@gearbox-protocol/sdk 12.8.0 → 12.9.0-txparser.1

package/dist/cjs/history/ContractRegister.js

@@ -0,0 +1,69 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var ContractRegister_exports = {};
+__export(ContractRegister_exports, {
+  ContractRegister: () => ContractRegister
+});
+module.exports = __toCommonJS(ContractRegister_exports);
+var import_sdk = require("../sdk/index.js");
+class ContractRegister {
+  #client;
+  #logger;
+  #register;
+  #factories = [];
+  constructor(client, logger) {
+    this.#client = client;
+    this.#logger = logger;
+    this.#register = import_sdk.ChainContractsRegister.for(client, logger);
+  }
+  get register() {
+    return this.#register;
+  }
+  registerFactory(factory) {
+    this.#factories.push(factory);
+  }
+  createContract(args) {
+    const { addr, version } = args;
+    const existing = this.#register.getContract(addr);
+    if (existing) {
+      return existing;
+    }
+    const contractType = (0, import_sdk.bytes32ToString)(args.contractType);
+    if (contractType === "CREDIT_FACADE" && (0, import_sdk.isV310)(version)) {
+      return new import_sdk.CreditFacadeV310BaseContract(
+        { client: this.#client, logger: this.#logger },
+        { ...args, name: `CreditFacadeV310(${addr})` }
+      );
+    }
+    for (const factory of this.#factories) {
+      const contract = factory(
+        { client: this.#client, logger: this.#logger },
+        args
+      );
+      if (contract) {
+        return contract;
+      }
+    }
+    throw new Error(`unknown contract ${contractType} v${version}`);
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ContractRegister
+});

package/dist/cjs/history/assembleOperations.js

@@ -0,0 +1,110 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var assembleOperations_exports = {};
+__export(assembleOperations_exports, {
+  assembleOperations: () => assembleOperations
+});
+module.exports = __toCommonJS(assembleOperations_exports);
+var import_adapters = require("../plugins/adapters/index.js");
+var import_classifyMulticallOperations = require("./classifyMulticallOperations.js");
+var import_extractProtocolCalls = require("./extractProtocolCalls.js");
+function assembleOperations(input) {
+  const {
+    facadeCalls,
+    executeResults,
+    register,
+    underlying,
+    txHash,
+    blockNumber,
+    liquidationRemainingFunds,
+    phantomTokens,
+    strict
+  } = input;
+  let offset = 0;
+  const meta = { txHash, blockNumber };
+  return facadeCalls.map((fc) => {
+    if (fc.operation === "PartiallyLiquidateCreditAccount") {
+      return assemblePartialLiquidation(fc, meta);
+    }
+    const count = countAdapterCalls(fc.innerCalls, register);
+    const sliced = executeResults.slice(offset, offset + count);
+    offset += count;
+    const protocolCalldatas = (0, import_extractProtocolCalls.extractProtocolCalls)(fc.trace, sliced);
+    const multicall = (0, import_classifyMulticallOperations.classifyMulticallOperations)({
+      innerCalls: fc.innerCalls,
+      executeResults: sliced,
+      protocolCalldatas,
+      register,
+      creditAccount: fc.creditAccount,
+      underlying,
+      strict,
+      phantomTokens
+    });
+    switch (fc.operation) {
+      case "OpenCreditAccount":
+        return {
+          ...meta,
+          operation: fc.operation,
+          creditAccount: fc.creditAccount,
+          onBehalfOf: fc.parsed.rawArgs.onBehalfOf,
+          referralCode: fc.parsed.rawArgs.referralCode,
+          multicall
+        };
+      case "LiquidateCreditAccount":
+        return {
+          ...meta,
+          operation: fc.operation,
+          creditAccount: fc.creditAccount,
+          to: fc.parsed.rawArgs.to,
+          token: underlying,
+          remainingFunds: liquidationRemainingFunds ?? 0n,
+          multicall
+        };
+      default:
+        return {
+          ...meta,
+          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 import_adapters.AbstractAdapterContract;
+  }).length;
+}
+function assemblePartialLiquidation(fc, meta) {
+  const { rawArgs } = fc.parsed;
+  return {
+    ...meta,
+    operation: "PartiallyLiquidateCreditAccount",
+    creditAccount: fc.creditAccount,
+    token: rawArgs.token,
+    repaidAmount: rawArgs.repaidAmount,
+    minSeizedAmount: rawArgs.minSeizedAmount,
+    to: rawArgs.to
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  assembleOperations
+});

package/dist/cjs/history/classifyMulticallOperations.js

@@ -0,0 +1,157 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var classifyMulticallOperations_exports = {};
+__export(classifyMulticallOperations_exports, {
+  classifyMulticallOperations: () => classifyMulticallOperations
+});
+module.exports = __toCommonJS(classifyMulticallOperations_exports);
+var import_viem = require("viem");
+var import_adapters = require("../plugins/adapters/index.js");
+var import_errors = require("./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 import_adapters.AbstractAdapterContract) {
+      const idx = transferIdx++;
+      const executeResult = executeResults[idx];
+      if (!executeResult) {
+        throw new import_errors.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 import_errors.UnknownAdapterError(call.target);
+    }
+    const unknownIdx = transferIdx++;
+    const unknownResult = executeResults[unknownIdx];
+    if (!unknownResult) {
+      throw new import_errors.TransferAlignmentError(executeResults.length, transferIdx);
+    }
+    const { transfers, targetContract } = unknownResult;
+    const netTransfers = (0, import_adapters.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",
+        ...(0, import_adapters.swapFromTransfers)(netTransfers)
+      }
+    });
+  }
+  if (transferIdx !== executeResults.length) {
+    throw new import_errors.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 ((0, import_viem.isAddressEqual)(phantom, calldataToken)) return deposited;
+  }
+  return void 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  classifyMulticallOperations
+});

