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

package/dist/types/preview/simulate/simulateRWAOperation.d.ts

@@ -1,19 +1,6 @@
-import type { Address, Hex } from "viem";
-import type { OnchainSDK } from "../../sdk/index.js";
 import type { RWAOperation } from "../parse/index.js";
-import type { OperationSimulationOptions, PoolOperationSimulation } from "./types.js";
-export interface SimulateRWAOperationInput {
-    /** Only `client`/`networkType` are used, so any OnchainSDK works. */
-    sdk: OnchainSDK;
-    /** Parsed RWA-factory operation to simulate. */
-    operation: RWAOperation;
-    /** Target contract the calldata is sent to (the RWA factory). */
-    to: Address;
-    /** Raw RWA-factory calldata to simulate. */
-    calldata: Hex;
-    /** Wallet whose balance changes and transfers we track. */
-    wallet: Address;
-}
+import type { PreviewOperationOptions } from "../types.js";
+import type { PoolOperationSimulationResult, SimulationInput } from "./types.js";
 /**
  * Simulates an RWA-factory operation.
  *
@@ -22,4 +9,4 @@ export interface SimulateRWAOperationInput {
  * not cover. The signature mirrors {@link simulatePoolOperation} so the
  * {@link simulateOperation} wrapper can delegate uniformly once implemented.
  */
-export declare function simulateRWAOperation(_input: SimulateRWAOperationInput, _options?: OperationSimulationOptions): Promise<PoolOperationSimulation>;
+export declare function simulateRWAOperation(_input: SimulationInput<RWAOperation>, _options?: PreviewOperationOptions): Promise<PoolOperationSimulationResult>;

package/dist/types/preview/simulate/types.d.ts

@@ -1,66 +1,35 @@
 import type { Address, Hex } from "viem";
 import type { OnchainSDK } from "../../sdk/index.js";
-import type { ILogger } from "../../sdk/types/logger.js";
-import type { PoolOperation } from "../parse/index.js";
-import type { PreviewSimulationError } from "./errors.js";
+import type { Operation } from "../parse/index.js";
 /**
- * Change in an address's balance of a single token over the simulated call.
- * `delta` is `after - before` (negative when the address spent the token).
+ * Input of the simulation functions, generic over the parsed operation kind
+ * so each specialized simulation narrows `operation` while sharing the same
+ * shape.
  */
