@gearbox-protocol/sdk 14.12.0-next.34 → 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/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")
 });

package/dist/cjs/sdk/accounts/liquidations/LiquidationsService.js

@@ -0,0 +1,207 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var LiquidationsService_exports = {};
+__export(LiquidationsService_exports, {
+  LiquidationsService: () => LiquidationsService
+});
+module.exports = __toCommonJS(LiquidationsService_exports);
+var import_base = require("../../base/index.js");
+var import_constants = require("../../constants/index.js");
+var import_utils = require("../../utils/index.js");
+var import_helpers = require("./helpers.js");
+class LiquidationsService extends import_base.SDKConstruct {
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+   **/
+  async getLiquidatableAccounts(props) {
+    if (props?.networks && !props.networks.includes(this.sdk.networkType)) {
+      return [];
+    }
+    await this.sdk.withdrawalCompressor?.loadWithdrawableAssets();
+    const accounts = await this.sdk.accounts.getCreditAccounts({
+      maxHealthFactor: import_constants.WAD - 1n,
+      includeZeroDebt: false
+    });
+    const seen = new import_utils.AddressSet(accounts.map((ca) => ca.creditAccount));
+    for (const ca of await this.#getExpiredCreditAccounts()) {
+      if (!seen.has(ca.creditAccount)) {
+        seen.add(ca.creditAccount);
+        accounts.push(ca);
+      }
+    }
+    const rows = [];
+    for (const ca of accounts) {
+      if (!ca.success) {
+        continue;
+      }
+      rows.push(this.#buildAccount(ca));
+    }
+    const allowedAssets = props?.assets?.length ? new import_utils.AddressSet(props.assets) : void 0;
+    return rows.filter((row) => {
+      if (props?.delayed !== void 0 && row.isDelayed !== props.delayed) {
+        return false;
+      }
+      if (allowedAssets && !allowedAssets.has(row.asset)) {
+        return false;
+      }
+      return true;
+    });
+  }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidationDetails}
+   **/
+  async getLiquidationDetails(props) {
+    const { network, creditAccount } = props;
+    if (network !== this.sdk.networkType) {
+      throw new Error(
+        `network mismatch: this SDK is attached to ${this.sdk.networkType}, requested ${network}`
+      );
+    }
+    const ca = await this.sdk.accounts.getCreditAccountData(creditAccount);
+    if (!ca) {
+      throw new Error(`credit account ${creditAccount} not found`);
+    }
+    if (!ca.success) {
+      throw new Error(
+        `cannot compute liquidation details for ${creditAccount}: collateral computation failed`
+      );
+    }
+    const compressor = this.sdk.withdrawalCompressor;
+    await compressor?.loadWithdrawableAssets();
+    const account = this.#buildAccount(ca);
+    const receivedAssets = [];
+    for (const t of ca.tokens) {
+      if (t.balance > import_helpers.DUST_THRESHOLD && !compressor?.getWithdrawalSourceToken(t.token)) {
+        receivedAssets.push({
+          isDelayed: false,
+          token: t.token,
+          amount: t.balance
+        });
+      }
+    }
+    if (account.isDelayed && compressor) {
+      const { claimable, pending } = await compressor.getCurrentWithdrawals(creditAccount);
+      for (const w of claimable) {
+        for (const o of w.outputs) {
+          receivedAssets.push({
+            isDelayed: true,
+            token: o.token,
+            amount: o.amount,
+            sourceToken: w.token
+          });
+        }
+      }
+      for (const w of pending) {
+        for (const o of w.expectedOutputs) {
+          receivedAssets.push({
+            isDelayed: true,
+            token: o.token,
+            amount: o.amount,
+            sourceToken: w.token,
+            claimableAt: w.claimableAt
+          });
+        }
+      }
+    }
+    return { ...account, receivedAssets };
+  }
+  /**
+   * Accounts of expired credit managers with outstanding debt are liquidatable
+   * regardless of their health factor.
+   **/
+  async #getExpiredCreditAccounts() {
+    const expiredCMs = [];
+    for (const market of this.sdk.marketRegister.markets) {
+      if (market.pool.pool.totalBorrowed === 0n) {
+        continue;
+      }
+      for (const cm of market.creditManagers) {
+        const borrowed = market.pool.pool.creditManagerDebtParams.get(cm.creditManager.address)?.borrowed ?? 0n;
+        if (cm.isExpired && borrowed > 0n) {
+          expiredCMs.push(cm.creditManager.address);
+        }
+      }
+    }
+    if (expiredCMs.length === 0) {
+      return [];
+    }
+    this.logger?.debug(
+      `getting credit accounts of ${expiredCMs.length} expired credit managers`
+    );
+    const result = [];
+    for (const creditManager of expiredCMs) {
+      const accounts = await this.sdk.accounts.getCreditAccounts({
+        creditManager,
+        includeZeroDebt: false
+      });
+      result.push(...accounts);
+    }
+    return result;
+  }
+  /**
+   * Requires the compressor's withdrawable assets cache to be loaded
+   * (see `loadWithdrawableAssets`) so that phantom token lookups are sync.
+   **/
+  #buildAccount(ca) {
+    const compressor = this.sdk.withdrawalCompressor;
+    const suite = this.sdk.marketRegister.findCreditManager(ca.creditManager);
+    const market = suite.market;
+    const meta = this.sdk.tokensMeta.get(suite.underlying);
+    const unwrappedUnderlying = meta && this.sdk.tokensMeta.isRWAUnderlying(meta) ? meta.asset : suite.underlying;
+    const liquidationDiscount = suite.isExpired ? suite.creditManager.liquidationDiscountExpired : suite.creditManager.liquidationDiscount;
+    let asset = (0, import_helpers.pickMainAsset)(ca, (token, balance) => {
+      try {
+        return market.priceOracle.convert(token, market.underlying, balance);
+      } catch {
+        return 0n;
+      }
+    });
+    if (asset) {
+      asset = compressor?.getWithdrawalSourceToken(asset) ?? asset;
+    } else {
+      asset = unwrappedUnderlying;
+    }
+    return {
+      creditAccount: ca.creditAccount,
+      creditManager: ca.creditManager,
+      network: this.sdk.networkType,
+      asset,
+      totalValue: {
+        token: unwrappedUnderlying,
+        balance: ca.totalValue
+      },
+      totalValueUSD: ca.totalValueUSD,
+      repaymentAmount: {
+        token: unwrappedUnderlying,
+        balance: (0, import_helpers.calcRepaymentAmount)(ca.totalValue, liquidationDiscount)
+      },
+      estimatedProfit: {
+        token: unwrappedUnderlying,
+        balance: (0, import_helpers.calcEstimatedProfit)(ca.totalValue, liquidationDiscount)
+      },
+      isDelayed: ca.tokens.some(
+        (t) => t.balance > import_helpers.DUST_THRESHOLD && !!compressor?.getWithdrawalSourceToken(t.token)
+      )
+    };
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LiquidationsService
+});