package/dist/cjs/history/enrichTokens.js

@@ -0,0 +1,80 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var enrichTokens_exports = {};
+__export(enrichTokens_exports, {
+  enrichOperations: () => enrichOperations
+});
+module.exports = __toCommonJS(enrichTokens_exports);
+function enrichOperations(ops, resolve) {
+  return ops.map((op) => enrichOperation(op, resolve));
+}
+function enrichOperation(op, resolve) {
+  switch (op.operation) {
+    case "DirectTokenTransfer":
+      return { ...op, token: resolve(op.token) };
+    case "PartiallyLiquidateCreditAccount":
+      return { ...op, token: resolve(op.token) };
+    case "LiquidateCreditAccount":
+      return {
+        ...op,
+        token: resolve(op.token),
+        multicall: enrichMulticall(op.multicall, resolve)
+      };
+    case "OpenCreditAccount":
+    case "CloseCreditAccount":
+    case "MultiCall":
+    case "BotMulticall":
+      return { ...op, multicall: enrichMulticall(op.multicall, resolve) };
+  }
+}
+function enrichMulticall(ops, resolve) {
+  return ops.map((op) => enrichInnerOp(op, resolve));
+}
+function enrichInnerOp(op, resolve) {
+  switch (op.operation) {
+    case "Execute":
+      return {
+        ...op,
+        transfers: op.transfers.map((t) => ({ ...t, token: resolve(t.token) }))
+      };
+    case "IncreaseBorrowedAmount":
+    case "DecreaseBorrowedAmount":
+      return { ...op, token: resolve(op.token) };
+    case "AddCollateral":
+      return { ...op, token: resolve(op.token) };
+    case "WithdrawCollateral": {
+      const enriched = {
+        operation: op.operation,
+        token: resolve(op.token),
+        amount: op.amount,
+        to: op.to
+      };
+      if (op.phantomToken) {
+        enriched.phantomToken = resolve(op.phantomToken);
+      }
+      return enriched;
+    }
+    case "UpdateQuota":
+      return { ...op, token: resolve(op.token) };
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  enrichOperations
+});

package/dist/cjs/history/errors.js

@@ -0,0 +1,91 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var errors_exports = {};
+__export(errors_exports, {
+  AdapterTraceAlignmentError: () => AdapterTraceAlignmentError,
+  ProtocolCallNotFoundError: () => ProtocolCallNotFoundError,
+  TransferAlignmentError: () => TransferAlignmentError,
+  UnexpectedFacadeEventOrderError: () => UnexpectedFacadeEventOrderError,
+  UnknownAdapterError: () => UnknownAdapterError,
+  UnknownFacadeCallError: () => UnknownFacadeCallError
+});
+module.exports = __toCommonJS(errors_exports);
+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;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AdapterTraceAlignmentError,
+  ProtocolCallNotFoundError,
+  TransferAlignmentError,
+  UnexpectedFacadeEventOrderError,
+  UnknownAdapterError,
+  UnknownFacadeCallError
+});

package/dist/cjs/history/extractProtocolCalls.js

@@ -0,0 +1,53 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var extractProtocolCalls_exports = {};
+__export(extractProtocolCalls_exports, {
+  extractProtocolCalls: () => extractProtocolCalls
+});
+module.exports = __toCommonJS(extractProtocolCalls_exports);
+var import_errors = require("./errors.js");
+var import_trace_utils = require("./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 = (0, import_trace_utils.findCallTo)(subtraces[subtraceIdx], targetContract);
+      subtraceIdx++;
+    }
+    if (!found) {
+      throw new import_errors.ProtocolCallNotFoundError(targetContract, i);
+    }
+    result.push(found.input);
+  }
+  if (result.length !== executeResults.length) {
+    throw new import_errors.AdapterTraceAlignmentError(executeResults.length, result.length);
+  }
+  return result;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractProtocolCalls
+});