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

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

@@ -1,242 +0,0 @@
-import { Bps, Token, TokenAmount } from "../../model/primitives.js";
-import { MalformedPreviewError } from "../../model/previews.js";
-import "../../model/index.js";
-import { Address } from "viem";
-//#region src/onchain/validation/refusal.d.ts
-/**
- * Why a preview could not be produced.
- *
- * Every member is raised by the engine as an {@link IntentPreviewError}, with
- * the exception of `unsupportedTokenPair` and `noRecordedIntent`, which the
- * prepare namespace reports for a request it can refuse before planning.
- */
-type PreviewErrorReason =
-/** The debt the request implies falls outside the facade's band. */
-"debtOutOfRange" |
-/** The leverage asked for cannot be expressed as a plan at all. */
-"leverageOutOfRange" |
-/** Nothing on the account or in the wallet can fund what was asked. */
-"insufficientSourceBalance" |
-/** Input token is not accepted by the flow (e.g. deposit of a non-underlying). */
-"unsupportedCollateralToken" |
-/**
- * No route for the trade the plan needs: no pool pair between the tokens
- * requested, several and none was picked, or the pathfinder itself found no
- * path for the amounts involved.
- */
-"unsupportedTokenPair" |
-/**
- * The intent cannot settle with a delay: the source has no redemption config,
- * the chain has no compressor, or the payout is one the tail cannot serve.
- */
-"noDelayedRoute" |
-/** Several redemption venues for the source, and nothing says which. */
-"multipleDelayedWithdrawals" |
-/** A redemption of the same asset is already in flight. */
-"withdrawalInProgress" |
-/**
- * The claim names no operation to resume: requested without an intent, or
- * read through a compressor too old to report one.
- */
-"noRecordedIntent" |
-/** The facade or the pool behind it is paused: nothing can be done at all. */
-"marketPaused" |
-/** The facade is past its expiration date and takes no more multicalls. */
-"marketExpired" |
-/**
- * The pool cannot lend what the plan draws right now — its free liquidity,
- * the manager's debt limit or the per-block cap stands in the way.
- */
-"insufficientPoolLiquidity" |
-/** The market takes no more quota for a token the plan wants to hold. */
-"quotaLimitReached" |
-/** The plan would increase the balance of a token the market forbids. */
-"forbiddenToken" |
-/**
- * The account would end the transaction owing more than its collateral is
- * worth under liquidation thresholds, which the facade refuses to allow.
- */
-"insufficientCollateral" |
-/** The pool is winding down: it still pays out, but takes no more deposits. */
-"poolSunset" |
-/**
- * The account would end up with more quoted tokens than the facade enables
- * at once. A count, not an amount — unlike `quotaLimitReached`.
- */
-"quotaCountExceeded" |
-/**
- * The transaction could not be replayed: it is malformed, and every field
- * derived from replayed balances is guesswork.
- */
-"malformedTransaction";
-/**
- * The numbers behind each refusal, so a caller reads the limit that was missed
- * instead of re-deriving it.
- *
- * Anything with a token and an amount is a {@link TokenAmount}; ratios carry
- * no token. `undefined` marks a reason raised from several places, only some of
- * which hold the numbers.
- */
-interface PreviewErrorDetails {
-  /** All three in the market's underlying. */
-  debtOutOfRange: {
-    requested: TokenAmount;
-    minDebt: TokenAmount;
-    maxDebt: TokenAmount;
-  };
-  /**
-   * Scaled by `LEVERAGE_DECIMALS` (`100n` = 1x), as the intent states it — not
-   * the read model's `Leverage`. `undefined` where the floor is not fixed: the
-   * deposit planner's is a function of the deposit.
-   */
-  leverageOutOfRange: {
-    requested: bigint;
-    min: bigint;
-  } | undefined;
-  /** `undefined` where the request never got as far as naming an amount. */
-  insufficientSourceBalance: {
-    required: TokenAmount;
-    held: TokenAmount;
-  } | undefined;
-  unsupportedCollateralToken: {
-    token: Token;
-  };
-  /**
-   * `to` is absent where the market named no output for `from`. The whole
-   * detail is absent only when the pathfinder reverted rather than answered.
-   */
-  unsupportedTokenPair: {
-    from: Token;
-    to: Token | undefined;
-  } | undefined;
-  noDelayedRoute: {
-    token: Token;
-  } | undefined;
-  multipleDelayedWithdrawals: {
-    token: Token;
-    venues: number;
-  };
-  /** The phantom token standing for the redemption already in flight. */
-  withdrawalInProgress: {
-    inFlight: TokenAmount;
-  };
-  noRecordedIntent: undefined;
-  /**
-   * Which contract is paused. A credit account operation names the manager, an
-   * LP operation the pool — the two are never both present.
-   */
-  marketPaused: {
-    creditManager: Address;
-  } | {
-    pool: Address;
-  };
-  /** `expirationDate` is unix seconds, as the facade reports it. */
-  marketExpired: {
-    creditManager: Address;
-    expirationDate: number;
-  };
-  /**
-   * Both in the market's underlying. `binding` names which of the four ceilings
-   * ran out first, so a caller can say what would fix it — waiting for lenders
-   * and asking governance are opposite answers. `solutionAmount` is the largest
-   * position still openable, absent when even the minimum debt does not fit.
-   */
-  insufficientPoolLiquidity: {
-    requested: TokenAmount;
-    available: TokenAmount;
-    binding: BorrowLimitBinding;
-    solutionAmount?: TokenAmount;
-  };
-  /**
-   * `token` is the one whose quota is asked for; the amounts are in the
-   * **underlying**, which is what a quota is measured in. `requested` is absent
-   * for a token the market opened no quota for at all — nothing was weighed
-   * against a limit.
-   */
-  quotaLimitReached: {
-    token: Token;
-    requested: TokenAmount | undefined;
-    available: TokenAmount;
-  };
-  forbiddenToken: {
-    token: Token;
-  };
-  /**
-   * `required` is the bar the factor was weighed against — the facade's own
-   * `1.0` for a check that asks whether the transaction lands, a form's higher
-   * bar for one that asks whether it is wise. `healthFactor` is the factor
-   * compared, which for a call that hands funds over is the safe-price one;
-   * `safePrices` says which, since a preview always reports main prices.
-   */
-  insufficientCollateral: {
-    healthFactor: Bps;
-    required: Bps;
-    safePrices: boolean;
-  };
-  poolSunset: {
-    pool: Address;
-  };
-  /** How many quoted tokens the account would end with, against the cap. */
-  quotaCountExceeded: {
-    count: number;
-    max: number;
-  };
-  /**
-   * The malformed-preview warning the SDK recorded, and its human-readable
-   * detail.
-   */
-  malformedTransaction: MalformedPreviewError;
-}
-/**
- * Which ceiling ran out when a borrow could not be served.
- *
- * The names are the expressions, not the legacy labels, because the two do not
- * line up: the legacy `insufficientDebtLimit` was the manager's own headroom
- * (`managerDebtAvailable`), `insufficientPoolDebtLimit` was `poolDebtLimit`,
- * and `insufficientPoolLiquidity` was what the manager could still draw
- * (`poolAvailableLiquidity`).
- *
- * `borrowable()` weighs only three of these — the pool's free liquidity, the
- * manager's remaining allowance and the facade's per-block cap. `poolDebtLimit`
- * is read by the account-opening path alone, which is why it is not among them.
- */
-type BorrowLimitBinding = "poolAvailableLiquidity" | "poolDebtLimit" | "managerDebtAvailable" | "facadePerBlockCap";
-/**
- * The failure half every simulation shares.
- *
- * Distributed over the reasons rather than written as `{ reason; detail }`, so
- * that narrowing on `reason` narrows `detail` with it.
- */
-type PreviewIssue = { [R in PreviewErrorReason]: {
-  reason: R;
-  detail: PreviewErrorDetails[R];
-}; }[PreviewErrorReason];
-/**
- * The failure half every simulation shares: an issue, plus the `ok: false`
- * that tells it apart from a preview.
- */
-type PreviewRefusal = {
-  ok: false;
-} & PreviewIssue;
-/** Builds the refusal a caller sees. */
-declare function refuse<R extends PreviewErrorReason>(reason: R, detail: PreviewErrorDetails[R]): PreviewRefusal;
-/**
- * Validation failure that maps onto {@link PreviewErrorReason} rather than
- * crashing the caller: raised by the planners and the guards, turned into
- * `{ ok: false }` by `CreditAccountOperationsService`.
- */
-declare class IntentPreviewError<R extends PreviewErrorReason = PreviewErrorReason> extends Error {
-  readonly reason: R;
-  readonly detail: PreviewErrorDetails[R];
-  constructor(reason: R, detail: PreviewErrorDetails[R], message?: string);
-}
-/**
- * Throws the issue a check found, with the sentence the engine logs for it.
- *
- * 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(issue: PreviewIssue | null, message: string): void;
-//#endregion
-export { BorrowLimitBinding, IntentPreviewError, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse };

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

@@ -1,47 +0,0 @@
-import { InvalidDelayedIntentError } from "../onchain/accounts/withdrawal-compressor/errors.js";
-import { UnsupportedZapperFunctionError } from "../onchain/market/zapper/errors.js";
-import { BorrowLimitBinding, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse } from "../onchain/validation/refusal.js";
-import { AdapterOperation, AdapterOperationBase, TokenTransfer, TraceAdapterExt } from "./parse/types-adapters.js";
-import { AddCollateralOp, CloseCreditAccountOperation, CompareBalancesOp, CreditAccountOperation, DecreaseDebtOp, DirectTokenTransferOperation, FacadeOperationMetadata, IncreaseDebtOp, InnerFacadeOperation, InnerOperation, LiquidateCreditAccountOperation, MulticallOperation, OpenCreditAccountOperation, OperationMetadata, OuterFacadeOperation, PartialLiquidationOperation, StoreExpectedBalancesOp, UpdateQuotaOp, WithdrawCollateralOp } from "./parse/types-facades.js";
-import { PoolDepositOperation, PoolMintOperation, PoolOperation, PoolRedeemOperation, PoolWithdrawOperation } from "./parse/types-pools.js";
-import { RWAMulticallOperation, RWAOpenCreditAccountOperation, RWAOperation, RWAOperationMetadata } from "./parse/types-rwa.js";
-import { Operation, isPoolOperation, isRWAOperation } from "./parse/types.js";
-import { ClassifyInnerOperationsProps, classifyInnerOperations } from "./parse/classifyInnerOperations.js";
-import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "./parse/errors.js";
-import { parseFacadeOperationCalldata } from "./parse/parseFacadeOperationCalldata.js";
-import { PreviewOperationInput, PreviewOperationOptions } from "./types.js";
-import { parseOperationCalldata } from "./parse/parseOperationCalldata.js";
-import { parsePoolOperationCalldata } from "./parse/parsePoolOperationCalldata.js";
-import { parseRWAFactoryOperationCalldata } from "./parse/parseRWAFactoryOperationCalldata.js";
-import "./parse/index.js";
-import { TransferAlignmentError, UnexpectedFacadeEventOrderError, UnknownAdapterError, UnknownFacadeCallError, WithdrawCollateralAlignmentError } from "./trace/errors.js";
-import { extractAdapterCallTraces } from "./trace/extractAdapterCallTraces.js";
-import { ExtractTransfersResult, WithdrawCollateralEventInfo, extractTransfers } from "./trace/extractTransfers.js";
-import { FacadeCallType, FacadeParsedCall } from "./trace/types.js";
-import { findFacadeCalls } from "./trace/findFacadeCalls.js";
-import "./trace/index.js";
-import { BalanceDetail, BalancePrerequisite, BalanceResult } from "./prerequisites/BalancePrerequisite.js";
-import { RWAOpenRequirementsDetail, RWAOpenRequirementsPrerequisite, RWAOpenRequirementsResult } from "./prerequisites/RWAOpenRequirementsPrerequisite.js";
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteKind, PrerequisiteOutcome, PrerequisiteResult } from "./prerequisites/types.js";
-import { Prerequisite } from "./prerequisites/Prerequisite.js";
-import { AllowanceDetail, AllowancePrerequisite, AllowanceResult } from "./prerequisites/AllowancePrerequisite.js";
-import { checkPrerequisites } from "./prerequisites/checkPrerequisites.js";
-import "./prerequisites/index.js";
-import { CreditAccountState, CreditAccountStateProps } from "./preview/CreditAccountState.js";
-import { DetectedDelayedOperation, detectDelayedOperation } from "./preview/detectDelayedOperation.js";
-import { buildDelayedStrategyPositionOperationPreview } from "./preview/buildDelayedStrategyPositionOperationPreview.js";
-import { classifyCloseOrRepay, isCloseOrRepay } from "./preview/detectCloseOrRepay.js";
-import { DetectedDelayedClaim, detectDelayedClaim, resolveDelayedClaimIntent } from "./preview/detectDelayedClaim.js";
-import { UnsupportedOperationError, adapterCallOutsideBracketError, invalidTransactionValueError, malformedBracketError, nonAdapterCallInBracketError, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError } from "./preview/errors.js";
-import { estimateClaimableAt } from "./preview/estimateClaimableAt.js";
-import { previewAdjustStrategyPosition } from "./preview/previewAdjustStrategyPosition.js";
-import { CloseOrRepayOperation, previewExitOrRepayStrategyPosition } from "./preview/previewExitOrRepayStrategyPosition.js";
-import { PreviewSimulationError, SimulationError, SimulationFlowFailure, SimulationFlowSource, asPreviewSimulationError } from "./simulate/errors.js";
-import { PreviewOperationError, previewOperation } from "./preview/previewOperation.js";
-import { ReplayState, makeReplayState, replayInnerOperations } from "./preview/replayInnerOperations.js";
-import { ReplayMulticallResult, ReplayableOperation, replayMulticall } from "./preview/replayMulticall.js";
-import "./preview/index.js";
-import { CheckOperationOptions, WeighedFactors, checkOperation, collateralIssue, marketIssues, quotaCountIssue } from "./validate/checkOperation.js";
-import { checkSimulation } from "./validate/checkSimulation.js";
-import "./validate/index.js";
-export { AdapterOperation, AdapterOperationBase, AddCollateralOp, AllowanceDetail, AllowancePrerequisite, AllowanceResult, BalanceDetail, BalancePrerequisite, BalanceResult, type BorrowLimitBinding, CheckOperationOptions, ClassifyInnerOperationsProps, CloseCreditAccountOperation, CloseOrRepayOperation, CompareBalancesOp, CreditAccountOperation, CreditAccountState, CreditAccountStateProps, DecreaseDebtOp, DetectedDelayedClaim, DetectedDelayedOperation, DirectTokenTransferOperation, ExtractTransfersResult, FacadeCallType, FacadeOperationMetadata, FacadeParsedCall, IncreaseDebtOp, InnerFacadeOperation, InnerOperation, type InvalidDelayedIntentError, LiquidateCreditAccountOperation, MulticallOperation, OpenCreditAccountOperation, Operation, OperationMetadata, OuterFacadeOperation, PartialLiquidationOperation, PoolDepositOperation, PoolMintOperation, PoolOperation, PoolRedeemOperation, PoolWithdrawOperation, Prerequisite, PrerequisiteContext, PrerequisiteError, PrerequisiteKind, PrerequisiteOutcome, PrerequisiteResult, type PreviewErrorDetails, type PreviewErrorReason, type PreviewIssue, PreviewOperationError, PreviewOperationInput, PreviewOperationOptions, type PreviewRefusal, type PreviewSimulationError, RWAMulticallOperation, RWAOpenCreditAccountOperation, RWAOpenRequirementsDetail, RWAOpenRequirementsPrerequisite, RWAOpenRequirementsResult, RWAOperation, RWAOperationMetadata, ReplayMulticallResult, ReplayState, ReplayableOperation, type SimulationError, type SimulationFlowFailure, type SimulationFlowSource, StoreExpectedBalancesOp, TokenTransfer, TraceAdapterExt, TransferAlignmentError, UnexpectedFacadeEventOrderError, UnknownAdapterError, UnknownFacadeCallError, UnsupportedOperationError, UnsupportedPoolFunctionError, UnsupportedTargetError, type UnsupportedZapperFunctionError, UpdateQuotaOp, WeighedFactors, WithdrawCollateralAlignmentError, WithdrawCollateralEventInfo, WithdrawCollateralOp, adapterCallOutsideBracketError, asPreviewSimulationError, buildDelayedStrategyPositionOperationPreview, checkOperation, checkPrerequisites, checkSimulation, classifyCloseOrRepay, classifyInnerOperations, collateralIssue, detectDelayedClaim, detectDelayedOperation, estimateClaimableAt, extractAdapterCallTraces, extractTransfers, findFacadeCalls, invalidTransactionValueError, isCloseOrRepay, isPoolOperation, isRWAOperation, makeReplayState, malformedBracketError, marketIssues, nonAdapterCallInBracketError, parseFacadeOperationCalldata, parseOperationCalldata, parsePoolOperationCalldata, parseRWAFactoryOperationCalldata, previewAdjustStrategyPosition, previewExitOrRepayStrategyPosition, previewOperation, quotaCountIssue, raise, refuse, replayInnerOperations, replayMulticall, resolveDelayedClaimIntent, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError };

package/dist/types/preview/parse/errors.d.ts

@@ -1,29 +0,0 @@
-import { IGearboxError } from "../../model/errors.js";
-import "../../model/index.js";
-import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
-import { Address } from "viem";
-//#region src/preview/parse/errors.d.ts
-/**
- * Refusal answered when the target of a transaction is neither a known
- * Gearbox pool nor a credit facade. A plain returned object per the SDK's
- * refusal vocabulary — not a thrown `Error`.
- */
-interface UnsupportedTargetError extends IGearboxError {
-  code: "unsupportedTarget";
-  /** Target address no known Gearbox contract answers for. */
-  target: Address;
-}
-/**
- * Refusal answered when a pool call uses a function other than ERC4626
- * `deposit`/`redeem`. A plain returned object per the SDK's refusal
- * vocabulary — not a thrown `Error`.
- */
-interface UnsupportedPoolFunctionError extends IGearboxError {
-  code: "unsupportedPoolFunction";
-  /** Pool the call targets. */
-  pool: Address;
-  /** Decoded function name the SDK cannot preview. */
-  functionName: string;
-}
-//#endregion
-export { UnsupportedPoolFunctionError, UnsupportedTargetError, type UnsupportedZapperFunctionError };

package/dist/types/preview/parse/parseOperationCalldata.d.ts

@@ -1,18 +0,0 @@
-import { SDKReturn } from "../../model/result.js";
-import "../../model/index.js";
-import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
-import { PluginsMap } from "../../onchain/plugins/types.js";
-import "../../onchain/index.js";
-import { Operation } from "./types.js";
-import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "./errors.js";
-import { PreviewOperationInput } from "../types.js";
-//#region src/preview/parse/parseOperationCalldata.d.ts
-/**
- * Decodes raw operation calldata into an {@link Operation}.
- *
- * Support parsing of pool operations (including via zappers),
- * credit facade operations and RWA factory operations.
- */
-declare function parseOperationCalldata<P extends PluginsMap>(input: PreviewOperationInput<P>): SDKReturn<Operation, UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError>;
-//#endregion
-export { parseOperationCalldata };

package/dist/types/preview/prerequisites/AllowancePrerequisite.d.ts

@@ -1,26 +0,0 @@
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteOutcome } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { Address } from "viem";
-//#region src/preview/prerequisites/AllowancePrerequisite.d.ts
-/** ERC-20 allowance from `owner` to `spender` must cover `required`. */
-interface AllowanceDetail {
-  token: Address;
-  owner: Address;
-  spender: Address;
-  required: bigint;
-  /** On-chain allowance read; only present when the read succeeded. */
-  actual?: bigint;
-}
-type AllowanceResult = PrerequisiteOutcome & {
-  kind: "allowance";
-  detail: AllowanceDetail;
-};
-/** Checks that `owner` granted `spender` an ERC-20 allowance >= `required`. */
-declare class AllowancePrerequisite extends Prerequisite {
-  #private;
-  constructor(detail: Omit<AllowanceDetail, "actual">);
-  protected check(ctx: PrerequisiteContext): Promise<AllowanceResult>;
-  protected errorResult(error: PrerequisiteError): AllowanceResult;
-}
-//#endregion
-export { AllowanceDetail, AllowancePrerequisite, AllowanceResult };

package/dist/types/preview/prerequisites/BalancePrerequisite.d.ts

@@ -1,29 +0,0 @@
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteOutcome } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { Address } from "viem";
-//#region src/preview/prerequisites/BalancePrerequisite.d.ts
-/** ERC-20 balance of `owner` must cover `required`. */
-interface BalanceDetail {
-  token: Address;
-  owner: Address;
-  required: bigint;
-  /** On-chain balance read; only present when the read succeeded. */
-  actual?: bigint;
-}
-type BalanceResult = PrerequisiteOutcome & {
-  kind: "balance";
-  detail: BalanceDetail;
-};
-/**
- * Checks that `owner` holds a token balance >= `required`. The token is read
- * as an ERC-20, except for the native pseudo-address ({@link NATIVE_ADDRESS},
- * e.g. ETH-zapper deposits) whose balance is read via `getBalance`.
- */
-declare class BalancePrerequisite extends Prerequisite {
-  #private;
-  constructor(detail: Omit<BalanceDetail, "actual">);
-  protected check(ctx: PrerequisiteContext): Promise<BalanceResult>;
-  protected errorResult(error: PrerequisiteError): BalanceResult;
-}
-//#endregion
-export { BalanceDetail, BalancePrerequisite, BalanceResult };

package/dist/types/preview/prerequisites/Prerequisite.d.ts

@@ -1,26 +0,0 @@
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteResult } from "./types.js";
-//#region src/preview/prerequisites/Prerequisite.d.ts
-/**
- * A single verifiable prerequisite for a transaction. Subclasses implement
- * {@link check} to perform whatever async reads they need (an ERC-20
- * `readContract`, a compressor call, ...) and map the outcome into a
- * {@link PrerequisiteResult}.
- */
-declare abstract class Prerequisite {
-  /**
-   * Verifies this prerequisite. Never rejects: any error thrown by
-   * {@link check} (revert, RPC/network failure, compressor error) is
-   * normalized into an `error` result.
-   */
-  verify(ctx: PrerequisiteContext): Promise<PrerequisiteResult>;
-  /**
-   * Performs the reads this prerequisite needs and maps them into a result.
-   * May throw on read failure; {@link verify} converts throws into `error`
-   * results.
-   */
-  protected abstract check(ctx: PrerequisiteContext): Promise<PrerequisiteResult>;
-  /** Builds this prerequisite's failed result from a normalized read error. */
-  protected abstract errorResult(error: PrerequisiteError): PrerequisiteResult;
-}
-//#endregion
-export { Prerequisite };

package/dist/types/preview/prerequisites/RWAOpenRequirementsPrerequisite.d.ts

@@ -1,55 +0,0 @@
-import { RWAMissingOpenAccountRequirements, RWAOpenAccountRequirements, RWAOperationArgs } from "../../onchain/market/rwa/types.js";
-import "../../onchain/index.js";
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteOutcome } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { Address } from "viem";
-//#region src/preview/prerequisites/RWAOpenRequirementsPrerequisite.d.ts
-/**
- * RWA (e.g. Securitize) open-account requirements: off-chain token
- * registration and/or EIP-712 signatures the borrower must provide before
- * opening a credit account in an RWA market.
- */
-interface RWAOpenRequirementsDetail {
-  /** RWA token (e.g. Securitize DSToken) the requirements are checked for. */
-  token: Address;
-  /** Credit manager of the RWA market. */
-  creditManager: Address;
-  /** RWA factory that gates the token. */
-  factory: Address;
-  /**
-   * Full requirements fetched at verify time via
-   * `sdk.accounts.getOpenAccountRequirements`; only present when the read
-   * succeeded and the factory gates the token.
-   */
-  requirements?: RWAOpenAccountRequirements;
-  /**
-   * Subset of `requirements` still unfulfilled, computed by the RWA
-   * factory at verify time (`IRWAFactory.getMissingRequirements`);
-   * `undefined` when everything is satisfied.
-   */
-  missing?: RWAMissingOpenAccountRequirements;
-}
-type RWAOpenRequirementsResult = PrerequisiteOutcome & {
-  kind: "rwaOpenRequirements";
-  detail: RWAOpenRequirementsDetail;
-};
-/**
- * Checks that the borrower has fulfilled the RWA factory's open-account
- * requirements (issuer-side token registration, EIP-712 signatures).
- *
- * The requirements are fetched at verify time via
- * `sdk.accounts.getOpenAccountRequirements`, so re-running verification picks
- * up off-chain progress (the borrower registering on the issuer's website or
- * signing the factory's message) without rebuilding the prerequisites. The
- * unfulfilled subset is computed by the factory itself
- * (`IRWAFactory.getMissingRequirements`) and exposed on the result's
- * `detail.missing`; the full requirements are kept on `detail.requirements`.
- */
-declare class RWAOpenRequirementsPrerequisite extends Prerequisite {
-  #private;
-  constructor(detail: Omit<RWAOpenRequirementsDetail, "requirements" | "missing">, providedArgs?: RWAOperationArgs);
-  protected check(ctx: PrerequisiteContext): Promise<RWAOpenRequirementsResult>;
-  protected errorResult(error: PrerequisiteError): RWAOpenRequirementsResult;
-}
-//#endregion
-export { RWAOpenRequirementsDetail, RWAOpenRequirementsPrerequisite, RWAOpenRequirementsResult };

package/dist/types/preview/prerequisites/buildCollateralPrerequisites.d.ts

@@ -1,20 +0,0 @@
-import { GetApprovalAddressProps } from "../../onchain/accounts/types.js";
-import "../../onchain/index.js";
-import { InnerOperation } from "../parse/types-facades.js";
-import "../parse/index.js";
-import { PrerequisiteContext } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-//#region src/preview/prerequisites/buildCollateralPrerequisites.d.ts
-/**
- * For every `addCollateral` inside a multicall, requires the wallet to approve
- * and hold the collateral token for the collateral spender.
- *
- * The approval spender is resolved via {@link OnchainSDK.accounts.getApprovalAddress}:
- * the credit manager for classic markets, but a per-investor "special wallet"
- * for RWA markets. The resolution happens at build time because the spender is
- * part of the prerequisite's identity and UI detail.
- *
- */
-declare function buildCollateralPrerequisites(spenderOptions: GetApprovalAddressProps, multicall: InnerOperation[], ctx: PrerequisiteContext): Promise<Prerequisite[]>;
-//#endregion
-export { buildCollateralPrerequisites };

package/dist/types/preview/prerequisites/buildPartialLiquidationPrerequisites.d.ts

@@ -1,12 +0,0 @@
-import { PartialLiquidationOperation } from "../parse/types-facades.js";
-import "../parse/index.js";
-import { PrerequisiteContext } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-//#region src/preview/prerequisites/buildPartialLiquidationPrerequisites.d.ts
-/**
- * Partial liquidation pulls the repaid underlying from the liquidator: they
- * must have approved it to the credit manager and hold enough of it.
- */
-declare function buildPartialLiquidationPrerequisites(tx: PartialLiquidationOperation, ctx: PrerequisiteContext): Prerequisite[];
-//#endregion
-export { buildPartialLiquidationPrerequisites };

package/dist/types/preview/prerequisites/buildPoolPrerequisites.d.ts

@@ -1,12 +0,0 @@
-import { PoolOperation } from "../parse/types-pools.js";
-import "../parse/index.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { Address } from "viem";
-//#region src/preview/prerequisites/buildPoolPrerequisites.d.ts
-/**
- * Prerequisites for ERC4626 pool operations (deposit, mint, withdraw, redeem),
- * either direct or zapper-routed.
- */
-declare function buildPoolPrerequisites(tx: PoolOperation, wallet: Address): Prerequisite[];
-//#endregion
-export { buildPoolPrerequisites };

package/dist/types/preview/prerequisites/buildRWAPrerequisites.d.ts

@@ -1,26 +0,0 @@
-import { RWAOperationArgs } from "../../onchain/market/rwa/types.js";
-import "../../onchain/index.js";
-import { InnerOperation } from "../parse/types-facades.js";
-import "../parse/index.js";
-import { PrerequisiteContext } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { Address } from "viem";
-//#region src/preview/prerequisites/buildRWAPrerequisites.d.ts
-/**
- * For RWA-factory open-account operations (e.g. `RWAOpenCreditAccount`),
- * builds a prerequisite per RWA token the multicall touches; each one checks
- * the factory's open-account requirements (issuer-side token registration,
- * EIP-712 signatures) at verify time.
- *
- * The `providedArgs` params are the registration values decoded from the
- * transaction calldata itself: signatures already included there satisfy the
- * signature requirement, so a fully built transaction is not reported as
- * missing signatures. In the template flow they are empty and the verified
- * result's `detail.missing` describes what is still unfulfilled; acting on it
- * (signing, rebuilding calldata) is up to the consumer.
- *
- * Returns nothing for non-RWA markets.
- */
-declare function buildRWAPrerequisites(multicall: InnerOperation[], creditManager: Address, providedArgs: RWAOperationArgs, ctx: PrerequisiteContext): Prerequisite[];
-//#endregion
-export { buildRWAPrerequisites };

