@gearbox-protocol/sdk 14.11.3 → 14.12.0-next.1

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

@@ -0,0 +1,24 @@
+import { type Address, type ContractFunctionParameters } from "viem";
+import { type MulticallCallResult, Prerequisite } from "./Prerequisite.js";
+import type { PrerequisiteDetail, PrerequisiteResult } from "./types.js";
+export interface AllowancePrerequisiteProps {
+    token: Address;
+    owner: Address;
+    spender: Address;
+    required: bigint;
+    title?: string;
+    id?: string;
+}
+/** Checks that `owner` granted `spender` an ERC-20 allowance >= `required`. */
+export declare class AllowancePrerequisite extends Prerequisite<"allowance"> {
+    private readonly _id;
+    private readonly _title;
+    private readonly _detail;
+    constructor(props: AllowancePrerequisiteProps);
+    get id(): string;
+    get kind(): "allowance";
+    get title(): string;
+    get detail(): PrerequisiteDetail<"allowance">;
+    calls(): ContractFunctionParameters[];
+    resolve(slice: MulticallCallResult[]): PrerequisiteResult<"allowance">;
+}

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

@@ -0,0 +1,23 @@
+import { type Address, type ContractFunctionParameters } from "viem";
+import { type MulticallCallResult, Prerequisite } from "./Prerequisite.js";
+import type { PrerequisiteDetail, PrerequisiteResult } from "./types.js";
+export interface BalancePrerequisiteProps {
+    token: Address;
+    owner: Address;
+    required: bigint;
+    title?: string;
+    id?: string;
+}
+/** Checks that `owner` holds an ERC-20 balance >= `required`. */
+export declare class BalancePrerequisite extends Prerequisite<"balance"> {
+    private readonly _id;
+    private readonly _title;
+    private readonly _detail;
+    constructor(props: BalancePrerequisiteProps);
+    get id(): string;
+    get kind(): "balance";
+    get title(): string;
+    get detail(): PrerequisiteDetail<"balance">;
+    calls(): ContractFunctionParameters[];
+    resolve(slice: MulticallCallResult[]): PrerequisiteResult<"balance">;
+}

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

@@ -0,0 +1,60 @@
+import { type ContractFunctionParameters } from "viem";
+import type { PrerequisiteContext, PrerequisiteDetail, PrerequisiteError, PrerequisiteKind, PrerequisiteResult } from "./types.js";
+/**
+ * One entry of a viem `multicall({ allowFailure: true })` response: either a
+ * decoded `result` or the `error` that the call reverted with.
+ */
+export type MulticallCallResult = {
+    status: "success";
+    result: unknown;
+    error?: undefined;
+} | {
+    status: "failure";
+    result?: undefined;
+    error: Error;
+};
+/**
+ * Decodes an unknown error into a {@link PrerequisiteError} with a
+ * human-readable revert reason. Mirrors the SDK's `extractCallError`: walk the
+ * viem error chain for a {@link ContractFunctionRevertedError} and use its
+ * `errorName`, otherwise fall back to the error's short message / name.
+ */
+export declare function toPrerequisiteError(cause: unknown): PrerequisiteError;
+/**
+ * A single verifiable prerequisite for a transaction. Subclasses describe the
+ * on-chain reads they need ({@link calls}) and how to turn the multicall slice
+ * into a {@link PrerequisiteResult} ({@link resolve}).
+ *
+ * Identity (`id`, `kind`, `title`) and build-time `detail` are exposed as
+ * read-only accessors; subclasses back them with private fields. The shared
+ * {@link satisfiedResult}/{@link errorResult} helpers are `protected` so each
+ * subclass builds results consistently.
+ *
+ * The same instance can be verified standalone via {@link verify} or batched
+ * together with others by `verifyPrerequisites`.
+ */
+export declare abstract class Prerequisite<K extends PrerequisiteKind> {
+    /** Stable identifier, used as a React key and for deduplication. */
+    abstract get id(): string;
+    /** Discriminant tying this check to its detail payload. */
+    abstract get kind(): K;
+    /** Human-readable label shown in the UI. */
+    abstract get title(): string;
+    /** Inputs known before reading the chain (no `actual` yet). */
+    abstract get detail(): PrerequisiteDetail<K>;
+    /** Contract reads this check needs (usually one). */
+    abstract calls(ctx: PrerequisiteContext): ContractFunctionParameters[];
+    /** Maps this check's slice of the multicall response into a result. */
+    abstract resolve(slice: MulticallCallResult[]): PrerequisiteResult<K>;
+    /**
+     * Verifies this prerequisite on its own using an `allowFailure` multicall.
+     * Prefer `verifyPrerequisites` to batch several checks into one round-trip.
+     */
+    verify(ctx: PrerequisiteContext): Promise<PrerequisiteResult<K>>;
+    /** Builds a successful result; `detail` carries the on-chain `actual`. */
+    protected satisfiedResult(satisfied: boolean, detail: PrerequisiteDetail<K>): PrerequisiteResult<K>;
+    /** Builds a failed result from a decoded read error. */
+    protected errorResult(error: PrerequisiteError): PrerequisiteResult<K>;
+}
+/** Any prerequisite regardless of its kind, used for heterogeneous lists. */
+export type AnyPrerequisite = Prerequisite<PrerequisiteKind>;

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

@@ -0,0 +1,16 @@
+import type { Operation } from "../parse/index.js";
+import type { AnyPrerequisite } from "./Prerequisite.js";
+import type { PrerequisiteContext } from "./types.js";
+/**
+ * Derives the on-chain prerequisites for a parsed operation: the conditions
+ * that must hold for the call not to revert and that we can verify with the
+ * SDK (token approvals, wallet balances).
+ *
+ * Only *sender-actionable* prerequisites belong here: conditions the LP
+ * provider or borrower can fix themselves before retrying (e.g. approve a
+ * token, top up a balance). Non-actionable protocol/admin state (pool pause,
+ * available pool liquidity, health factor, liquidatability, degen NFT gating,
+ * bot permissions) is intentionally out of scope, since the user cannot
+ * resolve it. New {@link AnyPrerequisite} subclasses must follow the same rule.
+ */
+export declare function buildPrerequisites(tx: Operation, ctx: PrerequisiteContext): AnyPrerequisite[];

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

@@ -0,0 +1,7 @@
+export * from "./AllowancePrerequisite.js";
+export * from "./BalancePrerequisite.js";
+export * from "./buildPrerequisites.js";
+export * from "./Prerequisite.js";
+export * from "./prepareAction.js";
+export * from "./runPrerequisites.js";
+export * from "./types.js";

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

@@ -0,0 +1,52 @@
+import { type Address, type Hex } from "viem";
+import type { AnyPrerequisiteResult } from "./types.js";
+/**
+ * A single transaction that satisfies a sender-actionable prerequisite.
+ *
+ * The shape is intentionally minimal (`to`/`data`/optional `value`) so it maps
+ * directly onto wallet send primitives (e.g. viem `sendTransaction`, wagmi
+ * `useSendTransaction`/`useWriteContract`). It is deliberately *not* the heavier
+ * {@link import("../../sdk/types/transactions.js").RawTx} used for Safe batches.
+ *
+ * The `kind` mirrors the prerequisite kind it remediates, so consumers can label
+ * the action (e.g. "Approve") without re-deriving it.
+ */
+export interface PrerequisiteAction {
+    /** Prerequisite kind this action remediates. */
+    kind: "allowance";
+    /** Contract the transaction is sent to (the ERC-20 token for allowances). */
+    to: Address;
+    /** Encoded calldata (e.g. `approve(spender, required)`). */
+    data: Hex;
+    /** Native value to send; omitted (treated as 0) for ERC-20 approvals. */
+    value?: bigint;
+}
+/**
+ * Builds the transaction that resolves an unsatisfied, sender-actionable
+ * prerequisite, or returns `null` when the prerequisite cannot be fixed with a
+ * single wallet transaction.
+ *
+ * Currently only `allowance` is actionable: it returns an ERC-20
+ * `approve(spender, required)` for the exact required amount. `balance`
+ * shortfalls (the user must acquire/free up funds) and errored reads are not
+ * actionable and return `null`. New actionable kinds (permits, native unwrap,
+ * approve-reset-to-zero for non-standard tokens, ...) should be encoded here so
+ * consumers do not have to special-case them.
+ *
+ * Operates on the serializable {@link AnyPrerequisiteResult} produced by
+ * `verifyPrerequisites` (not on {@link import("./Prerequisite.js").Prerequisite}
+ * instances), so it works against cached/persisted results.
+ *
+ * @param result - A verified prerequisite result.
+ * @returns The remediation transaction, or `null` if not auto-actionable.
+ */
+export declare function preparePrerequisiteAction(result: AnyPrerequisiteResult): PrerequisiteAction | null;
+/**
+ * Whether a prerequisite result represents something the sender can fix with a
+ * single wallet transaction (i.e. {@link preparePrerequisiteAction} returns a
+ * transaction for it).
+ *
+ * Useful for UIs that distinguish "approve to continue" (actionable) from hard
+ * blocks like an insufficient balance (not actionable).
+ */
+export declare function isActionablePrerequisite(result: AnyPrerequisiteResult): boolean;

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

@@ -0,0 +1,12 @@
+import type { AnyPrerequisite } from "./Prerequisite.js";
+import type { AnyPrerequisiteResult, PrerequisiteContext } from "./types.js";
+/**
+ * Verifies all prerequisites in a single resilient multicall.
+ *
+ * Every prereq contributes its reads to one `multicall({ allowFailure: true })`
+ * batch, then resolves its own slice of the response. A read that reverts
+ * isolates to that prerequisite (an `error` result) without affecting the
+ * others; if the whole round-trip fails (RPC/network), every prerequisite
+ * resolves to an `error` carrying that reason.
+ */
+export declare function verifyPrerequisites(prereqs: AnyPrerequisite[], ctx: PrerequisiteContext): Promise<AnyPrerequisiteResult[]>;

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

