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

package/dist/esm/preview/simulate/simulatePoolOpMulticall.js

@@ -1,130 +0,0 @@
-import { iPoolV310Abi } from "../../abi/310/generated.js";
-import { ierc20Abi } from "../../abi/iERC20.js";
-import { AddressMap } from "../../sdk/index.js";
-import { decodeSimulationError, PreviewSimulationError } from "./errors.js";
-import { watchedHolders } from "./holders.js";
-function previewRead(operation) {
-  switch (operation.operation) {
-    case "Deposit":
-      return { functionName: "previewDeposit", amount: operation.assets };
-    case "Mint":
-      return { functionName: "previewMint", amount: operation.shares };
-    case "Withdraw":
-      return { functionName: "previewWithdraw", amount: operation.assets };
-    case "Redeem":
-      return { functionName: "previewRedeem", amount: operation.shares };
-  }
-}
-async function simulatePoolOpMulticall(input, options = {}) {
-  const { sdk, operation, wallet } = input;
-  const { blockNumber } = options;
-  const { underlying, pool } = operation;
-  const holders = watchedHolders(operation, wallet);
-  const tokens = [underlying, pool];
-  const balanceCalls = holders.flatMap(
-    (holder) => tokens.map((token) => ({ holder, token }))
-  );
-  const balanceContracts = balanceCalls.map(
-    ({ holder, token }) => ({
-      address: token,
-      abi: ierc20Abi,
-      functionName: "balanceOf",
-      args: [holder]
-    })
-  );
-  const { functionName, amount } = previewRead(operation);
-  const previewContract = {
-    address: pool,
-    abi: iPoolV310Abi,
-    functionName,
-    args: [amount]
-  };
-  let results;
-  try {
-    results = await sdk.client.multicall({
-      allowFailure: false,
-      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
-      // testnet forks pinned to a specific block.
-      blockNumber,
-      contracts: [...balanceContracts, previewContract]
-    });
-  } catch (cause) {
-    throw new PreviewSimulationError([
-      {
-        source: "multicall",
-        detail: decodeSimulationError({
-          error: cause instanceof Error ? cause : new Error(String(cause))
-        })
-      }
-    ]);
-  }
-  const previewAmount = results[balanceContracts.length];
-  const balances = new AddressMap();
-  for (const [i, { holder, token }] of balanceCalls.entries()) {
-    const tokenBalances = balances.get(holder) ?? new AddressMap();
-    tokenBalances.upsert(token, results[i]);
-    balances.upsert(holder, tokenBalances);
-  }
-  const before = (token, holder) => balances.get(holder)?.get(token) ?? 0n;
-  return {
-    balanceChanges: computePoolOpBalanceChanges(
-      operation,
-      wallet,
-      previewAmount,
-      before
-    ),
-    transfers: void 0
-  };
-}
-function balanceLegs(operation, wallet, previewAmount) {
-  const { underlying, pool, receiver } = operation;
-  switch (operation.operation) {
-    case "Deposit":
-      return [
-        { address: wallet, token: underlying, delta: -operation.assets },
-        { address: receiver, token: pool, delta: previewAmount }
-      ];
-    case "Mint":
-      return [
-        { address: wallet, token: underlying, delta: -previewAmount },
-        { address: receiver, token: pool, delta: operation.shares }
-      ];
-    case "Withdraw":
-      return [
-        { address: operation.owner, token: pool, delta: -previewAmount },
-        { address: receiver, token: underlying, delta: operation.assets }
-      ];
-    case "Redeem":
-      return [
-        { address: operation.owner, token: pool, delta: -operation.shares },
-        { address: receiver, token: underlying, delta: previewAmount }
-      ];
-  }
-}
-function computePoolOpBalanceChanges(operation, wallet, previewAmount, before) {
-  const byAddress = new AddressMap();
-  for (const { address, token, delta } of balanceLegs(
-    operation,
-    wallet,
-    previewAmount
-  )) {
-    const beforeBalance = before(token, address);
-    const change = {
-      token,
-      before: beforeBalance,
-      after: beforeBalance + delta,
-      delta
-    };
-    const existing = byAddress.get(address);
-    if (existing) {
-      existing.changes.push(change);
-    } else {
-      byAddress.upsert(address, { address, changes: [change] });
-    }
-  }
-  return byAddress.values();
-}
-export {
-  computePoolOpBalanceChanges,
-  simulatePoolOpMulticall
-};

