@gearbox-protocol/sdk 13.3.3 → 13.3.5

package/dist/esm/sdk/accounts/AbstractCreditAccountsService.js

@@ -46,12 +46,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     );
   }
   /**
-   * Returns single credit account data, or undefined if it's not found
-   * Performs all necessary price feed updates under the hood
-   * @param account
-   * @param blockNumber
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getCreditAccountData}
+   **/
   async getCreditAccountData(account, blockNumber) {
     let raw;
     try {
@@ -90,13 +86,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return cad;
   }
   /**
-   * Methods to get all credit accounts with some optional filtering
-   * Performs all necessary price feed updates under the hood
-   *
-   * @param options
-   * @param blockNumber
-   * @returns returned credit accounts are sorted by health factor in ascending order
-   */
+   * {@inheritDoc ICreditAccountsService.getCreditAccounts}
+   **/
   async getCreditAccounts(options, blockNumber) {
     const {
       creditManager,
@@ -149,11 +140,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return allCAs.sort((a, b) => Number(a.healthFactor - b.healthFactor));
   }
   /**
-   * Method to get all claimable rewards for credit account (ex. stkUSDS SKY rewards)
-     Assosiates rewards by adapter + stakedPhantomToken
-   * @param {Address} creditAccount - address of credit account to get rewards for
-   * @returns {Array<Rewards>} list of {@link Rewards} that can be claimed
-   */
+   * {@inheritDoc ICreditAccountsService.getRewards}
+   **/
   async getRewards(creditAccount) {
     const rewards = await this.client.readContract({
       abi: rewardsCompressorAbi,
@@ -193,11 +181,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return Object.values(r);
   }
   /**
-   * Method to get all connected bots for credit account
-   * @param {Array<AccountToCheck>} accountsToCheck - list of credit accounts 
-      and their credit managers to check connected bots on
-   * @returns call result of getConnectedBots for each credit account
-   */
+   * {@inheritDoc ICreditAccountsService.getConnectedBots}
+   **/
   async getConnectedBots(accountsToCheck, legacyMigrationBot, additionalBots) {
     const allResp = await this.client.multicall({
       contracts: [
@@ -301,10 +286,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return void 0;
   }
   /**
-   * Generates transaction to liquidate credit account
-   * @param props - {@link FullyLiquidateProps}
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.fullyLiquidate}
+   **/
   async fullyLiquidate(props) {
     const {
       account,
@@ -354,21 +337,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     };
   }
   /**
-   * Closes credit account or closes credit account and keeps it open with zero debt.
-     - Ca is closed in the following order: price update -> close path to swap all tokens into underlying -> 
-       -> disable quotas of exiting tokens -> decrease debt -> disable exiting tokens tokens -> withdraw underlying tokenz
-   * @param {CloseOptions} operation - {@link CloseOptions}: close or zeroDebt
-   * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-   * @param {Array<Address>} assetsToWithdraw - tokens to withdraw from credit account. 
-      For credit account closing this is the underlying token, because during the closure, 
-      all tokens on account are swapped into the underlying, 
-      and only the underlying token will remain on the credit account
-   * @param {Address} to - Wallet address to withdraw underlying to
-   * @param {number} slippage  - Slippage in PERCENTAGE_FORMAT (100% = 10_000) per operation
-   * @default 50n
-   * @param {RouterCloseResult | undefined} closePath - result of findBestClosePath method from router; if omited, calls marketRegister.findCreditManager {@link RouterCloseResult}
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
+   * {@inheritDoc ICreditAccountsService.closeCreditAccount}
+   **/
   async closeCreditAccount({
     operation,
     assetsToWithdraw,
@@ -400,13 +370,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, routerCloseResult, creditFacade: cm.creditFacade };
   }
   /**
-   * Updates quota of credit account.
-     - CA quota updated in the following order: price update -> update quotas
-   * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-   * @param {Array<Asset>} averageQuota - average quota for desired tokens {@link Asset}
-   * @param {Array<Asset>} minQuota - minimum quota for desired tokens {@link Asset}
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
+   * {@inheritDoc ICreditAccountsService.updateQuotas}
+   **/
   async updateQuotas({
     minQuota,
     averageQuota,
@@ -430,16 +395,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Adds a single collateral to credit account and updates quotas
-     - Collateral is added in the following order: price update -> add collateral (with permit) -> update quotas
-   * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-   * @param {Array<Asset>} averageQuota - average quota for desired token {@link Asset}
-   * @param {Array<Asset>} minQuota - minimum quota for desired token {@link Asset}
-   * @param {Asset} asset - asset to add as collateral {@link Asset}
-   * @param {PermitResult | undefined} permits - permits of collateral asset if it is permittable {@link PermitResult}
-   * @param {bigint} ethAmount - native token amount to attach to tx
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
+   * {@inheritDoc ICreditAccountsService.addCollateral}
+   **/
   async addCollateral({
     creditAccount,
     asset,
@@ -473,15 +430,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Increases or decreases debt of credit account; debt decrease uses token ON CREDIT ACCOUNT
-     - Debt is changed in the following order: price update -> (enables underlying if it was disabled) -> change debt
-   * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-   * @param {bigint} amount - amount to change debt by; 
-      0 - prohibited value; 
-      negative value for debt decrease; 
-      positive value for debt increase.
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
+   * {@inheritDoc ICreditAccountsService.changeDebt}
+   **/
   async changeDebt({
     creditAccount,
     amount,
@@ -518,14 +468,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Executes swap specified by given calls, update quotas of affected tokens
-     - Swap is executed in the following order: price update -> execute swap path -> update quotas
-   * @param {RouterCASlice} creditAccount - minimal credit account data {@link RouterCASlice} on which operation is performed
-   * @param {Array<Asset>} averageQuota - average quota for desired token {@link Asset}
-   * @param {Array<Asset>} minQuota - minimum quota for desired token {@link Asset}
-   * @param {Array<MultiCall>} calls - array of MultiCall from router methods getSingleSwap or getAllSwaps {@link MultiCall}
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
+   * {@inheritDoc ICreditAccountsService.executeSwap}
+   **/
   async executeSwap({
     creditAccount,
     calls: swapCalls,
@@ -553,10 +497,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Preview delayed withdrawal for given token
-   * @param props - {@link PreviewDelayedWithdrawalProps}
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.previewDelayedWithdrawal}
+   **/
   async previewDelayedWithdrawal({
     creditAccount,
     amount,
@@ -580,10 +522,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return resp;
   }
   /**
-   * Get claimable and pending withdrawals of an account
-   * @param props - {@link GetPendingWithdrawalsProps}
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
+   **/
   async getPendingWithdrawals({
     creditAccount
   }) {
@@ -609,11 +549,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return respResult;
   }
   /**
-   * Start delayed withdrawal for given token
-     - Withdrawal is executed in the following order: price update -> execute withdraw calls -> update quotas
-   * @param props - {@link StartDelayedWithdrawalProps}
-   * @returns
-  */
+   * {@inheritDoc ICreditAccountsService.startDelayedWithdrawal}
+   **/
   async startDelayedWithdrawal({
     creditAccount,
     minQuota,
@@ -669,11 +606,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Claim tokens with delayed withdrawal
-     - Claim is executed in the following order: price update -> execute claim calls -> update quotas
-   * @param props - {@link ClaimDelayedProps}
-   * @returns
-  */
+   * {@inheritDoc ICreditAccountsService.claimDelayed}
+   **/
   async claimDelayed({
     creditAccount,
     minQuota,
@@ -734,44 +668,32 @@ class AbstractCreditAccountService extends SDKConstruct {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Executes swap specified by given calls, update quotas of affected tokens
-     - Open credit account is executed in the following order: price update -> increase debt -> add collateral ->
-      -> update quotas -> (optionally: execute swap path for trading/strategy) -> 
-      -> (optionally: withdraw debt for lending)
-    - Basic open credit account: price update -> increase debt -> add collateral -> update quotas
-    - Lending: price update -> increase debt -> add collateral -> update quotas -> withdraw debt
-    - Strategy/trading: price update -> increase debt -> add collateral -> update quotas -> execute swap path
-    - In strategy is possible situation when collateral is added, but not swapped; the only swapped value in this case will be debt
-   * @param {bigint} ethAmount - native token amount to attach to tx
-   * @param {Address} creditManager - address of credit manager to open credit account on
-   * @param {Array<Asset>} collateral - array of collateral which can be just directly added or swapped using the path {@link Asset}
-   * @param {Record<Address, PermitResult>} permits - permits of collateral tokens (in any permittable token is present) {@link PermitResult}
-   * @param {bigint} debt - debt to open credit account with
-   * @param {boolean} withdrawDebt - flag to withdraw debt to wallet after opening credit account; 
-      used for borrowing functionality
-   * @param {bigint} referralCode - referral code to open credit account with
-   * @param {Address} to - wallet address to transfer credit account to\
-   * @param {Array<MultiCall>} calls - array of MultiCall from router methods findOpenStrategyPath {@link MultiCall}.
-      Used for trading and strategy functionality
-   * @param {Array<Asset>} averageQuota - average quota for tokens after open {@link Asset}
-   * @param {Array<Asset>} minQuota - minimum quota for tokens after open  {@link Asset}
-   * @returns All necessary data to execute the transaction (call, credit facade)
-   */
-  async openCA({
-    ethAmount,
-    creditManager,
-    collateral,
-    permits,
-    debt,
-    withdrawDebt,
-    referralCode,
-    to,
-    calls: openPathCalls,
-    minQuota,
-    averageQuota
-  }) {
+   * {@inheritDoc ICreditAccountsService.openCA}
+   **/
+  async openCA(props) {
+    const {
+      ethAmount,
+      creditManager,
+      reopenCreditAccount,
+      collateral,
+      permits,
+      debt,
+      withdrawToken,
+      referralCode,
+      to,
+      calls: openPathCalls,
+      callsAfter,
+      minQuota,
+      averageQuota
+    } = props;
     const cmSuite = this.sdk.marketRegister.findCreditManager(creditManager);
     const cm = cmSuite.creditManager;
+    let tokenToWithdraw;
+    if (withdrawToken === true) {
+      tokenToWithdraw = cm.underlying;
+    } else if (typeof withdrawToken === "string") {
+      tokenToWithdraw = withdrawToken;
+    }
     const priceUpdatesCalls = await this.getPriceUpdatesForFacade({
       creditManager: cm.address,
       desiredQuotas: averageQuota
@@ -781,21 +703,32 @@ class AbstractCreditAccountService extends SDKConstruct {
       this.#prepareIncreaseDebt(cm.creditFacade, debt),
       ...this.prepareAddCollateral(cm.creditFacade, collateral, permits),
       ...openPathCalls,
-      ...withdrawDebt ? [this.prepareWithdrawToken(cm.creditFacade, cm.underlying, debt, to)] : [],
+      ...tokenToWithdraw ? [
+        this.prepareWithdrawToken(
+          cm.creditFacade,
+          tokenToWithdraw,
+          MAX_UINT256,
+          to
+        )
+      ] : [],
       ...this.prepareUpdateQuotas(cm.creditFacade, {
         minQuota,
         averageQuota
-      })
+      }),
+      ...callsAfter ?? []
     ];
-    const tx = cmSuite.creditFacade.openCreditAccount(to, calls, referralCode);
+    let tx;
+    if (reopenCreditAccount) {
+      tx = await cmSuite.creditFacade.multicall(reopenCreditAccount, calls);
+    } else {
+      tx = cmSuite.creditFacade.openCreditAccount(to, calls, referralCode);
+    }
     tx.value = ethAmount.toString(10);
     return { calls, tx, creditFacade: cmSuite.creditFacade };
   }
   /**
-   * Returns borrow rate with 4 digits precision (10000 = 100%)
-   * @param ca
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getBorrowRate}
+   **/
   getBorrowRate(ca) {
     const { creditManager } = this.sdk.marketRegister.findCreditManager(
       ca.creditManager
@@ -821,9 +754,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return r + qr;
   }
   /**
-   * Returns optimal HF for partial liquidation with 4 digits precision (10000 = 100%)
-   * @param ca
-   */
+   * {@inheritDoc ICreditAccountsService.getOptimalHFForPartialLiquidation}
+   **/
   getOptimalHFForPartialLiquidation(ca) {
     const borrowRate = this.getBorrowRate(ca);
     return PERCENTAGE_FACTOR + (borrowRate < 100n ? borrowRate : 100n);
@@ -872,12 +804,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return resp;
   }
   /**
-   * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
-   *
-   * This can be used by batch liquidator
-   * @param accounts
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getUpdateForAccounts}
+   **/
   async getUpdateForAccounts(accounts) {
     const tokensByPool = /* @__PURE__ */ new Map();
     const oracleByPool = /* @__PURE__ */ new Map();
@@ -949,10 +877,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     return this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(priceFeeds);
   }
   /**
-   * Returns account price updates that can be used in credit facade multicall or liquidator calls
-   * @param options
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
+   **/
   async getOnDemandPriceUpdates(options) {
     const { creditManager, creditAccount } = options;
     const market = this.sdk.marketRegister.findByCreditManager(creditManager);
@@ -968,13 +894,8 @@ class AbstractCreditAccountService extends SDKConstruct {
     );
   }
   /**
-   * Returns price updates in format that is accepted by various credit facade methods (multicall, close/liquidate, etc...).
-   * - If there are desiredQuotas and creditAccount update quotaBalance > 0 || (balance > 10n && isEnabled). Is used when account has both: balances and quota buys.
-   * - If there is creditAccount update balance > 10n && isEnabled. Is used in credit account actions when quota is not being bought.
-   * - If there is desiredQuotas update quotaBalance > 0. Is used on credit account opening, when quota is bought for the first time.
-   * @param acc
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getPriceUpdatesForFacade}
+   **/
   async getPriceUpdatesForFacade(options) {
     const updates = await this.getOnDemandPriceUpdates(options);
     return updates.multicall;

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

@@ -4,7 +4,7 @@ import { MAX_UINT256 } from "../constants/math.js";
 import { AbstractCreditAccountService } from "./AbstractCreditAccountsService.js";
 class CreditAccountServiceV310 extends AbstractCreditAccountService {
   /**
-   * Implements {@link ICreditAccountsService.setBot}
+   * {@inheritDoc ICreditAccountsService.setBot}
    */
   async setBot({
     botAddress,
@@ -46,7 +46,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.withdrawCollateral}
+   * {@inheritDoc ICreditAccountsService.withdrawCollateral}
    */
   async withdrawCollateral({
     creditAccount,
@@ -81,7 +81,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayCreditAccount}
    */
   async repayCreditAccount({
     operation,
@@ -117,7 +117,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayAndLiquidateCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
    */
   async repayAndLiquidateCreditAccount({
     collateralAssets,
@@ -154,7 +154,7 @@ class CreditAccountServiceV310 extends AbstractCreditAccountService {
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.claimFarmRewards}
+   * {@inheritDoc ICreditAccountsService.claimFarmRewards}
    */
   async claimFarmRewards({
     calls: externalCalls,

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

@@ -35,11 +35,30 @@ class ContractParseError extends BaseError {
   }
 }
 class BaseContract extends 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);
@@ -63,6 +82,7 @@ class BaseContract extends Construct {
       register.setAddressLabel(this.address, this.name);
     }
   }
+  /** {@inheritDoc IBaseContract.stateHuman} */
   stateHuman(_ = true) {
     return {
       address: this.labelAddress(this.address),
@@ -71,9 +91,10 @@ class BaseContract extends 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) {
   }
   /**
@@ -148,9 +169,8 @@ class BaseContract extends 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 = decodeFunctionData({

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