@gearbox-protocol/sdk 13.5.1 → 13.6.0-apy-plugin.1

package/dist/types/sdk/GearboxSDK.d.ts

@@ -115,6 +115,13 @@ export interface SyncStateOptions {
      **/
     ignoreUpdateablePrices?: boolean;
 }
+/**
+ * Payload carried by the `pluginUpdate` hook.
+ **/
+export interface PluginUpdateInfo {
+    /** Identifier of the plugin that triggered the update (e.g. `"pools7DAgo"`). */
+    plugin: string;
+}
 /**
  * Hook event map for the SDK lifecycle.
  *
@@ -123,10 +130,13 @@ export interface SyncStateOptions {
  *
  * - `syncState` — fired after {@link GearboxSDK.syncState} completes.
  * - `rehydrate` — fired after {@link GearboxSDK.rehydrate} completes.
+ * - `pluginUpdate` — fired by a plugin when its internal state changes
+ *   outside of the normal `syncState`/`rehydrate` cycle (e.g. timer tick).
  **/
 export type SDKHooks = {
     syncState: [SyncStateOptions];
     rehydrate: [SyncStateOptions];
+    pluginUpdate: [PluginUpdateInfo];
 };
 /**
  * Main entry point for the Gearbox SDK.
@@ -175,6 +185,15 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> extends C
      * @see {@link SDKHooks} for available event names.
      **/
     removeHook: <K extends keyof SDKHooks>(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
+    /**
+     * Triggers the `pluginUpdate` hook.
+     *
+     * Intended to be called by plugins when they update their internal state
+     * outside of the normal `syncState`/`rehydrate` cycle (e.g. via an
+     * internal timer).  Frontend listeners registered with
+     * `sdk.addHook("pluginUpdate", …)` will be notified.
+     **/
+    triggerPluginUpdate(plugin: string): Promise<void>;
     /**
      * Creates and initialises a new SDK instance by reading live on-chain state.
      *

package/dist/types/sdk/base/types.d.ts

@@ -5,7 +5,6 @@ import type { gaugeCompressorAbi } from "../../abi/compressors/gaugeCompressor.j
 import type { marketCompressorAbi } from "../../abi/compressors/marketCompressor.js";
 import type { peripheryCompressorAbi } from "../../abi/compressors/peripheryCompressor.js";
 import type { rewardsCompressorAbi } from "../../abi/compressors/rewardsCompressor.js";
-import type { NetworkType } from "../chain/index.js";
 /**
  * Recursively unwraps array types to their element type.
  **/
@@ -245,14 +244,6 @@ export interface IBaseContract {
      * labeling methods for user-facing output.
      */
     readonly name: string;
-    /**
-     * Chain ID of the contract.
-     **/
-    readonly chainId: number;
-    /**
-     * Network type of the contract.
-     **/
-    readonly networkType: NetworkType;
     /**
      * @internal
      * `true` when the local state has diverged from on-chain and needs a sync.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "13.5.1",
+  "version": "13.6.0-apy-plugin.1",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",

package/dist/cjs/plugins/pools-history/Pools7DAgoPlugin.js

@@ -1,108 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var Pools7DAgoPlugin_exports = {};
-__export(Pools7DAgoPlugin_exports, {
-  Pools7DAgoPlugin: () => Pools7DAgoPlugin
-});
-module.exports = __toCommonJS(Pools7DAgoPlugin_exports);
-var import_marketCompressor = require("../../abi/compressors/marketCompressor.js");
-var import_sdk = require("../../sdk/index.js");
-const MAP_LABEL = "pools7DAgo";
-class Pools7DAgoPlugin extends import_sdk.BasePlugin {
-  #pools7DAgo;
-  async load(force) {
-    if (!force && this.loaded) {
-      return this.state;
-    }
-    const targetBlock = this.sdk.currentBlock - import_sdk.BLOCKS_PER_WEEK_BY_NETWORK[this.sdk.networkType];
-    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
-      import_sdk.AP_MARKET_COMPRESSOR,
-      import_sdk.VERSION_RANGE_310
-    );
-    this.sdk.logger?.debug(
-      `loading pools 7d ago with market compressor ${marketCompressorAddress}`
-    );
-    const markets = this.sdk.marketRegister.markets;
-    const resp = await this.client.multicall({
-      allowFailure: true,
-      contracts: markets.map(
-        (m) => ({
-          address: marketCompressorAddress,
-          abi: import_marketCompressor.marketCompressorAbi,
-          functionName: "getPoolState",
-          args: [m.pool.pool.address]
-        })
-      ),
-      blockNumber: targetBlock > 0n ? targetBlock : void 0,
-      batchSize: 0
-    });
-    this.#pools7DAgo = new import_sdk.AddressMap(void 0, MAP_LABEL);
-    resp.forEach((r, index) => {
-      const m = markets[index];
-      const cfg = m.configurator.address;
-      const pool = m.pool.pool.address;
-      if (r.status === "success") {
-        this.#pools7DAgo?.upsert(m.pool.pool.address, {
-          dieselRate: r.result.dieselRate,
-          pool
-        });
-      } else {
-        this.sdk.logger?.error(
-          `failed to load pools 7d ago for market configurator ${this.labelAddress(cfg)} and pool ${this.labelAddress(pool)}: ${r.error}`
-        );
-      }
-    });
-    return this.state;
-  }
-  get loaded() {
-    return !!this.#pools7DAgo;
-  }
-  /**
-   * Returns a map of pool addresses to minified pool 7d ago state
-   * @throws if pool 7d ago plugin is not attached
-   */
-  get pools7DAgo() {
-    if (!this.#pools7DAgo) {
-      throw new Error("pools 7d ago plugin not attached");
-    }
-    return this.#pools7DAgo;
-  }
-  stateHuman(_) {
-    return this.pools7DAgo.values().flatMap((p) => ({
-      address: p.pool,
-      version: this.version,
-      dieselRate: p.dieselRate
-    }));
-  }
-  get state() {
-    return {
-      pools7DAgo: this.pools7DAgo.asRecord()
-    };
-  }
-  hydrate(state) {
-    this.#pools7DAgo = new import_sdk.AddressMap(
-      Object.entries(state.pools7DAgo),
-      MAP_LABEL
-    );
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Pools7DAgoPlugin
-});

