@gearbox-protocol/sdk 14.12.0-next.47 → 14.12.0-next.49

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

@@ -1,17 +1,35 @@
 import type { Address } from "viem";
 import type { Asset } from "../../base/index.js";
 import type { NetworkType } from "../../chain/index.js";
+import type { RawTx } from "../../types/index.js";
 /**
- * Filters for {@link ILiquidationsService.getLiquidatableAccounts}.
- * All filters are optional and applied after liquidatable accounts are fetched.
+ * Selects the chain for single-account methods of a multichain service.
  **/
-export interface GetLiquidatableAccountsProps {
+export interface MultichainNetworkProps {
     /**
-     * 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.
+     * Network the credit account lives on.
+     **/
+    network: NetworkType;
+}
+/**
+ * Restricts which chains a multichain list method queries.
+ **/
+export interface MultichainNetworksProps {
+    /**
+     * Networks to query. All chains configured in {@link MultichainSDK} when
+     * omitted.
      **/
     networks?: NetworkType[];
+}
+/**
+ * Adds chain-scoping props `T` only when the service spans multiple chains.
+ **/
+export type WithMultichain<Multichain extends boolean, T extends object> = Multichain extends true ? T : {};
+/**
+ * Chain-independent part of {@link GetLiquidatableAccountsProps}.
+ * All filters are optional and applied after liquidatable accounts are fetched.
+ **/
+export interface GetLiquidatableAccountsPropsBase {
     /**
      * Only return accounts whose main liquidated {@link LiquidatableAccount.asset}
      * is one of these tokens.
@@ -23,6 +41,10 @@ export interface GetLiquidatableAccountsProps {
      **/
     delayed?: boolean;
 }
+/**
+ * Props for {@link ILiquidationsService.getLiquidatableAccounts}.
+ **/
+export type GetLiquidatableAccountsProps<Multichain extends boolean = false> = GetLiquidatableAccountsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
 /**
  * A credit account that can be liquidated, with amounts precomputed for
  * manual liquidation via the frontend.
@@ -75,23 +97,54 @@ export interface LiquidatableAccount {
     isDelayed: boolean;
 }
 /**
- * Props for {@link ILiquidationsService.getLiquidationDetails}.
+ * Chain-independent part of {@link GetLiquidationDetailsProps}.
  **/
-export interface GetLiquidationDetailsProps {
-    /**
-     * Network the credit account lives on.
-     **/
-    network: NetworkType;
+export interface GetLiquidationDetailsPropsBase {
     /**
      * Credit account to get liquidation details for.
      **/
     creditAccount: Address;
     /**
-     * Liquidator wallet address. Reserved for future RWA KYC gating;
-     * accepted but not checked yet.
+     * Liquidator wallet address, used by the liquidation compressor to check
+     * KYC eligibility. When omitted, the zero address is used: amounts and
+     * received assets are unaffected, but {@link LiquidationDetails.isLiquidatorEligible}
+     * then only tells whether the liquidation is KYC-gated at all
+     * (see {@link LiquidationDetails.kycProtocol}).
      **/
     liquidator?: Address;
+    /**
+     * If true, reserve price feed updates are excluded from the price updates
+     * applied by the compressor before computing amounts.
+     **/
+    ignoreReservePrices?: boolean;
+}
+/**
+ * Props for {@link ILiquidationsService.getLiquidationDetails}.
+ **/
+export type GetLiquidationDetailsProps<Multichain extends boolean = false> = GetLiquidationDetailsPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
+/**
+ * Chain-independent part of {@link BuildLiquidationTxProps}.
+ **/
+export interface BuildLiquidationTxPropsBase {
+    /**
+     * Credit account to liquidate.
+     **/
+    creditAccount: Address;
+    /**
+     * Liquidator wallet address. Required: it is encoded into the transaction
+     * as the receiver of the liquidated collateral.
+     **/
+    liquidator: Address;
+    /**
+     * If true, reserve price feed updates are excluded from the price updates
+     * applied by the compressor before building the transaction.
+     **/
+    ignoreReservePrices?: boolean;
 }
+/**
+ * Props for {@link ILiquidationsService.buildLiquidationTx}.
+ **/
+export type BuildLiquidationTxProps<Multichain extends boolean = false> = BuildLiquidationTxPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
 /**
  * A token received directly from the credit account balance upon liquidation.
  **/
@@ -122,9 +175,10 @@ export interface DelayedReceivedAsset {
      **/
     amount: bigint;
     /**
-     * Source asset spent by the delayed withdrawal (e.g. ACRED).
+     * Redeemer contract transferred to the liquidator, from which `token`
+     * becomes claimable. `undefined` when the compressor does not report one.
      **/
-    sourceToken: Address;
+    redeemerAddress?: Address;
     /**
      * Estimated unix timestamp (in seconds) when a pending withdrawal becomes
      * claimable. `undefined` means the withdrawal is claimable now.
@@ -136,21 +190,19 @@ export interface DelayedReceivedAsset {
  **/
 export type ReceivedAsset = InstantReceivedAsset | DelayedReceivedAsset;
 /**
- * Props for {@link ILiquidationsService.getLiquidatorWithdrawals}.
+ * Chain-independent part of {@link GetLiquidatorWithdrawalsProps}.
  **/
-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[];
+export interface GetLiquidatorWithdrawalsPropsBase {
     /**
      * Liquidator wallet that owns the redemption receipts (redeemer contracts
      * received as a result of liquidations).
      **/
     liquidator: Address;
 }
+/**
+ * Props for {@link ILiquidationsService.getLiquidatorWithdrawals}.
+ **/
+export type GetLiquidatorWithdrawalsProps<Multichain extends boolean = false> = GetLiquidatorWithdrawalsPropsBase & WithMultichain<Multichain, MultichainNetworksProps>;
 /**
  * A single delayed-withdrawal position owned by the liquidator.
  *
@@ -183,8 +235,33 @@ export interface LiquidatorWithdrawal {
     claimableAt?: bigint;
 }
 /**
- * Detailed information about a liquidatable credit account, extending the
- * list row with the full breakdown of assets the liquidator receives.
+ * ERC-20 approval the liquidator must grant before sending the liquidation
+ * transaction.
+ **/
+export interface LiquidationApproval {
+    /**
+     * Address to approve: the credit manager when the liquidation goes directly
+     * through the credit facade (the facade forwards `msg.sender` as the payer
+     * and the credit manager executes the transfer), or the dedicated liquidator
+     * contract (Midas / Securitize) when the liquidation goes through one, since
+     * such contracts pull the token to themselves first.
+     **/
+    spender: Address;
+    /**
+     * Token pulled from the liquidator: the credit manager underlying.
+     **/
+    token: Address;
+    /**
+     * Amount to approve, equal to the amount the liquidation transaction pulls.
+     * The Securitize liquidator recomputes it on-chain, so approving with some
+     * headroom is advisable in case prices move.
+     **/
+    amount: bigint;
+}
+/**
+ * Detailed information about a liquidatable credit account, including
+ * the full breakdown of assets the liquidator receives.
+ *
  **/
 export interface LiquidationDetails extends LiquidatableAccount {
     /**
@@ -193,13 +270,41 @@ export interface LiquidationDetails extends LiquidatableAccount {
      * pending).
      **/
     receivedAssets: ReceivedAsset[];
+    /**
+     * Whether the liquidator passes the KYC checks of the liquidated assets.
+     * When {@link GetLiquidationDetailsPropsBase.liquidator} was not provided,
+     * `false` only means that the liquidation is KYC-gated, not that a
+     * particular wallet was rejected.
+     **/
+    isLiquidatorEligible: boolean;
+    /**
+     * Name of the KYC protocol the liquidator must be whitelisted in
+     * (e.g. `"securitize"`). `undefined` when the liquidation is not KYC-gated.
+     **/
+    kycProtocol?: string;
+    /**
+     * Token the liquidator must be whitelisted for in {@link kycProtocol}.
+     * `undefined` when the liquidation is not KYC-gated.
+     **/
+    kycToken?: Address;
+    /**
+     * ERC-20 approval required before sending the liquidation transaction.
+     * `undefined` when the selected liquidation path needs no capital from the
+     * liquidator, i.e. {@link repaymentAmount} is zero.
+     **/
+    approve?: LiquidationApproval;
 }
 /**
  * Service for discovering liquidatable credit accounts and previewing manual
  * liquidations. Implemented per-chain by {@link LiquidationsService} and
  * across all configured chains by {@link MultichainLiquidationsService}.
+ *
+ * @typeParam Multichain - When `true`, props select the chain to operate on:
+ * {@link MultichainNetworkProps} for single-account methods and
+ * {@link MultichainNetworksProps} for list methods. A per-chain service
+ * operates on the network its SDK is attached to and takes no network props.
  **/
-export interface ILiquidationsService {
+export interface ILiquidationsService<Multichain extends boolean = false> {
     /**
      * Returns all liquidatable credit accounts: accounts with health factor
      * below 1 plus accounts of expired credit managers with outstanding debt.
@@ -207,7 +312,7 @@ export interface ILiquidationsService {
      *
      * @param props - Optional filters, see {@link GetLiquidatableAccountsProps}
      **/
-    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps): Promise<LiquidatableAccount[]>;
+    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps<Multichain>): Promise<LiquidatableAccount[]>;
     /**
      * Returns detailed information about a liquidatable credit account,
      * including the full list of assets the liquidator receives.
@@ -215,7 +320,14 @@ export interface ILiquidationsService {
      * @param props - See {@link GetLiquidationDetailsProps}
      * @throws When the account is not found or its collateral computation fails.
      **/
-    getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    getLiquidationDetails(props: GetLiquidationDetailsProps<Multichain>): Promise<LiquidationDetails>;
+    /**
+     * Builds the transaction that fully liquidates a credit account, repaying
+     * the debt from own funds and receiving the collateral from the credit account.
+     *
+     * @param props - See {@link BuildLiquidationTxProps}
+     **/
+    buildLiquidationTx(props: BuildLiquidationTxProps<Multichain>): Promise<RawTx>;
     /**
      * Returns the status of delayed-withdrawal positions (redemption receipts)
      * owned by a liquidator wallet: what is receivable, how much, and when it
@@ -223,5 +335,5 @@ export interface ILiquidationsService {
      *
      * @param props - See {@link GetLiquidatorWithdrawalsProps}
      **/
-    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
+    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps<Multichain>): Promise<LiquidatorWithdrawal[]>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.47",
+  "version": "14.12.0-next.49",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {
@@ -89,29 +89,29 @@
     "@redstone-finance/protocol": "^0.9.0",
     "@redstone-finance/sdk": "^0.9.0",
     "@redstone-finance/utils": "^0.9.0",
-    "abitype": "^1.2.4",
+    "abitype": "^1.3.0",
     "buffer": "^6.0.3",
     "date-fns": "^4.4.0",
-    "viem": ">=2.23.15 <3.0.0",
+    "viem": "^2.55.10",
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.5.3",
+    "@biomejs/biome": "^2.5.6",
     "@commitlint/cli": "^21.2.1",
     "@commitlint/config-conventional": "^21.2.0",
-    "@gearbox-protocol/biome-config": "^1.1.2",
+    "@gearbox-protocol/biome-config": "^1.1.5",
     "@types/cross-spawn": "^6.0.6",
-    "axios": "^1.18.1",
+    "axios": "^1.19.0",
     "cross-spawn": "^7.0.6",
     "husky": "^9.1.7",
-    "lint-staged": "^17.0.8",
+    "lint-staged": "^17.2.0",
     "pino": "^10.3.1",
     "pino-pretty": "^13.1.3",
     "tsup": "^8.5.1",
-    "tsx": "^4.23.0",
+    "tsx": "^4.23.1",
     "typescript": "^7.0.2",
     "viem-deal": "^2.0.4",
-    "vite": "^8.1.3",
+    "vite": "^8.1.5",
     "vitest": "^4.1.10",
     "yaml": "^2.9.0"
   },