@gearbox-protocol/sdk 13.6.0-kyc.7 → 13.6.0

package/dist/esm/plugins/apy/apy-cache.js

@@ -0,0 +1,86 @@
+import axios from "axios";
+class ApyOutputCache {
+  static #instances = /* @__PURE__ */ new Map();
+  #url;
+  #ttlMs;
+  #cache;
+  #pending;
+  #logger;
+  constructor(url, ttlMs, logger) {
+    this.#url = url;
+    this.#ttlMs = ttlMs;
+    this.#logger = logger;
+  }
+  /**
+   * Returns a shared cache instance for the given URL.
+   * The same instance is reused across all callers with identical URL.
+   */
+  static get(url, ttlMs, logger) {
+    let instance = ApyOutputCache.#instances.get(url);
+    if (!instance) {
+      instance = new ApyOutputCache(url, ttlMs, logger);
+      ApyOutputCache.#instances.set(url, instance);
+    }
+    if (logger) {
+      instance.#logger = logger;
+    }
+    return instance;
+  }
+  /**
+   * Returns cached Output if fresh, otherwise fetches from the network.
+   * Concurrent calls are de-duplicated.
+   */
+  async fetch() {
+    if (this.#cache && Date.now() - this.#cache.fetchedAt < this.#ttlMs) {
+      this.#logger?.debug("apy cache: TTL still valid, returning cached data");
+      return this.#cache.data;
+    }
+    if (this.#pending) {
+      this.#logger?.debug("apy cache: request in flight, waiting");
+      return this.#pending;
+    }
+    this.#pending = this.#doFetch();
+    try {
+      return await this.#pending;
+    } finally {
+      this.#pending = void 0;
+    }
+  }
+  async #doFetch() {
+    try {
+      const headers = {};
+      if (this.#cache?.etag) {
+        headers["If-None-Match"] = this.#cache.etag;
+      }
+      const response = await axios.get(this.#url, {
+        headers,
+        validateStatus: (status) => status === 200 || status === 304
+      });
+      if (response.status === 304 && this.#cache) {
+        this.#cache.fetchedAt = Date.now();
+        this.#logger?.debug("apy cache: 304 Not Modified, extended TTL");
+        return this.#cache.data;
+      }
+      const etag = response.headers["etag"];
+      this.#cache = {
+        data: response.data,
+        etag,
+        fetchedAt: Date.now()
+      };
+      this.#logger?.debug(
+        `apy cache: fetched fresh data (timestamp: ${response.data.timestamp})`
+      );
+      return response.data;
+    } catch (e) {
+      this.#logger?.error(e, "apy cache: fetch failed");
+      return this.#cache?.data;
+    }
+  }
+  /** Evicts all cached entries. Mainly useful for tests. */
+  static clearAll() {
+    ApyOutputCache.#instances.clear();
+  }
+}
+export {
+  ApyOutputCache
+};

package/dist/esm/plugins/apy/apy-parser.js

