@gearbox-protocol/sdk 16.3.2 → 16.4.0-next.2

package/dist/types/onchain/validation/checks/checkReservePriceLimited.d.ts

@@ -0,0 +1,31 @@
+import { Bps, TokenAmount } from "../../../model/primitives.js";
+import { ReservePriceLimitedError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkReservePriceLimited.d.ts
+interface ReservePriceLimitedArgs {
+  /** The safe-price factor, the one the collateral check compared. */
+  healthFactor: Bps;
+  /** The same account at the main feed. */
+  atMainPrices: Bps;
+  /** The lowest acceptable factor — a factor equal to it passes. */
+  healthFactorThreshold: Bps;
+  /** What the account can still take out, in the market's underlying. */
+  withdrawable: TokenAmount;
+}
+/**
+ * Whether a failed collateral check is the reserve price feed's doing.
+ *
+ * A call that hands funds over is weighed at safe prices — `min` of a token's
+ * two feeds, and nothing at all where governance registered no reserve feed —
+ * so an account that covers its debt at the main feed can still be refused.
+ * The two are worth telling apart: a position that is genuinely too small is
+ * fixed by adding collateral or requesting less, while this one is a valuation
+ * the account does not control, and requesting less only helps as far as
+ * `withdrawable` says it does.
+ *
+ * Runs after `checkCollateralised` and answers only when that one refused, so
+ * the caller keeps its own threshold rather than restating it here.
+ */
+declare function checkReservePriceLimited(args: ReservePriceLimitedArgs): ReservePriceLimitedError[];
+//#endregion
+export { ReservePriceLimitedArgs, checkReservePriceLimited };

package/dist/types/onchain/validation/checks/index.d.ts

@@ -13,4 +13,5 @@ import { PoolPausedArgs, checkPoolPaused } from "./checkPoolPaused.js";
 import { PoolSunsetArgs, checkPoolSunset } from "./checkPoolSunset.js";
 import { QuotaCountArgs, checkQuotaCount } from "./checkQuotaCount.js";
 import { QuotaLimitArgs, checkQuotaLimit } from "./checkQuotaLimit.js";
-export { BorrowLimitArgs, CollateralisedArgs, CreditAccountFrozenArgs, CreditManagerPausedArgs, DebtLimitsArgs, EmergencyLiquidatorArgs, ForbiddenTokenArgs, LeverageArgs, LiquidatorEligibleArgs, MarketExpiredArgs, PoolLiquidityArgs, PoolPausedArgs, PoolSunsetArgs, QuotaCountArgs, QuotaLimitArgs, checkBorrowLimit, checkCollateralised, checkCreditAccountFrozen, checkCreditManagerPaused, checkDebtLimits, checkEmergencyLiquidator, checkForbiddenToken, checkLeverage, checkLiquidatorEligible, checkMarketExpired, checkPoolLiquidity, checkPoolPaused, checkPoolSunset, checkQuotaCount, checkQuotaLimit };
+import { ReservePriceLimitedArgs, checkReservePriceLimited } from "./checkReservePriceLimited.js";
+export { BorrowLimitArgs, CollateralisedArgs, CreditAccountFrozenArgs, CreditManagerPausedArgs, DebtLimitsArgs, EmergencyLiquidatorArgs, ForbiddenTokenArgs, LeverageArgs, LiquidatorEligibleArgs, MarketExpiredArgs, PoolLiquidityArgs, PoolPausedArgs, PoolSunsetArgs, QuotaCountArgs, QuotaLimitArgs, ReservePriceLimitedArgs, checkBorrowLimit, checkCollateralised, checkCreditAccountFrozen, checkCreditManagerPaused, checkDebtLimits, checkEmergencyLiquidator, checkForbiddenToken, checkLeverage, checkLiquidatorEligible, checkMarketExpired, checkPoolLiquidity, checkPoolPaused, checkPoolSunset, checkQuotaCount, checkQuotaLimit, checkReservePriceLimited };

package/dist/types/onchain/validation/index.d.ts

@@ -35,9 +35,10 @@ import { PoolPausedArgs, checkPoolPaused } from "./checks/checkPoolPaused.js";
 import { PoolSunsetArgs, checkPoolSunset } from "./checks/checkPoolSunset.js";
 import { QuotaCountArgs, checkQuotaCount } from "./checks/checkQuotaCount.js";
 import { QuotaLimitArgs, checkQuotaLimit } from "./checks/checkQuotaLimit.js";
+import { ReservePriceLimitedArgs, checkReservePriceLimited } from "./checks/checkReservePriceLimited.js";
 import "./checks/index.js";
 import { amountOf } from "./helpers/amount.js";
 import { MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM } from "./helpers/health-factor-limits.js";
 import { toToken, toTokenAmount } from "./helpers/token.js";
 import "./helpers/index.js";
-export { BorrowLimitArgs, CheckCollateralFundingInput, CheckLiquidationEligibilityInput, CheckLiquidationFundingInput, CheckLiquidationInput, CheckLiquidationOptions, CheckOperationInput, CheckOperationOptions, CheckPoolFundingInput, CheckRWAOpenRequirementsInput, CheckRWAOpeningInput, CheckSimulationInput, CheckWalletAllowanceInput, CheckWalletBalanceInput, CheckWalletInput, CollateralFundingPreview, CollateralisedArgs, CreditAccountFrozenArgs, CreditManagerPausedArgs, CreditOperationArgs, CreditOperationError, CreditOperationPreview, CreditSimulationInput, DebtLimitsArgs, EmergencyLiquidatorArgs, ForbiddenTokenArgs, HealthFactorThresholds, type IntentValidationError, LeverageArgs, LiquidationEligibilityError, LiquidationValidationError, LiquidatorEligibleArgs, MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM, MarketExpiredArgs, MarketStateError, OperationValidationError, PoolLiquidityArgs, PoolOperationArgs, PoolOperationError, PoolPausedArgs, PoolSunsetArgs, QuotaCountArgs, QuotaLimitArgs, SimulationValidationError, WalletFundingError, WeighedFactors, amountOf, checkAccountQuotas, checkBorrowLimit, checkCollateralFunding, checkCollateralised, checkCreditAccountFrozen, checkCreditManagerPaused, checkCreditOperation, checkDebtLimits, checkEmergencyLiquidator, checkForbiddenToken, checkHealthFactors, checkIncreaseDebt, checkIncreaseQuota, checkLeverage, checkLiquidation, checkLiquidationEligibility, checkLiquidationFunding, checkLiquidatorEligible, checkMarket, checkMarketExpired, checkObtained, checkOperation, checkPoolFunding, checkPoolLiquidity, checkPoolOperation, checkPoolPaused, checkPoolSunset, checkQuotaCount, checkQuotaLimit, checkRWAOpenRequirements, checkRWAOpening, checkSimulation, checkWallet, checkWalletAllowance, checkWalletBalance, raise, toToken, toTokenAmount };
+export { BorrowLimitArgs, CheckCollateralFundingInput, CheckLiquidationEligibilityInput, CheckLiquidationFundingInput, CheckLiquidationInput, CheckLiquidationOptions, CheckOperationInput, CheckOperationOptions, CheckPoolFundingInput, CheckRWAOpenRequirementsInput, CheckRWAOpeningInput, CheckSimulationInput, CheckWalletAllowanceInput, CheckWalletBalanceInput, CheckWalletInput, CollateralFundingPreview, CollateralisedArgs, CreditAccountFrozenArgs, CreditManagerPausedArgs, CreditOperationArgs, CreditOperationError, CreditOperationPreview, CreditSimulationInput, DebtLimitsArgs, EmergencyLiquidatorArgs, ForbiddenTokenArgs, HealthFactorThresholds, type IntentValidationError, LeverageArgs, LiquidationEligibilityError, LiquidationValidationError, LiquidatorEligibleArgs, MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM, MarketExpiredArgs, MarketStateError, OperationValidationError, PoolLiquidityArgs, PoolOperationArgs, PoolOperationError, PoolPausedArgs, PoolSunsetArgs, QuotaCountArgs, QuotaLimitArgs, ReservePriceLimitedArgs, SimulationValidationError, WalletFundingError, WeighedFactors, amountOf, checkAccountQuotas, checkBorrowLimit, checkCollateralFunding, checkCollateralised, checkCreditAccountFrozen, checkCreditManagerPaused, checkCreditOperation, checkDebtLimits, checkEmergencyLiquidator, checkForbiddenToken, checkHealthFactors, checkIncreaseDebt, checkIncreaseQuota, checkLeverage, checkLiquidation, checkLiquidationEligibility, checkLiquidationFunding, checkLiquidatorEligible, checkMarket, checkMarketExpired, checkObtained, checkOperation, checkPoolFunding, checkPoolLiquidity, checkPoolOperation, checkPoolPaused, checkPoolSunset, checkQuotaCount, checkQuotaLimit, checkRWAOpenRequirements, checkRWAOpening, checkReservePriceLimited, checkSimulation, checkWallet, checkWalletAllowance, checkWalletBalance, raise, toToken, toTokenAmount };

package/dist/types/onchain/validation/raise.d.ts

@@ -1,4 +1,4 @@
-import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaLimitReachedError } from "../../model/errors/operation-errors.js";
+import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaLimitReachedError, ReservePriceLimitedError } from "../../model/errors/operation-errors.js";
 import { MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError } from "../../model/errors/prepare-errors.js";
 import "../../model/index.js";
 //#region src/onchain/validation/raise.d.ts