package/dist/esm/preview/simulate/simulatePoolOpV1.js

@@ -1,82 +0,0 @@
-import { simulateCalls } from "viem/actions";
-import { ierc20Abi } from "../../abi/iERC20.js";
-import { decodeSimulationError, PreviewSimulationError } from "./errors.js";
-import { extractERC20Transfers } from "./extractERC20Transfers.js";
-import { watchedHolders } from "./holders.js";
-async function simulatePoolOpV1(input, options = {}) {
-  const { sdk, operation, to, calldata, wallet } = input;
-  const { blockNumber } = options;
-  const { underlying, pool } = operation;
-  const holders = watchedHolders(operation, wallet);
-  const tokens = [underlying, pool];
-  const balanceOf = (token, holder) => ({
-    to: token,
-    abi: ierc20Abi,
-    functionName: "balanceOf",
-    args: [holder]
-  });
-  const balanceCalls = holders.flatMap(
-    (holder) => tokens.map((token) => balanceOf(token, holder))
-  );
-  let results;
-  try {
-    ({ results } = await simulateCalls(sdk.client, {
-      account: wallet,
-      // `undefined` lets viem simulate at `latest`; `blockNumber` is only set
-      // for testnet forks pinned to a specific block.
-      blockNumber,
-      calls: [...balanceCalls, { to, data: calldata }, ...balanceCalls]
-    }));
-  } catch (cause) {
-    throw new PreviewSimulationError([
-      {
-        source: "eth_simulateV1",
-        detail: decodeSimulationError({
-          error: cause instanceof Error ? cause : new Error(String(cause))
-        })
-      }
-    ]);
-  }
-  const sim = results;
-  const txIndex = balanceCalls.length;
-  const afterOffset = txIndex + 1;
-  const txResult = sim[txIndex];
-  if (!txResult || txResult.status === "failure") {
-    throw new PreviewSimulationError([
-      {
-        source: "eth_simulateV1",
-        detail: decodeSimulationError({
-          error: txResult?.error,
-          data: txResult?.data
-        })
-      }
-    ]);
-  }
-  const balanceChanges = [];
-  for (const [holderIndex, address] of holders.entries()) {
-    const changes = [];
-    for (const [tokenIndex, token] of tokens.entries()) {
-      const slot = holderIndex * tokens.length + tokenIndex;
-      const before = readBalance(sim[slot]);
-      const after = readBalance(sim[afterOffset + slot]);
-      const delta = after - before;
-      const magnitude = delta >= 0n ? delta : -delta;
-      if (magnitude > 1n) {
-        changes.push({ token, before, after, delta });
-      }
-    }
-    if (changes.length > 0) {
-      balanceChanges.push({ address, changes });
-    }
-  }
-  return {
-    transfers: extractERC20Transfers(txResult.logs ?? [], holders),
-    balanceChanges
-  };
-}
-function readBalance(result) {
-  return result?.status === "success" ? result.result : 0n;
-}
-export {
-  simulatePoolOpV1
-};

package/dist/esm/preview/simulate/simulatePoolOperation.js

