@gearbox-protocol/sdk 17.13.0-next.1 → 17.13.0-next.10

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

@@ -1,17 +1,19 @@
 import { TxCall } from "../../../model/primitives.js";
 import { LiquidatableAccount, LiquidationDetails, LiquidationPosition } from "../../../model/liquidations.js";
 import "../../../model/index.js";
+import { AddressMap } from "../../utils/AddressMap.js";
 import { CreditAccountData } from "../../base/types.js";
+import "../../utils/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
 import "../../base/index.js";
-import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, LoadRWALiquidatorsProps, PartialLiquidationParams } from "./types.js";
+import { BuildLiquidationTxProps, BuildPartialLiquidationTxProps, FullyLiquidateProps, FullyLiquidateResult, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, GetPartialLiquidationDetailsProps, LoadRWALiquidatorsProps } from "./types.js";
 import { OptimalPartialLiquidation } from "./partialLiquidation.js";
 //#region src/onchain/accounts/liquidations/LiquidationsService.d.ts
 /**
  * Service for discovering liquidatable credit accounts and previewing manual
  * liquidations.
  **/
-declare class LiquidationsService extends SDKConstruct {
+export declare class LiquidationsService extends SDKConstruct {
   #private;
   /**
    * Returns all liquidatable credit accounts: accounts with health factor
@@ -30,30 +32,49 @@ declare class LiquidationsService extends SDKConstruct {
    * the debt from own funds and receiving the collateral from the credit account.
    **/
   buildLiquidationTx(props: BuildLiquidationTxProps): Promise<TxCall>;
+  /**
+   * Builds the transaction that fully liquidates a credit account, repaying
+   * the debt by swapping the account's own collateral through the router.
+   * The underlying left after the swaps is sent to `to`.
+   **/
+  fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
+  /**
+   * Details of a partial liquidation of a credit account, in the shape of a
+   * full one: what the liquidator pays, what it receives and what it must
+   * approve, plus {@link LiquidationDetails.isPartiallyLiquidatable}.
+   *
+   * A local estimate, not onchain read: no price feed updates are applied, so
+   * `ignoreReservePrices` has no effect here.
+   * Parameters left out of `props` are derived from current state.
+   *
+   * @throws For markets with a wrapped RWA underlying (Securitize), for a
+   * `tokenOut` that cannot be seized, and when no `tokenOut` can be picked.
+   **/
+  getPartialLiquidationDetails(props: GetPartialLiquidationDetailsProps): Promise<LiquidationDetails>;
+  /**
+   * Builds the transaction that partially liquidates a credit account,
+   * repaying part of its debt from the liquidator's funds in exchange for
+   * discounted collateral sent to the liquidator. Parameters left out of
+   * `props` are derived from current state.
+   *
+   * @throws For markets with a wrapped RWA underlying (Securitize), for a
+   * `tokenOut` that cannot be seized, when no `tokenOut` can be picked, and
+   * when the account cannot be partially liquidated, see
+   * {@link LiquidationDetails.isPartiallyLiquidatable}.
+   **/
+  buildPartialLiquidationTx(props: BuildPartialLiquidationTxProps): Promise<TxCall>;
   /**
    * Optimal partial liquidation of a credit account: the collateral to seize
    * and the amounts that bring its health factor close to `optimalHF`.
    *
-   * Prices come from the last synced oracle state and `ca`, not from fresh
-   * price updates. Withdrawal phantom tokens are never seized.
-   *
    * @param ca - Credit account to partially liquidate.
    * @param optimalHF - Health factor to aim for, in basis points. Defaults to
    * {@link CreditSuite.optimalHFForPartialLiquidation}.
+   * @param liquidationThresholds - Liquidation thresholds to use instead of
+   * the credit manager's cached ones, for example LTs just set on a fork.
    * @throws If no `tokenOut` can be picked.
    **/
-  getOptimalPartialLiquidation(ca: CreditAccountData, optimalHF?: bigint): OptimalPartialLiquidation;
-  /**
-   * Everything a partial liquidation of a credit account needs, with any
-   * parameter the caller pinned down taken as given and the rest derived from
-   * current state. A derived `tokenOut` is never a withdrawal phantom token.
-   *
-   * @param ca - Credit account to partially liquidate.
-   * @param overrides - Parameters to use instead of the derived defaults.
-   * @throws If a derived `tokenOut` cannot be picked, or if the seized token is
-   * not a collateral token of the credit manager.
-   **/
-  getPartialLiquidationParams(ca: CreditAccountData, overrides?: PartialLiquidationParams): Required<PartialLiquidationParams>;
+  getOptimalPartialLiquidation(ca: CreditAccountData, optimalHF?: bigint, liquidationThresholds?: AddressMap<number>): OptimalPartialLiquidation;
   /**
    * Returns the status of delayed-withdrawal positions (redemption receipts)
    * owned by a liquidator wallet: what is receivable, how much, and when it
@@ -67,5 +88,4 @@ declare class LiquidationsService extends SDKConstruct {
    **/
   loadRWALiquidators(props?: LoadRWALiquidatorsProps): Promise<void>;
 }
-//#endregion
-export { LiquidationsService };
+//#endregion

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

@@ -6,13 +6,13 @@ import { PluginsMap } from "../../plugins/types.js";
 import "../../plugins/index.js";
 import { MultichainConstruct } from "../../base/MultichainConstruct.js";
 import "../../base/index.js";
-import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, LoadRWALiquidatorsProps } from "./types.js";
+import { BuildLiquidationTxProps, BuildPartialLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, GetPartialLiquidationDetailsProps, LoadRWALiquidatorsProps } from "./types.js";
 //#region src/onchain/accounts/liquidations/MultichainLiquidationsService.d.ts
 /**
  * Cross-chain counterpart of {@link LiquidationsService}. These reads are live,
  * so each chain is pinned to its own freshly fetched head.
  **/
-declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
+export declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
   /**
    * Accounts of all queried chains, see
    * {@link LiquidationsService.getLiquidatableAccounts}.
@@ -30,6 +30,16 @@ declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {
    * The reported block is the one the transaction was built against.
    **/
   buildLiquidationTx(props: BuildLiquidationTxProps<true>): Promise<DataResponse<TxCall>>;
+  /**
+   * {@inheritDoc LiquidationsService.getPartialLiquidationDetails}
+   **/
+  getPartialLiquidationDetails(props: GetPartialLiquidationDetailsProps<true>): Promise<DataResponse<LiquidationDetails>>;
+  /**
+   * {@inheritDoc LiquidationsService.buildPartialLiquidationTx}
+   *
+   * The reported block is the one the transaction was built against.
+   **/
+  buildPartialLiquidationTx(props: BuildPartialLiquidationTxProps<true>): Promise<DataResponse<TxCall>>;
   /**
    * Liquidation positions of all queried chains, see
    * {@link LiquidationsService.getLiquidationPositions}.
@@ -44,5 +54,4 @@ declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {
    **/
   loadRWALiquidators(props?: LoadRWALiquidatorsProps<true>): Promise<DataResponse<void>>;
 }
-//#endregion
-export { MultichainLiquidationsService };
+//#endregion

package/dist/types/onchain/accounts/liquidations/constants.d.ts

@@ -1,11 +1,10 @@
 import { Address } from "viem";
 //#region src/onchain/accounts/liquidations/constants.d.ts
-declare const LIQUIDATION_COMPRESSOR_V313_ADDRESS: Address;
+export declare const LIQUIDATION_COMPRESSOR_V313_ADDRESS: Address;
 /**
  * Headroom (in bps) added on top of the amount the liquidation pulls when
  * building the liquidator's approval, so that the transaction does not revert
- * when prices move between the preview and the execution.
+ * when prices move or interest accrues between the preview and the execution.
  **/
-declare const LIQUIDATION_APPROVAL_BUFFER = 50n;
-//#endregion
-export { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS };
+export declare const LIQUIDATION_APPROVAL_BUFFER = 50n;
+//#endregion