@@ -0,0 +1,78 @@
+import type { Address } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+/**
+ * Extension point that ties each prerequisite kind to its detail payload.
+ *
+ * Adding a new prerequisite kind only requires a new entry here: the generic
+ * machinery below and the UI renderer registry both key off this map, so TS
+ * forces every consumer to handle the new kind.
+ *
+ * IMPORTANT: only add prerequisites that are *actionable by the transaction
+ * sender* (the LP provider or borrower). A valid prerequisite is one the user
+ * can resolve themselves before retrying, e.g. approve a token (`allowance`)
+ * or acquire/free up funds (`balance`). Do NOT add protocol- or admin-level
+ * state the user cannot change, such as pool pause status or available pool
+ * liquidity; those are not actionable and must not be listed as prerequisites.
+ */
+export interface PrerequisiteDetailMap {
+    /** ERC-20 allowance from `owner` to `spender` must cover `required`. */
+    allowance: {
+        token: Address;
+        owner: Address;
+        spender: Address;
+        required: bigint;
+        /** On-chain allowance read; only present when the read succeeded. */
+        actual?: bigint;
+    };
+    /** ERC-20 balance of `owner` must cover `required`. */
+    balance: {
+        token: Address;
+        owner: Address;
+        required: bigint;
+        /** On-chain balance read; only present when the read succeeded. */
+        actual?: bigint;
+    };
+}
+export type PrerequisiteKind = keyof PrerequisiteDetailMap;
+export type PrerequisiteDetail<K extends PrerequisiteKind = PrerequisiteKind> = PrerequisiteDetailMap[K];
+/** Failure of the underlying on-chain read (revert, decode error, RPC error). */
+export interface PrerequisiteError {
+    /** Decoded revert reason / error name, human-readable. */
+    reason: string;
+    /** Original error, kept for debugging. */
+    cause?: unknown;
+}
+export interface PrerequisiteBase<K extends PrerequisiteKind> {
+    id: string;
+    kind: K;
+    title: string;
+    detail: PrerequisiteDetail<K>;
+}
+/**
+ * Outcome of verifying a single prerequisite: either the read succeeded (a
+ * `satisfied` boolean) or it reverted/failed (an `error` with the revert
+ * reason). The two variants are mutually exclusive.
+ */
+export type PrerequisiteResult<K extends PrerequisiteKind = PrerequisiteKind> = PrerequisiteBase<K> & ({
+    satisfied: boolean;
+    error?: undefined;
+} | {
+    satisfied?: undefined;
+    error: PrerequisiteError;
+});
+/**
+ * Discriminated union over every prerequisite kind. Switching on `kind`
+ * narrows `detail` to the matching payload, so React components can render
+ * kind-specific details with full type safety.
+ */
+export type AnyPrerequisiteResult = {
+    [K in PrerequisiteKind]: PrerequisiteResult<K>;
+}[PrerequisiteKind];
+/** Shared inputs for building and verifying prerequisites. */
+export interface PrerequisiteContext {
+    sdk: OnchainSDK;
+    /** Address whose balances/allowances are checked (the tx sender). */
+    wallet: Address;
+    /** Block to read at; defaults to latest. Only set for testnet forks. */
+    blockNumber?: bigint;
+}

package/dist/types/preview/simulate/constants.d.ts

@@ -0,0 +1,6 @@
+import type { NetworkType } from "../../sdk/chain/index.js";
+/**
+ * Networks where the `eth_simulateV1` JSON-RPC method is available and usable
+ * for pool or credit account operation simulation.
+ **/
+export declare const ETH_SIMULATE_V1_NETWORKS: ReadonlySet<NetworkType>;

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

@@ -0,0 +1,51 @@
+import { BaseError, type Hex } from "viem";
+/** Which simulation flow produced a failure. */
+export type SimulationFlowSource = "eth_simulateV1" | "multicall" | "unknown";
+/** A single flow failure with its decoded revert detail. */
+export interface SimulationFlowFailure {
+    source: SimulationFlowSource;
+    detail: SimulationError;
+}
+/**
+ * Error returned by the pool simulation when all attempted flows fail.
+ *
+ * On a single-flow failure it wraps that flow's decoded revert reason; when both
+ * the `eth_simulateV1` and multicall flows fail, it carries the details of both
+ * (see {@link failures}).
+ */
+export declare class PreviewSimulationError extends BaseError {
+    name: string;
+    /** Per-flow decoded failures behind this error. */
+    readonly failures: SimulationFlowFailure[];
+    constructor(failures: SimulationFlowFailure[]);
+}
+/**
+ * Normalises an unknown rejection reason into a {@link PreviewSimulationError}.
+ * Pass-through when it already is one; otherwise decodes it under `source`.
+ */
+export declare function asPreviewSimulationError(reason: unknown, source: SimulationFlowSource): PreviewSimulationError;
+/** Merges several {@link PreviewSimulationError}s into one carrying all failures. */
+export declare function combinePreviewSimulationErrors(...errors: (PreviewSimulationError | undefined)[]): PreviewSimulationError;
+/** Decoded revert of the simulated transaction. */
+export interface SimulationError {
+    /** Human-readable revert reason / error name. */
+    reason: string;
+    /** Original error, kept for debugging. */
+    cause?: unknown;
+}
+/** Per-call slice of a `simulateCalls` failure we need to decode. */
+export interface SimulationRevert {
+    error?: Error;
+    /** Raw revert return data, when present. */
+    data?: Hex;
+}
+/**
+ * Decodes a simulated transaction revert into a {@link SimulationError}.
+ *
+ * The simulated call is raw calldata (no ABI), so viem cannot decode the revert
+ * itself. We first try to decode the raw return bytes against the SDK's
+ * {@link errorAbis} (Gearbox protocol exceptions plus standard ERC-20 custom
+ * errors); failing that, we walk viem's error chain for a
+ * {@link ContractFunctionRevertedError} (covers `Error(string)` / `Panic`).
+ */
+export declare function decodeSimulationError(revert: SimulationRevert): SimulationError;

