@gearbox-protocol/sdk 11.12.0 → 12.0.0-next.1

package/dist/cjs/sdk/base/BaseContract.js

@@ -18,66 +18,61 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var BaseContract_exports = {};
 __export(BaseContract_exports, {
-  BaseContract: () => BaseContract
+  BaseContract: () => BaseContract,
+  ContractParseError: () => ContractParseError
 });
 module.exports = __toCommonJS(BaseContract_exports);
 var import_viem = require("viem");
 var import_errors = require("../../abi/errors.js");
-var import_iVersion = require("../../abi/iVersion.js");
-var import_constants = require("../constants/index.js");
 var import_utils = require("../utils/index.js");
-var import_SDKConstruct = require("./SDKConstruct.js");
-class BaseContract extends import_SDKConstruct.SDKConstruct {
+var import_Construct = require("./Construct.js");
+class ContractParseError extends import_viem.BaseError {
+  address;
+  callData;
+  selector;
+  constructor(cause, options) {
+    const { address, callData, contractName } = options;
+    const selector = callData.slice(0, 10);
+    super(
+      `failed to parse function data for ${contractName ?? "unknown contract"} at ${address} with selector ${selector}`,
+      {
+        cause
+      }
+    );
+    this.callData = callData;
+    this.selector = selector;
+    this.address = address;
+  }
+}
+class BaseContract extends import_Construct.Construct {
   contract;
   abi;
-  logger;
   contractType;
   version;
-  #name;
-  #address;
-  constructor(sdk, args) {
-    super(sdk);
+  address;
+  name;
+  constructor({ client, logger }, args) {
+    super({ client, logger });
     this.abi = args.abi;
-    this.#address = (0, import_viem.getAddress)(args.addr);
+    this.address = (0, import_viem.getAddress)(args.addr);
     this.contract = (0, import_viem.getContract)({
       address: this.address,
       // add exceptions for better error decoding
       abi: [...this.abi, ...import_errors.errorAbis],
-      client: {
-        public: sdk.client
-      }
+      client
     });
     this.version = Number(args.version || 0);
     this.contractType = args.contractType ?? "";
     if ((0, import_viem.isHex)(this.contractType)) {
       this.contractType = (0, import_utils.bytes32ToString)(this.contractType);
     }
-    this.name = this.#name = args.name || this.contractType || this.#address;
-    this.logger = (0, import_utils.childLogger)(this.name, sdk.logger);
-    sdk.contracts.upsert(this.address, this);
-  }
-  get address() {
-    return this.#address;
-  }
-  set address(address) {
-    if (this.#address !== import_constants.ADDRESS_0X0) {
-      throw new Error(`Address can't be changed, currently: ${this.#address}`);
-    }
-    this.#address = (0, import_viem.getAddress)(address);
-    this.sdk.addressLabels.set(address, this.#name);
-  }
-  get name() {
-    return this.#name;
-  }
-  set name(name) {
-    this.#name = name;
-    if (this.#address !== import_constants.ADDRESS_0X0) {
-      this.sdk.addressLabels.set(this.#address, name);
-    }
+    this.name = args.name || this.contractType || this.address || this.constructor.name;
+    this.register.setContract(this.address, this);
+    this.register.setAddressLabel(this.address, this.name);
   }
   stateHuman(_ = true) {
     return {
-      address: this.sdk.labelAddress(this.address),
+      address: this.labelAddress(this.address),
       version: this.version,
       contractType: this.contractType
     };
@@ -89,14 +84,68 @@ class BaseContract extends import_SDKConstruct.SDKConstruct {
   processLog(_log) {
   }
   /**
-   * Converts contract calldata to some human-friendly string
-   * This is safe function which should not throw
+   * Return parsed args and function name from calldata belonging to this contract
+   * Target of the call is always this contract, but args can be parsed into calls to other contracts (de-facto recursive ParsedCall)
    * @param calldata
    * @returns
    */
   parseFunctionData(calldata) {
     try {
       return this.mustParseFunctionData(calldata);
+    } catch (e) {
+      this.logger?.warn(e);
+      return {
+        chainId: this.chainId,
+        target: this.address,
+        contractType: this.contractType,
+        label: this.name,
+        functionName: `Unknown function: ${calldata}`,
+        args: {}
+      };
+    }
+  }
+  /**
+   * Same as {@link parseFunctionData}, but throws {@link ContractParseError} if error occurs
+   * @param callData
+   * @returns
+   */
+  mustParseFunctionData(callData) {
+    try {
+      const decoded = (0, import_viem.decodeFunctionData)({
+        abi: this.abi,
+        data: callData
+      });
+      return this.wrapParseCall(
+        decoded.functionName,
+        this.parseFunctionParams(decoded)
+      );
+    } catch (e) {
+      throw new ContractParseError(e, {
+        address: this.address,
+        callData,
+        contractName: this.name
+      });
+    }
+  }
+  /**
+   * Parses viem-decoded contract function arguments to a map of named arguments
+   * This default implementation uses abi-based parsing, you can override it,
+   * but use this super implementation as fallback
+   * @param params
+   * @returns
+   */
+  parseFunctionParams(params) {
+    return (0, import_utils.functionArgsToMap)(this.abi, params.functionName, params.args);
+  }
+  /**
+   * Converts contract calldata to some human-friendly string
+   * This is safe function which should not throw
+   * @param calldata
+   * @returns
+   */
+  stringifyFunctionData(calldata) {
+    try {
+      return this.mustStringifyFunctionData(calldata);
     } catch (e) {
       const selector = calldata.slice(0, 10);
       this.logger?.warn(
@@ -105,59 +154,64 @@ class BaseContract extends import_SDKConstruct.SDKConstruct {
       return `unknown: ${this.labelAddress(this.address)}.${selector}`;
     }
   }
-  mustParseFunctionData(calldata) {
+  /**
+   * Same as {@link stingifyFunctionData}, but throws if error occurs
+   * @param calldata
+   * @returns
+   */
+  mustStringifyFunctionData(calldata) {
     const decoded = (0, import_viem.decodeFunctionData)({
       abi: this.abi,
       data: calldata
     });
-    const abiItem = this.abi.find(
-      (abiItem2) => abiItem2?.name === decoded.functionName && abiItem2?.type === "function"
-    );
-    if (!abiItem) {
+    const abiItem = (0, import_viem.getAbiItem)({
+      abi: this.abi,
+      name: decoded.functionName,
+      args: decoded.args
+    });
+    if (!abiItem || abiItem.type !== "function") {
       return `Unknown function: ${decoded.functionName}`;
     }
-    let paramsHuman;
-    const humanParams = this.parseFunctionParams(decoded);
-    if (humanParams) {
-      paramsHuman = humanParams.map((value, i) => {
-        return `${abiItem.inputs[i].name}: ${value}`;
-      });
-    } else if (Array.isArray(decoded.args)) {
-      paramsHuman = decoded.args.map((value, i) => {
-        return `${abiItem.inputs[i].name}: ${abiItem.inputs[i].type === "address" ? this.labelAddress(value) : abiItem.inputs[i].type.startsWith("tuple") ? (0, import_utils.json_stringify)(value) : value}`;
-      });
-    } else {
-      paramsHuman = Object.entries(decoded.args || {}).map(
-        ([key, value]) => `${key}: ${value}`
-      );
-    }
-    return `${this.name}.${decoded.functionName}({${paramsHuman.join(", ")}})`;
+    const params = this.stringifyFunctionParams(decoded).map(
+      (v, i) => `${abiItem.inputs[i].name}: ${v}`
+    );
+    return `${this.name}.${decoded.functionName}({${params.join(", ")}})`;
   }
   /**
-   * Return args and function name from calldata
-   * @param calldata
+   * Pretty-prints values of function arguments (do not include parameter names)
+   * Can be overriden in classes, but use this super implementation as fallback
+   *
+   * @param decoded - Function arguments decoded by viem
    * @returns
    */
-  parseFunctionDataToObject(calldata) {
-    const decoded = (0, import_viem.decodeFunctionData)({
+  stringifyFunctionParams(decoded) {
+    const abiItem = (0, import_viem.getAbiItem)({
       abi: this.abi,
-      data: calldata
+      name: decoded.functionName,
+      args: decoded.args
     });
-    return decoded;
-  }
-  parseFunctionParams(_params) {
-    return void 0;
+    if (Array.isArray(decoded.args)) {
+      return decoded.args.map((v, i) => {
+        return abiItem.inputs[i].type === "address" ? this.labelAddress(v) : abiItem.inputs[i].type.startsWith("tuple") ? (0, import_utils.json_stringify)(v) : `${v}`;
+      });
+    }
+    return Object.entries(decoded.args || {}).map((v) => `${v}`);
   }
-  async getVersion() {
-    this.version = Number(
-      await this.sdk.client.readContract({
-        abi: import_iVersion.iVersionAbi,
-        functionName: "version",
-        address: this.address
-      })
-    );
-    return this.version;
+  wrapParseCall(functionName, args) {
+    return {
+      chainId: this.chainId,
+      target: this.address,
+      contractType: this.contractType,
+      label: this.register.labelAddress(this.address),
+      functionName,
+      args
+    };
   }
+  /**
+   * Creates a raw transaction for a function in this contract
+   * @param parameters
+   * @returns
+   */
   createRawTx(parameters) {
     const { description: argsDescription } = parameters;
     const tx = (0, import_utils.createRawTx)(
@@ -168,11 +222,72 @@ class BaseContract extends import_SDKConstruct.SDKConstruct {
       },
       argsDescription
     );
-    tx.description = argsDescription || this.parseFunctionData(tx.callData);
+    tx.description = argsDescription || this.stringifyFunctionData(tx.callData);
     return tx;
   }
+  /**
+   * Get events in safe manner, by bisecting block range if needed
+   *
+   * @deprecated TODO: this should be moved to viem transport
+   *
+   * @param eventName
+   * @param fromBlock
+   * @param toBlock
+   * @param args
+   * @param chunkSize
+   * @returns
+   */
+  async getEvents(eventName, fromBlock, toBlock, args, chunkSize) {
+    if (chunkSize) {
+      const chunkSizeBigint = BigInt(chunkSize);
+      const getEventPromises = [];
+      for (let i = fromBlock; i < toBlock; i += chunkSizeBigint) {
+        getEventPromises.push(
+          this.client.getContractEvents({
+            address: this.address,
+            fromBlock: i,
+            toBlock: i + chunkSizeBigint,
+            abi: this.abi,
+            eventName,
+            args
+          })
+        );
+      }
+      const events = (await Promise.all(getEventPromises)).flat();
+      return events;
+    }
+    try {
+      const events = await this.client.getContractEvents({
+        address: this.address,
+        fromBlock,
+        toBlock,
+        abi: this.abi,
+        eventName,
+        args
+      });
+      return events;
+    } catch (e) {
+      const blockRangeErrors = [
+        "query exceeds max block",
+        "range is too large",
+        "eth_getLogs is limited to",
+        "Unable to perform request",
+        "Block range limit exceeded"
+      ];
+      if (e instanceof Error && blockRangeErrors.some((errorText) => e.message.includes(errorText))) {
+        const middle = (fromBlock + toBlock) / 2n;
+        const [firstHalfEvents, secondHalfEvents] = await Promise.all([
+          this.getEvents(eventName, fromBlock, middle, args),
+          this.getEvents(eventName, middle + 1n, toBlock, args)
+        ]);
+        return [...firstHalfEvents, ...secondHalfEvents];
+      }
+      throw e;
+    }
+  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  BaseContract
+  BaseContract,
+  ContractParseError
 });

package/dist/cjs/sdk/base/ChainContractsRegister.js

@@ -0,0 +1,135 @@
+"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 ChainContractsRegister_exports = {};
+__export(ChainContractsRegister_exports, {
+  ChainContractsRegister: () => ChainContractsRegister
+});
+module.exports = __toCommonJS(ChainContractsRegister_exports);
+var import_addresses = require("../constants/addresses.js");
+var import_AddressMap = require("../utils/AddressMap.js");
+var import_TokensMeta = require("./TokensMeta.js");
+class ChainContractsRegister {
+  static #chains = /* @__PURE__ */ new Map();
+  static for(client, logger) {
+    const chainId = client.chain.id;
+    let result = ChainContractsRegister.#chains.get(chainId);
+    if (!result) {
+      result = new ChainContractsRegister(client, logger);
+      ChainContractsRegister.#chains.set(chainId, result);
+    }
+    return result;
+  }
+  contracts = new import_AddressMap.AddressMap(
+    [],
+    "contracts"
+  );
+  labels = new import_AddressMap.AddressMap([], "labels");
+  client;
+  /**
+   * Token metadata such as symbol and decimals
+   */
+  tokensMeta;
+  logger;
+  constructor(client, logger) {
+    this.client = client;
+    this.tokensMeta = new import_TokensMeta.TokensMeta(client);
+    this.logger = logger;
+  }
+  getContract(address) {
+    return this.contracts.get(address);
+  }
+  mustGetContract(address) {
+    const contract = this.contracts.mustGet(address);
+    if (!contract) {
+      throw new Error(`contract ${address} not found on chain ${this.chainId}`);
+    }
+    return contract;
+  }
+  setContract(address, contract) {
+    this.contracts.upsert(address, contract);
+  }
+  setAddressLabel(address, label) {
+    if (address === import_addresses.NOT_DEPLOYED) {
+      return;
+    }
+    if (typeof label === "string") {
+      this.labels.upsert(address, label);
+    } else {
+      this.labels.upsert(address, label(this.labels.get(address)));
+    }
+  }
+  labelAddress(address) {
+    const label = this.labels.get(address);
+    return label ? `${address} [${label}]` : address;
+  }
+  get chain() {
+    return this.client.chain;
+  }
+  get chainId() {
+    return this.client.chain.id;
+  }
+  /**
+   * Converts contract call into some human-friendly string
+   * This method is safe and should not throw
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  stringifyFunctionData(address, calldata) {
+    const contract = this.contracts.get(address);
+    return contract ? contract.stringifyFunctionData(calldata) : `unknown: ${address}.${calldata.slice(0, 10)}`;
+  }
+  /**
+   * Converts multicalls into some human-friendly strings
+   * This method is safe and should not throw
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  stringifyMultiCall(calls) {
+    return calls.map(
+      (call) => this.stringifyFunctionData(call.target, call.callData)
+    );
+  }
+  /**
+   * Return args, function, type and address name from contract call
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  parseFunctionData(address, calldata) {
+    const contract = this.mustGetContract(address);
+    return contract.parseFunctionData(calldata);
+  }
+  /**
+   * Converts multicalls into call info
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  parseMultiCall(calls) {
+    return calls.map(
+      (call) => this.parseFunctionData(call.target, call.callData)
+    );
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ChainContractsRegister
+});

package/dist/cjs/sdk/base/Construct.js

@@ -0,0 +1,87 @@
+"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 Construct_exports = {};
+__export(Construct_exports, {
+  Construct: () => Construct
+});
+module.exports = __toCommonJS(Construct_exports);
+var import_utils = require("../utils/index.js");
+var import_ChainContractsRegister = require("./ChainContractsRegister.js");
+class Construct {
+  logger;
+  client;
+  register;
+  /**
+   * Indicates that contract state needs to be updated
+   */
+  #dirty = false;
+  constructor({ client, logger }) {
+    this.client = client;
+    this.register = import_ChainContractsRegister.ChainContractsRegister.for(client, logger);
+    this.logger = (0, import_utils.childLogger)(
+      this.constructor.name,
+      this.register.logger ?? logger
+    );
+  }
+  get chain() {
+    return this.client.chain;
+  }
+  get chainId() {
+    return this.client.chain.id;
+  }
+  get networkType() {
+    if ("network" in this.chain) {
+      return this.chain.network;
+    }
+    throw new Error(`chain ${this.chain.id} is not a Gearbox SDK chain`);
+  }
+  /**
+   * Indicates that contract state diverged from onchain state and needs to be updated
+   */
+  get dirty() {
+    return this.#dirty;
+  }
+  set dirty(value) {
+    this.#dirty = value;
+  }
+  /**
+   * Syntax sugar for rgister.tokensMeta
+   */
+  get tokensMeta() {
+    return this.register.tokensMeta;
+  }
+  /**
+   * Syntax suggar for getting contract labels
+   * @param address
+   * @returns
+   */
+  labelAddress(address) {
+    return this.register.labelAddress(address);
+  }
+  /**
+   * Returns list of addresses that should be watched for events to sync state
+   */
+  get watchAddresses() {
+    return /* @__PURE__ */ new Set();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Construct
+});

package/dist/cjs/sdk/base/SDKConstruct.js

@@ -21,39 +21,13 @@ __export(SDKConstruct_exports, {
   SDKConstruct: () => SDKConstruct
 });
 module.exports = __toCommonJS(SDKConstruct_exports);
-class SDKConstruct {
+var import_Construct = require("./Construct.js");
+class SDKConstruct extends import_Construct.Construct {
   sdk;
-  /**
-   * Indicates that contract state needs to be updated
-   */
-  #dirty = false;
   constructor(sdk) {
+    super(sdk);
     this.sdk = sdk;
   }
-  get networkType() {
-    return this.sdk.networkType;
-  }
-  get client() {
-    return this.sdk.client;
-  }
-  /**
-   * Indicates that contract state needs to be updated
-   */
-  get dirty() {
-    return this.#dirty;
-  }
-  set dirty(value) {
-    this.#dirty = value;
-  }
-  labelAddress(address) {
-    return this.sdk.labelAddress(address);
-  }
-  /**
-   * Returns list of addresses that should be watched for events to sync state
-   */
-  get watchAddresses() {
-    return /* @__PURE__ */ new Set();
-  }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/sdk/base/TokensMeta.js

@@ -25,11 +25,11 @@ var import_iVersion = require("../../abi/iVersion.js");
 var import__ = require("../index.js");
 var import_utils = require("../utils/index.js");
 class TokensMeta extends import_utils.AddressMap {
-  #sdk;
+  #client;
   #phantomTokensLoaded;
-  constructor(sdk) {
+  constructor(client) {
     super(void 0, "tokensMeta");
-    this.#sdk = sdk;
+    this.#client = client;
   }
   symbol(token) {
     return this.mustGet(token).symbol;
@@ -84,7 +84,7 @@ class TokensMeta extends import_utils.AddressMap {
   async loadPhantomTokens() {
     this.#phantomTokensLoaded = new import_utils.AddressSet();
     const tokens = this.keys();
-    const resp = await this.#sdk.client.multicall({
+    const resp = await this.#client.multicall({
       contracts: tokens.map(
         (t) => ({
           address: t,

package/dist/cjs/sdk/base/index.js

@@ -15,16 +15,18 @@ var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "defau
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var base_exports = {};
 module.exports = __toCommonJS(base_exports);
-__reExport(base_exports, require("./AddressLabeller.js"), module.exports);
 __reExport(base_exports, require("./BaseContract.js"), module.exports);
+__reExport(base_exports, require("./ChainContractsRegister.js"), module.exports);
+__reExport(base_exports, require("./Construct.js"), module.exports);
 __reExport(base_exports, require("./PlaceholderContract.js"), module.exports);
 __reExport(base_exports, require("./SDKConstruct.js"), module.exports);
 __reExport(base_exports, require("./TokensMeta.js"), module.exports);
 __reExport(base_exports, require("./types.js"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("./AddressLabeller.js"),
   ...require("./BaseContract.js"),
+  ...require("./ChainContractsRegister.js"),
+  ...require("./Construct.js"),
   ...require("./PlaceholderContract.js"),
   ...require("./SDKConstruct.js"),
   ...require("./TokensMeta.js"),

package/dist/cjs/sdk/core/BotListV3Contract.js

@@ -32,7 +32,7 @@ class BotListContract extends import_base.BaseContract {
     super(sdk, { addr: address, name: "BotListV3", abi });
     this.#currentBlock = sdk.chain.firstBlock ?? 0n;
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "setCreditManagerApprovedStatus": {
         const [creditManager, status] = params.args;
@@ -47,7 +47,7 @@ class BotListContract extends import_base.BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
   async syncState(toBlock) {