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

package/dist/esm/preview/parse/parseOperationCalldata.js

@@ -1,16 +1,46 @@
 import {
   CreditFacadeV310Contract,
-  PoolV310Contract
+  PoolV310Contract,
+  ZapperContract
 } from "../../sdk/index.js";
 import { UnsupportedTargetError } from "./errors.js";
 import { parseFacadeOperationCalldata } from "./parseFacadeOperationCalldata.js";
 import { parsePoolOperationCalldata } from "./parsePoolOperationCalldata.js";
 function parseOperationCalldata(input) {
-  const { sdk, to, calldata } = input;
+  const { sdk, to, calldata, value, sender } = input;
   const contract = sdk.getContract(to);
   if (contract instanceof PoolV310Contract) {
     return parsePoolOperationCalldata({ sdk, pool: contract, calldata });
   }
+  if (contract instanceof ZapperContract) {
+    const parsed = contract.parseOperation(calldata, value);
+    if (parsed.operation === "Deposit") {
+      const op2 = {
+        operation: "Deposit",
+        pool: parsed.pool,
+        receiver: parsed.receiver,
+        assets: parsed.assets,
+        underlying: parsed.underlying,
+        tokenIn: parsed.token,
+        zapper: parsed.zapper,
+        referralCode: parsed.referralCode
+      };
+      return op2;
+    }
+    const op = {
+      operation: "Redeem",
+      pool: parsed.pool,
+      receiver: parsed.receiver,
+      // The zapper burns the caller's pool shares, so the share owner is the
+      // transaction sender.
+      owner: sender,
+      shares: parsed.shares,
+      underlying: parsed.underlying,
+      tokenOut: parsed.token,
+      zapper: parsed.zapper
+    };
+    return op;
+  }
   if (contract instanceof CreditFacadeV310Contract) {
     return parseFacadeOperationCalldata({
       sdk,

package/dist/esm/preview/parse/parsePoolOperationCalldata.js

@@ -14,6 +14,8 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         assets: rawArgs.assets,
         underlying,
+        tokenIn: underlying,
+        zapper: void 0,
         referralCode: functionName === "depositWithReferral" ? rawArgs.referralCode : void 0
       };
     case "mint":
@@ -24,6 +26,8 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         shares: rawArgs.shares,
         underlying,
+        tokenIn: underlying,
+        zapper: void 0,
         referralCode: functionName === "mintWithReferral" ? rawArgs.referralCode : void 0
       };
     case "withdraw":
@@ -33,7 +37,9 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         owner: rawArgs.owner,
         assets: rawArgs.assets,
-        underlying
+        underlying,
+        tokenOut: underlying,
+        zapper: void 0
       };
     case "redeem":
       return {
@@ -42,7 +48,9 @@ function parsePoolOperationCalldata(props) {
         receiver: rawArgs.receiver,
         owner: rawArgs.owner,
         shares: rawArgs.shares,
-        underlying
+        underlying,
+        tokenOut: underlying,
+        zapper: void 0
       };
     default:
       throw new UnsupportedPoolFunctionError(pool.address, parsed.functionName);

package/dist/esm/preview/prerequisites/buildPrerequisites.js

@@ -11,6 +11,23 @@ function buildPrerequisites(tx, ctx) {
     // here we approximate Mint by its shares amount (a lower bound on assets is
     // not knowable from calldata alone).
     case "Deposit":
+      if (tx.zapper) {
+        return [
+          new AllowancePrerequisite({
+            token: tx.tokenIn,
+            owner: wallet,
+            spender: tx.zapper,
+            required: tx.assets,
+            title: "Token approved to zapper"
+          }),
+          new BalancePrerequisite({
+            token: tx.tokenIn,
+            owner: wallet,
+            required: tx.assets,
+            title: "Sufficient token balance"
+          })
+        ];
+      }
       return [
         new AllowancePrerequisite({
           token: tx.underlying,
@@ -45,6 +62,23 @@ function buildPrerequisites(tx, ctx) {
     // Redeem and Withdraw both burn LP shares from `owner`; they only differ in
     // which side (shares vs assets) the caller specifies.
     case "Redeem": {
+      if (tx.zapper) {
+        return [
+          new BalancePrerequisite({
+            token: tx.pool,
+            owner: wallet,
+            required: tx.shares,
+            title: "Sufficient LP token balance"
+          }),
+          new AllowancePrerequisite({
+            token: tx.pool,
+            owner: wallet,
+            spender: tx.zapper,
+            required: tx.shares,
+            title: "LP token approved to zapper"
+          })
+        ];
+      }
       const prereqs = [
         new BalancePrerequisite({
           token: tx.pool,

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

@@ -27,11 +27,6 @@ function asPreviewSimulationError(reason, source) {
     { source, detail: decodeSimulationError({ error }) }
   ]);
 }
-function combinePreviewSimulationErrors(...errors) {
-  return new PreviewSimulationError(
-    errors.filter((e) => e).flatMap((e) => e?.failures ?? [])
-  );
-}
 function decodeSimulationError(revert) {
   const { error, data } = revert;
   if (data && data !== "0x") {
@@ -70,6 +65,5 @@ function formatDecodedError(errorName, args) {
 export {
   PreviewSimulationError,
   asPreviewSimulationError,
-  combinePreviewSimulationErrors,
   decodeSimulationError
 };

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

@@ -1,10 +1,8 @@
-import { ETH_SIMULATE_V1_NETWORKS } from "./constants.js";
 import { PreviewSimulationError } from "./errors.js";
 import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
 import { simulateOperation } from "./simulateOperation.js";
 import { simulatePoolOperation } from "./simulatePoolOperation.js";
 export {
-  ETH_SIMULATE_V1_NETWORKS,
   PreviewSimulationError,
   simulateFacadeOperation,
   simulateOperation,

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

@@ -1,41 +1,166 @@
-import { ETH_SIMULATE_V1_NETWORKS } from "./constants.js";
+import { iPoolV310Abi } from "../../abi/310/generated.js";
+import { ierc20Abi } from "../../abi/iERC20.js";
+import { iZapperAbi } from "../../abi/iZapper.js";
+import { AddressMap } from "../../sdk/index.js";
 import {
   asPreviewSimulationError,
-  combinePreviewSimulationErrors
+  decodeSimulationError,
+  PreviewSimulationError
 } from "./errors.js";
-import { simulatePoolOpMulticall } from "./simulatePoolOpMulticall.js";
-import { simulatePoolOpV1 } from "./simulatePoolOpV1.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 };
+  }
+}
+function outsideToken(operation) {
+  switch (operation.operation) {
+    case "Deposit":
+    case "Mint":
+      return operation.tokenIn;
+    case "Withdraw":
+    case "Redeem":
+      return operation.tokenOut;
+  }
+}
+function previewContract(operation) {
+  const { functionName, amount } = previewRead(operation);
+  if (operation.zapper) {
+    return {
+      address: operation.zapper,
+      abi: iZapperAbi,
+      functionName,
+      args: [amount]
+    };
+  }
+  return {
+    address: operation.pool,
+    abi: iPoolV310Abi,
+    functionName,
+    args: [amount]
+  };
+}
 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 };
+  const { sdk, operation, wallet } = input;
+  const { blockNumber, logger } = options;
+  const { pool } = operation;
+  try {
+    const holders = watchedHolders(operation, wallet);
+    const tokens = [outsideToken(operation), 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 preview = previewContract(operation);
+    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, preview]
+      });
+    } 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 {
+      status: "success",
+      balanceChanges: computePoolOpBalanceChanges(
+        operation,
+        wallet,
+        previewAmount,
+        before
+      )
+    };
+  } catch (cause) {
+    const error = asPreviewSimulationError(cause, "multicall");
+    logger?.error(error, "pool operation simulation failed");
+    return { status: "failure", error };
   }
-  if (multicall.status === "fulfilled") {
-    if (v1.status === "rejected") {
-      logger?.debug(
-        asPreviewSimulationError(v1.reason, "eth_simulateV1"),
-        "eth_simulateV1 flow failed; falling back to multicall result"
-      );
+}
+function balanceLegs(operation, wallet, previewAmount) {
+  const { pool, receiver } = operation;
+  switch (operation.operation) {
+    case "Deposit":
+      return [
+        { address: wallet, token: operation.tokenIn, delta: -operation.assets },
+        { address: receiver, token: pool, delta: previewAmount }
+      ];
+    case "Mint":
+      return [
+        { address: wallet, token: operation.tokenIn, delta: -previewAmount },
+        { address: receiver, token: pool, delta: operation.shares }
+      ];
+    case "Withdraw":
+      return [
+        { address: operation.owner, token: pool, delta: -previewAmount },
+        {
+          address: receiver,
+          token: operation.tokenOut,
+          delta: operation.assets
+        }
+      ];
+    case "Redeem":
+      return [
+        { address: operation.owner, token: pool, delta: -operation.shares },
+        { address: receiver, token: operation.tokenOut, 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 { 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 };
+  return byAddress.values();
 }
 export {
+  computePoolOpBalanceChanges,
   simulatePoolOperation
 };

package/dist/esm/sdk/MultichainSDK.js

@@ -67,6 +67,7 @@ class MultichainSDK {
         const perChainOpts = options?.perChain?.[network] ?? {};
         return sdk.attach({
           ...perChainOpts,
+          loadZappers: perChainOpts.loadZappers ?? options?.loadZappers,
           redstone: {
             ...options?.redstone,
             cache: this.#redstoneCache,

package/dist/esm/sdk/OnchainSDK.js

@@ -126,7 +126,8 @@ class OnchainSDK extends ChainContractsRegister {
       ignoreMarkets,
       marketConfigurators: mcs,
       redstone,
-      pyth
+      pyth,
+      loadZappers
     } = options ?? {};
     const marketConfigurators = mcs ?? TypedObjectUtils.keys(
       this.client.chain.defaultMarketConfigurators
@@ -195,6 +196,9 @@ class OnchainSDK extends ChainContractsRegister {
         blockNumber: this.currentBlock,
         gas: this.gasLimit
       });
+      if (loadZappers) {
+        await this.#marketRegister.loadZappers();
+      }
     }
     const pluginsList = TypedObjectUtils.entries(this.plugins);
     const pluginResponse = await Promise.allSettled(
@@ -247,7 +251,7 @@ class OnchainSDK extends ChainContractsRegister {
       `address provider version: ${this.#addressProvider.version}`
     );
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
-    this.#marketRegister.hydrate(state.markets);
+    this.#marketRegister.hydrate(state);
     this.#rwa = new RWARegistry(this);
     this.#rwa.setState(state.rwa);
     for (const [name, plugin] of TypedObjectUtils.entries(this.plugins)) {
@@ -312,7 +316,7 @@ class OnchainSDK extends ChainContractsRegister {
       currentBlock: this.currentBlock,
       timestamp: this.timestamp,
       addressProvider: this.addressProvider.state,
-      markets: this.marketRegister.state,
+      ...this.marketRegister.state,
       rwa: this.#rwa.state,
       plugins: Object.fromEntries(
         TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [

package/dist/esm/sdk/market/MarketRegister.js

@@ -35,10 +35,11 @@ class MarketRegister extends ZapperRegister {
    * bypassing on-chain reads.
    * @param state - Array of market data snapshots.
    **/
-  hydrate(state) {
-    const configurators = new Set(state.map((m) => m.configurator));
+  hydrate({ markets, zappers }) {
+    const configurators = new Set(markets.map((m) => m.configurator));
     this.#setMarketFilter([...configurators]);
-    this.#setMarkets(state);
+    this.#setMarkets(markets);
+    this.hydrateZappers(zappers);
   }
   /**
    * @internal
@@ -157,7 +158,10 @@ class MarketRegister extends ZapperRegister {
    * Serializable snapshot of all loaded markets, suitable for hydration.
    **/
   get state() {
-    return this.markets.map((market) => market.state);
+    return {
+      markets: this.markets.map((market) => market.state),
+      zappers: this.zappersState
+    };
   }
   /**
    * Returns a human-readable snapshot of all markets.
@@ -165,7 +169,8 @@ class MarketRegister extends ZapperRegister {
    **/
   stateHuman(raw = true) {
     return {
-      markets: this.markets.map((market) => market.stateHuman(raw))
+      markets: this.markets.map((market) => market.stateHuman(raw)),
+      zappers: this.zappersStateHuman(raw)
     };
   }
   /**

package/dist/esm/sdk/market/ZapperRegister.js

@@ -55,6 +55,60 @@ class ZapperRegister extends SDKConstruct {
       }
     }
   }
+  /**
+   * Serializable snapshot of all loaded zappers, suitable for hydration.
+   * Returns `undefined` when zappers were never loaded (i.e. `loadZappers` was
+   * not called), so the not-loaded state round-trips cleanly.
+   **/
+  get zappersState() {
+    if (!this.#zappers) {
+      return void 0;
+    }
+    return this.#zappers.values().flatMap(
+      (zappers) => zappers.map((z) => ({
+        pool: z.pool,
+        type: z.type,
+        baseParams: z.baseParams,
+        tokenIn: z.tokenIn,
+        tokenOut: z.tokenOut
+      }))
+    );
+  }
+  /**
+   * Restores zapper state from a previously serialized snapshot,
+   * bypassing on-chain reads.
+   * @param state - Array of zapper data snapshots, or `undefined` when zappers
+   *   were not loaded in the snapshot (leaves the registry in the not-loaded state).
+   **/
+  hydrateZappers(state) {
+    if (!state) {
+      return;
+    }
+    this.#zappers = new AddressMap(void 0, "zappers");
+    for (const z of state) {
+      this.#addZapper(z);
+    }
+  }
+  /**
+   * Returns a human-readable snapshot of all loaded zappers.
+   * Returns `undefined` when zappers were never loaded.
+   * @param raw - When `true`, includes raw/unformatted values.
+   **/
+  zappersStateHuman(_ = true) {
+    if (!this.#zappers) {
+      return void 0;
+    }
+    return this.#zappers.values().flatMap(
+      (zappers) => zappers.map((z) => ({
+        address: this.labelAddress(z.baseParams.addr),
+        contractType: z.contractType,
+        type: z.type,
+        pool: this.labelAddress(z.pool),
+        tokenIn: this.sdk.labelAddress(z.tokenIn.addr),
+        tokenOut: this.sdk.labelAddress(z.tokenOut.addr)
+      }))
+    );
+  }
   #addZapper(z) {
     const zapper = createZapper(this.sdk, z);
     const existing = this.zappers.get(z.pool);

package/dist/esm/sdk/market/zapper/IERC20ZapperContract.js

@@ -1,25 +1,9 @@
 import { ierc20ZapperAbi } from "../../../abi/iERC20Zapper.js";
-import { BaseContract } from "../../base/index.js";
+import { ZapperContract } from "./ZapperContract.js";
 const abi = ierc20ZapperAbi;
-class IERC20ZapperContract extends BaseContract {
-  pool;
-  type;
-  baseParams;
-  tokenIn;
-  tokenOut;
+class IERC20ZapperContract extends ZapperContract {
   constructor(sdk, data) {
-    super(sdk, {
-      addr: data.baseParams.addr,
-      abi,
-      name: `ERC20Zapper(${sdk.labelAddress(data.baseParams.addr)})`,
-      version: data.baseParams.version,
-      contractType: data.baseParams.contractType
-    });
-    this.pool = data.pool;
-    this.type = data.type;
-    this.baseParams = data.baseParams;
-    this.tokenIn = data.tokenIn;
-    this.tokenOut = data.tokenOut;
+    super(sdk, data, abi, "ERC20Zapper");
   }
   /**
    * Deposits ERC20 tokens into the pool via this zapper.
@@ -49,25 +33,6 @@ class IERC20ZapperContract extends BaseContract {
       args: [tokenInAmount, receiver, referralCode, deadline, v, r, s]
     });
   }
-  /**
-   * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-   */
-  redeem(tokenInAmount, receiver) {
-    return this.createRawTx({
-      functionName: "redeem",
-      args: [tokenInAmount, receiver]
-    });
-  }
-  /**
-   * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-   * skipping a separate approve transaction.
-   */
-  redeemWithPermit(tokenInAmount, receiver, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "redeemWithPermit",
-      args: [tokenInAmount, receiver, deadline, v, r, s]
-    });
-  }
 }
 export {
   IERC20ZapperContract

package/dist/esm/sdk/market/zapper/IETHZapperContract.js

@@ -1,25 +1,9 @@
 import { iethZapperAbi } from "../../../abi/iETHZapper.js";
-import { BaseContract } from "../../base/index.js";
+import { ZapperContract } from "./ZapperContract.js";
 const abi = iethZapperAbi;
-class IETHZapperContract extends BaseContract {
-  pool;
-  type;
-  baseParams;
-  tokenIn;
-  tokenOut;
+class IETHZapperContract extends ZapperContract {
   constructor(sdk, data) {
-    super(sdk, {
-      addr: data.baseParams.addr,
-      abi,
-      name: `ETHZapper(${sdk.labelAddress(data.baseParams.addr)})`,
-      version: data.baseParams.version,
-      contractType: data.baseParams.contractType
-    });
-    this.pool = data.pool;
-    this.type = data.type;
-    this.baseParams = data.baseParams;
-    this.tokenIn = data.tokenIn;
-    this.tokenOut = data.tokenOut;
+    super(sdk, data, abi, "ETHZapper");
   }
   /**
    * Deposits native ETH into the pool via this zapper.
@@ -40,25 +24,6 @@ class IETHZapperContract extends BaseContract {
       args: [receiver, referralCode]
     });
   }
-  /**
-   * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-   */
-  redeem(tokenInAmount, receiver) {
-    return this.createRawTx({
-      functionName: "redeem",
-      args: [tokenInAmount, receiver]
-    });
-  }
-  /**
-   * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-   * skipping a separate approve transaction.
-   */
-  redeemWithPermit(tokenInAmount, receiver, deadline, v, r, s) {
-    return this.createRawTx({
-      functionName: "redeemWithPermit",
-      args: [tokenInAmount, receiver, deadline, v, r, s]
-    });
-  }
 }
 export {
   IETHZapperContract