@@ -1,41 +0,0 @@
-import { ETH_SIMULATE_V1_NETWORKS } from "./constants.js";
-import {
-  asPreviewSimulationError,
-  combinePreviewSimulationErrors
-} from "./errors.js";
-import { simulatePoolOpMulticall } from "./simulatePoolOpMulticall.js";
-import { simulatePoolOpV1 } from "./simulatePoolOpV1.js";
-async function simulatePoolOperation(input, options = {}) {
-  const { sdk } = input;
-  const { logger } = options;
-  const useSimulateV1 = options.useSimulateV1 ?? ETH_SIMULATE_V1_NETWORKS.has(sdk.networkType);
-  logger?.debug(
-    { wallet: input.wallet, to: input.to },
-    "simulating pool operation"
-  );
-  const [v1, multicall] = await Promise.allSettled([
-    useSimulateV1 ? simulatePoolOpV1(input, options) : void 0,
-    simulatePoolOpMulticall(input, options)
-  ]);
-  if (v1.status === "fulfilled" && v1.value) {
-    return { status: "success", ...v1.value };
-  }
-  if (multicall.status === "fulfilled") {
-    if (v1.status === "rejected") {
-      logger?.debug(
-        asPreviewSimulationError(v1.reason, "eth_simulateV1"),
-        "eth_simulateV1 flow failed; falling back to multicall result"
-      );
-    }
-    return { status: "success", ...multicall.value };
-  }
-  const error = combinePreviewSimulationErrors(
-    v1.status === "rejected" ? asPreviewSimulationError(v1.reason, "eth_simulateV1") : void 0,
-    asPreviewSimulationError(multicall.reason, "multicall")
-  );
-  logger?.error(error, "pool operation simulation failed");
-  return { status: "failure", error };
-}
-export {
-  simulatePoolOperation
-};

package/dist/esm/preview/trace/extractAdapterCallTraces.js

@@ -1,40 +0,0 @@
-import {
-  decodeAbiParameters,
-  isAddressEqual,
-  toFunctionSelector
-} from "viem";
-import {
-  resolveProtocolCall
-} from "../../common-utils/utils/trace.js";
-const WITHDRAW_PHANTOM_TOKEN_SELECTOR = toFunctionSelector(
-  "withdrawPhantomToken(address,uint256)"
-);
-const GET_PHANTOM_TOKEN_INFO_SELECTOR = toFunctionSelector(
-  "getPhantomTokenInfo()"
-);
-function isSynthesizedPhantomWithdrawal(siblings, index) {
-  const node = siblings[index];
-  if (node.type !== "CALL" || node.input.slice(0, 10).toLowerCase() !== WITHDRAW_PHANTOM_TOKEN_SELECTOR) {
-    return false;
-  }
-  const [token] = decodeAbiParameters(
-    [{ type: "address" }, { type: "uint256" }],
-    `0x${node.input.slice(10)}`
-  );
-  for (let i = 0; i < index; i++) {
-    const sib = siblings[i];
-    if (sib.type === "STATICCALL" && sib.input.slice(0, 10).toLowerCase() === GET_PHANTOM_TOKEN_INFO_SELECTOR && isAddressEqual(sib.to, token)) {
-      return true;
-    }
-  }
-  return false;
-}
-function extractAdapterCallTraces(facadeTrace) {
-  const subtraces = facadeTrace.calls ?? [];
-  return subtraces.filter(
-    (sub, index) => resolveProtocolCall(sub) !== void 0 && !isSynthesizedPhantomWithdrawal(subtraces, index)
-  );
-}
-export {
-  extractAdapterCallTraces
-};

package/dist/esm/preview/trace/index.js

@@ -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/common-utils/utils/trace.d.ts

