@gearbox-protocol/sdk 13.3.2 → 13.3.4

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/cjs/sdk/utils/viem/sendRawTx.js

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var sendRawTx_exports = {};
 __export(sendRawTx_exports, {
+  estimateRawTxGas: () => estimateRawTxGas,
   sendRawTx: () => sendRawTx
 });
 module.exports = __toCommonJS(sendRawTx_exports);
@@ -36,7 +37,22 @@ async function sendRawTx(client, params) {
     value: BigInt(tx.value)
   });
 }
+async function estimateRawTxGas(client, params) {
+  const { tx, ...rest } = params;
+  return (0, import_utils.getAction)(
+    client,
+    import_actions.estimateGas,
+    "estimateGas"
+  )({
+    ...rest,
+    account: params.account,
+    data: tx.callData,
+    to: tx.to,
+    value: BigInt(tx.value)
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  estimateRawTxGas,
   sendRawTx
 });

package/dist/esm/rewards/rewards/api.js

@@ -1,102 +1,12 @@
-import { getAddress, getContract } from "viem";
-import { iFarmingPoolAbi } from "../../abi/iFarmingPool.js";
+import { getAddress } from "viem";
 import { BigIntMath } from "../../common-utils/index.js";
 import { chains, toBigInt } from "../../sdk/index.js";
 import {
   MerkleXYZApi
 } from "./merkl-api.js";
-class GearboxRewardsApi {
+class RewardAmountAPI {
   constructor() {
   }
-  static async getLmRewardsV3({
-    pools,
-    tokensList,
-    provider,
-    account,
-    reportError
-  }) {
-    const poolByStakedDiesel = Object.values(pools).reduce((acc, p) => {
-      p.stakedDieselToken.forEach((t) => {
-        if (t) acc[t] = p.address;
-      });
-      p.stakedDieselToken_old.forEach((t) => {
-        if (t) acc[t] = p.address;
-      });
-      return acc;
-    }, {});
-    const stakedDieselTokens = Object.keys(poolByStakedDiesel);
-    const farmInfoCalls = stakedDieselTokens.map((address) => ({
-      address,
-      abi: iFarmingPoolAbi,
-      functionName: "farmInfo",
-      args: []
-    }));
-    const rewardTokenCalls = stakedDieselTokens.map((address) => ({
-      address,
-      abi: POOL_REWARDS_ABI,
-      functionName: "rewardsToken",
-      args: []
-    }));
-    const farmedCalls = stakedDieselTokens.map((address) => ({
-      address,
-      abi: iFarmingPoolAbi,
-      functionName: "farmed",
-      args: [account]
-    }));
-    const [response] = await Promise.allSettled([
-      provider.multicall({
-        allowFailure: false,
-        contracts: [...farmInfoCalls, ...rewardTokenCalls, ...farmedCalls],
-        batchSize: 0
-      })
-    ]);
-    const safeResponse = GearboxRewardsApi.extractFulfilled(response, reportError, "v3Rewards") || [];
-    const farmInfoCallsEnd = farmInfoCalls.length;
-    const farmInfo = safeResponse.slice(
-      0,
-      farmInfoCallsEnd
-    );
-    const rewardTokenCallsEnd = farmInfoCallsEnd + rewardTokenCalls.length;
-    const rewardTokens = safeResponse.slice(
-      farmInfoCallsEnd,
-      rewardTokenCallsEnd
-    );
-    const farmedCallsEnd = rewardTokenCallsEnd + farmedCalls.length;
-    const farmedList = safeResponse.slice(
-      rewardTokenCallsEnd,
-      farmedCallsEnd
-    );
-    const gearboxLmRewards = stakedDieselTokens.map(
-      (address, i) => {
-        const pool = poolByStakedDiesel[address];
-        const info = farmInfo[i];
-        const rewardToken = rewardTokens[i]?.toLowerCase();
-        const farmed = farmedList[i];
-        if (!pool || !info || !rewardToken) return void 0;
-        return {
-          pool,
-          poolToken: address,
-          rewardToken,
-          rewardTokenDecimals: tokensList[rewardToken]?.decimals || 18,
-          rewardTokenSymbol: tokensList[rewardToken]?.symbol || "unknown",
-          amount: farmed ?? 0n,
-          type: "stakedV3"
-        };
-      }
-    );
-    const { zero, nonZero } = gearboxLmRewards.reduce(
-      (acc, r) => {
-        if (r && r.amount > 0n) {
-          acc.nonZero.push(r);
-        } else if (r) {
-          acc.zero.push(r);
-        }
-        return acc;
-      },
-      { nonZero: [], zero: [] }
-    );
-    return [...nonZero, zero];
-  }
   static async getLmRewardsMerkle({
     pools,
     account,
@@ -113,7 +23,7 @@ class GearboxRewardsApi {
         })
       )
     ]);
-    const merkleXYZLm = GearboxRewardsApi.extractFulfilled(
+    const merkleXYZLm = RewardAmountAPI.extractFulfilled(
       merkleXYZLMResponse,
       reportError,
       "merkleXYZLm"
@@ -168,37 +78,7 @@ class GearboxRewardsApi {
       return void 0;
     }
   }
-  static async claimLmRewardsV3({
-    reward,
-    signer,
-    account
-  }) {
-    const pool = getContract({
-      address: reward.poolToken,
-      abi: iFarmingPoolAbi,
-      client: signer
-    });
-    return pool.write.claim({
-      account,
-      chain: signer.chain
-    });
-  }
 }
-const POOL_REWARDS_ABI = [
-  {
-    inputs: [],
-    name: "rewardsToken",
-    outputs: [
-      {
-        internalType: "contract IERC20",
-        name: "",
-        type: "address"
-      }
-    ],
-    stateMutability: "view",
-    type: "function"
-  }
-];
 export {
-  GearboxRewardsApi
+  RewardAmountAPI
 };

package/dist/esm/rewards/rewards/extra-apy.js

@@ -17,7 +17,7 @@ function getKeyForPoolPointsInfo(i) {
     i.condition
   ].join("-");
 }
-class GearboxRewardsExtraApy {
+class PoolPointsAPI {
   constructor() {
   }
   static async getTotalTokensOnProtocol({
@@ -27,9 +27,7 @@ class GearboxRewardsExtraApy {
   }) {
     const list = [...new Set(tokensToCheck)];
     const res = await Promise.allSettled(
-      list.map(
-        (t) => GearboxRewardsExtraApy.getTokenTotal(t, network, tokensList)
-      )
+      list.map((t) => PoolPointsAPI.getTokenTotal(t, network, tokensList))
     );
     return res.map((r, i) => [
       list[i],
@@ -59,7 +57,7 @@ class GearboxRewardsExtraApy {
         (acc2, pointsInfo2) => {
           const { address: tokenAddress } = tokensList[pointsInfo2.token] || {};
           const tokenBalance = totalTokenBalances[tokenAddress || ""];
-          const points = GearboxRewardsExtraApy.getPoolTokenPoints(
+          const points = PoolPointsAPI.getPoolTokenPoints(
             tokenBalance,
             p,
             tokensList,
@@ -96,6 +94,6 @@ class GearboxRewardsExtraApy {
   }
 }
 export {
-  GearboxRewardsExtraApy,
+  PoolPointsAPI,
   getKeyForPoolPointsInfo
 };

package/dist/esm/rewards/rewards/index.js

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