@owney/sdk 0.7.28-beta.4 → 0.7.28-beta.5

package/dist/index.cjs

@@ -2884,6 +2884,33 @@ function swapChain(chainId) {
   return CHAINS[chainId];
 }
 
+// src/lib/swap/swap.gas-check.ts
+var CLASSIC_SWAP_GAS = 300000n;
+var APPROVE_GAS2 = 60000n;
+var isNative = (address) => address.toLowerCase().startsWith("0xeeee");
+async function swapGasShortfall(deps, quote) {
+  if (quote.rail !== "classic" || isNative(quote.src.address)) return null;
+  const gas = CLASSIC_SWAP_GAS + APPROVE_GAS2;
+  const [balance, gasPrice] = await Promise.all([
+    deps.readNativeBalance(),
+    deps.getMaxFeePerGas()
+  ]);
+  const required = gas * gasPrice;
+  return balance < required ? { chainId: quote.src.chainId, balance, required } : null;
+}
+function swapGasError(shortfall, nativeSymbol) {
+  return new OwneyError(
+    "SWAP_INSUFFICIENT_GAS",
+    `This swap needs a little ${nativeSymbol} for network fees, and your wallet has too little. Add some ${nativeSymbol}, or choose a different asset to receive.`,
+    {
+      chainId: shortfall.chainId,
+      symbol: nativeSymbol,
+      balance: shortfall.balance.toString(),
+      required: shortfall.required.toString()
+    }
+  );
+}
+
 // src/lib/swap/swap.arrival.ts
 var DEFAULT_TIMEOUT_MS = 18e4;
 var DEFAULT_POLL_MS = 4e3;
