@gearbox-protocol/sdk 16.1.2 → 16.3.0-next.1

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

@@ -0,0 +1,18 @@
+import { checkAccountQuotas } from "./checkAccountQuotas.js";
+import { CheckWalletInput, WalletFundingError, checkWallet } from "./checkWallet.js";
+import { CheckCollateralFundingInput, CollateralFundingPreview, checkCollateralFunding } from "./checkCollateralFunding.js";
+import { HealthFactorThresholds, WeighedFactors, checkHealthFactors } from "./checkHealthFactors.js";
+import { MarketStateError, checkMarket } from "./checkMarket.js";
+import { CreditOperationArgs, CreditOperationError, CreditOperationPreview, checkCreditOperation } from "./checkCreditOperation.js";
+import { checkDraw } from "./checkDraw.js";
+import { CheckLiquidationEligibilityInput, LiquidationEligibilityError, checkLiquidationEligibility } from "./checkLiquidationEligibility.js";
+import { CheckLiquidationFundingInput, checkLiquidationFunding } from "./checkLiquidationFunding.js";
+import { checkObtained } from "./checkObtained.js";
+import { CheckPoolFundingInput, checkPoolFunding } from "./checkPoolFunding.js";
+import { PoolOperationArgs, PoolOperationError, checkPoolOperation } from "./checkPoolOperation.js";
+import { checkQuotasAsked } from "./checkQuotasAsked.js";
+import { CheckRWAOpeningInput, checkRWAOpening } from "./checkRWAOpening.js";
+import { CheckRWAOpenRequirementsInput, checkRWAOpenRequirements } from "./checkRWAOpenRequirements.js";
+import { CheckWalletAllowanceInput, checkWalletAllowance } from "./checkWalletAllowance.js";
+import { CheckWalletBalanceInput, checkWalletBalance } from "./checkWalletBalance.js";
+export { CheckCollateralFundingInput, CheckLiquidationEligibilityInput, CheckLiquidationFundingInput, CheckPoolFundingInput, CheckRWAOpenRequirementsInput, CheckRWAOpeningInput, CheckWalletAllowanceInput, CheckWalletBalanceInput, CheckWalletInput, CollateralFundingPreview, CreditOperationArgs, CreditOperationError, CreditOperationPreview, HealthFactorThresholds, LiquidationEligibilityError, MarketStateError, PoolOperationArgs, PoolOperationError, WalletFundingError, WeighedFactors, checkAccountQuotas, checkCollateralFunding, checkCreditOperation, checkDraw, checkHealthFactors, checkLiquidationEligibility, checkLiquidationFunding, checkMarket, checkObtained, checkPoolFunding, checkPoolOperation, checkQuotasAsked, checkRWAOpenRequirements, checkRWAOpening, checkWallet, checkWalletAllowance, checkWalletBalance };

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

@@ -0,0 +1,23 @@
+import { LiquidationDetails } from "../../model/liquidations.js";
+import "../../model/index.js";
+import { OnchainSDK } from "../OnchainSDK.js";
+import { WalletFundingError } from "./bundles/checkWallet.js";
+import { LiquidationEligibilityError } from "./bundles/checkLiquidationEligibility.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checkLiquidation.d.ts
+interface CheckLiquidationInput {
+  details: LiquidationDetails;
+  liquidator: Address;
+}
+interface CheckLiquidationOptions {
+  /** Block to read at; defaults to latest. Only set for testnet forks. */
+  blockNumber?: bigint;
+}
+/** {@inheritDoc checkLiquidation} */
+type LiquidationValidationError = LiquidationEligibilityError | WalletFundingError;
+/**
+ * Whether `liquidator` may send a full liquidation of this account
+ */
+declare function checkLiquidation(sdk: OnchainSDK, input: CheckLiquidationInput, options?: CheckLiquidationOptions): Promise<LiquidationValidationError[]>;
+//#endregion
+export { CheckLiquidationInput, CheckLiquidationOptions, LiquidationValidationError, checkLiquidation };

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