package/dist/types/onchain/accounts/liquidations/index.d.ts

@@ -1,6 +1,6 @@
 import { LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
-import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, PartialLiquidationParams, RWALiquidatorInfo } from "./types.js";
+import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, BuildPartialLiquidationTxProps, BuildPartialLiquidationTxPropsBase, FullyLiquidateProps, FullyLiquidateResult, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, GetPartialLiquidationDetailsProps, GetPartialLiquidationDetailsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, PartialLiquidationParams, RWALiquidatorInfo } from "./types.js";
 import { OptimalPartialLiquidation, OptimalPartialLiquidationProps, PartialLiquidationParamsProps, optimalPartialLiquidation, partialLiquidationParams } from "./partialLiquidation.js";
 import { LiquidationsService } from "./LiquidationsService.js";
 import { MultichainLiquidationsService } from "./MultichainLiquidationsService.js";
-export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, LoadRWALiquidatorsProps, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, OptimalPartialLiquidation, OptimalPartialLiquidationProps, PartialLiquidationParams, PartialLiquidationParamsProps, RWALiquidatorInfo, optimalPartialLiquidation, partialLiquidationParams };
+export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, BuildPartialLiquidationTxProps, BuildPartialLiquidationTxPropsBase, FullyLiquidateProps, FullyLiquidateResult, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, GetPartialLiquidationDetailsProps, GetPartialLiquidationDetailsPropsBase, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, LoadRWALiquidatorsProps, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, OptimalPartialLiquidation, OptimalPartialLiquidationProps, PartialLiquidationParams, PartialLiquidationParamsProps, RWALiquidatorInfo, optimalPartialLiquidation, partialLiquidationParams };

package/dist/types/onchain/accounts/liquidations/partialLiquidation.d.ts

@@ -1,7 +1,9 @@
+import { AddressMap } from "../../utils/AddressMap.js";
 import { CreditAccountData } from "../../base/types.js";
 import { CreditSuite } from "../../market/credit/CreditSuite.js";
 import { OptimalPartialLiquidationAmounts } from "../../market/math.js";
 import "../../market/index.js";
+import "../../utils/index.js";
 import "../../base/index.js";
 import { PartialLiquidationParams } from "./types.js";
 import { Address } from "viem";
@@ -9,7 +11,7 @@ import { Address } from "viem";
 /**
  * Inputs of {@link optimalPartialLiquidation}.
  **/
