@gearbox-protocol/sdk 7.7.0 → 7.9.0

package/dist/cjs/dev/CachedStateSubscriber.js

@@ -0,0 +1,78 @@
+"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 CachedStateSubscriber_exports = {};
+__export(CachedStateSubscriber_exports, {
+  CachedStateSubscriber: () => CachedStateSubscriber
+});
+module.exports = __toCommonJS(CachedStateSubscriber_exports);
+var import_sdk = require("../sdk/index.js");
+class CachedStateSubscriber {
+  #stateURL;
+  #etag;
+  #currentBlock;
+  #sdk;
+  constructor(sdk, stateURL) {
+    this.#stateURL = stateURL;
+    this.#sdk = sdk;
+  }
+  /**
+   * Subscribe to sdk state changes
+   * @param opts - Options
+   * @returns Unsubscribe function
+   */
+  subscribe(opts) {
+    const intervalMs = opts?.pollInterval ?? 10 * 60 * 1e3;
+    const interval = setInterval(async () => {
+      const newBlock = await this.#poll();
+      if (newBlock && opts?.onChange) {
+        opts.onChange(newBlock);
+      }
+    }, intervalMs);
+    return () => clearInterval(interval);
+  }
+  async #poll() {
+    try {
+      const head = await fetch(this.#stateURL, { method: "HEAD" });
+      const etag = head.headers.get("ETag");
+      if (!etag || etag === this.#etag) {
+        return;
+      }
+      const response = await fetch(this.#stateURL);
+      const txt = await response.text();
+      const state = (0, import_sdk.json_parse)(txt);
+      if (state.currentBlock === this.#currentBlock) {
+        return;
+      }
+      this.#etag = etag;
+      this.#currentBlock = state.currentBlock;
+      this.#logger?.debug(`rehydrating state at block ${state.currentBlock}`);
+      this.#sdk.rehydrate(state);
+      return state.currentBlock;
+    } catch (e) {
+      this.#logger?.error(e, "error while polling cached state");
+    }
+  }
+  get #logger() {
+    return this.#sdk.logger;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CachedStateSubscriber
+});

package/dist/cjs/dev/index.js

@@ -17,6 +17,7 @@ var dev_exports = {};
 module.exports = __toCommonJS(dev_exports);
 __reExport(dev_exports, require("./AccountOpener.js"), module.exports);
 __reExport(dev_exports, require("./AccountsCounterPlugin.js"), module.exports);
+__reExport(dev_exports, require("./CachedStateSubscriber.js"), module.exports);
 __reExport(dev_exports, require("./calcLiquidatableLTs.js"), module.exports);
 __reExport(dev_exports, require("./create2.js"), module.exports);
 __reExport(dev_exports, require("./createAnvilClient.js"), module.exports);