@@ -9,7 +9,7 @@ import "../../model/index.js";
  * Not a catch-all of every SDK error — pool paused/sunset is `checkOperation`'s,
  * a malformed transaction is `previewOperation`'s, not the engine's.
  **/
-type IntentValidationError = CreditManagerPausedError | MarketExpiredError | InsufficientPoolLiquidityError | DebtOutOfRangeError | LeverageOutOfRangeError | InsufficientCollateralError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientBalanceError | UnsupportedCollateralTokenError | UnsupportedTokenPairError | NoDelayedRouteError | MultipleDelayedWithdrawalsError | WithdrawalInProgressError | NoRecordedIntentError;
+type IntentValidationError = CreditManagerPausedError | MarketExpiredError | InsufficientPoolLiquidityError | DebtOutOfRangeError | LeverageOutOfRangeError | InsufficientCollateralError | ReservePriceLimitedError | ForbiddenTokenError | QuotaLimitReachedError | InsufficientBalanceError | UnsupportedCollateralTokenError | UnsupportedTokenPairError | NoDelayedRouteError | MultipleDelayedWithdrawalsError | WithdrawalInProgressError | NoRecordedIntentError;
 /**
  * Engine-internal throw: planners and guards raise one error object, and the
  * service boundary turns it into {@link SDKError}.

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

@@ -79,7 +79,7 @@ declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPr
   /**
    * {@inheritDoc IOpportunitiesPrepare.maxWithdraw}
    **/
