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

package/dist/esm/sdk/GearboxSDK.js

@@ -5,7 +5,7 @@ import {
   http,
   parseEventLogs
 } from "viem";
-import { AddressLabeller, TokensMeta } from "./base/index.js";
+import { ChainContractsRegister } from "./base/index.js";
 import { detectNetwork, getChain } from "./chain/index.js";
 import {
   ADDRESS_PROVIDER_V310,
@@ -30,7 +30,7 @@ import {
   PluginStateVersionError
 } from "./plugins/index.js";
 import { createRouter } from "./router/index.js";
-import { AddressMap, TypedObjectUtils, toAddress } from "./utils/index.js";
+import { TypedObjectUtils, toAddress } from "./utils/index.js";
 import { Hooks } from "./utils/internal/index.js";
 import { getLogsSafe } from "./utils/viem/index.js";
 const ERR_NOT_ATTACHED = new Error("Gearbox SDK not attached");
@@ -69,10 +69,9 @@ async function attachClient(options, network) {
   }
   return createClient(options, { networkType, chainId });
 }
-class GearboxSDK {
+class GearboxSDK extends ChainContractsRegister {
   #hooks = new Hooks();
   plugins;
-  #client;
   // Block which was use for data query
   #currentBlock;
   #timestamp;
@@ -83,29 +82,11 @@ class GearboxSDK {
   // Collection of markets
   #marketRegister;
   #priceFeeds;
-  logger;
   gasLimit;
-  addressLabels = new AddressLabeller();
-  /**
-   * Interest rate models can be reused across chain (and SDK operates on chain level)
-   * TODO: use whatever interface is necessary for InterestRateModels
-   */
-  interestRateModels = new AddressMap();
   /**
    * Will throw an error if contract type is not supported, otherwise will try to use generic contract first, if possible
    */
   strictContractTypes;
-  /**
-   * All contracts known to sdk
-   */
-  contracts = new AddressMap(
-    void 0,
-    "contracts"
-  );
-  /**
-   * Token metadata such as symbol and decimals
-   */
-  tokensMeta;
   addHook = this.#hooks.addHook.bind(this.#hooks);
   removeHook = this.#hooks.removeHook.bind(this.#hooks);
   static async attach(options) {
@@ -158,17 +139,16 @@ class GearboxSDK {
     }).#hydrate(rest, state);
   }
   constructor(options) {
-    this.logger = options.logger;
+    super(options.client, options.logger);
     this.strictContractTypes = options.strictContractTypes ?? false;
     this.plugins = options.plugins ?? {};
-    this.#client = options.client;
     for (const plugin of Object.values(this.plugins)) {
       plugin.sdk = this;
     }
     if (options.gasLimit !== null) {
       this.gasLimit = options.gasLimit || 550000000n;
     }
-    this.tokensMeta = new TokensMeta(this);
+    Object.assign(this, ChainContractsRegister.for(this.client, this.logger));
   }
   async #attach(opts) {
     const {
@@ -324,74 +304,9 @@ class GearboxSDK {
       timestamp: state.timestamp
     });
   }
-  get client() {
-    return this.#client;
-  }
-  /**
-   * Replaces client inflight
-   * You're responsible for all inconsistencies between new and old client
-   * @param options
-   */
-  replaceClient(options, network) {
-    this.#client = createClient(options, network);
-  }
   get networkType() {
     return this.client.chain.network;
   }
-  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
-   */
-  parseFunctionData(address, calldata) {
-    const contract = this.contracts.get(address);
-    return contract ? contract.parseFunctionData(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
-   */
-  parseMultiCall(calls) {
-    return calls.map(
-      (call) => this.parseFunctionData(call.target, call.callData)
-    );
-  }
-  /**
-   * Return args, function, type and address name from contract call
-   * @param address
-   * @param calldata
-   * @returns
-   */
-  parseFunctionDataToObject(address, calldata) {
-    const contract = this.contracts.get(address);
-    return contract ? {
-      ...contract.parseFunctionDataToObject(calldata),
-      address,
-      type: contract.contractType
-    } : null;
-  }
-  /**
-   * Converts multicalls into call info
-   * @param address
-   * @param calldata
-   * @returns
-   */
-  parseMultiCallToObject(calls) {
-    return calls.map(
-      (call) => this.parseFunctionDataToObject(call.target, call.callData)
-    );
-  }
   stateHuman(raw = true) {
     return {
       block: Number(this.currentBlock),
@@ -483,7 +398,7 @@ class GearboxSDK {
         address: watchAddresses
       });
       for (const log of logs) {
-        const contract = this.contracts.get(log.address);
+        const contract = this.getContract(log.address);
         if (contract) {
           const event = parseEventLogs({
             abi: contract.abi,
@@ -572,17 +487,11 @@ class GearboxSDK {
   }
   get botListContract() {
     const addr = this.addressProvider.getAddress(AP_BOT_LIST, NO_VERSION);
-    if (!this.contracts.has(addr)) {
-      return new BotListContract(this, addr);
-    }
-    return this.contracts.get(addr);
+    return this.getContract(addr) ?? new BotListContract(this, addr);
   }
   get gearStakingContract() {
     const addr = this.addressProvider.getAddress(AP_GEAR_STAKING, NO_VERSION);
-    if (!this.contracts.has(addr)) {
-      return new GearStakingContract(this, addr);
-    }
-    return this.contracts.get(addr);
+    return this.getContract(addr) ?? new GearStakingContract(this, addr);
   }
   get marketRegister() {
     if (this.#marketRegister === void 0) {
@@ -609,7 +518,7 @@ class GearboxSDK {
         );
         facadeAddr = cm.creditFacade.address;
       }
-      const facadeV = this.contracts.mustGet(facadeAddr).version;
+      const facadeV = this.mustGetContract(facadeAddr).version;
       routerRange = isV310(facadeV) ? VERSION_RANGE_310 : VERSION_RANGE_300;
     }
     const routerEntry = this.addressProvider.getLatest(AP_ROUTER, routerRange);
@@ -617,18 +526,7 @@ class GearboxSDK {
       throw new Error(`router not found in version range ${routerRange}`);
     }
     const [routerAddr, routerV] = routerEntry;
-    if (!this.contracts.has(routerAddr)) {
-      return createRouter(this, routerAddr, routerV);
-    }
-    return this.contracts.get(routerAddr);
-  }
-  /**
-   * Helper to get human-friendly label for address
-   * @param address
-   * @returns
-   */
-  labelAddress(address) {
-    return this.addressLabels.get(address);
+    return createRouter(this, routerAddr, routerV);
   }
 }
 export {

package/dist/esm/sdk/accountMigration/AbstractMigrateCreditAccountsService.js

@@ -7,9 +7,7 @@ import { createCreditAccountService } from "../accounts/createCreditAccountServi
 import { SDKConstruct } from "../base/index.js";
 import { chains as CHAINS } from "../chain/chains.js";
 import { isV310 } from "../constants/versions.js";
-import { childLogger } from "../utils/index.js";
 class AbstractMigrateCreditAccountsService extends SDKConstruct {
-  #logger;
   #version;
   #service;
   // TODO: HARDCODED
@@ -27,8 +25,7 @@ class AbstractMigrateCreditAccountsService extends SDKConstruct {
     super(sdk);
     this.#version = version;
     this.#service = createCreditAccountService(this.sdk, version);
-    this.#logger = childLogger("MigrateCreditAccountsService", sdk.logger);
-    this.#logger?.debug(
+    this.logger?.debug(
       `Created MigrateCreditAccountsService with version: ${this.#version}`
     );
   }

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

@@ -24,7 +24,7 @@ import {
 } from "../constants/index.js";
 import { assetsMap } from "../router/index.js";
 import { BigIntMath } from "../sdk-legacy/index.js";
-import { AddressMap, childLogger } from "../utils/index.js";
+import { AddressMap } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 function getWithdrawalCompressorAddress(chainId) {
   const compressor = chainId === 1 ? "0xfB79b6713fe214B8748ED7b0db1f93E4f1aC9d29" : void 0;
@@ -33,7 +33,6 @@ function getWithdrawalCompressorAddress(chainId) {
 class AbstractCreditAccountService extends SDKConstruct {
   #compressor;
   #batchSize;
-  #logger;
   constructor(sdk, options) {
     super(sdk);
     [this.#compressor] = sdk.addressProvider.mustGetLatest(
@@ -41,8 +40,7 @@ class AbstractCreditAccountService extends SDKConstruct {
       VERSION_RANGE_310
     );
     this.#batchSize = options?.batchSize;
-    this.#logger = childLogger("CreditAccountsService", sdk.logger);
-    this.#logger?.debug(
+    this.logger?.debug(
       `credit account compressor address: ${this.#compressor}`
     );
   }
@@ -144,7 +142,7 @@ class AbstractCreditAccountService extends SDKConstruct {
         offset = newOffset;
       } while (offset !== 0n);
     }
-    this.#logger?.debug(
+    this.logger?.debug(
       `loaded ${allCAs.length} credit accounts (${allCAs.length - revertingOffset} reverting)`
     );
     return allCAs.sort((a, b) => Number(a.healthFactor - b.healthFactor));
@@ -278,7 +276,7 @@ class AbstractCreditAccountService extends SDKConstruct {
       lossPolicyData = await market.lossPolicy.getLiquidationData(
         account.creditAccount
       );
-      this.#logger?.debug({ lossPolicyData }, "loss policy data");
+      this.logger?.debug({ lossPolicyData }, "loss policy data");
     }
     const tx = cm.creditFacade.liquidateCreditAccount(
       account.creditAccount,
@@ -836,7 +834,7 @@ class AbstractCreditAccountService extends SDKConstruct {
         gas: this.sdk.gasLimit
       });
     }
-    this.#logger?.debug(
+    this.logger?.debug(
       {
         accounts: resp[0]?.length ?? 0,
         nextOffset: Number(resp[1])
@@ -916,7 +914,7 @@ class AbstractCreditAccountService extends SDKConstruct {
     });
     const tStr = Array.from(tokens).map((t) => this.labelAddress(t)).join(", ");
     const remark = ignoreReservePrices ? " main" : "";
-    this.#logger?.debug(
+    this.logger?.debug(
       { account: creditAccount?.creditAccount, manager: cm.name },
       `generating price feed updates for ${tStr} from ${priceFeeds.length}${remark} price feeds`
     );
@@ -932,7 +930,7 @@ class AbstractCreditAccountService extends SDKConstruct {
     const market = this.sdk.marketRegister.findByCreditManager(creditManager);
     const cm = this.sdk.marketRegister.findCreditManager(creditManager);
     const update = await this.getUpdateForAccount(options);
-    this.#logger?.debug(
+    this.logger?.debug(
       { account: creditAccount?.creditAccount, manager: cm.name },
       `getting on demand price updates from ${update.txs.length} txs`
     );

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

@@ -1,65 +1,66 @@
-import { decodeFunctionData, getAddress, getContract, isHex } from "viem";
+import {
+  BaseError,
+  decodeFunctionData,
+  getAbiItem,
+  getAddress,
+  getContract,
+  isHex
+} from "viem";
 import { errorAbis } from "../../abi/errors.js";
-import { iVersionAbi } from "../../abi/iVersion.js";
-import { ADDRESS_0X0 } from "../constants/index.js";
 import {
   bytes32ToString,
-  childLogger,
   createRawTx,
+  functionArgsToMap,
   json_stringify
 } from "../utils/index.js";
-import { SDKConstruct } from "./SDKConstruct.js";
-class BaseContract extends SDKConstruct {
+import { Construct } from "./Construct.js";
+class ContractParseError extends 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 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 = getAddress(args.addr);
+    this.address = getAddress(args.addr);
     this.contract = getContract({
       address: this.address,
       // add exceptions for better error decoding
       abi: [...this.abi, ...errorAbis],
-      client: {
-        public: sdk.client
-      }
+      client
     });
     this.version = Number(args.version || 0);
     this.contractType = args.contractType ?? "";
     if (isHex(this.contractType)) {
       this.contractType = bytes32ToString(this.contractType);
     }
-    this.name = this.#name = args.name || this.contractType || this.#address;
-    this.logger = childLogger(this.name, sdk.logger);
-    sdk.contracts.upsert(this.address, this);
-  }
-  get address() {
-    return this.#address;
-  }
-  set address(address) {
-    if (this.#address !== ADDRESS_0X0) {
-      throw new Error(`Address can't be changed, currently: ${this.#address}`);
-    }
-    this.#address = getAddress(address);
-    this.sdk.addressLabels.set(address, this.#name);
-  }
-  get name() {
-    return this.#name;
-  }
-  set name(name) {
-    this.#name = name;
-    if (this.#address !== 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
     };
@@ -71,14 +72,68 @@ class BaseContract extends 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 = 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 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(
@@ -87,59 +142,64 @@ class BaseContract extends 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 = decodeFunctionData({
       abi: this.abi,
       data: calldata
     });
-    const abiItem = this.abi.find(
-      (abiItem2) => abiItem2?.name === decoded.functionName && abiItem2?.type === "function"
-    );
-    if (!abiItem) {
+    const abiItem = 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") ? 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 = decodeFunctionData({
+  stringifyFunctionParams(decoded) {
+    const abiItem = 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") ? json_stringify(v) : `${v}`;
+      });
+    }
+    return Object.entries(decoded.args || {}).map((v) => `${v}`);
   }
-  async getVersion() {
-    this.version = Number(
-      await this.sdk.client.readContract({
-        abi: 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 = createRawTx(
@@ -150,10 +210,71 @@ class BaseContract extends 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;
+    }
+  }
 }
 export {
-  BaseContract
+  BaseContract,
+  ContractParseError
 };