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

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) {

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

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

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

@@ -27,8 +27,8 @@ var import_constants = require("../../constants/index.js");
 var import_mappers = require("../../utils/mappers.js");
 class AbstractAddressProviderContract extends import_base.BaseContract {
   #addresses = {};
-  constructor(sdk, args, addresses = {}) {
-    super(sdk, args);
+  constructor(options, args, addresses = {}) {
+    super(options, args);
     this.#addresses = addresses;
   }
   setInternalAddress(key, address, version) {

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

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

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

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

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

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

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

@@ -29,7 +29,6 @@ var import_viem = require("../utils/viem/index.js");
 var import_MarketConfiguratorContract = require("./MarketConfiguratorContract.js");
 var import_MarketSuite = require("./MarketSuite.js");
 class MarketRegister extends import_base.SDKConstruct {
-  #logger;
   /**
    * Mapping pool.address -> MarketSuite
    */
@@ -42,7 +41,6 @@ class MarketRegister extends import_base.SDKConstruct {
   #ignoreMarkets;
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
-    this.#logger = (0, import_utils.childLogger)("MarketRegister", sdk.logger);
     this.#ignoreMarkets = new Set(
       ignoreMarkets.map((m) => m.toLowerCase())
     );
@@ -54,7 +52,7 @@ class MarketRegister extends import_base.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;
@@ -67,7 +65,7 @@ class MarketRegister extends import_base.SDKConstruct {
   }
   async loadMarkets(marketConfigurators, ignoreUpdateablePrices) {
     if (!marketConfigurators.length) {
-      this.#logger?.warn(
+      this.logger?.warn(
         "no market configurators provided, skipping loadMarkets"
       );
       return;
@@ -98,7 +96,7 @@ class MarketRegister extends import_base.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(
@@ -125,7 +123,7 @@ class MarketRegister extends import_base.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}`
     );
@@ -159,14 +157,14 @@ class MarketRegister extends import_base.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 import_MarketSuite.MarketSuite(this.sdk, data));
     }
-    this.#logger?.info(
+    this.logger?.info(
       `loaded ${this.#markets.size} markets in block ${this.sdk.currentBlock}`
     );
   }
@@ -185,7 +183,7 @@ class MarketRegister extends import_base.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 (0, import_viem.simulateWithPriceUpdates)(this.client, {
       priceUpdates: txs,

package/dist/cjs/sdk/market/MarketSuite.js

@@ -42,7 +42,7 @@ class MarketSuite extends import_base.SDKConstruct {
   constructor(sdk, marketData) {
     super(sdk);
     this.state = marketData;
-    const mc = sdk.contracts.mustGet(marketData.configurator);
+    const mc = sdk.mustGetContract(marketData.configurator);
     if (!(mc instanceof import_MarketConfiguratorContract.MarketConfiguratorContract)) {
       throw new Error(
         `Market configurator ${marketData.configurator} is not a market configurator`
@@ -53,7 +53,7 @@ class MarketSuite extends import_base.SDKConstruct {
     this.treasury = marketData.treasury;
     for (const t of marketData.tokens) {
       sdk.tokensMeta.upsert(t.addr, t);
-      sdk.addressLabels.set(t.addr, t.symbol);
+      sdk.setAddressLabel(t.addr, t.symbol);
     }
     this.pool = new import_pool.PoolSuite(sdk, marketData);
     for (let i = 0; i < marketData.creditManagers.length; i++) {

package/dist/cjs/sdk/market/credit/CreditConfiguratorV300Contract.js

@@ -28,7 +28,7 @@ var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
 const abi = [...import_v300.iCreditConfiguratorV300Abi, ...import_iPausable.iPausableAbi];
 class CreditConfiguratorV300Contract extends import_base.BaseContract {
-  adapters = [];
+  sdk;
   isPaused = false;
   constructor(sdk, { creditConfigurator, creditManager }) {
     super(sdk, {
@@ -36,6 +36,7 @@ class CreditConfiguratorV300Contract extends import_base.BaseContract {
       name: `CreditConfigurator(${creditManager.name})`,
       abi
     });
+    this.sdk = sdk;
   }
   processLog(log) {
     switch (log.eventName) {
@@ -82,7 +83,7 @@ class CreditConfiguratorV300Contract extends import_base.BaseContract {
     });
     return logs.map(({ args }) => args);
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "addCollateralToken":
       case "setLiquidationThreshold": {
@@ -128,7 +129,7 @@ class CreditConfiguratorV300Contract extends import_base.BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
 }

package/dist/cjs/sdk/market/credit/CreditConfiguratorV310Contract.js

@@ -27,7 +27,7 @@ var import_constants = require("../../constants/index.js");
 var import_utils = require("../../utils/index.js");
 const abi = import_generated.iCreditConfiguratorV310Abi;
 class CreditConfiguratorV310Contract extends import_base.BaseContract {
-  adapters = [];
+  sdk;
   isPaused = false;
   constructor(sdk, { creditConfigurator, creditManager }) {
     super(sdk, {
@@ -35,6 +35,7 @@ class CreditConfiguratorV310Contract extends import_base.BaseContract {
       name: `CreditConfigurator(${creditManager.name})`,
       abi
     });
+    this.sdk = sdk;
   }
   processLog(log) {
     switch (log.eventName) {
@@ -69,7 +70,7 @@ class CreditConfiguratorV310Contract extends import_base.BaseContract {
     });
     return logs.map(({ args }) => args);
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "addCollateralToken":
       case "setLiquidationThreshold": {
@@ -113,7 +114,7 @@ class CreditConfiguratorV310Contract extends import_base.BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
 }