@gearbox-protocol/sdk 14.10.7 → 14.11.0-next.2

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

@@ -0,0 +1,30 @@
+import { type Address, type Hex } from "viem";
+import type { OnchainSDK } from "../../sdk/index.js";
+import type { PoolOperation } from "../parse/index.js";
+import type { PoolSimulationResult } from "./types.js";
+export interface SimulatePoolOperationInput {
+    /** Only `client` is 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/redeem calldata to simulate. */
+    calldata: Hex;
+    /** Wallet whose balance changes and transfers we track. */
+    wallet: Address;
+    /** Block to simulate at; defaults to latest. Only set for testnet forks. */
+    blockNumber?: bigint;
+}
+/**
+ * Simulates a pool deposit/redeem by sandwiching the raw calldata between
+ * `balanceOf(wallet)` reads of the underlying and pool (share) tokens.
+ *
+ * On success, returns the ERC-20 transfers emitted by the call that involve the
+ * wallet or the operation recipient (for merging into the parsed operation) and
+ * the balance changes grouped by watched address (wallet, plus the recipient
+ * when distinct); on revert, returns the decoded reason. Simulation runs against
+ * real chain state (no overrides), so an unmet prerequisite surfaces here as a
+ * failure.
+ */
+export declare function simulatePoolOperation(input: SimulatePoolOperationInput): Promise<PoolSimulationResult>;

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

@@ -0,0 +1,43 @@
+import type { Address } from "viem";
+import type { TokenTransfer } from "../../plugins/adapters/index.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[];
+}
+/** Decoded revert of the simulated transaction. */
+export interface SimulationError {
+    /** Human-readable revert reason / error name. */
+    reason: string;
+    /** Original error, kept for debugging. */
+    cause?: unknown;
+}
+/**
+ * Outcome of simulating a pool operation. On success it carries the
+ * wallet-filtered ERC-20 transfers (to merge into the parsed operation) and the
+ * balance changes grouped by watched address; on failure it carries the decoded
+ * revert reason.
+ */
+export type PoolSimulationResult = {
+    status: "success";
+    transfers: TokenTransfer[];
+    balanceChanges: AddressBalanceChanges[];
+    gasUsed: bigint;
+} | {
+    status: "failure";
+    error: SimulationError;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.10.7",
+  "version": "14.11.0-next.2",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {
@@ -44,6 +44,11 @@
       "import": "./dist/esm/permissionless/index.js",
       "default": "./dist/cjs/permissionless/index.js"
     },
+    "./preview": {
+      "types": "./dist/types/preview/index.d.ts",
+      "import": "./dist/esm/preview/index.js",
+      "default": "./dist/cjs/preview/index.js"
+    },
     "./common-utils": {
       "types": "./dist/types/common-utils/index.d.ts",
       "import": "./dist/esm/common-utils/index.js",