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

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

@@ -0,0 +1,197 @@
+import { isAddressEqual } from "viem";
+import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
+function buildPrerequisites(tx, ctx) {
+  const { wallet } = ctx;
+  switch (tx.operation) {
+    // Deposit and Mint both pull the underlying from the caller into the pool;
+    // they only differ in which side (assets vs shares) the caller specifies.
+    // The exact underlying amount for Mint is resolved by the pool, so we can
+    // only require an allowance/balance against the known specified amount —
+    // 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,
+          owner: wallet,
+          spender: tx.pool,
+          required: tx.assets,
+          title: "Token approved to pool"
+        }),
+        new BalancePrerequisite({
+          token: tx.underlying,
+          owner: wallet,
+          required: tx.assets,
+          title: "Sufficient token balance"
+        })
+      ];
+    case "Mint":
+      return [
+        new AllowancePrerequisite({
+          token: tx.underlying,
+          owner: wallet,
+          spender: tx.pool,
+          required: tx.shares,
+          title: "Token approved to pool"
+        }),
+        new BalancePrerequisite({
+          token: tx.underlying,
+          owner: wallet,
+          required: tx.shares,
+          title: "Sufficient token balance"
+        })
+      ];
+    // 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,
+          owner: tx.owner,
+          required: tx.shares,
+          title: "Sufficient LP token balance"
+        })
+      ];
+      if (!isAddressEqual(tx.owner, wallet)) {
+        prereqs.push(
+          new AllowancePrerequisite({
+            token: tx.pool,
+            owner: tx.owner,
+            spender: wallet,
+            required: tx.shares,
+            title: "LP token approved to caller"
+          })
+        );
+      }
+      return prereqs;
+    }
+    case "Withdraw": {
+      const prereqs = [
+        new BalancePrerequisite({
+          token: tx.pool,
+          owner: tx.owner,
+          required: tx.assets,
+          title: "Sufficient LP token balance"
+        })
+      ];
+      if (!isAddressEqual(tx.owner, wallet)) {
+        prereqs.push(
+          new AllowancePrerequisite({
+            token: tx.pool,
+            owner: tx.owner,
+            spender: wallet,
+            required: tx.assets,
+            title: "LP token approved to caller"
+          })
+        );
+      }
+      return prereqs;
+    }
+    case "MultiCall":
+    case "BotMulticall":
+    case "OpenCreditAccount":
+    case "CloseCreditAccount":
+    case "LiquidateCreditAccount":
+      return collateralPrerequisites(tx.multicall, tx.creditManager, wallet);
+    case "PartiallyLiquidateCreditAccount": {
+      const underlying = underlyingOf(ctx.sdk, tx.creditManager);
+      if (!underlying || tx.repaidAmount === 0n) {
+        return [];
+      }
+      return [
+        new AllowancePrerequisite({
+          token: underlying,
+          owner: wallet,
+          spender: tx.creditManager,
+          required: tx.repaidAmount,
+          title: "Underlying approved to credit manager"
+        }),
+        new BalancePrerequisite({
+          token: underlying,
+          owner: wallet,
+          required: tx.repaidAmount,
+          title: "Sufficient underlying balance"
+        })
+      ];
+    }
+    default:
+      return [];
+  }
+}
+function collateralPrerequisites(multicall, creditManager, wallet) {
+  const required = /* @__PURE__ */ new Map();
+  for (const op of multicall) {
+    if (op.operation !== "AddCollateral" || op.amount === 0n) {
+      continue;
+    }
+    const key = op.token.toLowerCase();
+    const existing = required.get(key);
+    required.set(key, {
+      token: op.token,
+      amount: (existing?.amount ?? 0n) + op.amount
+    });
+  }
+  const prereqs = [];
+  for (const { token, amount } of required.values()) {
+    prereqs.push(
+      new AllowancePrerequisite({
+        token,
+        owner: wallet,
+        spender: creditManager,
+        required: amount,
+        title: "Collateral approved to credit manager"
+      }),
+      new BalancePrerequisite({
+        token,
+        owner: wallet,
+        required: amount,
+        title: "Sufficient collateral balance"
+      })
+    );
+  }
+  return prereqs;
+}
+function underlyingOf(sdk, creditManager) {
+  const suite = sdk.marketRegister.creditManagers.find(
+    (cm) => isAddressEqual(cm.creditManager.address, creditManager)
+  );
+  return suite?.underlying;
+}
+export {
+  buildPrerequisites
+};

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

@@ -0,0 +1,7 @@
+export * from "./AllowancePrerequisite.js";
+export * from "./BalancePrerequisite.js";
+export * from "./buildPrerequisites.js";
+export * from "./Prerequisite.js";
+export * from "./prepareAction.js";
+export * from "./runPrerequisites.js";
+export * from "./types.js";

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

@@ -0,0 +1,23 @@
+import { encodeFunctionData, erc20Abi } from "viem";
+function preparePrerequisiteAction(result) {
+  if (result.kind === "allowance" && result.satisfied === false) {
+    const { token, spender, required } = result.detail;
+    return {
+      kind: "allowance",
+      to: token,
+      data: encodeFunctionData({
+        abi: erc20Abi,
+        functionName: "approve",
+        args: [spender, required]
+      })
+    };
+  }
+  return null;
+}
+function isActionablePrerequisite(result) {
+  return preparePrerequisiteAction(result) !== null;
+}
+export {
+  isActionablePrerequisite,
+  preparePrerequisiteAction
+};

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/errors.js

@@ -0,0 +1,69 @@
+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 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,
+  decodeSimulationError
+};

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,10 @@
+import { PreviewSimulationError } from "./errors.js";
+import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
+import { simulateOperation } from "./simulateOperation.js";
+import { simulatePoolOperation } from "./simulatePoolOperation.js";
+export {
+  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/simulatePoolOperation.js

@@ -0,0 +1,166 @@
+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,
+  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 };
+  }
+}
+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, 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 };
+  }
+}
+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 byAddress.values();
+}
+export {
+  computePoolOpBalanceChanges,
+  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
+};