@@ -1,73 +0,0 @@
-import { type Address, type Hex } from "viem";
-/**
- * A single frame from Ethereum's `debug_traceTransaction` callTracer output.
- * Recursive: each frame may contain nested sub-calls.
- */
-export interface CallTrace {
-    from: Address;
-    to: Address;
-    input: Hex;
-    output: Hex;
-    value: Hex;
-    /** "CALL", "DELEGATECALL", "STATICCALL", "CREATE", etc. */
-    type: string;
-    /** Present when the call reverted (e.g. "execution reverted"). */
-    error?: string;
-    /** ABI-encoded revert data, if available. */
-    revertReason?: Hex;
-    calls?: CallTrace[];
-}
-/**
- * Selector of `CreditManagerV3.execute(bytes)` (`0x09c5eabe`).
- *
- * This is the authoritative marker of an adapter performing an external
- * protocol call: the adapter calls the credit manager's `execute(bytes)`, which
- * forwards the calldata to the credit account, which in turn CALLs the target
- * (protocol) contract. Adapter approvals use a different selector
- * (`execute(address,bytes)` on the credit account), so matching on this
- * selector isolates the real protocol call.
- */
-export declare const EXECUTE_BYTES_SELECTOR: "0x09c5eabe";
-/**
- * Finds the shallowest non-reverted `CreditManager.execute(bytes)` call in a
- * trace subtree (breadth-first), or `undefined` if none exists.
- *
- * "Shallowest" matters for account migration: a migrate adapter nests the
- * entire target `openCreditAccount` multicall - including that account's own
- * `execute(bytes)` calls - inside its subtree. The shallowest match is the
- * adapter's own protocol call, not a nested one.
- */
-export declare function findExecuteBytes(node: CallTrace): CallTrace | undefined;
-/**
- * Finds the first non-reverted CALL in a subtree whose `input` exactly matches
- * `input` (case-insensitive). Used to locate the leaf CALL to the target
- * contract: `execute(bytes)` forwards the calldata unchanged through the credit
- * account proxy DELEGATECALL down to the final CALL to the protocol contract.
- */
-export declare function findCallWithInput(node: CallTrace, input: Hex): CallTrace | undefined;
-/**
- * Resolves the external protocol call performed by an adapter-level call trace.
- *
- * Locates the shallowest `CreditManager.execute(bytes)`, decodes the forwarded
- * calldata, then finds the leaf CALL whose input matches that calldata to
- * recover the target (protocol) contract address. Returns `undefined` when the
- * subtree does not actually reach an external protocol CALL (e.g. the
- * facade-internal `depositPhantomToken` / `withdrawPhantomToken` accounting
- * calls, which forward calldata but make no external CALL).
- *
- * @param node - direct child node of the upper-level facade call trace
- */
-export declare function resolveProtocolCall(node: CallTrace): {
-    contract: Address;
-    calldata: Hex;
-} | undefined;
-/**
- * Finds the first non-reverted CALL to `target` anywhere in a trace subtree.
- */
-export declare function findCallTo(node: CallTrace, target: Address): CallTrace | undefined;
-/**
- * DFS walk of the call trace tree, collecting non-reverted CALL entries
- * to the given address.
- * Does not recurse into children of matched nodes
- */
-export declare function collectTraces(node: CallTrace, target: Address): CallTrace[];

package/dist/types/dev/verifyTestnet.d.ts

@@ -1,82 +0,0 @@
-import type { Address, PublicClient } from "viem";
-/**
- * Address is stable, contract deployed via create2
- */
-export declare const ONCHAIN_EXECUTION_ID_ADDRESS: Address;
-/**
- * This contract is deployed on every Gearbox testnet and contains
- * execution id and alias of the testnet
- */
-export declare const iOnchainExecutionIdAbi: readonly [{
-    readonly type: "function";
-    readonly name: "deployer";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly name: "";
-        readonly type: "string";
-        readonly internalType: "string";
-    }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "executionId";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly name: "";
-        readonly type: "string";
-        readonly internalType: "string";
-    }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "forkAlias";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly name: "";
-        readonly type: "string";
-        readonly internalType: "string";
-    }];
-    readonly stateMutability: "view";
-}, {
-    readonly type: "function";
-    readonly name: "info";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly name: "";
-        readonly type: "tuple";
-        readonly internalType: "struct ExecutionId.Info";
-        readonly components: readonly [{
-            readonly name: "deployer";
-            readonly type: "string";
-            readonly internalType: "string";
-        }, {
-            readonly name: "executionId";
-            readonly type: "string";
-            readonly internalType: "string";
-        }, {
-            readonly name: "forkAlias";
-            readonly type: "string";
-            readonly internalType: "string";
-        }];
-    }];
-    readonly stateMutability: "view";
-}];
-export type VerifyTestnetParams = {
-    executionId: string;
-} | {
-    alias: string;
-} | {
-    executionId: string;
-    alias: string;
-};
-/**
- * Tries to read the contract that is deployed on every Gearbox testnet
- * and verify that we're on expected testnet.
- *
- * Used to check that wallet is using correct RPC for the testnet.
- *
- * @param client - Public client
- * @param expected - Expected tesnet alias or execution id
- * @returns True if we're on expected testnet
- */
-export declare function verifyTestnet(client: PublicClient, expected: VerifyTestnetParams): Promise<boolean>;