@@ -0,0 +1,143 @@
+import { PERCENTAGE_FACTOR } from "../../sdk/index.js";
+function numberToAPY(baseApy) {
+  return Math.round(baseApy * Number(PERCENTAGE_FACTOR));
+}
+function parseGearStats(output) {
+  const d = output.gearApy?.status === "ok" ? output.gearApy.data : void 0;
+  if (!d) return null;
+  return {
+    base: numberToAPY(d.base ?? 0),
+    crv: numberToAPY(d.crv ?? 0),
+    gear: numberToAPY(d.gear ?? 0),
+    gearPrice: d.gearPrice ?? 0
+  };
+}
+function parseNetworkApy(apyResp, poolResp) {
+  const baseAPYList = {};
+  const extraCollateralAPYList = {};
+  const basePointsList = {};
+  const extraCollateralPointsList = {};
+  const tokenExtraRewardsList = {};
+  const apyData = apyResp?.status === "ok" ? apyResp.data : void 0;
+  for (const d of apyData ?? []) {
+    const tokenAddress = d.address.toLowerCase();
+    const tokenSymbol = d.symbol;
+    const apy = d.rewards.apy?.[0];
+    if (apy) {
+      baseAPYList[tokenAddress] = numberToAPY(apy.value ?? 0);
+    }
+    const points = d.rewards.points?.[0];
+    if (points) {
+      basePointsList[tokenAddress] = {
+        address: tokenAddress,
+        symbol: tokenSymbol,
+        rewards: points.rewards.map((p) => ({
+          ...p,
+          multiplier: p.multiplier === "soon" ? p.multiplier : BigInt(p.multiplier || 0)
+        })),
+        debtRewards: points.debtRewards?.map((p) => ({
+          ...p,
+          cm: (p.cm || "").toLowerCase(),
+          multiplier: p.multiplier === "soon" ? p.multiplier : BigInt(p.multiplier || 0)
+        }))
+      };
+    }
+    const extraRewards = d.rewards.extraRewards;
+    if (extraRewards && extraRewards.length > 0) {
+      tokenExtraRewardsList[tokenAddress] = extraRewards.map((r) => ({
+        address: tokenAddress,
+        symbol: r.rewardSymbol,
+        rewardToken: r.rewardToken.toLowerCase(),
+        rewardSymbol: r.rewardSymbol,
+        token: r.rewardToken.toLowerCase(),
+        finished: BigInt(r.finished || 0),
+        duration: BigInt(r.duration || 0),
+        reward: BigInt(r.reward || 0),
+        balance: BigInt(r.balance || 0)
+      }));
+    }
+    const ecApy = d.rewards.extraCollateralAPY;
+    if (ecApy && ecApy.length > 0) {
+      for (const ea of ecApy) {
+        const pool = ea.pool.toLowerCase();
+        if (!extraCollateralAPYList[pool]) extraCollateralAPYList[pool] = {};
+        extraCollateralAPYList[pool][tokenAddress] = {
+          ...ea,
+          address: tokenAddress,
+          symbol: tokenSymbol,
+          pool,
+          value: numberToAPY(ea.value ?? 0)
+        };
+      }
+    }
+    const ecPoints = d.rewards.extraCollateralPoints;
+    if (ecPoints && ecPoints.length > 0) {
+      for (const ea of ecPoints) {
+        const pool = ea.pool.toLowerCase();
+        if (!extraCollateralPointsList[pool])
+          extraCollateralPointsList[pool] = {};
+        extraCollateralPointsList[pool][tokenAddress] = {
+          address: tokenAddress,
+          symbol: tokenSymbol,
+          rewards: ea.rewards.map((p) => ({
+            ...p,
+            multiplier: p.multiplier === "soon" ? p.multiplier : BigInt(p.multiplier || 0)
+          })),
+          debtRewards: ea.debtRewards?.map((p) => ({
+            ...p,
+            cm: (p.cm || "").toLowerCase(),
+            multiplier: p.multiplier === "soon" ? p.multiplier : BigInt(p.multiplier || 0)
+          }))
+        };
+      }
+    }
+  }
+  const poolRewardsList = {};
+  const poolExternalAPYList = {};
+  const poolExtraAPYList = {};
+  const poolData = poolResp?.status === "ok" ? poolResp.data : void 0;
+  for (const r of poolData ?? []) {
+    const pool = (r.pool || "").toLowerCase();
+    const points = r.rewards.points;
+    if (points && points.length > 0) {
+      poolRewardsList[pool] = points.map((p) => ({
+        ...p,
+        token: p.token.toLowerCase(),
+        pool,
+        amount: BigInt(p.amount || 0)
+      }));
+    }
+    const externalAPY = r.rewards.externalAPY;
+    if (externalAPY && externalAPY.length > 0) {
+      poolExternalAPYList[pool] = externalAPY.map((ex) => ({ ...ex, pool }));
+    }
+    const extraAPY = r.rewards.extraAPY;
+    if (extraAPY && extraAPY.length > 0) {
+      poolExtraAPYList[extraAPY[0].token.toLowerCase()] = extraAPY.map((ex) => ({
+        ...ex,
+        token: ex.token.toLowerCase(),
+        rewardToken: ex.rewardToken.toLowerCase()
+      }));
+    }
+  }
+  const allResponses = [apyResp, poolResp];
+  const allErrors = allResponses.filter((r) => r?.status === "error");
+  if (allResponses.length > 0 && allErrors.length === allResponses.length) {
+    return void 0;
+  }
+  return {
+    apyList: Object.keys(baseAPYList).length > 0 ? baseAPYList : void 0,
+    extraCollateralAPYList: Object.keys(extraCollateralAPYList).length > 0 ? extraCollateralAPYList : void 0,
+    pointsList: Object.keys(basePointsList).length > 0 ? basePointsList : void 0,
+    extraCollateralPointsList: Object.keys(extraCollateralPointsList).length > 0 ? extraCollateralPointsList : void 0,
+    poolRewardsList: Object.keys(poolRewardsList).length > 0 ? poolRewardsList : void 0,
+    tokenExtraRewardsList: Object.keys(tokenExtraRewardsList).length > 0 ? tokenExtraRewardsList : void 0,
+    poolExternalAPYList: Object.keys(poolExternalAPYList).length > 0 ? poolExternalAPYList : void 0,
+    poolExtraAPYList: Object.keys(poolExtraAPYList).length > 0 ? poolExtraAPYList : void 0
+  };
+}
+export {
+  numberToAPY,
+  parseGearStats,
+  parseNetworkApy
+};