-  maxWithdraw(position: PositionInput): Promise<WithdrawCeilings>;
+  maxWithdraw(position: PositionInput, sourceToken?: Address): Promise<WithdrawCeilings>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.repayStrategy}
    **/

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

@@ -1,6 +1,6 @@
 import { Bps, Timestamp, TokenAmount } from "../../model/primitives.js";
 import { Curator } from "../../model/curators.js";
-import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaLimitReachedError } from "../../model/errors/operation-errors.js";
+import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaLimitReachedError, 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";
@@ -22,7 +22,7 @@ import { Address } from "viem";
  * 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 | InsufficientBalanceError | CreditAccountNotFoundError | UnexpectedFailureError;
+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;
 /**
@@ -541,26 +541,33 @@ interface IOpportunitiesPrepare {
    **/
   withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<SDKReturn<StrategyRoutesResult, (AccountFlowError | DebtOutOfRangeError | UnsupportedTokenPairError | NoDelayedRouteError | MultipleDelayedWithdrawalsError | WithdrawalInProgressError) & WithRouteErrors>>;
   /**
-   * How much {@link withdrawStrategy} can take out, both ends of it, in
-   * underlying units: `partial` is the largest withdrawal that keeps leverage
-   * and leaves the debt at the credit manager's `minDebt`, `exit` is the net
-   * value leaving entirely hands over.
-   *
-   * Two numbers rather than one because the range has a hole in it: between
-   * them the flow refuses with `debtOutOfRange`, since the leftover loan would
-   * sit below the floor. A form driving a slider off `partial` and a Max
-   * button off `exit` describes what the account can actually do; a form using
-   * either alone will misstate one of them — see {@link WithdrawCeilings},
-   * which spells out how far apart they can be.
-   *
-   * Taking everything out needs neither figure: send `MAX_UINT256` to
+   * How much {@link withdrawStrategy} can take out, every end of it, in
+   * underlying units: `safePartial` is the largest partial withdrawal the flow
+   * accepts, `partial` the same figure before the safe-price collateral check
+   * has had its say, and `exit` the net value leaving entirely hands over.
+   *
+   * More than one number because the range has a hole in it: between the
+   * largest partial and `exit` the flow refuses with `debtOutOfRange`, since
+   * the leftover loan would sit below the floor. A form driving a slider off
+   * `safePartial` and a Max button off `exit` describes what the account can
+   * actually do; a form using either alone will misstate one of them — see
+   * {@link WithdrawCeilings}, which spells out how far apart they can be and
+   * why the two partial figures differ.
+   *
+   * `sourceToken` is the collateral the withdrawal would be funded from, the
+   * same argument {@link withdrawStrategy} takes. It matters because selling
+   * one collateral and selling another cost the safe-price check different
+   * amounts; omitted, both this and the flow itself reach for the account's
+   * largest non-phantom balance.
+   *
+   * Taking everything out needs none of the figures: send `MAX_UINT256` to
    * {@link withdrawStrategy} and the exit is what runs, named rather than
    * priced.
    *
    * A bare read: it answers its numbers, and throws on an account or a chain
    * the SDK does not hold.
    **/
-  maxWithdraw(position: PositionInput): Promise<WithdrawCeilings>;
+  maxWithdraw(position: PositionInput, sourceToken?: Address): Promise<WithdrawCeilings>;
   /**
    * Paying debt down with funds from the wallet: collateral stays where it is,
    * so net value grows by what was repaid, leverage falls and the health factor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "16.3.2",
+  "version": "16.4.0-next.2",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {