@gearbox-protocol/sdk 13.3.3 → 13.3.5

package/dist/cjs/sdk/accounts/CreditAccountsServiceV310.js

@@ -27,7 +27,7 @@ var import_math = require("../constants/math.js");
 var import_AbstractCreditAccountsService = require("./AbstractCreditAccountsService.js");
 class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.AbstractCreditAccountService {
   /**
-   * Implements {@link ICreditAccountsService.setBot}
+   * {@inheritDoc ICreditAccountsService.setBot}
    */
   async setBot({
     botAddress,
@@ -69,7 +69,7 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.withdrawCollateral}
+   * {@inheritDoc ICreditAccountsService.withdrawCollateral}
    */
   async withdrawCollateral({
     creditAccount,
@@ -104,7 +104,7 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayCreditAccount}
    */
   async repayCreditAccount({
     operation,
@@ -140,7 +140,7 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayAndLiquidateCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
    */
   async repayAndLiquidateCreditAccount({
     collateralAssets,
@@ -177,7 +177,7 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.claimFarmRewards}
+   * {@inheritDoc ICreditAccountsService.claimFarmRewards}
    */
   async claimFarmRewards({
     calls: externalCalls,

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

@@ -45,11 +45,30 @@ class ContractParseError extends import_viem.BaseError {
   }
 }
 class BaseContract extends import_Construct.Construct {
+  /**
+   * Viem contract instance for direct read calls
+   **/
   contract;
+  /**
+   * Contract ABI
+   **/
   abi;
+  /**
+   * Gearbox contract type identifier (e.g. `"CREDIT_MANAGER"`), or empty string if unknown.
+   **/
   contractType;
+  /**
+   * Contract version number.
+   * @default 0
+   **/
   version;
+  /**
+   * On-chain address of the contract.
+   **/
   address;
+  /**
+   * Display name for the contract.
+   **/
   name;
   constructor(options, args) {
     super(options);
@@ -73,6 +92,7 @@ class BaseContract extends import_Construct.Construct {
       register.setAddressLabel(this.address, this.name);
     }
   }
+  /** {@inheritDoc IBaseContract.stateHuman} */
   stateHuman(_ = true) {
     return {
       address: this.labelAddress(this.address),
@@ -81,9 +101,10 @@ class BaseContract extends import_Construct.Construct {
     };
   }
   /**
-   * Updates (or not) contract's internal state from event
-   * @param _log
-   */
+   * Applies an on-chain event to update this contract's local state.
+   *
+   * @param _log - Decoded event log emitted by this contract.
+   **/
   processLog(_log) {
   }
   /**
@@ -158,9 +179,8 @@ class BaseContract extends import_Construct.Construct {
     }
   }
   /**
-   * Same as {@link stingifyFunctionData}, but throws if error occurs
-   * @param calldata
-   * @returns
+   * Same as {@link stringifyFunctionData}, but throws if error occurs.
+   * @param calldata - Raw ABI-encoded calldata.
    */
   mustStringifyFunctionData(calldata) {
     const decoded = (0, import_viem.decodeFunctionData)({

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

@@ -32,8 +32,8 @@ class ChainContractsRegister {
   labels = new import_AddressMap.AddressMap([], "labels");
   client;
   /**
-   * Token metadata such as symbol and decimals
-   */
+   * Shared token metadata (symbol, decimals) for all tokens known on this chain.
+   **/
   tokensMeta;
   logger;
   constructor(client, logger) {
@@ -41,6 +41,9 @@ class ChainContractsRegister {
     this.tokensMeta = new import_TokensMeta.TokensMeta(client);
     this.logger = logger;
   }
+  /**
+   * Clears all registered contracts, address labels, and token metadata.
+   **/
   resetContracts() {
     this.logger?.debug(
       `resetting contacts register with ${this.contracts.size} contracts`
@@ -49,9 +52,19 @@ class ChainContractsRegister {
     this.contracts.clear();
     this.tokensMeta.reset();
   }
+  /**
+   * Looks up a contract by address.
+   * @param address - On-chain address.
+   * @returns The contract wrapper, or `undefined` if not registered.
+   */
   getContract(address) {
     return this.contracts.get(address);
   }
+  /**
+   * Looks up a contract by address, throwing if not found.
+   * @param address - On-chain address.
+   * @throws If no contract is registered at this address.
+   */
   mustGetContract(address) {
     const contract = this.contracts.mustGet(address);
     if (!contract) {
@@ -59,9 +72,21 @@ class ChainContractsRegister {
     }
     return contract;
   }
+  /**
+   * Registers (or replaces) a contract at the given address.
+   * @param address - On-chain address.
+   * @param contract - Contract wrapper instance.
+   */
   setContract(address, contract) {
     this.contracts.upsert(address, contract);
   }
+  /**
+   * Assigns a human-readable label to an address for use in logging and
+   * parsed call output.
+   * @param address - On-chain address.
+   * @param label - Static label string, or a function that receives the
+   *   current label and returns a new one.
+   */
   setAddressLabel(address, label) {
     if (address === import_addresses.NOT_DEPLOYED) {
       return;
@@ -72,13 +97,25 @@ class ChainContractsRegister {
       this.labels.upsert(address, label(this.labels.get(address)));
     }
   }
+  /**
+   * Returns a display string for an address, incorporating its label if one exists.
+   * @param address - On-chain address.
+   * @param omitAddress - When `true`, returns only the label (no address prefix).
+   *   Falls back to the raw address when no label is set.
+   */
   labelAddress(address, omitAddress) {
     const label = this.labels.get(address);
     return label ? omitAddress ? label : `${address} [${label}]` : address;
   }
+  /**
+   * The viem {@link Chain} object for this register's connected client.
+   **/
   get chain() {
     return this.client.chain;
   }
+  /**
+   * Numeric chain ID (e.g. `1` for Ethereum mainnet).
+   **/
   get chainId() {
     return this.client.chain.id;
   }

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

@@ -27,9 +27,6 @@ class Construct {
   logger;
   client;
   #register;
-  /**
-   * Indicates that contract state needs to be updated
-   */
   #dirty = false;
   constructor(options) {
     if (options instanceof import_ChainContractsRegister.ChainContractsRegister) {
@@ -61,12 +58,22 @@ class Construct {
   safeGetRegister() {
     return this.#register;
   }
+  /**
+   * The viem {@link Chain} object associated with the connected client.
+   **/
   get chain() {
     return this.client.chain;
   }
+  /**
+   * Numeric chain ID (e.g. `1` for Ethereum mainnet).
+   **/
   get chainId() {
     return this.client.chain.id;
   }
+  /**
+   * Gearbox network type for this chain (e.g. `"Mainnet"`, `"Arbitrum"`).
+   * @throws If the chain was not created by the Gearbox SDK.
+   */
   get networkType() {
     if ("network" in this.chain) {
       return this.chain.network;
@@ -74,6 +81,7 @@ class Construct {
     throw new Error(`chain ${this.chain.id} is not a Gearbox SDK chain`);
   }
   /**
+   * @internal
    * Indicates that contract state diverged from onchain state and needs to be updated
    */
   get dirty() {
@@ -82,6 +90,9 @@ class Construct {
   set dirty(value) {
     this.#dirty = value;
   }
+  /**
+   * Information about tokens known on this chain
+   */
   get tokensMeta() {
     return this.register.tokensMeta;
   }
@@ -89,6 +100,7 @@ class Construct {
     return this.#register?.labelAddress(address, omitAddress) ?? address;
   }
   /**
+   * @internal
    * Returns list of addresses that should be watched for events to sync state
    */
   get watchAddresses() {

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

@@ -30,13 +30,26 @@ class TokensMeta extends import_utils.AddressMap {
     super(void 0, "tokensMeta");
     this.#client = client;
   }
+  /**
+   * Clears all token metadata
+   **/
   reset() {
     this.clear();
     this.#phantomTokensLoaded = void 0;
   }
+  /**
+   * Returns the symbol string for a token.
+   * @param token - Token address.
+   * @throws If the token is not in the registry.
+   */
   symbol(token) {
     return this.mustGet(token).symbol;
   }
+  /**
+   * Returns the decimal count for a token.
+   * @param token - Token address.
+   * @throws If the token is not in the registry.
+   */
   decimals(token) {
     return this.mustGet(token).decimals;
   }
@@ -71,9 +84,19 @@ class TokensMeta extends import_utils.AddressMap {
     const asStr = (0, import_utils.formatBN)(amount, this.decimals(token), precision);
     return symbol ? `${asStr} ${this.symbol(token)}` : asStr;
   }
+  /**
+   * Finds a token by its symbol (e.g. `"USDC"`).
+   * @param symbol - Case-sensitive ticker symbol.
+   * @returns The matching metadata, or `undefined` if no token has this symbol.
+   */
   findBySymbol(symbol) {
     return this.values().find((v) => v.symbol === symbol);
   }
+  /**
+   * Finds a token by its symbol, throwing if not found.
+   * @param symbol - Case-sensitive ticker symbol.
+   * @throws If no token matches the symbol.
+   */
   mustFindBySymbol(symbol) {
     const meta = this.findBySymbol(symbol);
     if (!meta) {

package/dist/cjs/sdk/constants/address-provider.js

@@ -18,7 +18,6 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var address_provider_exports = {};
 __export(address_provider_exports, {
-  ADDRESS_PROVIDER: () => ADDRESS_PROVIDER,
   ADDRESS_PROVIDER_V310: () => ADDRESS_PROVIDER_V310,
   AP_ACCOUNT_FACTORY: () => AP_ACCOUNT_FACTORY,
   AP_ACL: () => AP_ACL,
@@ -55,7 +54,6 @@ __export(address_provider_exports, {
   NO_VERSION: () => NO_VERSION
 });
 module.exports = __toCommonJS(address_provider_exports);
-var import_addresses = require("./addresses.js");
 const NO_VERSION = 0;
 const AP_ACCOUNT_FACTORY = "ACCOUNT_FACTORY";
 const AP_ACL = "ACL";
@@ -89,29 +87,9 @@ const AP_WETH_GATEWAY = "WETH_GATEWAY";
 const AP_WETH_TOKEN = "WETH_TOKEN";
 const AP_ZAPPER_REGISTER = "ZAPPER_REGISTER";
 const AP_ZERO_PRICE_FEED = "ZERO_PRICE_FEED";
-const ADDRESS_PROVIDER = {
-  Mainnet: "0x9ea7b04Da02a5373317D745c1571c84aaD03321D",
-  Arbitrum: "0x7d04eCdb892Ae074f03B5D0aBA03796F90F3F2af",
-  Optimism: "0x3761ca4BFAcFCFFc1B8034e69F19116dD6756726",
-  Base: import_addresses.NOT_DEPLOYED,
-  Sonic: "0x4b27b296273B72d7c7bfee1ACE93DC081467C41B",
-  // New networks
-  MegaETH: import_addresses.NOT_DEPLOYED,
-  Monad: import_addresses.NOT_DEPLOYED,
-  Berachain: import_addresses.NOT_DEPLOYED,
-  Avalanche: import_addresses.NOT_DEPLOYED,
-  BNB: import_addresses.NOT_DEPLOYED,
-  WorldChain: import_addresses.NOT_DEPLOYED,
-  Etherlink: import_addresses.NOT_DEPLOYED,
-  Hemi: import_addresses.NOT_DEPLOYED,
-  Lisk: import_addresses.NOT_DEPLOYED,
-  Plasma: import_addresses.NOT_DEPLOYED,
-  Somnia: import_addresses.NOT_DEPLOYED
-};
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ADDRESS_PROVIDER,
   ADDRESS_PROVIDER_V310,
   AP_ACCOUNT_FACTORY,
   AP_ACL,

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

@@ -56,6 +56,9 @@ class AbstractAddressProviderContract extends import_base.BaseContract {
       this.#addresses[k][version] = overriden;
     }
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getAddress}
+   **/
   getAddress(contract, version = import_constants.NO_VERSION) {
     if (!this.#addresses[contract]) {
       throw new Error(`Address ${contract}, version: ${version} not found`);
@@ -66,6 +69,9 @@ class AbstractAddressProviderContract extends import_base.BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getLatest}
+   **/
   getLatest(contract, range) {
     const allVersions = this.#addresses[contract];
     if (!allVersions) {
@@ -85,6 +91,9 @@ class AbstractAddressProviderContract extends import_base.BaseContract {
     }
     return [address, version];
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.mustGetLatest}
+   **/
   mustGetLatest(contract, range) {
     const result = this.getLatest(contract, range);
     if (!result) {
@@ -92,6 +101,9 @@ class AbstractAddressProviderContract extends import_base.BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.state}
+   **/
   get state() {
     return {
       baseParams: {
@@ -103,6 +115,9 @@ class AbstractAddressProviderContract extends import_base.BaseContract {
       addresses: this.#addresses
     };
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.stateHuman}
+   **/
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

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

@@ -29,9 +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 {
-  /**
-   * Mapping pool.address -> MarketSuite
-   */
   #markets = new import_utils.AddressMap(void 0, "markets");
   #marketFilter;
   #marketConfigurators = new import_utils.AddressMap(
@@ -39,12 +36,21 @@ class MarketRegister extends import_base.SDKConstruct {
     "marketConfigurators"
   );
   #ignoreMarkets;
+  /**
+   * @param sdk - Top-level SDK instance.
+   * @param ignoreMarkets - Pool addresses of markets to exclude from loading.
+   **/
   constructor(sdk, ignoreMarkets = []) {
     super(sdk);
     this.#ignoreMarkets = new Set(
       ignoreMarkets.map((m) => m.toLowerCase())
     );
   }
+  /**
+   * Restores market state from a previously serialized snapshot,
+   * bypassing on-chain reads.
+   * @param state - Array of market data snapshots.
+   **/
   hydrate(state) {
     this.#markets.clear();
     const configurators = new Set(state.map((m) => m.configurator));
@@ -63,6 +69,13 @@ class MarketRegister extends import_base.SDKConstruct {
       );
     }
   }
+  /**
+   * Fetches all markets from the on-chain for the given market configurators.
+   *
+   * @param marketConfigurators - Addresses of market configurator contracts to query.
+   * @param ignoreUpdateablePrices - When `true`, skips generating off-chain
+   *   price updates before loading
+   **/
   async loadMarkets(marketConfigurators, ignoreUpdateablePrices) {
     if (!marketConfigurators.length) {
       this.logger?.warn(
@@ -85,6 +98,10 @@ class MarketRegister extends import_base.SDKConstruct {
       underlying: import_constants.ADDRESS_0X0
     };
   }
+  /**
+   * The active filter used to scope market compressor queries.
+   * @throws If the register has not been hydrated or attached yet.
+   **/
   get marketFilter() {
     if (!this.#marketFilter) {
       throw new Error(
@@ -93,6 +110,15 @@ class MarketRegister extends import_base.SDKConstruct {
     }
     return this.#marketFilter;
   }
+  /**
+   * Re-synchronizes market state with the chain. If during sdk synchronization
+   * we detected that some markets or market configurators were changed,
+   * we reload everything.
+   *
+   * Otherwise only prices are refreshed.
+   *
+   * @param ignoreUpdateablePrices - When `true`, skips off-chain price updates.
+   **/
   async syncState(ignoreUpdateablePrices) {
     const dirty = this.markets.some((m) => m.dirty) || this.marketConfigurators.some((c) => c.dirty);
     if (dirty) {
@@ -203,26 +229,50 @@ class MarketRegister extends import_base.SDKConstruct {
       ...this.marketFilter.configurators
     ]);
   }
+  /**
+   * Serializable snapshot of all loaded markets, suitable for hydration.
+   **/
   get state() {
     return this.markets.map((market) => market.state);
   }
+  /**
+   * Returns a human-readable snapshot of all markets.
+   * @param raw - When `true`, includes raw/unformatted values.
+   **/
   stateHuman(raw = true) {
     return {
       markets: this.markets.map((market) => market.stateHuman(raw))
     };
   }
+  /**
+   * All pool suites across loaded markets.
+   **/
   get pools() {
     return this.markets.map((market) => market.pool);
   }
+  /**
+   * All price oracles across loaded markets.
+   **/
   get priceOracles() {
     return this.markets.map((market) => market.priceOracle);
   }
+  /**
+   * All credit manager suites across loaded markets.
+   **/
   get creditManagers() {
     return this.markets.flatMap((market) => market.creditManagers);
   }
+  /**
+   * All known market configurator contracts.
+   **/
   get marketConfigurators() {
     return this.#marketConfigurators.values();
   }
+  /**
+   * Finds a credit manager suite by its on-chain address.
+   * @param creditManager - Credit manager contract address.
+   * @throws If no loaded market contains the given credit manager.
+   **/
   findCreditManager(creditManager) {
     const addr = creditManager.toLowerCase();
     for (const market of this.markets) {
@@ -234,6 +284,11 @@ class MarketRegister extends import_base.SDKConstruct {
     }
     throw new Error(`cannot find credit manager ${creditManager}`);
   }
+  /**
+   * Finds the market that contains the given credit manager.
+   * @param creditManager - Credit manager contract address.
+   * @throws If no loaded market contains the given credit manager.
+   **/
   findByCreditManager(creditManager) {
     const addr = creditManager.toLowerCase();
     const market = this.markets.find(
@@ -246,6 +301,11 @@ class MarketRegister extends import_base.SDKConstruct {
     }
     return market;
   }
+  /**
+   * Finds the market that uses the given price oracle.
+   * @param address - Price oracle contract address.
+   * @throws If no loaded market uses the given oracle.
+   **/
   findByPriceOracle(address) {
     const addr = address.toLowerCase();
     for (const market of this.markets) {
@@ -255,6 +315,11 @@ class MarketRegister extends import_base.SDKConstruct {
     }
     throw new Error(`cannot find market for price oracle ${address}`);
   }
+  /**
+   * Finds the market associated with the given pool.
+   * @param address - Pool contract address.
+   * @throws If no loaded market uses the given pool.
+   **/
   findByPool(address) {
     const addr = address.toLowerCase();
     for (const market of this.markets) {
@@ -264,9 +329,15 @@ class MarketRegister extends import_base.SDKConstruct {
     }
     throw new Error(`cannot find market for pool ${address}`);
   }
+  /**
+   * Underlying address map of pool address to market suite
+   **/
   get marketsMap() {
     return this.#markets;
   }
+  /**
+   * All loaded market suites.
+   **/
   get markets() {
     return this.#markets.values();
   }