@gearbox-protocol/sdk 14.12.0-next.65 → 14.12.0-next.67

package/dist/types/new-sdk/types.d.ts

@@ -0,0 +1,149 @@
+import { ILogger } from "../sdk/types/logger.js";
+import { NetworkType } from "../sdk/chain/chains.js";
+import { MultichainNetworkMeta } from "../sdk/types/multichain.js";
+import { MultichainAttachOptions, MultichainSDK, MultichainSDKOptions } from "../sdk/MultichainSDK.js";
+import "../sdk/index.js";
+import { GearboxAPIOptions } from "../offchain/types.js";
+import { GearboxAPI } from "../offchain/GearboxAPI.js";
+import "../offchain/index.js";
+//#region src/new-sdk/types.d.ts
+/**
+ * Which sources a {@link GearboxSDK} reads from. Fixed at construction: a
+ * running instance never changes mode, and the mode decides which methods
+ * exist at all rather than what they return.
+ **/
+type Mode = "onchain" | "offchain" | "both";
+/**
+ * Outcome of the off-chain read behind a response.
+ **/
+interface OffchainSourceStatus {
+  /**
+   * Whether the backend served the request.
+   **/
+  status: "success" | "error";
+  /**
+   * Rejection reason. Only set when {@link status} is `"error"`.
+   **/
+  error?: unknown;
+}
+/**
+ * Which sources produced a response and which of them failed.
+ *
+ * Meta is always present, in every mode. A partial answer is the normal case
+ * for a multi-chain read, so a caller that ignores this block is choosing to
+ * treat "one chain is down" as "these opportunities do not exist".
+ **/
+interface SourceMeta {
+  /**
+   * Outcome per queried chain. Empty when the read touched no chain, either
+   * because the SDK is off-chain or because a filter selected no chain.
+   **/
+  chains: MultichainNetworkMeta[];
+  /**
+   * Outcome of the off-chain read, absent when the SDK has no backend source.
+   **/
+  offchain?: OffchainSourceStatus;
+}
+/**
+ * What every {@link GearboxSDK} read returns.
+ *
+ * @typeParam T - Payload type.
+ **/
+interface ReadResult<T> {
+  /**
+   * Requested payload, built from every source that answered.
+   **/
+  result: T;
+  /**
+   * Which sources produced it, see {@link SourceMeta}.
+   **/
+  meta: SourceMeta;
+}
+/**
+ * Thrown when a read had sources to ask and none of them answered.
+ *
+ * A read that partially succeeded never throws: it returns what it has and
+ * reports the rest in {@link SourceMeta}.
+ **/
+declare class AllSourcesFailedError extends Error {
+  /**
+   * Outcome of every source the failed read asked.
+   **/
+  readonly meta: SourceMeta;
+  constructor(action: string, meta: SourceMeta);
+}
+/**
+ * On-chain source of a {@link GearboxSDK}: either an already-attached SDK to
+ * reuse, or the options to build one with.
+ *
+ * An injected instance is never re-attached — its owner decides when it syncs.
+ **/
+type OnchainSource = MultichainSDK | PlainMultichainSDKOptions;
+/**
+ * {@link MultichainSDKOptions} without plugin typing.
+ *
+ * The facade exposes the on-chain SDK as a plain `MultichainSDK`; a consumer
+ * that injects a plugin-typed instance keeps its own typed reference to it.
+ **/
+type PlainMultichainSDKOptions = MultichainSDKOptions<{}>;
+/**
+ * Off-chain source of a {@link GearboxSDK}: either a client to reuse or the
+ * options to build one with.
+ **/
+type OffchainSource = GearboxAPI | GearboxAPIOptions;
+/**
+ * Options for creating a {@link GearboxSDK}.
+ *
+ * @typeParam M - Mode, which decides which sources are required.
+ **/
+interface GearboxSDKOptions<M extends Mode = Mode> {
+  /**
+   * Sources to read from, see {@link Mode}.
+   **/
+  mode: M;
+  /**
+   * Chains the SDK covers. This list is authoritative: when {@link onchain} is
+   * an already-attached instance covering a different set of chains, the
+   * mismatch is logged and this list still decides what is read.
+   **/
+  networks: NetworkType[];
+  /**
+   * On-chain source. Required in `onchain` and `both` mode.
+   **/
+  onchain?: OnchainSource;
+  /**
+   * Off-chain source. Required in `offchain` and `both` mode.
+   **/
+  offchain?: OffchainSource;
+  /**
+   * Options passed to {@link MultichainSDK.attach}, used only when the SDK
+   * builds the on-chain source itself.
+   **/
+  attach?: MultichainAttachOptions;
+  /**
+   * Logger for source selection and degradation diagnostics.
+   **/
+  logger?: ILogger;
+}
+/**
+ * On-chain escape hatch per mode: absent when the SDK reads no chain.
+ *
+ * @internal
+ **/
+interface OnchainByMode {
+  onchain: MultichainSDK;
+  offchain: undefined;
+  both: MultichainSDK;
+}
+/**
+ * Off-chain escape hatch per mode: absent when the SDK reads no backend.
+ *
+ * @internal
+ **/
+interface OffchainByMode {
+  onchain: undefined;
+  offchain: GearboxAPI;
+  both: GearboxAPI;
+}
+//#endregion
+export { AllSourcesFailedError, GearboxSDKOptions, Mode, OffchainByMode, OffchainSource, OffchainSourceStatus, OnchainByMode, OnchainSource, PlainMultichainSDKOptions, ReadResult, SourceMeta };

