@msafe/sui3-sdk 0.0.34 → 0.0.36

package/dist/index.cjs

@@ -43,7 +43,6 @@ __export(src_exports, {
   LOCAL_API_URL: () => LOCAL_API_URL,
   LOCAL_SYNCING_URL: () => LOCAL_SYNCING_URL,
   MAINNET_RPC_URL: () => MAINNET_RPC_URL,
-  MSAFE_APPLICATION: () => MSAFE_APPLICATION,
   MSafeAccount: () => MSafeAccount,
   MSafeClient: () => MSafeClient,
   MSafeEnv: () => MSafeEnv,
@@ -176,10 +175,83 @@ var InvitationSDK = class {
 };
 
 // src/core/MSafeAccount.ts
+var import_sui_app_store = require("@msafe/sui-app-store");
 var import_sui3_utils4 = require("@msafe/sui3-utils");
-var import_transactions = require("@mysten/sui.js/transactions");
+var import_transactions2 = require("@mysten/sui.js/transactions");
 var import_utils3 = require("@mysten/sui.js/utils");
 
+// src/simulate/simulator.ts
+var import_transactions = require("@mysten/sui.js/transactions");
+var GAS_SAFE_OVERHEAD = 1000n;
+var DEF_GAS_PRICE_NUM = 120n;
+var DEF_GAS_PRICE_DEN = 100n;
+var DEF_GAS_PRICE_OPTION = {
+  multiplier: {
+    numerator: DEF_GAS_PRICE_NUM,
+    denominator: DEF_GAS_PRICE_DEN
+  }
+};
+var Simulator = class {
+  constructor(globals) {
+    this.globals = globals;
+  }
+  async simulate(input, options = DEF_GAS_PRICE_OPTION) {
+    const tx = this.copyTransactionBlock(input.txb);
+    const { suiClient } = this.globals;
+    const gasPrice = await this.getGasPrice(options);
+    tx.setGasPrice(gasPrice);
+    const inspectResult = await suiClient.devInspectTransactionBlock({ transactionBlock: tx, sender: input.sender });
+    const { gasUsed } = inspectResult.effects;
+    const gasBudget = this.toGasBudget(gasUsed, gasPrice);
+    const success = inspectResult.effects.status.status === "success";
+    let error;
+    if (!success) {
+      error = inspectResult.effects.status.error;
+    }
+    return {
+      success,
+      gasPrice,
+      gasObject: inspectResult.effects.gasObject.reference,
+      gasUsed,
+      gasBudget,
+      simulationError: error
+    };
+  }
+  async getGasPrice(option) {
+    if (this.isFixedValue(option)) {
+      return option.fixedVal;
+    }
+    const refGasPrice = await this.globals.suiClient.getReferenceGasPrice();
+    return this.applyGasOption(refGasPrice, option);
+  }
+  toGasBudget(gasUsed, gasPrice) {
+    const { computationCost, storageCost } = gasUsed;
+    const safeOverhead = GAS_SAFE_OVERHEAD * gasPrice;
+    const baseComputationCostWithOverhead = BigInt(computationCost) + safeOverhead;
+    const gasBudget = baseComputationCostWithOverhead + BigInt(storageCost);
+    return gasBudget > baseComputationCostWithOverhead ? gasBudget : baseComputationCostWithOverhead;
+  }
+  isFixedValue(option) {
+    return "fixedVal" in option;
+  }
+  isMultiplier(option) {
+    return "multiplier" in option;
+  }
+  applyGasOption(val, option) {
+    if (this.isFixedValue(option)) {
+      return option.fixedVal;
+    }
+    if (this.isMultiplier(option)) {
+      const { multiplier } = option;
+      return val * multiplier.numerator / multiplier.denominator;
+    }
+    throw new Error("Sanity: Unknown gas price option");
+  }
+  copyTransactionBlock(tx) {
+    return import_transactions.TransactionBlock.from(tx.serialize());
+  }
+};
+
 // src/utils/buffer.ts
 function stringToBuffer(s) {
   return Buffer.from(s, "utf-8");
@@ -529,9 +601,11 @@ var MSafeAccount = class _MSafeAccount {
       creationNonce: info.creationNonce
     });
     this.coinHelper = new CoinHelper(this.suiClient);
+    this.simulator = new Simulator(globals);
   }
   multiSig;
   coinHelper;
+  simulator;
   static async New(globals, address) {
     const info = await globals.backend.getMSafeAccountInfo(address);
     const ms = new _MSafeAccount(globals, info);
@@ -560,7 +634,6 @@ var MSafeAccount = class _MSafeAccount {
     };
     return getAllOwnedObjects(this.suiClient, this.address, filterCoinObjectOptions);
   }
-  // TODO: Calculate the votes
   async pendingTransaction() {
     const res = await this.backend.getPendingTransactions({ msafeAddress: this.address });
     if (!res.pending) {
@@ -586,7 +659,6 @@ var MSafeAccount = class _MSafeAccount {
       rejectWeight: this.calculateWeightFromVotes(rejectPending?.votes ?? [])
     };
   }
-  // TODO: Calculate the votes.
   async historyTransaction(pagination) {
     return this.backend.getHistoryTransactions({
       msafeAddress: this.address,
@@ -602,6 +674,22 @@ var MSafeAccount = class _MSafeAccount {
   async nextSequenceNumber() {
     return this.backend.getNextSequenceNumber(this.address);
   }
+  async simulateIntention(request) {
+    const appHelper = import_sui_app_store.appHelpers.getAppHelper(request.application);
+    if (!appHelper) {
+      throw new Error(`Can't find app helper for application ${request.application}`);
+    }
+    const txb = await appHelper.build({
+      intentionData: request.intention,
+      txType: request.txType,
+      txSubType: request.txSubType,
+      suiClient: this.globals.suiClient,
+      account: {
+        address: this.address
+      }
+    });
+    return this.simulator.simulate({ txb, sender: this.address });
+  }
   async proposeIntention(input) {
     const message = import_sui3_utils4.SigningMessageHelper.proposeIntentionMessage({
       msafeAddress: this.address,
@@ -611,12 +699,22 @@ var MSafeAccount = class _MSafeAccount {
     const signature = await this.wallet.signPersonalMessage({
       messageStr: message
     });
-    await this.backend.proposeIntention({
+    return this.backend.proposeIntention({
       ...input,
       msafeAddress: this.address,
       signature: signature.signature
     });
   }
+  async simulateCoinTransferIntention(intention) {
+    const sn = await this.nextSequenceNumber();
+    return this.simulateIntention({
+      application: import_sui3_utils4.TransactionDefaultApplication,
+      txType: import_sui3_utils4.TransactionType.Assets,
+      txSubType: import_sui3_utils4.TransactionSubTypes.assets.coin.send,
+      sequenceNumber: sn,
+      intention
+    });
+  }
   async proposeCoinTransferIntention(intention) {
     const sn = await this.nextSequenceNumber();
     return this.proposeIntention({
@@ -640,7 +738,7 @@ var MSafeAccount = class _MSafeAccount {
   }
   async proposePlainPayloadIntention(intention) {
     const sn = await this.nextSequenceNumber();
-    const tb = import_transactions.TransactionBlock.from(intention.payload);
+    const tb = import_transactions2.TransactionBlock.from(intention.payload);
     if (!tb.blockData.sender || !(0, import_sui3_utils4.isSameAddress)(tb.blockData.sender, this.address)) {
       throw new Error("Transaction sender is not same as the multisig address");
     }
@@ -664,7 +762,7 @@ var MSafeAccount = class _MSafeAccount {
   // Shortcut for proposing a transaction to be a pending transaction, and add user vote to it.
   // Requires the multi-sig to be empty in pending transaction.
   async proposePendingTransaction(intention) {
-    const txb = new import_transactions.TransactionBlock();
+    const txb = new import_transactions2.TransactionBlock();
     const payload = await txb.build({ client: this.suiClient });
     const digest = await txb.getDigest({ client: this.suiClient });
     const signature = await this.wallet.signTransactionBlock({ transactionBlock: payload });
@@ -692,33 +790,34 @@ var MSafeAccount = class _MSafeAccount {
       signature: signature.signature
     });
   }
-  async buildNextIntentionAndAddToPending() {
-    return this.backend.buildNextIntentionAndAddToPending({ msafeAddress: this.address });
+  async simulateBuildTransaction() {
+    const intention = await this.backend.getNextIntention({ msafeAddress: this.address });
+    const appHelper = import_sui_app_store.appHelpers.getAppHelper(intention.application);
+    if (!appHelper) {
+      throw new Error(`Can't find app helper for application ${intention.application}`);
+    }
+    const txb = await appHelper.build({
+      intentionData: intention.intention,
+      txType: intention.txType,
+      txSubType: intention.txSubType,
+      suiClient: this.globals.suiClient,
+      account: {
+        address: this.address
+      }
+    });
+    return this.simulator.simulate({ txb, sender: this.address });
+  }
+  async buildNextIntentionAndAddToPending(gasOption) {
+    return this.backend.buildNextIntentionAndAddToPending({
+      msafeAddress: this.address,
+      forceBuild: gasOption.forceBuild,
+      gasPrice: gasOption.gasPrice,
+      gasBudget: gasOption.gasBudget
+    });
   }
   async skipNextFailedIntention() {
     return this.backend.skipNextFailedIntention({ msafeAddress: this.address });
   }
-  async simulateIntention() {
-    const txb = new import_transactions.TransactionBlock();
-    txb.setSender(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);
-    const { gasUsed } = dryRunResult.effects;
-    return {
-      success,
-      errorMsg,
-      gasPrice,
-      gasUsed,
-      dryRunResult
-    };
-  }
   async executePendingTx(pending, isRejectTx = false) {
     const votes = isRejectTx ? pending.rejectVotes : pending.votes;
     const payload = isRejectTx ? pending.rejectPayload : pending.payload;
@@ -958,6 +1057,13 @@ var BackendImpl = class _BackendImpl {
     });
     return res.data;
   }
+  async getNextIntention(input) {
+    const res = await this.get(`/transaction/intention/next`, {
+      params: input,
+      headers: this.headers()
+    });
+    return res.data;
+  }
   async getCurrentSequenceNumber(address) {
     const res = await this.get(`/transaction/sn/current`, {
       params: {
@@ -984,7 +1090,6 @@ var BackendImpl = class _BackendImpl {
   async proposeIntention(input) {
     await this.post(`/transaction/intention`, input, { headers: this.headers() });
   }
-  // TODO later
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   async proposePendingTransaction(_input) {
     return void 0;
@@ -1000,7 +1105,11 @@ var BackendImpl = class _BackendImpl {
     });
   }
   async buildNextIntentionAndAddToPending(input) {
-    await this.post(`/transaction/pending/build`, input, { headers: this.headers() });
+    await this.post(
+      `/transaction/pending/build`,
+      { ...input, gasPrice: input.gasPrice.toString(), gasBudget: input.gasBudget.toString() },
+      { headers: this.headers() }
+    );
   }
   async skipNextFailedIntention(input) {
     await this.post(`/transaction/pending/skip`, input, { headers: this.headers() });
@@ -1103,7 +1212,6 @@ var MSafeEnv = /* @__PURE__ */ ((MSafeEnv3) => {
   MSafeEnv3["prod"] = "prod";
   return MSafeEnv3;
 })(MSafeEnv || {});
-var MSAFE_APPLICATION = "msafe";
 var TESTNET_RPC_URL = "https://sui-testnet.blockvision.org/v1/2Sgk89ivT64MnKdcGzjmyjY2ndD";
 var MAINNET_RPC_URL = "https://sui-mainnet.blockvision.org/v1/2Sgk7NPvqkd7mESYkxF01yX15l7";
 var LOCAL_API_URL = "http://127.0.0.1:3000";
@@ -1301,7 +1409,6 @@ var MSafeClient = class _MSafeClient {
   LOCAL_API_URL,
   LOCAL_SYNCING_URL,
   MAINNET_RPC_URL,
-  MSAFE_APPLICATION,
   MSafeAccount,
   MSafeClient,
   MSafeEnv,