@gearbox-protocol/sdk 13.4.0-beta.1 → 13.4.0-beta.2

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

@@ -32,6 +32,7 @@ var import_iBaseRewardPool = require("../../abi/iBaseRewardPool.js");
 var import_base = require("../base/index.js");
 var import_chains = require("../chain/chains.js");
 var import_constants = require("../constants/index.js");
+var import_market = require("../market/index.js");
 var import_router = require("../router/index.js");
 var import_utils = require("../utils/index.js");
 var import_viem2 = require("../utils/viem/index.js");
@@ -58,12 +59,8 @@ class AbstractCreditAccountService extends import_base.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 {
@@ -82,10 +79,7 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     if (raw.success) {
       return raw;
     }
-    const { txs: priceUpdateTxs } = await this.getUpdateForAccount({
-      creditManager: raw.creditManager,
-      creditAccount: raw
-    });
+    const { txs: priceUpdateTxs } = await this.getUpdateForAccount(raw);
     const [cad] = await (0, import_viem2.simulateWithPriceUpdates)(this.client, {
       priceUpdates: priceUpdateTxs,
       contracts: [
@@ -102,13 +96,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -161,11 +150,8 @@ class AbstractCreditAccountService extends import_base.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: import_rewardsCompressor.rewardsCompressorAbi,
@@ -205,11 +191,8 @@ class AbstractCreditAccountService extends import_base.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: [
@@ -313,10 +296,8 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     return void 0;
   }
   /**
-   * Generates transaction to liquidate credit account
-   * @param props - {@link FullyLiquidateProps}
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.fullyLiquidate}
+   **/
   async fullyLiquidate(props) {
     const {
       account,
@@ -366,21 +347,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -408,13 +376,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -436,16 +399,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -478,15 +433,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -523,14 +471,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -557,10 +499,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -584,10 +524,8 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     return resp;
   }
   /**
-   * Get claimable and pending withdrawals of an account
-   * @param props - {@link GetPendingWithdrawalsProps}
-   * @returns
-   */
+   * {@inheritDoc ICreditAccountsService.getPendingWithdrawals}
+   **/
   async getPendingWithdrawals({
     creditAccount
   }) {
@@ -613,11 +551,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -672,11 +607,8 @@ class AbstractCreditAccountService extends import_base.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,
@@ -736,29 +668,8 @@ class AbstractCreditAccountService extends import_base.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)
-   */
+   * {@inheritDoc ICreditAccountsService.openCA}
+   **/
   async openCA({
     ethAmount,
     creditManager,
@@ -790,10 +701,8 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     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
@@ -819,9 +728,8 @@ class AbstractCreditAccountService extends import_base.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 import_constants.PERCENTAGE_FACTOR + (borrowRate < 100n ? borrowRate : 100n);
@@ -869,70 +777,18 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
     );
     return resp;
   }
-  async getUpdateForAccount(options) {
-    const { creditManager, creditAccount, desiredQuotas, ignoreReservePrices } = options;
-    const quotaRecord = desiredQuotas ? (0, import_router.assetsMap)(desiredQuotas) : desiredQuotas;
-    const caBalancesRecord = creditAccount ? (0, import_router.assetsMap)(creditAccount.tokens) : creditAccount;
-    const market = this.sdk.marketRegister.findByCreditManager(creditManager);
-    const cm = this.sdk.marketRegister.findCreditManager(creditManager).creditManager;
-    const tokens = /* @__PURE__ */ new Set([(0, import_viem.getAddress)(cm.underlying)]);
-    for (const t of cm.collateralTokens) {
-      if (creditAccount && caBalancesRecord && quotaRecord) {
-        const balanceAsset = caBalancesRecord.get(t);
-        const balance = balanceAsset?.balance || 0n;
-        const mask = balanceAsset?.mask || 0n;
-        const isEnabled = (mask & creditAccount.enabledTokensMask) !== 0n;
-        const quotaAsset = quotaRecord.get(t);
-        const quotaBalance = quotaAsset?.balance || 0n;
-        if (balance > 10n && isEnabled || quotaBalance > 0) {
-          tokens.add((0, import_viem.getAddress)(t));
-        }
-      } else if (creditAccount && caBalancesRecord) {
-        const balanceAsset = caBalancesRecord.get(t);
-        const balance = balanceAsset?.balance || 0n;
-        const mask = balanceAsset?.mask || 0n;
-        const isEnabled = (mask & creditAccount.enabledTokensMask) !== 0n;
-        if (balance > 10n && isEnabled) {
-          tokens.add((0, import_viem.getAddress)(t));
-        }
-      } else if (quotaRecord) {
-        const quotaAsset = quotaRecord.get(t);
-        const quotaBalance = quotaAsset?.balance || 0n;
-        if (quotaBalance > 0) {
-          tokens.add((0, import_viem.getAddress)(t));
-        }
-      }
-    }
-    const priceFeeds = market.priceOracle.priceFeedsForTokens(Array.from(tokens), {
-      main: true,
-      reserve: !ignoreReservePrices
-    });
-    const tStr = Array.from(tokens).map((t) => this.labelAddress(t)).join(", ");
-    const remark = ignoreReservePrices ? " main" : "";
-    this.logger?.debug(
-      { account: creditAccount?.creditAccount, manager: cm.name },
-      `generating price feed updates for ${tStr} from ${priceFeeds.length}${remark} price feeds`
-    );
-    return this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(priceFeeds);
-  }
   /**
-   * Returns account price updates that can be used in credit facade multicall or liquidator calls
-   * @param options
-   * @returns
-   */
-  async getOnDemandPriceUpdates(options) {
-    const { creditManager, creditAccount } = options;
-    const market = this.sdk.marketRegister.findByCreditManager(creditManager);
+   * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
+   **/
+  async getOnDemandPriceUpdates(account, ignoreReservePrices) {
+    const { creditManager, creditAccount } = account;
     const cm = this.sdk.marketRegister.findCreditManager(creditManager);
-    const update = await this.getUpdateForAccount(options);
+    const update = await this.getUpdateForAccount(account, ignoreReservePrices);
     this.logger?.debug(
-      { account: creditAccount?.creditAccount, manager: cm.name },
+      { account: creditAccount, manager: cm.name },
       `getting on demand price updates from ${update.txs.length} txs`
     );
-    return market.priceOracle.onDemandPriceUpdates(
-      cm.creditFacade.address,
-      update
-    ).raw;
+    return (0, import_market.getRawPriceUpdates)(update);
   }
   /**
    * Analyzes a multicall array and prepends necessary on-demand price feed updates.
@@ -992,6 +848,29 @@ class AbstractCreditAccountService extends import_base.SDKConstruct {
       ...remainingCalls
     ];
   }
+  async getUpdateForAccount(account, ignoreReservePrices) {
+    const { creditManager, creditAccount, enabledTokensMask } = account;
+    const market = this.sdk.marketRegister.findByCreditManager(creditManager);
+    const cm = this.sdk.marketRegister.findCreditManager(creditManager).creditManager;
+    const tokens = new import_utils.AddressSet([cm.underlying]);
+    for (const t of account.tokens) {
+      const isEnabled = (t.mask & enabledTokensMask) !== 0n;
+      if (t.balance > 10n && isEnabled) {
+        tokens.add(t.token);
+      }
+    }
+    const priceFeeds = market.priceOracle.priceFeedsForTokens(Array.from(tokens), {
+      main: true,
+      reserve: !ignoreReservePrices
+    });
+    const tStr = tokens.map((t) => this.labelAddress(t)).join(", ");
+    const remark = ignoreReservePrices ? " main" : "";
+    this.logger?.debug(
+      { account: creditAccount, manager: cm.name },
+      `generating price feed updates for ${tStr} from ${priceFeeds.length}${remark} price feeds`
+    );
+    return this.sdk.priceFeeds.generatePriceFeedsUpdateTxs(priceFeeds);
+  }
   /**
    * Executes a multicall on a credit account, automatically prepending
    * necessary on-demand price feed updates.

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,
@@ -136,7 +136,7 @@ class CreditAccountServiceV310 extends import_AbstractCreditAccountsService.Abst
     return { tx, calls, creditFacade: cm.creditFacade };
   }
   /**
-   * Implements {@link ICreditAccountsService.repayAndLiquidateCreditAccount}
+   * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
    */
   async repayAndLiquidateCreditAccount({
     collateralAssets,
@@ -173,7 +173,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() {