@gearbox-protocol/sdk 17.13.0-next.3 → 17.13.0-next.6

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

@@ -2,7 +2,7 @@ import { ChainId, TxCall } from "../../model/primitives.js";
 import { LiquidatableAccount, LiquidationDetails, LiquidationPosition } from "../../model/liquidations.js";
 import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
-import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps } from "../../onchain/accounts/liquidations/types.js";
+import { BuildLiquidationTxProps, BuildPartialLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, GetPartialLiquidationDetailsProps } from "../../onchain/accounts/liquidations/types.js";
 import { CheckLiquidationInput, CheckLiquidationOptions, LiquidationValidationError } from "../../onchain/validation/checkLiquidation.js";
 import "../../onchain/index.js";
 import { Address } from "viem";
@@ -11,7 +11,7 @@ import { Address } from "viem";
  * On-chain discovery of liquidatable credit accounts and delayed-withdrawal
  * positions a liquidator wallet holds.
  **/
-interface ILiquidations {
+export interface ILiquidations {
   /**
    * All liquidatable credit accounts: health factor below 1 plus accounts of
    * expired credit managers with outstanding debt. Optionally narrowed.
@@ -22,21 +22,37 @@ interface ILiquidations {
    * liquidator receives. Throws when the chain cannot answer.
    **/
   getLiquidationDetails(props: GetLiquidationDetailsProps<true>): Promise<DataResponse<LiquidationDetails>>;
+  /**
+   * Partial liquidation of one credit account, in the shape of a full one:
+   * what the liquidator pays, receives and must approve. A local estimate from
+   * the synced oracle state. Parameters left out are derived from current
+   * state. Throws for RWA markets and withdrawal phantom collateral.
+   **/
+  getPartialLiquidationDetails(props: GetPartialLiquidationDetailsProps<true>): Promise<DataResponse<LiquidationDetails>>;
   /**
    * Transaction that fully liquidates a credit account. The reported block is
    * the one the transaction was built against.
    **/
   buildLiquidationTx(props: BuildLiquidationTxProps<true>): Promise<DataResponse<TxCall>>;
+  /**
+   * Transaction that partially liquidates a credit account, sending the
+   * seized collateral to the liquidator. The reported block is the one the
+   * transaction was built against. Throws when the account cannot be
+   * partially liquidated.
+   **/
+  buildPartialLiquidationTx(props: BuildPartialLiquidationTxProps<true>): Promise<DataResponse<TxCall>>;
   /**
    * Delayed-withdrawal positions (redemption receipts) owned by a liquidator
    * wallet, optionally scoped to some of the SDK's chains.
    **/
   getLiquidationPositions(props: GetLiquidationPositionsProps<true>): Promise<DataResponse<LiquidationPosition[]>>;
   /**
-   * Whether `liquidator` may send a full liquidation of this account.
+   * Whether `liquidator` may send a full or partial liquidation of this
+   * account.
    *
-   * `details` must come from {@link ILiquidations.getLiquidationDetails} called
-   * with the same `liquidator`.
+   * `details` must come from {@link ILiquidations.getLiquidationDetails}
+   * called with the same `liquidator`, or from
+   * {@link ILiquidations.getPartialLiquidationDetails}.
    **/
   checkLiquidation(props: CheckLiquidationInput, options?: CheckLiquidationOptions): Promise<LiquidationValidationError[]>;
   /**
@@ -44,7 +60,7 @@ interface ILiquidations {
    **/
   isEmergencyLiquidator(props: IsEmergencyLiquidatorProps): boolean;
 }
-interface IsEmergencyLiquidatorProps {
+export interface IsEmergencyLiquidatorProps {
   chainId: ChainId;
   creditManager: Address;
   liquidator: Address;
@@ -53,10 +69,9 @@ interface IsEmergencyLiquidatorProps {
  * `sdk.liquidations` per mode: an on-chain read, absent when the SDK reads no
  * chain.
  **/
-interface ILiquidationsByMode {
+export interface ILiquidationsByMode {
   onchain: ILiquidations;
   offchain: undefined;
   both: ILiquidations;
 }
-//#endregion
-export { ILiquidations, ILiquidationsByMode, IsEmergencyLiquidatorProps };
+//#endregion

package/dist/types/sdk/opportunities/OpportunitiesNamespace.d.ts

@@ -21,7 +21,7 @@ import { Address } from "viem";
  * The `opportunities` namespace of a {@link GearboxSDK}, see
  * {@link IOpportunitiesByMode} for what each mode offers.
  **/
-declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["opportunities"], GearboxAPI["opportunities"]> implements IOpportunitiesBase, IOpportunitiesOffchainOnly, IOpportunitiesOnchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOffchainBranch {
+export declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["opportunities"], GearboxAPI["opportunities"]> implements IOpportunitiesBase, IOpportunitiesOffchainOnly, IOpportunitiesOnchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOffchainBranch {
   #private;
   /**
    * {@inheritDoc IOpportunitiesBase.merge}
@@ -66,5 +66,4 @@ declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["op
   charts<const Metrics extends readonly PoolOpportunityChartMetric[]>(key: PoolOpportunityRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
   charts<const Metrics extends readonly StrategyOpportunityChartMetric[]>(key: StrategyOpportunityRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
 }
-//#endregion
-export { OpportunitiesNamespace };
+//#endregion

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

@@ -18,7 +18,7 @@ import { Address } from "viem";
 /**
  * What the `opportunities` namespace offers in every mode.
  **/
-interface IOpportunitiesBase {
+export interface IOpportunitiesBase {
   /**
    * All pool and strategy opportunities, optionally narrowed. In `both` mode
    * each chain is served by whichever source is fresh enough, see
@@ -50,7 +50,7 @@ interface IOpportunitiesBase {
 /**
  * Reads only a backend can answer.
  **/
-interface IOpportunitiesOffchainOnly {
+export interface IOpportunitiesOffchainOnly {
   /**
    * Protocol-wide totals across every opportunity: the TVL, total borrowed and
    * total supplied the landing page shows.
@@ -73,7 +73,7 @@ interface IOpportunitiesOffchainOnly {
 /**
  * Reads only the chain can answer.
  **/
-interface IOpportunitiesOnchainOnly {
+export interface IOpportunitiesOnchainOnly {
   /**
    * What a deposit, withdrawal or leverage change would do, and the calldata
    * that does it.
@@ -99,21 +99,21 @@ interface IOpportunitiesOnchainOnly {
  * The chain on its own, for a consumer that shows each source as it arrives.
  * Absent in `offchain` mode.
  **/
-interface IOpportunitiesOnchainBranch {
+export interface IOpportunitiesOnchainBranch {
   readonly onchain: IMultichainOpportunitiesService;
 }
 /**
  * The backend on its own, see {@link IOpportunitiesOnchainBranch}. Absent in
  * `onchain` mode.
  **/
-interface IOpportunitiesOffchainBranch {
+export interface IOpportunitiesOffchainBranch {
   readonly offchain: IOffchainOpportunities;
 }
 /**
  * Merge policy of each read, exposed so that a consumer reading the two
  * branches itself combines them exactly as `both` mode would.
  **/
-interface IOpportunityMergers {
+export interface IOpportunityMergers {
   list: ListMerger<Opportunity[]>;
   pool: EntityMerger<PoolOpportunityDetail>;
   /**
@@ -125,7 +125,7 @@ interface IOpportunityMergers {
 /**
  * Which methods the `opportunities` namespace has in each mode.
  **/
-interface IOpportunitiesByMode {
+export interface IOpportunitiesByMode {
   onchain: IOpportunitiesBase & IOpportunitiesOnchainOnly & IOpportunitiesOnchainBranch;
   offchain: IOpportunitiesBase & IOpportunitiesOffchainOnly & IOpportunitiesOffchainBranch;
   both: IOpportunitiesBase & IOpportunitiesOnchainOnly & IOpportunitiesOffchainOnly & IOpportunitiesOnchainBranch & IOpportunitiesOffchainBranch;
@@ -133,6 +133,5 @@ interface IOpportunitiesByMode {
 /**
  * The `opportunities` namespace of a {@link GearboxSDK} in mode `M`.
  **/
-type IOpportunities<M extends Mode = Mode> = IOpportunitiesByMode[M];
-//#endregion
-export { IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers };
+export type IOpportunities<M extends Mode = Mode> = IOpportunitiesByMode[M];
+//#endregion

package/dist/types/sdk/positions/PositionsNamespace.d.ts

@@ -19,7 +19,7 @@ import { Address } from "viem";
  * The `positions` namespace of a {@link GearboxSDK}, see
  * {@link IPositionsByMode} for what each mode offers.
  **/
-declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements IPositionsBase, IPositionsOffchainOnly, IPositionsOnchainOnly, IPositionsOnchainBranch, IPositionsOffchainBranch {
+export declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements IPositionsBase, IPositionsOffchainOnly, IPositionsOnchainOnly, IPositionsOnchainBranch, IPositionsOffchainBranch {
   /**
    * {@inheritDoc IPositionsBase.merge}
    **/
@@ -51,5 +51,4 @@ declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positi
    **/
   getCurrentWithdrawals(props: GetCurrentWithdrawalsProps<true>): Promise<DataResponse<PositionWithdrawals>>;
 }
-//#endregion
-export { PositionsNamespace };
+//#endregion

package/dist/types/sdk/positions/mergePositionList.d.ts

@@ -19,6 +19,5 @@ import { MergeListResult } from "../utils/types.js";
  * still preferred when it has the row. `name` is derived from that collateral,
  * so it follows the same override.
  **/
-declare function mergePositionList<Onchain extends DataResponse<Position[]> | undefined, Offchain extends DataResponse<Position[]> | undefined>(onchain: Onchain, offchain: Offchain, maxLagSeconds?: number): MergeListResult<Onchain, Offchain, Position[]>;
-//#endregion
-export { mergePositionList };
+export declare function mergePositionList<Onchain extends DataResponse<Position[]> | undefined, Offchain extends DataResponse<Position[]> | undefined>(onchain: Onchain, offchain: Offchain, maxLagSeconds?: number): MergeListResult<Onchain, Offchain, Position[]>;
+//#endregion

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

@@ -15,7 +15,7 @@ import { Address } from "viem";
 /**
  * What the `positions` namespace offers in every mode.
  **/
-interface IPositionsBase {
+export interface IPositionsBase {
   /**
    * Everything a wallet holds: its pool shares, its credit accounts and the
    * delayed withdrawals it took over by liquidating, optionally narrowed. In
@@ -38,7 +38,7 @@ interface IPositionsBase {
 /**
  * Reads only a backend can answer.
  **/
-interface IPositionsOffchainOnly {
+export interface IPositionsOffchainOnly {
   /**
    * Aggregate over everything a wallet holds: the list screen's badges, see
    * {@link PositionsTotals}.
@@ -70,7 +70,7 @@ interface IPositionsOffchainOnly {
 /**
  * Reads only the chain can answer.
  **/
-interface IPositionsOnchainOnly {
+export interface IPositionsOnchainOnly {
   /**
    * Delayed withdrawals of one credit account: claimable rows carry the
    * adapter call and recorded intent a claim is built from; pending rows
@@ -82,27 +82,27 @@ interface IPositionsOnchainOnly {
  * The chain on its own, for a consumer that shows each source as it arrives.
  * Absent in `offchain` mode.
  **/
-interface IPositionsOnchainBranch {
+export interface IPositionsOnchainBranch {
   readonly onchain: IMultichainPositionsService;
 }
 /**
  * The backend on its own, see {@link IPositionsOnchainBranch}. Absent in
  * `onchain` mode.
  **/
-interface IPositionsOffchainBranch {
+export interface IPositionsOffchainBranch {
   readonly offchain: IOffchainPositions;
 }
 /**
  * Merge policy of each read, exposed so that a consumer reading the two
  * branches itself combines them exactly as `both` mode would.
  **/
-interface IPositionMergers {
+export interface IPositionMergers {
   list: ListMerger<Position[]>;
 }
 /**
  * Which methods the `positions` namespace has in each mode.
  **/
-interface IPositionsByMode {
+export interface IPositionsByMode {
   onchain: IPositionsBase & IPositionsOnchainOnly & IPositionsOnchainBranch;
   offchain: IPositionsBase & IPositionsOffchainOnly & IPositionsOffchainBranch;
   both: IPositionsBase & IPositionsOnchainOnly & IPositionsOffchainOnly & IPositionsOnchainBranch & IPositionsOffchainBranch;
@@ -110,6 +110,5 @@ interface IPositionsByMode {
 /**
  * The `positions` namespace of a {@link GearboxSDK} in mode `M`.
  **/
-type IPositions<M extends Mode = Mode> = IPositionsByMode[M];
-//#endregion
-export { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly };
+export type IPositions<M extends Mode = Mode> = IPositionsByMode[M];
+//#endregion

package/dist/types/sdk/prepare/PrepareApi.d.ts

@@ -1,7 +1,7 @@
 import { Bps, ChainId } from "../../model/primitives.js";
 import { CreditManagerPausedError, DebtOutOfRangeError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaAboveMaxError, QuotaInactiveError, QuotaUnchangedError } from "../../model/errors/operation-errors.js";
 import { CreditAccountNotEmptyError, CreditAccountNotFoundError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError } from "../../model/errors/prepare-errors.js";
-import { PositionCollateral, StrategyPosition } from "../../model/positions.js";
+import { Position, PositionCollateral, StrategyPosition } from "../../model/positions.js";
 import { SDKReturn } from "../../model/result.js";
 import "../../model/index.js";
 import { Asset } from "../../onchain/base/types.js";
@@ -14,7 +14,7 @@ import { LeverageBand } from "../../onchain/accounts/intents/leverage-band.js";
 import { OpenStrategyState } from "../../onchain/accounts/intents/open-strategy.js";
 import { PoolOperationError } from "../../onchain/validation/bundles/checkPoolOperation.js";
 import "../../onchain/index.js";
-import { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, DepositStrategyParams, EmptyCreditAccountResult, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, OpenFlowError, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, UpdateQuotaParams, WithRouteErrors, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+import { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, DepositStrategyParams, EmptyCreditAccountResult, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, OpenFlowError, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, QuotaBufferState, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, UpdateQuotaParams, WithRouteErrors, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
 import { EnsureFreshChains } from "../types.js";
 import { Address } from "viem";
 //#region src/sdk/prepare/PrepareApi.d.ts
@@ -25,7 +25,7 @@ import { Address } from "viem";
  * loaded state and have nothing to await; the execute namespace resolves its
  * chain the same way.
  **/
-type ChainOf = (chainId: ChainId) => OnchainSDK;
+export type ChainOf = (chainId: ChainId) => OnchainSDK;
 /**
  * {@inheritDoc IOpportunitiesPrepare}
  *
@@ -47,7 +47,7 @@ type ChainOf = (chainId: ChainId) => OnchainSDK;
  * the bare `max*` reads throw on bugs and lifecycle errors instead, see
  * {@link IOpportunitiesPrepare}.
  **/
-declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPrepare {
+export declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPrepare {
   #private;
   constructor(sdk: MultichainSDK, ensureFresh?: EnsureFreshChains);
   /**
@@ -130,6 +130,9 @@ declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPr
    * {@inheritDoc IOpportunitiesPrepare.maxBorrow}
    **/
   maxBorrow(strategy: StrategyInput, params: MaxBorrowParams): bigint;
+  /** {@inheritDoc IOpportunitiesPrepare.getQuotaBufferState} */
+  getQuotaBufferState(position: Position, extraQuotas?: readonly (Pick<Asset, "token"> & {
+    quota: bigint;
+  })[]): QuotaBufferState | undefined;
 }
-//#endregion
-export { ChainOf, PrepareApi };
+//#endregion

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

@@ -4,6 +4,6 @@ import { ExecutionCost, OperationState, PathLossRate, RouteErrors, WithPartialSt
 import { BorrowState } from "../../onchain/accounts/intents/borrow.js";
 import { LeverageBand } from "../../onchain/accounts/intents/leverage-band.js";
 import { PoolOperationError } from "../../onchain/validation/bundles/checkPoolOperation.js";
-import { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, DelayedStrategyResult, DepositStrategyParams, EmptyCreditAccountResult, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, OpenFlowError, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, UpdateQuotaParams, WithRouteErrors, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+import { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, DelayedStrategyResult, DepositStrategyParams, EmptyCreditAccountResult, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, OpenFlowError, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, PrepareOptions, QuotaBufferState, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, UpdateQuotaParams, WithRouteErrors, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
 import { ChainOf, PrepareApi } from "./PrepareApi.js";
-export { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, type BorrowState, ChainOf, type CreditAccountNotEmptyError, type CreditAccountNotFoundError, DelayedStrategyResult, DepositStrategyParams, EmptyCreditAccountResult, type ExecutionCost, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, type LeverageBand, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, type MultipleDelayedWithdrawalsError, type NoDelayedRouteError, type NoRecordedIntentError, type NoStrategyTargetCollateralError, OpenFlowError, OpenStrategyParams, OpenStrategyResult, type OperationState, type PathLossRate, PoolInput, type PoolOperationError, PositionInput, PrepareApi, PrepareOptions, RepayStrategyParams, type RouteErrors, StrategyInput, StrategyResult, StrategyRoutesResult, type UnexpectedFailureError, type UnsupportedCollateralTokenError, type UnsupportedTokenPairError, UpdateQuotaParams, type WithPartialState, WithRouteErrors, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, type WithdrawalInProgressError, creditAccountNotEmpty, creditAccountNotFound, noStrategyTargetCollateral, unexpectedFailure };
+export { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, type BorrowState, ChainOf, type CreditAccountNotEmptyError, type CreditAccountNotFoundError, DelayedStrategyResult, DepositStrategyParams, EmptyCreditAccountResult, type ExecutionCost, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, type LeverageBand, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, type MultipleDelayedWithdrawalsError, type NoDelayedRouteError, type NoRecordedIntentError, type NoStrategyTargetCollateralError, OpenFlowError, OpenStrategyParams, OpenStrategyResult, type OperationState, type PathLossRate, PoolInput, type PoolOperationError, PositionInput, PrepareApi, PrepareOptions, QuotaBufferState, RepayStrategyParams, type RouteErrors, StrategyInput, StrategyResult, StrategyRoutesResult, type UnexpectedFailureError, type UnsupportedCollateralTokenError, type UnsupportedTokenPairError, UpdateQuotaParams, type WithPartialState, WithRouteErrors, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, type WithdrawalInProgressError, creditAccountNotEmpty, creditAccountNotFound, noStrategyTargetCollateral, unexpectedFailure };

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

@@ -3,7 +3,7 @@ import { Curator } from "../../model/curators.js";
 import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaAboveMaxError, QuotaInactiveError, QuotaLimitReachedError, QuotaUnchangedError, ReservePriceLimitedError } from "../../model/errors/operation-errors.js";
 import { CreditAccountNotEmptyError, CreditAccountNotFoundError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError } from "../../model/errors/prepare-errors.js";
 import { PoolOpportunityKey, StrategyOpportunityKey } from "../../model/opportunities.js";
-import { PositionCollateral, StrategyPosition, StrategyPositionKey } from "../../model/positions.js";
+import { Position, PositionCollateral, StrategyPosition, StrategyPositionKey } from "../../model/positions.js";
 import { SDKReturn } from "../../model/result.js";
 import { PositionClaimableWithdrawal } from "../../model/withdrawals.js";
 import "../../model/index.js";
@@ -19,7 +19,19 @@ import { PoolOperationError } from "../../onchain/validation/bundles/checkPoolOp
 import "../../onchain/index.js";
 import { Address } from "viem";
 //#region src/sdk/prepare/types.d.ts
-interface MaxWithdrawCollateralOptions {
+/** Recoverable target-token quota, computed from loaded market state. */
+export interface QuotaBufferState {
+  /** Validated strategy context, with a known target collateral. */
+  position: StrategyPosition & {
+    targetCollateral: NonNullable<StrategyPosition["targetCollateral"]>;
+  };
+  /** Target value times LT, before reserve and protocol-step rounding. */
+  baseQuota: bigint;
+  currentQuota: bigint;
+  /** Positive increase available under the pool and account limits. */
+  quotaIncrease: bigint;
+}
+export interface MaxWithdrawCollateralOptions {
   /** Main-price HF threshold, in basis points; defaults to 10101. */
   targetHF?: bigint;
   /** Safe-price HF threshold, in basis points; defaults to 10001. */
@@ -29,9 +41,9 @@ interface MaxWithdrawCollateralOptions {
  * What any operation on an existing account can answer with: the engine's
  * shared guards, the missing account, and a wrapped crash.
  **/
-type AccountFlowError = CreditManagerPausedError | MarketExpiredError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientCollateralError | ReservePriceLimitedError | InsufficientBalanceError | CreditAccountNotFoundError | UnexpectedFailureError;
+export type AccountFlowError = CreditManagerPausedError | MarketExpiredError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientCollateralError | ReservePriceLimitedError | InsufficientBalanceError | CreditAccountNotFoundError | UnexpectedFailureError;
 /** Same guards for the account-less open flow. */
-type OpenFlowError = CreditManagerPausedError | MarketExpiredError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientCollateralError | InsufficientBalanceError | UnexpectedFailureError;
+export type OpenFlowError = CreditManagerPausedError | MarketExpiredError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientCollateralError | InsufficientBalanceError | UnexpectedFailureError;
 /**
  * What every error of a two-route request carries on top of its own code,
  * see {@link StrategyRoutesResult}.
@@ -41,7 +53,7 @@ type OpenFlowError = CreditManagerPausedError | MarketExpiredError | ForbiddenTo
  * a caller can usually act on — or the delayed route's when the instant one
  * did not get far enough to have a reason of its own.
  **/
-interface WithRouteErrors {
+export interface WithRouteErrors {
   errors: RouteErrors;
 }
 /**
@@ -50,7 +62,7 @@ interface WithRouteErrors {
  * simulation cannot know — whose market this is, and how large the position
  * ends up.
  **/
-interface LpState extends PoolSimulation {
+export interface LpState extends PoolSimulation {
   /**
    * Curator of the market the pool belongs to, in the same shape
    * {@link PoolOpportunity} and {@link CreditOperationMarket} report it.
@@ -77,7 +89,7 @@ interface LpState extends PoolSimulation {
  * conversion applied to the amount, at the rate of the block the market was
  * loaded at.
  **/
-interface LpResult {
+export interface LpResult {
   /**
    * Always empty: a pool operation is a single transaction, so there is no
    * chain of steps to show. Present so callers can treat both kinds of
@@ -103,7 +115,7 @@ interface LpResult {
 /**
  * What an operation on an existing credit account comes to.
  **/
-interface StrategyResult {
+export interface StrategyResult {
   /**
    * The logical steps, each carrying the amounts it was computed from.
    * Useful for showing the user what will happen, and for pinning behaviour
@@ -129,7 +141,7 @@ interface StrategyResult {
  * What the tail of a delayed operation comes to: {@link StrategyResult}, plus
  * whether the claim it was built on settled the withdrawal whole.
  **/
-interface FinalizeResult extends StrategyResult {
+export interface FinalizeResult extends StrategyResult {
   /**
    * What the claim did not bring, when the venue settled part of the matured
    * withdrawal and left the rest of it queued — only a legacy Mellow multivault
@@ -152,7 +164,7 @@ interface FinalizeResult extends StrategyResult {
  * are meant to be compared on the same footing, so `state` is the end of the
  * operation in both, not the end of the transaction.
  **/
-interface DelayedStrategyResult {
+export interface DelayedStrategyResult {
   /**
    * {@inheritDoc StrategyResult.operations}
    **/
@@ -195,7 +207,7 @@ interface DelayedStrategyResult {
  * routes that exist; a failure means neither does, and the error still carries
  * `errors`, see {@link WithRouteErrors}.
  **/
-interface StrategyRoutesResult {
+export interface StrategyRoutesResult {
   /**
    * The router route: one transaction, settled on the spot. `undefined`
    * when the asset cannot be sold, see `errors.instant`.
@@ -223,7 +235,7 @@ interface StrategyRoutesResult {
  * The only result that reports both an expected and a floor branch: opening
  * takes both from a single pathfinder call, and `openCA` consumes both.
  **/
-interface OpenStrategyResult {
+export interface OpenStrategyResult {
   /**
    * Everything the opening arrives at: the projection, both branches of the
    * post-open balances and quotas, and the router path `openCA` is handed.
@@ -241,7 +253,7 @@ interface OpenStrategyResult {
  * there is no chain of steps to report — with the whole projection on the
  * state rather than two branches of balances, see {@link BorrowState}.
  **/
-interface BorrowResult {
+export interface BorrowResult {
   /**
    * Everything the loan arrives at: the collateral and the debt it backs, the
    * payout expected and its floor, the position metrics a screen shows beside
@@ -263,7 +275,7 @@ interface BorrowResult {
  * health factor to read. What the preparation is for is the refusal it can
  * answer with instead: a market that takes no multicall.
  **/
-interface EmptyCreditAccountResult {
+export interface EmptyCreditAccountResult {
   /** Block of the chain state this result was computed from. */
   blockNumber: number;
   /** Unix seconds of {@link blockNumber}. */
@@ -272,7 +284,7 @@ interface EmptyCreditAccountResult {
 /**
  * Shared knobs. Both default to the SDK's own defaults when omitted.
  **/
-interface PrepareOptions {
+export interface PrepareOptions {
   /** Router slippage in PERCENTAGE_FORMAT (100% = 10_000). */
   slippage?: number;
   /**
@@ -285,18 +297,18 @@ interface PrepareOptions {
  * Position to prepare against. A `StrategyPosition` from
  * `sdk.positions.list()` satisfies this, as does a bare key.
  **/
-type PositionInput = StrategyPositionKey;
+export type PositionInput = StrategyPositionKey;
 /**
  * Pool to prepare against. A `PoolOpportunity` from
  * `sdk.opportunities.list()` satisfies this, as does a bare key.
  **/
-type PoolInput = PoolOpportunityKey;
+export type PoolInput = PoolOpportunityKey;
 /**
  * Market to open a new position in. A `StrategyOpportunity` from
  * `sdk.opportunities.list()` satisfies this, as does a bare key.
  **/
-type StrategyInput = StrategyOpportunityKey;
-interface DepositStrategyParams extends PrepareOptions {
+export type StrategyInput = StrategyOpportunityKey;
+export interface DepositStrategyParams extends PrepareOptions {
   /**
    * Collateral to add: the market underlying, or its unwrapped asset on an RWA
    * market (USDC rather than dcUSDC).
@@ -316,7 +328,7 @@ interface DepositStrategyParams extends PrepareOptions {
    **/
   targetLeverage?: bigint;
 }
-interface WithdrawStrategyParams extends PrepareOptions {
+export interface WithdrawStrategyParams extends PrepareOptions {
   /**
    * Amount the wallet receives, denominated in `tokenOut`. `MAX_UINT256`, or
    * anything at or above the account's net value, turns the flow into an exit,
@@ -336,7 +348,7 @@ interface WithdrawStrategyParams extends PrepareOptions {
    **/
   sourceToken?: Address;
 }
-interface RepayStrategyParams extends PrepareOptions {
+export interface RepayStrategyParams extends PrepareOptions {
   /**
    * Funding token: the market underlying, which needs no conversion and is
    * repaid where it lands, or — on an RWA market — the unwrapped asset behind
@@ -354,7 +366,7 @@ interface RepayStrategyParams extends PrepareOptions {
   /** Native value to attach when paying a wrapped-native market in the coin. */
   value?: bigint;
 }
-interface AdjustLeverageParams extends PrepareOptions {
+export interface AdjustLeverageParams extends PrepareOptions {
   /**
    * Target total leverage scaled by `LEVERAGE_DECIMALS` (300n = 3x); 100n means
    * no debt.
@@ -366,21 +378,21 @@ interface AdjustLeverageParams extends PrepareOptions {
    **/
   token?: Address;
 }
-interface AddCollateralParams extends PrepareOptions {
+export interface AddCollateralParams extends PrepareOptions {
   /** Position token to deposit; nothing else is accepted. */
   token: Address;
   amount: bigint;
   /** Native value to attach when paying a wrapped-native market in the coin. */
   value?: bigint;
 }
-interface WithdrawCollateralParams extends PrepareOptions {
+export interface WithdrawCollateralParams extends PrepareOptions {
   /** Token to move out; must already sit on the account. */
   token: Address;
   amount: bigint;
   /** Wallet receiving the tokens. */
   to: Address;
 }
-interface UpdateQuotaParams extends PrepareOptions {
+export interface UpdateQuotaParams extends PrepareOptions {
   /** Collateral token on the account, other than the underlying. */
   token: Address;
   /**
@@ -389,7 +401,7 @@ interface UpdateQuotaParams extends PrepareOptions {
    **/
   quota?: bigint;
 }
-interface OpenStrategyParams extends PrepareOptions {
+export interface OpenStrategyParams extends PrepareOptions {
   /** Collateral coming from the wallet, in their own tokens. */
   collateral: Asset[];
   /**
@@ -413,7 +425,7 @@ interface OpenStrategyParams extends PrepareOptions {
    **/
   creditAccount?: Address;
 }
-interface BorrowParams extends PrepareOptions {
+export interface BorrowParams extends PrepareOptions {
   /**
    * Token the wallet puts up as collateral. Must be a collateral token of the
    * market, and cannot be {@link borrowToken} — the payout is swept off the
@@ -462,7 +474,7 @@ interface BorrowParams extends PrepareOptions {
  * What a borrow form knows before it knows the amount: everything
  * {@link BorrowParams} carries except the loan itself, which is the answer.
  **/
-interface MaxBorrowParams {
+export interface MaxBorrowParams {
   /** Token the wallet would put up, as in {@link BorrowParams}. */
   collateralToken: Address;
   /** Amount of {@link collateralToken} that would leave the wallet. */
@@ -481,7 +493,7 @@ interface MaxBorrowParams {
    **/
   quotaReserve?: number;
 }
-interface LpParams {
+export interface LpParams {
   /**
    * On deposit: amount of `tokenIn`. On withdraw: amount of `tokenOut`, which
    * the pool's `withdraw` takes as is and prices in shares itself.
@@ -509,7 +521,7 @@ interface LpParams {
  * treats `amount` as the pool shares to burn rather than the underlying to
  * receive.
  **/
-interface LpRedeemParams {
+export interface LpRedeemParams {
   /**
    * Amount of `tokenIn` — pool shares, or the zapper token that wraps them —
    * to redeem.
@@ -519,7 +531,7 @@ interface LpRedeemParams {
   tokenIn?: Address;
   tokenOut?: Address;
 }
-interface FinalizeParams extends PrepareOptions {
+export interface FinalizeParams extends PrepareOptions {
   /**
    * The matured withdrawal to claim, from
    * `sdk.positions.getCurrentWithdrawals()`.
@@ -565,7 +577,14 @@ interface FinalizeParams extends PrepareOptions {
  * {@link maxBorrow}) weigh state already loaded and say "nothing available"
  * with `undefined`, an empty list or `0n`.
  **/
-interface IOpportunitiesPrepare {
+export interface IOpportunitiesPrepare {
+  /** Synchronous quota-buffer state from loaded chain data. No freshness refresh
+   * or account RPC read. Ineligible positions return undefined; unexpected
+   * failures are thrown. extraQuotas includes reservations absent from the position.
+   */
+  getQuotaBufferState(position: Position, extraQuotas?: readonly (Pick<Asset, "token"> & {
+    quota: bigint;
+  })[]): QuotaBufferState | undefined;
   /**
    * Depositing into a pool: underlying in, shares out.
    *
@@ -859,4 +878,4 @@ interface IOpportunitiesPrepare {
   finalize(position: PositionInput, params: FinalizeParams): Promise<SDKReturn<FinalizeResult, (AccountFlowError | NoRecordedIntentError | NoDelayedRouteError | WithdrawalInProgressError | UnsupportedTokenPairError) & WithPartialState<OperationState>>>;
 }
 //#endregion
-export { AccountFlowError, AddCollateralParams, AdjustLeverageParams, BorrowParams, BorrowResult, type BorrowState, type CreditAccountNotEmptyError, type CreditAccountNotFoundError, DelayedStrategyResult, DepositStrategyParams, EmptyCreditAccountResult, type ExecutionCost, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, type LeverageBand, LpParams, LpRedeemParams, LpResult, LpState, MaxBorrowParams, MaxWithdrawCollateralOptions, type MultipleDelayedWithdrawalsError, type NoDelayedRouteError, type NoRecordedIntentError, type NoStrategyTargetCollateralError, OpenFlowError, OpenStrategyParams, OpenStrategyResult, type OperationState, type PathLossRate, PoolInput, type PoolOperationError, PositionInput, PrepareOptions, RepayStrategyParams, type RouteErrors, StrategyInput, StrategyResult, StrategyRoutesResult, type UnexpectedFailureError, type UnsupportedCollateralTokenError, type UnsupportedTokenPairError, UpdateQuotaParams, type WithPartialState, WithRouteErrors, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, type WithdrawalInProgressError };
+export type { BorrowState, CreditAccountNotEmptyError, CreditAccountNotFoundError, ExecutionCost, LeverageBand, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, OperationState, PathLossRate, PoolOperationError, RouteErrors, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithPartialState, WithdrawCeilings, WithdrawalInProgressError };

package/dist/types/sdk/prepare/withdrawable-collaterals.d.ts

@@ -6,6 +6,5 @@ import "../../onchain/index.js";
 /**
  * {@inheritDoc IOpportunitiesPrepare.withdrawableCollaterals}
  **/
-declare function withdrawableCollaterals(sdk: OnchainSDK, position: StrategyPosition): PositionCollateral[];
-//#endregion
-export { withdrawableCollaterals };
+export declare function withdrawableCollaterals(sdk: OnchainSDK, position: StrategyPosition): PositionCollateral[];
+//#endregion

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

@@ -13,7 +13,7 @@ import { NamespaceOptions } from "../types.js";
 /**
  * {@inheritDoc IPreview}
  **/
-declare class PreviewNamespace implements IPreview {
+export declare class PreviewNamespace implements IPreview {
   #private;
   constructor(onchain: MultichainSDK, options: NamespaceOptions);
   /**
@@ -29,5 +29,4 @@ declare class PreviewNamespace implements IPreview {
    **/
   checkSimulation(props: CheckSimulationInput, options?: HealthFactorThresholds): Promise<SimulationValidationError[]>;
 }
-//#endregion
-export { PreviewNamespace };
+//#endregion