@gearbox-protocol/sdk 13.0.0-next.9 → 13.0.1

package/dist/esm/common-utils/utils/priceMath.js

@@ -0,0 +1,42 @@
+import { PRICE_DECIMALS, WAD } from "../../sdk/index.js";
+class PriceUtils {
+  /**
+   * This class is intentionally non-instantiable.
+   */
+  constructor() {
+  }
+  /**
+   * Calculates normalized total value for a token amount at a given price.
+   *
+   * Formula:
+   * `(amount * WAD * price) / 10^decimals / PRICE_DECIMALS`
+   *
+   * @param price Token unit price in `PRICE_DECIMALS` precision.
+   * @param amount Token amount in raw token units.
+   * @param decimals Token decimals used to normalize `amount` (defaults to `18`).
+   * @returns Total value in WAD-normalized units.
+   */
+  static calcTotalPrice = (price, amount, decimals = 18) => amount * WAD * price / 10n ** BigInt(decimals) / PRICE_DECIMALS;
+  /**
+   * Converts a normalized monetary value into target token amount by price.
+   *
+   * Formula:
+   * `(totalMoney * 10^targetDecimals * PRICE_DECIMALS) / targetPrice / WAD`
+   *
+   * Safety behavior:
+   * - returns `0n` when `targetPrice <= 0n` to avoid invalid division
+   *
+   * @param totalMoney Value to convert, expected in WAD-normalized units.
+   * @param target Conversion target configuration:
+   * - `price`: target token unit price in `PRICE_DECIMALS` precision
+   * - `decimals`: target token decimals (defaults to `18`)
+   * @returns Target token amount in raw token units.
+   */
+  static convertByPrice(totalMoney, { price: targetPrice, decimals: targetDecimals = 18 }) {
+    if (targetPrice <= 0n) return 0n;
+    return totalMoney * 10n ** BigInt(targetDecimals) * PRICE_DECIMALS / targetPrice / WAD;
+  }
+}
+export {
+  PriceUtils
+};

package/dist/esm/dev/AccountOpener.js

@@ -6,8 +6,8 @@ import {
   parseEventLogs
 } from "viem";
 import { generatePrivateKey, privateKeyToAccount } from "viem/accounts";
+import { iCreditFacadeV310Abi, iPoolV310Abi } from "../abi/310/generated.js";
 import { ierc20Abi } from "../abi/iERC20.js";