package/dist/types/preview/prerequisites/checkPrerequisites.d.ts

@@ -1,28 +0,0 @@
-import { SDKReturn } from "../../model/result.js";
-import "../../model/index.js";
-import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
-import { PluginsMap } from "../../onchain/plugins/types.js";
-import "../../onchain/index.js";
-import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "../parse/errors.js";
-import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
-import "../parse/index.js";
-import { PrerequisiteResult } from "./types.js";
-//#region src/preview/prerequisites/checkPrerequisites.d.ts
-/**
- * Derives and verifies the on-chain prerequisites for an operation given its
- * raw calldata: the conditions that must hold for the call not to revert and
- * that we can verify with the SDK (token approvals, wallet balances, RWA
- * open-account requirements).
- *
- * Each prerequisite performs its own reads and resolves into a
- * {@link PrerequisiteResult} (`satisfied` or `error`).
- *
- * Only *sender-actionable* prerequisites belong here: conditions the LP
- * provider or borrower can fix themselves before retrying (e.g. approve a
- * token, sign the RWA factory's messages). Non-actionable protocol/admin state
- * (e.g. pool is paused) is intentionally out of scope, since the user cannot
- * resolve it.
- */
-declare function checkPrerequisites<P extends PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<SDKReturn<PrerequisiteResult[], UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError>>;
-//#endregion
-export { checkPrerequisites };

package/dist/types/preview/prerequisites/helpers.d.ts

@@ -1,10 +0,0 @@
-import { Prerequisite } from "./Prerequisite.js";
-import { AllowanceDetail } from "./AllowancePrerequisite.js";
-//#region src/preview/prerequisites/helpers.d.ts
-/**
- * The most common prerequisite pair: `owner` must have approved `spender` for
- * `required` of `token` and must hold at least that much of it.
- */
-declare function allowanceAndBalance(props: Omit<AllowanceDetail, "actual">): Prerequisite[];
-//#endregion
-export { allowanceAndBalance };

package/dist/types/preview/prerequisites/index.d.ts

@@ -1,7 +0,0 @@
-import { BalanceDetail, BalancePrerequisite, BalanceResult } from "./BalancePrerequisite.js";
-import { RWAOpenRequirementsDetail, RWAOpenRequirementsPrerequisite, RWAOpenRequirementsResult } from "./RWAOpenRequirementsPrerequisite.js";
-import { PrerequisiteContext, PrerequisiteError, PrerequisiteKind, PrerequisiteOutcome, PrerequisiteResult } from "./types.js";
-import { Prerequisite } from "./Prerequisite.js";
-import { AllowanceDetail, AllowancePrerequisite, AllowanceResult } from "./AllowancePrerequisite.js";
-import { checkPrerequisites } from "./checkPrerequisites.js";
-export { AllowanceDetail, AllowancePrerequisite, AllowanceResult, BalanceDetail, BalancePrerequisite, BalanceResult, Prerequisite, PrerequisiteContext, PrerequisiteError, PrerequisiteKind, PrerequisiteOutcome, PrerequisiteResult, RWAOpenRequirementsDetail, RWAOpenRequirementsPrerequisite, RWAOpenRequirementsResult, checkPrerequisites };