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

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

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

@@ -33,17 +33,29 @@ import { YearnPriceFeedContract } from "./YearnPriceFeed.js";
 import { ZeroPriceFeedContract } from "./ZeroPriceFeed.js";
 class PriceFeedRegister extends SDKConstruct {
   #hooks = new Hooks();
+  #updaters;
   #feeds = new AddressMap(void 0, "priceFeeds");
   #latestUpdate;
-  updaters;
   constructor(sdk, opts = {}) {
     super(sdk);
-    this.updaters = [
+    this.#updaters = [
       new PythUpdater(sdk, opts?.pyth),
       new RedstoneUpdater(sdk, opts?.redstone)
     ];
   }
+  /**
+   * @internal
+   * Registers a callback for price-feed register lifecycle events.
+   * @param event - Event name.
+   * @param handler - Callback to invoke.
+   **/
   addHook = this.#hooks.addHook.bind(this.#hooks);
+  /**
+   * @internal
+   * Removes a previously registered hook.
+   * @param event - Event name.
+   * @param handler - Callback to remove.
+   **/
   removeHook = this.#hooks.removeHook.bind(this.#hooks);
   /**
    * Returns all price feeds known to sdk
@@ -52,12 +64,13 @@ class PriceFeedRegister extends SDKConstruct {
     return this.#feeds.values();
   }
   /**
-   * Returns RawTxs to update price feeds
-   * @param priceFeeds Array oftop-level price feeds, actual updatable price feeds will be derived.
-   * Or filter criteria, that will gather all main or reserve price feeds from all oracles
-   * If not provided will use all price feeds that are attached
-   * @returns
-   */
+   * Generates transactions to push fresh off-chain prices to updatable feeds.
+   *
+   * @param priceFeeds - Top-level price feeds whose updatable dependencies
+   *   will be resolved, or a filter (`{ main: true }` / `{ reserve: true }`)
+   *   to gather feeds from all oracles. When omitted, all registered feeds
+   *   are used.
+   **/
   async generatePriceFeedsUpdateTxs(priceFeeds) {
     let updateables = this.#feeds.values();
     let filterRemark = "";
@@ -78,7 +91,7 @@ class PriceFeedRegister extends SDKConstruct {
       timestamp: Math.floor(Date.now() / 1e3)
     };
     const updates = (await Promise.all(
-      this.updaters.map((u) => u.getUpdateTxs(updateables).catch(() => []))
+      this.#updaters.map((u) => u.getUpdateTxs(updateables).catch(() => []))
     )).flat();
     let maxTimestamp = 0;
     for (const tx of updates) {
@@ -128,7 +141,7 @@ class PriceFeedRegister extends SDKConstruct {
     });
   }
   /**
-   * Similar to {@link generatePriceFeedsUpdateTxs}, but will generate necessary price update transactions for external price feeds
+   * Similar to {@link generatePriceFeedsUpdateTxs}, but will generate necessary price update transactions for external price feeds (not known to sdk)
    * This does not add feeds to this register, so they won't be implicitly included in future generatePriceFeedsUpdateTxs calls
    * @param feeds
    * @param block
@@ -165,12 +178,32 @@ class PriceFeedRegister extends SDKConstruct {
     );
     return getRawPriceUpdates(updates);
   }
+  /**
+   * Checks whether a price feed is already registered at the given address.
+   * @param address - On-chain address to look up.
+   **/
   has(address) {
     return this.#feeds.has(address);
   }
+  /**
+   * Returns the cached price feed contract at the given address.
+   * @param address - On-chain address to look up.
+   * @throws If no feed is registered at that address.
+   **/
   mustGet(address) {
     return this.#feeds.mustGet(address);
   }
+  /**
+   * Inserts or updates a price feed from a full tree node.
+   *
+   * If a fully loaded feed already exists at the same address, only the
+   * answer is refreshed. Otherwise a new contract wrapper is created and
+   * cached.
+   *
+   * @param data - Full price feed tree node from the compressor.
+   * @returns The cached (or newly created) feed instance.
+   * @throws If the created feed is only partially initialized.
+   **/
   upsert(data) {
     const existing = this.#feeds.get(data.baseParams.addr);
     if (existing?.loaded) {
@@ -217,6 +250,14 @@ class PriceFeedRegister extends SDKConstruct {
     );
     return result.map((baseParams) => this.#createUpdatableProxy({ baseParams }));
   }
+  /**
+   * Instantiates the appropriate price feed contract wrapper based on
+   * the `contractType` discriminator in the node's base params.
+   *
+   * @param data - Partial or full price feed tree node.
+   * @returns A new (uncached) feed contract instance.
+   * @throws If the contract type is unsupported and strict mode is enabled.
+   **/
   create(data) {
     const contractType = bytes32ToString(
       data.baseParams.contractType
@@ -280,8 +321,10 @@ class PriceFeedRegister extends SDKConstruct {
     });
   }
   /**
-   * Information update latest update of updatable price feeds, for diagnostic purposes
-   */
+   * @internal
+   * Diagnostic snapshot of the most recent price-update round, or
+   * `undefined` if no updates have been generated yet.
+   **/
   get latestUpdate() {
     return this.#latestUpdate;
   }

package/dist/esm/sdk/options.js

@@ -6,50 +6,56 @@ import {
 import { ZodAddress } from "./utils/index.js";
 const SDKOptions = z.object({
   /**
-   * If not set, address provider address is determinted automatically from networkType
-   */
+   * Override address of the Gearbox AddressProvider contract.
+   * If not set, uses default universal address provider address {@link ADDRESS_PROVIDER_V310}
+   **/
   addressProvider: ZodAddress().optional(),
   /**
-   * Market configurators
-   */
+   * Addresses of market configurator contracts to load.
+   * If not set, all default market configurators for the chain are loaded
+   * (from {@link GearboxChain.defaultMarketConfigurators})
+   **/
   marketConfigurators: z.array(ZodAddress()).optional(),
   /**
-   * Attach and load state at this specific block number
-   */
+   * Pin SDK to a specific block number during attach.
+   * When set, all on-chain reads use this block instead of `latest`.
+   **/
   blockNumber: z.union([z.bigint().nonnegative(), z.number().int().nonnegative()]).optional(),
   /**
-   * Will skip updateable prices on attach and sync
-   * Makes things faster when your service is not intereseted in prices
-   */
+   * Skip fetching updatable price feeds on attach and sync.
+   * Speeds up initialisation when prices are not needed.
+   **/
   ignoreUpdateablePrices: z.boolean().optional(),
   /**
-   * Will skip loading markets for these pools on attach/hydrate/sync
-   */
+   * Pool addresses whose markets should be skipped during attach/hydrate/sync.
+   **/
   ignoreMarkets: z.array(ZodAddress()).optional(),
   /**
-   * Will throw an error if contract type is not supported, otherwise will try to use generic contract first, if possible
-   */
+   * When `true`, throw on unrecognised contract types instead of falling
+   * back to a generic contract wrapper.
+   **/
   strictContractTypes: z.boolean().optional(),
   /**
-   * Plugins to extends SDK functionality
-   */
+   * Plugins that extend SDK functionality.
+   **/
   plugins: z.record(z.string(), z.any()).optional(),
   /**
-   * Bring your own logger
-   */
+   * Custom logger implementation.
+   **/
   logger: z.any(),
   /**
-   * Options related to redstone price feeds
-   */
+   * Options for Redstone price-feed updates.
+   **/
   redstone: RedstoneOptions.optional(),
   /**
-   * Options related to pyth price feeds
-   */
+   * Options for Pyth price-feed updates.
+   **/
   pyth: PythOptions.optional(),
   /**
-   * Explicit gas limit for read eth_calls
-   * Null to disable explicitly setting gas limit, undefined to use default sdk value
-   */
+   * Explicit gas limit for read-only `eth_call` requests.
+   * `null` disables the gas limit entirely; `undefined` uses the SDK default.
+   * Default gas limit is 550_000_000 (550M).
+   **/
   gasLimit: z.bigint().nonnegative().nullable().optional()
 });
 export {

package/dist/esm/sdk/plugins/BasePlugin.js

@@ -1,11 +1,23 @@
 class BasePlugin {
   #sdk;
   logger;
+  /**
+   * Plugin state version for hydration compatibility checks.
+   * @default 1
+   **/
   version = 1;
+  /**
+   * When `true`, state is fetched eagerly during the `attach` phase
+   * rather than waiting for an explicit `load` call.
+   **/
   loadOnAttach;
   constructor(loadOnAttach = false) {
     this.loadOnAttach = loadOnAttach;
   }
+  /**
+   * Reference to the parent SDK instance.
+   * @throws Error if the SDK has not been attached yet.
+   **/
   get sdk() {
     if (!this.#sdk) {
       throw new Error("SDK is not attached");
@@ -19,17 +31,29 @@ class BasePlugin {
     this.#sdk = sdk;
     this.logger = sdk.logger?.child?.({ name: this.constructor.name }) ?? sdk.logger;
   }
+  /**
+   * {@inheritDoc IGearboxSDKPlugin.attach}
+   **/
   async attach() {
     if (this.loadOnAttach) {
       await this.load(true);
     }
   }
+  /**
+   * {@inheritDoc IGearboxSDKPlugin.syncState}
+   **/
   async syncState() {
     await this.load(false);
   }
+  /**
+   * Network type of the connected chain (e.g. `"Mainnet"`, `"Arbitrum"`).
+   **/
   get network() {
     return this.sdk.networkType;
   }
+  /**
+   * Viem public client for read-only chain interactions.
+   **/
   get client() {
     return this.sdk.client;
   }

package/dist/esm/sdk/pools/AbstractPoolService.js

@@ -10,6 +10,9 @@ class AbstractPoolService extends SDKConstruct {
     this.#version = version;
     this.logger?.debug(`Created PoolService with version: ${this.#version}`);
   }
+  /**
+   * {@inheritDoc IPoolsService.addLiquidity}
+   **/
   addLiquidity({
     collateral,
     pool,
@@ -66,6 +69,9 @@ class AbstractPoolService extends SDKConstruct {
       ];
     }
   }
+  /**
+   * {@inheritDoc IPoolsService.removeLiquidity}
+   **/
   removeLiquidity({
     pool,
     amount,

package/dist/esm/sdk/router/AbstractRouterContract.js

@@ -3,6 +3,9 @@ import { PERCENTAGE_FACTOR } from "../constants/math.js";
 import { AddressMap, AddressSet, formatBN, isDust } from "../utils/index.js";
 import { limitLeftover } from "./helpers.js";
 class AbstractRouterContract extends BaseContract {
+  /**
+   * Reference to the parent SDK instance.
+   **/
   sdk;
   constructor(sdk, args) {
     super(sdk, args);
@@ -65,7 +68,7 @@ class AbstractRouterContract extends BaseContract {
     };
   }
   /**
-   * Tries to sell just enought of most valuable token to cover debt
+   * Tries to sell just enough of the most valuable token to cover debt.
    * @param ca
    * @param keepAssets
    * @returns

package/dist/esm/sdk/router/RouterV310Contract.js

@@ -18,8 +18,8 @@ class RouterV310Contract extends AbstractRouterContract {
     });
   }
   /**
-   * Implements {@link IRouterContract.findOneTokenPath}
-   */
+   * {@inheritDoc IRouterContract.findOneTokenPath}
+   **/
   async findOneTokenPath(props) {
     const {
       creditAccount,
@@ -60,8 +60,8 @@ class RouterV310Contract extends AbstractRouterContract {
     };
   }
   /**
-   * Implements {@link IRouterContract.findOpenStrategyPath}
-   */
+   * {@inheritDoc IRouterContract.findOpenStrategyPath}
+   **/
   async findOpenStrategyPath(props) {
     const {
       creditManager: cm,
@@ -118,8 +118,8 @@ class RouterV310Contract extends AbstractRouterContract {
     };
   }
   /**
-   * Implements {@link IRouterContract.findClaimAllRewards}
-   */
+   * {@inheritDoc IRouterContract.findClaimAllRewards}
+   **/
   async findClaimAllRewards(props) {
     const record = props.tokensToClaim.reduce(
       (acc, a) => {
@@ -144,8 +144,8 @@ class RouterV310Contract extends AbstractRouterContract {
     };
   }
   /**
-   * Implements {@link IRouterContract.findBestClosePath}
-   */
+   * {@inheritDoc IRouterContract.findBestClosePath}
+   **/
   async findBestClosePath(props) {
     const {
       creditAccount: ca,
@@ -210,17 +210,22 @@ class RouterV310Contract extends AbstractRouterContract {
     };
   }
   /**
-   * v310-specific method to set explicitly number of splits for a token
-   * @param token
-   * @param numSplits
-   */
+   * Override the number of route splits used when swapping a specific token.
+   *
+   * @param token - Token address to configure.
+   * @param numSplits - Number of parallel route splits.
+   * @internal
+   **/
   setNumSplits(token, numSplits) {
     this.#numSplits.upsert(token, numSplits);
   }
   /**
-   * v310-specific method to set default number of splits for a token
-   * @param numSplits
-   */
+   * Set the default number of route splits applied to the highest-value
+   * token in each swap.
+   *
+   * @param numSplits - Default number of parallel route splits.
+   * @internal
+   **/
   setDefaultNumSplits(numSplits) {
     this.#defaultNumSplits = numSplits;
   }