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

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

@@ -0,0 +1,20 @@
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import { AdjustStrategyPositionPreview, PreviewOperationInput } from "../../../model/previews.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { MulticallOperation } from "../parse/types-facades.js";
+import { RWAMulticallOperation } from "../parse/types-rwa.js";
+import "../parse/index.js";
+import { ReplayMulticallResult } from "./replayMulticall.js";
+import "../../index.js";
+//#region src/onchain/preview/preview/previewAdjustStrategyPosition.d.ts
+/**
+ * Previews a `multicall`/`botMulticall` operation on an existing credit
+ * account: reports the replayed post-state alongside the changes relative
+ * to the pre-state.
+ */
+declare function previewAdjustStrategyPosition<P extends PluginsMap>(sdk: OnchainSDK<P>, input: PreviewOperationInput, operation: MulticallOperation | RWAMulticallOperation, replay: ReplayMulticallResult): SDKReturn<AdjustStrategyPositionPreview, MalformedTransactionError>;
+//#endregion
+export { previewAdjustStrategyPosition };

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

@@ -0,0 +1,21 @@
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import { ExitStrategyPositionPreview, PreviewOperationInput, RepayStrategyPositionPreview } from "../../../model/previews.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { CloseCreditAccountOperation, MulticallOperation } from "../parse/types-facades.js";
+import { RWAMulticallOperation } from "../parse/types-rwa.js";
+import "../parse/index.js";
+import { ReplayMulticallResult } from "./replayMulticall.js";
+import "../../index.js";
+//#region src/onchain/preview/preview/previewExitOrRepayStrategyPosition.d.ts
+/**
+ * Any parsed operation that fully closes or repays a credit account: the
+ * facade `closeCreditAccount` entry point (permanent closure) or a plain
+ * multicall detected by `isCloseOrRepay` (`decreaseDebt(MAX)`).
+ */
+type CloseOrRepayOperation = CloseCreditAccountOperation | MulticallOperation | RWAMulticallOperation;
+declare function previewExitOrRepayStrategyPosition<P extends PluginsMap>(sdk: OnchainSDK<P>, input: PreviewOperationInput, operation: CloseOrRepayOperation, permanent: boolean, replay: ReplayMulticallResult): SDKReturn<ExitStrategyPositionPreview | RepayStrategyPositionPreview, MalformedTransactionError>;
+//#endregion
+export { CloseOrRepayOperation, previewExitOrRepayStrategyPosition };

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

@@ -0,0 +1,14 @@
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import { OpenStrategyPositionPreview, PreviewOperationInput } from "../../../model/previews.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { OpenCreditAccountOperation } from "../parse/types-facades.js";
+import { RWAOpenCreditAccountOperation } from "../parse/types-rwa.js";
+import "../parse/index.js";
+import "../../index.js";
+//#region src/onchain/preview/preview/previewOpenStrategyPosition.d.ts
+declare function previewOpenStrategyPosition<P extends PluginsMap>(sdk: OnchainSDK<P>, input: PreviewOperationInput, operation: OpenCreditAccountOperation | RWAOpenCreditAccountOperation): SDKReturn<OpenStrategyPositionPreview, MalformedTransactionError>;
+//#endregion
+export { previewOpenStrategyPosition };

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