@@ -3400,8 +3427,8 @@ async function runClassic(deps, options) {
   onStage?.("quoting");
   debugLog("owney-sdk", "swap: fetching classic calldata");
   let { tx } = await deps.api.swapTx(swapTxRequest);
-  const isNative = BigInt(tx.value ?? "0") > 0n;
-  if (!isNative) {
+  const isNative2 = BigInt(tx.value ?? "0") > 0n;
+  if (!isNative2) {
     const needed = amount;
     const current = await deps.readAllowance(tx.to);
     debugLog("owney-sdk", "swap: allowance", {
@@ -4467,6 +4494,15 @@ function makeSponsoredCallsCallback(deps) {
 
 // src/client.ts
 var WALLET_CATCHUP_TIMEOUT_MS = 3e4;
+function shortfallBalance(error, asked) {
+  if (!(error instanceof OwneyError)) return void 0;
+  if (error.code !== "DEPOSIT_INSUFFICIENT_BALANCE") return void 0;
+  const seen = error.details?.balance;
+  if (typeof seen !== "string") return void 0;
+  const balance = BigInt(seen);
+  if (balance <= 0n || balance >= asked) return void 0;
+  return (asked - balance) * 100n <= asked ? balance : void 0;
+}
 function encodeMultiAgentCursor(map) {
   return Buffer.from(JSON.stringify(map), "utf8").toString("base64");
 }
@@ -5673,6 +5709,38 @@ var OwneySDK = class {
     const balance = await this.readTokenBalance(chainId, token);
     return (balance < received ? balance : received).toString();
   }
+  /**
+   * Deposit a swap's output, retrying once at the balance the deposit saw.
+   *
+   * `settleSwapDepositAmount` approves and THEN reads, but the read and the
+   * deposit's own pre-check can disagree: the approval is confirmed through
+   * the wallet's node, the read goes to a pinned RPC, and gas paid in WETH
+   * (MetaMask offers this to a wallet with no ETH) can land after either.
+   * ROUT-618 failed that way with the settle step in place.
+   *
+   * The pre-check reports the balance it saw, and that is the authority, so
+   * a shortfall is retried once at that figure. Only a small one: a node that
+   * has not caught up can read near zero, and depositing that would leave the
+   * rest of the swap stranded behind a "success".
+   */
+  async depositSwapOutput(options) {
+    const attempt = (amount) => this.deposit({
+      amount,
+      asset: options.asset,
+      ...options.agentId ? { agentId: options.agentId } : {}
+    });
+    try {
+      return {
+        deposit: await attempt(options.amount),
+        deposited: options.amount
+      };
+    } catch (error) {
+      const balance = shortfallBalance(error, BigInt(options.amount));
+      if (balance === void 0) throw error;
+      const deposited = balance.toString();
+      return { deposit: await attempt(deposited), deposited };
+    }
+  }
   async walletSeesBalance(chainId, token, amount) {
     const provider = this.requireConnectedProvider();
     const state = this.requireState();
@@ -5698,9 +5766,39 @@ var OwneySDK = class {
    * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
    * so the deposit half of `swapAndDeposit` can be exercised on its own.
    */
-  runSwap(quote, options) {
+  async runSwap(quote, options) {
+    await this.checkSwapGas(quote);
     return executeSwap(this.buildSwapDeps(quote), { quote, ...options });
   }
+  /**
+   * Throws SWAP_INSUFFICIENT_GAS when the wallet cannot pay for this swap.
+   *
+   * Only the classic rail is ever refused: it is the one where the user sends
+   * the transactions. Call it on a preview quote to warn BEFORE a withdrawal
+   * moves anything — `withdrawAndSwap` repeats it on its own quote, but by
+   * then the funds have already left the agent (ROUT-622).
+   */
+  async checkSwapGas(quote) {
+    const state = this.requireState();
+    const chain = swapChain(quote.src.chainId);
+    if (!chain) return;
+    const pub = (0, import_viem9.createPublicClient)({
+      chain,
+      transport: swapReadTransport(quote.src.chainId, this.zyfaiRpcUrls)
+    });
+    const shortfall = await swapGasShortfall(
+      {
+        readNativeBalance: () => pub.getBalance({ address: state.walletAddress }),
+        // The 1559 ceiling, as the wrap reserve reads it.
+        getMaxFeePerGas: async () => {
+          const fees = await pub.estimateFeesPerGas();
+          return fees.maxFeePerGas ?? pub.getGasPrice();
+        }
+      },
+      quote
+    );
+    if (shortfall) throw swapGasError(shortfall, chain.nativeCurrency.symbol);
+  }
   /**
    * The half of the swap deps that only ever talks to the routing API.
    *
@@ -5772,8 +5870,15 @@ var OwneySDK = class {
       );
     }
     await this.ensureSwapChain(entry.chainId);
-    const deposit = await this.deposit({
-      amount: entry.received,
+    const token = entry.symbol === "WETH" ? SPONSORED_WETH_BY_CHAIN[entry.chainId] : void 0;
+    const amount = token ? await this.settleSwapDepositAmount(
+      entry.chainId,
+      token,
+      entry.symbol,
+      BigInt(entry.received)
+    ) : entry.received;
+    const { deposit } = await this.depositSwapOutput({
+      amount,
       asset: entry.symbol,
       ...entry.agentId ? { agentId: entry.agentId } : {}
     });
@@ -6013,12 +6118,12 @@ var OwneySDK = class {
         options.to.symbol,
         BigInt(swap.received)
       );
-      const deposit = await this.deposit({
+      const { deposit, deposited } = await this.depositSwapOutput({
         amount,
         asset: options.to.symbol,
         ...options.agentId ? { agentId: options.agentId } : {}
       });
-      return { swap, deposit, deposited: amount };
+      return { swap, deposit, deposited };
     } catch (error) {
       const pending = {
         id: `${quote.dst.chainId}-${options.to.symbol}-${Date.now()}`,
@@ -6122,6 +6227,7 @@ var OwneySDK = class {
         walletAddress: state.walletAddress
       });
       await this.ensureSwapChain(quote.src.chainId);
+      await this.checkSwapGas(quote);
       const swap = await executeSwap(this.buildSwapDeps(quote), {
         quote,
         walletAddress: state.walletAddress,

package/dist/index.d.cts

@@ -1393,12 +1393,36 @@ declare class OwneySDK {
      *   where the sponsor covers the transfer and Permit2 never applies.
      */
     private settleSwapDepositAmount;
+    /**
+     * Deposit a swap's output, retrying once at the balance the deposit saw.
+     *
+     * `settleSwapDepositAmount` approves and THEN reads, but the read and the
+     * deposit's own pre-check can disagree: the approval is confirmed through
+     * the wallet's node, the read goes to a pinned RPC, and gas paid in WETH
+     * (MetaMask offers this to a wallet with no ETH) can land after either.
+     * ROUT-618 failed that way with the settle step in place.
+     *
+     * The pre-check reports the balance it saw, and that is the authority, so
+     * a shortfall is retried once at that figure. Only a small one: a node that
+     * has not caught up can read near zero, and depositing that would leave the
+     * rest of the swap stranded behind a "success".
+     */
+    private depositSwapOutput;
     private walletSeesBalance;
     /**
      * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
      * so the deposit half of `swapAndDeposit` can be exercised on its own.
      */
     private runSwap;
+    /**
+     * Throws SWAP_INSUFFICIENT_GAS when the wallet cannot pay for this swap.
+     *
+     * Only the classic rail is ever refused: it is the one where the user sends
+     * the transactions. Call it on a preview quote to warn BEFORE a withdrawal
+     * moves anything — `withdrawAndSwap` repeats it on its own quote, but by
+     * then the funds have already left the agent (ROUT-622).
+     */
+    checkSwapGas(quote: SwapQuote): Promise<void>;
     /**
      * The half of the swap deps that only ever talks to the routing API.
      *

package/dist/index.d.ts

@@ -1393,12 +1393,36 @@ declare class OwneySDK {
      *   where the sponsor covers the transfer and Permit2 never applies.
      */
     private settleSwapDepositAmount;
+    /**
+     * Deposit a swap's output, retrying once at the balance the deposit saw.
+     *
+     * `settleSwapDepositAmount` approves and THEN reads, but the read and the
+     * deposit's own pre-check can disagree: the approval is confirmed through
+     * the wallet's node, the read goes to a pinned RPC, and gas paid in WETH
+     * (MetaMask offers this to a wallet with no ETH) can land after either.
+     * ROUT-618 failed that way with the settle step in place.
+     *
+     * The pre-check reports the balance it saw, and that is the authority, so
+     * a shortfall is retried once at that figure. Only a small one: a node that
+     * has not caught up can read near zero, and depositing that would leave the
+     * rest of the swap stranded behind a "success".
+     */
+    private depositSwapOutput;
     private walletSeesBalance;
     /**
      * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
      * so the deposit half of `swapAndDeposit` can be exercised on its own.
      */
     private runSwap;
+    /**
+     * Throws SWAP_INSUFFICIENT_GAS when the wallet cannot pay for this swap.
+     *
+     * Only the classic rail is ever refused: it is the one where the user sends
+     * the transactions. Call it on a preview quote to warn BEFORE a withdrawal
+     * moves anything — `withdrawAndSwap` repeats it on its own quote, but by
+     * then the funds have already left the agent (ROUT-622).
+     */
+    checkSwapGas(quote: SwapQuote): Promise<void>;
     /**
      * The half of the swap deps that only ever talks to the routing API.
      *

package/dist/index.js

@@ -2854,6 +2854,33 @@ function swapChain(chainId) {
   return CHAINS[chainId];
 }
 
+// src/lib/swap/swap.gas-check.ts
+var CLASSIC_SWAP_GAS = 300000n;
+var APPROVE_GAS2 = 60000n;
+var isNative = (address) => address.toLowerCase().startsWith("0xeeee");
+async function swapGasShortfall(deps, quote) {
+  if (quote.rail !== "classic" || isNative(quote.src.address)) return null;
+  const gas = CLASSIC_SWAP_GAS + APPROVE_GAS2;
+  const [balance, gasPrice] = await Promise.all([
+    deps.readNativeBalance(),
+    deps.getMaxFeePerGas()
+  ]);
+  const required = gas * gasPrice;
+  return balance < required ? { chainId: quote.src.chainId, balance, required } : null;
+}
+function swapGasError(shortfall, nativeSymbol) {
+  return new OwneyError(
+    "SWAP_INSUFFICIENT_GAS",
+    `This swap needs a little ${nativeSymbol} for network fees, and your wallet has too little. Add some ${nativeSymbol}, or choose a different asset to receive.`,
+    {
+      chainId: shortfall.chainId,
+      symbol: nativeSymbol,
+      balance: shortfall.balance.toString(),
+      required: shortfall.required.toString()
+    }
+  );
+}
+
 // src/lib/swap/swap.arrival.ts
 var DEFAULT_TIMEOUT_MS = 18e4;
 var DEFAULT_POLL_MS = 4e3;
@@ -3370,8 +3397,8 @@ async function runClassic(deps, options) {
   onStage?.("quoting");
   debugLog("owney-sdk", "swap: fetching classic calldata");
   let { tx } = await deps.api.swapTx(swapTxRequest);
-  const isNative = BigInt(tx.value ?? "0") > 0n;
-  if (!isNative) {
+  const isNative2 = BigInt(tx.value ?? "0") > 0n;
+  if (!isNative2) {
     const needed = amount;
     const current = await deps.readAllowance(tx.to);
     debugLog("owney-sdk", "swap: allowance", {
@@ -4448,6 +4475,15 @@ function makeSponsoredCallsCallback(deps) {
 
 // src/client.ts
 var WALLET_CATCHUP_TIMEOUT_MS = 3e4;
+function shortfallBalance(error, asked) {
+  if (!(error instanceof OwneyError)) return void 0;
+  if (error.code !== "DEPOSIT_INSUFFICIENT_BALANCE") return void 0;
+  const seen = error.details?.balance;
+  if (typeof seen !== "string") return void 0;
+  const balance = BigInt(seen);
+  if (balance <= 0n || balance >= asked) return void 0;
+  return (asked - balance) * 100n <= asked ? balance : void 0;
+}
 function encodeMultiAgentCursor(map) {
   return Buffer.from(JSON.stringify(map), "utf8").toString("base64");
 }
@@ -5654,6 +5690,38 @@ var OwneySDK = class {
     const balance = await this.readTokenBalance(chainId, token);
     return (balance < received ? balance : received).toString();
   }
+  /**
+   * Deposit a swap's output, retrying once at the balance the deposit saw.
+   *
+   * `settleSwapDepositAmount` approves and THEN reads, but the read and the
+   * deposit's own pre-check can disagree: the approval is confirmed through
+   * the wallet's node, the read goes to a pinned RPC, and gas paid in WETH
+   * (MetaMask offers this to a wallet with no ETH) can land after either.
+   * ROUT-618 failed that way with the settle step in place.
+   *
+   * The pre-check reports the balance it saw, and that is the authority, so
+   * a shortfall is retried once at that figure. Only a small one: a node that
+   * has not caught up can read near zero, and depositing that would leave the
+   * rest of the swap stranded behind a "success".
+   */
+  async depositSwapOutput(options) {
+    const attempt = (amount) => this.deposit({
+      amount,
+      asset: options.asset,
+      ...options.agentId ? { agentId: options.agentId } : {}
+    });
+    try {
+      return {
+        deposit: await attempt(options.amount),
+        deposited: options.amount
+      };
+    } catch (error) {
+      const balance = shortfallBalance(error, BigInt(options.amount));
+      if (balance === void 0) throw error;
+      const deposited = balance.toString();
+      return { deposit: await attempt(deposited), deposited };
+    }
+  }
   async walletSeesBalance(chainId, token, amount) {
     const provider = this.requireConnectedProvider();
     const state = this.requireState();
@@ -5679,9 +5747,39 @@ var OwneySDK = class {
    * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
    * so the deposit half of `swapAndDeposit` can be exercised on its own.
    */
-  runSwap(quote, options) {
+  async runSwap(quote, options) {
+    await this.checkSwapGas(quote);
     return executeSwap(this.buildSwapDeps(quote), { quote, ...options });
   }
+  /**
+   * Throws SWAP_INSUFFICIENT_GAS when the wallet cannot pay for this swap.
+   *
+   * Only the classic rail is ever refused: it is the one where the user sends
+   * the transactions. Call it on a preview quote to warn BEFORE a withdrawal
+   * moves anything — `withdrawAndSwap` repeats it on its own quote, but by
+   * then the funds have already left the agent (ROUT-622).
+   */
+  async checkSwapGas(quote) {
+    const state = this.requireState();
+    const chain = swapChain(quote.src.chainId);
+    if (!chain) return;
+    const pub = createPublicClient2({
+      chain,
+      transport: swapReadTransport(quote.src.chainId, this.zyfaiRpcUrls)
+    });
+    const shortfall = await swapGasShortfall(
+      {
+        readNativeBalance: () => pub.getBalance({ address: state.walletAddress }),
+        // The 1559 ceiling, as the wrap reserve reads it.
+        getMaxFeePerGas: async () => {
+          const fees = await pub.estimateFeesPerGas();
+          return fees.maxFeePerGas ?? pub.getGasPrice();
+        }
+      },
+      quote
+    );
+    if (shortfall) throw swapGasError(shortfall, chain.nativeCurrency.symbol);
+  }
   /**
    * The half of the swap deps that only ever talks to the routing API.
    *
@@ -5753,8 +5851,15 @@ var OwneySDK = class {
       );
     }
     await this.ensureSwapChain(entry.chainId);
-    const deposit = await this.deposit({
-      amount: entry.received,
+    const token = entry.symbol === "WETH" ? SPONSORED_WETH_BY_CHAIN[entry.chainId] : void 0;
+    const amount = token ? await this.settleSwapDepositAmount(
+      entry.chainId,
+      token,
+      entry.symbol,
+      BigInt(entry.received)
+    ) : entry.received;
+    const { deposit } = await this.depositSwapOutput({
+      amount,
       asset: entry.symbol,
       ...entry.agentId ? { agentId: entry.agentId } : {}
     });
@@ -5994,12 +6099,12 @@ var OwneySDK = class {
         options.to.symbol,
         BigInt(swap.received)
       );
-      const deposit = await this.deposit({
+      const { deposit, deposited } = await this.depositSwapOutput({
         amount,
         asset: options.to.symbol,
         ...options.agentId ? { agentId: options.agentId } : {}
       });
-      return { swap, deposit, deposited: amount };
+      return { swap, deposit, deposited };
     } catch (error) {
       const pending = {
         id: `${quote.dst.chainId}-${options.to.symbol}-${Date.now()}`,
@@ -6103,6 +6208,7 @@ var OwneySDK = class {
         walletAddress: state.walletAddress
       });
       await this.ensureSwapChain(quote.src.chainId);
+      await this.checkSwapGas(quote);
       const swap = await executeSwap(this.buildSwapDeps(quote), {
         quote,
         walletAddress: state.walletAddress,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owney/sdk",
-  "version": "0.7.28-beta.4",
+  "version": "0.7.28-beta.5",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",