@gearbox-protocol/sdk 13.3.3 → 13.3.4

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

@@ -9,8 +9,8 @@ class ChainContractsRegister {
   labels = new 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) {
@@ -18,6 +18,9 @@ class ChainContractsRegister {
     this.tokensMeta = new 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`
@@ -26,9 +29,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) {
@@ -36,9 +49,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 === NOT_DEPLOYED) {
       return;
@@ -49,13 +74,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/esm/sdk/base/Construct.js

@@ -4,9 +4,6 @@ class Construct {
   logger;
   client;
   #register;
-  /**
-   * Indicates that contract state needs to be updated
-   */
   #dirty = false;
   constructor(options) {
     if (options instanceof ChainContractsRegister) {
@@ -38,12 +35,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;
@@ -51,6 +58,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() {
@@ -59,6 +67,9 @@ class Construct {
   set dirty(value) {
     this.#dirty = value;
   }
+  /**
+   * Information about tokens known on this chain
+   */
   get tokensMeta() {
     return this.register.tokensMeta;
   }
@@ -66,6 +77,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/esm/sdk/base/TokensMeta.js

@@ -12,13 +12,26 @@ class TokensMeta extends 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;
   }
@@ -53,9 +66,19 @@ class TokensMeta extends AddressMap {
     const asStr = 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/esm/sdk/constants/address-provider.js

@@ -1,4 +1,3 @@
-import { NOT_DEPLOYED } from "./addresses.js";
 const NO_VERSION = 0;
 const AP_ACCOUNT_FACTORY = "ACCOUNT_FACTORY";
 const AP_ACL = "ACL";
@@ -32,28 +31,8 @@ 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: NOT_DEPLOYED,
-  Sonic: "0x4b27b296273B72d7c7bfee1ACE93DC081467C41B",
-  // New networks
-  MegaETH: NOT_DEPLOYED,
-  Monad: NOT_DEPLOYED,
-  Berachain: NOT_DEPLOYED,
-  Avalanche: NOT_DEPLOYED,
-  BNB: NOT_DEPLOYED,
-  WorldChain: NOT_DEPLOYED,
-  Etherlink: NOT_DEPLOYED,
-  Hemi: NOT_DEPLOYED,
-  Lisk: NOT_DEPLOYED,
-  Plasma: NOT_DEPLOYED,
-  Somnia: NOT_DEPLOYED
-};
 const ADDRESS_PROVIDER_V310 = "0xF7f0a609BfAb9a0A98786951ef10e5FE26cC1E38";
 export {
-  ADDRESS_PROVIDER,
   ADDRESS_PROVIDER_V310,
   AP_ACCOUNT_FACTORY,
   AP_ACL,

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

@@ -33,6 +33,9 @@ class AbstractAddressProviderContract extends BaseContract {
       this.#addresses[k][version] = overriden;
     }
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getAddress}
+   **/
   getAddress(contract, version = NO_VERSION) {
     if (!this.#addresses[contract]) {
       throw new Error(`Address ${contract}, version: ${version} not found`);
@@ -43,6 +46,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.getLatest}
+   **/
   getLatest(contract, range) {
     const allVersions = this.#addresses[contract];
     if (!allVersions) {
@@ -62,6 +68,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return [address, version];
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.mustGetLatest}
+   **/
   mustGetLatest(contract, range) {
     const result = this.getLatest(contract, range);
     if (!result) {
@@ -69,6 +78,9 @@ class AbstractAddressProviderContract extends BaseContract {
     }
     return result;
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.state}
+   **/
   get state() {
     return {
       baseParams: {
@@ -80,6 +92,9 @@ class AbstractAddressProviderContract extends BaseContract {
       addresses: this.#addresses
     };
   }
+  /**
+   * {@inheritDoc IAddressProviderContract.stateHuman}
+   **/
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

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

@@ -10,9 +10,6 @@ import { simulateWithPriceUpdates } from "../utils/viem/index.js";
 import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 class MarketRegister extends SDKConstruct {
-  /**
-   * Mapping pool.address -> MarketSuite
-   */
   #markets = new AddressMap(void 0, "markets");
   #marketFilter;
   #marketConfigurators = new AddressMap(
@@ -20,12 +17,21 @@ class MarketRegister extends 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));
@@ -44,6 +50,13 @@ class MarketRegister extends 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(
@@ -66,6 +79,10 @@ class MarketRegister extends SDKConstruct {
       underlying: 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(
@@ -74,6 +91,15 @@ class MarketRegister extends 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) {
@@ -184,26 +210,50 @@ class MarketRegister extends 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) {
@@ -215,6 +265,11 @@ class MarketRegister extends 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(
@@ -227,6 +282,11 @@ class MarketRegister extends 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) {
@@ -236,6 +296,11 @@ class MarketRegister extends 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) {
@@ -245,9 +310,15 @@ class MarketRegister extends 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();
   }

package/dist/esm/sdk/market/oracle/PriceOracleBaseContract.js

@@ -13,26 +13,26 @@ const ZERO_PRICE_FEED = stringToHex("PRICE_FEED::ZERO", { size: 32 });
 class PriceOracleBaseContract extends BaseContract {
   sdk;
   /**
-   * Mapping Token => [PriceFeed Address, stalenessPeriod]
-   */
+   * {@inheritDoc IPriceOracleContract.mainPriceFeeds}
+   **/
   mainPriceFeeds = new AddressMap(
     void 0,
     "mainPriceFeeds"
   );
   /**
-   * Mapping Token => [PriceFeed Address, stalenessPeriod]
-   */
+   * {@inheritDoc IPriceOracleContract.reservePriceFeeds}
+   **/
   reservePriceFeeds = new AddressMap(
     void 0,
     "reservePriceFeeds"
   );
   /**
-   * Mapping Token => Price in USD
-   */
+   * {@inheritDoc IPriceOracleContract.mainPrices}
+   **/
   mainPrices = new PriceFeedAnswerMap(void 0, "mainPrices");
   /**
-   * Mapping Token => Price in USD
-   */
+   * {@inheritDoc IPriceOracleContract.reservePrices}
+   **/
   reservePrices = new PriceFeedAnswerMap(
     void 0,
     "reservePrices"
@@ -48,11 +48,8 @@ class PriceOracleBaseContract extends BaseContract {
     this.#loadState(priceFeedMap, priceFeedTree);
   }
   /**
-   * Returns main and reserve price feeds for given tokens
-   * @param tokens
-   * @param opts Option to include main/reserve feeds only, defaults to both
-   * @returns
-   */
+   * {@inheritDoc IPriceOracleContract.priceFeedsForTokens}
+   **/
   priceFeedsForTokens(tokens, opts) {
     const main = opts?.main ?? true;
     const reserve = opts?.reserve ?? true;
@@ -62,39 +59,26 @@ class PriceOracleBaseContract extends BaseContract {
     ]).filter((f) => !!f);
   }
   /**
-   * Gets main price for given token
-   * Throws if token price feed is not found or answer is not successful
-   * @param token
-   * @returns
-   */
+   * {@inheritDoc IPriceOracleContract.mainPrice}
+   **/
   mainPrice(token) {
     return this.mainPrices.price(token);
   }
   /**
-   * Gets reserve price for given token
-   * Throws if token price feed is not found or answer is not successful
-   * @param token
-   * @returns
-   */
+   * {@inheritDoc IPriceOracleContract.reservePrice}
+   **/
   reservePrice(token) {
     return this.reservePrices.price(token);
   }
   /**
-   * Returns true if oracle's price feed tree contains given price feed
-   * This feed is not necessary connected to token, but can be a component of composite feed for some token
-   * @param priceFeed
-   * @returns
-   */
+   * {@inheritDoc IPriceOracleContract.usesPriceFeed}
+   **/
   usesPriceFeed(priceFeed) {
     return this.#priceFeedTree.has(priceFeed);
   }
   /**
-   * Tries to convert amount of from one token to another, using latest known prices
-   * @param from
-   * @param to
-   * @param amount
-   * @param reserve use reserve price feed instead of main
-   */
+   * {@inheritDoc IPriceOracleContract.convert}
+   **/
   convert(from, to, amount, reserve = false) {
     if (from === to) {
       return amount;
@@ -106,11 +90,8 @@ class PriceOracleBaseContract extends BaseContract {
     return amount * fromPrice * toScale / (toPrice * fromScale);
   }
   /**
-   * Tries to convert amount of token to USD, using latest known prices
-   * @param from
-   * @param amount
-   * @param reserve use reserve price feed instead of main
-   */
+   * {@inheritDoc IPriceOracleContract.convertToUSD}
+   **/
   convertToUSD(from, amount, reserve = false) {
     if (amount === 0n) {
       return 0n;
@@ -120,11 +101,8 @@ class PriceOracleBaseContract extends BaseContract {
     return amount * price / scale;
   }
   /**
-   * Tries to convert amount of USD to token, using latest known prices
-   * @param to
-   * @param amount
-   * @param reserve use reserve price feed instead of main
-   */
+   * {@inheritDoc IPriceOracleContract.convertFromUSD}
+   **/
   convertFromUSD(to, amount, reserve = false) {
     if (amount === 0n) {
       return 0n;
@@ -134,14 +112,14 @@ class PriceOracleBaseContract extends BaseContract {
     return amount * scale / price;
   }
   /**
-   * All price feed tree nodes known to this oracle
-   */
+   * {@inheritDoc IPriceOracleContract.priceFeeds}
+   **/
   get priceFeeds() {
     return this.#priceFeedTree.values().map((node) => this.sdk.priceFeeds.mustGet(node.baseParams.addr));
   }
   /**
-   * Paired method to updatePrices, helps to update prices on all oracles in one multicall
-   */
+   * {@inheritDoc IPriceOracleContract.syncStateMulticall}
+   **/
   syncStateMulticall() {
     const args = [this.address];
     const [address] = this.sdk.addressProvider.mustGetLatest(
@@ -207,11 +185,14 @@ class PriceOracleBaseContract extends BaseContract {
     });
   }
   /**
-   * Returns list of addresses that should be watched for events to sync state
-   */
+   * {@inheritDoc IPriceOracleContract.watchAddresses}
+   **/
   get watchAddresses() {
     return /* @__PURE__ */ new Set([this.address]);
   }
+  /**
+   * {@inheritDoc IPriceOracleContract.stateHuman}
+   **/
   stateHuman(raw = true) {
     return {
       ...super.stateHuman(raw),

package/dist/esm/sdk/market/pricefeeds/PriceFeedRef.js

@@ -1,7 +1,14 @@
 import { Construct } from "../../base/index.js";
 import { formatDuration } from "../../utils/index.js";
 class PriceFeedRef extends Construct {
+  /**
+   * On-chain address of the referenced price feed contract.
+   **/
   address;
+  /**
+   * Maximum allowed age (in seconds) of the feed's answer before the
+   * oracle considers it stale.
+   **/
   stalenessPeriod;
   #priceFeed;
   constructor(options, address, stalenessPeriod) {
@@ -9,6 +16,10 @@ class PriceFeedRef extends Construct {
     this.address = address;
     this.stalenessPeriod = stalenessPeriod;
   }
+  /**
+   * Lazily resolved price feed contract instance.
+   * @throws If the feed is not registered in the contracts register.
+   **/
   get priceFeed() {
     if (!this.#priceFeed) {
       this.#priceFeed = this.register.mustGetContract(
@@ -17,6 +28,11 @@ class PriceFeedRef extends Construct {
     }
     return this.#priceFeed;
   }
+  /**
+   * Returns a human-readable snapshot of the feed state, including the
+   * staleness period formatted as a duration string.
+   * @param raw - When `true`, includes raw/unformatted values.
+   **/
   stateHuman(raw = true) {
     return {
       ...this.priceFeed.stateHuman(raw),