-export interface TokenBalanceChange {
-    token: Address;
-    before: bigint;
-    after: bigint;
-    delta: bigint;
-}
-/**
- * Balance changes for a single watched address (e.g. the wallet or the
- * operation recipient). Keyed purely by address; UI labeling is resolved
- * separately by the presentation layer.
- */
-export interface AddressBalanceChanges {
-    address: Address;
-    changes: TokenBalanceChange[];
-}
-export interface PoolOperationSimulationInput {
+export interface SimulationInput<Op extends Operation = Operation> {
     /** Only `client`/`networkType` are used, so any OnchainSDK works. */
     sdk: OnchainSDK;
-    /** Parsed operation, used to resolve the underlying and pool tokens. */
-    operation: PoolOperation;
-    /** Target contract the calldata is sent to (the pool). */
+    /** Parsed operation to simulate. */
+    operation: Op;
+    /** Target contract the calldata is sent to. */
     to: Address;
-    /** Raw deposit/mint/withdraw/redeem calldata to simulate. */
+    /** Raw operation calldata to simulate. */
     calldata: Hex;
-    /** Wallet whose balance changes and transfers we track. */
-    wallet: Address;
-}
-export interface OperationSimulationOptions {
-    /** Block to simulate at; defaults to latest. */
-    blockNumber?: bigint;
-    /**
-     * Optional logger.
-     **/
-    logger?: ILogger;
 }
 /**
- * Successful simulation of a pool operation: the balance changes grouped by
- * watched address. This is the success payload of
- * {@link PoolOperationSimulation} without the `status` discriminant.
+ * Result of simulating a pool operation: the amounts of tokens going in
+ * and out. One side comes from calldata, the other from the matching ERC4626
+ * preview read.
  */
 export interface PoolOperationSimulationResult {
     /**
-     * Balance changes grouped by watched address (wallet, recipient, owner).
+     * Amount of tokens going from the user to the pool (underlying or zapper
+     * input token for deposit/mint, pool shares for withdraw/redeem).
+     **/
+    amountIn: bigint;
+    /**
+     * Amount of tokens going from the pool to the user (pool shares or zapper
+     * output token for deposit/mint, underlying for withdraw/redeem).
      **/
-    balanceChanges: AddressBalanceChanges[];
+    amountOut: bigint;
 }
-/**
- * Outcome of simulating a pool operation. On success it carries a
- * {@link PoolOperationSimulationResult}; on failure it carries a
- * {@link PreviewSimulationError}.
- */
-export type PoolOperationSimulation = ({
-    status: "success";
-} & PoolOperationSimulationResult) | {
-    status: "failure";
-    error: PreviewSimulationError;
-};

package/dist/types/preview/types.d.ts

@@ -0,0 +1,63 @@
+import type { Address, Hex } from "viem";
+import type { SdkWithAdapters } from "../plugins/adapters/index.js";
+import type { CreditAccountData, PluginsMap } from "../sdk/index.js";
+import type { ILogger } from "../sdk/types/logger.js";
+/**
+ * Raw-calldata operation input shared by `parseOperationCalldata`,
+ * `previewOperation` and `checkPrerequisites`.
+ */
+export interface PreviewOperationInput<P extends PluginsMap = PluginsMap> {
+    /**
+     * Already-attached SDK; chain, RPC and block are baked in at attach time.
+     * Must be created with the adapters plugin (enforced at compile time) so
+     * adapter contracts resolve during multicall classification.
+     */
+    sdk: SdkWithAdapters<P>;
+    /**
+     * Contract address that was called
+     */
+    to: Address;
+    /**
+     * Raw calldata of the operation
+     */
+    calldata: Hex;
+    /**
+     * Transaction sender
+     */
+    sender: Address;
+    /**
+     * Transaction `msg.value`, required for native-token zapper deposits.
+     **/
+    value?: bigint;
+}
+interface PreviewOperationOptionsBase {
+    /**
+     * Block to read/simulate at; defaults to latest. Only set for testnet
+     * forks.
+     */
+    blockNumber?: bigint;
+    /**
+     * Optional logger.
+     **/
+    logger?: ILogger;
+}
+/**
+ * Options shared by the preview, simulation and prerequisite-check flows.
+ * Each flow uses the subset it needs and ignores the rest.
+ *
+ * `WithAccount = true` marks options whose credit account state has already
+ * been resolved (internal preview paths on an existing credit account).
+ */
+export type PreviewOperationOptions<WithAccount extends boolean = false> = WithAccount extends true ? PreviewOperationOptionsBase & {
+    /**
+     * Pre-resolved state of the credit account the operation targets
+     */
+    creditAccount: CreditAccountData;
+} : PreviewOperationOptionsBase & {
+    /**
+     * @internal
+     * Credit account state for testing purposes
+     */
+    creditAccount?: CreditAccountData;
+};
+export {};

package/dist/types/rewards/rewards/extra-apy.d.ts

@@ -12,6 +12,7 @@ export interface GetTotalTokensOnProtocolProps {
     tokensToCheck: Array<Address>;
     tokensList: Record<Address, TokenData>;
     network: NetworkType;
+    backendUrl?: string;
 }
 export type PoolPointsBase = Record<Address, Array<{
     key: string;
@@ -21,7 +22,8 @@ export type PoolPointsBase = Record<Address, Array<{
 export declare function getKeyForPoolPointsInfo(i: PoolPointsInfo<string>): string;
 export declare class PoolPointsAPI {
     private constructor();
-    static getTotalTokensOnProtocol({ tokensToCheck, tokensList, network, }: GetTotalTokensOnProtocolProps): Promise<[`0x${string}`, PromiseSettledResult<Asset>][]>;
+    private static defaultBackendUrl;
+    static getTotalTokensOnProtocol({ tokensToCheck, tokensList, network, backendUrl, }: GetTotalTokensOnProtocolProps): Promise<[`0x${string}`, PromiseSettledResult<Asset>][]>;
     private static getTokenTotal;
     static getPointsByPool({ poolRewards, totalTokenBalances, pools, tokensList, }: GetPointsByPoolProps): PoolPointsBase;
     private static getPoolTokenPoints;

package/dist/types/sdk/MultichainSDK.d.ts

@@ -1,3 +1,4 @@
+import type { ILiquidationsService } from "./accounts/index.js";
 import type { NetworkType } from "./chain/chains.js";
 import { type PythOptions, type RedstoneOptions } from "./market/pricefeeds/updates/index.js";
 import { type AttachOptions, type ClientOptions, type HydrateOptions, OnchainSDK } from "./OnchainSDK.js";
@@ -102,6 +103,11 @@ export interface MultichainSyncStateOptions {
  **/
 export declare class MultichainSDK<const Plugins extends PluginsMap = {}> {
     #private;
+    /**
+     * Namespace for liquidatable credit accounts discovery across all
+     * configured chains.
+     */
+    readonly liquidations: ILiquidationsService;
     constructor(options: MultichainSDKOptions<Plugins>);
     /**
      * Attach all configured chains in parallel.

package/dist/types/sdk/OnchainSDK.d.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
 import { type PublicClient, type Transport } from "viem";
 import type { HttpRpcClientOptions } from "viem/utils";
-import { type ICreditAccountsService } from "./accounts/index.js";
+import { type ICreditAccountsService, type ILiquidationsService, type IRedemptionLoggerContract, type IWithdrawalCompressorContract } from "./accounts/index.js";
 import type { BaseState, IBaseContract } from "./base/index.js";
 import { ChainContractsRegister } from "./base/index.js";
 import type { GearboxChain, NetworkType } from "./chain/chains.js";
@@ -191,6 +191,10 @@ export declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends C
      * Namespace for pool operations.
      */
     readonly pools: IPoolsService;
+    /**
+     * Namespace for liquidatable credit accounts discovery.
+     */
+    readonly liquidations: ILiquidationsService;
     /**
      * @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
      * @param clientOptions - Connection options (RPC URLs, transport, or client).
@@ -286,4 +290,16 @@ export declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends C
     } | {
         creditFacade: Address | BaseState | IBaseContract;
     } | VersionRange): IRouterContract;
+    /**
+     * Withdrawal compressor contract for the current chain, or `undefined`
+     * when no withdrawal compressor is supported on it.
+     **/
+    get withdrawalCompressor(): IWithdrawalCompressorContract | undefined;
+    /**
+     * `RedemptionLogger` contract for the current chain, or `undefined` when
+     * it is not deployed on it. Created lazily on first access: the contract
+     * is resolved from the address provider, which is only available after
+     * the SDK is attached or hydrated.
+     **/
+    get redemptionLogger(): IRedemptionLoggerContract | undefined;
 }

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

@@ -4,9 +4,10 @@ import { SDKConstruct } from "../base/index.js";
 import { type PriceUpdate } from "../market/index.js";
 import type { RWAOpenAccountRequirements } from "../market/rwa/index.js";
 import type { OnchainSDK } from "../OnchainSDK.js";
-import { type RouterCASlice } from "../router/index.js";
+import type { RouterCASlice } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
-import type { AccountToCheck, AddCollateralProps, AssembleCaUpdateCallsProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, DefaultPartialLiquidationParams, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
+import type { AccountToCheck, AddCollateralProps, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, DefaultPartialLiquidationParams, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PreviewDelayedWithdrawalProps, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
+import type { RequestableWithdrawal } from "./withdrawal-compressor/index.js";
 /**
  * Options for configuring the credit account service.
  **/
@@ -17,15 +18,6 @@ export interface CreditAccountServiceOptions {
      **/
     batchSize?: number;
 }
-/**
- * Returns the withdrawal compressor contract address for the given chain, or `undefined` if none is configured.
- * @param chainId - Numeric chain ID.
- * @returns Withdrawal compressor address, or `undefined`.
- **/
-export declare function getWithdrawalCompressorAddress(chainId: number): {
-    address: Address;
-    version: 311 | 310;
-};
 /**
  * Service for querying and operating on Gearbox credit accounts.
  *
@@ -79,6 +71,10 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
      * {@inheritDoc ICreditAccountsService.closeCreditAccount}
      **/
     closeCreditAccount({ operation, assetsToWithdraw, creditAccount: ca, to, slippage, closePath, }: CloseCreditAccountProps): Promise<CloseCreditAccountResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.assembleCloseCreditAccountCalls}
+     */
+    assembleCloseCreditAccountCalls({ creditAccount: ca, routerCalls, assetsToWithdraw, to, }: AssembleCloseCreditAccountCallsProps): Promise<Array<MultiCall>>;
     /**
      * {@inheritDoc ICreditAccountsService.updateQuotas}
      **/
@@ -98,11 +94,19 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
     /**
      * {@inheritDoc ICreditAccountsService.previewDelayedWithdrawal}
      **/
-    previewDelayedWithdrawal({ creditAccount, amount, token, }: PreviewDelayedWithdrawalProps): Promise<PreviewDelayedWithdrawalResult>;
+    previewDelayedWithdrawal({ creditAccount, amount, token, withdrawalPhantomToken, intent, }: PreviewDelayedWithdrawalProps): Promise<RequestableWithdrawal>;
     /**
      * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
      **/
     getPendingWithdrawals({ creditAccount, }: GetPendingWithdrawalsProps): Promise<GetPendingWithdrawalsResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.assembleStartDelayedWithdrawalCalls}
+     **/
+    assembleStartDelayedWithdrawalCalls({ creditFacade, preview, }: AssembleStartDelayedWithdrawalCallsProps): Array<MultiCall>;
+    /**
+     * {@inheritDoc ICreditAccountsService.assembleClaimDelayedCalls}
+     **/
+    assembleClaimDelayedCalls({ creditFacade, claimableNow, }: AssembleClaimDelayedCallsProps): Array<MultiCall>;
     /**
      * {@inheritDoc ICreditAccountsService.startDelayedWithdrawal}
      **/
@@ -178,7 +182,11 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
     /**
      * {@inheritDoc ICreditAccountsService.repayCreditAccount}
      */
-    repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, calls: wrapCalls, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
+    repayCreditAccount(props: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.assembleRepayCreditAccountCalls}
+     */
+    assembleRepayCreditAccountCalls({ collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, calls: wrapCalls, }: AssembleRepayCreditAccountCallsProps): Promise<Array<MultiCall>>;
     /**
      * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
      */
@@ -211,9 +219,9 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
         ignoreReservePrices?: boolean;
     }): Promise<MultiCall[]>;
     /**
-     * {@inheritDoc ICreditAccountsService.assembleCaUpdateCalls}
+     * {@inheritDoc ICreditAccountsService.assembleCaOperations}
      */
-    assembleCaUpdateCalls({ operations, routerCallGroups, creditFacade, withdrawTo, creditAccount, underlyingToken, }: AssembleCaUpdateCallsProps): MultiCall[];
+    assembleCaOperations({ operations, creditFacade, }: AssembleCaOperationsProps): MultiCall[];
     /**
      * {@inheritDoc ICreditAccountsService.executeCaUpdate}
      */

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

@@ -1,2 +1,4 @@
 export * from "./CreditAccountsServiceV310.js";
+export * from "./liquidations/index.js";
 export * from "./types.js";
+export * from "./withdrawal-compressor/index.js";

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

@@ -0,0 +1,24 @@
+import { SDKConstruct } from "../../base/index.js";
+import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
+/**
+ * Per-chain implementation of {@link ILiquidationsService}.
+ *
+ * Discovers liquidatable credit accounts (health factor below 1 plus accounts
+ * of expired credit managers with outstanding debt) and previews what a
+ * manual liquidation pays and receives.
+ **/
+export declare class LiquidationsService extends SDKConstruct implements ILiquidationsService {
+    #private;
+    /**
+     * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+     **/
+    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps): Promise<LiquidatableAccount[]>;
+    /**
+     * {@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

@@ -0,0 +1,27 @@
+import type { MultichainSDK } from "../../MultichainSDK.js";
+import type { PluginsMap } from "../../plugins/index.js";
+import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
+/**
+ * Cross-chain implementation of {@link ILiquidationsService}.
+ *
+ * Aggregates liquidatable accounts over all chains configured in
+ * {@link MultichainSDK} (optionally restricted via
+ * {@link GetLiquidatableAccountsProps.networks}). A failed chain is logged as
+ * a warning and skipped, so one dead RPC does not empty the whole list.
+ **/
+export declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> implements ILiquidationsService {
+    #private;
+    constructor(sdk: MultichainSDK<Plugins>);
+    /**
+     * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+     **/
+    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps): Promise<LiquidatableAccount[]>;
+    /**
+     * {@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

@@ -0,0 +1,46 @@
+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`).
+ **/
+export declare const DUST_THRESHOLD = 10n;
+/**
+ * Estimated amount (in underlying) the liquidator pays to fully liquidate an
+ * account: the part of total value used to repay debt and protocol fees.
+ *
+ * @param totalValue - Account total value in underlying
+ * @param liquidationDiscount - Liquidation discount in bps (`100% - liquidation premium`)
+ **/
+export declare function calcRepaymentAmount(totalValue: bigint, liquidationDiscount: number): bigint;
+/**
+ * Estimated liquidator profit (in underlying): the liquidation premium part
+ * of total value.
+ *
+ * @param totalValue - Account total value in underlying
+ * @param liquidationDiscount - Liquidation discount in bps (`100% - liquidation premium`)
+ **/
+export declare function calcEstimatedProfit(totalValue: bigint, liquidationDiscount: number): bigint;
+/**
+ * Picks the main asset being liquidated: the most valuable enabled
+ * non-underlying collateral token above dust (by oracle value in underlying).
+ * Returns `undefined` when the account has no eligible non-underlying
+ * collateral above dust.
+ *
+ * @param ca - Credit account data
+ * @param convert - Converts a token balance into its value in underlying;
+ * 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/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./helpers.js";
+export * from "./LiquidationsService.js";
+export * from "./MultichainLiquidationsService.js";
+export * from "./types.js";