package/dist/types/plugins/adapters/transfers.d.ts

@@ -1,17 +0,0 @@
-import type { Address } from "viem";
-/**
- * A single ERC-20 Transfer event captured between Execute boundaries.
- *
- * Internal to `plugins/adapters` (kept here so {@link toNetTransfers} stays
- * typed) and intentionally **not** re-exported from the package barrel: the
- * canonical, public `TokenTransfer` lives in the `preview` module. The two are
- * structurally identical, so values flow between the modules without casts.
- *
- * @deprecated Will be deprecated when we get rid of classifyLegacyOperation
- */
-export interface TokenTransfer {
-    token: Address;
-    amount: bigint;
-    from: Address;
-    to: Address;
-}

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

@@ -1,4 +0,0 @@
-export * from "./parse/index.js";
-export * from "./prerequisites/index.js";
-export * from "./simulate/index.js";
-export * from "./trace/index.js";

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

@@ -1,21 +0,0 @@
-import type { Address } from "viem";
-import type { OnchainSDK, ParsedCallV2 } from "../../sdk/index.js";
-import type { InnerOperation } from "./types.js";
-export interface ClassifyInnerOperationsProps {
-    sdk: OnchainSDK;
-    /** Underlying token of the credit manager, used for debt operations. */
-    underlying: Address;
-}
-/**
- * Calldata-only counterpart of the SDK's `classifyMulticallOperations`.
- *
- * Maps each inner multicall entry to an {@link InnerOperation}:
- * - adapter and unknown targets become a pure-descriptor `Execute`
- *   {@link AdapterOperation};
- * - credit-facade self-calls map to the matching inner facade operation.
- *
- * Raw calldata has no execution trace, so the trace-derived adapter data
- * (`protocol`, `transfers`) and `legacy` are intentionally absent; they are only
- * recovered by trace-based flows (history, facade simulation).
- */
-export declare function classifyInnerOperations(calls: ParsedCallV2[], props: ClassifyInnerOperationsProps): InnerOperation[];

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

@@ -1,17 +0,0 @@
-import type { Address } from "viem";
-/**
- * Thrown when the target of a transaction is neither a known Gearbox pool nor a
- * credit facade.
- */
-export declare class UnsupportedTargetError extends Error {
-    readonly target: Address;
-    constructor(target: Address);
-}
-/**
- * Thrown when a pool call uses a function other than ERC4626 `deposit`/`redeem`.
- */
-export declare class UnsupportedPoolFunctionError extends Error {
-    readonly pool: Address;
-    readonly functionName: string;
-    constructor(pool: Address, functionName: string);
-}

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

@@ -1,22 +0,0 @@
-import type { ParsedCallV2 } from "../../sdk/index.js";
-import type { ExpectedBalanceChange } from "./types.js";
-/**
- * Recovers the potential balance changes declared by a router-generated
- * `storeExpectedBalances`/`compareBalances` pair inside a credit-facade
- * multicall.
- *
- * The detection is intentionally limited to the router shape:
- * - `onDemandPriceUpdates` calls are dropped first (they may only appear at the
- *   front of a multicall);
- * - the remaining calls must start with `storeExpectedBalances` and end with
- *   `compareBalances`.
- *
- * When the multicall does not match this shape, `undefined` is returned. On a
- * match, the `BalanceDelta[]` argument of `storeExpectedBalances` is decoded
- * into {@link ExpectedBalanceChange}[] (the `amount` is the signed `int256`
- * delta and may be negative).
- *
- * @param innerCalls - Raw (already-decoded) inner multicall calls.
- * @returns The declared balance changes, or `undefined` when not router-shaped.
- */
-export declare function extractExpectedBalanceChanges(innerCalls: ParsedCallV2[]): ExpectedBalanceChange[] | undefined;

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

