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

package/dist/cjs/sdk/options.js

@@ -26,50 +26,56 @@ var import_updates = require("./market/pricefeeds/updates/index.js");
 var import_utils = require("./utils/index.js");
 const SDKOptions = import_v4.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: (0, import_utils.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: import_v4.z.array((0, import_utils.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: import_v4.z.union([import_v4.z.bigint().nonnegative(), import_v4.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: import_v4.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: import_v4.z.array((0, import_utils.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: import_v4.z.boolean().optional(),
   /**
-   * Plugins to extends SDK functionality
-   */
+   * Plugins that extend SDK functionality.
+   **/
   plugins: import_v4.z.record(import_v4.z.string(), import_v4.z.any()).optional(),
   /**
-   * Bring your own logger
-   */
+   * Custom logger implementation.
+   **/
   logger: import_v4.z.any(),
   /**
-   * Options related to redstone price feeds
-   */
+   * Options for Redstone price-feed updates.
+   **/
   redstone: import_updates.RedstoneOptions.optional(),
   /**
-   * Options related to pyth price feeds
-   */
+   * Options for Pyth price-feed updates.
+   **/
   pyth: import_updates.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: import_v4.z.bigint().nonnegative().nullable().optional()
 });
 // Annotate the CommonJS export names for ESM import in node:

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

@@ -24,11 +24,23 @@ module.exports = __toCommonJS(BasePlugin_exports);
 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");
@@ -42,17 +54,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/cjs/sdk/pools/AbstractPoolService.js

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

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

@@ -26,6 +26,9 @@ var import_math = require("../constants/math.js");
 var import_utils = require("../utils/index.js");
 var import_helpers = require("./helpers.js");
 class AbstractRouterContract extends import_base.BaseContract {
+  /**
+   * Reference to the parent SDK instance.
+   **/
   sdk;
   constructor(sdk, args) {
     super(sdk, args);
@@ -88,7 +91,7 @@ class AbstractRouterContract extends import_base.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/cjs/sdk/router/RouterV310Contract.js

@@ -41,8 +41,8 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
     });
   }
   /**
-   * Implements {@link IRouterContract.findOneTokenPath}
-   */
+   * {@inheritDoc IRouterContract.findOneTokenPath}
+   **/
   async findOneTokenPath(props) {
     const {
       creditAccount,
@@ -83,8 +83,8 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
     };
   }
   /**
-   * Implements {@link IRouterContract.findOpenStrategyPath}
-   */
+   * {@inheritDoc IRouterContract.findOpenStrategyPath}
+   **/
   async findOpenStrategyPath(props) {
     const {
       creditManager: cm,
@@ -141,8 +141,8 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
     };
   }
   /**
-   * Implements {@link IRouterContract.findClaimAllRewards}
-   */
+   * {@inheritDoc IRouterContract.findClaimAllRewards}
+   **/
   async findClaimAllRewards(props) {
     const record = props.tokensToClaim.reduce(
       (acc, a) => {
@@ -167,8 +167,8 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
     };
   }
   /**
-   * Implements {@link IRouterContract.findBestClosePath}
-   */
+   * {@inheritDoc IRouterContract.findBestClosePath}
+   **/
   async findBestClosePath(props) {
     const {
       creditAccount: ca,
@@ -233,17 +233,22 @@ class RouterV310Contract extends import_AbstractRouterContract.AbstractRouterCon
     };
   }
   /**
-   * 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/cjs/sdk/utils/AddressMap.js

@@ -26,6 +26,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) {
@@ -37,9 +41,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) {
@@ -53,9 +58,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) {
@@ -70,27 +76,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 = (0, import_viem.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 = (0, import_viem.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 = (0, import_viem.getAddress)(address);
@@ -100,40 +105,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 = (0, import_viem.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/cjs/sdk/utils/AddressSet.js

@@ -23,6 +23,9 @@ __export(AddressSet_exports, {
 module.exports = __toCommonJS(AddressSet_exports);
 var import_viem = require("viem");
 class AddressSet extends Set {
+  /**
+   * @param entries - Optional initial addresses. Each is checksummed automatically.
+   */
   constructor(entries) {
     super(Array.from(entries ?? []).map((a) => (0, import_viem.getAddress)(a)));
   }
@@ -35,9 +38,15 @@ class AddressSet extends Set {
   has(value) {
     return super.has((0, import_viem.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/permissionless/utils/price-update/get-price-update-tx.js

@@ -1,26 +1,13 @@
 import {
-  decodeFunctionData,
-  multicall3Abi,
-  parseAbi
+  multicall3Abi
 } from "viem";
 import {
   createRawTx,
-  GearboxSDK
+  GearboxSDK,
+  getRawPriceUpdates
 } from "../../../sdk/index.js";
-import {
-  PriceFeedStoreContract
-} from "../../bindings/index.js";
+import { PriceFeedStoreContract } from "../../bindings/index.js";
 import { Addresses } from "../../deployment/addresses.js";
-function getUpdateCalldata(tx) {
-  const data = decodeFunctionData({
-    abi: parseAbi(["function updatePrice(bytes calldata data) external"]),
-    data: tx.raw.callData
-  });
-  return {
-    priceFeed: tx.raw.to,
-    data: data.args[0]
-  };
-}
 async function getPriceUpdateTx({
   client,
   priceFeeds,
@@ -57,13 +44,12 @@ async function getPriceUpdateTx({
     });
     return multicallTx;
   }
-  const priceUpdates = updateTxs.txs.map((tx) => getUpdateCalldata(tx));
+  const priceUpdates = getRawPriceUpdates(updateTxs);
   if (priceUpdates.length === 0) {
     return void 0;
   }
   return pfStore.updatePrices(priceUpdates);
 }
 export {
-  getPriceUpdateTx,
-  getUpdateCalldata
+  getPriceUpdateTx
 };