@owney/sdk 0.7.26-beta.7 → 0.7.26

package/README.md

@@ -134,6 +134,13 @@ Deposit funds into a specific agent, or split equally across all agents if `agen
 | `options.depositCallback` | `DepositCallback`    | Callback that performs the token transfer and returns a tx hash |
 | `options.agentId`         | `AgentId` (optional) | Target agent. Omit to split equally across all agents.          |
 
+Zyfai's native transfer path uses `sendDeposit()`. It returns after the token
+transfer confirms and the deposit is registered, while balance credit may still
+be queued. Balance reads reflect subsequent credit and allocation; the deposit
+call does not wait for `waitForDepositCredit()`.
+A successful deposit result confirms the transfer; it does not guarantee that
+the funds are already credited or earning yield.
+
 Returns: `OwneyDepositResult` (single agent) or `OwneyMultiDepositResult` (all agents)
 
 ```typescript

package/dist/index.cjs

@@ -1352,7 +1352,7 @@ var ZyfaiAgent = class _ZyfaiAgent {
    * chain/account switch fires the provider's `accountsChanged` →
    * `disconnectAccount` (nulls walletClient + authenticatedUserId) while our
    * own `connectAuth` guard still believes this chain is connected and
-   * early-returns. Without this, authenticated calls (depositFunds,
+   * early-returns. Without this, authenticated calls (sendDeposit,
    * withdrawFunds) fail with "No account connected".
    */
   async ensureConnected(state, chainId) {
@@ -1930,7 +1930,7 @@ var ZyfaiAgent = class _ZyfaiAgent {
         return { txHash, smartWallet, amount };
       }
       await this.ensureWalletDeployed(this.getAddress(), validChainId);
-      const raw = await this.sdk.depositFunds(
+      const raw = await this.sdk.sendDeposit(
         this.getAddress(),
         validChainId,
         amount,
@@ -2499,9 +2499,24 @@ async function wrapNative(deps, options) {
       message: error instanceof Error ? error.message : String(error)
     });
   }
+  let approvalPending = true;
+  if (options.spender && deps.readAllowance) {
+    try {
+      const allowance = await deps.readAllowance(wrapper, options.spender);
+      approvalPending = allowance < requested;
+    } catch (error) {
+      debugLog(
+        "owney-sdk",
+        "wrap: allowance read failed, assuming an approve",
+        {
+          message: error instanceof Error ? error.message : String(error)
+        }
+      );
+    }
+  }
   const measured = await deps.getMaxFeePerGas();
   const gasPrice = measured > MIN_WALLET_GAS_PRICE ? measured : MIN_WALLET_GAS_PRICE;
-  const reserve = (wrapGas + APPROVE_GAS) * gasPrice * GAS_SAFETY;
+  const reserve = (wrapGas + (approvalPending ? APPROVE_GAS : 0n)) * gasPrice * GAS_SAFETY;
   const spendable = balance > reserve ? balance - reserve : 0n;
   const wrapped = requested < spendable ? requested : spendable;
   debugLog("owney-sdk", "wrap: sizing", {
@@ -2509,6 +2524,7 @@ async function wrapNative(deps, options) {
     requested: requested.toString(),
     measuredGasPrice: measured.toString(),
     reservedAtGasPrice: gasPrice.toString(),
+    approvalPending,
     reserve: reserve.toString(),
     wrapped: wrapped.toString()
   });
@@ -3102,7 +3118,7 @@ async function runSameChainFusion(deps, options, walletAddress) {
   const isNativeSource = quote.src.address.toLowerCase().startsWith("0xeeee");
   const amount = isNativeSource ? BigInt(quote.src.amount) : await affordableAmount(deps, BigInt(quote.src.amount));
   const permit = await authoriseSpend(deps, options, amount, isNativeSource);
-  onStage?.("quoting");
+  onStage?.("building");
   debugLog("owney-sdk", "swap: building same-chain fusion order");
   const built = await deps.api.buildOrder({
     from: {
@@ -3184,7 +3200,7 @@ async function runFusion(deps, options, walletAddress) {
   const amount = await affordableAmount(deps, BigInt(quote.src.amount));
   const permit = await authoriseSpend(deps, options, amount, false);
   const { secrets, secretHashes } = mintSecrets(quote.secretsCount ?? 1);
-  onStage?.("quoting");
+  onStage?.("building");
   debugLog("owney-sdk", "swap: building fusion order", {
     secrets: secretHashes.length
   });
@@ -5012,13 +5028,25 @@ var OwneySDK = class {
           }
           return hash;
         },
-        ensureChain: (id) => this.ensureSwapChain(id)
+        ensureChain: (id) => this.ensureSwapChain(id),
+        // Read through the same public client as every other sizing input, so
+        // a wallet sitting on the wrong chain cannot answer for this one.
+        readAllowance: (token, spender) => publicClient.readContract({
+          address: token,
+          abi: ERC20_ALLOWANCE_ABI,
+          functionName: "allowance",
+          args: [walletAddress, spender]
+        })
       },
       {
         chainId,
         wrapper: wrapper.address,
         nativeSymbol: quote.src.symbol,
         requested: BigInt(quote.src.amount),
+        // Lets the reserve skip the approve's gas when one is already in
+        // place. Absent on a quote that names no spender, which keeps the
+        // full reserve (ROUT-242, comment 16234).
+        ...quote.spender ? { spender: quote.spender } : {},
         onSubmitted: () => onStage?.("wrapped")
       }
     );
@@ -5199,6 +5227,64 @@ var OwneySDK = class {
    * the deposit's own check is the authority and refusing to even attempt
    * would strand funds we might have been able to move.
    */
+  /** ERC20 balance of the connected wallet, read through the wallet's own node. */
+  async readTokenBalance(chainId, token) {
+    const state = this.requireState();
+    return readErc20Balance(
+      (0, import_viem9.createPublicClient)({
+        chain: swapChain(chainId),
+        transport: (0, import_viem9.custom)(this.requireConnectedProvider())
+      }),
+      token,
+      state.walletAddress
+    );
+  }
+  /** How much of `token` the wallet has already approved Permit2 to move. */
+  async readTokenPermit2Allowance(chainId, token) {
+    const state = this.requireState();
+    return readPermit2Allowance(
+      (0, import_viem9.createPublicClient)({
+        chain: swapChain(chainId),
+        transport: (0, import_viem9.custom)(this.requireConnectedProvider())
+      }),
+      token,
+      state.walletAddress
+    );
+  }
+  /**
+   * How much of a landed swap to actually deposit.
+   *
+   * The swap reports what ARRIVED, and the deposit used to be handed that
+   * figure directly. It is the entire arrival, so there is no slack: anything
+   * that spends the target asset between the two fails the deposit outright.
+   *
+   * Something does. A first WETH deposit needs a one-time Permit2 approval,
+   * and that approval is a transaction. A wallet holding no native gas token -
+   * the normal state of someone who just swapped everything INTO WETH - pays
+   * for it out of the WETH. The deposit then asked for ~2e12 wei more than was
+   * left and refused with DEPOSIT_INSUFFICIENT_BALANCE, under a wrapper saying
+   * the funds were safe but unadded (ROUT-242).
+   *
+   * So the approval happens here, before the amount is settled, and the amount
+   * comes from a read taken after it. Two things this deliberately is not:
+   *
+   * - It is not a balance sweep. `received` is a DELTA over the pre-swap
+   *   balance, so a wallet already holding WETH reads far above it; depositing
+   *   the balance would move funds the user never offered. The arrival is the
+   *   ceiling and the balance is only ever allowed to lower it.
+   * - It does not touch USDC, which moves on signed typed data and so spends
+   *   nothing of the user's in between, nor a paymaster-configured client,
+   *   where the sponsor covers the transfer and Permit2 never applies.
+   */
+  async settleSwapDepositAmount(chainId, token, symbol, received) {
+    if (symbol !== "WETH" || this.paymasterServiceUrl) {
+      return received.toString();
+    }
+    const allowance = await this.readTokenPermit2Allowance(chainId, token);
+    if (allowance < received) await this.approvePermit2();
+    const balance = await this.readTokenBalance(chainId, token);
+    return (balance < received ? balance : received).toString();
+  }
   async walletSeesBalance(chainId, token, amount) {
     const provider = this.requireConnectedProvider();
     const state = this.requireState();
@@ -5427,7 +5513,7 @@ var OwneySDK = class {
    */
   async getWalletBalances(chainIds) {
     const state = this.requireState();
-    const chains = chainIds ?? SUPPORTED_CHAIN_IDS;
+    const chains = chainIds ?? SWAP_CHAIN_IDS;
     const failedChainIds = [];
     const results = await Promise.all(
       chains.map(async (chainId) => {
@@ -5533,12 +5619,18 @@ var OwneySDK = class {
         quote.dst.address,
         BigInt(swap.received)
       );
+      const amount = await this.settleSwapDepositAmount(
+        quote.dst.chainId,
+        quote.dst.address,
+        options.to.symbol,
+        BigInt(swap.received)
+      );
       const deposit = await this.deposit({
-        amount: swap.received,
+        amount,
         asset: options.to.symbol,
         ...options.agentId ? { agentId: options.agentId } : {}
       });
-      return { swap, deposit };
+      return { swap, deposit, deposited: amount };
     } catch (error) {
       const pending = {
         id: `${quote.dst.chainId}-${options.to.symbol}-${Date.now()}`,

package/dist/index.d.cts

@@ -220,7 +220,7 @@ type SwapOrderStatus = "pending" | "executed" | "expired" | "cancelled" | "refun
  * of the flow and the one place a user would otherwise think nothing is
  * happening.
  */
-type SwapStage = "withdrawing" | "withdrawn" | "quoting" | "wrapping" | "wrapped" | "approving" | "signing" | "swapping" | "swapped" | "depositing" | "refunding" | "refunded";
+type SwapStage = "withdrawing" | "withdrawn" | "quoting" | "wrapping" | "wrapped" | "approving" | "building" | "signing" | "swapping" | "swapped" | "depositing" | "refunding" | "refunded";
 /**
  * Which way the funds travel, which decides what each side may be.
  *
@@ -1129,6 +1129,36 @@ declare class OwneySDK {
      * the deposit's own check is the authority and refusing to even attempt
      * would strand funds we might have been able to move.
      */
+    /** ERC20 balance of the connected wallet, read through the wallet's own node. */
+    private readTokenBalance;
+    /** How much of `token` the wallet has already approved Permit2 to move. */
+    private readTokenPermit2Allowance;
+    /**
+     * How much of a landed swap to actually deposit.
+     *
+     * The swap reports what ARRIVED, and the deposit used to be handed that
+     * figure directly. It is the entire arrival, so there is no slack: anything
+     * that spends the target asset between the two fails the deposit outright.
+     *
+     * Something does. A first WETH deposit needs a one-time Permit2 approval,
+     * and that approval is a transaction. A wallet holding no native gas token -
+     * the normal state of someone who just swapped everything INTO WETH - pays
+     * for it out of the WETH. The deposit then asked for ~2e12 wei more than was
+     * left and refused with DEPOSIT_INSUFFICIENT_BALANCE, under a wrapper saying
+     * the funds were safe but unadded (ROUT-242).
+     *
+     * So the approval happens here, before the amount is settled, and the amount
+     * comes from a read taken after it. Two things this deliberately is not:
+     *
+     * - It is not a balance sweep. `received` is a DELTA over the pre-swap
+     *   balance, so a wallet already holding WETH reads far above it; depositing
+     *   the balance would move funds the user never offered. The arrival is the
+     *   ceiling and the balance is only ever allowed to lower it.
+     * - It does not touch USDC, which moves on signed typed data and so spends
+     *   nothing of the user's in between, nor a paymaster-configured client,
+     *   where the sponsor covers the transfer and Permit2 never applies.
+     */
+    private settleSwapDepositAmount;
     private walletSeesBalance;
     /**
      * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
@@ -1328,6 +1358,12 @@ declare class OwneySDK {
             txHash?: string;
         };
         deposit: OwneyDepositResult | OwneyMultiDepositResult;
+        /**
+         * What was actually deposited, which is not always what the swap
+         * delivered - see `settleSwapDepositAmount`. Callers seeding a headline
+         * want this one; `swap.received` stays what it says it is.
+         */
+        deposited: string;
     }>;
     /**
      * Withdraw from an agent and swap the proceeds into whatever the user wants

package/dist/index.d.ts

@@ -220,7 +220,7 @@ type SwapOrderStatus = "pending" | "executed" | "expired" | "cancelled" | "refun
  * of the flow and the one place a user would otherwise think nothing is
  * happening.
  */
-type SwapStage = "withdrawing" | "withdrawn" | "quoting" | "wrapping" | "wrapped" | "approving" | "signing" | "swapping" | "swapped" | "depositing" | "refunding" | "refunded";
+type SwapStage = "withdrawing" | "withdrawn" | "quoting" | "wrapping" | "wrapped" | "approving" | "building" | "signing" | "swapping" | "swapped" | "depositing" | "refunding" | "refunded";
 /**
  * Which way the funds travel, which decides what each side may be.
  *
@@ -1129,6 +1129,36 @@ declare class OwneySDK {
      * the deposit's own check is the authority and refusing to even attempt
      * would strand funds we might have been able to move.
      */
+    /** ERC20 balance of the connected wallet, read through the wallet's own node. */
+    private readTokenBalance;
+    /** How much of `token` the wallet has already approved Permit2 to move. */
+    private readTokenPermit2Allowance;
+    /**
+     * How much of a landed swap to actually deposit.
+     *
+     * The swap reports what ARRIVED, and the deposit used to be handed that
+     * figure directly. It is the entire arrival, so there is no slack: anything
+     * that spends the target asset between the two fails the deposit outright.
+     *
+     * Something does. A first WETH deposit needs a one-time Permit2 approval,
+     * and that approval is a transaction. A wallet holding no native gas token -
+     * the normal state of someone who just swapped everything INTO WETH - pays
+     * for it out of the WETH. The deposit then asked for ~2e12 wei more than was
+     * left and refused with DEPOSIT_INSUFFICIENT_BALANCE, under a wrapper saying
+     * the funds were safe but unadded (ROUT-242).
+     *
+     * So the approval happens here, before the amount is settled, and the amount
+     * comes from a read taken after it. Two things this deliberately is not:
+     *
+     * - It is not a balance sweep. `received` is a DELTA over the pre-swap
+     *   balance, so a wallet already holding WETH reads far above it; depositing
+     *   the balance would move funds the user never offered. The arrival is the
+     *   ceiling and the balance is only ever allowed to lower it.
+     * - It does not touch USDC, which moves on signed typed data and so spends
+     *   nothing of the user's in between, nor a paymaster-configured client,
+     *   where the sponsor covers the transfer and Permit2 never applies.
+     */
+    private settleSwapDepositAmount;
     private walletSeesBalance;
     /**
      * Runs a quoted swap. A named seam rather than an inline `executeSwap` call
@@ -1328,6 +1358,12 @@ declare class OwneySDK {
             txHash?: string;
         };
         deposit: OwneyDepositResult | OwneyMultiDepositResult;
+        /**
+         * What was actually deposited, which is not always what the swap
+         * delivered - see `settleSwapDepositAmount`. Callers seeding a headline
+         * want this one; `swap.received` stays what it says it is.
+         */
+        deposited: string;
     }>;
     /**
      * Withdraw from an agent and swap the proceeds into whatever the user wants

package/dist/index.js

@@ -1312,7 +1312,7 @@ var ZyfaiAgent = class _ZyfaiAgent {
    * chain/account switch fires the provider's `accountsChanged` →
    * `disconnectAccount` (nulls walletClient + authenticatedUserId) while our
    * own `connectAuth` guard still believes this chain is connected and
-   * early-returns. Without this, authenticated calls (depositFunds,
+   * early-returns. Without this, authenticated calls (sendDeposit,
    * withdrawFunds) fail with "No account connected".
    */
   async ensureConnected(state, chainId) {
@@ -1890,7 +1890,7 @@ var ZyfaiAgent = class _ZyfaiAgent {
         return { txHash, smartWallet, amount };
       }
       await this.ensureWalletDeployed(this.getAddress(), validChainId);
-      const raw = await this.sdk.depositFunds(
+      const raw = await this.sdk.sendDeposit(
         this.getAddress(),
         validChainId,
         amount,
@@ -2459,9 +2459,24 @@ async function wrapNative(deps, options) {
       message: error instanceof Error ? error.message : String(error)
     });
   }
+  let approvalPending = true;
+  if (options.spender && deps.readAllowance) {
+    try {
+      const allowance = await deps.readAllowance(wrapper, options.spender);
+      approvalPending = allowance < requested;
+    } catch (error) {
+      debugLog(
+        "owney-sdk",
+        "wrap: allowance read failed, assuming an approve",
+        {
+          message: error instanceof Error ? error.message : String(error)
+        }
+      );
+    }
+  }
   const measured = await deps.getMaxFeePerGas();
   const gasPrice = measured > MIN_WALLET_GAS_PRICE ? measured : MIN_WALLET_GAS_PRICE;
-  const reserve = (wrapGas + APPROVE_GAS) * gasPrice * GAS_SAFETY;
+  const reserve = (wrapGas + (approvalPending ? APPROVE_GAS : 0n)) * gasPrice * GAS_SAFETY;
   const spendable = balance > reserve ? balance - reserve : 0n;
   const wrapped = requested < spendable ? requested : spendable;
   debugLog("owney-sdk", "wrap: sizing", {
@@ -2469,6 +2484,7 @@ async function wrapNative(deps, options) {
     requested: requested.toString(),
     measuredGasPrice: measured.toString(),
     reservedAtGasPrice: gasPrice.toString(),
+    approvalPending,
     reserve: reserve.toString(),
     wrapped: wrapped.toString()
   });
@@ -3072,7 +3088,7 @@ async function runSameChainFusion(deps, options, walletAddress) {
   const isNativeSource = quote.src.address.toLowerCase().startsWith("0xeeee");
   const amount = isNativeSource ? BigInt(quote.src.amount) : await affordableAmount(deps, BigInt(quote.src.amount));
   const permit = await authoriseSpend(deps, options, amount, isNativeSource);
-  onStage?.("quoting");
+  onStage?.("building");
   debugLog("owney-sdk", "swap: building same-chain fusion order");
   const built = await deps.api.buildOrder({
     from: {
@@ -3154,7 +3170,7 @@ async function runFusion(deps, options, walletAddress) {
   const amount = await affordableAmount(deps, BigInt(quote.src.amount));
   const permit = await authoriseSpend(deps, options, amount, false);
   const { secrets, secretHashes } = mintSecrets(quote.secretsCount ?? 1);
-  onStage?.("quoting");
+  onStage?.("building");
   debugLog("owney-sdk", "swap: building fusion order", {
     secrets: secretHashes.length
   });
@@ -4993,13 +5009,25 @@ var OwneySDK = class {
           }
           return hash;
         },
-        ensureChain: (id) => this.ensureSwapChain(id)
+        ensureChain: (id) => this.ensureSwapChain(id),
+        // Read through the same public client as every other sizing input, so
+        // a wallet sitting on the wrong chain cannot answer for this one.
+        readAllowance: (token, spender) => publicClient.readContract({
+          address: token,
+          abi: ERC20_ALLOWANCE_ABI,
+          functionName: "allowance",
+          args: [walletAddress, spender]
+        })
       },
       {
         chainId,
         wrapper: wrapper.address,
         nativeSymbol: quote.src.symbol,
         requested: BigInt(quote.src.amount),
+        // Lets the reserve skip the approve's gas when one is already in
+        // place. Absent on a quote that names no spender, which keeps the
+        // full reserve (ROUT-242, comment 16234).
+        ...quote.spender ? { spender: quote.spender } : {},
         onSubmitted: () => onStage?.("wrapped")
       }
     );
@@ -5180,6 +5208,64 @@ var OwneySDK = class {
    * the deposit's own check is the authority and refusing to even attempt
    * would strand funds we might have been able to move.
    */
+  /** ERC20 balance of the connected wallet, read through the wallet's own node. */
+  async readTokenBalance(chainId, token) {
+    const state = this.requireState();
+    return readErc20Balance(
+      createPublicClient2({
+        chain: swapChain(chainId),
+        transport: custom(this.requireConnectedProvider())
+      }),
+      token,
+      state.walletAddress
+    );
+  }
+  /** How much of `token` the wallet has already approved Permit2 to move. */
+  async readTokenPermit2Allowance(chainId, token) {
+    const state = this.requireState();
+    return readPermit2Allowance(
+      createPublicClient2({
+        chain: swapChain(chainId),
+        transport: custom(this.requireConnectedProvider())
+      }),
+      token,
+      state.walletAddress
+    );
+  }
+  /**
+   * How much of a landed swap to actually deposit.
+   *
+   * The swap reports what ARRIVED, and the deposit used to be handed that
+   * figure directly. It is the entire arrival, so there is no slack: anything
+   * that spends the target asset between the two fails the deposit outright.
+   *
+   * Something does. A first WETH deposit needs a one-time Permit2 approval,
+   * and that approval is a transaction. A wallet holding no native gas token -
+   * the normal state of someone who just swapped everything INTO WETH - pays
+   * for it out of the WETH. The deposit then asked for ~2e12 wei more than was
+   * left and refused with DEPOSIT_INSUFFICIENT_BALANCE, under a wrapper saying
+   * the funds were safe but unadded (ROUT-242).
+   *
+   * So the approval happens here, before the amount is settled, and the amount
+   * comes from a read taken after it. Two things this deliberately is not:
+   *
+   * - It is not a balance sweep. `received` is a DELTA over the pre-swap
+   *   balance, so a wallet already holding WETH reads far above it; depositing
+   *   the balance would move funds the user never offered. The arrival is the
+   *   ceiling and the balance is only ever allowed to lower it.
+   * - It does not touch USDC, which moves on signed typed data and so spends
+   *   nothing of the user's in between, nor a paymaster-configured client,
+   *   where the sponsor covers the transfer and Permit2 never applies.
+   */
+  async settleSwapDepositAmount(chainId, token, symbol, received) {
+    if (symbol !== "WETH" || this.paymasterServiceUrl) {
+      return received.toString();
+    }
+    const allowance = await this.readTokenPermit2Allowance(chainId, token);
+    if (allowance < received) await this.approvePermit2();
+    const balance = await this.readTokenBalance(chainId, token);
+    return (balance < received ? balance : received).toString();
+  }
   async walletSeesBalance(chainId, token, amount) {
     const provider = this.requireConnectedProvider();
     const state = this.requireState();
@@ -5408,7 +5494,7 @@ var OwneySDK = class {
    */
   async getWalletBalances(chainIds) {
     const state = this.requireState();
-    const chains = chainIds ?? SUPPORTED_CHAIN_IDS;
+    const chains = chainIds ?? SWAP_CHAIN_IDS;
     const failedChainIds = [];
     const results = await Promise.all(
       chains.map(async (chainId) => {
@@ -5514,12 +5600,18 @@ var OwneySDK = class {
         quote.dst.address,
         BigInt(swap.received)
       );
+      const amount = await this.settleSwapDepositAmount(
+        quote.dst.chainId,
+        quote.dst.address,
+        options.to.symbol,
+        BigInt(swap.received)
+      );
       const deposit = await this.deposit({
-        amount: swap.received,
+        amount,
         asset: options.to.symbol,
         ...options.agentId ? { agentId: options.agentId } : {}
       });
-      return { swap, deposit };
+      return { swap, deposit, deposited: amount };
     } catch (error) {
       const pending = {
         id: `${quote.dst.chainId}-${options.to.symbol}-${Date.now()}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owney/sdk",
-  "version": "0.7.26-beta.7",
+  "version": "0.7.26",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -23,7 +23,7 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@zyfai/sdk": "0.2.55",
+    "@zyfai/sdk": "0.3.1",
     "siwe": "^3.0.0",
     "viem": "^2.48.1"
   },