package/dist/esm/plugins/apy/constants.js

@@ -0,0 +1,6 @@
+const APY_STATE_CACHE_URL = "https://state-cache.gearbox.foundation/apy-server/latest.json";
+const DEFAULT_APY_INTERVAL_MS = 10 * 60 * 1e3;
+export {
+  APY_STATE_CACHE_URL,
+  DEFAULT_APY_INTERVAL_MS
+};

package/dist/esm/plugins/apy/index.js

@@ -0,0 +1,7 @@
+export * from "./ApyPlugin.js";
+export * from "./apy-cache.js";
+export * from "./apy-parser.js";
+export * from "./constants.js";
+export * from "./pool-apy-types.js";
+export * from "./pool-apy-utils.js";
+export * from "./types.js";

package/dist/esm/plugins/apy/pool-apy-utils.js

@@ -0,0 +1,113 @@
+import { PERCENTAGE_FACTOR, RAY } from "../../sdk/constants/index.js";
+import { formatBN, rayToNumber } from "../../sdk/utils/formatter.js";
+const SCALE = 1000000n;
+const WEEKS_PER_YEAR = 54n;
+function getPoolExtraAPY(lookupAddresses, poolExtraAPYList) {
+  if (!poolExtraAPYList) return [];
+  const result = [];
+  for (const addr of lookupAddresses) {
+    const extra = poolExtraAPYList[addr.toLowerCase()];
+    if (extra) {
+      result.push(...extra);
+    }
+  }
+  return result;
+}
+function calculateSupplyApy7d(currentDieselRate, currentSupplyRate, dieselRate7DAgo) {
+  if (dieselRate7DAgo > currentDieselRate) {
+    return rayToNumber(currentSupplyRate * SCALE) / Number(PERCENTAGE_FACTOR);
+  }
+  const apy = (currentDieselRate * RAY / dieselRate7DAgo - RAY) * WEEKS_PER_YEAR;
+  return rayToNumber(apy * SCALE) / Number(PERCENTAGE_FACTOR);
+}
+function calculatePoolFullAPY({
+  depositAPY,
+  underlyingAPY,
+  extraAPY,
+  currentExternalList
+}) {
+  const baseAPY = [
+    { type: "supplyAPY", apy: depositAPY },
+    ...underlyingAPY > 0 ? [
+      {
+        type: "tokenYield",
+        apy: Number(underlyingAPY) / Number(PERCENTAGE_FACTOR)
+      }
+    ] : []
+  ];
+  const filteredExtra = [...extraAPY ?? []].filter((r) => r.apy > 0);
+  const baseAPYTotal = baseAPY.reduce((s, r) => s + (r.apy || 0), 0);
+  const extraAPYTotal = filteredExtra.reduce((s, r) => s + (r.apy || 0), 0);
+  const total = baseAPYTotal + extraAPYTotal;
+  const externalAPY = resolveExternalAPY(currentExternalList, total);
+  return {
+    totalAPY: total,
+    baseAPY,
+    extraAPY: filteredExtra,
+    extraAPYTotal,
+    externalAPY
+  };
+}
+function resolveExternalAPY(list, baseTotal) {
+  const first = list?.[0];
+  if (!first) return void 0;
+  return {
+    ...first,
+    totalValue: baseTotal + first.value
+  };
+}
+function calculatePoolFullAPY7DAgo({
+  supplyAPY7DAgo,
+  depositAPY,
+  poolAPY
+}) {
+  const {
+    baseAPY = [],
+    extraAPYTotal = 0,
+    extraAPY = [],
+    externalAPY
+  } = poolAPY ?? {};
+  const base = [
+    { apy: supplyAPY7DAgo || depositAPY, type: "supplyAPY" },
+    ...baseAPY.filter((r) => r.type !== "supplyAPY")
+  ];
+  const baseTotal = base.reduce((acc, r) => acc + r.apy, 0);
+  const total = baseTotal + extraAPYTotal;
+  return {
+    totalAPY: total,
+    extraAPYTotal,
+    baseAPY: base,
+    extraAPY,
+    externalAPY,
+    loading7DAgo: supplyAPY7DAgo === void 0
+  };
+}
+function calculatePoolPoints({
+  poolTokenSymbol,
+  points,
+  tokensList
+}) {
+  return points?.map(({ info, points: pts }) => {
+    const { decimals = 18 } = tokensList.get(info.token) || {};
+    const amount = formatBN(pts, decimals);
+    const { name = "Points", duration } = info ?? {};
+    return {
+      reward: info,
+      name,
+      amount,
+      tokenTitle: poolTokenSymbol,
+      fullTip: [
+        `${amount} ${name}`,
+        ...duration ? [duration] : [],
+        ...poolTokenSymbol ? [poolTokenSymbol] : []
+      ].join(" per ")
+    };
+  });
+}
+export {
+  calculatePoolFullAPY,
+  calculatePoolFullAPY7DAgo,
+  calculatePoolPoints,
+  calculateSupplyApy7d,
+  getPoolExtraAPY
+};

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