@@ -1,7 +0,0 @@
-export * from "./classifyInnerOperations.js";
-export * from "./errors.js";
-export * from "./extractExpectedBalanceChanges.js";
-export * from "./parseFacadeOperationCalldata.js";
-export * from "./parseOperationCalldata.js";
-export * from "./parsePoolOperationCalldata.js";
-export * from "./types.js";

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

@@ -1,19 +0,0 @@
-import { type Hex } from "viem";
-import type { CreditFacadeV310Contract, OnchainSDK } from "../../sdk/index.js";
-import type { OuterFacadeOperation } from "./types.js";
-export interface ParseFacadeOperationCalldataProps {
-    sdk: OnchainSDK;
-    /** Resolved credit facade contract for the transaction target. */
-    facade: CreditFacadeV310Contract;
-    calldata: Hex;
-}
-/**
- * Decodes a credit-facade entry-point call into the matching
- * {@link OuterFacadeOperation}.
- *
- * Transaction-level metadata (`txHash`, `blockNumber`, `timestamp`) is not part
- * of the base `preview` operation: those values are only known once the
- * transaction is mined and are added in `history` mode. `creditAccount` is
- * `zeroAddress` for `openCreditAccount` (the address is assigned on-chain).
- */
-export declare function parseFacadeOperationCalldata(props: ParseFacadeOperationCalldataProps): OuterFacadeOperation;

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

@@ -1,23 +0,0 @@
-import type { Address, Hex } from "viem";
-import { type PluginsMap } from "../../sdk/index.js";
-import type { Operation, SdkWithAdapters } from "./types.js";
-export interface ParseOperationCalldataInput<P extends PluginsMap = PluginsMap> {
-    /**
-     * Already-attached SDK; chain, RPC and block are baked in at attach time.
-     * Must be created with the adapters plugin (enforced at compile time) so
-     * adapter contracts resolve during multicall classification.
-     */
-    sdk: SdkWithAdapters<P>;
-    to: Address;
-    calldata: Hex;
-    /** Transaction sender, contextual only. */
-    sender: Address;
-}
-/**
- * Decodes raw operation calldata into an {@link Operation}.
- *
- * Routes by the resolved contract at `to`: a pool yields a deposit/redeem
- * operation, a credit facade yields one facade operation. Anything else throws
- * {@link UnsupportedTargetError}.
- */
-export declare function parseOperationCalldata<P extends PluginsMap>(input: ParseOperationCalldataInput<P>): Operation;

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

@@ -1,17 +0,0 @@
-import type { Hex } from "viem";
-import type { OnchainSDK, PoolV310Contract } from "../../sdk/index.js";
-import type { PoolOperation } from "./types.js";
-export interface ParsePoolOperationCalldataProps {
-    sdk: OnchainSDK;
-    /** Resolved pool contract for the transaction target. */
-    pool: PoolV310Contract;
-    calldata: Hex;
-}
-/**
- * Decodes ERC4626 pool calldata into a {@link PoolOperation}. Supports every
- * deposit/mint/withdraw/redeem variant of `IPoolV3` (and the `IERC4626` base it
- * extends): `deposit`/`depositWithReferral`, `mint`/`mintWithReferral`,
- * `withdraw` and `redeem`. Any other selector throws
- * {@link UnsupportedPoolFunctionError}.
- */
-export declare function parsePoolOperationCalldata(props: ParsePoolOperationCalldataProps): PoolOperation;