@gearbox-protocol/sdk 13.3.2 → 13.3.4

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;
   }

package/dist/esm/sdk/utils/AddressMap.js

@@ -3,6 +3,10 @@ class AddressMap {
   #map;
   #frozen = false;
   #name;
+  /**
+   * @param entries - Optional initial key-value pairs. Address strings are checksummed automatically.
+   * @param name - Optional label used in error messages when a lookup fails.
+   */
   constructor(entries, name) {
     this.#map = /* @__PURE__ */ new Map();
     if (entries) {
@@ -14,9 +18,10 @@ class AddressMap {
     this.#name = name;
   }
   /**
-   * Adds or updates value, undefined removes value
-   * @param address
-   * @param value
+   * Adds or updates a value. Passing `undefined` removes the entry.
+   * @param address - EVM address (checksummed automatically).
+   * @param value - Value to store, or `undefined` to delete the entry.
+   * @throws If the map has been {@link freeze | frozen}.
    */
   upsert(address, value) {
     if (this.#frozen) {
@@ -30,9 +35,10 @@ class AddressMap {
     }
   }
   /**
-   * Adds value, throws if this address is already used
-   * @param address
-   * @param value
+   * Inserts a value, throwing if the address is already present.
+   * @param address - EVM address (checksummed automatically).
+   * @param value - Value to store.
+   * @throws If the map has been {@link freeze | frozen} or if `address` already exists.
    */
   insert(address, value) {
     if (this.#frozen) {
@@ -47,27 +53,26 @@ class AddressMap {
     this.#map.set(key, value);
   }
   /**
-   * Checks if address is present in map
-   * @param address
-   * @returns
+   * Checks whether an address is present in the map.
+   * @param address - EVM address (case-insensitive).
    */
   has(address) {
     const key = getAddress(address);
     return this.#map.has(key);
   }
   /**
-   * Returns value, or undefined if the address is not in map
-   * @param address
-   * @returns
+   * Looks up a value by EVM address (case-insensitive).
+   * @param address - EVM address to look up.
+   * @returns The stored value, or `undefined` if not present.
    */
   get(address) {
     const key = getAddress(address);
     return this.#map.get(key);
   }
   /**
-   * Gets address from map, throws if not found
-   * @param address
-   * @returns
+   * Looks up a value by EVM address, throwing if the address is absent.
+   * @param address - EVM address to look up.
+   * @throws If `address` is not in the map.
    */
   mustGet(address) {
     const key = getAddress(address);
@@ -77,40 +82,71 @@ class AddressMap {
     return this.#map.get(key);
   }
   /**
-   * Deletes address from map
-   * @param address
+   * Removes an entry by address. No-op if the address is absent.
+   * @param address - EVM address to remove.
    */
   delete(address) {
     const key = getAddress(address);
     this.#map.delete(key);
   }
+  /**
+   * Removes all entries from the map.
+   **/
   clear() {
     this.#map.clear();
   }
+  /**
+   * Returns all entries as an array of `[checksummedAddress, value]` tuples.
+   **/
   entries() {
     return Array.from(this.#map.entries());
   }
+  /**
+   * Returns all values in insertion order.
+   **/
   values() {
     return Array.from(this.#map.values());
   }
+  /**
+   * Returns all checksummed addresses in insertion order.
+   **/
   keys() {
     return Array.from(this.#map.keys());
   }
+  /**
+   * Converts the map to a plain `Record<Address, T>` object.
+   **/
   asRecord() {
     return Object.fromEntries(this.#map.entries());
   }
+  /**
+   * Number of entries in the map.
+   **/
   get size() {
     return this.#map.size;
   }
+  /**
+   * Prevents further mutations. Any subsequent call to {@link upsert},
+   * {@link insert}, or {@link delete} will throw.
+   */
   freeze() {
     this.#frozen = true;
   }
   get name() {
     return this.#name;
   }
+  /**
+   * Creates an `AddressMap` from a plain record object.
+   * @param record - Object whose keys are EVM addresses.
+   */
   static fromRecord(record) {
     return new AddressMap(Object.entries(record));
   }
+  /**
+   * Creates an `AddressMap` by extracting an address from each array element.
+   * @param array - Source items.
+   * @param mapFn - Function that returns the address key for a given item.
+   */
   static fromMappedArray(array, mapFn) {
     return new AddressMap(array.map((item) => [mapFn(item), item]));
   }

package/dist/esm/sdk/utils/AddressSet.js

@@ -1,5 +1,8 @@
 import { getAddress } from "viem";
 class AddressSet extends Set {
+  /**
+   * @param entries - Optional initial addresses. Each is checksummed automatically.
+   */
   constructor(entries) {
     super(Array.from(entries ?? []).map((a) => getAddress(a)));
   }
@@ -12,9 +15,15 @@ class AddressSet extends Set {
   has(value) {
     return super.has(getAddress(value));
   }
+  /**
+   * Returns all addresses as an array.
+   **/
   asArray() {
     return Array.from(this);
   }
+  /**
+   * Maps each address through `fn` and returns the resulting array.
+   **/
   map(fn) {
     return this.asArray().map(fn);
   }

package/dist/esm/sdk/utils/viem/sendRawTx.js

@@ -1,4 +1,7 @@
-import { sendTransaction } from "viem/actions";
+import {
+  estimateGas,
+  sendTransaction
+} from "viem/actions";
 import { getAction } from "viem/utils";
 async function sendRawTx(client, params) {
   const { tx, ...rest } = params;
@@ -13,6 +16,21 @@ async function sendRawTx(client, params) {
     value: BigInt(tx.value)
   });
 }
+async function estimateRawTxGas(client, params) {
+  const { tx, ...rest } = params;
+  return getAction(
+    client,
+    estimateGas,
+    "estimateGas"
+  )({
+    ...rest,
+    account: params.account,
+    data: tx.callData,
+    to: tx.to,
+    value: BigInt(tx.value)
+  });
+}
 export {
+  estimateRawTxGas,
   sendRawTx
 };

package/dist/types/rewards/rewards/api.d.ts

@@ -1,6 +1,6 @@
-import type { Address, PublicClient, WalletClient } from "viem";
+import type { Address } from "viem";
 import { type NetworkType } from "../../sdk/index.js";
-import type { PoolData, TokenData } from "./common.js";
+import type { PoolData } from "./common.js";
 export interface GearboxExtraMerkleLmReward {
     pool: Address;
     poolToken: Address;
@@ -10,40 +10,17 @@ export interface GearboxExtraMerkleLmReward {
     amount: bigint;
     type: "extraMerkle";
 }
-export interface GearboxStakedV3LmReward {
-    pool: Address;
-    poolToken: Address;
-    rewardTokenSymbol: string;
-    rewardTokenDecimals: number;
-    rewardToken: Address;
-    amount: bigint;
-    type: "stakedV3";
-}
-export type GearboxLmReward = GearboxStakedV3LmReward | GearboxExtraMerkleLmReward;
+export type GearboxLmReward = GearboxExtraMerkleLmReward;
 type ReportHandler = (e: unknown, description?: string) => void;
-export interface GetLmRewardsV3Props {
-    pools: Record<`0x${string}`, PoolData>;
-    tokensList: Record<Address, TokenData>;
-    account: Address;
-    provider: PublicClient;
-    reportError?: ReportHandler;
-}
 export interface GetLmRewardsMerkleProps {
     pools: Record<Address, PoolData>;
     account: Address;
     network: NetworkType;
     reportError?: ReportHandler;
 }
-export interface ClaimLmRewardsV3Props {
-    reward: GearboxStakedV3LmReward;
-    account: Address;
-    signer: WalletClient;
-}
-export declare class GearboxRewardsApi {
+export declare class RewardAmountAPI {
     private constructor();
-    static getLmRewardsV3({ pools, tokensList, provider, account, reportError, }: GetLmRewardsV3Props): Promise<(GearboxLmReward | GearboxLmReward[])[]>;
-    static getLmRewardsMerkle({ pools, account, network, reportError, }: GetLmRewardsMerkleProps): Promise<GearboxLmReward[]>;
+    static getLmRewardsMerkle({ pools, account, network, reportError, }: GetLmRewardsMerkleProps): Promise<GearboxExtraMerkleLmReward[]>;
     private static extractFulfilled;
-    static claimLmRewardsV3({ reward, signer, account, }: ClaimLmRewardsV3Props): Promise<`0x${string}`>;
 }
 export {};

package/dist/types/rewards/rewards/extra-apy.d.ts

@@ -20,7 +20,7 @@ export type PoolPointsBase = Record<Address, Array<{
     points: bigint;
 }>>;
 export declare function getKeyForPoolPointsInfo(i: PoolPointsInfo<string>): string;
-export declare class GearboxRewardsExtraApy {
+export declare class PoolPointsAPI {
     private constructor();
     static getTotalTokensOnProtocol({ tokensToCheck, tokensList, network, }: GetTotalTokensOnProtocolProps): Promise<[`0x${string}`, PromiseSettledResult<Asset>][]>;
     private static getTokenTotal;

package/dist/types/rewards/rewards/index.d.ts

@@ -1,4 +1,2 @@
 export * from "./api.js";
-export * from "./apy.js";
 export * from "./extra-apy.js";
-export * from "./merkl-api.js";