@msafe/sui3-sdk 1.0.23 → 1.0.25

package/dist/index.cjs

@@ -40,6 +40,7 @@ __export(src_exports, {
   DEV_SYNCING_URL: () => DEV_SYNCING_URL,
   ENV_CONFIGS: () => ENV_CONFIGS,
   Formatter: () => Formatter,
+  GasPaymentLimitError: () => GasPaymentLimitError,
   HexToUint8Array: () => HexToUint8Array,
   InfoTypeEnabledDto: () => InfoTypeEnabledDto,
   InfoTypeKey: () => InfoTypeKey,
@@ -47,6 +48,7 @@ __export(src_exports, {
   LOCAL_API_URL: () => LOCAL_API_URL,
   LOCAL_SYNCING_URL: () => LOCAL_SYNCING_URL,
   MAINNET_RPC_URL: () => MAINNET_RPC_URL,
+  MAX_GAS_PAYMENT_OBJECTS: () => MAX_GAS_PAYMENT_OBJECTS,
   MSafeAccount: () => MSafeAccount,
   MSafeClient: () => MSafeClient,
   MSafeEnabledDto: () => MSafeEnabledDto,
@@ -66,6 +68,8 @@ __export(src_exports, {
   computeGasBudget: () => computeGasBudget,
   createCoinReservationRef: () => createCoinReservationRef,
   estimateGasBudget: () => estimateGasBudget,
+  gasCoinWithdrawal: () => gasCoinWithdrawal,
+  gasPaymentCover: () => gasPaymentCover,
   getAllCoins: () => getAllCoins,
   getIntentionContent: () => getIntentionContent,
   getMSafeConfig: () => getMSafeConfig,
@@ -74,6 +78,7 @@ __export(src_exports, {
   isCoinReservationDigest: () => isCoinReservationDigest,
   msafeChainToSuiNetwork: () => msafeChainToSuiNetwork,
   parkedPayloadHex: () => parkedPayloadHex,
+  pickGasPaymentCoins: () => pickGasPaymentCoins,
   preferClassicGasPayment: () => preferClassicGasPayment,
   prepareGasFunding: () => prepareGasFunding,
   selectGasFunding: () => selectGasFunding,
@@ -485,6 +490,10 @@ async function getAllCoins(input) {
 
 // src/utils/gasFunding.ts
 var GAS_SAFE_OVERHEAD = 1000n;
+var MAX_GAS_PAYMENT_OBJECTS = 256;
+var ESTIMATE_GAS_COVER = 1000000000n;
+var MAX_PROBE_GAS_BUDGET = 50000000000n;
+var COIN_WITH_BALANCE_INTENT = "CoinWithBalance";
 var InsufficientGasFundsError = class extends Error {
   gasBudget;
   coinBalance;
@@ -500,11 +509,105 @@ var InsufficientGasFundsError = class extends Error {
     this.addressBalance = addressBalance;
   }
 };
+var GasPaymentLimitError = class extends Error {
+  required;
+  covered;
+  coinCount;
+  constructor(required, covered, coinCount) {
+    super(gasPaymentLimitMessage(required, covered, coinCount));
+    this.name = "GasPaymentLimitError";
+    this.required = required;
+    this.covered = covered;
+    this.coinCount = coinCount;
+  }
+};
+function formatSui(mist) {
+  const negative = mist < 0n;
+  const value = negative ? -mist : mist;
+  const whole = value / 1000000000n;
+  const fraction = (value % 1000000000n).toString().padStart(9, "0").replace(/0+$/, "");
+  const text = fraction.length > 0 ? `${whole}.${fraction}` : `${whole}`;
+  return negative ? `-${text}` : text;
+}
+function gasPaymentLimitMessage(required, covered, coinCount) {
+  const requiredSui = formatSui(required);
+  const coveredSui = formatSui(covered);
+  if (coinCount >= MAX_GAS_PAYMENT_OBJECTS) {
+    return `This transfer needs ${requiredSui} SUI from gas coins, but the largest ${MAX_GAS_PAYMENT_OBJECTS} coins only cover ${coveredSui} SUI. Send a smaller amount, or consolidate coins into fewer objects first.`;
+  }
+  return `This transfer needs ${requiredSui} SUI from gas coins, but the available SUI coin objects only cover ${coveredSui} SUI.`;
+}
 function computeGasBudget(gasUsed, gasPrice) {
   const { computationCost, storageCost } = gasUsed;
   const safeOverhead = GAS_SAFE_OVERHEAD * gasPrice;
   return BigInt(computationCost) + BigInt(storageCost) + safeOverhead;
 }
+function compareBalanceDescending(a, b) {
+  if (a.balance === b.balance) {
+    return 0;
+  }
+  return a.balance < b.balance ? 1 : -1;
+}
+function pickGasPaymentCoins(coins, cover) {
+  if (cover <= 0n) {
+    return [];
+  }
+  const sorted = [...coins].filter((coin) => coin.balance > 0n).sort(compareBalanceDescending);
+  const selected = [];
+  let sum = 0n;
+  for (let index = 0; index < sorted.length; index += 1) {
+    if (selected.length >= MAX_GAS_PAYMENT_OBJECTS) {
+      break;
+    }
+    const coin = sorted[index];
+    selected.push(coin);
+    sum += coin.balance;
+    if (sum >= cover) {
+      break;
+    }
+  }
+  return selected;
+}
+function readBigInt(value) {
+  if (typeof value === "bigint") {
+    return value;
+  }
+  if (typeof value === "number" && Number.isFinite(value)) {
+    return BigInt(Math.trunc(value));
+  }
+  if (typeof value === "string" && /^-?\d+$/.test(value)) {
+    return BigInt(value);
+  }
+  return 0n;
+}
+function gasCoinWithdrawal(tx) {
+  return tx.getData().commands.reduce((sum, command) => {
+    if (command.$kind !== "$Intent" || command.$Intent.name !== COIN_WITH_BALANCE_INTENT) {
+      return sum;
+    }
+    const data = command.$Intent.data;
+    if (data?.type !== "gas") {
+      return sum;
+    }
+    return sum + readBigInt(data.balance);
+  }, 0n);
+}
+function gasPaymentCover(tx, addressBalance, gasBudget) {
+  const withdrawal = gasCoinWithdrawal(tx);
+  const fromGasCoin = withdrawal > addressBalance ? withdrawal : 0n;
+  return gasBudget + fromGasCoin;
+}
+function sumBalances(coins) {
+  return coins.reduce((sum, coin) => sum + coin.balance, 0n);
+}
+function pickGasPaymentCoinsForCover(coins, cover) {
+  const picked = pickGasPaymentCoins(coins, cover);
+  const covered = sumBalances(picked);
+  if (cover > 0n && covered < cover) {
+    throw new GasPaymentLimitError(cover, covered, picked.length);
+  }
+  return picked;
+}
 function collectUsedObjectIds(tx) {
   const used = tx.getData().inputs.reduce((acc, input) => {
     const immOrOwned = input.Object?.ImmOrOwnedObject?.objectId;
@@ -648,8 +751,14 @@ async function selectGasFunding(input) {
   if (total < gasBudget) {
     throw new InsufficientGasFundsError(gasBudget, coinBalance, addressBalance);
   }
+  const cover = gasPaymentCover(tx, addressBalance, gasBudget);
+  if (cover > gasBudget) {
+    const picked = pickGasPaymentCoinsForCover(paymentCoins, cover);
+    tx.setGasPayment(toObjectRefs(picked));
+    return { mode: "classic", gasBudget, coinBalance, addressBalance };
+  }
   if (paymentCoins.length > 0 && coinBalance >= gasBudget) {
-    tx.setGasPayment(toObjectRefs(paymentCoins));
+    tx.setGasPayment(toObjectRefs(pickGasPaymentCoins(paymentCoins, gasBudget)));
     return { mode: "classic", gasBudget, coinBalance, addressBalance };
   }
   if (paymentCoins.length > 0 && total >= gasBudget) {
@@ -658,7 +767,7 @@ async function selectGasFunding(input) {
       tx,
       suiClient,
       owner,
-      paymentCoins,
+      paymentCoins: pickGasPaymentCoins(paymentCoins, 1n),
       topUpAmount
     });
     return { mode: "mixedTopUp", gasBudget, coinBalance, addressBalance };
@@ -703,8 +812,19 @@ async function estimateGasBudget(input) {
   const probe = mustResetGas ? cloneWithClearedGasConfig(tx) : import_transactions.Transaction.from(tx);
   probe.setSender(owner);
   probe.setGasPrice(gasPrice);
-  if (funding.paymentCoins.length > 0) {
-    probe.setGasPayment(toObjectRefs(funding.paymentCoins));
+  const fromGasCoin = gasPaymentCover(tx, funding.addressBalance, 0n);
+  if (fromGasCoin > 0n) {
+    const picked = pickGasPaymentCoins(funding.paymentCoins, fromGasCoin + ESTIMATE_GAS_COVER);
+    const covered = sumBalances(picked);
+    if (covered <= fromGasCoin) {
+      throw new GasPaymentLimitError(fromGasCoin, covered, picked.length);
+    }
+    probe.setGasPayment(toObjectRefs(picked));
+    const remainder = covered - fromGasCoin;
+    const probeBudget = remainder > MAX_PROBE_GAS_BUDGET ? MAX_PROBE_GAS_BUDGET : remainder;
+    probe.setGasBudget(probeBudget);
+  } else if (funding.paymentCoins.length > 0) {
+    probe.setGasPayment(toObjectRefs(pickGasPaymentCoins(funding.paymentCoins, ESTIMATE_GAS_COVER)));
   }
   let built;
   try {
@@ -779,7 +899,7 @@ async function preferClassicGasPayment(input) {
   if (funding.paymentCoins.length === 0) {
     return false;
   }
-  tx.setGasPayment(toObjectRefs(funding.paymentCoins));
+  tx.setGasPayment(toObjectRefs(pickGasPaymentCoins(funding.paymentCoins, ESTIMATE_GAS_COVER)));
   return true;
 }