@@ -0,0 +1,32 @@
+import { OperationPreview } from "../../model/previews.js";
+import "../../model/index.js";
+import { OnchainSDK } from "../OnchainSDK.js";
+import { WalletFundingError } from "./bundles/checkWallet.js";
+import { HealthFactorThresholds } from "./bundles/checkHealthFactors.js";
+import { CreditOperationError } from "./bundles/checkCreditOperation.js";
+import { PoolOperationError } from "./bundles/checkPoolOperation.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checkOperation.d.ts
+interface CheckOperationOptions extends HealthFactorThresholds {
+  /** Block to read at; defaults to latest. Only set for testnet forks. */
+  blockNumber?: bigint;
+}
+interface CheckOperationInput {
+  sdk: OnchainSDK;
+  preview: OperationPreview;
+  /** The wallet that signs. Its allowances, balances and RWA standing are read on-chain. */
+  sender: Address;
+}
+/** {@inheritDoc checkOperation} */
+type OperationValidationError = CreditOperationError | PoolOperationError | WalletFundingError;
+/**
+ * Whether a parsed operation may be signed by `sender`: protocol state first,
+ * then what the wallet has to approve, hold or sign.
+ *
+ * The array is in check order, most fundamental first, so a caller with room
+ * for one verdict reports the first entry. Approve and sign errors are picked
+ * out by `code`, not by position.
+ */
+declare function checkOperation(input: CheckOperationInput, options?: CheckOperationOptions): Promise<OperationValidationError[]>;
+//#endregion
+export { CheckOperationInput, CheckOperationOptions, OperationValidationError, checkOperation };

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

@@ -0,0 +1,56 @@
+import { ChainId } from "../../model/primitives.js";
+import { DebtOutOfRangeError, InsufficientCollateralError, QuotaCountExceededError } from "../../model/errors/operation-errors.js";
+import "../../model/index.js";
+import { PoolSimulation } from "../pools/types.js";
+import { OnchainSDK } from "../OnchainSDK.js";
+import { OperationState } from "../accounts/intents/types.js";
+import { HealthFactorThresholds } from "./bundles/checkHealthFactors.js";
+import { MarketStateError } from "./bundles/checkMarket.js";
+import { PoolOperationError } from "./bundles/checkPoolOperation.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checkSimulation.d.ts
+/** A simulated credit operation, as the intents engine reports one. */
+interface CreditSimulationInput {
+  chainId: ChainId;
+  state: OperationState;
+}
+/**
+ * A simulated pool operation. The pool comes alongside the state, which names
+ * the tokens moving through it but not the market they belong to.
+ */
+interface PoolSimulationInput {
+  chainId: ChainId;
+  pool: Address;
+  state: PoolSimulation;
+  /** Whether the operation puts liquidity in rather than taking it out. */
+  isDeposit: boolean;
+}
+type CheckSimulationInput = CreditSimulationInput | PoolSimulationInput;
+/** {@inheritDoc checkSimulation} */
+type SimulationValidationError = MarketStateError | DebtOutOfRangeError | QuotaCountExceededError | InsufficientCollateralError | PoolOperationError;
+/**
+ * Whether a simulated operation clears the caller's own thresholds.
+ *
+ * The engine holds an account to the facade's `1.0`, because its guards answer
+ * "would this revert". A form is wiser to ask for more, and the engine's own
+ * note says so — a caller wanting the stricter threshold applies it itself.
+ * This is that second opinion, over the numbers the engine already reported.
+ *
+ * Three of the checks on a credit account the engine does not make at all:
+ * both health-factor thresholds are its own `1.0`, and the quota count it never
+ * weighs. The other two run against the same numbers the engine used, and are
+ * here so that a change in the engine cannot pass silently.
+ *
+ * What is deliberately absent: the forbidden-token, quota-limit and funding
+ * checks all need the *delta* an operation applies, and `OperationState` reports
+ * only the state after it. Weighing them against absolutes would stop a
+ * forbidden token the account merely holds, or a quota the operation never
+ * touched. The engine performed all three during the walk, so a simulation that
+ * came back `ok` has already passed them.
+ *
+ * A pool operation has no account to weigh, so what is left is the pool's own
+ * state — which the engine does not read either.
+ */
+declare function checkSimulation(sdk: OnchainSDK, input: CheckSimulationInput, options?: HealthFactorThresholds): SimulationValidationError[];
+//#endregion
+export { CheckSimulationInput, CreditSimulationInput, PoolSimulationInput, SimulationValidationError, checkSimulation };

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

