@msafe/sui3-sdk 0.0.11 → 0.0.12-pre-84adfec.0

package/src/core/MSafeAccount.ts

@@ -1,14 +1,21 @@
-import { MSafeAccountInfo, MultisigAccountManager } from '@msafe/sui3-utils';
+import {
+  buildIntentionTransaction,
+  getIntentionType,
+  MSafeAccountInfo,
+  MultisigAccountManager,
+} from '@msafe/sui3-utils';
 import { SuiObjectData } from '@mysten/sui.js/client';
 import { SerializedSignature } from '@mysten/sui.js/cryptography';
+import { SuiObjectResponse } from '@mysten/sui.js/src/client';
 import { normalizeStructTag } from '@mysten/sui.js/utils';
 
 import { MessageHelper } from '@/core/MessageHelper';
+import { MSAFE_APPLICATION } from '@/globals';
 import { MSafeGlobals } from '@/globals/MSafeGlobals';
 import { IntentionHelper, TxIntention } from '@/transactions/intention';
 import { OwnedCoin } from '@/types/assets';
 import { PaginationOption } from '@/types/backend';
-import { PendingTx } from '@/types/msafe';
+import { PendingTx, SimulationResult } from '@/types/msafe';
 import { CoinHelper } from '@/utils';
 import { HexToUint8Array } from '@/utils/buffer';
 import { BatchObjectOptions, getAllOwnedObjects } from '@/utils/iter/object';