package/dist/esm/plugins/pools-history/Pools7DAgoPlugin.js

@@ -1,90 +0,0 @@
-import { marketCompressorAbi } from "../../abi/compressors/marketCompressor.js";
-import {
-  AddressMap,
-  AP_MARKET_COMPRESSOR,
-  BasePlugin,
-  BLOCKS_PER_WEEK_BY_NETWORK,
-  VERSION_RANGE_310
-} from "../../sdk/index.js";
-const MAP_LABEL = "pools7DAgo";
-class Pools7DAgoPlugin extends BasePlugin {
-  #pools7DAgo;
-  async load(force) {
-    if (!force && this.loaded) {
-      return this.state;
-    }
-    const targetBlock = this.sdk.currentBlock - BLOCKS_PER_WEEK_BY_NETWORK[this.sdk.networkType];
-    const [marketCompressorAddress] = this.sdk.addressProvider.mustGetLatest(
-      AP_MARKET_COMPRESSOR,
-      VERSION_RANGE_310
-    );
-    this.sdk.logger?.debug(
-      `loading pools 7d ago with market compressor ${marketCompressorAddress}`
-    );
-    const markets = this.sdk.marketRegister.markets;
-    const resp = await this.client.multicall({
-      allowFailure: true,
-      contracts: markets.map(
-        (m) => ({
-          address: marketCompressorAddress,
-          abi: marketCompressorAbi,
-          functionName: "getPoolState",
-          args: [m.pool.pool.address]
-        })
-      ),
-      blockNumber: targetBlock > 0n ? targetBlock : void 0,
-      batchSize: 0
-    });
-    this.#pools7DAgo = new AddressMap(void 0, MAP_LABEL);
-    resp.forEach((r, index) => {
-      const m = markets[index];
-      const cfg = m.configurator.address;
-      const pool = m.pool.pool.address;
-      if (r.status === "success") {
-        this.#pools7DAgo?.upsert(m.pool.pool.address, {
-          dieselRate: r.result.dieselRate,
-          pool
-        });
-      } else {
-        this.sdk.logger?.error(
-          `failed to load pools 7d ago for market configurator ${this.labelAddress(cfg)} and pool ${this.labelAddress(pool)}: ${r.error}`
-        );
-      }
-    });
-    return this.state;
-  }
-  get loaded() {
-    return !!this.#pools7DAgo;
-  }
-  /**
-   * Returns a map of pool addresses to minified pool 7d ago state
-   * @throws if pool 7d ago plugin is not attached
-   */
-  get pools7DAgo() {
-    if (!this.#pools7DAgo) {
-      throw new Error("pools 7d ago plugin not attached");
-    }
-    return this.#pools7DAgo;
-  }
-  stateHuman(_) {
-    return this.pools7DAgo.values().flatMap((p) => ({
-      address: p.pool,
-      version: this.version,
-      dieselRate: p.dieselRate
-    }));
-  }
-  get state() {
-    return {
-      pools7DAgo: this.pools7DAgo.asRecord()
-    };
-  }
-  hydrate(state) {
-    this.#pools7DAgo = new AddressMap(
-      Object.entries(state.pools7DAgo),
-      MAP_LABEL
-    );
-  }
-}
-export {
-  Pools7DAgoPlugin
-};

package/dist/types/plugins/pools-history/Pools7DAgoPlugin.d.ts

@@ -1,20 +0,0 @@
-import type { Address } from "viem";
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
-import { AddressMap, BasePlugin } from "../../sdk/index.js";
-import type { Pool7DAgoState, Pools7DAgoStateHuman } from "./types.js";
-export interface Pools7DAgoPluginState {
-    pools7DAgo: Record<Address, Pool7DAgoState>;
-}
-export declare class Pools7DAgoPlugin extends BasePlugin<Pools7DAgoPluginState> implements IGearboxSDKPlugin<Pools7DAgoPluginState> {
-    #private;
-    load(force?: boolean): Promise<Pools7DAgoPluginState>;
-    get loaded(): boolean;
-    /**
-     * Returns a map of pool addresses to minified pool 7d ago state
-     * @throws if pool 7d ago plugin is not attached
-     */
-    get pools7DAgo(): AddressMap<Pool7DAgoState>;
-    stateHuman(_?: boolean): Pools7DAgoStateHuman[];
-    get state(): Pools7DAgoPluginState;
-    hydrate(state: Pools7DAgoPluginState): void;
-}