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

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

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -1547,6 +1547,160 @@ class CreditAccountsServiceV310 extends SDKConstruct {
       callsWithPrices
     );
   }
+  /**
+   * {@inheritDoc ICreditAccountsService.prependPriceUpdates}
+   */
+  async prependPriceUpdates(creditManager, calls, creditAccount, options) {
+    return this.#prependPriceUpdates(
+      creditManager,
+      calls,
+      creditAccount,
+      options
+    );
+  }
+  /**
+   * {@inheritDoc ICreditAccountsService.assembleCaUpdateCalls}
+   */
+  assembleCaUpdateCalls({
+    operations,
+    routerCallGroups,
+    creditFacade,
+    withdrawTo,
+    creditAccount,
+    underlyingToken
+  }) {
+    const calls = [];
+    let swapGroupIndex = 0;
+    let routerGroupsConsumed = 0;
+    for (const op of operations) {
+      switch (op.type) {
+        case "increaseDebt":
+          calls.push(this.#prepareIncreaseDebt(creditFacade, op.amount));
+          break;
+        case "decreaseDebt":
+          calls.push(this.#prepareChangeDebt(creditFacade, op.amount, true));
+          break;
+        case "addCollateral":
+          calls.push(
+            ...this.#prepareAddCollateral(
+              creditFacade,
+              [{ token: op.token, balance: op.amount }],
+              {}
+            )
+          );
+          break;
+        case "withdrawCollateral":
+          calls.push(
+            this.#prepareWithdrawToken(
+              creditFacade,
+              op.token,
+              op.amount,
+              withdrawTo
+            )
+          );
+          break;
+        case "swap": {
+          const routerCalls = routerCallGroups[swapGroupIndex];
+          if (!routerCalls) {
+            throw new Error(
+              `assembleCaUpdateCalls: missing router calls for swap leg ${swapGroupIndex}`
+            );
+          }
+          calls.push(...routerCalls);
+          swapGroupIndex += 1;
+          routerGroupsConsumed += 1;
+          break;
+        }
+        case "changeQuota": {
+          const quotaAssets = [...op.quotaIncrease, ...op.quotaDecrease];
+          if (quotaAssets.length === 0) {
+            break;
+          }
+          calls.push(
+            ...this.#prepareUpdateQuotas(creditFacade, {
+              averageQuota: quotaAssets,
+              minQuota: quotaAssets
+            })
+          );
+          break;
+        }
+        case "closeCreditAccount": {
+          for (const group of routerCallGroups) {
+            calls.push(...group);
+            routerGroupsConsumed += 1;
+          }
+          calls.push(
+            ...this.#prepareDisableQuotas({
+              creditFacade,
+              tokens: Object.entries(creditAccount.initialQuotas).map(
+                ([token, { quota }]) => ({
+                  token,
+                  quota
+                })
+              )
+            })
+          );
+          if (creditAccount.debt > 0n) {
+            calls.push(
+              ...this.#prepareDecreaseDebt({
+                creditFacade,
+                debt: creditAccount.debt
+              })
+            );
+          }
+          const hasAssets = creditAccount.assets.some(
+            (asset) => asset.balance > 0n
+          );
+          if (hasAssets) {
+            calls.push(
+              this.#prepareWithdrawToken(
+                creditFacade,
+                underlyingToken,
+                MAX_UINT256,
+                withdrawTo
+              )
+            );
+          }
+          break;
+        }
+        default: {
+          const _exhaustive = op;
+          throw new Error(
+            `assembleCaUpdateCalls: unsupported operation ${_exhaustive}`
+          );
+        }
+      }
+    }
+    if (routerGroupsConsumed !== routerCallGroups.length) {
+      throw new Error(
+        `assembleCaUpdateCalls: router call group mismatch (consumed ${routerGroupsConsumed}, got ${routerCallGroups.length})`
+      );
+    }
+    return calls;
+  }
+  /**
+   * {@inheritDoc ICreditAccountsService.executeCaUpdate}
+   */
+  async executeCaUpdate(creditAccount, calls, options) {
+    const cm = this.sdk.marketRegister.findCreditManager(
+      creditAccount.creditManager
+    );
+    const callsWithPrices = await this.#prependPriceUpdates(
+      creditAccount.creditManager,
+      calls,
+      creditAccount,
+      { ignoreReservePrices: options?.ignoreReservePrices }
+    );
+    const tx = await this.#multicallTx(
+      cm,
+      creditAccount.creditAccount,
+      callsWithPrices
+    );
+    if (options?.ethAmount && options.ethAmount > 0n) {
+      tx.value = options.ethAmount.toString(10);
+    }
+    return { tx, calls: callsWithPrices };
+  }
   #prepareDisableQuotas(ca) {
     const calls = [];
     for (const { token, quota } of ca.tokens) {

package/dist/types/common-utils/utils/index.d.ts

@@ -5,4 +5,5 @@ export * from "./constants.js";
 export * from "./creditAccount/index.js";
 export * from "./price-math.js";
 export * from "./strategies/index.js";
+export * from "./trace.js";
 export * from "./validation/index.js";

package/dist/types/common-utils/utils/trace.d.ts

@@ -0,0 +1,73 @@
+import { type Address, type Hex } from "viem";
+/**
+ * A single frame from Ethereum's `debug_traceTransaction` callTracer output.
+ * Recursive: each frame may contain nested sub-calls.
+ */
+export interface CallTrace {
+    from: Address;
+    to: Address;
+    input: Hex;
+    output: Hex;
+    value: Hex;
+    /** "CALL", "DELEGATECALL", "STATICCALL", "CREATE", etc. */
+    type: string;
+    /** Present when the call reverted (e.g. "execution reverted"). */
+    error?: string;
+    /** ABI-encoded revert data, if available. */
+    revertReason?: Hex;
+    calls?: CallTrace[];
+}
+/**
+ * Selector of `CreditManagerV3.execute(bytes)` (`0x09c5eabe`).
+ *
+ * This is the authoritative marker of an adapter performing an external
+ * protocol call: the adapter calls the credit manager's `execute(bytes)`, which
+ * forwards the calldata to the credit account, which in turn CALLs the target
+ * (protocol) contract. Adapter approvals use a different selector
+ * (`execute(address,bytes)` on the credit account), so matching on this
+ * selector isolates the real protocol call.
+ */
+export declare const EXECUTE_BYTES_SELECTOR: "0x09c5eabe";
+/**
+ * Finds the shallowest non-reverted `CreditManager.execute(bytes)` call in a
+ * trace subtree (breadth-first), or `undefined` if none exists.
+ *
+ * "Shallowest" matters for account migration: a migrate adapter nests the
+ * entire target `openCreditAccount` multicall - including that account's own
+ * `execute(bytes)` calls - inside its subtree. The shallowest match is the
+ * adapter's own protocol call, not a nested one.
+ */
+export declare function findExecuteBytes(node: CallTrace): CallTrace | undefined;
+/**
+ * Finds the first non-reverted CALL in a subtree whose `input` exactly matches
+ * `input` (case-insensitive). Used to locate the leaf CALL to the target
+ * contract: `execute(bytes)` forwards the calldata unchanged through the credit
+ * account proxy DELEGATECALL down to the final CALL to the protocol contract.
+ */
+export declare function findCallWithInput(node: CallTrace, input: Hex): CallTrace | undefined;
+/**
+ * Resolves the external protocol call performed by an adapter-level call trace.
+ *
+ * Locates the shallowest `CreditManager.execute(bytes)`, decodes the forwarded
+ * calldata, then finds the leaf CALL whose input matches that calldata to
+ * recover the target (protocol) contract address. Returns `undefined` when the
+ * subtree does not actually reach an external protocol CALL (e.g. the
+ * facade-internal `depositPhantomToken` / `withdrawPhantomToken` accounting
+ * calls, which forward calldata but make no external CALL).
+ *
+ * @param node - direct child node of the upper-level facade call trace
+ */
+export declare function resolveProtocolCall(node: CallTrace): {
+    contract: Address;
+    calldata: Hex;
+} | undefined;
+/**
+ * Finds the first non-reverted CALL to `target` anywhere in a trace subtree.
+ */
+export declare function findCallTo(node: CallTrace, target: Address): CallTrace | undefined;
+/**
+ * DFS walk of the call trace tree, collecting non-reverted CALL entries
+ * to the given address.
+ * Does not recurse into children of matched nodes
+ */
+export declare function collectTraces(node: CallTrace, target: Address): CallTrace[];

package/dist/types/dev/abi.d.ts

@@ -38,44 +38,126 @@ export declare const iDegenNftv2Abi: readonly [{
     readonly outputs: readonly [];
 }];
 export declare const faucetAbi: readonly [{
-    readonly name: "minAmountUSD";
     readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
+    readonly name: "assets";
+    readonly inputs: readonly [{
+        readonly name: "";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
 }, {
-    readonly name: "claim";
     readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [];
-}, {
     readonly name: "claim";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
     readonly inputs: readonly [{
-        readonly type: "uint256";
         readonly name: "amountUSD";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
 }, {
-    readonly name: "claim";
     readonly type: "function";
+    readonly name: "claim";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "claim";
     readonly inputs: readonly [{
+        readonly name: "claims";
         readonly type: "tuple[]";
+        readonly internalType: "struct TokenClaim[]";
         readonly components: readonly [{
-            readonly type: "address";
             readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
         }, {
-            readonly type: "uint256";
             readonly name: "amount";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
         }];
-        readonly name: "claims";
     }];
     readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getAssets";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "hasClaimed";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "minAmountUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "owner";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "prices";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "scales";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
 }];
 /**
  * This contract is deployed on testnets and contains testnet executionId and forkAlias

package/dist/types/dev/index.d.ts

@@ -20,3 +20,4 @@ export * from "./replaceStorage.js";
 export * from "./resilientTransport.js";
 export * from "./transports.js";
 export * from "./types.js";
+export * from "./verifyTestnet.js";