@@ -28,6 +29,7 @@ __reExport(dev_exports, require("./migrateFaucet.js"), module.exports);
 0 && (module.exports = {
   ...require("./AccountOpener.js"),
   ...require("./AccountsCounterPlugin.js"),
+  ...require("./CachedStateSubscriber.js"),
   ...require("./calcLiquidatableLTs.js"),
   ...require("./create2.js"),
   ...require("./createAnvilClient.js"),

package/dist/cjs/sdk/GearboxSDK.js

@@ -210,15 +210,22 @@ class GearboxSDK {
     return this;
   }
   #hydrate(options, state) {
-    const { logger: _logger, redstone, ...opts } = options;
+    const { logger: _logger, ...opts } = options;
     if (state.version !== STATE_VERSION) {
       throw new Error(
         `hydrated state version is ${state.version}, but expected ${STATE_VERSION}`
       );
     }
+    const re = this.#attachConfig ? "re" : "";
+    this.logger?.info(
+      {
+        networkType: this.provider.networkType
+      },
+      `${re}hydrating sdk state`
+    );
     this.#currentBlock = state.currentBlock;
     this.#timestamp = state.timestamp;
-    this.#priceFeeds = new import_pricefeeds.PriceFeedRegister(this, { redstone });
+    this.#priceFeeds = new import_pricefeeds.PriceFeedRegister(this, { redstone: opts.redstone });
     this.#addressProvider = (0, import_core.hydrateAddressProvider)(this, state.addressProvider);
     this.logger?.debug(
       `address provider version: ${this.#addressProvider.version}`
@@ -242,6 +249,7 @@ class GearboxSDK {
         plugin.hydrate(pluginState);
       }
     }
+    this.logger?.info(`${re}hydrated sdk state`);
     return this;
   }
   /**
@@ -254,6 +262,19 @@ class GearboxSDK {
     }
     await this.#attach(this.#attachConfig);
   }
+  /**
+   * Rehydrate existing SDK from new state without re-creating instance
+   */
+  rehydrate(state) {
+    if (!this.#attachConfig) {
+      throw new Error("cannot rehydrate, attach config is not set");
+    }
+    const opts = {
+      ignoreUpdateablePrices: this.#attachConfig.ignoreUpdateablePrices,
+      redstone: this.#attachConfig.redstone
+    };
+    this.#hydrate(opts, state);
+  }
   /**
    * Converts contract call into some human-friendly string
    * This method is safe and should not throw

package/dist/cjs/sdk/market/MarketSuite.js

@@ -59,9 +59,6 @@ class MarketSuite extends import_base.SDKConstruct {
       this.creditManagers.push(new import_credit.CreditSuite(sdk, marketData, i));
     }
     this.priceOracle = (0, import_oracle.getOrCreatePriceOracle)(sdk, marketData.priceOracle);
-    sdk.logger?.debug(
-      `oracle ${this.labelAddress(this.priceOracle.address)} has ${this.priceOracle.mainPriceFeeds.size} main and ${this.priceOracle.reservePriceFeeds.size} reserve price feeds`
-    );
   }
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);

package/dist/cjs/sdk/market/oracle/createPriceOracle.js

@@ -28,16 +28,20 @@ var import_PriceOracleV310Contract = require("./PriceOracleV310Contract.js");
 function getOrCreatePriceOracle(sdk, data) {
   const { version, addr } = data.baseParams;
   const existing = sdk.contracts.get(addr);
+  let result;
   if (existing) {
-    return tryExtendExistingOracle(existing, data);
+    result = tryExtendExistingOracle(existing, data);
+  } else if ((0, import_constants.isV300)(version)) {
+    result = new import_PriceOracleV300Contract.PriceOracleV300Contract(sdk, data);
+  } else if ((0, import_constants.isV310)(version)) {
+    result = new import_PriceOracleV310Contract.PriceOracleV310Contract(sdk, data);
+  } else {
+    throw new Error(`Unsupported oracle version ${version}`);
   }
-  if ((0, import_constants.isV300)(version)) {
-    return new import_PriceOracleV300Contract.PriceOracleV300Contract(sdk, data);
-  }
-  if ((0, import_constants.isV310)(version)) {
-    return new import_PriceOracleV310Contract.PriceOracleV310Contract(sdk, data);
-  }
-  throw new Error(`Unsupported oracle version ${version}`);
+  sdk.logger?.debug(
+    `oracle ${addr} v${version} was ${existing ? "extended" : "created"} with ${result.mainPriceFeeds.size} main and ${result.reservePriceFeeds.size} reserve price feeds`
+  );
+  return result;
 }
 function tryExtendExistingOracle(existing, data) {
   const { version, addr } = data.baseParams;

package/dist/esm/dev/CachedStateSubscriber.js

@@ -0,0 +1,54 @@
+import { json_parse } from "../sdk/index.js";
+class CachedStateSubscriber {
+  #stateURL;
+  #etag;
+  #currentBlock;
+  #sdk;
+  constructor(sdk, stateURL) {
+    this.#stateURL = stateURL;
+    this.#sdk = sdk;
+  }
+  /**
+   * Subscribe to sdk state changes
+   * @param opts - Options
+   * @returns Unsubscribe function
+   */
+  subscribe(opts) {
+    const intervalMs = opts?.pollInterval ?? 10 * 60 * 1e3;
+    const interval = setInterval(async () => {
+      const newBlock = await this.#poll();
+      if (newBlock && opts?.onChange) {
+        opts.onChange(newBlock);
+      }
+    }, intervalMs);
+    return () => clearInterval(interval);
+  }
+  async #poll() {
+    try {
+      const head = await fetch(this.#stateURL, { method: "HEAD" });
+      const etag = head.headers.get("ETag");
+      if (!etag || etag === this.#etag) {
+        return;
+      }
+      const response = await fetch(this.#stateURL);
+      const txt = await response.text();
+      const state = json_parse(txt);
+      if (state.currentBlock === this.#currentBlock) {
+        return;
+      }
+      this.#etag = etag;
+      this.#currentBlock = state.currentBlock;
+      this.#logger?.debug(`rehydrating state at block ${state.currentBlock}`);
+      this.#sdk.rehydrate(state);
+      return state.currentBlock;
+    } catch (e) {
+      this.#logger?.error(e, "error while polling cached state");
+    }
+  }
+  get #logger() {
+    return this.#sdk.logger;
+  }
+}
+export {
+  CachedStateSubscriber
+};

package/dist/esm/dev/index.js

@@ -1,5 +1,6 @@
 export * from "./AccountOpener.js";
 export * from "./AccountsCounterPlugin.js";
+export * from "./CachedStateSubscriber.js";
 export * from "./calcLiquidatableLTs.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";

package/dist/esm/sdk/GearboxSDK.js

@@ -208,15 +208,22 @@ class GearboxSDK {
     return this;
   }
   #hydrate(options, state) {
-    const { logger: _logger, redstone, ...opts } = options;
+    const { logger: _logger, ...opts } = options;
     if (state.version !== STATE_VERSION) {
       throw new Error(
         `hydrated state version is ${state.version}, but expected ${STATE_VERSION}`
       );
     }
