@gearbox-protocol/sdk 14.8.7 → 14.10.0-next.1

package/dist/esm/{plugins/apy/apy-cache.js → common-utils/axios-cache/AxiosCache.js}

@@ -1,42 +1,49 @@
 import axios from "axios";
-class ApyOutputCache {
+class AxiosCache {
   static #instances = /* @__PURE__ */ new Map();
   #url;
   #ttlMs;
   #cache;
   #pending;
   #logger;
-  constructor(url, ttlMs, logger) {
+  #getLogMeta;
+  constructor(url, ttlMs, logger, getLogMeta) {
     this.#url = url;
     this.#ttlMs = ttlMs;
     this.#logger = logger;
+    this.#getLogMeta = getLogMeta;
   }
   /**
    * 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);
+  static get(url, ttlMs, logger, getLogMeta) {
+    let instance = AxiosCache.#instances.get(url);
     if (!instance) {
-      instance = new ApyOutputCache(url, ttlMs, logger);
-      ApyOutputCache.#instances.set(url, instance);
+      instance = new AxiosCache(url, ttlMs, logger, getLogMeta);
+      AxiosCache.#instances.set(url, instance);
     }
     if (logger) {
       instance.#logger = logger;
     }
+    if (getLogMeta) {
+      instance.#getLogMeta = getLogMeta;
+    }
     return instance;
   }
   /**
-   * Returns cached Output if fresh, otherwise fetches from the network.
+   * Returns cached data 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");
+      this.#logger?.debug(
+        "axios cache: TTL still valid, returning cached data"
+      );
       return this.#cache.data;
     }
     if (this.#pending) {
-      this.#logger?.debug("apy cache: request in flight, waiting");
+      this.#logger?.debug("axios cache: request in flight, waiting");
       return this.#pending;
     }
     this.#pending = this.#doFetch();
@@ -58,29 +65,33 @@ class ApyOutputCache {
       });
       if (response.status === 304 && this.#cache) {
         this.#cache.fetchedAt = Date.now();
-        this.#logger?.debug("apy cache: 304 Not Modified, extended TTL");
+        this.#logger?.debug("axios cache: 304 Not Modified, extended TTL");
         return this.#cache.data;
       }
-      const etag = response.headers["etag"];
+      const etag = response.headers.etag;
       this.#cache = {
         data: response.data,
         etag,
         fetchedAt: Date.now()
       };
+      const meta = this.#getLogMeta?.(response.data);
       this.#logger?.debug(
-        `apy cache: fetched fresh data (timestamp: ${response.data.timestamp})`
+        `axios cache: fetched fresh data${meta ? ` (${meta})` : ""}`
       );
       return response.data;
     } catch (e) {
-      this.#logger?.error(e, "apy cache: fetch failed");
-      return this.#cache?.data;
+      this.#logger?.error(e, "axios cache: fetch failed");
+      if (this.#cache) {
+        return this.#cache.data;
+      }
+      throw e;
     }
   }
   /** Evicts all cached entries. Mainly useful for tests. */
   static clearAll() {
-    ApyOutputCache.#instances.clear();
+    AxiosCache.#instances.clear();
   }
 }
 export {
-  ApyOutputCache
+  AxiosCache
 };

package/dist/esm/common-utils/axios-cache/index.js

@@ -0,0 +1 @@
+export * from "./AxiosCache.js";

package/dist/esm/common-utils/index.js

@@ -1,3 +1,4 @@
+export * from "./axios-cache/index.js";
 export * from "./charts/index.js";
 export * from "./static/index.js";
 export * from "./utils/index.js";

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

@@ -1,4 +1,5 @@
 import { marketCompressorAbi } from "../../abi/compressors/marketCompressor.js";
+import { AxiosCache } from "../../common-utils/axios-cache/index.js";
 import {
   getAvailableAndDisabledStrategies,
   getReleasedStrategiesListCore,
@@ -16,7 +17,6 @@ import {
 } from "../../sdk/index.js";
 import { rayToNumber } from "../../sdk/utils/formatter.js";
 import { hexEq } from "../../sdk/utils/hex.js";
-import { ApyOutputCache } from "./apy-cache.js";
 import { parseGearStats, parseNetworkApy } from "./apy-parser.js";
 import { APY_STATE_CACHE_URL, DEFAULT_APY_INTERVAL_MS } from "./constants.js";
 import {
@@ -272,13 +272,13 @@ class ApyPlugin extends BasePlugin {
   // ---------------------------------------------------------------------------
   async #fetchApy() {
     try {
-      const cache = ApyOutputCache.get(
+      const cache = AxiosCache.get(
         this.#apyUrl,
         this.#cacheTtlMs,
-        this.#logger
+        this.#logger,
+        (data) => `timestamp: ${data.timestamp}`
       );
       const output = await cache.fetch();
-      if (!output) return void 0;
       const chainData = output.chains[this.sdk.chainId];
       if (!chainData) {
         this.#logger?.debug(

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

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

package/dist/esm/plugins/delayed-withdrawal/DelayedWithdrawalPlugin.js

@@ -1,4 +1,5 @@
 import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
+import { iWithdrawalCompressorV311Abi } from "../../abi/IWithdrawalCompressorV311.js";
 import {
   AddressMap,
   BasePlugin,
@@ -19,8 +20,8 @@ class DelayedWithdrawalPlugin extends BasePlugin {
     const resp = await this.client.multicall({
       contracts: compressor ? creditManagers.map(
         (cm) => ({
-          abi: iWithdrawalCompressorV310Abi,
-          address: compressor,
+          address: compressor.address,
+          abi: compressor.version === 310 ? iWithdrawalCompressorV310Abi : iWithdrawalCompressorV311Abi,
           functionName: "getWithdrawableAssets",
           args: [cm.creditManager.address]
         })

package/dist/esm/plugins/remote-configs/CustomConfigSource.js

@@ -0,0 +1,17 @@
+class CustomConfigSource {
+  #getPools;
+  #getStrategies;
+  constructor(options) {
+    this.#getPools = options.getPools;
+    this.#getStrategies = options.getStrategies;
+  }
+  async getPools() {
+    return this.#getPools();
+  }
+  async getStrategies() {
+    return this.#getStrategies();
+  }
+}
+export {
+  CustomConfigSource
+};

package/dist/esm/plugins/remote-configs/RemoteConfigSource.js

@@ -0,0 +1,32 @@
+import { AxiosCache } from "../../common-utils/axios-cache/index.js";
+const DEFAULT_POOLS_URL = "https://static.gearbox.finance/client-v3/configs/pools/pools.json";
+const DEFAULT_STRATEGIES_URL = "https://static.gearbox.finance/client-v3/configs/strategies/strategies.json";
+const DEFAULT_CACHE_TTL_MS = 30 * 60 * 1e3;
+class RemoteConfigSource {
+  #poolsCache;
+  #strategiesCache;
+  constructor(options) {
+    const poolsUrl = options?.poolsUrl ?? DEFAULT_POOLS_URL;
+    const strategiesUrl = options?.strategiesUrl ?? DEFAULT_STRATEGIES_URL;
+    const ttlMs = options?.cacheTtlMs ?? DEFAULT_CACHE_TTL_MS;
+    this.#poolsCache = AxiosCache.get(
+      poolsUrl,
+      ttlMs,
+      options?.logger
+    );
+    this.#strategiesCache = AxiosCache.get(
+      strategiesUrl,
+      ttlMs,
+      options?.logger
+    );
+  }
+  async getPools() {
+    return this.#poolsCache.fetch();
+  }
+  async getStrategies() {
+    return this.#strategiesCache.fetch();
+  }
+}
+export {
+  RemoteConfigSource
+};

package/dist/esm/plugins/remote-configs/RemoteConfigsPlugin.js

@@ -0,0 +1,165 @@
+import { isAddress } from "viem";
+import {
+  BasePlugin,
+  TypedObjectUtils
+} from "../../sdk/index.js";
+import { RemoteConfigSource } from "./RemoteConfigSource.js";
+class RemoteConfigsPlugin extends BasePlugin {
+  #sources;
+  #pools;
+  #strategies;
+  constructor(loadOnAttach = false, options) {
+    super(loadOnAttach);
+    this.#sources = options?.sources ?? [new RemoteConfigSource()];
+  }
+  get loaded() {
+    return !!this.#pools && !!this.#strategies;
+  }
+  async load(force) {
+    if (!force && this.loaded) {
+      return this.state;
+    }
+    const [pools, strategies] = await Promise.all([
+      this.#loadPools(),
+      this.#loadStrategies()
+    ]);
+    this.#pools = pools;
+    this.#strategies = strategies;
+    return this.state;
+  }
+  async syncState() {
+    await this.load(false);
+  }
+  get state() {
+    return {
+      pools: this.pools,
+      strategies: this.strategies
+    };
+  }
+  hydrate(state) {
+    this.#pools = state.pools;
+    this.#strategies = state.strategies;
+  }
+  stateHuman(_) {
+    return this.state;
+  }
+  // ---------------------------------------------------------------------------
+  // Accessors
+  // ---------------------------------------------------------------------------
+  /**
+   * Pool configs for the current SDK network.
+   * @throws if plugin is not loaded
+   */
+  get pools() {
+    if (!this.#pools) {
+      throw new Error("remote-configs plugin not loaded");
+    }
+    return this.#pools;
+  }
+  /**
+   * Strategy configs for the current SDK network.
+   * @throws if plugin is not loaded
+   */
+  get strategies() {
+    if (!this.#strategies) {
+      throw new Error("remote-configs plugin not loaded");
+    }
+    return this.#strategies;
+  }
+  // ---------------------------------------------------------------------------
+  // Internal
+  // ---------------------------------------------------------------------------
+  async #loadPools() {
+    for (const source of this.#sources) {
+      try {
+        const data = await source.getPools();
+        const mapped = this.#mapPoolPayload(
+          data.filter(
+            (p) => p.chainId === this.sdk.chainId && p.network.toLowerCase() === this.sdk.networkType.toLowerCase()
+          )
+        );
+        return mapped;
+      } catch (e) {
+        this.logger?.warn(e, `${source.constructor.name} failed to load pools`);
+      }
+    }
+    throw new Error("all config sources failed to load pools");
+  }
+  async #loadStrategies() {
+    for (const source of this.#sources) {
+      try {
+        const data = await source.getStrategies();
+        const mapped = this.#mapStrategyPayload(
+          data.filter(
+            (s) => s.chainId === this.sdk.chainId && s.network.toLowerCase() === this.sdk.networkType.toLowerCase()
+          )
+        );
+        return mapped;
+      } catch (e) {
+        this.logger?.warn(
+          e,
+          `${source.constructor.name} failed to load strategies`
+        );
+      }
+    }
+    throw new Error("all config sources failed to load strategies");
+  }
+  #mapPoolPayload(payload) {
+    return payload.reduce((acc, p) => {
+      const addressLc = p.address.toLowerCase();
+      if (isAddress(addressLc)) {
+        acc.push({
+          ...p,
+          address: addressLc
+        });
+      }
+      return acc;
+    }, []);
+  }
+  #mapStrategyPayload(payload) {
+    return payload.reduce((acc, p) => {
+      const tokenOutAddressLc = p.tokenOutAddress.toLowerCase();
+      const creditManagers = p.creditManagers.filter((cm) => isAddress(cm)).map((cm) => cm.toLowerCase());
+      const zeroSlippage = p.zeroSlippage ? TypedObjectUtils.entries(p.zeroSlippage).reduce((zsAcc, [address, value]) => {
+        const addressLc = address.toLowerCase();
+        if (isAddress(addressLc)) zsAcc[addressLc] = value;
+        return zsAcc;
+      }, {}) : void 0;
+      const additionalRewardQuotas = p.additionalRewardQuotas ? TypedObjectUtils.entries(p.additionalRewardQuotas).reduce((rqAcc, [address, value]) => {
+        const addressLc = address.toLowerCase();
+        if (isAddress(addressLc)) {
+          const rewards = value?.filter((r) => isAddress(r)).map((r) => r.toLowerCase());
+          rqAcc[addressLc] = rewards;
+        }
+        return rqAcc;
+      }, {}) : void 0;
+      const additionalCollaterals = p.additionalCollaterals?.reduce((colAcc, cfg) => {
+        const token = typeof cfg === "string" ? cfg : cfg.token;
+        const tokenLc = token.toLowerCase();
+        const valid = isAddress(tokenLc);
+        if (valid && !colAcc[tokenLc]) colAcc[tokenLc] = [];
+        const nextCfg = typeof cfg === "string" ? tokenLc : {
+          token: tokenLc,
+          cm: cfg.cm.toLowerCase()
+        };
+        if (valid) colAcc[tokenLc].push(nextCfg);
+        return colAcc;
+      }, {});
+      if (isAddress(tokenOutAddressLc)) {
+        const { additionalCollaterals: _, ...rest } = p;
+        acc.push({
+          ...rest,
+          tokenOutAddress: tokenOutAddressLc,
+          creditManagers,
+          ...zeroSlippage ? { zeroSlippage } : {},
+          ...additionalRewardQuotas ? { additionalRewardQuotas } : {},
+          ...additionalCollaterals ? { additionalCollaterals } : {}
+        });
+      }
+      return acc;
+    }, []);
+  }
+}
+export {
+  RemoteConfigsPlugin
+};

package/dist/esm/plugins/remote-configs/index.js

@@ -0,0 +1,4 @@
+export * from "./CustomConfigSource.js";
+export * from "./RemoteConfigSource.js";
+export * from "./RemoteConfigsPlugin.js";
+export * from "./types.js";

package/dist/esm/plugins/remote-configs/package.json

@@ -0,0 +1 @@
+{"type": "module","sideEffects":false}

package/dist/esm/sdk/OnchainSDK.js

@@ -149,12 +149,12 @@ class OnchainSDK extends ChainContractsRegister {
     );
     this.#currentBlock = block.number;
     this.#timestamp = block.timestamp;
-    if (!!blockNumber && !redstone?.historicTimestamp && time - Number(block.timestamp) * 1e3 > 60 * 1e3) {
+    if (blockNumber && !redstone?.historicTimestamp && time - Number(block.timestamp) * 1e3 > 60 * 1e3) {
       this.logger?.warn(
         "attaching to fixed block number, but redstone historicTimestamp is not set. price updates might fail"
       );
     }
-    if (!!blockNumber && !pyth?.historicTimestamp && time - Number(block.timestamp) * 1e3 > 60 * 1e3) {
+    if (blockNumber && !pyth?.historicTimestamp && time - Number(block.timestamp) * 1e3 > 60 * 1e3) {
       this.logger?.warn(
         "attaching to fixed block number, but pyth historicTimestamp is not set. price updates might fail"
       );

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -8,6 +8,7 @@ import { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountC
 import { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
 import { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
 import { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
+import { iWithdrawalCompressorV311Abi } from "../../abi/IWithdrawalCompressorV311.js";
 import { iBaseRewardPoolAbi } from "../../abi/iBaseRewardPool.js";
 import { iRWAFactoryAbi } from "../../abi/rwa/iRWAFactory.js";
 import { SDKConstruct } from "../base/index.js";
@@ -35,8 +36,14 @@ import {
   mergePriceUpdates
 } from "./multicall-utils.js";
 const COMPRESSORS = {
-  [chains.Mainnet.id]: "0x36F3d0Bb73CBC2E94fE24dF0f26a689409cF9023",
-  [chains.Monad.id]: "0x36F3d0Bb73CBC2E94fE24dF0f26a689409cF9023"
+  [chains.Mainnet.id]: {
+    address: "0x36F3d0Bb73CBC2E94fE24dF0f26a689409cF9023",
+    version: 310
+  },
+  [chains.Monad.id]: {
+    address: "0x36F3d0Bb73CBC2E94fE24dF0f26a689409cF9023",
+    version: 310
+  }
 };
 function getWithdrawalCompressorAddress(chainId) {
   return COMPRESSORS[chainId];
@@ -773,8 +780,8 @@ class CreditAccountsServiceV310 extends SDKConstruct {
         `No compressor for current chain ${this.sdk.networkType}`
       );
     const contract = getContract({
-      address: compressor,
-      abi: iWithdrawalCompressorV310Abi,
+      address: compressor.address,
+      abi: compressor.version === 310 ? iWithdrawalCompressorV310Abi : iWithdrawalCompressorV311Abi,
       client: this.client
     });
     const resp = await contract.read.getWithdrawalRequestResult([
@@ -796,8 +803,8 @@ class CreditAccountsServiceV310 extends SDKConstruct {
         `No compressor for current chain ${this.sdk.networkType}`
       );
     const contract = getContract({
-      address: compressor,
-      abi: iWithdrawalCompressorV310Abi,
+      address: compressor.address,
+      abi: compressor.version === 310 ? iWithdrawalCompressorV310Abi : iWithdrawalCompressorV311Abi,
       client: this.client
     });
     const resp = await contract.read.getCurrentWithdrawals([creditAccount]);

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

@@ -114,7 +114,7 @@ async function simulateWithPriceUpdates(client, parameters) {
       const r = multicallResults[1];
       if (r.status === "success") {
         const fromMc = BigInt(r.result);
-        if (!!r.result && fromMc !== parameters.blockNumber) {
+        if (r.result && fromMc !== parameters.blockNumber) {
           throw getSimulateWithPriceUpdatesError(
             new BaseError(
               `block number returned from multicall (${fromMc}) is different from the one provided (${parameters.blockNumber})`