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

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

@@ -0,0 +1,47 @@
+async function verifyPrerequisites(prereqs, ctx) {
+  if (prereqs.length === 0) {
+    return [];
+  }
+  const ranges = [];
+  const calls = [];
+  for (const prereq of prereqs) {
+    const start = calls.length;
+    calls.push(...prereq.calls(ctx));
+    ranges.push({ start, end: calls.length });
+  }
+  let results;
+  try {
+    results = await ctx.sdk.client.multicall({
+      allowFailure: true,
+      contracts: calls,
+      // `undefined` lets viem read at `latest`; `blockNumber` is only set for
+      // testnet forks pinned to a specific block.
+      blockNumber: ctx.blockNumber
+    });
+  } catch (cause) {
+    const error = cause instanceof Error ? cause : new Error(String(cause));
+    return prereqs.map(
+      (prereq, i) => (
+        // Each prereq pairs its own kind with its detail, so the widened
+        // `resolve` return is safe to narrow back to the discriminated union.
+        prereq.resolve(
+          failureSlice(ranges[i].end - ranges[i].start, error)
+        )
+      )
+    );
+  }
+  return prereqs.map(
+    (prereq, i) => prereq.resolve(
+      results.slice(ranges[i].start, ranges[i].end)
+    )
+  );
+}
+function failureSlice(n, error) {
+  return Array.from({ length: n }, () => ({
+    status: "failure",
+    error
+  }));
+}
+export {
+  verifyPrerequisites
+};

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

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

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

@@ -0,0 +1,75 @@
+import {
+  BaseError,
+  ContractFunctionRevertedError,
+  decodeErrorResult
+} from "viem";
+import { errorAbis } from "../../abi/errors.js";
+class PreviewSimulationError extends BaseError {
+  name = "PreviewSimulationError";
+  /** Per-flow decoded failures behind this error. */
+  failures;
+  constructor(failures) {
+    const shortMessage = failures.length <= 1 ? failures[0]?.detail.reason ?? "simulation failed" : "all simulation flows failed";
+    const cause = failures.find((f) => f.detail.cause instanceof Error)?.detail.cause;
+    super(shortMessage, {
+      metaMessages: failures.map((f) => `[${f.source}] ${f.detail.reason}`),
+      cause
+    });
+    this.failures = failures;
+  }
+}
+function asPreviewSimulationError(reason, source) {
+  if (reason instanceof PreviewSimulationError) {
+    return reason;
+  }
+  const error = reason instanceof Error ? reason : new Error(String(reason));
+  return new PreviewSimulationError([
+    { 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") {
+    try {
+      const decoded = decodeErrorResult({ abi: errorAbis, data });
+      return {
+        reason: formatDecodedError(decoded.errorName, decoded.args),
+        cause: error
+      };
+    } catch {
+    }
+  }
+  if (error instanceof BaseError) {
+    const reverted = error.walk(
+      (e) => e instanceof ContractFunctionRevertedError
+    );
+    if (reverted instanceof ContractFunctionRevertedError) {
+      return {
+        reason: reverted.data?.errorName ?? reverted.reason ?? reverted.shortMessage ?? "reverted",
+        cause: error
+      };
+    }
+    return { reason: error.shortMessage ?? error.name, cause: error };
+  }
+  if (error instanceof Error) {
+    return { reason: error.message, cause: error };
+  }
+  return { reason: "reverted", cause: error };
+}
+function formatDecodedError(errorName, args) {
+  if (!args || args.length === 0) {
+    return errorName;
+  }
+  return `${errorName}(${args.map((arg) => String(arg)).join(", ")})`;
+}
+export {
+  PreviewSimulationError,
+  asPreviewSimulationError,
+  combinePreviewSimulationErrors,
+  decodeSimulationError
+};

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

@@ -0,0 +1,23 @@
+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/holders.js

@@ -0,0 +1,21 @@
+import { AddressSet } from "../../sdk/index.js";
+function sourceHolder(operation, wallet) {
+  switch (operation.operation) {
+    case "Deposit":
+    case "Mint":
+      return wallet;
+    case "Withdraw":
+    case "Redeem":
+      return operation.owner;
+  }
+}
+function watchedHolders(operation, wallet) {
+  const holders = new AddressSet([
+    sourceHolder(operation, wallet),
+    operation.receiver
+  ]);
+  return holders.asArray();
+}
+export {
+  watchedHolders
+};

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

@@ -0,0 +1,12 @@
+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,
+  simulatePoolOperation
+};

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

@@ -0,0 +1,6 @@
+async function simulateFacadeOperation(_input, _options) {
+  throw new Error("not yet implemented");
+}
+export {
+  simulateFacadeOperation
+};

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

@@ -0,0 +1,13 @@
+import { isPoolOperation } from "../parse/index.js";
+import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
+import { simulatePoolOperation } from "./simulatePoolOperation.js";
+async function simulateOperation(input, options) {
+  const { operation } = input;
+  if (isPoolOperation(operation)) {
+    return simulatePoolOperation({ ...input, operation }, options);
+  }
+  return simulateFacadeOperation({ ...input, operation }, options);
+}
+export {
+  simulateOperation
+};

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

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

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

@@ -0,0 +1,41 @@
+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/{history → preview/trace}/errors.js

@@ -22,28 +22,6 @@ class WithdrawCollateralAlignmentError extends Error {
     this.name = "WithdrawCollateralAlignmentError";
   }
 }
