@gearbox-protocol/sdk 14.12.0-next.41 → 14.12.0-next.42

package/dist/cjs/preview/preview/buildDelayedPreview.js

@@ -38,23 +38,12 @@ function buildDelayedPreview(afterInstant, before, detected, convert, receivedTo
       repayFromClaim(post, request.claimToken, converter.convert, claimed);
       break;
     case "WITHDRAW_COLLATERAL": {
-      const withdrawn = import_common_utils.BigIntMath.min(
-        intent.withdrawAmount,
-        post.balances.getOrZero(intent.withdrawToken)
-      );
-      if (withdrawn > 0n) {
-        post.balances.dec(intent.withdrawToken, withdrawn);
-        collateralWithdrawn.upsert(intent.withdrawToken, withdrawn);
-      }
-      const claimSpentOnWithdrawal = (0, import_viem.isAddressEqual)(
-        intent.withdrawToken,
-        request.claimToken
-      ) ? withdrawn : 0n;
-      repayFromClaim(
+      applyWithdrawCollateral(
         post,
-        request.claimToken,
-        converter.convert,
-        import_common_utils.BigIntMath.max(claimed - claimSpentOnWithdrawal, 0n)
+        request,
+        intent,
+        converter,
+        collateralWithdrawn
       );
       break;
     }
@@ -89,6 +78,39 @@ function applyClaim(post, request) {
   post.balances.inc(request.claimToken, claimed);
   return claimed;
 }
+function applyWithdrawCollateral(post, request, intent, converter, collateralWithdrawn) {
+  const { withdrawToken, withdrawAmount, debtRepaid } = intent;
+  const { claimToken } = request;
+  const sameToken = (0, import_viem.isAddressEqual)(withdrawToken, claimToken);
+  const fromBalance = import_common_utils.BigIntMath.min(
+    withdrawAmount,
+    post.balances.getOrZero(withdrawToken)
+  );
+  post.balances.dec(withdrawToken, fromBalance);
+  let withdrawn = fromBalance;
+  const missing = withdrawAmount - fromBalance;
+  if (missing > 0n && !sameToken) {
+    const available = post.balances.getOrZero(claimToken);
+    const cost = converter.convert(withdrawToken, claimToken, missing);
+    if (cost > 0n && cost <= available) {
+      post.balances.dec(claimToken, cost);
+      withdrawn += missing;
+    } else if (available > 0n) {
+      post.balances.dec(claimToken, available);
+      withdrawn += converter.convert(claimToken, withdrawToken, available);
+    }
+  }
+  if (withdrawn > 0n) {
+    collateralWithdrawn.upsert(withdrawToken, withdrawn);
+  }
+  const remaining = post.balances.getOrZero(claimToken);
+  if (remaining > 0n) {
+    const proceeds = converter.convert(claimToken, post.underlying, remaining);
+    post.balances.dec(claimToken, remaining);
+    post.balances.inc(post.underlying, proceeds);
+    post.repay(import_common_utils.BigIntMath.min(proceeds, debtRepaid));
+  }
+}
 function repayFromClaim(post, claimToken, convert, amount) {
   const spent = import_common_utils.BigIntMath.min(amount, post.balances.getOrZero(claimToken));
   if (spent <= 0n) {

package/dist/cjs/sdk/accounts/withdrawal-compressor/intent-codec.js

@@ -25,7 +25,7 @@ __export(intent_codec_exports, {
 });
 module.exports = __toCommonJS(intent_codec_exports);
 var import_viem = require("viem");
-const DELAYED_INTENT_VERSION = 1;
+const DELAYED_INTENT_VERSION = 2;
 const DELAYED_INTENT_TYPES = {
   INCREASE_LEVERAGE: 1,
   DEPOSIT: 2,
@@ -43,7 +43,9 @@ const TO_PARAMS = [...HEADER_PARAMS, { type: "address", name: "to" }];
 const WITHDRAW_COLLATERAL_PARAMS = [
   ...TO_PARAMS,
   { type: "address", name: "withdrawToken" },
-  { type: "uint256", name: "withdrawAmount" }
+  { type: "uint256", name: "withdrawAmount" },
+  { type: "address", name: "sourceToken" },
+  { type: "uint256", name: "debtRepaid" }
 ];
 function encodeDelayedIntent(intent) {
   const version = DELAYED_INTENT_VERSION;
@@ -58,7 +60,9 @@ function encodeDelayedIntent(intent) {
         intentType,
         intent.to,
         intent.withdrawToken,
-        intent.withdrawAmount
+        intent.withdrawAmount,
+        intent.sourceToken,
+        intent.debtRepaid
       ]);
     case "DEPOSIT":
     case "DEPOSIT_AND_INCREASE_LEVERAGE":
@@ -86,15 +90,14 @@ function decodeDelayedIntent(data) {
     case DELAYED_INTENT_TYPES.DEPOSIT_AND_INCREASE_LEVERAGE:
       return { type: "DEPOSIT_AND_INCREASE_LEVERAGE" };
     case DELAYED_INTENT_TYPES.WITHDRAW_COLLATERAL: {
-      const [, , to, withdrawToken, withdrawAmount] = (0, import_viem.decodeAbiParameters)(
-        WITHDRAW_COLLATERAL_PARAMS,
-        data
-      );
+      const [, , to, withdrawToken, withdrawAmount, sourceToken, debtRepaid] = (0, import_viem.decodeAbiParameters)(WITHDRAW_COLLATERAL_PARAMS, data);
       return {
         type: "WITHDRAW_COLLATERAL",
         to,
         withdrawToken,
-        withdrawAmount
+        withdrawAmount,
+        sourceToken,
+        debtRepaid
       };
     }
     case DELAYED_INTENT_TYPES.CLOSE_ACCOUNT: {

package/dist/esm/preview/preview/buildDelayedPreview.js

@@ -1,6 +1,8 @@
 import { isAddressEqual } from "viem";
 import { BigIntMath } from "../../common-utils/index.js";
-import { AssetsMap } from "../../sdk/index.js";
+import {
+  AssetsMap
+} from "../../sdk/index.js";
 import {
   ERROR_UNPRICEABLE_TOKEN,
   PREVIEW_DUST
@@ -18,23 +20,12 @@ function buildDelayedPreview(afterInstant, before, detected, convert, receivedTo
       repayFromClaim(post, request.claimToken, converter.convert, claimed);
       break;
     case "WITHDRAW_COLLATERAL": {
-      const withdrawn = BigIntMath.min(
-        intent.withdrawAmount,
-        post.balances.getOrZero(intent.withdrawToken)
-      );
-      if (withdrawn > 0n) {
-        post.balances.dec(intent.withdrawToken, withdrawn);
-        collateralWithdrawn.upsert(intent.withdrawToken, withdrawn);
-      }
-      const claimSpentOnWithdrawal = isAddressEqual(
-        intent.withdrawToken,
-        request.claimToken
-      ) ? withdrawn : 0n;
-      repayFromClaim(
+      applyWithdrawCollateral(
         post,
-        request.claimToken,
-        converter.convert,
-        BigIntMath.max(claimed - claimSpentOnWithdrawal, 0n)
+        request,
+        intent,
+        converter,
+        collateralWithdrawn
       );
       break;
     }
@@ -69,6 +60,39 @@ function applyClaim(post, request) {
   post.balances.inc(request.claimToken, claimed);
   return claimed;
 }
+function applyWithdrawCollateral(post, request, intent, converter, collateralWithdrawn) {
+  const { withdrawToken, withdrawAmount, debtRepaid } = intent;
+  const { claimToken } = request;
+  const sameToken = isAddressEqual(withdrawToken, claimToken);
+  const fromBalance = BigIntMath.min(
+    withdrawAmount,
+    post.balances.getOrZero(withdrawToken)
+  );
+  post.balances.dec(withdrawToken, fromBalance);
+  let withdrawn = fromBalance;
+  const missing = withdrawAmount - fromBalance;
+  if (missing > 0n && !sameToken) {
+    const available = post.balances.getOrZero(claimToken);
+    const cost = converter.convert(withdrawToken, claimToken, missing);
+    if (cost > 0n && cost <= available) {
+      post.balances.dec(claimToken, cost);
+      withdrawn += missing;
+    } else if (available > 0n) {
+      post.balances.dec(claimToken, available);
+      withdrawn += converter.convert(claimToken, withdrawToken, available);
+    }
+  }
+  if (withdrawn > 0n) {
+    collateralWithdrawn.upsert(withdrawToken, withdrawn);
+  }
+  const remaining = post.balances.getOrZero(claimToken);
+  if (remaining > 0n) {
+    const proceeds = converter.convert(claimToken, post.underlying, remaining);
+    post.balances.dec(claimToken, remaining);
+    post.balances.inc(post.underlying, proceeds);
+    post.repay(BigIntMath.min(proceeds, debtRepaid));
+  }
+}
 function repayFromClaim(post, claimToken, convert, amount) {
   const spent = BigIntMath.min(amount, post.balances.getOrZero(claimToken));
   if (spent <= 0n) {

package/dist/esm/sdk/accounts/withdrawal-compressor/intent-codec.js

@@ -1,5 +1,5 @@
 import { decodeAbiParameters, encodeAbiParameters } from "viem";
-const DELAYED_INTENT_VERSION = 1;
+const DELAYED_INTENT_VERSION = 2;
 const DELAYED_INTENT_TYPES = {
   INCREASE_LEVERAGE: 1,
   DEPOSIT: 2,
@@ -17,7 +17,9 @@ const TO_PARAMS = [...HEADER_PARAMS, { type: "address", name: "to" }];
 const WITHDRAW_COLLATERAL_PARAMS = [
   ...TO_PARAMS,
   { type: "address", name: "withdrawToken" },
-  { type: "uint256", name: "withdrawAmount" }
+  { type: "uint256", name: "withdrawAmount" },
+  { type: "address", name: "sourceToken" },
+  { type: "uint256", name: "debtRepaid" }
 ];
 function encodeDelayedIntent(intent) {
   const version = DELAYED_INTENT_VERSION;
@@ -32,7 +34,9 @@ function encodeDelayedIntent(intent) {
         intentType,
         intent.to,
         intent.withdrawToken,
-        intent.withdrawAmount
+        intent.withdrawAmount,
+        intent.sourceToken,
+        intent.debtRepaid
       ]);
     case "DEPOSIT":
     case "DEPOSIT_AND_INCREASE_LEVERAGE":
@@ -60,15 +64,14 @@ function decodeDelayedIntent(data) {
     case DELAYED_INTENT_TYPES.DEPOSIT_AND_INCREASE_LEVERAGE:
       return { type: "DEPOSIT_AND_INCREASE_LEVERAGE" };
     case DELAYED_INTENT_TYPES.WITHDRAW_COLLATERAL: {
-      const [, , to, withdrawToken, withdrawAmount] = decodeAbiParameters(
-        WITHDRAW_COLLATERAL_PARAMS,
-        data
-      );
+      const [, , to, withdrawToken, withdrawAmount, sourceToken, debtRepaid] = decodeAbiParameters(WITHDRAW_COLLATERAL_PARAMS, data);
       return {
         type: "WITHDRAW_COLLATERAL",
         to,
         withdrawToken,
-        withdrawAmount
+        withdrawAmount,
+        sourceToken,
+        debtRepaid
       };
     }
     case DELAYED_INTENT_TYPES.CLOSE_ACCOUNT: {

package/dist/types/preview/preview/buildDelayedPreview.d.ts

@@ -8,34 +8,16 @@ import { type InstantOperationPreview } from "./types.js";
 export type ConvertFn = (token: Address, to: Address, amount: bigint) => bigint;
 /**
  * Builds the best-effort preview of the account state after the detected
- * delayed withdrawal is claimed and its intent (if any) is resumed.
+ * delayed withdrawal is claimed and its intent (if any) is resumed:
+ * the claim itself followed by the intent-specific tail
  *
- * Pure function: reads the post-instant account state, never mutates it and
- * performs no network access. Swaps that the resume flow would route through
- * the router are estimated with the injected oracle conversion; tokens the
- * oracle cannot price contribute nothing and set a non-fatal
- * `ERROR_UNPRICEABLE_TOKEN` error on the preview.
+ * Pure function: the input states are never mutated and no network access is performed.
+ * Swaps are estimated with the injected conversion; tokens it cannot price contribute
+ * nothing and set a non-fatal `ERROR_UNPRICEABLE_TOKEN` error on the
+ * preview.
  *
- * Common claim step (all intents): the phantom token is burned (balance and
- * quota zeroed) and the claim token is credited with the same amount 1:1.
- *
- * Intent-specific resume:
- * - `CLOSE_ACCOUNT`: everything is swapped into the underlying, the debt is
- *   fully repaid and the rest is withdrawn to the user as `receivedToken`
- *   (the unwrapped underlying for RWA markets, converting 1:1 with the
- *   underlying; the underlying itself otherwise).
- * - `DECREASE_LEVERAGE`: the claimed amount is swapped into the underlying
- *   and used to decrease the debt.
- * - `WITHDRAW_COLLATERAL`: the recorded amount of the recorded token is
- *   withdrawn to the user, the rest of the claimed amount decreases the debt.
- * - other intents and `intent: undefined`: claim-only, the post-claim swap
- *   target is not recoverable from the intent.
- *
- * The changes (`debtChange`, `quotasChange`, `assetsChange`) are reported
- * relative to the account state before the whole transaction, not the
- * post-instant-part state: to the user the delayed preview answers "where will
- * the account end up compared to now", so the transient phantom token
- * (minted by the instant part, burned by the claim) nets out to nothing.
+ * The changes (e.g. `debtChange`) are reported relative to the account
+ * state before the whole transaction.
  *
  * @param afterInstant - Account state after the instant part of the
  * transaction.

package/dist/types/sdk/accounts/withdrawal-compressor/intent-codec.d.ts

@@ -4,7 +4,7 @@ import type { DelayedIntent } from "./types.js";
  * Current version of the delayed intent encoding schema.
  * Bump when the layout of any intent type changes.
  **/
-export declare const DELAYED_INTENT_VERSION = 1;
+export declare const DELAYED_INTENT_VERSION = 2;
 /**
  * Stable uint8 discriminants for intent types.
  * Starts at 1 so that all-zero data cannot decode as a valid intent.

package/dist/types/sdk/accounts/withdrawal-compressor/types.d.ts

@@ -31,8 +31,9 @@ export interface DelayedDepositAndIncreaseLeverageIntent {
 }
 /**
  * App: 2.1 Withdraw — withdraw selected token at fixed leverage.
- * Swap token into `underlying` -> [decrease debt with `underlying` ->
- * withdraw token to wallet].
+ * Primary goal is `withdrawAmount` of `withdrawToken` (W of T). Debt cut is
+ * residual from the claim/path after reserving W. `sourceToken` (S) funds the
+ * delayed path; `debtRepaid` is 0 when debt was already repaid on start.
  **/
 export interface DelayedWithdrawCollateralIntent {
     type: "WITHDRAW_COLLATERAL";
@@ -46,9 +47,18 @@ export interface DelayedWithdrawCollateralIntent {
      **/
     withdrawToken: Address;
     /**
-     * Amount of `withdrawToken` to withdraw to the wallet after the claim
+     * Amount of `withdrawToken` to withdraw to the wallet after the claim (W)
      **/
     withdrawAmount: bigint;
+    /**
+     * Token that funds the delayed path / debt conversion (S)
+     **/
+    sourceToken: Address;
+    /**
+     * Desired debt decrease in underlying units remaining for resume.
+     * `0n` when debt was already repaid on the delayed-start branch.
+     **/
+    debtRepaid: bigint;
 }
 /**
  * App: 2.2 Withdraw — close account (receive leftover to wallet).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.41",
+  "version": "14.12.0-next.42",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {