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

package/dist/types/sdk/pools/types.d.ts

@@ -1,5 +1,5 @@
 import type { Abi, Address, ContractFunctionArgs, ContractFunctionName } from "viem";
-import type { Zapper } from "../market/index.js";
+import type { IZapperContract } from "../market/index.js";
 import type { Asset } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/transactions.js";
 interface PermitResult {
@@ -62,7 +62,7 @@ export interface DepositMetadata {
     /**
      * Zapper that will perform the deposit, undefined in case of direct pool underlying deposit
      */
-    zapper?: Zapper;
+    zapper?: IZapperContract;
     /**
      * Before deposit user will nedd to call approve method on token that he wants to deposit,
      * this is the spender address that will be used to call approve method.
@@ -82,7 +82,7 @@ export interface WithdrawalMetadata {
     /**
      * Zapper that will perform the withdrawal, undefined in case of direct pool underlying withdrawal
      */
-    zapper?: Zapper;
+    zapper?: IZapperContract;
     /**
      * Before withdrawal user will need to call approve method on token that he wants to withdraw (diesel token),
      * this is the spender address that will be used to call approve method.

package/dist/types/sdk/types/state-human.d.ts

@@ -193,6 +193,14 @@ export interface MarketStateHuman {
     unpausableAdmins: string[];
     emergencyLiquidators: string[];
 }
+export interface ZapperStateHuman {
+    address: string;
+    contractType: string;
+    type: "migration" | "rwa" | "base";
+    pool: string;
+    tokenIn: string;
+    tokenOut: string;
+}
 export interface GearboxStateHuman {
     network: string;
     block: number;
@@ -202,6 +210,7 @@ export interface GearboxStateHuman {
     plugins: Record<string, unknown>;
     tokens: TokenMetaData[];
     rwa: RWAStateHuman;
+    zappers?: ZapperStateHuman[];
 }
 /**
  * Human-readable state for all chains managed by {@link MultichainSDK}.

package/dist/types/sdk/types/state.d.ts

@@ -1,6 +1,7 @@
 import type { MarketData } from "../base/index.js";
 import type { NetworkType } from "../chain/chains.js";
 import type { AddressProviderState } from "../core/index.js";
+import type { ZapperData } from "../market/index.js";
 import type { RWAState } from "../market/rwa/index.js";
 import type { PluginStatesMap, PluginsMap } from "../plugins/index.js";
 /**
@@ -45,6 +46,12 @@ export interface GearboxState<Plugins extends PluginsMap = {}> {
      * RWA compressor state snapshot, if RWA factories were loaded.
      **/
     rwa?: RWAState;
+    /**
+     * All loaded zappers, keyed implicitly by their `pool` field.
+     *
+     * Present only when zappers were loaded (they are optional)
+     **/
+    zappers?: ZapperData[];
     /**
      * Per-plugin serialised state.
      **/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.1",
+  "version": "14.12.0-next.2",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {
@@ -67,13 +67,13 @@
     "clean": "rm -rf dist",
     "build": "tsup",
     "dev": "tsup --watch",
-    "example": "tsx --env-file .env scripts/example.ts | pino-pretty",
+    "example": "tsx scripts/example.ts | pino-pretty",
     "test:watch": "vitest --project unit",
     "test:unit": "vitest run --project unit",
     "test:e2e": "vitest run --project e2e",
     "test:all": "vitest run",
     "test": "vitest run",
-    "generate:e2e": "NODE_OPTIONS='--max-old-space-size=8192' tsx --env-file .env scripts/generate-e2e-fixtures.ts",
+    "generate:e2e": "NODE_OPTIONS='--max-old-space-size=8192' tsx scripts/generate-e2e-fixtures.ts",
     "prepare": "husky",
     "check": "biome check --write",
     "check:ci": "biome check --diagnostic-level=error",

package/dist/cjs/preview/simulate/extractERC20Transfers.js

@@ -1,47 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var extractERC20Transfers_exports = {};
-__export(extractERC20Transfers_exports, {
-  extractERC20Transfers: () => extractERC20Transfers
-});
-module.exports = __toCommonJS(extractERC20Transfers_exports);
-var import_viem = require("viem");
-var import_iERC20 = require("../../abi/iERC20.js");
-function extractERC20Transfers(logs, watch) {
-  const parsed = (0, import_viem.parseEventLogs)({
-    abi: import_iERC20.ierc20Abi,
-    eventName: "Transfer",
-    logs
-  });
-  const transfers = [];
-  for (const log of parsed) {
-    const { from, to, value } = log.args;
-    const involved = watch.some(
-      (address) => (0, import_viem.isAddressEqual)(from, address) || (0, import_viem.isAddressEqual)(to, address)
-    );
-    if (involved) {
-      transfers.push({ token: log.address, amount: value, from, to });
-    }
-  }
-  return transfers;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  extractERC20Transfers
-});

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

@@ -1,155 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var simulatePoolOpMulticall_exports = {};
-__export(simulatePoolOpMulticall_exports, {
-  computePoolOpBalanceChanges: () => computePoolOpBalanceChanges,
-  simulatePoolOpMulticall: () => simulatePoolOpMulticall
-});
-module.exports = __toCommonJS(simulatePoolOpMulticall_exports);
-var import_generated = require("../../abi/310/generated.js");
-var import_iERC20 = require("../../abi/iERC20.js");
-var import_sdk = require("../../sdk/index.js");
-var import_errors = require("./errors.js");
-var import_holders = require("./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 = (0, import_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: import_iERC20.ierc20Abi,
-      functionName: "balanceOf",
-      args: [holder]
-    })
-  );
-  const { functionName, amount } = previewRead(operation);
-  const previewContract = {
-    address: pool,
-    abi: import_generated.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 import_errors.PreviewSimulationError([
-      {
-        source: "multicall",
-        detail: (0, import_errors.decodeSimulationError)({
-          error: cause instanceof Error ? cause : new Error(String(cause))
-        })
-      }
-    ]);
-  }
-  const previewAmount = results[balanceContracts.length];
-  const balances = new import_sdk.AddressMap();
-  for (const [i, { holder, token }] of balanceCalls.entries()) {
-    const tokenBalances = balances.get(holder) ?? new import_sdk.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 import_sdk.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();
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  computePoolOpBalanceChanges,
-  simulatePoolOpMulticall
-});

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

@@ -1,106 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var simulatePoolOpV1_exports = {};
-__export(simulatePoolOpV1_exports, {
-  simulatePoolOpV1: () => simulatePoolOpV1
-});
-module.exports = __toCommonJS(simulatePoolOpV1_exports);
-var import_actions = require("viem/actions");
-var import_iERC20 = require("../../abi/iERC20.js");
-var import_errors = require("./errors.js");
-var import_extractERC20Transfers = require("./extractERC20Transfers.js");
-var import_holders = require("./holders.js");
-async function simulatePoolOpV1(input, options = {}) {
-  const { sdk, operation, to, calldata, wallet } = input;
-  const { blockNumber } = options;
-  const { underlying, pool } = operation;
-  const holders = (0, import_holders.watchedHolders)(operation, wallet);
-  const tokens = [underlying, pool];
-  const balanceOf = (token, holder) => ({
-    to: token,
-    abi: import_iERC20.ierc20Abi,
-    functionName: "balanceOf",
-    args: [holder]
-  });
-  const balanceCalls = holders.flatMap(
-    (holder) => tokens.map((token) => balanceOf(token, holder))
-  );
-  let results;
-  try {
-    ({ results } = await (0, import_actions.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 import_errors.PreviewSimulationError([
-      {
-        source: "eth_simulateV1",
-        detail: (0, import_errors.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 import_errors.PreviewSimulationError([
-      {
-        source: "eth_simulateV1",
-        detail: (0, import_errors.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: (0, import_extractERC20Transfers.extractERC20Transfers)(txResult.logs ?? [], holders),
-    balanceChanges
-  };
-}
-function readBalance(result) {
-  return result?.status === "success" ? result.result : 0n;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  simulatePoolOpV1
-});

package/dist/cjs/sdk/market/zapper/Zapper.js

@@ -1,47 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var Zapper_exports = {};
-__export(Zapper_exports, {
-  Zapper: () => Zapper
-});
-module.exports = __toCommonJS(Zapper_exports);
-var import_utils = require("../../utils/index.js");
-class Zapper {
-  pool;
-  type;
-  baseParams;
-  tokenIn;
-  tokenOut;
-  contractType;
-  constructor(data) {
-    this.pool = data.pool;
-    this.type = data.type;
-    this.baseParams = data.baseParams;
-    this.tokenIn = data.tokenIn;
-    this.tokenOut = data.tokenOut;
-    this.contractType = Zapper.contractType(data.baseParams);
-  }
-  static contractType(baseParams) {
-    return (0, import_utils.bytes32ToString)(baseParams.contractType);
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Zapper
-});

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

@@ -1,4 +0,0 @@
-const ETH_SIMULATE_V1_NETWORKS = /* @__PURE__ */ new Set(["Mainnet", "Plasma", "Somnia"]);
-export {
-  ETH_SIMULATE_V1_NETWORKS
-};

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

@@ -1,23 +0,0 @@
-import { isAddressEqual, parseEventLogs } from "viem";
-import { ierc20Abi } from "../../abi/iERC20.js";
-function extractERC20Transfers(logs, watch) {
-  const parsed = parseEventLogs({
-    abi: ierc20Abi,
-    eventName: "Transfer",
-    logs
-  });
-  const transfers = [];
-  for (const log of parsed) {
-    const { from, to, value } = log.args;
-    const involved = watch.some(
-      (address) => isAddressEqual(from, address) || isAddressEqual(to, address)
-    );
-    if (involved) {
-      transfers.push({ token: log.address, amount: value, from, to });
-    }
-  }
-  return transfers;
-}
-export {
-  extractERC20Transfers
-};

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
-};