-import { iCreditFacadeV300Abi, iPoolV300Abi } from "../abi/v300.js";
 import {
   ADDRESS_0X0,
   AddressMap,
@@ -212,7 +212,7 @@ class AccountOpener extends SDKConstruct {
     }
     logger?.info(`opened credit account ${index}/${total}`);
     const logs = parseEventLogs({
-      abi: iCreditFacadeV300Abi,
+      abi: iCreditFacadeV310Abi,
       logs: receipt.logs,
       eventName: "OpenCreditAccount"
     });
@@ -478,7 +478,7 @@ class AccountOpener extends SDKConstruct {
       txHash = await this.#anvil.writeContract({
         account: depositor,
         address,
-        abi: iPoolV300Abi,
+        abi: iPoolV310Abi,
         functionName: "deposit",
         args: [amount, depositor.address],
         chain: this.#anvil.chain

package/dist/esm/dev/ltUtils.js

@@ -1,15 +1,9 @@
 import { erc20Abi, parseEther } from "viem";
 import {
-  iCreditConfiguratorV300Abi,
-  iCreditManagerV300Abi
-} from "../abi/v300.js";
-import {
-  hexEq,
-  isV300,
-  isV310,
-  PERCENTAGE_FACTOR,
-  TypedObjectUtils
-} from "../sdk/index.js";
+  iCreditConfiguratorV310Abi,
+  iCreditManagerV310Abi
+} from "../abi/310/generated.js";
+import { hexEq, isV310, TypedObjectUtils } from "../sdk/index.js";
 import { iaclTraitAbi, iOwnableAbi } from "./abi.js";
 async function setLTs(anvil, cm, newLTs, logger) {
   const configuratorAddr = await impresonateCCOwner(anvil, cm);
@@ -18,7 +12,7 @@ async function setLTs(anvil, cm, newLTs, logger) {
       chain: anvil.chain,
       address: cm.creditConfigurator.baseParams.addr,
       account: configuratorAddr,
-      abi: iCreditConfiguratorV300Abi,
+      abi: iCreditConfiguratorV310Abi,
       functionName: "setLiquidationThreshold",
       args: [t, lt]
     });
@@ -30,9 +24,7 @@ async function setLTs(anvil, cm, newLTs, logger) {
 }
 async function setLTZero(anvil, cm, logger) {
   const v = Number(cm.creditConfigurator.baseParams.version);
-  if (isV300(v)) {
-    await setLTZeroV300(anvil, cm, logger);
-  } else if (isV310(v)) {
+  if (isV310(v)) {
     await setLTZeroV310(anvil, cm, logger);
   } else {
     throw new Error(
@@ -40,91 +32,6 @@ async function setLTZero(anvil, cm, logger) {
     );
   }
 }
-async function setLTZeroV300(anvil, cm, logger) {
-  const ccAddr = cm.creditConfigurator.baseParams.addr;
-  const cmAddr = cm.creditManager.baseParams.addr;
-  const {
-    name,
-    underlying,
-    feeInterest,
-    liquidationDiscount,
-    feeLiquidation,
-    feeLiquidationExpired,
-    liquidationDiscountExpired
-  } = cm.creditManager;
-  const owner = await impresonateCCOwner(anvil, cm);
-  let hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: ccAddr,
-    account: owner,
-    abi: iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      feeInterest,
-      liquidationDiscount - 1,
-      Number(PERCENTAGE_FACTOR) - liquidationDiscount,
-      feeLiquidationExpired,
-      liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${name}] setFees part 2`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: ccAddr,
-    account: owner,
-    abi: iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      feeInterest,
-      feeLiquidation,
-      Number(PERCENTAGE_FACTOR) - liquidationDiscount,
-      feeLiquidationExpired,
-      liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${name}] setFees done`);
-  await anvil.impersonateAccount({
-    address: ccAddr
-  });
-  await anvil.setBalance({
-    address: ccAddr,
-    value: parseEther("100")
-  });
-  logger?.debug(`[${name}] impresonating creditConfigurator ${ccAddr}`);
-  logger?.debug(`[${name}] setting liquidation threshold`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cmAddr,
-    account: ccAddr,
-    abi: iCreditManagerV300Abi,
-    functionName: "setCollateralTokenData",
-    args: [underlying, 1, 1, Number(2n ** 40n - 1n), 0]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${name}] setting configurator ${ccAddr}`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cmAddr,
-    account: ccAddr,
-    abi: iCreditManagerV300Abi,
-    functionName: "setCreditConfigurator",
-    args: [ccAddr]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${name}] done`);
-  await anvil.stopImpersonatingAccount({
-    address: ccAddr
-  });
-  await anvil.stopImpersonatingAccount({ address: owner });
-  await logLTs(
-    anvil,
-    cm,
-    cm.creditManager.collateralTokens.map((c) => c.token),
-    logger
-  );
-}
 async function setLTZeroV310(anvil, cm, logger) {
   const newLTs = {};
   for (const { token } of cm.creditManager.collateralTokens) {
@@ -159,7 +66,7 @@ async function logLTs(anvil, cm, tokens, logger) {
     allowFailure: true,
     contracts: tokens.flatMap((t) => [
       {
-        abi: iCreditManagerV300Abi,
+        abi: iCreditManagerV310Abi,
         functionName: "liquidationThresholds",
         address: cm.creditManager.baseParams.addr,
         args: [t]

package/dist/esm/dev/migrateFaucet.js

@@ -1,41 +1,29 @@
 import { formatEther, parseEther, stringToHex } from "viem";
 import { iAddressProviderV310Abi } from "../abi/310/generated.js";
-import { iAddressProviderV300Abi } from "../abi/v300.js";
-import { ADDRESS_PROVIDER } from "../sdk/index.js";
 import { extendAnvilClient } from "./createAnvilClient.js";
+async function migrateFaucet(sdk, faucet) {
+  try {
+    await unsafeMigrateFaucet(sdk, faucet);
+    sdk.logger?.info("faucet migrated successfully");
+  } catch (e) {
+    sdk.logger?.error(`faucet migration failed: ${e}`);
+  }
+  return sdk.client.readContract({
+    abi: iAddressProviderV310Abi,
+    address: sdk.addressProvider.address,
+    functionName: "getAddressOrRevert",
+    args: [stringToHex("FAUCET", { size: 32 }), 0n]
+  });
+}
 async function unsafeMigrateFaucet(sdk, faucet) {
   const anvil = extendAnvilClient(sdk.client);
-  let faucetAddr;
-  let owner;
-  if (faucet) {
-    faucetAddr = faucet;
-    owner = await anvil.readContract({
-      abi: iAddressProviderV310Abi,
-      address: sdk.addressProvider.address,
-      functionName: "owner",
-      args: []
-    });
-  } else {
-    [faucetAddr, owner] = await anvil.multicall({
-      contracts: [
-        {
-          abi: iAddressProviderV300Abi,
-          address: ADDRESS_PROVIDER[sdk.networkType],
-          functionName: "getAddressOrRevert",
-          args: [stringToHex("FAUCET", { size: 32 }), 0n]
-        },
-        {
-          abi: iAddressProviderV310Abi,
-          address: sdk.addressProvider.address,
-          functionName: "owner",
-          args: []
-        }
-      ],
-      allowFailure: false,
-      batchSize: 0
-    });
-  }
-  sdk.logger?.debug(`faucet address: ${faucetAddr}, owner: ${owner}`);
+  const owner = await anvil.readContract({
+    abi: iAddressProviderV310Abi,
+    address: sdk.addressProvider.address,
+    functionName: "owner",
+    args: []
+  });
+  sdk.logger?.debug(`faucet address: ${faucet}, owner: ${owner}`);
   await anvil.impersonateAccount({ address: owner });
   await anvil.setBalance({
     address: owner,
@@ -49,7 +37,7 @@ async function unsafeMigrateFaucet(sdk, faucet) {
     address: sdk.addressProvider.address,
     abi: iAddressProviderV310Abi,
     functionName: "setAddress",
-    args: [stringToHex("FAUCET", { size: 32 }), faucetAddr, false]
+    args: [stringToHex("FAUCET", { size: 32 }), faucet, false]
   });
   sdk.logger?.debug("estimated setAddress call");
   const hash = await anvil.writeContract({
@@ -58,7 +46,7 @@ async function unsafeMigrateFaucet(sdk, faucet) {
     address: sdk.addressProvider.address,
     abi: iAddressProviderV310Abi,
     functionName: "setAddress",
-    args: [stringToHex("FAUCET", { size: 32 }), faucetAddr, false],
+    args: [stringToHex("FAUCET", { size: 32 }), faucet, false],
     gas: request.gas ? request.gas * 11n / 10n : void 0
   });
   const receipt = await anvil.waitForTransactionReceipt({ hash });
@@ -67,21 +55,6 @@ async function unsafeMigrateFaucet(sdk, faucet) {
     throw new Error("faucet migration reverted");
   }
 }
-async function migrateFaucet(sdk, faucet) {
-  try {
-    await unsafeMigrateFaucet(sdk, faucet);
-    sdk.logger?.info("faucet migrated successfully");
-  } catch (e) {
-    sdk.logger?.error(`faucet migration failed: ${e}`);
-  }
-  return sdk.client.readContract({
-    abi: iAddressProviderV310Abi,
-    address: sdk.addressProvider.address,
-    functionName: "getAddressOrRevert",
-    args: [stringToHex("FAUCET", { size: 32 }), 0n]
-  });
-}
 export {
-  migrateFaucet,
-  unsafeMigrateFaucet
+  migrateFaucet
 };

package/dist/esm/dev/providers.js

@@ -22,6 +22,9 @@ function getRpcProviderUrl(provider, network, apiKey, protocol = "http") {
   }
 }
 function getAlchemyUrl(network, apiKey, protocol = "http") {
+  if (!apiKey) {
+    return void 0;
+  }
   const alchemyDomain = ALCHEMY_DOMAINS[network];
   if (!alchemyDomain) {
     return void 0;
@@ -65,6 +68,9 @@ const ALCHEMY_DOMAINS = {
   Somnia: null
 };
 function getDrpcUrl(network, apiKey, protocol = "http") {
+  if (!apiKey) {
+    return void 0;
+  }
   const net = DRPC_NETS[network];
   return net ? `${protocol}s://lb.drpc.live/${net}/${apiKey}` : void 0;
 }
@@ -87,6 +93,9 @@ const ANKR_DOMAINS = {
   Somnia: "somnia_mainnet"
 };
 function getAnkrUrl(network, apiKey, protocol = "http") {
+  if (!apiKey) {
+    return void 0;
+  }
   const net = ANKR_DOMAINS[network];
   const sep = protocol === "ws" ? "/ws/" : "/";
   return net ? `${protocol}s://rpc.ankr.com/${net}${sep}${apiKey}` : void 0;
@@ -110,6 +119,9 @@ const THIRDWEB_DOMAINS = {
   Somnia: chains.Somnia.id.toString()
 };
 function getThirdWebUrl(network, apiKey, protocol = "http") {
+  if (!apiKey) {
+    return void 0;
+  }
   if (protocol === "ws") {
     return void 0;
   }

package/dist/esm/history/assembleOperations.js

@@ -0,0 +1,79 @@
+import { AbstractAdapterContract } from "../plugins/adapters/index.js";
+import { classifyMulticallOperations } from "./classifyMulticallOperations.js";
+import { extractProtocolCalls } from "./extractProtocolCalls.js";
+function assembleOperations(input) {
+  const {
+    facadeCalls,
+    executeResults,
+    register,
+    underlying,
+    liquidationRemainingFunds,
+    phantomTokens,
+    strict
+  } = input;
+  let offset = 0;
+  return facadeCalls.map((fc) => {
+    if (fc.operation === "PartiallyLiquidateCreditAccount") {
+      return assemblePartialLiquidation(fc);
+    }
+    const count = countAdapterCalls(fc.innerCalls, register);
+    const sliced = executeResults.slice(offset, offset + count);
+    offset += count;
+    const protocolCalldatas = extractProtocolCalls(fc.trace, sliced);
+    const multicall = classifyMulticallOperations({
+      innerCalls: fc.innerCalls,
+      executeResults: sliced,
+      protocolCalldatas,
+      register,
+      creditAccount: fc.creditAccount,
+      underlying,
+      strict,
+      phantomTokens
+    });
+    switch (fc.operation) {
+      case "OpenCreditAccount":
+        return {
+          operation: fc.operation,
+          creditAccount: fc.creditAccount,
+          onBehalfOf: fc.parsed.rawArgs.onBehalfOf,
+          referralCode: fc.parsed.rawArgs.referralCode,
+          multicall
+        };
+      case "LiquidateCreditAccount":
+        return {
+          operation: fc.operation,
+          creditAccount: fc.creditAccount,
+          to: fc.parsed.rawArgs.to,
+          token: underlying,
+          remainingFunds: liquidationRemainingFunds ?? 0n,
+          multicall
+        };
+      default:
+        return {
+          operation: fc.operation,
+          creditAccount: fc.creditAccount,
+          multicall
+        };
+    }
+  });
+}
+function countAdapterCalls(innerCalls, register) {
+  return innerCalls.filter((call) => {
+    const contract = register.getContract(call.target);
+    return !contract || contract instanceof AbstractAdapterContract;
+  }).length;
+}
+function assemblePartialLiquidation(fc) {
+  const { rawArgs } = fc.parsed;
+  return {
+    operation: "PartiallyLiquidateCreditAccount",
+    creditAccount: fc.creditAccount,
+    token: rawArgs.token,
+    repaidAmount: rawArgs.repaidAmount,
+    minSeizedAmount: rawArgs.minSeizedAmount,
+    to: rawArgs.to
+  };
+}
+export {
+  assembleOperations
+};

package/dist/esm/history/classifyMulticallOperations.js

@@ -0,0 +1,137 @@
+import { isAddressEqual } from "viem";
+import {
+  AbstractAdapterContract,
+  swapFromTransfers,
+  toNetTransfers
+} from "../plugins/adapters/index.js";
+import { TransferAlignmentError, UnknownAdapterError } from "./errors.js";
+function classifyMulticallOperations(input) {
+  const {
+    innerCalls,
+    executeResults,
+    protocolCalldatas,
+    register,
+    creditAccount,
+    underlying,
+    strict,
+    phantomTokens
+  } = input;
+  let transferIdx = 0;
+  const result = [];
+  for (const call of innerCalls) {
+    const contract = register.getContract(call.target);
+    if (contract instanceof AbstractAdapterContract) {
+      const idx = transferIdx++;
+      const executeResult = executeResults[idx];
+      if (!executeResult) {
+        throw new TransferAlignmentError(executeResults.length, transferIdx);
+      }
+      const { transfers: transfers2, targetContract: targetContract2 } = executeResult;
+      const protocolCalldata = protocolCalldatas[idx];
+      const partial = contract.parseAdapterOperation(
+        call,
+        transfers2,
+        creditAccount,
+        protocolCalldata,
+        strict
+      );
+      if (partial) result.push({ ...partial, protocol: targetContract2 });
+      continue;
+    }
+    if (contract !== void 0) {
+      const op = classifyFacadeInnerCall(call, underlying, phantomTokens);
+      if (op) result.push(op);
+      continue;
+    }
+    if (strict) {
+      throw new UnknownAdapterError(call.target);
+    }
+    const unknownIdx = transferIdx++;
+    const unknownResult = executeResults[unknownIdx];
+    if (!unknownResult) {
+      throw new TransferAlignmentError(executeResults.length, transferIdx);
+    }
+    const { transfers, targetContract } = unknownResult;
+    const netTransfers = toNetTransfers(transfers, creditAccount);
+    result.push({
+      operation: "Execute",
+      adapter: call.target,
+      protocol: targetContract,
+      adapterType: call.contractType,
+      version: call.version,
+      label: call.label,
+      adapterFunctionName: call.functionName,
+      adapterArgs: call.rawArgs,
+      protocolFunctionName: call.functionName,
+      protocolArgs: call.rawArgs,
+      transfers,
+      legacy: {
+        operation: "Swap",
+        ...swapFromTransfers(netTransfers)
+      }
+    });
+  }
+  if (transferIdx !== executeResults.length) {
+    throw new TransferAlignmentError(executeResults.length, transferIdx);
+  }
+  return result;
+}
+function classifyFacadeInnerCall(call, underlying, phantomTokens) {
+  const { functionName: sig, rawArgs } = call;
+  const functionName = sig.split("(")[0];
+  switch (functionName) {
+    case "increaseDebt":
+      return {
+        operation: "IncreaseBorrowedAmount",
+        token: underlying,
+        amount: rawArgs.amount
+      };
+    case "decreaseDebt":
+      return {
+        operation: "DecreaseBorrowedAmount",
+        token: underlying,
+        amount: rawArgs.amount
+      };
+    case "addCollateral":
+    case "addCollateralWithPermit":
+      return {
+        operation: "AddCollateral",
+        token: rawArgs.token,
+        amount: rawArgs.amount
+      };
+    case "withdrawCollateral": {
+      const calldataToken = rawArgs.token;
+      const depositedToken = findPhantomDepositedToken(
+        calldataToken,
+        phantomTokens
+      );
+      return {
+        operation: "WithdrawCollateral",
+        token: depositedToken ?? calldataToken,
+        amount: rawArgs.amount,
+        to: rawArgs.to,
+        ...depositedToken ? { phantomToken: calldataToken } : {}
+      };
+    }
+    case "updateQuota":
+      return {
+        operation: "UpdateQuota",
+        token: rawArgs.token,
+        change: rawArgs.quotaChange
+      };
+    // other unclassified facade calls, for example onDemandPriceUpdates
+    // https://github.com/Gearbox-protocol/core-v3/blob/b038597d9070d9fd18593a6ae9c3d28ca931bb73/contracts/credit/CreditFacadeV3.sol#L534
+    default:
+      return null;
+  }
+}
+function findPhantomDepositedToken(calldataToken, phantomTokens) {
+  if (!phantomTokens) return void 0;
+  for (const [phantom, deposited] of phantomTokens.entries()) {
+    if (isAddressEqual(phantom, calldataToken)) return deposited;
+  }
+  return void 0;
+}
+export {
+  classifyMulticallOperations
+};

package/dist/esm/history/errors.js

@@ -0,0 +1,62 @@
+class UnknownAdapterError extends Error {
+  address;
+  constructor(address) {
+    super(`unknown adapter contract ${address}`);
+    this.name = "UnknownAdapterError";
+    this.address = address;
+  }
+}
+class TransferAlignmentError extends Error {
+  constructor(expected, actual) {
+    super(
+      `transfer alignment mismatch: expected ${expected} Execute transfers, consumed ${actual}`
+    );
+    this.name = "TransferAlignmentError";
+  }
+}
+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";
+  }
+}
+class UnexpectedFacadeEventOrderError extends Error {
+  constructor(e) {
+    super(
+      `unexpected facade event order: ${e.eventName} at ${e.logIndex} in ${e.transactionHash}`
+    );
+    this.name = "UnexpectedFacadeEventOrderError";
+  }
+}
+class UnknownFacadeCallError extends Error {
+  address;
+  functionName;
+  constructor(address, functionName) {
+    super(`unknown facade call "${functionName}" at ${address}`);
+    this.name = "UnknownFacadeCallError";
+    this.address = address;
+    this.functionName = functionName;
+  }
+}
+export {
+  AdapterTraceAlignmentError,
+  ProtocolCallNotFoundError,
+  TransferAlignmentError,
+  UnexpectedFacadeEventOrderError,
+  UnknownAdapterError,
+  UnknownFacadeCallError
+};

package/dist/esm/history/extractProtocolCalls.js

@@ -0,0 +1,32 @@
+import {
+  AdapterTraceAlignmentError,
+  ProtocolCallNotFoundError
+} from "./errors.js";
+import { findCallTo } from "./trace-utils.js";
+function extractProtocolCalls(facadeTrace, executeResults) {
+  if (executeResults.length === 0) {
+    return [];
+  }
+  const subtraces = facadeTrace.calls ?? [];
+  const result = [];
+  let subtraceIdx = 0;
+  for (let i = 0; i < executeResults.length; i++) {
+    const { targetContract } = executeResults[i];
+    let found;
+    while (subtraceIdx < subtraces.length && !found) {
+      found = findCallTo(subtraces[subtraceIdx], targetContract);
+      subtraceIdx++;
+    }
+    if (!found) {
+      throw new ProtocolCallNotFoundError(targetContract, i);
+    }
+    result.push(found.input);
+  }
+  if (result.length !== executeResults.length) {
+    throw new AdapterTraceAlignmentError(executeResults.length, result.length);
+  }
+  return result;
+}
+export {
+  extractProtocolCalls
+};