package/dist/types/preview/simulate/extractERC20Transfers.d.ts

@@ -0,0 +1,11 @@
+import { type Address, type Log } from "viem";
+import type { TokenTransfer } from "../parse/index.js";
+/**
+ * Parses ERC-20 `Transfer` logs and keeps only those involving one of the
+ * watched addresses (as sender or receiver). A log that touches several watched
+ * addresses is still emitted once.
+ *
+ * @param logs - raw logs from the simulated call
+ * @param watch - addresses whose transfers we care about (e.g. wallet + recipient)
+ */
+export declare function extractERC20Transfers(logs: Log[], watch: Address[]): TokenTransfer[];

package/dist/types/preview/simulate/holders.d.ts

@@ -0,0 +1,7 @@
+import type { Address } from "viem";
+import type { PoolOperation } from "../parse/index.js";
+/**
+ * Distinct addresses whose balances change during the operation: the funds
+ * source (payer or share owner) and the receiver.
+ */
+export declare function watchedHolders(operation: PoolOperation, wallet: Address): Address[];

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

@@ -0,0 +1,9 @@
+export { ETH_SIMULATE_V1_NETWORKS } from "./constants.js";
+export type { SimulationError, SimulationFlowFailure, SimulationFlowSource, } from "./errors.js";
+export { PreviewSimulationError } from "./errors.js";
+export type { SimulateFacadeOperationInput } from "./simulateFacadeOperation.js";
+export { simulateFacadeOperation } from "./simulateFacadeOperation.js";
+export type { SimulateOperationInput } from "./simulateOperation.js";
+export { simulateOperation } from "./simulateOperation.js";
+export { simulatePoolOperation } from "./simulatePoolOperation.js";
+export type { AddressBalanceChanges, OperationSimulationOptions, PoolOperationSimulation, PoolOperationSimulationInput, PoolOperationSimulationResult, TokenBalanceChange, } from "./types.js";

package/dist/types/preview/simulate/simulateFacadeOperation.d.ts

@@ -0,0 +1,25 @@
+import type { Address, Hex } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+import type { OuterFacadeOperation } from "../parse/index.js";
+import type { OperationSimulationOptions, PoolOperationSimulation } from "./types.js";
+export interface SimulateFacadeOperationInput {
+    /** Only `client`/`networkType` are used, so any OnchainSDK works. */
+    sdk: OnchainSDK;
+    /** Parsed credit-facade operation to simulate. */
+    operation: OuterFacadeOperation;
+    /** Target contract the calldata is sent to (the credit facade). */
+    to: Address;
+    /** Raw credit-facade calldata to simulate. */
+    calldata: Hex;
+    /** Wallet whose balance changes and transfers we track. */
+    wallet: Address;
+}
+/**
+ * Simulates a credit-facade operation.
+ *
+ * Not yet implemented: credit-facade simulation requires multicall-aware
+ * balance/transfer accounting that the pool simulation does not cover. The
+ * signature mirrors {@link simulatePoolOperation} so the
+ * {@link simulateOperation} wrapper can delegate uniformly once implemented.
+ */
+export declare function simulateFacadeOperation(_input: SimulateFacadeOperationInput, _options?: OperationSimulationOptions): Promise<PoolOperationSimulation>;

package/dist/types/preview/simulate/simulateOperation.d.ts