@@ -0,0 +1,32 @@
+import { CreditAccountNotFoundError } from "../../../model/errors/prepare-errors.js";
+import { InvalidDelayedIntentError, MalformedTransactionError, PoolOperationPreviewError, UnsupportedOperationError, UnsupportedPoolFunctionError, UnsupportedTargetError, UnsupportedZapperFunctionError } from "../../../model/errors/preview-errors.js";
+import { OperationPreview, PreviewOperationInput, PreviewOperationOptions } from "../../../model/previews.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { CreditAccountData } from "../../base/types.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import "../../index.js";
+//#region src/onchain/preview/preview/previewOperation.d.ts
+/**
+ * Everything {@link previewOperation} can refuse with: the refusal errors
+ * its pipeline raises, discriminated by `code`. Each is a plain object —
+ * never a thrown `Error` — per the SDK's refusal vocabulary.
+ */
+type PreviewOperationError = UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError | UnsupportedOperationError | InvalidDelayedIntentError | PoolOperationPreviewError | MalformedTransactionError | CreditAccountNotFoundError;
+/**
+ * Previews a raw operation calldata: decodes it into a typed operation and
+ * assembles an operation-specific, human-displayable preview.
+ *
+ * Answers an {@link SDKReturn} envelope: the preview behind `ok: true`, or —
+ * when the transaction is one the previewer refuses to read — a
+ * {@link PreviewOperationError} behind `ok: false`. A thrown exception
+ * still means the SDK could not do its job (a read failed), not a refusal
+ * of the transaction.
+ *
+ * `input.chainId` and `sdk` both name the chain; the engine does not read
+ * `input.chainId`.
+ */
+declare function previewOperation<P extends PluginsMap = PluginsMap>(sdk: OnchainSDK<P>, input: PreviewOperationInput, options?: PreviewOperationOptions, creditAccount?: CreditAccountData): Promise<SDKReturn<OperationPreview, PreviewOperationError>>;
+//#endregion
+export { PreviewOperationError, previewOperation };

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

@@ -0,0 +1,13 @@
+import { PoolOperationPreviewError } from "../../../model/errors/preview-errors.js";
+import { PoolPositionOperationPreview, PreviewOperationOptions } from "../../../model/previews.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { PoolOperation } from "../parse/types-pools.js";
+import "../parse/index.js";
+import "../../index.js";
+//#region src/onchain/preview/preview/previewPoolPositionOperation.d.ts
+declare function previewPoolPositionOperation<P extends PluginsMap>(sdk: OnchainSDK<P>, operation: PoolOperation, options?: PreviewOperationOptions): Promise<SDKReturn<PoolPositionOperationPreview, PoolOperationPreviewError>>;
+//#endregion
+export { previewPoolPositionOperation };

package/dist/types/{preview → onchain/preview}/preview/replayInnerOperations.d.ts

@@ -1,13 +1,13 @@
-import { OperationPreviewError } from "../../model/previews.js";
-import "../../model/index.js";
-import { AssetsMap } from "../../onchain/utils/AssetsMap.js";
-import { PluginsMap } from "../../onchain/plugins/types.js";
-import { OnchainSDK } from "../../onchain/OnchainSDK.js";
-import "../../onchain/index.js";
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import "../../../model/index.js";
+import { AssetsMap } from "../../utils/AssetsMap.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
 import { InnerOperation } from "../parse/types-facades.js";
 import "../parse/index.js";
 import { CreditAccountState } from "./CreditAccountState.js";
-//#region src/preview/preview/replayInnerOperations.d.ts
+import "../../index.js";
+//#region src/onchain/preview/preview/replayInnerOperations.d.ts
 /**
  * Running state threaded through a credit-facade multicall by
  * {@link replayInnerOperations}: the account's post-state being mutated in
@@ -41,11 +41,11 @@ declare function makeReplayState(account: CreditAccountState): ReplayState;
  * facade execution order. The result is the *minimal guaranteed* post-state.
  *
  * The function assumes that the call was generated by our frontend using
- * router/withdrawal compressor, otherwise it returns a warning, but still
- * proceeds best-effort.
+ * router/withdrawal compressor, otherwise it answers the error on a malformed
+ * multicall; state is left as replayed up to that op.
  *
- * @returns `undefined` on success, the warning on a malformed multicall.
+ * @returns `undefined` on success, the error on a malformed multicall.
  */
-declare function replayInnerOperations<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], state: ReplayState): OperationPreviewError | undefined;
+declare function replayInnerOperations<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], state: ReplayState): MalformedTransactionError | undefined;
 //#endregion
 export { ReplayState, makeReplayState, replayInnerOperations };

package/dist/types/{preview → onchain/preview}/preview/replayMulticall.d.ts

@@ -1,15 +1,16 @@
-import { OperationPreviewError } from "../../model/previews.js";
-import "../../model/index.js";
-import { PluginsMap } from "../../onchain/plugins/types.js";
-import { OnchainSDK } from "../../onchain/OnchainSDK.js";
-import "../../onchain/index.js";
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { CreditAccountData } from "../../base/types.js";
+import { PluginsMap } from "../../plugins/types.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
 import { InnerOperation } from "../parse/types-facades.js";
-import { PreviewOperationOptions } from "../types.js";
 import "../parse/index.js";
 import { CreditAccountState } from "./CreditAccountState.js";
 import { ReplayState } from "./replayInnerOperations.js";
+import "../../index.js";
 import { Address } from "viem";
-//#region src/preview/preview/replayMulticall.d.ts
+//#region src/onchain/preview/preview/replayMulticall.d.ts
 /**
  * Parsed operation on an existing credit account whose multicall can be
  * replayed: the facade `closeCreditAccount` entry point and
@@ -33,12 +34,11 @@ interface ReplayMulticallResult {
    * replay in facade execution order
    */
   after: ReplayState;
-  warning?: OperationPreviewError;
 }
 /**
  * Replays the operation's multicall over the account's pre-resolved
- * pre-state (`options.creditAccount`) via {@link replayInnerOperations}.
+ * pre-state via {@link replayInnerOperations}.
  */
-declare function replayMulticall<P extends PluginsMap>(sdk: OnchainSDK<P>, operation: ReplayableOperation, options: PreviewOperationOptions<true>): ReplayMulticallResult;
+declare function replayMulticall<P extends PluginsMap>(sdk: OnchainSDK<P>, operation: ReplayableOperation, creditAccount: CreditAccountData): SDKReturn<ReplayMulticallResult, MalformedTransactionError>;
 //#endregion
 export { ReplayMulticallResult, ReplayableOperation, replayMulticall };

package/dist/types/{preview → onchain/preview}/preview/unwrapNativeCollateral.d.ts

@@ -1,19 +1,10 @@
-import { OperationPreviewError } from "../../model/previews.js";
-import "../../model/index.js";
-import { Asset } from "../../onchain/base/types.js";
-import "../../onchain/index.js";
+import { MalformedTransactionError } from "../../../model/errors/preview-errors.js";
+import { SDKReturn } from "../../../model/result.js";
+import "../../../model/index.js";
+import { Asset } from "../../base/types.js";
+import "../../index.js";
 import { Address } from "viem";
-//#region src/preview/preview/unwrapNativeCollateral.d.ts
-interface UnwrapNativeCollateralResult {
-  /**
-   * Collateral with the native amount unwrapped from the WETH entry.
-   */
-  assets: Asset[];
-  /**
-   * Warning set when the transaction value is malformed.
-   */
-  warning?: OperationPreviewError;
-}
+//#region src/onchain/preview/preview/unwrapNativeCollateral.d.ts
 /**
  * Represents the transaction's attached native value as a `NATIVE_ADDRESS`
  * entry in the collateral list.
@@ -25,15 +16,14 @@ interface UnwrapNativeCollateralResult {
  * reaches zero). Other entries are preserved.
  *
  * When `nativeAmount` is positive but the WETH collateral is missing or
- * smaller than it, the transaction is malformed: the collateral is returned
- * as-is (no unwrapping) together with an `invalidTransactionValue` warning.
+ * smaller than it, the transaction is malformed.
  *
  * @param collateral - Collateral assets as declared by the multicall.
  * @param nativeAmount - Transaction `msg.value`.
  * @param wethToken - Wrapped native token address.
  * @returns Collateral with the native amount unwrapped from the WETH entry,
- * plus the warning on a malformed transaction value.
+ * or `malformedTransaction` when `msg.value` does not fit the declared WETH.
  */
-declare function unwrapNativeCollateral(collateral: Asset[], nativeAmount: bigint, wethToken: Address): UnwrapNativeCollateralResult;
+declare function unwrapNativeCollateral(collateral: Asset[], nativeAmount: bigint, wethToken: Address): SDKReturn<Asset[], MalformedTransactionError>;
 //#endregion
-export { UnwrapNativeCollateralResult, unwrapNativeCollateral };
+export { unwrapNativeCollateral };

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

