@gearbox-protocol/sdk 14.12.0-next.33 → 14.12.0-next.35

package/dist/cjs/abi/IWithdrawalCompressorV313.js

@@ -102,6 +102,100 @@ const iWithdrawalCompressorV313Abi = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "getExternalAccountCurrentWithdrawals",
+    inputs: [
+      { name: "withdrawalToken", type: "address", internalType: "address" },
+      { name: "account", type: "address", internalType: "address" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct ClaimableWithdrawal[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            type: "address",
+            internalType: "address"
+          },
+          {
+            name: "withdrawalTokenSpent",
+            type: "uint256",
+            internalType: "uint256"
+          },
+          {
+            name: "outputs",
+            type: "tuple[]",
+            internalType: "struct WithdrawalOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "isDelayed", type: "bool", internalType: "bool" },
+              { name: "amount", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "claimCalls",
+            type: "tuple[]",
+            internalType: "struct MultiCall[]",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "extraData", type: "bytes", internalType: "bytes" }
+        ]
+      },
+      {
+        name: "",
+        type: "tuple[]",
+        internalType: "struct PendingWithdrawal[]",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          {
+            name: "withdrawalPhantomToken",
+            type: "address",
+            internalType: "address"
+          },
+          {
+            name: "expectedOutputs",
+            type: "tuple[]",
+            internalType: "struct WithdrawalOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "isDelayed", type: "bool", internalType: "bool" },
+              { name: "amount", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          { name: "claimableAt", type: "uint256", internalType: "uint256" },
+          { name: "extraData", type: "bytes", internalType: "bytes" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getWithdrawalStatus",
+    inputs: [{ name: "redeemer", type: "address", internalType: "address" }],
+    outputs: [
+      { name: "", type: "uint8", internalType: "enum WithdrawalStatus" }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getWithdrawalStatus",
+    inputs: [
+      { name: "redeemers", type: "address[]", internalType: "address[]" }
+    ],
+    outputs: [
+      { name: "", type: "uint8[]", internalType: "enum WithdrawalStatus[]" }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "getWithdrawableAssets",
@@ -175,6 +269,48 @@ const iWithdrawalCompressorV313Abi = [
     ],
     stateMutability: "view"
   },
+  {
+    type: "function",
+    name: "getWithdrawalRequestResult",
+    inputs: [
+      { name: "creditAccount", type: "address", internalType: "address" },
+      { name: "token", type: "address", internalType: "address" },
+      { name: "withdrawalToken", type: "address", internalType: "address" },
+      { name: "amount", type: "uint256", internalType: "uint256" }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "tuple",
+        internalType: "struct RequestableWithdrawal",
+        components: [
+          { name: "token", type: "address", internalType: "address" },
+          { name: "amountIn", type: "uint256", internalType: "uint256" },
+          {
+            name: "outputs",
+            type: "tuple[]",
+            internalType: "struct WithdrawalOutput[]",
+            components: [
+              { name: "token", type: "address", internalType: "address" },
+              { name: "isDelayed", type: "bool", internalType: "bool" },
+              { name: "amount", type: "uint256", internalType: "uint256" }
+            ]
+          },
+          {
+            name: "requestCalls",
+            type: "tuple[]",
+            internalType: "struct MultiCall[]",
+            components: [
+              { name: "target", type: "address", internalType: "address" },
+              { name: "callData", type: "bytes", internalType: "bytes" }
+            ]
+          },
+          { name: "claimableAt", type: "uint256", internalType: "uint256" }
+        ]
+      }
+    ],
+    stateMutability: "view"
+  },
   {
     type: "function",
     name: "getWithdrawalRequestResult",

package/dist/cjs/plugins/delayed-withdrawal/DelayedWithdrawalPlugin.js

@@ -24,16 +24,31 @@ module.exports = __toCommonJS(DelayedWithdrawalPlugin_exports);
 var import_sdk = require("../../sdk/index.js");
 const MAP_LABEL = "delayedWithdrawal";
 class DelayedWithdrawalPlugin extends import_sdk.BasePlugin {
-  #withdrawableAssets;
   async load(force) {
     if (!force && this.loaded) {
       return this.state;
     }
-    this.#withdrawableAssets = new import_sdk.AddressMap(void 0, MAP_LABEL);
-    const resp = await this.sdk.withdrawalCompressor.getWithdrawableAssetsBatch();
-    const byCreditManager = /* @__PURE__ */ new Map();
-    for (const cfg of resp) {
-      const assets = byCreditManager.get(cfg.creditManager) ?? [];
+    await this.sdk.withdrawalCompressor?.loadWithdrawableAssets(force);
+    return this.state;
+  }
+  get loaded() {
+    return !!this.sdk.withdrawalCompressor?.state;
+  }
+  /**
+   * Returns a map of cmAddress -> array of delayed assets
+   * @throws if withdrawable assets have not been loaded
+   */
+  get withdrawableAssets() {
+    const compressor = this.sdk.withdrawalCompressor;
+    if (!compressor?.state) {
+      throw new Error("withdrawable assets are not loaded");
+    }
+    const result = new import_sdk.AddressMap(
+      void 0,
+      MAP_LABEL
+    );
+    for (const cfg of compressor.getWithdrawableAssets()) {
+      const assets = result.get(cfg.creditManager) ?? [];
       assets.push({
         ...cfg,
         disabled: isConfigToOmit({
@@ -43,25 +58,9 @@ class DelayedWithdrawalPlugin extends import_sdk.BasePlugin {
           underlying: cfg.underlying
         })
       });
-      byCreditManager.set(cfg.creditManager, assets);
-    }
-    for (const [creditManager, assets] of byCreditManager) {
-      this.#withdrawableAssets.upsert(creditManager, assets);
+      result.upsert(cfg.creditManager, assets);
     }
-    return this.state;
-  }
-  get loaded() {
-    return !!this.#withdrawableAssets;
-  }
-  /**
-   * Returns a map of cmAddress -> array of delayed assets
-   * @throws if plugin is not attached
-   */
-  get withdrawableAssets() {
-    if (!this.#withdrawableAssets) {
-      throw new Error("withdrawable assets plugin not attached");
-    }
-    return this.#withdrawableAssets;
+    return result;
   }
   stateHuman(_) {
     return this.withdrawableAssets.values().flatMap((cm) => {
@@ -76,15 +75,7 @@ class DelayedWithdrawalPlugin extends import_sdk.BasePlugin {
     });
   }
   get state() {
-    return {
-      withdrawableAssets: this.withdrawableAssets.asRecord()
-    };
-  }
-  hydrate(state) {
-    this.#withdrawableAssets = new import_sdk.AddressMap(
-      Object.entries(state.withdrawableAssets),
-      MAP_LABEL
-    );
+    return {};
   }
 }
 function getConfigKey(config) {

package/dist/cjs/preview/prerequisites/buildCollateralPrerequisites.js

@@ -21,10 +21,13 @@ __export(buildCollateralPrerequisites_exports, {
   buildCollateralPrerequisites: () => buildCollateralPrerequisites
 });
 module.exports = __toCommonJS(buildCollateralPrerequisites_exports);
+var import_viem = require("viem");
 var import_sdk = require("../../sdk/index.js");
+var import_AllowancePrerequisite = require("./AllowancePrerequisite.js");
+var import_BalancePrerequisite = require("./BalancePrerequisite.js");
 var import_helpers = require("./helpers.js");
 async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
-  const { sdk, wallet } = ctx;
+  const { sdk, wallet, value = 0n } = ctx;
   const required = new import_sdk.AssetsMap();
   for (const op of multicall) {
     if (op.operation !== "AddCollateral" || op.amount === 0n) {
@@ -32,12 +35,45 @@ async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
     }
     required.inc(op.token, op.amount);
   }
-  if (required.size === 0) {
+  if (required.size === 0 && value === 0n) {
     return [];
   }
-  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
   const prereqs = [];
+  if (value > 0n) {
+    prereqs.push(
+      new import_BalancePrerequisite.BalancePrerequisite({
+        token: import_sdk.NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(import_sdk.AP_WETH_TOKEN, import_sdk.NO_VERSION);
   for (const [token, amount] of required.entries()) {
+    if (value > 0n && (0, import_viem.isAddressEqual)(token, weth)) {
+      prereqs.push(
+        new import_AllowancePrerequisite.AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new import_BalancePrerequisite.BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
     prereqs.push(
       ...(0, import_helpers.allowanceAndBalance)({
         token,

package/dist/cjs/preview/prerequisites/checkPrerequisites.js

@@ -32,7 +32,8 @@ async function checkPrerequisites(input, options) {
   const ctx = {
     sdk,
     wallet,
-    blockNumber: options?.blockNumber
+    blockNumber: options?.blockNumber,
+    value: input.value ?? 0n
   };
   const prereqs = await buildPrerequisites(tx, ctx);
   return Promise.all(prereqs.map((p) => p.verify(ctx)));

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

@@ -25,7 +25,7 @@ var import_viem = require("viem");
 var import_common_utils = require("../../common-utils/index.js");
 var import_sdk = require("../../sdk/index.js");
 var import_types = require("./types.js");
-function buildDelayedPreview(afterInstant, before, detected, convert) {
+function buildDelayedPreview(afterInstant, before, detected, convert, receivedToken) {
   const { request, intent } = detected;
   const post = afterInstant.clone();
   const converter = makeSafeConverter(convert);
@@ -33,7 +33,7 @@ function buildDelayedPreview(afterInstant, before, detected, convert) {
   const collateralWithdrawn = new import_sdk.AssetsMap();
   switch (intent?.type) {
     case "CLOSE_ACCOUNT":
-      return buildClosePreview(post, converter);
+      return buildClosePreview(post, converter, receivedToken);
     case "DECREASE_LEVERAGE":
       repayFromClaim(post, request.claimToken, converter.convert, claimed);
       break;
@@ -104,16 +104,17 @@ function totalValueInUnderlying(post, convert, dust) {
     (token, balance) => balance > dust ? convert(token, post.underlying, balance) : 0n
   );
 }
-function buildClosePreview(post, converter) {
+function buildClosePreview(post, converter, receivedToken) {
   const totalValue = totalValueInUnderlying(post, converter.convert, 0n);
   return {
     operation: "CloseCreditAccount",
     permanent: false,
     creditManager: post.creditManager,
     creditAccount: post.creditAccount,
-    // Oracle estimate denominated in the underlying
+    // Oracle estimate computed in the underlying; RWA underlyings convert
+    // 1:1 with their vault asset, so the amount holds for `receivedToken`
     receivedAmount: {
-      token: post.underlying,
+      token: receivedToken,
       balance: import_common_utils.BigIntMath.max(totalValue - post.totalDebt, 0n)
     },
     error: converter.error

package/dist/cjs/preview/preview/previewOperation.js

@@ -74,6 +74,8 @@ async function previewMulticallOperation(input, operation, options) {
     operation.creditManager
   );
   const convert = (token, to, amount) => market.priceOracle.convert(token, to, amount);
+  const meta = sdk.tokensMeta.get(market.underlying);
+  const receivedToken = meta && sdk.tokensMeta.isRWAUnderlying(meta) ? meta.asset : market.underlying;
   return {
     operation: "DelayedCreditAccountOperation",
     creditAccount: operation.creditAccount,
@@ -84,7 +86,8 @@ async function previewMulticallOperation(input, operation, options) {
       after.account,
       before,
       delayed,
-      convert
+      convert,
+      receivedToken
     )
   };
 }

package/dist/cjs/sdk/MultichainSDK.js

@@ -21,6 +21,7 @@ __export(MultichainSDK_exports, {
   MultichainSDK: () => MultichainSDK
 });
 module.exports = __toCommonJS(MultichainSDK_exports);
+var import_accounts = require("./accounts/index.js");
 var import_chains = require("./chain/chains.js");
 var import_core = require("./core/index.js");
 var import_updates = require("./market/pricefeeds/updates/index.js");
@@ -30,6 +31,11 @@ class MultichainSDK {
   #redstoneCache;
   #pythCache;
   #logger;
+  /**
+   * Namespace for liquidatable credit accounts discovery across all
+   * configured chains.
+   */
+  liquidations;
   constructor(options) {
     this.#chains = /* @__PURE__ */ new Map();
     this.#logger = options.logger;
@@ -57,6 +63,7 @@ class MultichainSDK {
       );
       this.#chains.set(network, sdk);
     }
+    this.liquidations = new import_accounts.MultichainLiquidationsService(this);
   }
   /**
    * Attach all configured chains in parallel.

package/dist/cjs/sdk/OnchainSDK.js

@@ -67,6 +67,7 @@ class OnchainSDK extends import_base.ChainContractsRegister {
   #rwa;
   #marketRegister;
   #priceFeeds;
+  #withdrawalCompressor;
   /**
    * Gas limit applied to read-only `eth_call` requests.
    **/
@@ -83,6 +84,10 @@ class OnchainSDK extends import_base.ChainContractsRegister {
    * Namespace for pool operations.
    */
   pools;
+  /**
+   * Namespace for liquidatable credit accounts discovery.
+   */
+  liquidations;
   /**
    * @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
    * @param clientOptions - Connection options (RPC URLs, transport, or client).
@@ -109,6 +114,8 @@ class OnchainSDK extends import_base.ChainContractsRegister {
     }
     this.accounts = new import_accounts.CreditAccountsServiceV310(this);
     this.pools = new import_pools.PoolService(this);
+    this.liquidations = new import_accounts.LiquidationsService(this);
+    this.#withdrawalCompressor = (0, import_accounts.createWithdrawalCompressor)(this);
   }
   /**
    * Initialises the SDK by reading live on-chain state.
@@ -255,6 +262,9 @@ class OnchainSDK extends import_base.ChainContractsRegister {
     this.#marketRegister.hydrate(state);
     this.#rwa = new import_market.RWARegistry(this);
     this.#rwa.setState(state.rwa);
+    if (state.withdrawals) {
+      this.#withdrawalCompressor?.hydrate(state.withdrawals);
+    }
     for (const [name, plugin] of import_utils.TypedObjectUtils.entries(this.plugins)) {
       const pluginState = state.plugins[name];
       if (plugin.hydrate && pluginState) {
@@ -319,6 +329,7 @@ class OnchainSDK extends import_base.ChainContractsRegister {
       addressProvider: this.addressProvider.state,
       ...this.marketRegister.state,
       rwa: this.#rwa.state,
+      withdrawals: this.#withdrawalCompressor?.state,
       plugins: Object.fromEntries(
         import_utils.TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
           name,
@@ -536,12 +547,11 @@ class OnchainSDK extends import_base.ChainContractsRegister {
     return (0, import_router.createRouter)(this, routerAddr, routerV);
   }
   /**
-   * Lazily returns a withdrawal compressor contract for the current chain.
-   *
-   * @throws If no withdrawal compressor is supported on the current chain.
+   * Withdrawal compressor contract for the current chain, or `undefined`
+   * when no withdrawal compressor is supported on it.
    **/
   get withdrawalCompressor() {
-    return (0, import_accounts.createWithdrawalCompressor)(this);
+    return this.#withdrawalCompressor;
   }
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/cjs/sdk/accounts/CreditAccountsServiceV310.js

@@ -771,14 +771,16 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
     creditAccount,
     amount,
     token,
+    withdrawalPhantomToken,
     intent
   }) {
-    return this.sdk.withdrawalCompressor.getWithdrawalRequestResult(
+    return this.#withdrawalCompressor.getWithdrawalRequestResult({
       creditAccount,
       token,
       amount,
+      withdrawalPhantomToken,
       intent
-    );
+    });
   }
   /**
    * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
@@ -786,7 +788,7 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
   async getPendingWithdrawals({
     creditAccount
   }) {
-    const { claimable, pending } = await this.sdk.withdrawalCompressor.getCurrentWithdrawals(creditAccount);
+    const { claimable, pending } = await this.#withdrawalCompressor.getCurrentWithdrawals(creditAccount);
     return {
       claimableNow: claimable,
       pending
@@ -1853,6 +1855,17 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
     }
     return suite.creditFacade.multicall(creditAccount, calls);
   }
+  /**
+   * Withdrawal compressor of the current chain.
+   * @throws If no withdrawal compressor is supported on the current chain.
+   **/
+  get #withdrawalCompressor() {
+    const compressor = this.sdk.withdrawalCompressor;
+    if (!compressor) {
+      throw new Error(`no withdrawal compressor on ${this.sdk.networkType}`);
+    }
+    return compressor;
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/sdk/accounts/index.js

@@ -16,11 +16,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var accounts_exports = {};
 module.exports = __toCommonJS(accounts_exports);
 __reExport(accounts_exports, require("./CreditAccountsServiceV310.js"), module.exports);
+__reExport(accounts_exports, require("./liquidations/index.js"), module.exports);
 __reExport(accounts_exports, require("./types.js"), module.exports);
 __reExport(accounts_exports, require("./withdrawal-compressor/index.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./CreditAccountsServiceV310.js"),
+  ...require("./liquidations/index.js"),
   ...require("./types.js"),
   ...require("./withdrawal-compressor/index.js")
 });