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

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

@@ -121,6 +121,27 @@ class LiquidationsService extends import_base.SDKConstruct {
     }
     return { ...account, receivedAssets };
   }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   **/
+  async getLiquidatorWithdrawals(props) {
+    if (props.networks && !props.networks.includes(this.sdk.networkType)) {
+      return [];
+    }
+    const compressor = this.sdk.withdrawalCompressor;
+    if (!compressor) {
+      return [];
+    }
+    await compressor.loadWithdrawableAssets();
+    const phantomTokens = new import_utils.AddressSet(
+      compressor.getWithdrawableAssets().map((a) => a.withdrawalPhantomToken)
+    );
+    const current = await compressor.getExternalAccountCurrentWithdrawals(
+      props.liquidator,
+      ...phantomTokens.asArray()
+    );
+    return (0, import_helpers.toLiquidatorWithdrawals)(current, this.sdk.networkType);
+  }
   /**
    * Accounts of expired credit managers with outstanding debt are liquidatable
    * regardless of their health factor.

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

@@ -58,6 +58,32 @@ class MultichainLiquidationsService {
   async getLiquidationDetails(props) {
     return this.#sdk.chain(props.network).liquidations.getLiquidationDetails(props);
   }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   **/
+  async getLiquidatorWithdrawals(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.getLiquidatorWithdrawals(props)
+      )
+    );
+    const withdrawals = [];
+    results.forEach((result, i) => {
+      const [network, chainSdk] = chains[i];
+      if (result.status === "fulfilled") {
+        withdrawals.push(...result.value);
+      } else {
+        chainSdk.logger?.warn(
+          result.reason,
+          `failed to get liquidator withdrawals on ${network}`
+        );
+      }
+    });
+    return withdrawals;
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

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

@@ -21,7 +21,8 @@ __export(helpers_exports, {
   DUST_THRESHOLD: () => DUST_THRESHOLD,
   calcEstimatedProfit: () => calcEstimatedProfit,
   calcRepaymentAmount: () => calcRepaymentAmount,
-  pickMainAsset: () => pickMainAsset
+  pickMainAsset: () => pickMainAsset,
+  toLiquidatorWithdrawals: () => toLiquidatorWithdrawals
 });
 module.exports = __toCommonJS(helpers_exports);
 var import_constants = require("../../constants/index.js");
@@ -54,10 +55,36 @@ function pickMainAsset(ca, convert) {
   }
   return bestToken;
 }
+function toLiquidatorWithdrawals(current, network) {
+  const rows = [];
+  for (const w of current.claimable) {
+    for (const o of w.outputs) {
+      rows.push({
+        network,
+        sourceToken: w.token,
+        token: o.token,
+        amount: o.amount
+      });
+    }
+  }
+  for (const w of current.pending) {
+    for (const o of w.expectedOutputs) {
+      rows.push({
+        network,
+        sourceToken: w.token,
+        token: o.token,
+        amount: o.amount,
+        claimableAt: w.claimableAt
+      });
+    }
+  }
+  return rows;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DUST_THRESHOLD,
   calcEstimatedProfit,
   calcRepaymentAmount,
-  pickMainAsset
+  pickMainAsset,
+  toLiquidatorWithdrawals
 });

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

@@ -5,7 +5,8 @@ import {
   calcEstimatedProfit,
   calcRepaymentAmount,
   DUST_THRESHOLD,
-  pickMainAsset
+  pickMainAsset,
+  toLiquidatorWithdrawals
 } from "./helpers.js";
 class LiquidationsService extends SDKConstruct {
   /**
@@ -103,6 +104,27 @@ class LiquidationsService extends SDKConstruct {
     }
     return { ...account, receivedAssets };
   }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   **/
+  async getLiquidatorWithdrawals(props) {
+    if (props.networks && !props.networks.includes(this.sdk.networkType)) {
+      return [];
+    }
+    const compressor = this.sdk.withdrawalCompressor;
+    if (!compressor) {
+      return [];
+    }
+    await compressor.loadWithdrawableAssets();
+    const phantomTokens = new AddressSet(
+      compressor.getWithdrawableAssets().map((a) => a.withdrawalPhantomToken)
+    );
+    const current = await compressor.getExternalAccountCurrentWithdrawals(
+      props.liquidator,
+      ...phantomTokens.asArray()
+    );
+    return toLiquidatorWithdrawals(current, this.sdk.networkType);
+  }
   /**
    * Accounts of expired credit managers with outstanding debt are liquidatable
    * regardless of their health factor.

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

@@ -35,6 +35,32 @@ class MultichainLiquidationsService {
   async getLiquidationDetails(props) {
     return this.#sdk.chain(props.network).liquidations.getLiquidationDetails(props);
   }
+  /**
+   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   **/
+  async getLiquidatorWithdrawals(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.getLiquidatorWithdrawals(props)
+      )
+    );
+    const withdrawals = [];
+    results.forEach((result, i) => {
+      const [network, chainSdk] = chains[i];
+      if (result.status === "fulfilled") {
+        withdrawals.push(...result.value);
+      } else {
+        chainSdk.logger?.warn(
+          result.reason,
+          `failed to get liquidator withdrawals on ${network}`
+        );
+      }
+    });
+    return withdrawals;
+  }
 }
 export {
   MultichainLiquidationsService

package/dist/esm/sdk/accounts/liquidations/helpers.js

@@ -28,9 +28,35 @@ function pickMainAsset(ca, convert) {
   }
   return bestToken;
 }