@@ -0,0 +1,21 @@
+import { Token } from "../../../model/primitives.js";
+import { BorrowLimitCause, InsufficientPoolLiquidityError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkBorrowLimit.d.ts
+interface BorrowLimitArgs {
+  requested: bigint;
+  available: bigint;
+  limit: BorrowLimitCause;
+  underlying: Token;
+  maxBorrowAmount?: bigint;
+}
+/**
+ * What the pool will hand over, against what is asked for.
+ *
+ * `available` and `limit` are the caller's reading of which limit is in the
+ * way; this check only compares. `maxBorrowAmount` is the largest debt still
+ * takeable, left out when none is.
+ */
+declare function checkBorrowLimit(args: BorrowLimitArgs): InsufficientPoolLiquidityError[];
+//#endregion
+export { BorrowLimitArgs, checkBorrowLimit };

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

@@ -0,0 +1,25 @@
+import { Bps } from "../../../model/primitives.js";
+import { InsufficientCollateralError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkCollateralised.d.ts
+interface CollateralisedArgs {
+  healthFactor: Bps | undefined;
+  /** The lowest acceptable factor — a factor equal to it passes. */
+  healthFactorThreshold: Bps;
+  safePrices: boolean;
+  /**
+   * The factor the account stands at now. Given, an operation that raises it
+   * passes even from under the required factor: an account already below is
+   * rescued by exactly the top-ups a flat threshold would refuse.
+   */
+  improvesFrom?: Bps;
+}
+/**
+ * The account against its debt, at whichever threshold the caller holds it to.
+ *
+ * An unread factor counts as failing: a check that cannot see the number is
+ * not evidence that the number is fine.
+ */
+declare function checkCollateralised(args: CollateralisedArgs): InsufficientCollateralError[];
+//#endregion
+export { CollateralisedArgs, checkCollateralised };

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

@@ -0,0 +1,12 @@
+import { CreditAccountFrozenError } from "../../../model/errors/liquidation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkCreditAccountFrozen.d.ts
+interface CreditAccountFrozenArgs {
+  frozen: boolean;
+  creditAccount: Address;
+}
+/** An RWA factory freeze stops the account's collateral from moving. */
+declare function checkCreditAccountFrozen(args: CreditAccountFrozenArgs): CreditAccountFrozenError[];
+//#endregion
+export { CreditAccountFrozenArgs, checkCreditAccountFrozen };

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

@@ -0,0 +1,12 @@
+import { CreditManagerPausedError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkCreditManagerPaused.d.ts
+interface CreditManagerPausedArgs {
+  isPaused: boolean;
+  creditManager: Address;
+}
+/** The credit manager takes no multicall while it is paused. */
+declare function checkCreditManagerPaused(args: CreditManagerPausedArgs): CreditManagerPausedError[];
+//#endregion
+export { CreditManagerPausedArgs, checkCreditManagerPaused };

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

@@ -0,0 +1,21 @@
+import { Token } from "../../../model/primitives.js";
+import { DebtOutOfRangeError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkDebtLimits.d.ts
+interface DebtLimitsArgs {
+  debt: bigint;
+  minDebt: bigint;
+  maxDebt: bigint;
+  underlying: Token;
+  /**
+   * Whether ending with no loan at all is acceptable. The one place the two
+   * callers genuinely disagree: an account being adjusted may end owing
+   * nothing, while one being opened may not — so the exemption is stated
+   * rather than assumed.
+   */
+  allowZero: boolean;
+}
+/** A debt the facade would revert on. */
+declare function checkDebtLimits(args: DebtLimitsArgs): DebtOutOfRangeError[];
+//#endregion
+export { DebtLimitsArgs, checkDebtLimits };

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

@@ -0,0 +1,17 @@
+import { NotEmergencyLiquidatorError } from "../../../model/errors/liquidation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkEmergencyLiquidator.d.ts
+interface EmergencyLiquidatorArgs {
+  paused: boolean;
+  isEmergencyLiquidator: boolean;
+  creditManager: Address;
+  liquidator: Address;
+}
+/**
+ * A paused market only accepts liquidations from its emergency liquidators.
+ * An unpaused market does not consult the list.
+ */
+declare function checkEmergencyLiquidator(args: EmergencyLiquidatorArgs): NotEmergencyLiquidatorError[];
+//#endregion
+export { EmergencyLiquidatorArgs, checkEmergencyLiquidator };

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

@@ -0,0 +1,12 @@
+import { Token } from "../../../model/primitives.js";
+import { ForbiddenTokenError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkForbiddenToken.d.ts
+interface ForbiddenTokenArgs {
+  token: Token;
+  isForbidden: boolean;
+}
+/** A token the market will not let the account hold more of. */
+declare function checkForbiddenToken(args: ForbiddenTokenArgs): ForbiddenTokenError[];
+//#endregion
+export { ForbiddenTokenArgs, checkForbiddenToken };

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

@@ -0,0 +1,12 @@
+import { LeverageOutOfRangeError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkLeverage.d.ts
+interface LeverageArgs {
+  /** Scaled by `LEVERAGE_DECIMALS` (`100n` = 1x), as the intent states it. */
+  leverage: bigint;
+  min: bigint;
+}
+/** Leverage below 1x is not a position, it is a withdrawal. */
+declare function checkLeverage(args: LeverageArgs): LeverageOutOfRangeError[];
+//#endregion
+export { LeverageArgs, checkLeverage };

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

@@ -0,0 +1,13 @@
+import { Token } from "../../../model/primitives.js";
+import { LiquidatorNotEligibleError } from "../../../model/errors/liquidation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkLiquidatorEligible.d.ts
+interface LiquidatorEligibleArgs {
+  eligible: boolean;
+  kycProtocol?: string;
+  kycToken?: Token;
+}
+/** The compressor's KYC check of this wallet against the liquidated assets. */
+declare function checkLiquidatorEligible(args: LiquidatorEligibleArgs): LiquidatorNotEligibleError[];
+//#endregion
+export { LiquidatorEligibleArgs, checkLiquidatorEligible };

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

@@ -0,0 +1,14 @@
+import { MarketExpiredError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkMarketExpired.d.ts
+interface MarketExpiredArgs {
+  isExpired: boolean;
+  creditManager: Address;
+  /** Unix seconds, as the facade reports it. */
+  expirationDate: number;
+}
+/** Past its expiration date the facade takes no more multicalls. */
+declare function checkMarketExpired(args: MarketExpiredArgs): MarketExpiredError[];
+//#endregion
+export { MarketExpiredArgs, checkMarketExpired };

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

@@ -0,0 +1,20 @@
+import { Token } from "../../../model/primitives.js";
+import { InsufficientPoolLiquidityError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkPoolLiquidity.d.ts
+interface PoolLiquidityArgs {
+  requested: bigint;
+  available: bigint;
+  underlying: Token;
+}
+/**
+ * What the pool holds, against what is being taken out of it.
+ *
+ * The operator is not `checkBorrowLimit`'s: a pool holding exactly the amount
+ * asked for still cannot serve it, so equality is already a refusal. That is
+ * the rule the legacy withdrawal validator enforced and it is preserved to the
+ * unit.
+ */
+declare function checkPoolLiquidity(args: PoolLiquidityArgs): InsufficientPoolLiquidityError[];
+//#endregion
+export { PoolLiquidityArgs, checkPoolLiquidity };

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

@@ -0,0 +1,12 @@
+import { PoolPausedError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkPoolPaused.d.ts
+interface PoolPausedArgs {
+  isPaused: boolean;
+  pool: Address;
+}
+/** A paused pool neither takes deposits nor serves withdrawals. */
+declare function checkPoolPaused(args: PoolPausedArgs): PoolPausedError[];
+//#endregion
+export { PoolPausedArgs, checkPoolPaused };

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

@@ -0,0 +1,13 @@
+import { PoolSunsetError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { Address } from "viem";
+//#region src/onchain/validation/checks/checkPoolSunset.d.ts
+interface PoolSunsetArgs {
+  isSunset: boolean;
+  isDeposit: boolean;
+  pool: Address;
+}
+/** A pool winding down still serves withdrawals, so only what puts money in is refused. */
+declare function checkPoolSunset(args: PoolSunsetArgs): PoolSunsetError[];
+//#endregion
+export { PoolSunsetArgs, checkPoolSunset };

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

@@ -0,0 +1,11 @@
+import { QuotaCountExceededError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkQuotaCount.d.ts
+interface QuotaCountArgs {
+  count: number;
+  max: number;
+}
+/** How many quoted tokens the facade enables at once. */
+declare function checkQuotaCount(args: QuotaCountArgs): QuotaCountExceededError[];
+//#endregion
+export { QuotaCountArgs, checkQuotaCount };

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

@@ -0,0 +1,18 @@
+import { Token } from "../../../model/primitives.js";
+import { QuotaLimitReachedError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/checks/checkQuotaLimit.d.ts
+interface QuotaLimitArgs {
+  token: Token;
+  /**
+   * Absent for a token the market opened no quota for at all — nothing is
+   * weighed against a limit, the token simply counts as no collateral.
+   */
+  requested: bigint | undefined;
+  available: bigint;
+  underlying: Token;
+}
+/** The room the keeper still has for a token's quota, in the underlying. */
+declare function checkQuotaLimit(args: QuotaLimitArgs): QuotaLimitReachedError[];
+//#endregion
+export { QuotaLimitArgs, checkQuotaLimit };

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

@@ -0,0 +1,16 @@
+import { BorrowLimitArgs, checkBorrowLimit } from "./checkBorrowLimit.js";
+import { CollateralisedArgs, checkCollateralised } from "./checkCollateralised.js";
+import { CreditAccountFrozenArgs, checkCreditAccountFrozen } from "./checkCreditAccountFrozen.js";
+import { CreditManagerPausedArgs, checkCreditManagerPaused } from "./checkCreditManagerPaused.js";
+import { DebtLimitsArgs, checkDebtLimits } from "./checkDebtLimits.js";
+import { EmergencyLiquidatorArgs, checkEmergencyLiquidator } from "./checkEmergencyLiquidator.js";
+import { ForbiddenTokenArgs, checkForbiddenToken } from "./checkForbiddenToken.js";
+import { LeverageArgs, checkLeverage } from "./checkLeverage.js";
+import { LiquidatorEligibleArgs, checkLiquidatorEligible } from "./checkLiquidatorEligible.js";
+import { MarketExpiredArgs, checkMarketExpired } from "./checkMarketExpired.js";
+import { PoolLiquidityArgs, checkPoolLiquidity } from "./checkPoolLiquidity.js";
+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 };

package/dist/types/onchain/validation/helpers/amount.d.ts

@@ -0,0 +1,7 @@
+import { Token, TokenAmount } from "../../../model/primitives.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/helpers/amount.d.ts
+/** A check names what a limit was measured in, never what it is worth. */
+declare function amountOf(token: Token, value: bigint): TokenAmount;
+//#endregion
+export { amountOf };

package/dist/types/onchain/validation/helpers/health-factor-limits.d.ts

@@ -0,0 +1,21 @@
+//#region src/onchain/validation/helpers/health-factor-limits.d.ts
+/**
+ * The health-factor thresholds this codebase holds an account to.
+ *
+ * They are deliberately different numbers for different jobs: the facade's is
+ * what a transaction must clear to land, a form's is what makes a position
+ * worth signing, and a sizing helper leaves a margin above both.
+ **/
+/** A factor at or below this is refused; kept for the callers that size on it. */
+declare const MIN_HF_LIMITED = 10100n;
+/** The same threshold as a `required` argument — the lowest factor that passes. */
+declare const MIN_HEALTH_FACTOR_FORM = 10101;
+/** The threshold the facade itself enforces: an account may end exactly at 1.0. */
+declare const MIN_HEALTH_FACTOR_FACADE = 10000;
+/**
+ * The safe-price threshold a form holds an account to. A step above the
+ * facade's, because a factor of exactly 1.0 at safe prices is already refused.
+ **/
+declare const MIN_SAFE_HEALTH_FACTOR_FORM = 10001;
+//#endregion
+export { MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM };

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

@@ -0,0 +1,4 @@
+import { amountOf } from "./amount.js";
+import { MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM } from "./health-factor-limits.js";
+import { toToken, toTokenAmount } from "./token.js";
+export { MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM, amountOf, toToken, toTokenAmount };

package/dist/types/onchain/validation/{token.d.ts → helpers/token.d.ts}

@@ -1,8 +1,8 @@
-import { Token, TokenAmount } from "../../model/primitives.js";
-import "../../model/index.js";
-import { OnchainSDK } from "../OnchainSDK.js";
+import { Token, TokenAmount } from "../../../model/primitives.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
 import { Address } from "viem";
-//#region src/onchain/validation/token.d.ts
+//#region src/onchain/validation/helpers/token.d.ts
 /**
  * The token behind an address, for the refusal details that inline one.
  *

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

@@ -1,4 +1,43 @@
-import { BorrowLimitBinding, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse } from "./refusal.js";
-import { MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM, amountOf, checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkDebtInBand, checkForbiddenToken, checkFunding, checkLeverageAtLeastOne, checkMarketExpired, checkPoolPaused, checkPoolPayout, checkPoolSunset, checkPreviewError, checkQuotaCount, checkQuotaLimit, isMalformedPreviewError } from "./checks.js";
-import { toToken, toTokenAmount } from "./token.js";
-export { type BorrowLimitBinding, MIN_HEALTH_FACTOR_FACADE, MIN_HEALTH_FACTOR_FORM, MIN_HF_LIMITED, MIN_SAFE_HEALTH_FACTOR_FORM, type PreviewErrorDetails, type PreviewErrorReason, type PreviewIssue, type PreviewRefusal, amountOf, checkBorrowLimit, checkCollateralised, checkCreditManagerPaused, checkDebtInBand, checkForbiddenToken, checkFunding, checkLeverageAtLeastOne, checkMarketExpired, checkPoolPaused, checkPoolPayout, checkPoolSunset, checkPreviewError, checkQuotaCount, checkQuotaLimit, isMalformedPreviewError, raise, refuse, toToken, toTokenAmount };
+import { IntentValidationError, raise } from "./raise.js";
+import { checkAccountQuotas } from "./bundles/checkAccountQuotas.js";
+import { CheckWalletInput, WalletFundingError, checkWallet } from "./bundles/checkWallet.js";
+import { CheckCollateralFundingInput, CollateralFundingPreview, checkCollateralFunding } from "./bundles/checkCollateralFunding.js";
+import { HealthFactorThresholds, WeighedFactors, checkHealthFactors } from "./bundles/checkHealthFactors.js";
+import { MarketStateError, checkMarket } from "./bundles/checkMarket.js";
+import { CreditOperationArgs, CreditOperationError, CreditOperationPreview, checkCreditOperation } from "./bundles/checkCreditOperation.js";
+import { checkDraw } from "./bundles/checkDraw.js";
+import { CheckLiquidationEligibilityInput, LiquidationEligibilityError, checkLiquidationEligibility } from "./bundles/checkLiquidationEligibility.js";
+import { CheckLiquidationFundingInput, checkLiquidationFunding } from "./bundles/checkLiquidationFunding.js";
+import { checkObtained } from "./bundles/checkObtained.js";
+import { CheckPoolFundingInput, checkPoolFunding } from "./bundles/checkPoolFunding.js";
+import { PoolOperationArgs, PoolOperationError, checkPoolOperation } from "./bundles/checkPoolOperation.js";
+import { checkQuotasAsked } from "./bundles/checkQuotasAsked.js";
+import { CheckRWAOpeningInput, checkRWAOpening } from "./bundles/checkRWAOpening.js";
+import { CheckRWAOpenRequirementsInput, checkRWAOpenRequirements } from "./bundles/checkRWAOpenRequirements.js";
+import { CheckWalletAllowanceInput, checkWalletAllowance } from "./bundles/checkWalletAllowance.js";
+import { CheckWalletBalanceInput, checkWalletBalance } from "./bundles/checkWalletBalance.js";
+import "./bundles/index.js";
+import { CheckLiquidationInput, CheckLiquidationOptions, LiquidationValidationError, checkLiquidation } from "./checkLiquidation.js";
+import { CheckOperationInput, CheckOperationOptions, OperationValidationError, checkOperation } from "./checkOperation.js";
+import { CheckSimulationInput, CreditSimulationInput, PoolSimulationInput, SimulationValidationError, checkSimulation } from "./checkSimulation.js";
+import { BorrowLimitArgs, checkBorrowLimit } from "./checks/checkBorrowLimit.js";
+import { CollateralisedArgs, checkCollateralised } from "./checks/checkCollateralised.js";
+import { CreditAccountFrozenArgs, checkCreditAccountFrozen } from "./checks/checkCreditAccountFrozen.js";
+import { CreditManagerPausedArgs, checkCreditManagerPaused } from "./checks/checkCreditManagerPaused.js";
+import { DebtLimitsArgs, checkDebtLimits } from "./checks/checkDebtLimits.js";
+import { EmergencyLiquidatorArgs, checkEmergencyLiquidator } from "./checks/checkEmergencyLiquidator.js";
+import { ForbiddenTokenArgs, checkForbiddenToken } from "./checks/checkForbiddenToken.js";
+import { LeverageArgs, checkLeverage } from "./checks/checkLeverage.js";
+import { LiquidatorEligibleArgs, checkLiquidatorEligible } from "./checks/checkLiquidatorEligible.js";
+import { MarketExpiredArgs, checkMarketExpired } from "./checks/checkMarketExpired.js";
+import { PoolLiquidityArgs, checkPoolLiquidity } from "./checks/checkPoolLiquidity.js";
+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 "./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, PoolSimulationInput, PoolSunsetArgs, QuotaCountArgs, QuotaLimitArgs, SimulationValidationError, WalletFundingError, WeighedFactors, amountOf, checkAccountQuotas, checkBorrowLimit, checkCollateralFunding, checkCollateralised, checkCreditAccountFrozen, checkCreditManagerPaused, checkCreditOperation, checkDebtLimits, checkDraw, checkEmergencyLiquidator, checkForbiddenToken, checkHealthFactors, checkLeverage, checkLiquidation, checkLiquidationEligibility, checkLiquidationFunding, checkLiquidatorEligible, checkMarket, checkMarketExpired, checkObtained, checkOperation, checkPoolFunding, checkPoolLiquidity, checkPoolOperation, checkPoolPaused, checkPoolSunset, checkQuotaCount, checkQuotaLimit, checkQuotasAsked, checkRWAOpenRequirements, checkRWAOpening, checkSimulation, checkWallet, checkWalletAllowance, checkWalletBalance, raise, toToken, toTokenAmount };

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

@@ -0,0 +1,33 @@
+import { CreditManagerPausedError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientBalanceError, InsufficientCollateralError, InsufficientPoolLiquidityError, LeverageOutOfRangeError, MarketExpiredError, QuotaLimitReachedError } 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
+/**
+ * What the intents engine can raise: unit-check errors it runs, plus the
+ * planning outcomes discovered mid-walk. Feeds prepare's per-method unions.
+ *
+ * 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;
+/**
+ * Engine-internal throw: planners and guards raise one error object, and the
+ * service boundary turns it into {@link SDKError}.
+ **/
+declare class IntentPreviewError extends Error {
+  readonly error: IntentValidationError;
+  constructor(error: IntentValidationError, message?: string);
+  /** The same wrap the checks hand out, with an optional engine-side sentence. */
+  static of(error: IntentValidationError, message?: string): IntentPreviewError;
+}
+/**
+ * Throws the first error a check found, with the sentence the engine logs for
+ * it. An empty array is a pass.
+ *
+ * Returns normally when there is nothing to raise, so it cannot narrow a type
+ * the way a bare `throw` does — a site that guards a value for the code below
+ * it keeps throwing directly.
+ **/
+declare function raise(errors: readonly IntentValidationError[], message: string): void;
+//#endregion
+export { IntentPreviewError, IntentValidationError, raise };

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

@@ -1,8 +1,8 @@
 import { ChainId } from "../../model/primitives.js";
+import { SecuritizeRegisterMessage } from "../../model/rwa.js";
 import { SDKResult } from "../../model/result.js";
 import "../../model/index.js";
 import { Asset } from "../../onchain/base/types.js";
-import { SecuritizeRegisterMessage } from "../../onchain/market/rwa/securitize/types.js";
 import { RawTx } from "../../onchain/types/transactions.js";
 import "../../onchain/index.js";
 import { LpResult, OpenStrategyResult, StrategyResult } from "../prepare/types.js";
@@ -72,7 +72,7 @@ type PrepareRequest = PoolPrepareRequest | OpenPrepareRequest | AccountPrepareRe
  * The write side of the opportunities namespace: turns what `prepare`
  * answered into the transaction to sign. Sending, and whatever the wallet has
  * to do first (allowances, permits, RWA signatures), stays with the caller —
- * `checkPrerequisites` reports the former on the built transaction.
+ * `checkOperation` reports the former on the built transaction's preview.
  **/
 interface IOpportunitiesExecute {
   /**

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

@@ -1,10 +1,9 @@
-import { BorrowLimitBinding, IntentPreviewError, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse } from "../onchain/validation/refusal.js";
+import { CreditAccountNotEmptyError, CreditAccountNotFoundError, EmptyOpenTakesNothingError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithdrawalInProgressError, creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, noStrategyTargetCollateral, unexpectedFailure } from "../model/errors/prepare-errors.js";
 import { LeverageBand } from "../onchain/accounts/intents/leverage-band.js";
-import { OperationState, PathLossRate, WithdrawCeilings } from "../onchain/accounts/intents/types.js";
+import { OperationState, PathLossRate, RouteErrors, WithdrawCeilings } from "../onchain/accounts/intents/types.js";
 import { IAnalytics, IAnalyticsByMode } from "./analytics/types.js";
 import { ILiquidations, ILiquidationsByMode } from "./liquidations/types.js";
-import { AccountFlowError, CreditAccountNotFoundError, DebtOutOfRangeError, ForbiddenTokenError, InsufficientCollateralError, InsufficientPoolLiquidityError, InsufficientSourceBalanceError, LeverageOutOfRangeError, MalformedTransactionError, MarketExpiredError, MarketPausedError, MultipleDelayedWithdrawalsError, NoDelayedRouteError, NoRecordedIntentError, NoStrategyTargetCollateralError, OpenFlowError, PoolSunsetError, QuotaCountExceededError, QuotaLimitReachedError, RefusalErrors, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithRouteRefusals, WithdrawalInProgressError, creditAccountNotFound, noStrategyTargetCollateral, toRefusalError, unexpectedFailure } from "./prepare/errors.js";
-import { AddCollateralParams, AdjustLeverageParams, DelayedStrategyResult, DepositStrategyParams, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
+import { AccountFlowError, AddCollateralParams, AdjustLeverageParams, DelayedStrategyResult, DepositStrategyParams, FinalizeParams, FinalizeResult, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpResult, LpState, OpenFlowError, OpenStrategyParams, OpenStrategyResult, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyResult, StrategyRoutesResult, WithRouteErrors, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
 import { ChainOf, PrepareApi } from "./prepare/PrepareApi.js";
 import "./prepare/index.js";
 import { AccountPrepareRequest, IOpportunitiesExecute, OpenPrepareRequest, PoolPrepareRequest, PrepareRequest } from "./execute/types.js";
@@ -16,7 +15,7 @@ import { DEFAULT_MAX_OFFCHAIN_LAG, mergeChainList, mergeChainOne } from "./utils
 import "./utils/index.js";
 import { IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers } from "./opportunities/types.js";
 import { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly } from "./positions/types.js";
-import { IPreview, IPreviewByMode } from "./preview/types.js";
+import { CheckOperationProps, IPreview, IPreviewByMode } from "./preview/types.js";
 import { EnsureFreshChains, GearboxSDKOptions, IGearboxSDK, INotices, INoticesByMode, Mode, NamespaceOptions, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, PlainMultichainSDKOptions } from "./types.js";
 import { AbstractNamespace, MergedQuery } from "./AbstractNamespace.js";
 import { AnalyticsNamespace } from "./analytics/AnalyticsNamespace.js";
@@ -38,4 +37,4 @@ import { SourceUnavailableError } from "./errors/SourceUnavailableError.js";
 import { assertSameChains } from "./errors/assertSameChains.js";
 import { everyChainFailed } from "./errors/everyChainFailed.js";
 import "./errors/index.js";
-export { AbstractNamespace, AccountFlowError, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, AnalyticsNamespace, BorrowLimitBinding, ChainOf, ChainRef, CreditAccountNotFoundError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DebtOutOfRangeError, DelayedStrategyResult, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, FinalizeResult, ForbiddenTokenError, GearboxSDK, GearboxSDKOptions, IAnalytics, IAnalyticsByMode, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, InsufficientCollateralError, InsufficientPoolLiquidityError, InsufficientSourceBalanceError, IntentPreviewError, type LeverageBand, LeverageOutOfRangeError, LiquidationsNamespace, type ListMerger, LpParams, LpRedeemParams, LpResult, LpState, MalformedTransactionError, MarketExpiredError, MarketPausedError, type MergeListResult, MergedQuery, MissingSourceError, Mode, MultipleDelayedWithdrawalsError, NamespaceOptions, NoDelayedRouteError, NoRecordedIntentError, NoSourceServedError, NoStrategyTargetCollateralError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenFlowError, OpenPrepareRequest, OpenStrategyParams, OpenStrategyResult, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PoolSunsetError, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewNamespace, PreviewRefusal, QuotaCountExceededError, QuotaLimitReachedError, RefusalErrors, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyResult, StrategyRoutesResult, UnexpectedFailureError, UnsupportedCollateralTokenError, UnsupportedTokenPairError, WithRouteRefusals, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, WithdrawalInProgressError, assertSameChains, creditAccountNotFound, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, noStrategyTargetCollateral, raise, refuse, toRefusalError, unexpectedFailure };
+export { AbstractNamespace, AccountFlowError, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, AnalyticsNamespace, ChainOf, ChainRef, CheckOperationProps, type CreditAccountNotEmptyError, type CreditAccountNotFoundError, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DelayedStrategyResult, DepositStrategyParams, type EmptyOpenTakesNothingError, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, FinalizeResult, GearboxSDK, GearboxSDKOptions, IAnalytics, IAnalyticsByMode, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, type LeverageBand, LiquidationsNamespace, type ListMerger, LpParams, LpRedeemParams, LpResult, LpState, type MergeListResult, MergedQuery, MissingSourceError, Mode, type MultipleDelayedWithdrawalsError, NamespaceOptions, type NoDelayedRouteError, type NoRecordedIntentError, NoSourceServedError, type NoStrategyTargetCollateralError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenFlowError, OpenPrepareRequest, OpenStrategyParams, OpenStrategyResult, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewNamespace, RepayStrategyParams, type RouteErrors, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyResult, StrategyRoutesResult, type UnexpectedFailureError, type UnsupportedCollateralTokenError, type UnsupportedTokenPairError, WithRouteErrors, type WithdrawCeilings, WithdrawCollateralParams, WithdrawStrategyParams, type WithdrawalInProgressError, assertSameChains, creditAccountNotEmpty, creditAccountNotFound, emptyOpenTakesNothing, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, noStrategyTargetCollateral, unexpectedFailure };