@@ -0,0 +1,20 @@
+import type { Address, Hex } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+import { type Operation } from "../parse/index.js";
+import type { OperationSimulationOptions, PoolOperationSimulation } from "./types.js";
+export interface SimulateOperationInput {
+    /** Gearbox SDK instance. */
+    sdk: OnchainSDK;
+    /** Parsed pool or credit account operation */
+    operation: Operation;
+    /** Target contract the calldata is sent to. */
+    to: Address;
+    /** Raw operation calldata to simulate. */
+    calldata: Hex;
+    /** Wallet whose balance changes and transfers we track. */
+    wallet: Address;
+}
+/**
+ * Simulates a parsed pool or credit account operation {@link Operation}
+ */
+export declare function simulateOperation(input: SimulateOperationInput, options?: OperationSimulationOptions): Promise<PoolOperationSimulation>;

package/dist/types/preview/simulate/simulatePoolOpMulticall.d.ts

@@ -0,0 +1,28 @@
+import type { Address } from "viem";
+import type { PoolOperation } from "../parse/index.js";
+import type { AddressBalanceChanges, OperationSimulationOptions, PoolOperationSimulationInput, PoolOperationSimulationResult } from "./types.js";
+/** Reads a watched holder's "before" balance of a token. */
+export type BalanceLookup = (token: Address, holder: Address) => bigint;
+/**
+ * Multicall pool-operation flow, used where `eth_simulateV1` is unavailable or
+ * as a fallback alongside it.
+ *
+ * Reads the watched holders' "before" balances together with the matching
+ * ERC4626 preview (`previewDeposit`/`previewMint`/`previewWithdraw`/
+ * `previewRedeem`) in a single multicall, then computes the theoretical balance
+ * changes via {@link computePoolOpBalanceChanges}.
+ *
+ * Unlike the `eth_simulateV1` flow it does not execute the calldata, so it
+ * cannot recover ERC-20 transfers (`transfers` is always `undefined`) and it
+ * ignores balance/allowance prerequisites (preview reads succeed regardless).
+ *
+ * @throws {@link PreviewSimulationError} when the multicall round-trip throws or
+ * any call (a balance read or the preview read) reverts.
+ */
+export declare function simulatePoolOpMulticall(input: PoolOperationSimulationInput, options?: OperationSimulationOptions): Promise<PoolOperationSimulationResult>;
+/**
+ * Pure computation of {@link AddressBalanceChanges} for a pool operation from
+ * its ERC4626 preview result and the watched holders' "before" balances. Legs
+ * sharing the same address are grouped together.
+ */
+export declare function computePoolOpBalanceChanges(operation: PoolOperation, wallet: Address, previewAmount: bigint, before: BalanceLookup): AddressBalanceChanges[];

package/dist/types/preview/simulate/simulatePoolOpV1.d.ts

@@ -0,0 +1,14 @@
+import type { OperationSimulationOptions, PoolOperationSimulationInput, PoolOperationSimulationResult } from "./types.js";
+/**
+ * `eth_simulateV1` pool-operation flow.
+ *
+ * Sandwiches the raw calldata between `balanceOf` reads of the underlying and
+ * pool (share) tokens for every watched holder, then derives the balance changes
+ * from the before/after diff and the wallet-relevant ERC-20 transfers from the
+ * emitted logs. Simulation runs against real chain state (no overrides), so an
+ * unmet prerequisite surfaces here as a revert.
+ *
+ * @throws {@link PreviewSimulationError} when the round-trip throws or the
+ * simulated transaction reverts.
+ */
+export declare function simulatePoolOpV1(input: PoolOperationSimulationInput, options?: OperationSimulationOptions): Promise<PoolOperationSimulationResult>;

package/dist/types/preview/simulate/simulatePoolOperation.d.ts