+function toLiquidatorWithdrawals(current, network) {
+  const rows = [];
+  for (const w of current.claimable) {
+    for (const o of w.outputs) {
+      rows.push({
+        network,
+        sourceToken: w.token,
+        token: o.token,
+        amount: o.amount
+      });
+    }
+  }
+  for (const w of current.pending) {
+    for (const o of w.expectedOutputs) {
+      rows.push({
+        network,
+        sourceToken: w.token,
+        token: o.token,
+        amount: o.amount,
+        claimableAt: w.claimableAt
+      });
+    }
+  }
+  return rows;
+}
 export {
   DUST_THRESHOLD,
   calcEstimatedProfit,
   calcRepaymentAmount,
-  pickMainAsset
+  pickMainAsset,
+  toLiquidatorWithdrawals
 };

package/dist/types/sdk/accounts/liquidations/LiquidationsService.d.ts

@@ -1,5 +1,5 @@
 import { SDKConstruct } from "../../base/index.js";
-import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails } from "./types.js";
+import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
 /**
  * Per-chain implementation of {@link ILiquidationsService}.
  *
@@ -17,4 +17,8 @@ export declare class LiquidationsService extends SDKConstruct implements ILiquid
      * {@inheritDoc ILiquidationsService.getLiquidationDetails}
      **/
     getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    /**
+     * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+     **/
+    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
 }

package/dist/types/sdk/accounts/liquidations/MultichainLiquidationsService.d.ts

@@ -1,6 +1,6 @@
 import type { MultichainSDK } from "../../MultichainSDK.js";
 import type { PluginsMap } from "../../plugins/index.js";
-import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails } from "./types.js";
+import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
 /**
  * Cross-chain implementation of {@link ILiquidationsService}.
  *
@@ -20,4 +20,8 @@ export declare class MultichainLiquidationsService<const Plugins extends Plugins
      * {@inheritDoc ILiquidationsService.getLiquidationDetails}
      **/
     getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    /**
+     * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+     **/
+    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
 }

package/dist/types/sdk/accounts/liquidations/helpers.d.ts

@@ -1,5 +1,8 @@
 import type { Address } from "viem";
 import type { CreditAccountData } from "../../base/index.js";
+import type { NetworkType } from "../../chain/index.js";
+import type { CurrentWithdrawals } from "../withdrawal-compressor/index.js";
+import type { LiquidatorWithdrawal } from "./types.js";
 /**
  * Token balances at or below this threshold are treated as dust and ignored,
  * consistent with the rest of the SDK (see `filterDust`).
@@ -32,3 +35,12 @@ export declare function calcEstimatedProfit(totalValue: bigint, liquidationDisco
  * must return `0n` when the price is unavailable
  **/
 export declare function pickMainAsset(ca: CreditAccountData, convert: (token: Address, balance: bigint) => bigint): Address | undefined;
+/**
+ * Flattens delayed withdrawals of a liquidator into per-output rows:
+ * claimable outputs have no `claimableAt` (claimable now), pending outputs
+ * carry the estimated claim timestamp.
+ *
+ * @param current - Claimable and pending withdrawals from the withdrawal compressor
+ * @param network - Network the withdrawals live on
+ **/
+export declare function toLiquidatorWithdrawals(current: CurrentWithdrawals, network: NetworkType): LiquidatorWithdrawal[];

package/dist/types/sdk/accounts/liquidations/types.d.ts

@@ -135,6 +135,53 @@ export interface DelayedReceivedAsset {
  * A single asset the liquidator receives when fully liquidating an account.
  **/
 export type ReceivedAsset = InstantReceivedAsset | DelayedReceivedAsset;
+/**
+ * Props for {@link ILiquidationsService.getLiquidatorWithdrawals}.
+ **/
+export interface GetLiquidatorWithdrawalsProps {
+    /**
+     * Networks to query. On {@link MultichainLiquidationsService} selects which
+     * chains to query; a single-chain service returns an empty list when its
+     * own network is excluded.
+     **/
+    networks?: NetworkType[];
+    /**
+     * Liquidator wallet that owns the redemption receipts (redeemer contracts
+     * received as a result of liquidations).
+     **/
+    liquidator: Address;
+}
+/**
+ * A single delayed-withdrawal position owned by the liquidator.
+ *
+ * The redeemer contract address is not included: it is not part of the
+ * on-chain withdrawal structs returned by the withdrawal compressor. It can
+ * be surfaced later if the compressor structs are extended.
+ **/
+export interface LiquidatorWithdrawal {
+    /**
+     * Network the withdrawal lives on.
+     **/
+    network: NetworkType;
+    /**
+     * Source asset spent by the delayed withdrawal (e.g. ACRED).
+     **/
+    sourceToken: Address;
+    /**
+     * Receivable asset (e.g. USDC).
+     **/
+    token: Address;
+    /**
+     * Amount of `token` receivable: exact for claimable withdrawals, estimated
+     * for pending ones.
+     **/
+    amount: bigint;
+    /**
+     * Estimated unix timestamp (in seconds) when a pending withdrawal becomes
+     * claimable. `undefined` means the withdrawal is claimable now.
+     **/
+    claimableAt?: bigint;
+}
 /**
  * Detailed information about a liquidatable credit account, extending the
  * list row with the full breakdown of assets the liquidator receives.
@@ -169,4 +216,12 @@ export interface ILiquidationsService {
      * @throws When the account is not found or its collateral computation fails.
      **/
     getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    /**
+     * Returns the status of delayed-withdrawal positions (redemption receipts)
+     * owned by a liquidator wallet: what is receivable, how much, and when it
+     * becomes claimable.
+     *
+     * @param props - See {@link GetLiquidatorWithdrawalsProps}
+     **/
+    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
 }

package/package.json

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