package/dist/types/new-sdk/utils/history.d.ts

@@ -0,0 +1,44 @@
+import { HistoryChartMetadata, HistoryMetric, HistoryPoint, HistoryRange } from "../../model/history.js";
+import "../../model/index.js";
+import { SourceMeta } from "../types.js";
+//#region src/new-sdk/utils/history.d.ts
+/**
+ * Everything that annotates a chart: what the backend said about the series,
+ * plus which sources produced it.
+ **/
+interface ChartMetadata extends HistoryChartMetadata {
+  /**
+   * Which sources answered, see {@link SourceMeta}. A chart is backend-only,
+   * so this reports the backend alone.
+   **/
+  source: SourceMeta;
+}
+/**
+ * One chart: the points to draw and everything that annotates them.
+ **/
+interface Chart {
+  /**
+   * Samples, oldest first.
+   **/
+  data: HistoryPoint[];
+  /**
+   * Annotations of the series, see {@link ChartMetadata}.
+   **/
+  metadata: ChartMetadata;
+}
+/**
+ * Reads the charts of one subject, one metric and one range at a time.
+ *
+ * @typeParam Metric - Metrics the subject has.
+ **/
+interface HistoryReader<Metric extends HistoryMetric> {
+  /**
+   * Historical chart of one metric over one window.
+   *
+   * A metric the subject does not have is a compile error rather than an empty
+   * chart.
+   **/
+  chart(metric: Metric, range: HistoryRange): Promise<Chart>;
+}
+//#endregion
+export { Chart, ChartMetadata, HistoryReader };

package/dist/types/new-sdk/utils/index.d.ts

@@ -0,0 +1,2 @@
+import { Chart, ChartMetadata, HistoryReader } from "./history.js";
+export { Chart, ChartMetadata, HistoryReader };

package/dist/types/offchain/GearboxAPI.d.ts

