MSafe IOTA app store repository
npm install @msafe/iota-app-storeDue to Sui blockchain version limitations, multisig account can't propose multiple transactions at the same time. It's needed to be create as transaction intention first and propose transaction 1 by 1 for vote & execution.
https://msafe-sui-web-v3.vercel.app/
We provide a demo dApp for MSafe app store integration. please refer below GitHub repository: https://github.com/Momentum-Safe/msafe-sui-app-arbitrary-transaction
- Fork the repository
- Create a new branch for your app development
- Create pull request for review
- Create your app folder under src/apps/ folder
- Create your dapp intentions under src/apps/ folder
Here is an example for transaction intention, if your dapp have multiple transaction types, you need to define 1 by 1 for each type of transaction intention.
``typescript
export interface CoinTransferIntentionData {
recipient: string;
coinType: string;
amount: string;
}
export class CoinTransferIntention extends CoreBaseIntention
txType: TransactionType.Assets;
txSubType: 'SendCoin';
constructor(public readonly data: CoinTransferIntentionData) {
super(data);
}
async build(input: { suiClient: SuiClient; account: WalletAccount }): Promise
const { suiClient, account } = input;
return buildCoinTransferTxb(suiClient, this.data, account.address);
}
static fromData(data: CoinTransferIntentionData) {
return new CoinTransferIntention(data);
}
}
`
Each intention should have one data structure to store transaction information for future build.
This structure can be defined according to your own business logic, it can be any type of data, (should be JSON serializable)
Transaction intention implement mainly one API build(): Promise which will build Sui transaction block from your defined business data.
- Create helper ts at src/apps/
Here is an example of intention.ts file
`typescript
export type CoreIntention = CoinTransferIntention | ObjectTransferIntention;
export type CoreIntentionData = CoinTransferIntentionData | ObjectTransferIntentionData;
export class CoreHelper implements MSafeAppHelper
application: string;
constructor() {
this.application = 'msafe-core';
}
deserialize(): CoreIntention {
throw new Error('MSafe core transaction intention should be build from API');
}
async build(input: {
intentionData: CoreIntentionData;
txType: TransactionType;
txSubType: string;
suiClient: SuiClient;
account: WalletAccount;
}): Promise
const { suiClient, account } = input;
let intention: CoreIntention;
switch (input.txSubType) {
case 'coin-transfer':
intention = CoinTransferIntention.fromData(input.intentionData as CoinTransferIntentionData);
break;
case 'object-transfer':
intention = ObjectTransferIntention.fromData(input.intentionData as ObjectTransferIntentionData);
break;
default:
throw new Error('not implemented');
}
return intention.build({ suiClient, account });
}
}
`
The helper is responsible for convert a transaction block to your own transaction intention business data. this is call by SuiWallet standard API sui:signTransactionBlock feature.
- Create your test at test/
You can follow be example to write test
`typescript
import { TransactionType } from '@msafe/iota-utils';
import { CoinTransferIntention, CoinTransferIntentionData } from '@/apps/msafe-core/coin-transfer';
import { appHelpers } from '@/index';
import { Account, Client } from './config';
describe('MSafe Core Wallet', () => {
it('Core transaction build', async () => {
const appHelper = appHelpers.getAppHelper('msafe-core');
expect(appHelper.application).toBe('msafe-core');
const res = await appHelper.build({
txType: TransactionType.Assets,
txSubType: 'coin-transfer',
suiClient: Client,
account: Account,
intentionData: {
amount: '1000',
coinType: '0x2::sui::SUI',
recipient: '123',
} as CoinTransferIntentionData,
});
expect(res.blockData.version).toBe(1);
expect(res.blockData.sender).toBe('0x0df172b18d30935ad68b2f9d6180e5adcf8edfd7df874852817002e6eccada66');
});
it('Test intention serialization', () => {
const intention = CoinTransferIntention.fromData({
recipient: 'a',
coinType: 'b',
amount: '100',
});
expect(intention.serialize()).toBe('{"amount":"100","coinType":"b","recipient":"a"}');
});
});
`
- Add your app helper to file src/index.ts
`typescript`
export const appHelpers = new MSafeApps([new CoreHelper(),
Once you finish development, you can create a PR to submit your changes.
The last step is to integrate MSafe wallet with your application
- Run command yarn add @msafe/sui-wallet to add MSafe wallet package to your projectmain.tsx
- Add below code to your application, basically it should be added to your file
`typescript
import { MSafeWallet } from '@msafe/sui-wallet';
import { registerWallet } from '@mysten/wallet-standard';
registerWallet(new MSafeWallet('
``
Once the development mentioned above is complete, MSafe team will assist in verifying the integration. Feedback will be provided to your team upon completion of the verification process.