@@ -0,0 +1,8 @@
+import type { OperationSimulationOptions, PoolOperationSimulation, PoolOperationSimulationInput } from "./types.js";
+/**
+ * Simulates a pool deposit/mint/withdraw/redeem and returns the resulting
+ * balance changes (and, when available, ERC-20 transfers), or a decoded failure.
+ *
+ * @throws {@link PreviewSimulationError} when the simulation fails.
+ */
+export declare function simulatePoolOperation(input: PoolOperationSimulationInput, options?: OperationSimulationOptions): Promise<PoolOperationSimulation>;

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

@@ -0,0 +1,79 @@
+import type { Address, Hex } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+import type { ILogger } from "../../sdk/types/logger.js";
+import type { PoolOperation, TokenTransfer } from "../parse/index.js";
+import type { PreviewSimulationError } from "./errors.js";
+/**
+ * Change in an address's balance of a single token over the simulated call.
+ * `delta` is `after - before` (negative when the address spent the token).
+ */
+export interface TokenBalanceChange {
+    token: Address;
+    before: bigint;
+    after: bigint;
+    delta: bigint;
+}
+/**
+ * Balance changes for a single watched address (e.g. the wallet or the
+ * operation recipient). Keyed purely by address; UI labeling is resolved
+ * separately by the presentation layer.
+ */
+export interface AddressBalanceChanges {
+    address: Address;
+    changes: TokenBalanceChange[];
+}
+export interface PoolOperationSimulationInput {
+    /** Only `client`/`networkType` are used, so any OnchainSDK works. */
+    sdk: OnchainSDK;
+    /** Parsed operation, used to resolve the underlying and pool tokens. */
+    operation: PoolOperation;
+    /** Target contract the calldata is sent to (the pool). */
+    to: Address;
+    /** Raw deposit/mint/withdraw/redeem calldata to simulate. */
+    calldata: Hex;
+    /** Wallet whose balance changes and transfers we track. */
+    wallet: Address;
+}
+export interface OperationSimulationOptions {
+    /** Block to simulate at; defaults to latest. */
+    blockNumber?: bigint;
+    /**
+     * Whether to run the `eth_simulateV1` flow (preferred, recovers transfers).
+     * When `undefined`, defaults to whether the SDK's network is in
+     * {@link ETH_SIMULATE_V1_NETWORKS}.
+     */
+    useSimulateV1?: boolean;
+    /**
+     * Optional logger.
+     **/
+    logger?: ILogger;
+}
+/**
+ * Successful simulation of a pool operation: the balance changes grouped by
+ * watched address and, when available, the wallet-filtered ERC-20 transfers.
+ * This is the success payload of {@link PoolOperationSimulation} without the
+ * `status` discriminant.
+ */
+export interface PoolOperationSimulationResult {
+    /**
+     * Balance changes grouped by watched address (wallet, recipient, owner).
+     **/
+    balanceChanges: AddressBalanceChanges[];
+    /**
+     * ERC-20 transfers involving the watched addresses.
+     *
+     * NOTE: transfers are **not guaranteed** to be returned.
+     */
+    transfers?: TokenTransfer[];
+}
+/**
+ * Outcome of simulating a pool operation. On success it carries a
+ * {@link PoolOperationSimulationResult}; on failure it carries a
+ * {@link PreviewSimulationError}.
+ */
+export type PoolOperationSimulation = ({
+    status: "success";
+} & PoolOperationSimulationResult) | {
+    status: "failure";
+    error: PreviewSimulationError;
+};

package/dist/types/{history → preview/trace}/errors.d.ts