@@ -0,0 +1,31 @@
+import { GearboxAPIOptions } from "./types.js";
+import { OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
+import "./opportunities/index.js";
+//#region src/offchain/GearboxAPI.d.ts
+/**
+ * Client for the Gearbox backend, the off-chain source of the read model.
+ *
+ * It mirrors the namespace layout of the combined `GearboxSDK`, so the same
+ * call reads the same way against either source:
+ *
+ * ```ts
+ * const api = new GearboxAPI({ baseUrl: "https://api.gearbox.fi" });
+ * const { result } = await api.opportunities.list({ kind: "strategy" });
+ * ```
+ *
+ * The backend imports the read model from this package and its endpoints
+ * return those types directly, so there is no wire DTO layer here — only
+ * transport and schema validation.
+ *
+ * The transport is not implemented yet; see {@link OffchainOpportunities} for
+ * what each stubbed endpoint currently answers.
+ **/
+declare class GearboxAPI {
+  /**
+   * Namespace for pool and strategy opportunities.
+   **/
+  readonly opportunities: OffchainOpportunities;
+  constructor(options?: GearboxAPIOptions);
+}
+//#endregion
+export { GearboxAPI };

package/dist/types/offchain/index.d.ts

@@ -0,0 +1,5 @@
+import { GearboxAPIOptions, OffchainResult, OffchainSourceMeta } from "./types.js";
+import { OffchainNotImplementedError, OffchainOpportunities } from "./opportunities/OffchainOpportunities.js";
+import "./opportunities/index.js";
+import { GearboxAPI } from "./GearboxAPI.js";
+export { GearboxAPI, GearboxAPIOptions, OffchainNotImplementedError, OffchainOpportunities, OffchainResult, OffchainSourceMeta };

package/dist/types/offchain/opportunities/OffchainOpportunities.d.ts

@@ -0,0 +1,69 @@
+import { Opportunity, OpportunityFilter, PoolOpportunityDetail, PoolOpportunityKey, StrategyOpportunityDetail, StrategyOpportunityKey } from "../../model/opportunities.js";
+import { HistoryMetric, HistorySeries, OpportunityHistoryQuery } from "../../model/history.js";
+import { GearboxAPIOptions, OffchainResult } from "../types.js";
+//#region src/offchain/opportunities/OffchainOpportunities.d.ts
+/**
+ * Thrown by the endpoints that have no stub answer, so that a caller in
+ * `offchain` mode fails loudly instead of reading an empty detail page as a
+ * missing opportunity.
+ **/
+declare class OffchainNotImplementedError extends Error {
+  constructor(endpoint: string);
+}
+/**
+ * Backend counterpart of the `opportunities` namespace.
+ *
+ * This is a stub: the HTTP client is not written yet, so list reads answer with
+ * an empty list and detail reads throw. Every signature is already the final
+ * one, because the backend returns the read model types directly — there is no
+ * wire DTO and no mapper between the two.
+ *
+ * When the transport lands, each method will validate the response against the
+ * matching schema from `src/model` before returning it. A validation failure is
+ * a version-skew error and is handled exactly like a transport error: the
+ * combined SDK drops the backend's contribution in `both` mode and rethrows in
+ * `offchain` mode.
+ **/
+declare class OffchainOpportunities {
+  #private;
+  constructor(options?: GearboxAPIOptions);
+  /**
+   * Base URL the client will call once the transport is implemented.
+   **/
+  get baseUrl(): string | undefined;
+  /**
+   * All opportunities the backend knows about, optionally narrowed by
+   * {@link OpportunityFilter}.
+   *
+   * @returns An empty list until the backend client is implemented.
+   **/
+  list(filter?: OpportunityFilter): Promise<OffchainResult<Opportunity[]>>;
+  /**
+   * Detailed view of one pool opportunity.
+   *
+   * @throws {@link OffchainNotImplementedError} until the backend client is
+   * implemented.
+   **/
+  getPool(key: PoolOpportunityKey): Promise<OffchainResult<PoolOpportunityDetail>>;
+  /**
+   * Detailed view of one strategy opportunity.
+   *
+   * @throws {@link OffchainNotImplementedError} until the backend client is
+   * implemented.
+   **/
+  getStrategy(key: StrategyOpportunityKey): Promise<OffchainResult<StrategyOpportunityDetail>>;
+  /**
+   * One historical series of one opportunity. History exists only here:
+   * rebuilding it from the chain would mean an archive read per point.
+   *
+   * The requested metric types the response, so a caller asking for one metric
+   * does not have to narrow the union back down. When the transport lands,
+   * validation is what upholds it: a response carrying a different metric than
+   * the one asked for is a version-skew error like any other.
+   *
+   * @returns An empty series until the backend client is implemented.
+   **/
+  getHistory<M extends HistoryMetric>(query: OpportunityHistoryQuery<M>): Promise<OffchainResult<HistorySeries<M>>>;
+}
+//#endregion
+export { OffchainNotImplementedError, OffchainOpportunities };

package/dist/types/offchain/opportunities/index.d.ts

@@ -0,0 +1,2 @@
+import { OffchainNotImplementedError, OffchainOpportunities } from "./OffchainOpportunities.js";
+export { OffchainNotImplementedError, OffchainOpportunities };

package/dist/types/offchain/types.d.ts

@@ -0,0 +1,50 @@
+import { ILogger } from "../sdk/types/logger.js";
+//#region src/offchain/types.d.ts
+/**
+ * Outcome of the single request that serves a backend read. Unlike the
+ * on-chain source there is no per-chain breakdown here: one HTTP call covers
+ * every chain, so splitting it per chain would be fabricated.
+ **/
+interface OffchainSourceMeta {
+  /**
+   * Whether the backend served the request.
+   **/
+  status: "success" | "error";
+  /**
+   * Rejection reason. Only set when {@link status} is `"error"`.
+   **/
+  error?: unknown;
+}
+/**
+ * What every {@link GearboxAPI} read returns: the payload plus the outcome of
+ * the request that produced it, in the same shape the combined SDK exposes.
+ *
+ * @typeParam T - Payload type.
+ **/
+interface OffchainResult<T> {
+  /**
+   * Requested payload.
+   **/
+  result: T;
+  /**
+   * Outcome of the backend request.
+   **/
+  meta: OffchainSourceMeta;
+}
+/**
+ * Options for creating a {@link GearboxAPI} instance.
+ **/
+interface GearboxAPIOptions {
+  /**
+   * Base URL of the Gearbox backend, without a trailing slash.
+   *
+   * @example `"https://api.gearbox.fi"`
+   **/
+  baseUrl?: string;
+  /**
+   * Logger used for transport and validation diagnostics.
+   **/
+  logger?: ILogger;
+}
+//#endregion
+export { GearboxAPIOptions, OffchainResult, OffchainSourceMeta };

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

@@ -6,10 +6,12 @@ import { MultichainStateHuman } from "./types/state-human.js";
 import { PythOptions } from "./market/pricefeeds/updates/PythUpdater.js";
 import { RedstoneOptions } from "./market/pricefeeds/updates/RedstoneUpdater.js";
 import "./market/pricefeeds/updates/index.js";
+import { MultichainOpportunitiesService } from "./opportunities/MultichainOpportunitiesService.js";
+import "./opportunities/index.js";
 import { AttachOptions, ClientOptions, HydrateOptions, OnchainSDK } from "./OnchainSDK.js";
 import { MultichainState } from "./types/state.js";
 import "./types/index.js";
-import { ILiquidationsService } from "./accounts/liquidations/types.js";
+import { MultichainLiquidationsService } from "./accounts/liquidations/MultichainLiquidationsService.js";
 import "./accounts/index.js";
 //#region src/sdk/MultichainSDK.d.ts
 /**
@@ -115,7 +117,12 @@ declare class MultichainSDK<const Plugins extends PluginsMap = {}> {
    * Namespace for liquidatable credit accounts discovery across all
    * configured chains.
    */
-  readonly liquidations: ILiquidationsService<true>;
+  readonly liquidations: MultichainLiquidationsService<Plugins>;
+  /**
+   * Namespace for the pool and strategy opportunities of all configured
+   * chains.
+   */
+  readonly opportunities: MultichainOpportunitiesService<Plugins>;
   constructor(options: MultichainSDKOptions<Plugins>);
   /**
    * Attach all configured chains in parallel.
@@ -144,6 +151,12 @@ declare class MultichainSDK<const Plugins extends PluginsMap = {}> {
    * Read-only map of all configured chains.
    **/
   get chains(): ReadonlyMap<NetworkType, OnchainSDK<Plugins>>;
+  /**
+   * Shared logger, used for messages that are not attributable to a single
+   * chain. Per-chain messages should use the logger of the corresponding
+   * {@link OnchainSDK}.
+   **/
+  get logger(): ILogger | undefined;
   /**
    * Sync state for all chains in parallel.
    *

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

@@ -1,6 +1,6 @@
 import { ILogger } from "./types/logger.js";
-import { IRedemptionLoggerContract, IWithdrawalCompressorContract } from "./accounts/withdrawal-compressor/types.js";
 import { GearboxChain, NetworkType } from "./chain/chains.js";
+import { IRedemptionLoggerContract, IWithdrawalCompressorContract } from "./accounts/withdrawal-compressor/types.js";
 import { BaseState, IBaseContract } from "./base/types.js";
 import { VersionRange } from "./constants/versions.js";
 import "./constants/index.js";
@@ -18,6 +18,8 @@ import { PriceFeedRegister } from "./market/pricefeeds/PriceFeedsRegister.js";
 import "./market/pricefeeds/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import "./market/index.js";
+import { OpportunitiesService } from "./opportunities/OpportunitiesService.js";
+import "./opportunities/index.js";
 import { IPoolsService } from "./pools/types.js";
 import "./pools/index.js";
 import { ChainContractsRegister } from "./base/ChainContractsRegister.js";
@@ -26,7 +28,7 @@ import "./core/index.js";
 import { GearboxState } from "./types/state.js";
 import "./types/index.js";
 import "./base/index.js";
-import { ILiquidationsService } from "./accounts/liquidations/types.js";
+import { LiquidationsService } from "./accounts/liquidations/LiquidationsService.js";
 import "./accounts/index.js";
 import { Address, PublicClient, Transport } from "viem";
 import { HttpRpcClientOptions } from "viem/utils";
@@ -210,7 +212,11 @@ declare class OnchainSDK<const Plugins extends PluginsMap = {}> extends ChainCon
   /**
    * Namespace for liquidatable credit accounts discovery.
    */
-  readonly liquidations: ILiquidationsService;
+  readonly liquidations: LiquidationsService;
+  /**
+   * Namespace for the pool and strategy opportunities of this chain.
+   */
+  readonly opportunities: OpportunitiesService;
   /**
    * @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
    * @param clientOptions - Connection options (RPC URLs, transport, or client).

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

@@ -12,9 +12,9 @@ import { WithdrawalCompressorV313Contract } from "./withdrawal-compressor/Withdr
 import "./withdrawal-compressor/index.js";
 import { AccountToCheck, AddCollateralProps, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountFilter, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerFilter, CreditManagerOperationResult, DefaultPartialLiquidationParams, EncodableCreditAccountOperation, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsArgs, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
 import { CreditAccountServiceOptions, CreditAccountsServiceV310 } from "./CreditAccountsServiceV310.js";
-import { LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
-import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, DelayedReceivedAsset, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidatorWithdrawalsProps, GetLiquidatorWithdrawalsPropsBase, ILiquidationsService, InstantReceivedAsset, LiquidatableAccount, LiquidationApproval, LiquidationDetails, LiquidatorWithdrawal, LoadRWALiquidatorsProps, MultichainNetworkProps, MultichainNetworksProps, ReceivedAsset, WithMultichain } from "./liquidations/types.js";
+import { DUST_THRESHOLD, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./liquidations/constants.js";
+import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, RWALiquidatorInfo } from "./liquidations/types.js";
 import { LiquidationsService } from "./liquidations/LiquidationsService.js";
 import { MultichainLiquidationsService } from "./liquidations/MultichainLiquidationsService.js";
 import "./liquidations/index.js";
-export { AbstractWithdrawalCompressorContract, AccountToCheck, AddCollateralProps, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, BuildLiquidationTxProps, BuildLiquidationTxPropsBase, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, ClaimableWithdrawal, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountFilter, CreditAccountOperationResult, CreditAccountServiceOptions, CreditAccountTokensSlice, CreditAccountsServiceV310, CreditManagerFilter, CreditManagerOperationResult, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DefaultPartialLiquidationParams, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedIntentExtended, DelayedReceivedAsset, DelayedWithdrawCollateralIntent, EncodableCreditAccountOperation, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsArgs, GetCreditAccountsOptions, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidatorWithdrawalsProps, GetLiquidatorWithdrawalsPropsBase, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, GetWithdrawalRequestResultProps, ICreditAccountsService, ILiquidationsService, IRedemptionLoggerContract, IWithdrawalCompressorContract, InstantReceivedAsset, InvalidDelayedIntentError, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidatableAccount, LiquidationApproval, LiquidationDetails, LiquidationsService, LiquidatorWithdrawal, LoadRWALiquidatorsProps, MultichainLiquidationsService, MultichainNetworkProps, MultichainNetworksProps, OnchainRequestableWithdrawal, OpenCAProps, PartiallyLiquidateProps, PendingWithdrawal, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, ReceivedAsset, RedemptionLog, RedemptionLoggerV310Contract, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, RequestableWithdrawal, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithMultichain, WithdrawCollateralProps, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, AccountToCheck, AddCollateralProps, AssembleCaOperationsProps, AssembleClaimDelayedCallsProps, AssembleCloseCreditAccountCallsProps, AssembleRepayCreditAccountCallsProps, AssembleStartDelayedWithdrawalCallsProps, BuildLiquidationTxProps, BuildLiquidationTxPropsBase, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, ClaimableWithdrawal, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountFilter, CreditAccountOperationResult, CreditAccountServiceOptions, CreditAccountTokensSlice, CreditAccountsServiceV310, CreditManagerFilter, CreditManagerOperationResult, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DUST_THRESHOLD, DefaultPartialLiquidationParams, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedIntentExtended, DelayedWithdrawCollateralIntent, EncodableCreditAccountOperation, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsArgs, GetCreditAccountsOptions, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, GetWithdrawalRequestResultProps, ICreditAccountsService, IRedemptionLoggerContract, IWithdrawalCompressorContract, InvalidDelayedIntentError, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, LoadRWALiquidatorsProps, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, OnchainRequestableWithdrawal, OpenCAProps, PartiallyLiquidateProps, PendingWithdrawal, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, RWALiquidatorInfo, RedemptionLog, RedemptionLoggerV310Contract, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, RequestableWithdrawal, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

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

@@ -1,36 +1,44 @@
-import { RawTx } from "../../types/transactions.js";
-import "../../types/index.js";
+import { TxCall } from "../../../model/primitives.js";
+import { LiquidatableAccount, LiquidationDetails, LiquidationPosition } from "../../../model/liquidations.js";
+import "../../../model/index.js";
 import { SDKConstruct } from "../../base/SDKConstruct.js";
 import "../../base/index.js";
-import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
+import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps } from "./types.js";
 //#region src/sdk/accounts/liquidations/LiquidationsService.d.ts
 /**
- * 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.
+ * Service for discovering liquidatable credit accounts and previewing manual
+ * liquidations.
  **/
-declare class LiquidationsService extends SDKConstruct implements ILiquidationsService {
+declare class LiquidationsService extends SDKConstruct {
   #private;
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+   * Returns all liquidatable credit accounts: accounts with health factor
+   * below 1 plus accounts of expired credit managers with outstanding debt.
+   * Accounts whose collateral computation failed are excluded.
    **/
   getLiquidatableAccounts(props?: GetLiquidatableAccountsProps): Promise<LiquidatableAccount[]>;
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidationDetails}
+   * Returns detailed information about a liquidatable credit account,
+   * including the full list of assets the liquidator receives.
+   *
+   * @throws When the account is not found or its collateral computation fails.
    **/
   getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
   /**
-   * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+   * Builds the transaction that fully liquidates a credit account, repaying
+   * the debt from own funds and receiving the collateral from the credit account.
    **/
-  buildLiquidationTx(props: BuildLiquidationTxProps): Promise<RawTx>;
+  buildLiquidationTx(props: BuildLiquidationTxProps): Promise<TxCall>;
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   * Returns the status of delayed-withdrawal positions (redemption receipts)
+   * owned by a liquidator wallet: what is receivable, how much, and when it
+   * becomes claimable.
    **/
-  getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
+  getLiquidationPositions(props: GetLiquidationPositionsProps): Promise<LiquidationPosition[]>;
   /**
-   * {@inheritDoc ILiquidationsService.loadRWALiquidators}
+   * Discovers the dedicated RWA liquidator contracts (Securitize, Midas)
+   * deployed for the markets of the chain and registers them in the SDK
+   * contracts register.
    **/
   loadRWALiquidators(): Promise<void>;
 }

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

@@ -1,41 +1,47 @@
+import { TxCall } from "../../../model/primitives.js";
+import { MultichainResult } from "../../types/multichain.js";
 import { PluginsMap } from "../../plugins/types.js";
 import "../../plugins/index.js";
-import { RawTx } from "../../types/transactions.js";
+import { LiquidatableAccount, LiquidationDetails, LiquidationPosition } from "../../../model/liquidations.js";
+import "../../../model/index.js";
 import "../../types/index.js";
-import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal, LoadRWALiquidatorsProps } from "./types.js";
-import { MultichainSDK } from "../../MultichainSDK.js";
+import { MultichainConstruct } from "../../base/MultichainConstruct.js";
+import "../../base/index.js";
+import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, LoadRWALiquidatorsProps } from "./types.js";
 //#region src/sdk/accounts/liquidations/MultichainLiquidationsService.d.ts
 /**
- * Cross-chain implementation of {@link ILiquidationsService}.
+ * Cross-chain counterpart of {@link LiquidationsService}.
  *
- * Aggregates liquidatable accounts over all chains configured in
- * {@link MultichainSDK} (optionally restricted via
- * {@link MultichainNetworksProps.networks}). A failed chain is logged as
- * a warning and skipped, so one dead RPC does not empty the whole list.
+ * Fans out over all chains configured in {@link MultichainSDK} (optionally
+ * restricted via {@link MultichainNetworksProps.networks}). A failed chain is
+ * logged as a warning and skipped, so one dead RPC does not empty the whole
+ * list; its failure is reported in {@link MultichainResult.meta}. Networks that
+ * are not configured in the SDK are reported there the same way.
  **/
-declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> implements ILiquidationsService<true> {
-  #private;
-  constructor(sdk: MultichainSDK<Plugins>);
+declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> extends MultichainConstruct<Plugins> {
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
+   * Accounts of all queried chains, see
+   * {@link LiquidationsService.getLiquidatableAccounts}.
    **/
-  getLiquidatableAccounts(props?: GetLiquidatableAccountsProps<true>): Promise<LiquidatableAccount[]>;
+  getLiquidatableAccounts(props?: GetLiquidatableAccountsProps<true>): Promise<MultichainResult<LiquidatableAccount[]>>;
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidationDetails}
+   * {@inheritDoc LiquidationsService.getLiquidationDetails}
    **/
   getLiquidationDetails(props: GetLiquidationDetailsProps<true>): Promise<LiquidationDetails>;
   /**
-   * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+   * {@inheritDoc LiquidationsService.buildLiquidationTx}
    **/
-  buildLiquidationTx(props: BuildLiquidationTxProps<true>): Promise<RawTx>;
+  buildLiquidationTx(props: BuildLiquidationTxProps<true>): Promise<TxCall>;
   /**
-   * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
+   * Liquidation positions of all queried chains, see
+   * {@link LiquidationsService.getLiquidationPositions}.
    **/
-  getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps<true>): Promise<LiquidatorWithdrawal[]>;
+  getLiquidationPositions(props: GetLiquidationPositionsProps<true>): Promise<MultichainResult<LiquidationPosition[]>>;
   /**
-   * {@inheritDoc ILiquidationsService.loadRWALiquidators}
+   * Loads the liquidators of all queried chains, see
+   * {@link LiquidationsService.loadRWALiquidators}.
    **/