-interface OptimalPartialLiquidationProps {
+export interface OptimalPartialLiquidationProps {
   /**
    * Credit suite of the account.
    **/
@@ -27,12 +29,18 @@ interface OptimalPartialLiquidationProps {
    * Tokens that cannot be seized.
    **/
   exclude?: (token: Address) => boolean;
+  /**
+   * Liquidation thresholds to use instead of the credit manager's cached ones,
+   * for example LTs just set on a fork. Tokens missing here fall back to the
+   * credit manager.
+   **/
+  liquidationThresholds?: AddressMap<number>;
 }
 /**
  * Partial liquidation that brings the account's health factor close to the
  * target, see {@link OptimalPartialLiquidationAmounts}.
  **/
-interface OptimalPartialLiquidation extends OptimalPartialLiquidationAmounts {
+export interface OptimalPartialLiquidation extends OptimalPartialLiquidationAmounts {
   /**
    * Collateral token to seize.
    **/
@@ -41,7 +49,7 @@ interface OptimalPartialLiquidation extends OptimalPartialLiquidationAmounts {
 /**
  * Inputs of {@link partialLiquidationParams}.
  **/
-interface PartialLiquidationParamsProps {
+export interface PartialLiquidationParamsProps {
   /**
    * Credit suite of the account.
    **/
@@ -53,7 +61,7 @@ interface PartialLiquidationParamsProps {
   /**
    * Parameters to use instead of the derived defaults.
    **/
-  overrides?: PartialLiquidationParams;
+  overrides?: Partial<PartialLiquidationParams>;
   /**
    * Tokens that cannot be picked as the default `tokenOut`.
    **/
@@ -68,7 +76,7 @@ interface PartialLiquidationParamsProps {
  *
  * @throws If no `tokenOut` can be picked.
  **/
-declare function optimalPartialLiquidation({ suite, account, optimalHF, exclude }: OptimalPartialLiquidationProps): OptimalPartialLiquidation;
+export declare function optimalPartialLiquidation({ suite, account, optimalHF, exclude, liquidationThresholds }: OptimalPartialLiquidationProps): OptimalPartialLiquidation;
 /**
  * Everything a partial liquidation of credit account needs, with any parameter
  * the caller pinned down taken as given and the rest derived from current state.
@@ -76,6 +84,5 @@ declare function optimalPartialLiquidation({ suite, account, optimalHF, exclude
  * @throws If a derived `tokenOut` cannot be picked, or if the seized token is
  * not a collateral token of the credit manager.
  **/
-declare function partialLiquidationParams({ suite, account, overrides, exclude }: PartialLiquidationParamsProps): Required<PartialLiquidationParams>;
-//#endregion
-export { OptimalPartialLiquidation, OptimalPartialLiquidationProps, PartialLiquidationParamsProps, optimalPartialLiquidation, partialLiquidationParams };
+export declare function partialLiquidationParams({ suite, account, overrides, exclude }: PartialLiquidationParamsProps): PartialLiquidationParams;
+//#endregion

package/dist/types/onchain/accounts/liquidations/skipLiquidatableAccount.d.ts

@@ -6,6 +6,5 @@ import { Address } from "viem";
  * collateral computation failed, or it holds a Mellow withdrawal phantom
  * token above dust (no liquidation subcompressor for that type).
  **/
-declare function skipLiquidatableAccount(account: Pick<CreditAccountData, "success" | "tokens">, getContractType: (token: Address) => string | undefined): boolean;
-//#endregion
-export { skipLiquidatableAccount };
+export declare function skipLiquidatableAccount(account: Pick<CreditAccountData, "success" | "tokens">, getContractType: (token: Address) => string | undefined): boolean;
+//#endregion

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

@@ -2,28 +2,31 @@ import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompress
 import { LiquidatableAccountFilter } from "../../../model/liquidations.js";
 import "../../../model/index.js";
 import { MultichainChainIdsProps, MultichainNetworkProps, WithBlock, WithMultichain } from "../../types/multichain.js";
+import { RouterCASlice, RouterCloseResult } from "../../router/types.js";
+import "../../router/index.js";
+import { MultiCall, RawTx } from "../../types/transactions.js";
 import "../../types/index.js";
 import { Address, ContractFunctionReturnType } from "viem";
 //#region src/onchain/accounts/liquidations/types.d.ts
 /**
  * Raw `LiquidationData` returned by `LiquidationCompressor.getLiquidationData`.
  **/
-type OnchainLiquidationData = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "nonpayable", "getLiquidationData">;
+export type OnchainLiquidationData = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "nonpayable", "getLiquidationData">;
 /**
  * Single element of {@link OnchainLiquidationData.expectedOutputs}.
  **/
-type OnchainLiquidationOutput = OnchainLiquidationData["expectedOutputs"][number];
+export type OnchainLiquidationOutput = OnchainLiquidationData["expectedOutputs"][number];
 /**
  * Single call built by the liquidation compressor.
  **/
-type OnchainLiquidationCall = OnchainLiquidationData["liquidationCall"];
+export type OnchainLiquidationCall = OnchainLiquidationData["liquidationCall"];
 /**
  * A dedicated RWA liquidator contract (Midas / Securitize) discovered by
  * `LiquidationCompressor.getRWALiquidators`. `contractType` is the bytes32
  * contract type of the liquidator itself (e.g. `RWA_LIQUIDATOR::MIDAS`),
  * not of the phantom token it was found through.
  **/
-type RWALiquidatorInfo = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "view", "getRWALiquidators">[number];
+export type RWALiquidatorInfo = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "view", "getRWALiquidators">[number];
 /**
  * Props for {@link LiquidationsService.getLiquidatableAccounts}: the read
  * model's {@link LiquidatableAccountFilter}, whose
@@ -33,26 +36,25 @@ type RWALiquidatorInfo = ContractFunctionReturnType<typeof iLiquidationCompresso
  * {@link BlockNumberProps.blockNumber} is only on the single-chain form: a
  * height is not shared across the networks of the fan-out.
  **/
-type GetLiquidatableAccountsProps<Multichain extends boolean = false> = LiquidatableAccountFilter & WithBlock<Multichain>;
+export type GetLiquidatableAccountsProps<Multichain extends boolean = false> = LiquidatableAccountFilter & WithBlock<Multichain>;
 /**
  * Chain-independent part of {@link GetLiquidationDetailsProps}.
  **/
-interface GetLiquidationDetailsPropsBase {
+export interface GetLiquidationDetailsPropsBase {
   /**
    * Credit account to get liquidation details for.
    **/
   creditAccount: Address;
   /**
-   * 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 wallet address, used to check KYC eligibility. Amounts and
+   * received assets are unaffected. When omitted,
+   * {@link LiquidationDetails.isLiquidatorEligible} 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.
+   * applied before computing amounts.
    **/
   ignoreReservePrices?: boolean;
   /**
@@ -66,11 +68,11 @@ interface GetLiquidationDetailsPropsBase {
  * {@link BlockNumberProps.blockNumber} is kept on the multichain form because
  * the method already targets a single {@link MultichainNetworkProps.network}.
  **/
-type GetLiquidationDetailsProps<Multichain extends boolean = false> = GetLiquidationDetailsPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
+export type GetLiquidationDetailsProps<Multichain extends boolean = false> = GetLiquidationDetailsPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
 /**
  * Chain-independent part of {@link BuildLiquidationTxProps}.
  **/
-interface BuildLiquidationTxPropsBase {
+export interface BuildLiquidationTxPropsBase {
   /**
    * Credit account to liquidate.
    **/
@@ -82,7 +84,7 @@ interface BuildLiquidationTxPropsBase {
   liquidator: Address;
   /**
    * If true, reserve price feed updates are excluded from the price updates
-   * applied by the compressor before building the transaction.
+   * applied before building the transaction.
    **/
   ignoreReservePrices?: boolean;
   /**
@@ -96,11 +98,89 @@ interface BuildLiquidationTxPropsBase {
  * {@link BlockNumberProps.blockNumber} is kept on the multichain form because
  * the method already targets a single {@link MultichainNetworkProps.network}.
  **/
-type BuildLiquidationTxProps<Multichain extends boolean = false> = BuildLiquidationTxPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
+export type BuildLiquidationTxProps<Multichain extends boolean = false> = BuildLiquidationTxPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
+/**
+ * Props for {@link LiquidationsService.fullyLiquidate}.
+ **/
+export interface FullyLiquidateProps {
+  /**
+   * Credit account to liquidate
+   */
+  account: RouterCASlice;
+  /**
+   * Address to transfer underlying left after liquidation
+   */
+  to: Address;
+  /**
+   * Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
+   */
+  slippage?: bigint;
+  /**
+   * List of assets to keep on account after liquidation
+   */
+  keepAssets?: Address[];
+  /**
+   * If true, will ignore reserve prices
+   */
+  ignoreReservePrices?: boolean;
+  /**
+   * If true, will try to apply loss policy
+   */
+  applyLossPolicy?: boolean;
+  /**
+   * Debt only mode — will try to sell just enough of the most valuable token to cover debt.
+   */
+  debtOnly?: boolean;
+}
+/**
+ * Result of {@link LiquidationsService.fullyLiquidate}.
+ **/
+export interface FullyLiquidateResult {
+  /**
+   * Raw transaction data ready to be signed and submitted.
+   **/
+  tx: RawTx;
+  /**
+   * Multicall entries passed to the credit facade, price updates included.
+   **/
+  calls: Array<MultiCall>;
+  /**
+   * Router result describing the swap path used to convert account tokens into the underlying.
+   **/
+  routerCloseResult: RouterCloseResult;
+}
+/**
+ * Chain-independent part of {@link GetPartialLiquidationDetailsProps}.
+ *
+ * Parameters left out are derived from current state, see
+ * {@link PartialLiquidationParams}.
+ **/
+export interface GetPartialLiquidationDetailsPropsBase extends GetLiquidationDetailsPropsBase, Partial<PartialLiquidationParams> {}
+/**
+ * Props for {@link LiquidationsService.getPartialLiquidationDetails}.
+ *
+ * {@link BlockNumberProps.blockNumber} is kept on the multichain form because
+ * the method already targets a single {@link MultichainNetworkProps.network}.
+ **/
+export type GetPartialLiquidationDetailsProps<Multichain extends boolean = false> = GetPartialLiquidationDetailsPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
+/**
+ * Chain-independent part of {@link BuildPartialLiquidationTxProps}.
+ *
+ * Parameters left out are derived from current state, see
+ * {@link PartialLiquidationParams}.
+ **/
+export interface BuildPartialLiquidationTxPropsBase extends BuildLiquidationTxPropsBase, Partial<PartialLiquidationParams> {}
+/**
+ * Props for {@link LiquidationsService.buildPartialLiquidationTx}.
+ *
+ * {@link BlockNumberProps.blockNumber} is kept on the multichain form because
+ * the method already targets a single {@link MultichainNetworkProps.network}.
+ **/
+export type BuildPartialLiquidationTxProps<Multichain extends boolean = false> = BuildPartialLiquidationTxPropsBase & WithMultichain<Multichain, MultichainNetworkProps>;
 /**
  * Chain-independent part of {@link GetLiquidationPositionsProps}.
  **/
-interface GetLiquidationPositionsPropsBase {
+export interface GetLiquidationPositionsPropsBase {
   /**
    * Liquidator wallet that owns the redemption receipts (redeemer contracts
    * received as a result of liquidations).
@@ -113,41 +193,52 @@ interface GetLiquidationPositionsPropsBase {
  * {@link BlockNumberProps.blockNumber} is only on the single-chain form: a
  * height is not shared across the networks of the fan-out.
  **/
-type GetLiquidationPositionsProps<Multichain extends boolean = false> = GetLiquidationPositionsPropsBase & WithBlock<Multichain> & WithMultichain<Multichain, MultichainChainIdsProps>;
+export type GetLiquidationPositionsProps<Multichain extends boolean = false> = GetLiquidationPositionsPropsBase & WithBlock<Multichain> & WithMultichain<Multichain, MultichainChainIdsProps>;
 /**
- * Partial liquidation parameters a caller wants to pin down instead of letting
- * {@link LiquidationsService.getPartialLiquidationParams} derive them.
+ * Partial liquidation parameters used by
+ * {@link LiquidationsService.getPartialLiquidationDetails} and
+ * {@link LiquidationsService.buildPartialLiquidationTx}. A caller can pin
+ * down any of them instead of letting them be derived from current state.
  *
  * @remarks
  * The defaults are derived in order - `optimalHF` feeds `repaidAmount`, which
  * feeds `minSeizedAmount` - so overriding one still lets the ones after it
  * follow from the override.
  **/
-interface PartialLiquidationParams {
+export interface PartialLiquidationParams {
   /**
    * Collateral token to seize.
-   * If omitted, the most valuable enabled non-underlying collateral token
-   * (by oracle), excluding withdrawal phantom tokens
+   * Defaults to the most valuable enabled non-underlying collateral token
+   * (by oracle), excluding withdrawal phantom tokens and phantom tokens that
+   * unwrap to the underlying
    */
-  tokenOut?: Address;
+  tokenOut: Address;
   /**
-   * Amount of underlying token to repay.
-   * If omitted, computed internally
+   * Amount of underlying the liquidator pays; the credit manager transfers it
+   * from the wallet.
+   *
+   * Defaults to the amount that brings the account close to `optimalHF`.
    */
-  repaidAmount?: bigint;
+  repaidAmount: bigint;
   /**
    * Minimum amount of `token` to seize from `creditAccount`.
    * If `token` is a phantom token, it's withdrawn first, and its `depositedToken` is then sent to the liquidator.
    * In this case, `minSeizedAmount` is denominated in `depositedToken`.
-   * If omitted, computed internally.
+   * Computed internally by default.
    */
-  minSeizedAmount?: bigint;
+  minSeizedAmount: bigint;
   /**
    * Target health factor for partial liquidation (4 digits precision, 10000 = 100%).
-   * If omitted, defaults to {@link CreditSuite.optimalHFForPartialLiquidation}.
-   * Only used when `repaidAmount` is not explicitly provided.
+   * Defaults to {@link CreditSuite.optimalHFForPartialLiquidation}.
    */
-  optimalHF?: bigint;
+  optimalHF: bigint;
+  /**
+   * `false` when the account is neither unhealthy nor expired, when no
+   * repayment reaches `optimalHF` without leaving less than the minimum debt
+   * on the account, or when the account is already there. Computed for the
+   * resolved `tokenOut` even when `repaidAmount` was overridden.
+   **/
+  isPartiallyLiquidatable: boolean;
 }
 /**
  * Props for {@link LiquidationsService.loadRWALiquidators}.
@@ -155,6 +246,5 @@ interface PartialLiquidationParams {
  * {@link BlockNumberProps.blockNumber} is only on the single-chain form: a
  * height is not shared across the networks of the fan-out.
  **/
-type LoadRWALiquidatorsProps<Multichain extends boolean = false> = WithBlock<Multichain> & WithMultichain<Multichain, MultichainChainIdsProps>;
-//#endregion
-export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, PartialLiquidationParams, RWALiquidatorInfo };
+export type LoadRWALiquidatorsProps<Multichain extends boolean = false> = WithBlock<Multichain> & WithMultichain<Multichain, MultichainChainIdsProps>;
+//#endregion

package/dist/types/onchain/accounts/multicall-utils.d.ts

@@ -14,7 +14,7 @@ import "../types/index.js";
  * @returns Object with `priceUpdates` (decoded price update tuples) and
  *          `remainingCalls` (everything else, preserving order)
  */
-declare function extractPriceUpdates(calls: MultiCall[]): {
+export declare function extractPriceUpdates(calls: MultiCall[]): {
   priceUpdates: PriceUpdate[];
   remainingCalls: MultiCall[];
 };
@@ -27,7 +27,7 @@ declare function extractPriceUpdates(calls: MultiCall[]): {
  * @param calls - Array of multicall entries to scan
  * @returns Unique token addresses from positive-change quota updates
  */
-declare function extractQuotaTokens(calls: MultiCall[]): AddressSet;
+export declare function extractQuotaTokens(calls: MultiCall[]): AddressSet;
 /**
  * Merges two {@link PriceUpdate} arrays, deduplicating by `priceFeed` address.
  *
@@ -38,6 +38,5 @@ declare function extractQuotaTokens(calls: MultiCall[]): AddressSet;
  * @param generated - Newly generated price updates to merge in
  * @returns Merged array with no duplicate `priceFeed` addresses
  */
-declare function mergePriceUpdates(existing: PriceUpdate[], generated: PriceUpdate[]): PriceUpdate[];
-//#endregion
-export { extractPriceUpdates, extractQuotaTokens, mergePriceUpdates };
+export declare function mergePriceUpdates(existing: PriceUpdate[], generated: PriceUpdate[]): PriceUpdate[];
+//#endregion

package/dist/types/onchain/accounts/quota-utils.d.ts

@@ -2,18 +2,18 @@ import { Asset, AssetWithAmountInTarget } from "../base/types.js";
 import { QuotaSlice } from "../market/credit/types.js";
 import { Address } from "viem";
 //#region src/onchain/accounts/quota-utils.d.ts
-interface CalcDefaultQuotaProps {
+export interface CalcDefaultQuotaProps {
   amount: bigint;
   lt: bigint;
   quotaReserve: bigint;
 }
-interface CalcRecommendedQuotaProps {
+export interface CalcRecommendedQuotaProps {
   amount: bigint;
   debt: bigint;
   lt: bigint;
   quotaReserve: bigint;
 }
-interface MaxAmountForQuotaProps {
+export interface MaxAmountForQuotaProps {
   available: bigint;
   initialQuota: bigint;
   totalInitialQuota: bigint;
@@ -21,7 +21,7 @@ interface MaxAmountForQuotaProps {
   lt: bigint;
   quotaReserve: bigint;
 }
-interface CalcQuotaUpdateProps {
+export interface CalcQuotaUpdateProps {
   quotas: Record<Address, QuotaSlice | undefined>;
   initialQuotas: Record<Address, {
     quota: bigint;
@@ -46,7 +46,7 @@ interface CalcQuotaUpdateReturnType {
  * Quota that keeps a directly transferred token enabled, so a liquidation
  * counts it.
  */
-declare const DIRECT_TRANSFERS_QUOTA = 10000n;
+export declare const DIRECT_TRANSFERS_QUOTA = 10000n;
 /**
  * Rounds quota deltas to protocol precision step (`PERCENTAGE_FACTOR`).
  *
@@ -56,7 +56,7 @@ declare const DIRECT_TRANSFERS_QUOTA = 10000n;
  * @param quotaChange Raw quota delta.
  * @returns Rounded quota delta, or untouched `MIN_INT96` sentinel.
  */
-declare function roundUpQuota(quotaChange: bigint): bigint;
+export declare function roundUpQuota(quotaChange: bigint): bigint;
 /**
  * Computes recommended quota for a token when debt-aware capping is enabled.
  *
@@ -66,7 +66,7 @@ declare function roundUpQuota(quotaChange: bigint): bigint;
  * @param props Token amount in target units, debt, liquidation threshold, reserve.
  * @returns Recommended rounded quota.
  */
-declare function calcRecommendedQuota({ amount, debt, lt, quotaReserve }: CalcRecommendedQuotaProps): bigint;
+export declare function calcRecommendedQuota({ amount, debt, lt, quotaReserve }: CalcRecommendedQuotaProps): bigint;
 /**
  * Computes default quota for a token without debt capping.
  *
@@ -76,9 +76,9 @@ declare function calcRecommendedQuota({ amount, debt, lt, quotaReserve }: CalcRe
  * @param props Token amount in target units, liquidation threshold, reserve.
  * @returns Default rounded quota.
  */
-declare function calcDefaultQuota({ amount, lt, quotaReserve }: CalcDefaultQuotaProps): bigint;
+export declare function calcDefaultQuota({ amount, lt, quotaReserve }: CalcDefaultQuotaProps): bigint;
 /** Inverse of default quota rounding, including the account-wide increase cap. */
-declare function maxAmountForQuota({ available, initialQuota, totalInitialQuota, maxDebt, lt, quotaReserve }: MaxAmountForQuotaProps): bigint | undefined;
+export declare function maxAmountForQuota({ available, initialQuota, totalInitialQuota, maxDebt, lt, quotaReserve }: MaxAmountForQuotaProps): bigint | undefined;
 /**
  * Produces desired quota state and explicit increase/decrease actions.
  *
@@ -93,6 +93,6 @@ declare function maxAmountForQuota({ available, initialQuota, totalInitialQuota,
  * @param props Current quotas, initial quotas, permissions, and calculation context.
  * @returns Desired quota map plus separate increase/decrease instruction lists.
  */
-declare function calcQuotaUpdate(props: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
+export declare function calcQuotaUpdate(props: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
 //#endregion
-export { CalcDefaultQuotaProps, CalcQuotaUpdateProps, CalcRecommendedQuotaProps, DIRECT_TRANSFERS_QUOTA, MaxAmountForQuotaProps, calcDefaultQuota, calcQuotaUpdate, calcRecommendedQuota, maxAmountForQuota, roundUpQuota };
+export {};