@gearbox-protocol/sdk 11.11.0-next.1 → 11.11.0

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

@@ -1,66 +1,65 @@
-import {
-  BaseError,
-  decodeFunctionData,
-  getAbiItem,
-  getAddress,
-  getContract,
-  isHex
-} from "viem";
+import { decodeFunctionData, 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 { 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 {
+import { SDKConstruct } from "./SDKConstruct.js";
+class BaseContract extends SDKConstruct {
   contract;
   abi;
+  logger;
   contractType;
   version;
-  address;
-  name;
-  constructor({ client, logger }, args) {
-    super({ client, logger });
+  #name;
+  #address;
+  constructor(sdk, args) {
+    super(sdk);
     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
+      client: {
+        public: sdk.client
+      }
     });
     this.version = Number(args.version || 0);
     this.contractType = args.contractType ?? "";
     if (isHex(this.contractType)) {
       this.contractType = bytes32ToString(this.contractType);
     }
-    this.name = args.name || this.contractType || this.address || this.constructor.name;
-    this.register.setContract(this.address, this);
-    this.register.setAddressLabel(this.address, this.name);
+    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);
+    }
   }
   stateHuman(_ = true) {
     return {
-      address: this.labelAddress(this.address),
+      address: this.sdk.labelAddress(this.address),
       version: this.version,
       contractType: this.contractType
     };
@@ -71,69 +70,15 @@ class BaseContract extends Construct {
    */
   processLog(_log) {
   }
-  /**
-   * 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) {
+  parseFunctionData(calldata) {
     try {
-      return this.mustStringifyFunctionData(calldata);
+      return this.mustParseFunctionData(calldata);
     } catch (e) {
       const selector = calldata.slice(0, 10);
       this.logger?.warn(
@@ -142,64 +87,59 @@ class BaseContract extends Construct {
       return `unknown: ${this.labelAddress(this.address)}.${selector}`;
     }
   }
-  /**
-   * Same as {@link stingifyFunctionData}, but throws if error occurs
-   * @param calldata
-   * @returns
-   */
-  mustStringifyFunctionData(calldata) {
+  mustParseFunctionData(calldata) {
     const decoded = decodeFunctionData({
       abi: this.abi,
       data: calldata
     });
-    const abiItem = getAbiItem({
-      abi: this.abi,
-      name: decoded.functionName,
-      args: decoded.args
-    });
-    if (!abiItem || abiItem.type !== "function") {
+    const abiItem = this.abi.find(
+      (abiItem2) => abiItem2?.name === decoded.functionName && abiItem2?.type === "function"
+    );
+    if (!abiItem) {
       return `Unknown function: ${decoded.functionName}`;
     }
-    const params = this.stringifyFunctionParams(decoded).map(
-      (v, i) => `${abiItem.inputs[i].name}: ${v}`
-    );
-    return `${this.name}.${decoded.functionName}({${params.join(", ")}})`;
+    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(", ")}})`;
   }
   /**
-   * 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
+   * Return args and function name from calldata
+   * @param calldata
    * @returns
    */
-  stringifyFunctionParams(decoded) {
-    const abiItem = getAbiItem({
+  parseFunctionDataToObject(calldata) {
+    const decoded = decodeFunctionData({
       abi: this.abi,
-      name: decoded.functionName,
-      args: decoded.args
+      data: calldata
     });
-    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}`);
+    return decoded;
   }
-  wrapParseCall(functionName, args) {
-    return {
-      chainId: this.chainId,
-      target: this.address,
-      contractType: this.contractType,
-      label: this.register.labelAddress(this.address),
-      functionName,
-      args
-    };
+  parseFunctionParams(_params) {
+    return void 0;
+  }
+  async getVersion() {
+    this.version = Number(
+      await this.sdk.client.readContract({
+        abi: iVersionAbi,
+        functionName: "version",
+        address: this.address
+      })
+    );
+    return this.version;
   }
-  /**
-   * Creates a raw transaction for a function in this contract
-   * @param parameters
-   * @returns
-   */
   createRawTx(parameters) {
     const { description: argsDescription } = parameters;
     const tx = createRawTx(
@@ -210,71 +150,10 @@ class BaseContract extends Construct {
       },
       argsDescription
     );
-    tx.description = argsDescription || this.stringifyFunctionData(tx.callData);
+    tx.description = argsDescription || this.parseFunctionData(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,
-  ContractParseError
+  BaseContract
 };

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

@@ -1,10 +1,36 @@
-import { Construct } from "./Construct.js";
-class SDKConstruct extends Construct {
+class SDKConstruct {
   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();
+  }
 }
 export {
   SDKConstruct

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

@@ -2,11 +2,11 @@ import { iVersionAbi } from "../../abi/iVersion.js";
 import { bytes32ToString } from "../index.js";
 import { AddressMap, AddressSet, formatBN } from "../utils/index.js";
 class TokensMeta extends AddressMap {
-  #client;
+  #sdk;
   #phantomTokensLoaded;
-  constructor(client) {
+  constructor(sdk) {
     super(void 0, "tokensMeta");
-    this.#client = client;
+    this.#sdk = sdk;
   }
   symbol(token) {
     return this.mustGet(token).symbol;
@@ -61,7 +61,7 @@ class TokensMeta extends AddressMap {
   async loadPhantomTokens() {
     this.#phantomTokensLoaded = new AddressSet();
     const tokens = this.keys();
-    const resp = await this.#client.multicall({
+    const resp = await this.#sdk.client.multicall({
       contracts: tokens.map(
         (t) => ({
           address: t,

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

@@ -1,6 +1,5 @@
+export * from "./AddressLabeller.js";
 export * from "./BaseContract.js";
-export * from "./ChainContractsRegister.js";
-export * from "./Construct.js";
 export * from "./PlaceholderContract.js";
 export * from "./SDKConstruct.js";
 export * from "./TokensMeta.js";

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

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

package/dist/esm/sdk/core/GearStakingV3Contract.js

@@ -6,14 +6,14 @@ class GearStakingContract extends BaseContract {
   constructor(sdk, address) {
     super(sdk, { addr: address, name: "GearStakingV3", abi });
   }
-  stringifyFunctionParams(params) {
+  parseFunctionParams(params) {
     switch (params.functionName) {
       case "setVotingContractStatus": {
         const [address, status] = params.args;
         return [this.labelAddress(address), VotingContractStatus[status]];
       }
       default:
-        return super.stringifyFunctionParams(params);
+        return void 0;
     }
   }
   stateHuman(raw = true) {

package/dist/esm/sdk/core/address-provider/AbstractAddressProviderContract.js

@@ -4,8 +4,8 @@ import { NO_VERSION } from "../../constants/index.js";
 import { TypedObjectUtils } from "../../utils/mappers.js";
 class AbstractAddressProviderContract extends BaseContract {
   #addresses = {};
-  constructor(options, args, addresses = {}) {
-    super(options, args);
+  constructor(sdk, args, addresses = {}) {
+    super(sdk, args);
     this.#addresses = addresses;
   }
   setInternalAddress(key, address, version) {

package/dist/esm/sdk/core/address-provider/AddressProviderV300Contract.js

@@ -4,9 +4,9 @@ import { getLogsSafe } from "../../utils/viem/index.js";
 import AbstractAddressProviderContract from "./AbstractAddressProviderContract.js";
 const abi = iAddressProviderV300Abi;
 class AddressProviderV300Contract extends AbstractAddressProviderContract {
-  constructor(options, address, version, addresses = {}) {
+  constructor(sdk, address, version, addresses = {}) {
     super(
-      options,
+      sdk,
       {
         addr: address,
         name: "AddressProviderV300",
@@ -16,7 +16,7 @@ class AddressProviderV300Contract extends AbstractAddressProviderContract {
       addresses
     );
   }
-  stringifyFunctionParams(params) {
+  parseFunctionParams(params) {
     switch (params.functionName) {
       case "setAddress": {
         if (params.args.length !== 3) {
@@ -27,7 +27,7 @@ class AddressProviderV300Contract extends AbstractAddressProviderContract {
         return [bytesToString(toBytes(key)), value, `${saveVersion}`];
       }
       default:
-        return super.stringifyFunctionParams(params);
+        return void 0;
     }
   }
   processLog(log) {
@@ -52,16 +52,11 @@ class AddressProviderV300Contract extends AbstractAddressProviderContract {
     }
   }
   async syncState(blockNumber) {
-    if (!("firstBlock" in this.chain)) {
-      throw new Error(
-        `address provider v300 requires gearbox chain for ${this.chain.id} `
-      );
-    }
-    const fromBlock = this.chain.firstBlock;
+    const fromBlock = this.sdk.chain.firstBlock;
     this.logger?.debug(
       `loading events from block ${fromBlock} to ${blockNumber}`
     );
-    const events = await getLogsSafe(this.client, {
+    const events = await getLogsSafe(this.sdk.client, {
       address: this.address,
       event: getAbiItem({ abi: this.abi, name: "SetAddress" }),
       fromBlock,

package/dist/esm/sdk/core/address-provider/AddressProviderV310Contract.js

@@ -3,9 +3,9 @@ import { iAddressProviderV310Abi } from "../../../abi/310/generated.js";
 import AbstractAddressProviderContract from "./AbstractAddressProviderContract.js";
 const abi = iAddressProviderV310Abi;
 class AddressProviderV310Contract extends AbstractAddressProviderContract {
-  constructor(options, address, version = 310, addresses = {}) {
+  constructor(sdk, address, version, addresses = {}) {
     super(
-      options,
+      sdk,
       {
         addr: address,
         name: "AddressProviderV310",
@@ -15,7 +15,7 @@ class AddressProviderV310Contract extends AbstractAddressProviderContract {
       addresses
     );
   }
-  stringifyFunctionParams(params) {
+  parseFunctionParams(params) {
     switch (params.functionName) {
       case "setAddress": {
         if (params.args.length !== 3) {
@@ -26,7 +26,7 @@ class AddressProviderV310Contract extends AbstractAddressProviderContract {
         return [bytesToString(toBytes(key)), value, `${saveVersion}`];
       }
       default:
-        return super.stringifyFunctionParams(params);
+        return void 0;
     }
   }
   processLog(log) {

package/dist/esm/sdk/market/MarketConfiguratorContract.js

@@ -7,8 +7,8 @@ import { AP_MARKET_CONFIGURATOR } from "../constants/index.js";
 const abi = iMarketConfiguratorV310Abi;
 class MarketConfiguratorContract extends BaseContract {
   #curatorName;
-  constructor(options, address) {
-    super(options, {
+  constructor(sdk, address) {
+    super(sdk, {
       abi,
       addr: address,
       contractType: AP_MARKET_CONFIGURATOR,
@@ -16,18 +16,18 @@ class MarketConfiguratorContract extends BaseContract {
     });
   }
   async loadCuratorName() {
-    this.#curatorName = await this.client.readContract({
+    this.#curatorName = await this.sdk.client.readContract({
       address: this.address,
       abi: this.abi,
       functionName: "curatorName"
     });
-    this.register.setAddressLabel(
+    this.sdk.addressLabels.set(
       this.address,
       `Market configurator ${this.#curatorName}`
     );
   }
   async getPeripheryContract(contract) {
-    const resp = await this.client.readContract({
+    const resp = await this.sdk.client.readContract({
       address: this.address,
       abi: this.abi,
       functionName: "getPeripheryContracts",

package/dist/esm/sdk/market/MarketRegister.js

@@ -5,11 +5,12 @@ import {
   AP_MARKET_COMPRESSOR,
   VERSION_RANGE_310
 } from "../constants/index.js";
-import { AddressMap } from "../utils/index.js";
+import { AddressMap, childLogger } from "../utils/index.js";
 import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 class MarketRegister extends SDKConstruct {
+  #logger;
   /**
    * Mapping pool.address -> MarketSuite
    */
@@ -22,6 +23,7 @@ class MarketRegister extends SDKConstruct {
   #ignoreMarkets;
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
+    this.#logger = childLogger("MarketRegister", sdk.logger);
     this.#ignoreMarkets = new Set(
       ignoreMarkets.map((m) => m.toLowerCase())
     );
@@ -33,7 +35,7 @@ class MarketRegister extends SDKConstruct {
     for (const data of state) {
       const pool = data.pool.baseParams.addr;
       if (this.#ignoreMarkets.has(pool.toLowerCase())) {
-        this.logger?.debug(
+        this.#logger?.debug(
           `ignoring market of pool ${pool} (${data.pool.name})`
         );
         continue;
@@ -46,7 +48,7 @@ class MarketRegister extends SDKConstruct {
   }
   async loadMarkets(marketConfigurators, ignoreUpdateablePrices) {
     if (!marketConfigurators.length) {
-      this.logger?.warn(
+      this.#logger?.warn(
         "no market configurators provided, skipping loadMarkets"
       );
       return;
@@ -77,7 +79,7 @@ class MarketRegister extends SDKConstruct {
   async syncState(ignoreUpdateablePrices) {
     const dirty = this.markets.some((m) => m.dirty) || this.marketConfigurators.some((c) => c.dirty);
     if (dirty) {
-      this.logger?.debug(
+      this.#logger?.debug(
         "some markets or market configurators are dirty, reloading everything"
       );
       await this.#loadMarkets(
@@ -104,7 +106,7 @@ class MarketRegister extends SDKConstruct {
       const updates = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(updatables);
       txs = updates.txs;
     }
-    this.logger?.debug(
+    this.#logger?.debug(
       { configurators, pools },
       `calling getMarkets with ${txs.length} price updates in block ${this.sdk.currentBlock}`
     );
@@ -138,14 +140,14 @@ class MarketRegister extends SDKConstruct {
     for (const data of markets) {
       const pool = data.pool.baseParams.addr;
       if (this.#ignoreMarkets.has(pool.toLowerCase())) {
-        this.logger?.debug(
+        this.#logger?.debug(
           `ignoring market of pool ${pool} (${data.pool.name})`
         );
         continue;
       }
       this.#markets.upsert(pool, new MarketSuite(this.sdk, data));
     }
-    this.logger?.info(
+    this.#logger?.info(
       `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
     );
   }
@@ -164,7 +166,7 @@ class MarketRegister extends SDKConstruct {
     if (!multicalls.length) {
       return;
     }
-    this.logger?.debug(`syncing prices on ${multicalls.length} oracles`);
+    this.#logger?.debug(`syncing prices on ${multicalls.length} oracles`);
     const { txs } = await this.sdk.priceFeeds.generatePriceFeedsUpdateTxs();
     const oraclesStates = await simulateWithPriceUpdates(this.client, {
       priceUpdates: txs,