@@ -53,11 +60,11 @@ export class MSafeAccount {
   }
 
   async ownedObjects(options?: BatchObjectOptions): Promise<SuiObjectData[]> {
-    return getAllOwnedObjects(this.suiClient, this.address, options);
-  }
-
-  async pendingTransactions() {
-    return this.backend.getPendingTransactions(this.address);
+    const filterCoinObjectOptions = {
+      filter: (objRes: SuiObjectResponse) => !objRes?.data?.type?.startsWith('0x2::coin::Coin'),
+      ...options,
+    };
+    return getAllOwnedObjects(this.suiClient, this.address, filterCoinObjectOptions);
   }
 
   async pendingTransaction(): Promise<PendingTx | undefined> {
@@ -68,21 +75,20 @@ export class MSafeAccount {
     if (pendings.length === 0) {
       return undefined;
     }
-    if (pendings.length === 1) {
-      return pendings[0];
-    }
 
-    const [rejectPending, pendingTx] = pendings[0].isRejectTx ? [pendings[0], pendings[1]] : [pendings[1], pendings[0]];
-    pendingTx.rejectDigest = rejectPending.digest;
-    pendingTx.rejectPayload = rejectPending.payload;
-    pendingTx.rejectVotes = rejectPending.votes;
+    const pendingTx = pendings.find((tx) => !tx.isRejectTx);
+    const rejectPending = pendings.find((tx) => tx.isRejectTx);
 
-    return pendingTx;
+    return {
+      ...pendingTx!,
+      rejectDigest: rejectPending?.digest ?? '',
+      rejectPayload: rejectPending?.payload ?? '',
+      rejectVotes: rejectPending?.votes ?? [],
+    };
   }
 
   async historyTransaction(paginationOption?: PaginationOption) {
-    const paginatedHistoryTransactions = await this.backend.getHistoryTransactions(this.address, paginationOption);
-    return paginatedHistoryTransactions.data;
+    return this.backend.getHistoryTransactions(this.address, paginationOption);
   }
 
   async futureIntentions(paginationOption?: PaginationOption) {
@@ -99,16 +105,26 @@ export class MSafeAccount {
   }
 
   async proposeIntention(intention: TxIntention, sequenceNumber: number) {
-    const message = MessageHelper.proposeIntentionMessage({ intention, sn: sequenceNumber });
+    const message = MessageHelper.proposeIntentionMessage({
+      intention,
+      sn: sequenceNumber,
+      msafeAddress: this.address,
+    });
     const signature = await this.wallet.signPersonalMessage({
       messageStr: message,
     });
+
+    const txType = getIntentionType(intention);
+    // TODO get application from common utils
     await this.backend.proposeIntention({
       intention,
       sequenceNumber,
       msafeAddress: this.address,
       userAddress: await this.userAddress(),
       signature: signature.signature,
+      application: MSAFE_APPLICATION,
+      txType: txType.txType,
+      txSubType: txType.txSubType,
     });
   }
 
@@ -152,7 +168,7 @@ export class MSafeAccount {
       payloadToReject = pending.payload;
     } else {
       const pendingTx = await this.pendingTransaction();
-      if (!pendingTx || pendingTx?.rejectDigest !== undefined) {
+      if (!pendingTx || pendingTx.rejectDigest !== '') {
         throw new Error('Already rejected');
       }
 
@@ -181,6 +197,29 @@ export class MSafeAccount {
     return this.backend.skipNextFailedIntention({ msafeAddress: this.address, userAddress: await this.userAddress() });
   }
 
+  async simulateIntention(intention: TxIntention): Promise<SimulationResult> {
+    const txb = await buildIntentionTransaction(this.suiClient, intention, this.address);
+    if (!txb.blockData.gasConfig.price) {
+      const refGas = await this.suiClient.getReferenceGasPrice();
+      txb.setGasPrice(refGas);
+    }
+    const payload = await txb.build({ client: this.suiClient });
+    const dryRunResult = await this.suiClient.dryRunTransactionBlock({ transactionBlock: payload });
+
+    const success = dryRunResult.effects.status.status === 'success';
+    const errorMsg = dryRunResult.effects.status.error;
+    const gasPrice = BigInt(txb.blockData.gasConfig.price as string);
+    const { gasUsed } = dryRunResult.effects;
+
+    return {
+      success,
+      errorMsg,
+      gasPrice,
+      gasUsed,
+      dryRunResult,
+    };
+  }
+
   async executePendingTx(pending: PendingTx) {
     let gotSigs: Map<string, string>;
     let payload: string;

package/src/core/MessageHelper.ts

@@ -30,11 +30,12 @@ export class MessageHelper {
   }
 
   static proposeIntentionMessage(data: ProposeIntentionData) {
-    const { intention, sn } = data;
+    const { msafeAddress, intention, sn } = data;
     const intentionData = IntentionHelper.ser(intention);
     const msg: ProposeIntentionMessage = {
       intentionData,
       sequenceNumber: sn,
+      msafeAddress,
     };
     return JSON.stringify(msg);
   }
@@ -49,8 +50,9 @@ export class MessageHelper {
     ) {
       throw new Error('Invalid intention data');
     }
-    const { sequenceNumber, intentionData } = de;
+    const { msafeAddress, sequenceNumber, intentionData } = de;
     return {
+      msafeAddress,
       sn: sequenceNumber,
       intention: IntentionHelper.de(intentionData),
     };
@@ -81,11 +83,13 @@ export class MessageHelper {
 }
 
 export interface ProposeIntentionData {
+  msafeAddress: string;
   intention: TxIntention;
   sn: number;
 }
 
 export interface ProposeIntentionMessage {
+  msafeAddress: string;
   intentionData: string;
   sequenceNumber: number;
 }

package/src/globals/const.ts

@@ -53,6 +53,8 @@ export const DEV_DATABASE_CONFIG: DBConfig = {
   logging: false,
 };
 
+export const MSAFE_APPLICATION = 'msafe';
+
 export const TESTNET_RPC_URL = 'https://sui-testnet.blockvision.org/v1/2Sgk89ivT64MnKdcGzjmyjY2ndD';
 export const MAINNET_RPC_URL = 'https://sui-mainnet.blockvision.org/v1/2Sgk7NPvqkd7mESYkxF01yX15l7';
 

package/src/types/msafe.ts

@@ -1,3 +1,5 @@
+import { GasCostSummary, DryRunTransactionBlockResponse } from '@mysten/sui.js/client';
+
 import { TxIntention } from '@/transactions/intention';
 
 export interface PendingTx {
@@ -10,9 +12,9 @@ export interface PendingTx {
   createdAt: Date;
   sequenceNumber: number;
   votes: PendingVote[];
-  rejectDigest?: string;
-  rejectPayload?: string;
-  rejectVotes?: PendingVote[];
+  rejectDigest: string;
+  rejectPayload: string;
+  rejectVotes: PendingVote[];
 }
 
 export interface PendingVote {
@@ -62,3 +64,13 @@ export interface FutureIntention {
   statusRemark?: string;
   createdAt: Date;
 }
+
+export interface SimulationResult {
+  success: boolean;
+  errorMsg?: string;
+  // gas price for the simulation
+  gasPrice: bigint;
+  // detailed gas cost summary
+  gasUsed: GasCostSummary;
+  dryRunResult: DryRunTransactionBlockResponse;
+}