-class ProtocolCallNotFoundError extends Error {
-  targetContract;
-  executeIndex;
-  constructor(targetContract, executeIndex) {
-    super(
-      `protocol call to ${targetContract} not found in trace for Execute #${executeIndex}`
-    );
-    this.name = "ProtocolCallNotFoundError";
-    this.targetContract = targetContract;
-    this.executeIndex = executeIndex;
-  }
-}
-class AdapterTraceAlignmentError extends Error {
-  constructor(expected, actual) {
-    super(`found ${actual} adapter traces for ${expected} execute events`);
-    this.expected = expected;
-    this.actual = actual;
-    this.name = "AdapterTracesAlignmentError";
-  }
-  expected;
-  actual;
-}
 class UnexpectedFacadeEventOrderError extends Error {
   constructor(e) {
     super(
@@ -63,8 +41,6 @@ class UnknownFacadeCallError extends Error {
   }
 }
 export {
-  AdapterTraceAlignmentError,
-  ProtocolCallNotFoundError,
   TransferAlignmentError,
   UnexpectedFacadeEventOrderError,
   UnknownAdapterError,

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

@@ -0,0 +1,40 @@
+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/{history → preview/trace}/extractTransfers.js

@@ -3,9 +3,9 @@ import {
   isAddressEqual,
   parseEventLogs
 } from "viem";
-import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
-import { ierc20Abi } from "../abi/iERC20.js";
-import { AddressMap } from "../sdk/index.js";
+import { iCreditFacadeV310Abi } from "../../abi/310/generated.js";
+import { ierc20Abi } from "../../abi/iERC20.js";
+import { AddressMap } from "../../sdk/index.js";
 import { UnexpectedFacadeEventOrderError } from "./errors.js";
 function extractTransfers(logs, creditAccount, pool, creditFacade) {
   const ranges = buildOperationRanges(logs, creditFacade, creditAccount);
@@ -14,7 +14,7 @@ function extractTransfers(logs, creditAccount, pool, creditFacade) {
     return !!e && (e.eventName === "LiquidateCreditAccount" || e.eventName === "PartiallyLiquidateCreditAccount") && isAddressEqual(e.args.creditAccount, creditAccount);
   });
   let currentEntries = [];
-  const executeResults = [];
+  const executeTransfers = [];
   const directTransfers = [];
   const phantomTokens = new AddressMap();
   const withdrawCollateralEvents = [];
@@ -23,20 +23,17 @@ function extractTransfers(logs, creditAccount, pool, creditFacade) {
     const facadeEvent = tryDecodeFacadeEvent(log, creditFacade);
     if (facadeEvent) {
       if (isExecute(facadeEvent, creditAccount)) {
-        executeResults.push({
-          transfers: currentEntries,
-          targetContract: facadeEvent.args.targetContract
-        });
+        executeTransfers.push(currentEntries);
       } else if (isLiquidation(facadeEvent, creditAccount)) {
         liquidationRemainingFunds = facadeEvent.args.remainingFunds;
       } else if (isWithdrawPhantomToken(facadeEvent, creditAccount)) {
-        const phantomExec = executeResults.pop();
-        if (!phantomExec) {
+        const phantomTransfers = executeTransfers.pop();
+        if (!phantomTransfers) {
           throw new Error(
             `WithdrawPhantomToken without preceding Execute at logIndex ${facadeEvent.logIndex}`
           );
         }
-        const rawDeposit = phantomExec.transfers.find(
+        const rawDeposit = phantomTransfers.find(
           (t) => isAddressEqual(t.to, creditAccount)
         );
         if (!rawDeposit) {
@@ -80,7 +77,7 @@ function extractTransfers(logs, creditAccount, pool, creditFacade) {
     }
   }
   return {
-    executeResults,
+    executeTransfers,
     directTransfers,
     liquidationRemainingFunds,
     phantomTokens,

package/dist/esm/{history → preview/trace}/findFacadeCalls.js

@@ -2,9 +2,11 @@ import {
   decodeFunctionResult,
   isAddressEqual
 } from "viem";
-import { iCreditFacadeV310Abi } from "../abi/310/generated.js";
+import { iCreditFacadeV310Abi } from "../../abi/310/generated.js";
+import {
+  collectTraces
+} from "../../common-utils/utils/trace.js";
 import { UnknownFacadeCallError } from "./errors.js";
-import { collectTraces } from "./trace-utils.js";
 const FACADE_CALL_TYPES = {
   multicall: "MultiCall",
   botMulticall: "BotMulticall",

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

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