@gearbox-protocol/sdk 14.11.0-next.9 → 14.11.0

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

@@ -1,11 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,79 +0,0 @@
-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/preview/trace/extractAdapterCallTraces.d.ts

@@ -1,23 +0,0 @@
-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/preview/trace/index.d.ts

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

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

@@ -1,21 +0,0 @@
-import type { Address } from "viem";
-import type { CallTrace } from "../../common-utils/utils/trace.js";
-import type { ParsedCallV2 } from "../../sdk/index.js";
-/**
- * The set of credit facade entry-point functions that produce history operations.
- */
-export type FacadeCallType = "MultiCall" | "BotMulticall" | "OpenCreditAccount" | "CloseCreditAccount" | "LiquidateCreditAccount" | "PartiallyLiquidateCreditAccount";
-/**
- * A parsed credit facade call extracted from a call trace,
- * with inner multicall calls already decoded.
- */
-export interface FacadeParsedCall {
-    operation: FacadeCallType;
-    creditAccount: Address;
-    /** The full ParsedCallV2 from facade calldata parsing. */
-    parsed: ParsedCallV2;
-    /** Inner multicall entries from rawArgs.calls (empty for partiallyLiquidateCreditAccount). */
-    innerCalls: ParsedCallV2[];
-    /** The full call trace node for this facade call (used to extract protocol-level calldata). */
-    trace: CallTrace;
-}