-  loadRWALiquidators(props?: LoadRWALiquidatorsProps<true>): Promise<void>;
+  loadRWALiquidators(props?: LoadRWALiquidatorsProps<true>): Promise<MultichainResult<void>>;
 }
 //#endregion
 export { MultichainLiquidationsService };

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

@@ -1,5 +1,16 @@
 import { Address } from "viem";
 //#region src/sdk/accounts/liquidations/constants.d.ts
 declare const LIQUIDATION_COMPRESSOR_V313_ADDRESS: Address;
+/**
+ * Token balances at or below this threshold are treated as dust and ignored,
+ * consistent with the rest of the SDK (see `filterDust`).
+ **/
+declare const DUST_THRESHOLD = 10n;
+/**
+ * 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.
+ **/
+declare const LIQUIDATION_APPROVAL_BUFFER = 50n;
 //#endregion
-export { LIQUIDATION_COMPRESSOR_V313_ADDRESS };
+export { DUST_THRESHOLD, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS };

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

@@ -1,5 +1,5 @@
-import { LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
-import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, DelayedReceivedAsset, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidatorWithdrawalsProps, GetLiquidatorWithdrawalsPropsBase, ILiquidationsService, InstantReceivedAsset, LiquidatableAccount, LiquidationApproval, LiquidationDetails, LiquidatorWithdrawal, LoadRWALiquidatorsProps, MultichainNetworkProps, MultichainNetworksProps, ReceivedAsset, WithMultichain } from "./types.js";
+import { DUST_THRESHOLD, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS } from "./constants.js";
+import { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LoadRWALiquidatorsProps, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, RWALiquidatorInfo } from "./types.js";
 import { LiquidationsService } from "./LiquidationsService.js";
 import { MultichainLiquidationsService } from "./MultichainLiquidationsService.js";
-export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, DelayedReceivedAsset, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidatorWithdrawalsProps, GetLiquidatorWithdrawalsPropsBase, ILiquidationsService, InstantReceivedAsset, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidatableAccount, LiquidationApproval, LiquidationDetails, LiquidationsService, LiquidatorWithdrawal, LoadRWALiquidatorsProps, MultichainLiquidationsService, MultichainNetworkProps, MultichainNetworksProps, ReceivedAsset, WithMultichain };
+export { BuildLiquidationTxProps, BuildLiquidationTxPropsBase, DUST_THRESHOLD, GetLiquidatableAccountsProps, GetLiquidatableAccountsPropsBase, GetLiquidationDetailsProps, GetLiquidationDetailsPropsBase, GetLiquidationPositionsProps, GetLiquidationPositionsPropsBase, LIQUIDATION_APPROVAL_BUFFER, LIQUIDATION_COMPRESSOR_V313_ADDRESS, LiquidationsService, LoadRWALiquidatorsProps, MultichainLiquidationsService, OnchainLiquidationCall, OnchainLiquidationData, OnchainLiquidationOutput, RWALiquidatorInfo };