@@ -52,11 +52,13 @@ class PoolPointsAPI {
     tokensList
   }) {
     const r = pools.reduce((acc, p) => {
-      const pointsInfo = poolRewards[p.address] || [];
+      const poolAddress = p.pool.pool.address.toLowerCase();
+      const pointsInfo = poolRewards[poolAddress] || [];
       const poolPointsList = pointsInfo.reduce(
         (acc2, pointsInfo2) => {
-          const { address: tokenAddress } = tokensList[pointsInfo2.token] || {};
-          const tokenBalance = totalTokenBalances[tokenAddress || ""];
+          const { addr: tokenAddress } = tokensList.get(pointsInfo2.token) || {};
+          const tokenAddressLower = (tokenAddress || "").toLowerCase();
+          const tokenBalance = totalTokenBalances[tokenAddressLower];
           const points = PoolPointsAPI.getPoolTokenPoints(
             tokenBalance,
             p,
@@ -74,22 +76,22 @@ class PoolPointsAPI {
         },
         []
       );
-      acc[p.address] = poolPointsList;
+      acc[poolAddress] = poolPointsList;
       return acc;
     }, {});
     return r;
   }
   static getPoolTokenPoints(tokenBalanceInPool, pool, tokensList, pointsInfo) {
-    if (pool.expectedLiquidity <= 0) return 0n;
+    if (pool.pool.pool.expectedLiquidity <= 0) return 0n;
     if (pointsInfo.estimation === "relative" && !tokenBalanceInPool)
       return null;
-    const { decimals = 18 } = tokensList[pointsInfo.token] || {};
+    const { decimals = 18 } = tokensList.get(pointsInfo.token) || {};
     const targetFactor = 10n ** BigInt(decimals);
     const defaultPoints = pointsInfo.amount * targetFactor / PERCENTAGE_FACTOR;
     if (pointsInfo.estimation === "absolute") return defaultPoints;
-    const { decimals: underlyingDecimals = 18 } = tokensList[pool.underlyingToken] || {};
+    const { decimals: underlyingDecimals = 18 } = tokensList.get(pool.pool.pool.underlying) || {};
     const underlyingFactor = 10n ** BigInt(underlyingDecimals);
-    const points = (tokenBalanceInPool?.balance || 0n) * defaultPoints / (pool.expectedLiquidity * targetFactor / underlyingFactor);
+    const points = (tokenBalanceInPool?.balance || 0n) * defaultPoints / (pool.pool.pool.expectedLiquidity * targetFactor / underlyingFactor);
     return BigIntMath.min(points, defaultPoints);
   }
 }

package/dist/esm/sdk/GearboxSDK.js

@@ -16,7 +16,6 @@ import {
   VERSION_RANGE_310
 } from "./constants/index.js";
 import { createAddressProvider, hydrateAddressProvider } from "./core/index.js";
-import { KYCRegistry } from "./market/kyc/index.js";
 import { MarketRegister } from "./market/MarketRegister.js";
 import { PriceFeedRegister } from "./market/pricefeeds/index.js";
 import {
@@ -25,10 +24,7 @@ import {
 import { createRouter } from "./router/index.js";
 import { formatTimestamp, TypedObjectUtils, toAddress } from "./utils/index.js";
 import { Hooks } from "./utils/internal/index.js";
-import {
-  executeDelegatedMulticalls,
-  getLogsSafe
-} from "./utils/viem/index.js";
+import { getLogsSafe } from "./utils/viem/index.js";
 const ERR_NOT_ATTACHED = new Error("Gearbox SDK not attached");
 const STATE_VERSION = 1;
 function createClient(opts, network) {
@@ -81,7 +77,6 @@ class GearboxSDK extends ChainContractsRegister {
   #addressProvider;
   #attachConfig;
   #marketRegister;
-  #kyc;
   #priceFeeds;
   /**
    * Gas limit applied to read-only `eth_call` requests.
@@ -126,7 +121,6 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators: mcs,
-      kycFactories: kfs,
       strictContractTypes,
       gasLimit
     } = options;
@@ -136,7 +130,6 @@ class GearboxSDK extends ChainContractsRegister {
       addressProvider = ADDRESS_PROVIDER_V310;
     }
     const marketConfigurators = mcs ?? TypedObjectUtils.keys(client.chain.defaultMarketConfigurators);
-    const kycFactories = kfs ?? client.chain.kycFactories;
     return new GearboxSDK({
       client,
       logger,
@@ -149,7 +142,6 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators,
-      kycFactories,
       redstone,
       pyth
     });
@@ -189,7 +181,7 @@ class GearboxSDK extends ChainContractsRegister {
       plugin.sdk = this;
     }
     if (options.gasLimit !== null) {
-      this.gasLimit = options.gasLimit || 550000000n;
+      this.gasLimit = options.gasLimit || getChain(this.networkType).gasLimit;
     }
   }
   async #attach(opts) {
@@ -199,7 +191,6 @@ class GearboxSDK extends ChainContractsRegister {
       ignoreUpdateablePrices,
       ignoreMarkets,
       marketConfigurators,
-      kycFactories,
       redstone,
       pyth
     } = opts;
@@ -210,7 +201,6 @@ class GearboxSDK extends ChainContractsRegister {
         chainId: this.chainId,
         addressProvider,
         marketConfigurators,
-        kycFactories,
         blockNumber,
         ignoreMarkets
       },
@@ -245,34 +235,10 @@ class GearboxSDK extends ChainContractsRegister {
     );
     await this.#addressProvider.syncState(this.currentBlock);
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
-    this.#kyc = new KYCRegistry(this);
-    if (!marketConfigurators.length) {
-      this.logger?.warn(
-        "no market configurators provided, skipping market loading"
-      );
-    } else {
-      const delegated = [
-        ...this.#marketRegister.getLoadMulticalls(marketConfigurators),
-        ...this.#kyc.getLoadMulticalls(marketConfigurators, kycFactories)
-      ];
-      let txs = [];
-      if (!ignoreUpdateablePrices) {
-        const updatables = await this.#priceFeeds.getPartialUpdatablePriceFeeds(
-          marketConfigurators
-        );
-        const updates = await this.#priceFeeds.generatePriceFeedsUpdateTxs(updatables);
-        txs = updates.txs;
-      }
-      this.logger?.debug(
-        { configurators: marketConfigurators },
-        `calling getMarkets with ${txs.length} price updates in block ${this.currentBlock}`
-      );
-      await executeDelegatedMulticalls(this.client, delegated, {
-        priceUpdates: txs,
-        blockNumber: this.currentBlock,
-        gas: this.gasLimit
-      });
-    }
+    await this.#marketRegister.loadMarkets(
+      marketConfigurators,
+      ignoreUpdateablePrices
+    );
     const pluginsList = TypedObjectUtils.entries(this.plugins);
     const pluginResponse = await Promise.allSettled(
       pluginsList.map(([name, plugin]) => {
@@ -318,15 +284,12 @@ class GearboxSDK extends ChainContractsRegister {
     );
     this.#marketRegister = new MarketRegister(this, ignoreMarkets);
     this.#marketRegister.hydrate(state.markets);
-    this.#kyc = new KYCRegistry(this);
-    this.#kyc.setState(state.kyc);
     this.#attachConfig = {
       ...opts,
       addressProvider: this.addressProvider.address,
       marketConfigurators: this.marketRegister.marketConfigurators.map(
         (m) => m.address
       ),
-      kycFactories: this.kyc.factories.map((f) => f.address),
       blockNumber: this.currentBlock
     };
     for (const [name, plugin] of TypedObjectUtils.entries(this.plugins)) {
@@ -410,7 +373,6 @@ class GearboxSDK extends ChainContractsRegister {
         addressProviderV3: this.addressProvider.stateHuman(raw)
       },
       tokens: this.tokensMeta.values(),
-      kyc: this.kyc.stateHuman(raw),
       plugins: Object.fromEntries(
         TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
           name,
@@ -436,7 +398,6 @@ class GearboxSDK extends ChainContractsRegister {
       timestamp: this.timestamp,
       addressProvider: this.addressProvider.state,
       markets: this.marketRegister.state,
-      kyc: this.kyc.state,
       plugins: Object.fromEntries(
         TypedObjectUtils.entries(this.plugins).map(([name, plugin]) => [
           name,
@@ -633,17 +594,6 @@ class GearboxSDK extends ChainContractsRegister {
     }
     return this.#marketRegister;
   }
-  /**
-   * KYC register for KYC-wrapped underlying tokens and factories.
-   *
-   * @throws If the SDK has not been attached or hydrated yet.
-   **/
-  get kyc() {
-    if (this.#kyc === void 0) {
-      throw ERR_NOT_ATTACHED;
-    }
-    return this.#kyc;
-  }
   /**
    * Resolves the appropriate router contract for a given credit manager,
    * credit facade, or explicit version range.