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

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

@@ -0,0 +1,111 @@
+import { NOT_DEPLOYED } from "../constants/addresses.js";
+import { AddressMap } from "../utils/AddressMap.js";
+import { TokensMeta } from "./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 AddressMap(
+    [],
+    "contracts"
+  );
+  labels = new AddressMap([], "labels");
+  client;
+  /**
+   * Token metadata such as symbol and decimals
+   */
+  tokensMeta;
+  logger;
+  constructor(client, logger) {
+    this.client = client;
+    this.tokensMeta = new 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 === 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)
+    );
+  }
+}
+export {
+  ChainContractsRegister
+};

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

@@ -0,0 +1,63 @@
+import { childLogger } from "../utils/index.js";
+import { ChainContractsRegister } from "./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 = ChainContractsRegister.for(client, logger);
+    this.logger = 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();
+  }
+}
+export {
+  Construct
+};

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

@@ -1,36 +1,10 @@
-class SDKConstruct {
+import { Construct } from "./Construct.js";
+class SDKConstruct extends 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();
-  }
 }
 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 {
-  #sdk;
+  #client;
   #phantomTokensLoaded;
-  constructor(sdk) {
+  constructor(client) {
     super(void 0, "tokensMeta");
-    this.#sdk = sdk;
+    this.#client = client;
   }
   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.#sdk.client.multicall({
+    const resp = await this.#client.multicall({
       contracts: tokens.map(
         (t) => ({
           address: t,

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

@@ -1,5 +1,6 @@
-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;
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "setCreditManagerApprovedStatus": {
         const [creditManager, status] = params.args;
@@ -24,7 +24,7 @@ class BotListContract extends BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
   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 });
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "setVotingContractStatus": {
         const [address, status] = params.args;
         return [this.labelAddress(address), VotingContractStatus[status]];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
   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(sdk, args, addresses = {}) {
-    super(sdk, args);
+  constructor(options, args, addresses = {}) {
+    super(options, 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(sdk, address, version, addresses = {}) {
+  constructor(options, address, version, addresses = {}) {
     super(
-      sdk,
+      options,
       {
         addr: address,
         name: "AddressProviderV300",
@@ -16,7 +16,7 @@ class AddressProviderV300Contract extends AbstractAddressProviderContract {
       addresses
     );
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(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 void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
   processLog(log) {
@@ -52,11 +52,16 @@ class AddressProviderV300Contract extends 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 getLogsSafe(this.sdk.client, {
+    const events = await getLogsSafe(this.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(sdk, address, version, addresses = {}) {
+  constructor(options, address, version = 310, addresses = {}) {
     super(
-      sdk,
+      options,
       {
         addr: address,
         name: "AddressProviderV310",
@@ -15,7 +15,7 @@ class AddressProviderV310Contract extends AbstractAddressProviderContract {
       addresses
     );
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(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 void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
   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(sdk, address) {
-    super(sdk, {
+  constructor(options, address) {
+    super(options, {
       abi,
       addr: address,
       contractType: AP_MARKET_CONFIGURATOR,
@@ -16,18 +16,18 @@ class MarketConfiguratorContract extends 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/esm/sdk/market/MarketRegister.js

@@ -5,12 +5,11 @@ import {
   AP_MARKET_COMPRESSOR,
   VERSION_RANGE_310
 } from "../constants/index.js";
-import { AddressMap, childLogger } from "../utils/index.js";
+import { AddressMap } 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
    */
@@ -23,7 +22,6 @@ 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())
     );
@@ -35,7 +33,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;
@@ -48,7 +46,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;
@@ -79,7 +77,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(
@@ -106,7 +104,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}`
     );
@@ -140,14 +138,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}`
     );
   }
@@ -166,7 +164,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,

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

@@ -21,7 +21,7 @@ class MarketSuite extends 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 MarketConfiguratorContract)) {
       throw new Error(
         `Market configurator ${marketData.configurator} is not a market configurator`
@@ -32,7 +32,7 @@ class MarketSuite extends 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 PoolSuite(sdk, marketData);
     for (let i = 0; i < marketData.creditManagers.length; i++) {

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

@@ -5,7 +5,7 @@ import { RAMP_DURATION_BY_NETWORK } from "../../constants/index.js";
 import { formatDuration, percentFmt } from "../../utils/index.js";
 const abi = [...iCreditConfiguratorV300Abi, ...iPausableAbi];
 class CreditConfiguratorV300Contract extends BaseContract {
-  adapters = [];
+  sdk;
   isPaused = false;
   constructor(sdk, { creditConfigurator, creditManager }) {
     super(sdk, {
@@ -13,6 +13,7 @@ class CreditConfiguratorV300Contract extends BaseContract {
       name: `CreditConfigurator(${creditManager.name})`,
       abi
     });
+    this.sdk = sdk;
   }
   processLog(log) {
     switch (log.eventName) {
@@ -59,7 +60,7 @@ class CreditConfiguratorV300Contract extends BaseContract {
     });
     return logs.map(({ args }) => args);
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "addCollateralToken":
       case "setLiquidationThreshold": {
@@ -105,7 +106,7 @@ class CreditConfiguratorV300Contract extends BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
 }

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

@@ -4,7 +4,7 @@ import { RAMP_DURATION_BY_NETWORK } from "../../constants/index.js";
 import { formatDuration, percentFmt } from "../../utils/index.js";
 const abi = iCreditConfiguratorV310Abi;
 class CreditConfiguratorV310Contract extends BaseContract {
-  adapters = [];
+  sdk;
   isPaused = false;
   constructor(sdk, { creditConfigurator, creditManager }) {
     super(sdk, {
@@ -12,6 +12,7 @@ class CreditConfiguratorV310Contract extends BaseContract {
       name: `CreditConfigurator(${creditManager.name})`,
       abi
     });
+    this.sdk = sdk;
   }
   processLog(log) {
     switch (log.eventName) {
@@ -46,7 +47,7 @@ class CreditConfiguratorV310Contract extends BaseContract {
     });
     return logs.map(({ args }) => args);
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "addCollateralToken":
       case "setLiquidationThreshold": {
@@ -90,7 +91,7 @@ class CreditConfiguratorV310Contract extends BaseContract {
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
 }

package/dist/esm/sdk/market/credit/CreditFacadeV300Contract.js

@@ -13,9 +13,9 @@ const abi = [
 ];
 class CreditFacadeV300Contract extends BaseContract {
   underlying;
-  constructor(sdk, { creditFacade, creditManager }) {
+  constructor(options, { creditFacade, creditManager }) {
     const { baseParams, ...rest } = creditFacade;
-    super(sdk, {
+    super(options, {
       ...baseParams,
       name: `CreditFacadeV3(${creditManager.name})`,
       abi
@@ -24,7 +24,7 @@ class CreditFacadeV300Contract extends BaseContract {
     this.underlying = creditManager.underlying;
   }
   stateHuman(raw) {
-    const decimals = this.sdk.tokensMeta.decimals(this.underlying);
+    const decimals = this.tokensMeta.decimals(this.underlying);
     return {
       ...super.stateHuman(raw),
       expirable: this.expirable,
@@ -88,13 +88,13 @@ class CreditFacadeV300Contract extends BaseContract {
       args: [to, calls, referralCode]
     });
   }
-  parseFunctionParams(params) {
+  stringifyFunctionParams(params) {
     switch (params.functionName) {
       case "openCreditAccount": {
         const [onBehalfOf, calls, referralCode] = params.args;
         return [
           this.labelAddress(onBehalfOf),
-          this.sdk.parseMultiCall([...calls]).join(","),
+          this.register.parseMultiCall([...calls]).join(","),
           `${referralCode}`
         ];
       }
@@ -102,7 +102,7 @@ class CreditFacadeV300Contract extends BaseContract {
         const [creditAccount, calls] = params.args;
         return [
           this.labelAddress(creditAccount),
-          this.sdk.parseMultiCall([...calls]).join(",")
+          this.register.parseMultiCall([...calls]).join(",")
         ];
       }
       case "liquidateCreditAccount": {
@@ -110,7 +110,7 @@ class CreditFacadeV300Contract extends BaseContract {
         return [
           this.labelAddress(creditAccount),
           this.labelAddress(to),
-          this.sdk.parseMultiCall([...calls]).join(",")
+          this.register.parseMultiCall([...calls]).join(",")
         ];
       }
       case "setBotPermissions": {
@@ -125,12 +125,12 @@ class CreditFacadeV300Contract extends BaseContract {
         const [deltas] = params.args;
         return [
           deltas.map(({ token, amount }) => {
-            return this.labelAddress(token) + ": " + this.sdk.tokensMeta.formatBN(token, amount);
+            return this.labelAddress(token) + ": " + this.tokensMeta.formatBN(token, amount);
           }).join(",")
         ];
       }
       default:
-        return void 0;
+        return super.stringifyFunctionParams(params);
     }
   }
 }