@gearbox-protocol/sdk 13.3.3 → 13.3.5

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