@gearbox-protocol/sdk 13.4.0-beta.1 → 13.4.0-beta.3

package/dist/cjs/permissionless/utils/price-update/get-price-update-tx.js

@@ -18,24 +18,13 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var get_price_update_tx_exports = {};
 __export(get_price_update_tx_exports, {
-  getPriceUpdateTx: () => getPriceUpdateTx,
-  getUpdateCalldata: () => getUpdateCalldata
+  getPriceUpdateTx: () => getPriceUpdateTx
 });
 module.exports = __toCommonJS(get_price_update_tx_exports);
 var import_viem = require("viem");
 var import_sdk = require("../../../sdk/index.js");
 var import_bindings = require("../../bindings/index.js");
 var import_addresses = require("../../deployment/addresses.js");
-function getUpdateCalldata(tx) {
-  const data = (0, import_viem.decodeFunctionData)({
-    abi: (0, import_viem.parseAbi)(["function updatePrice(bytes calldata data) external"]),
-    data: tx.raw.callData
-  });
-  return {
-    priceFeed: tx.raw.to,
-    data: data.args[0]
-  };
-}
 async function getPriceUpdateTx({
   client,
   priceFeeds,
@@ -72,7 +61,7 @@ async function getPriceUpdateTx({
     });
     return multicallTx;
   }
-  const priceUpdates = updateTxs.txs.map((tx) => getUpdateCalldata(tx));
+  const priceUpdates = (0, import_sdk.getRawPriceUpdates)(updateTxs);
   if (priceUpdates.length === 0) {
     return void 0;
   }
@@ -80,6 +69,5 @@ async function getPriceUpdateTx({
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  getPriceUpdateTx,
-  getUpdateCalldata
+  getPriceUpdateTx
 });

package/dist/cjs/sdk/GearboxSDK.js

@@ -76,24 +76,50 @@ async function attachClient(options, network) {
 }
 class GearboxSDK extends import_base.ChainContractsRegister {
   #hooks = new import_internal.Hooks();
+  /**
+   * Registered plugin instances, keyed by plugin name.
+   **/
   plugins;
-  // Block which was use for data query
   #currentBlock;
   #timestamp;
   #syncing = false;
-  // Collection of core singleton contracts
   #addressProvider;
   #attachConfig;
-  // Collection of markets
   #marketRegister;
   #priceFeeds;
+  /**
+   * Gas limit applied to read-only `eth_call` requests.
+   * `undefined` means that gas limit will not be set on read-only calls,
+   * leaving it to rpc provider to decide.
+   **/
   gasLimit;
   /**
-   * Will throw an error if contract type is not supported, otherwise will try to use generic contract first, if possible
-   */
+   * When `true`, the SDK throws on unrecognised contract types instead of
+   * falling back to a generic contract wrapper.
+   **/
   strictContractTypes;
+  /**
+   * Registers a callback for an SDK lifecycle event.
+   *
+   * @see {@link SDKHooks} for available event names.
+   **/
   addHook = this.#hooks.addHook.bind(this.#hooks);
+  /**
+   * Removes a previously registered lifecycle callback.
+   *
+   * @see {@link SDKHooks} for available event names.
+   **/
   removeHook = this.#hooks.removeHook.bind(this.#hooks);
+  /**
+   * Creates and initialises a new SDK instance by reading live on-chain state.
+   *
+   * This is the primary way to bootstrap the SDK.  The method connects to the
+   * chain, discovers the address provider and all configured markets, and
+   * attaches any supplied plugins.
+   *
+   * @param options - Combined SDK, client, and (optional) network options.
+   * @returns A fully initialised SDK instance.
+   **/
   static async attach(options) {
     const {
       logger,
@@ -129,6 +155,19 @@ class GearboxSDK extends import_base.ChainContractsRegister {
       pyth
     });
   }
+  /**
+   * Creates a new SDK instance from a previously serialised {@link GearboxState}
+   * snapshot, without making any on-chain calls.
+   *
+   * Use this for fast startup when a recent state snapshot is available
+   * (e.g. loaded from a file or received from a backend service).
+   *
+   * @param options - SDK and client options (block number and address provider
+   *   are taken from the snapshot).
+   * @param state - Serialised state obtained from {@link GearboxSDK.state}.
+   * @returns A fully initialised SDK instance.
+   * @throws If the snapshot's {@link STATE_VERSION} does not match.
+   **/
   static hydrate(options, state) {
     const { logger, plugins, strictContractTypes, gasLimit, ...rest } = options;
     const client = createClient(options, {
@@ -281,9 +320,15 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     return this;
   }
   /**
-   * Reattach SDK with the same config as before, without re-creating instance. Will load all state from scratch
-   * Be mindful of block number, for example
-   */
+   * Re-attaches the SDK using the same configuration, discarding all cached
+   * state and re-reading everything from the chain.
+   *
+   * Useful when the SDK needs a full refresh (e.g. after a protocol upgrade).
+   * Note that if the original `blockNumber` was pinned, the same block is
+   * re-used — call {@link syncState} instead if you want to advance.
+   *
+   * @throws If the SDK has not been attached yet.
+   **/
   async reattach() {
     if (!this.#attachConfig) {
       throw new Error("cannot reattach, attach config is not set");
@@ -291,8 +336,15 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     await this.#attach(this.#attachConfig);
   }
   /**
-   * Rehydrate existing SDK from new state without re-creating instance
-   */
+   * Replaces the SDK's in-memory state with a new serialised snapshot
+   * without re-creating the instance.
+   *
+   * After hydration the `rehydrate` hook is triggered so that listeners
+   * can react to the state change.
+   *
+   * @param state - Serialised state obtained from {@link GearboxSDK.state}.
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   async rehydrate(state) {
     if (!this.#attachConfig) {
       throw new Error("cannot rehydrate, attach config is not set");
@@ -308,9 +360,20 @@ class GearboxSDK extends import_base.ChainContractsRegister {
       timestamp: state.timestamp
     });
   }
+  /**
+   * Gearbox network type the SDK is connected to (e.g. `"Mainnet"`, `"Arbitrum"`).
+   **/
   get networkType() {
     return this.client.chain.network;
   }
+  /**
+   * Returns a human-readable snapshot of the entire SDK state, suitable
+   * for logging or diagnostic inspection.
+   *
+   * @param raw - When `true`, include raw numeric values alongside
+   *   formatted ones.
+   * @default true
+   **/
   stateHuman(raw = true) {
     return {
       block: Number(this.currentBlock),
@@ -328,6 +391,13 @@ class GearboxSDK extends import_base.ChainContractsRegister {
       ...this.marketRegister.stateHuman(raw)
     };
   }
+  /**
+   * Serialisable snapshot of the current SDK state.
+   *
+   * The returned object can be persisted (e.g. written to a file) and later
+   * passed to {@link GearboxSDK.hydrate} for instant restoration without
+   * on-chain reads.
+   **/
   get state() {
     return {
       version: STATE_VERSION,
@@ -346,10 +416,20 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     };
   }
   /**
-   * Reloads markets states based on events from last processed block to new block (defaults to latest block)
-   * @param opts
-   * @returns true if successful, false if was skipped or failed
-   */
+   * Incrementally updates the SDK state by replaying on-chain events from the
+   * last processed block up to the target block (defaults to `latest`).
+   *
+   * Use the to periodically update sdk state on cron, or subscribe to new blocks
+   * using viem's `watchBlocks`
+   *
+   * On failure the SDK reverts to the previous block/timestamp so that
+   * subsequent calls can retry.
+   *
+   * @param opts - Target block and sync behaviour. When omitted the latest
+   *   block is fetched automatically.
+   * @returns `true` if the sync completed successfully, `false` if it was
+   *   skipped or failed.
+   **/
   async syncState(opts) {
     let {
       blockNumber,
@@ -451,12 +531,22 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     }
     return success;
   }
+  /**
+   * Block number that the SDK state corresponds to.
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   get currentBlock() {
     if (this.#currentBlock === void 0) {
       throw ERR_NOT_ATTACHED;
     }
     return this.#currentBlock;
   }
+  /**
+   * Block timestamp (Unix epoch seconds) corresponding to {@link currentBlock}.
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   get timestamp() {
     if (this.#timestamp === void 0) {
       throw ERR_NOT_ATTACHED;
@@ -464,14 +554,23 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     return this.#timestamp;
   }
   /**
-   * All price feeds known to sdk, without oracle-related data (stalenessPeriod, main/reserve, etc.)
-   */
+   * Global registry of all price feeds known to the SDK (on all markets).
+   *
+   * Unlike per-oracle price feed references, this register does not carry
+   * oracle-specific metadata (staleness period, main/reserve designation, etc.).
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   get priceFeeds() {
     if (this.#priceFeeds === void 0) {
       throw ERR_NOT_ATTACHED;
     }
     return this.#priceFeeds;
   }
+  /**
+   * Address of the GEAR governance token on this chain, or `undefined`
+   * if the address provider does not list it.
+   **/
   get gear() {
     try {
       const g = this.addressProvider.getAddress(import_constants.AP_GEAR_TOKEN, import_constants.NO_VERSION);
@@ -481,12 +580,23 @@ class GearboxSDK extends import_base.ChainContractsRegister {
       return void 0;
     }
   }
+  /**
+   * The chain's address provider contract, the central directory for all
+   * protocol-wide Gearbox protocol addresses.
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   get addressProvider() {
     if (this.#addressProvider === void 0) {
       throw ERR_NOT_ATTACHED;
     }
     return this.#addressProvider;
   }
+  /**
+   * Registry of all loaded markets (pools, credit managers, oracles, etc.).
+   *
+   * @throws If the SDK has not been attached or hydrated yet.
+   **/
   get marketRegister() {
     if (this.#marketRegister === void 0) {
       throw ERR_NOT_ATTACHED;
@@ -494,10 +604,15 @@ class GearboxSDK extends import_base.ChainContractsRegister {
     return this.#marketRegister;
   }
   /**
-   * Returns router contract that will work for given credit manager or credit facade, or simply version range
-   * @param params
-   * @returns
-   */
+   * Resolves the appropriate router contract for a given credit manager,
+   * credit facade, or explicit version range.
+   *
+   * @param params - Identifies the context: a credit manager address/state,
+   *   a credit facade address/state, or a {@link VersionRange}.
+   * @returns The matching router contract instance.
+   * @throws If the credit facade version is unsupported or no router is
+   *   registered for the resolved version range.
+   **/
   routerFor(params) {
     let routerRange;
     if (Array.isArray(params)) {