+    const re = this.#attachConfig ? "re" : "";
+    this.logger?.info(
+      {
+        networkType: this.provider.networkType
+      },
+      `${re}hydrating sdk state`
+    );
     this.#currentBlock = state.currentBlock;
     this.#timestamp = state.timestamp;
-    this.#priceFeeds = new PriceFeedRegister(this, { redstone });
+    this.#priceFeeds = new PriceFeedRegister(this, { redstone: opts.redstone });
     this.#addressProvider = hydrateAddressProvider(this, state.addressProvider);
     this.logger?.debug(
       `address provider version: ${this.#addressProvider.version}`
@@ -240,6 +247,7 @@ class GearboxSDK {
         plugin.hydrate(pluginState);
       }
     }
+    this.logger?.info(`${re}hydrated sdk state`);
     return this;
   }
   /**
@@ -252,6 +260,19 @@ class GearboxSDK {
     }
     await this.#attach(this.#attachConfig);
   }
+  /**
+   * Rehydrate existing SDK from new state without re-creating instance
+   */
+  rehydrate(state) {
+    if (!this.#attachConfig) {
+      throw new Error("cannot rehydrate, attach config is not set");
+    }
+    const opts = {
+      ignoreUpdateablePrices: this.#attachConfig.ignoreUpdateablePrices,
+      redstone: this.#attachConfig.redstone
+    };
+    this.#hydrate(opts, state);
+  }
   /**
    * Converts contract call into some human-friendly string
    * This method is safe and should not throw

package/dist/esm/sdk/market/MarketSuite.js

@@ -36,9 +36,6 @@ class MarketSuite extends SDKConstruct {
       this.creditManagers.push(new CreditSuite(sdk, marketData, i));
     }
     this.priceOracle = getOrCreatePriceOracle(sdk, marketData.priceOracle);
-    sdk.logger?.debug(
-      `oracle ${this.labelAddress(this.priceOracle.address)} has ${this.priceOracle.mainPriceFeeds.size} main and ${this.priceOracle.reservePriceFeeds.size} reserve price feeds`
-    );
   }
   get dirty() {
     return this.configurator.dirty || this.pool.dirty || this.priceOracle.dirty || this.creditManagers.some((cm) => cm.dirty);

package/dist/esm/sdk/market/oracle/createPriceOracle.js

@@ -5,16 +5,20 @@ import { PriceOracleV310Contract } from "./PriceOracleV310Contract.js";
 function getOrCreatePriceOracle(sdk, data) {
   const { version, addr } = data.baseParams;
   const existing = sdk.contracts.get(addr);
+  let result;
   if (existing) {
-    return tryExtendExistingOracle(existing, data);
+    result = tryExtendExistingOracle(existing, data);
+  } else if (isV300(version)) {
+    result = new PriceOracleV300Contract(sdk, data);
+  } else if (isV310(version)) {
+    result = new PriceOracleV310Contract(sdk, data);
+  } else {
+    throw new Error(`Unsupported oracle version ${version}`);
   }
-  if (isV300(version)) {
-    return new PriceOracleV300Contract(sdk, data);
-  }
-  if (isV310(version)) {
-    return new PriceOracleV310Contract(sdk, data);
-  }
-  throw new Error(`Unsupported oracle version ${version}`);
+  sdk.logger?.debug(
+    `oracle ${addr} v${version} was ${existing ? "extended" : "created"} with ${result.mainPriceFeeds.size} main and ${result.reservePriceFeeds.size} reserve price feeds`
+  );
+  return result;
 }
 function tryExtendExistingOracle(existing, data) {
   const { version, addr } = data.baseParams;

package/dist/types/dev/CachedStateSubscriber.d.ts

@@ -0,0 +1,21 @@
+import type { GearboxSDK, PluginsMap } from "../sdk/index.js";
+export interface CachedStateSubscriberOptions {
+    /**
+     * Polling interval in milliseconds
+     */
+    pollInterval?: number;
+    /**
+     * Callback to be called when state changes
+     */
+    onChange?: (blockNumber: bigint) => void;
+}
+export declare class CachedStateSubscriber<const Plugins extends PluginsMap = {}> {
+    #private;
+    constructor(sdk: GearboxSDK<Plugins>, stateURL: string);
+    /**
+     * Subscribe to sdk state changes
+     * @param opts - Options
+     * @returns Unsubscribe function
+     */
+    subscribe(opts?: CachedStateSubscriberOptions): () => void;
+}

package/dist/types/dev/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./AccountOpener.js";
 export * from "./AccountsCounterPlugin.js";
+export * from "./CachedStateSubscriber.js";
 export * from "./calcLiquidatableLTs.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";

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

@@ -92,6 +92,10 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> {
      * Be mindful of block number, for example
      */
     reattach(): Promise<void>;
+    /**
+     * Rehydrate existing SDK from new state without re-creating instance
+     */
+    rehydrate(state: GearboxState<Plugins>): void;
     /**
      * Converts contract call into some human-friendly string
      * This method is safe and should not throw

package/package.json

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