package/dist/cjs/sdk/accounts/liquidations/MultichainLiquidationsService.js

@@ -0,0 +1,65 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var MultichainLiquidationsService_exports = {};
+__export(MultichainLiquidationsService_exports, {
+  MultichainLiquidationsService: () => MultichainLiquidationsService
+});
+module.exports = __toCommonJS(MultichainLiquidationsService_exports);
+class MultichainLiquidationsService {
+  #sdk;
+  constructor(sdk) {
+    this.#sdk = sdk;
+  }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+   **/
+  async getLiquidatableAccounts(props) {
+    const chains = [...this.#sdk.chains.entries()].filter(
+      ([network]) => !props?.networks || props.networks.includes(network)
+    );
+    const results = await Promise.allSettled(
+      chains.map(
+        ([, chainSdk]) => chainSdk.liquidations.getLiquidatableAccounts(props)
+      )
+    );
+    const accounts = [];
+    results.forEach((result, i) => {
+      const [network, chainSdk] = chains[i];
+      if (result.status === "fulfilled") {
+        accounts.push(...result.value);
+      } else {
+        chainSdk.logger?.warn(
+          result.reason,
+          `failed to get liquidatable accounts on ${network}`
+        );
+      }
+    });
+    return accounts;
+  }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidationDetails}
+   **/
+  async getLiquidationDetails(props) {
+    return this.#sdk.chain(props.network).liquidations.getLiquidationDetails(props);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MultichainLiquidationsService
+});