@@ -9,16 +9,6 @@ export declare class TransferAlignmentError extends Error {
 export declare class WithdrawCollateralAlignmentError extends Error {
     constructor(expected: number, actual: number);
 }
-export declare class ProtocolCallNotFoundError extends Error {
-    readonly targetContract: Address;
-    readonly executeIndex: number;
-    constructor(targetContract: Address, executeIndex: number);
-}
-export declare class AdapterTraceAlignmentError extends Error {
-    readonly expected: number;
-    readonly actual: number;
-    constructor(expected: number, actual: number);
-}
 export declare class UnexpectedFacadeEventOrderError extends Error {
     constructor(e: {
         eventName: string;

package/dist/types/preview/trace/extractAdapterCallTraces.d.ts

@@ -0,0 +1,23 @@
+import { type CallTrace } from "../../common-utils/utils/trace.js";
+/**
+ * Extracts the user multicall's adapter-level call traces from a single facade
+ * call trace.
+ *
+ * Returns the direct children of the facade trace that perform an external
+ * protocol call (their subtree resolves to a `CreditManager.execute(bytes)`
+ * that reaches a leaf CALL to a target contract), in trace order.
+ *
+ * Scoping to direct children of the facade trace (rather than flattening the
+ * whole subtree) avoids over-counting in nested credit-manager scenarios such
+ * as account migration, where a single migrate-adapter subtree nests another
+ * account's `execute(bytes)` calls.
+ *
+ * Facade-synthesized phantom-token withdrawals are excluded: while processing
+ * `withdrawCollateral` on a phantom token the facade issues its own
+ * `withdrawPhantomToken` adapter call, which also reaches an external target
+ * but does not correspond to a user multicall inner call. These are detected
+ * via the preceding `getPhantomTokenInfo()` probe (see
+ * {@link isSynthesizedPhantomWithdrawal}), so the returned traces line up 1:1,
+ * in order, with the multicall's adapter inner calls.
+ */
+export declare function extractAdapterCallTraces(facadeTrace: CallTrace): CallTrace[];

package/dist/types/{history → preview/trace}/extractTransfers.d.ts

@@ -1,7 +1,6 @@
 import { type Address, type Log } from "viem";
-import { AddressMap } from "../sdk/index.js";
-import type { ExecuteResult } from "./internal-types.js";
-import type { DirectTransferInfo } from "./types.js";
+import { AddressMap } from "../../sdk/index.js";
+import type { TokenTransfer } from "../parse/index.js";
 type RawLog = Log<bigint | number, number, false>;
 /**
  * Effective `withdrawCollateral` outcome decoded from the facade's
@@ -26,8 +25,18 @@ export interface WithdrawCollateralEventInfo {
  * @param creditAccount - the credit account address to track
  */
 export interface ExtractTransfersResult {
-    executeResults: ExecuteResult[];
-    directTransfers: DirectTransferInfo[];
+    /**
+     * ERC-20 transfers grouped per facade `Execute` event, one inner array per
+     * Execute event across the whole transaction, in emission order. Each inner
+     * array holds the transfers to/from the credit account that occurred between
+     * that Execute boundary and the previous one.
+     */
+    executeTransfers: TokenTransfer[][];
+    /**
+     * ERC-20 transfers that are not part of a facade `Execute` event and are
+     * direct incoming transfers to the credit account.
+     */
+    directTransfers: TokenTransfer[];
     liquidationRemainingFunds?: bigint;
     /** Maps phantom token address to its deposited (underlying) token address. */
     phantomTokens: AddressMap<Address>;

package/dist/types/{history → preview/trace}/findFacadeCalls.d.ts

@@ -1,6 +1,7 @@
 import { type Address } from "viem";
-import type { ChainContractsRegister } from "../sdk/index.js";
-import type { CallTrace, FacadeParsedCall } from "./internal-types.js";
+import { type CallTrace } from "../../common-utils/utils/trace.js";
+import type { ChainContractsRegister } from "../../sdk/index.js";
+import type { FacadeParsedCall } from "./types.js";
 /**
  * Walks a `debug_traceTransaction` callTracer tree, finds all non-reverted
  * calls to the credit facade, parses them via the register, and returns

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

@@ -0,0 +1,5 @@
+export * from "./errors.js";
+export * from "./extractAdapterCallTraces.js";
+export * from "./extractTransfers.js";
+export * from "./findFacadeCalls.js";
+export * from "./types.js";