@@ -0,0 +1,16 @@
+import { QuotaCountExceededError } from "../../../model/errors/operation-errors.js";
+import { AccountProjection } from "../../../model/previews.js";
+import "../../../model/index.js";
+import { CreditSuite } from "../../market/credit/CreditSuite.js";
+//#region src/onchain/validation/bundles/checkAccountQuotas.d.ts
+/**
+ * How many quoted tokens the account would end up holding, against the number
+ * the facade enables at once.
+ *
+ * Reads nothing but the projected account, so a parsed transaction and a
+ * simulated one are held to it by the same code — including the reading that a
+ * quota the operation zeroed out is no longer held.
+ */
+declare function checkAccountQuotas(suite: CreditSuite, account: Pick<AccountProjection, "quotas">): QuotaCountExceededError[];
+//#endregion
+export { checkAccountQuotas };

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

@@ -0,0 +1,22 @@
+import { AdjustStrategyPositionPreview, OpenStrategyPositionPreview, RepayStrategyPositionPreview } from "../../../model/previews.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { WalletFundingError } from "./checkWallet.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkCollateralFunding.d.ts
+type CollateralFundingPreview = OpenStrategyPositionPreview | AdjustStrategyPositionPreview | RepayStrategyPositionPreview;
+interface CheckCollateralFundingInput {
+  sdk: OnchainSDK;
+  preview: CollateralFundingPreview;
+  sender: Address;
+  blockNumber?: bigint;
+}
+/**
+ * What the wallet must hold and have approved for the collateral the
+ * operation adds. Native value is already split out of `collateralAdded` as a
+ * `NATIVE_ADDRESS` entry; the facade wraps it into WETH, so the WETH allowance
+ * covers both halves.
+ */
+declare function checkCollateralFunding(input: CheckCollateralFundingInput): Promise<WalletFundingError[]>;
+//#endregion
+export { CheckCollateralFundingInput, CollateralFundingPreview, checkCollateralFunding };

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

@@ -0,0 +1,31 @@
+import { DebtOutOfRangeError, ForbiddenTokenError, InsufficientCollateralError, InsufficientPoolLiquidityError, QuotaCountExceededError, QuotaLimitReachedError, RWAOpenRequirementsError } from "../../../model/errors/operation-errors.js";
+import { AdjustStrategyPositionPreview, OpenStrategyPositionPreview } from "../../../model/previews.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { WalletFundingError } from "./checkWallet.js";
+import { HealthFactorThresholds } from "./checkHealthFactors.js";
+import { MarketStateError } from "./checkMarket.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkCreditOperation.d.ts
+/** {@inheritDoc checkCreditOperation} */
+type CreditOperationError = MarketStateError | DebtOutOfRangeError | InsufficientPoolLiquidityError | ForbiddenTokenError | QuotaCountExceededError | QuotaLimitReachedError | InsufficientCollateralError | WalletFundingError | RWAOpenRequirementsError;
+/** The two previews that carry a position for the thresholds to weigh. */
+type CreditOperationPreview = OpenStrategyPositionPreview | AdjustStrategyPositionPreview;
+interface CreditOperationArgs extends HealthFactorThresholds {
+  sdk: OnchainSDK;
+  preview: CreditOperationPreview;
+  /** The wallet that signs. Its balances, allowances and RWA standing are read on-chain. */
+  sender: Address;
+  blockNumber?: bigint;
+}
+/**
+ * What the protocol stops a credit operation for, then what the wallet still
+ * has to hold, approve or sign.
+ *
+ * The array is in check order, most fundamental first: the market's own state,
+ * then what the facade would revert on, then what the operation asks the
+ * market for, then the account it leaves behind, and last the wallet's side.
+ */
+declare function checkCreditOperation(args: CreditOperationArgs): Promise<CreditOperationError[]>;
+//#endregion
+export { CreditOperationArgs, CreditOperationError, CreditOperationPreview, checkCreditOperation };

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

@@ -0,0 +1,20 @@
+import { Token } from "../../../model/primitives.js";
+import { InsufficientPoolLiquidityError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { CreditSuite } from "../../market/credit/CreditSuite.js";
+import { CreditOperationPreview } from "./checkCreditOperation.js";
+//#region src/onchain/validation/bundles/checkDraw.d.ts
+/**
+ * What the transaction draws, against what the market can lend right now.
+ *
+ * Only a draw is weighed: repaying, or leaving the debt alone, can never exceed
+ * a ceiling. Opening borrows the whole debt; adjusting borrows
+ * `totalDebtChange`.
+ *
+ * The engine holds every simulation to this already (`assertCanBorrow`), so
+ * this is here for the transactions it never saw — a pasted calldata reaches
+ * the confirm screen with nothing else standing between it and a revert.
+ */
+declare function checkDraw(suite: CreditSuite, preview: CreditOperationPreview, underlying: Token): InsufficientPoolLiquidityError[];
+//#endregion
+export { checkDraw };

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

@@ -0,0 +1,39 @@
+import { Bps } from "../../../model/primitives.js";
+import { InsufficientCollateralError } from "../../../model/errors/operation-errors.js";
+import { AccountHoldings, AccountMetrics } from "../../../model/previews.js";
+import "../../../model/index.js";
+//#region src/onchain/validation/bundles/checkHealthFactors.d.ts
+/**
+ * The factors a caller holds an account to. Omitting a threshold switches its
+ * check off — there is no single right one.
+ */
+interface HealthFactorThresholds {
+  /** Lowest acceptable health factor at main prices, in bps. */
+  minHealthFactor?: Bps;
+  /** Lowest acceptable health factor at safe prices, in bps. */
+  minSafeHealthFactor?: Bps;
+  /**
+   * The factor the account stands at now. Given, an operation that raises it
+   * passes even from under the required factor — the top-ups that rescue a
+   * position would otherwise be stopped by the very check meant to protect it.
+   */
+  currentHealthFactor?: Bps;
+}
+/**
+ * An account's factors, in whichever branch of a routed leg the caller means to
+ * be held to: `prepare` reports the outcome the router expects, `preview` the
+ * floor its calldata guarantees. The check is indifferent — it weighs the
+ * numbers it is handed — and passing them one by one is what makes the choice
+ * visible where it is made.
+ */
+interface WeighedFactors extends Pick<AccountHoldings, "totalDebt">, Pick<AccountMetrics, "healthFactor" | "safeHealthFactor"> {}
+/**
+ * The account against whichever thresholds the caller holds it to, so a parsed
+ * transaction and a simulated one are weighed by the same code.
+ *
+ * A loan-free account is nothing to weigh: the health factor reports its
+ * zero-debt sentinel and no threshold applies.
+ */
+declare function checkHealthFactors(account: WeighedFactors, thresholds: HealthFactorThresholds): InsufficientCollateralError[];
+//#endregion
+export { HealthFactorThresholds, WeighedFactors, checkHealthFactors };

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

@@ -0,0 +1,20 @@
+import { CreditAccountFrozenError, LiquidatorNotEligibleError, NotEmergencyLiquidatorError } from "../../../model/errors/liquidation-errors.js";
+import { LiquidationDetails } from "../../../model/liquidations.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkLiquidationEligibility.d.ts
+interface CheckLiquidationEligibilityInput {
+  sdk: OnchainSDK;
+  details: LiquidationDetails;
+  liquidator: Address;
+}
+/** {@inheritDoc checkLiquidationEligibility} */
+type LiquidationEligibilityError = CreditAccountFrozenError | NotEmergencyLiquidatorError | LiquidatorNotEligibleError;
+/**
+ * Whether this wallet may liquidate this account, from the facts the
+ * compressor already reported and the market's emergency-liquidator list.
+ */
+declare function checkLiquidationEligibility(input: CheckLiquidationEligibilityInput): LiquidationEligibilityError[];
+//#endregion
+export { CheckLiquidationEligibilityInput, LiquidationEligibilityError, checkLiquidationEligibility };

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

@@ -0,0 +1,18 @@
+import { LiquidationDetails } from "../../../model/liquidations.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { WalletFundingError } from "./checkWallet.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkLiquidationFunding.d.ts
+interface CheckLiquidationFundingInput {
+  sdk: OnchainSDK;
+  details: LiquidationDetails;
+  liquidator: Address;
+  blockNumber?: bigint;
+}
+/**
+ * What the liquidator wallet must hold and have approved.
+ */
+declare function checkLiquidationFunding(input: CheckLiquidationFundingInput): Promise<WalletFundingError[]>;
+//#endregion
+export { CheckLiquidationFundingInput, checkLiquidationFunding };

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

@@ -0,0 +1,15 @@
+import { CreditManagerPausedError, MarketExpiredError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { CreditSuite } from "../../market/credit/CreditSuite.js";
+//#region src/onchain/validation/bundles/checkMarket.d.ts
+/** {@inheritDoc checkMarket} */
+type MarketStateError = CreditManagerPausedError | MarketExpiredError;
+/**
+ * What the market itself stops, whatever the operation does.
+ *
+ * Neither state is anything the sender can fix, which is why it comes first
+ * wherever it is composed in.
+ */
+declare function checkMarket(suite: CreditSuite): MarketStateError[];
+//#endregion
+export { MarketStateError, checkMarket };

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

@@ -0,0 +1,9 @@
+import { ForbiddenTokenError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { CreditSuite } from "../../market/credit/CreditSuite.js";
+import { CreditOperationPreview } from "./checkCreditOperation.js";
+//#region src/onchain/validation/bundles/checkObtained.d.ts
+/** Every token the operation buys more of, against what the market forbids. */
+declare function checkObtained(suite: CreditSuite, preview: CreditOperationPreview): ForbiddenTokenError[];
+//#endregion
+export { checkObtained };

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

@@ -0,0 +1,19 @@
+import { PoolPositionOperationPreview } from "../../../model/previews.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { WalletFundingError } from "./checkWallet.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkPoolFunding.d.ts
+interface CheckPoolFundingInput {
+  sdk: OnchainSDK;
+  preview: PoolPositionOperationPreview;
+  sender: Address;
+  blockNumber?: bigint;
+}
+/**
+ * What the wallet must hold (and approve) for a pool deposit, mint, withdraw
+ * or redeem, read off the preview's `tokenIn`, `zapper` and `holder`.
+ */
+declare function checkPoolFunding(input: CheckPoolFundingInput): Promise<WalletFundingError[]>;
+//#endregion
+export { CheckPoolFundingInput, checkPoolFunding };

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

@@ -0,0 +1,31 @@
+import { TokenAmount } from "../../../model/primitives.js";
+import { InsufficientPoolLiquidityError, PoolPausedError, PoolSunsetError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkPoolOperation.d.ts
+/** {@inheritDoc checkPoolOperation} */
+type PoolOperationError = PoolPausedError | PoolSunsetError | InsufficientPoolLiquidityError;
+interface PoolOperationArgs {
+  sdk: OnchainSDK;
+  /** Pool the liquidity moves through. */
+  pool: Address;
+  /** Whether the operation puts liquidity in rather than taking it out. */
+  isDeposit: boolean;
+  /**
+   * What the wallet receives. Weighed against the pool's liquidity on a
+   * withdrawal, where it is the underlying leaving the pool; on a deposit it
+   * is the shares the pool mints and nothing weighs it.
+   */
+  tokenOut: TokenAmount;
+}
+/**
+ * What the pool's own state stops, whichever side of it the wallet is on.
+ *
+ * The liquidity read is the market's rather than the trimmed figure a
+ * simulation carries: a withdrawal sized against that figure has to pass the
+ * check that follows it.
+ */
+declare function checkPoolOperation(args: PoolOperationArgs): PoolOperationError[];
+//#endregion
+export { PoolOperationArgs, PoolOperationError, checkPoolOperation };

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

@@ -0,0 +1,10 @@
+import { Token } from "../../../model/primitives.js";
+import { QuotaLimitReachedError } from "../../../model/errors/operation-errors.js";
+import "../../../model/index.js";
+import { MarketSuite } from "../../market/MarketSuite.js";
+import { CreditOperationPreview } from "./checkCreditOperation.js";
+//#region src/onchain/validation/bundles/checkQuotasAsked.d.ts
+/** Every quota the operation raises, against the room the keeper has left. */
+declare function checkQuotasAsked(market: MarketSuite, preview: CreditOperationPreview, underlying: Token): QuotaLimitReachedError[];
+//#endregion
+export { checkQuotasAsked };

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

@@ -0,0 +1,21 @@
+import { RWAOperationArgs } from "../../../model/rwa.js";
+import { RWAOpenRequirementsError } from "../../../model/errors/operation-errors.js";
+import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkRWAOpenRequirements.d.ts
+interface CheckRWAOpenRequirementsInput {
+  sdk: OnchainSDK;
+  wallet: Address;
+  creditManager: Address;
+  token: Address;
+  providedArgs: RWAOperationArgs;
+}
+/**
+ * The RWA factory is satisfied that `wallet` may open on `token` with the
+ * registration args already on the transaction.
+ */
+declare function checkRWAOpenRequirements(input: CheckRWAOpenRequirementsInput): Promise<(RWAOpenRequirementsError | UnexpectedFailureError)[]>;
+//#endregion
+export { CheckRWAOpenRequirementsInput, checkRWAOpenRequirements };

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

@@ -0,0 +1,19 @@
+import { RWAOpenRequirementsError } from "../../../model/errors/operation-errors.js";
+import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
+import { OpenRWAStrategyPositionPreview } from "../../../model/previews.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkRWAOpening.d.ts
+interface CheckRWAOpeningInput {
+  sdk: OnchainSDK;
+  preview: OpenRWAStrategyPositionPreview;
+  sender: Address;
+}
+/**
+ * Per factory-gated token among `collateralAdded ∪ quotas`, whether the
+ * borrower still has to register or sign before this opening can land.
+ */
+declare function checkRWAOpening(input: CheckRWAOpeningInput): Promise<(RWAOpenRequirementsError | UnexpectedFailureError)[]>;
+//#endregion
+export { CheckRWAOpeningInput, checkRWAOpening };

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

@@ -0,0 +1,23 @@
+import { InsufficientAllowanceError, InsufficientBalanceError } from "../../../model/errors/operation-errors.js";
+import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkWallet.d.ts
+/** {@inheritDoc checkWallet} */
+type WalletFundingError = InsufficientBalanceError | InsufficientAllowanceError | UnexpectedFailureError;
+interface CheckWalletInput {
+  sdk: OnchainSDK;
+  token: Address;
+  holder: Address;
+  required: bigint;
+  spender?: Address;
+  blockNumber?: bigint;
+}
+/**
+ * The wallet's whole side for one token: always the balance; the allowance
+ * only when it can matter (an ERC-20, with a spender who is not the holder).
+ */
+declare function checkWallet(input: CheckWalletInput): Promise<WalletFundingError[]>;
+//#endregion
+export { CheckWalletInput, WalletFundingError, checkWallet };

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

@@ -0,0 +1,18 @@
+import { InsufficientAllowanceError } from "../../../model/errors/operation-errors.js";
+import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkWalletAllowance.d.ts
+interface CheckWalletAllowanceInput {
+  sdk: OnchainSDK;
+  token: Address;
+  owner: Address;
+  spender: Address;
+  required: bigint;
+  blockNumber?: bigint;
+}
+/** `owner` has approved `spender` for at least `required` of `token`. */
+declare function checkWalletAllowance(input: CheckWalletAllowanceInput): Promise<(InsufficientAllowanceError | UnexpectedFailureError)[]>;
+//#endregion
+export { CheckWalletAllowanceInput, checkWalletAllowance };

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

@@ -0,0 +1,17 @@
+import { InsufficientBalanceError } from "../../../model/errors/operation-errors.js";
+import { UnexpectedFailureError } from "../../../model/errors/prepare-errors.js";
+import "../../../model/index.js";
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { Address } from "viem";
+//#region src/onchain/validation/bundles/checkWalletBalance.d.ts
+interface CheckWalletBalanceInput {
+  sdk: OnchainSDK;
+  token: Address;
+  holder: Address;
+  required: bigint;
+  blockNumber?: bigint;
+}
+/** `holder` holds at least `required` of `token` (ERC-20 or native). */
+declare function checkWalletBalance(input: CheckWalletBalanceInput): Promise<(InsufficientBalanceError | UnexpectedFailureError)[]>;
+//#endregion
+export { CheckWalletBalanceInput, checkWalletBalance };