@gearbox-protocol/sdk 13.7.0-kyc.3 → 14.0.0-next.10

package/dist/esm/sdk/GearboxSDK.js

@@ -1,689 +0,0 @@
-import {
-  createPublicClient,
-  defineChain,
-  fallback,
-  http,
-  parseEventLogs
-} from "viem";
-import { ChainContractsRegister } from "./base/index.js";
-import { detectNetwork, getChain } from "./chain/index.js";
-import {
-  ADDRESS_PROVIDER_V310,
-  AP_GEAR_TOKEN,
-  AP_ROUTER,
-  isV310,
-  NO_VERSION,
-  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 {
-  PluginStateVersionError
-} from "./plugins/index.js";
-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";
-const ERR_NOT_ATTACHED = new Error("Gearbox SDK not attached");
-const STATE_VERSION = 1;
-function createClient(opts, network) {
-  let transport;
-  if ("client" in opts) {
-    return opts.client;
-  }
-  if ("transport" in opts) {
-    transport = opts.transport;
-  } else {
-    const rpcs = opts.rpcURLs.map(
-      (url) => http(url, {
-        ...opts.httpTransportOptions,
-        timeout: opts.timeout,
-        retryCount: opts.retryCount
-      })
-    );
-    transport = rpcs.length > 1 ? fallback(rpcs) : rpcs[0];
-  }
-  const chain = network ? defineChain({
-    ...getChain(network.networkType),
-    id: network.chainId
-  }) : void 0;
-  return createPublicClient({ transport, chain });
-}
-async function attachClient(options, network) {
-  let { chainId, networkType } = network;
-  const attachClient2 = createClient(options);
-  if (networkType) {
-    if (!chainId) {
-      chainId = getChain(networkType).id;
-    }
-  } else {
-    networkType = await detectNetwork(attachClient2);
-    if (!chainId) {
-      chainId = await attachClient2.getChainId();
-    }
-  }
-  return createClient(options, { networkType, chainId });
-}
-class GearboxSDK extends ChainContractsRegister {
-  #hooks = new Hooks();
-  /**
-   * Registered plugin instances, keyed by plugin name.
-   **/
-  plugins;
-  #currentBlock;
-  #timestamp;
-  #syncing = false;
-  #addressProvider;
-  #attachConfig;
-  #marketRegister;
-  #kyc;
-  #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;
-  /**
-   * 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,
-      plugins,
-      blockNumber,
-      redstone,
-      pyth,
-      ignoreUpdateablePrices,
-      ignoreMarkets,
-      marketConfigurators: mcs,
-      kycFactories: kfs,
-      strictContractTypes,
-      gasLimit
-    } = options;
-    let { addressProvider } = options;
-    const client = await attachClient(options, options);
-    if (!addressProvider) {
-      addressProvider = ADDRESS_PROVIDER_V310;
-    }
-    const marketConfigurators = mcs ?? TypedObjectUtils.keys(client.chain.defaultMarketConfigurators);
-    const kycFactories = kfs ?? client.chain.kycFactories;
-    return new GearboxSDK({
-      client,
-      logger,
-      plugins,
-      strictContractTypes,
-      gasLimit
-    }).#attach({
-      addressProvider,
-      blockNumber,
-      ignoreUpdateablePrices,
-      ignoreMarkets,
-      marketConfigurators,
-      kycFactories,
-      redstone,
-      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, {
-      networkType: state.network,
-      chainId: state.chainId
-    });
-    return new GearboxSDK({
-      client,
-      plugins,
-      logger,
-      strictContractTypes,
-      gasLimit
-    }).#hydrate(rest, state);
-  }
-  constructor(options) {
-    super(options.client, options.logger);
-    this.strictContractTypes = options.strictContractTypes ?? false;
-    this.plugins = options.plugins ?? {};
-    for (const plugin of Object.values(this.plugins)) {
-      plugin.sdk = this;
-    }
-    if (options.gasLimit !== null) {
-      this.gasLimit = options.gasLimit || getChain(this.networkType).gasLimit;
-    }
-  }
-  async #attach(opts) {
-    const {
-      addressProvider,
-      blockNumber,
-      ignoreUpdateablePrices,
-      ignoreMarkets,
-      marketConfigurators,
-      kycFactories,
-      redstone,
-      pyth
-    } = opts;
-    const re = this.#attachConfig ? "re" : "";
-    this.logger?.info(
-      {
-        networkType: this.networkType,
-        chainId: this.chainId,
-        addressProvider,
-        marketConfigurators,
-        kycFactories,
-        blockNumber,
-        ignoreMarkets
-      },
-      `${re}attaching gearbox sdk`
-    );
-    if (!!blockNumber && !opts.redstone?.historicTimestamp) {
-      this.logger?.warn(
-        `${re}attaching to fixed block number, but redstone historicTimestamp is not set. price updates might fail`
-      );
-    }
-    if (!!blockNumber && !opts.pyth?.historicTimestamp) {
-      this.logger?.warn(
-        `${re}attaching to fixed block number, but pyth historicTimestamp is not set. price updates might fail`
-      );
-    }
-    this.#attachConfig = opts;
-    const time = Date.now();
-    const block = await this.client.getBlock(
-      blockNumber ? { blockNumber: BigInt(blockNumber) } : {
-        blockTag: "latest"
-      }
-    );
-    this.#currentBlock = block.number;
-    this.#timestamp = block.timestamp;
-    this.#priceFeeds = new PriceFeedRegister(this, { redstone, pyth });
-    this.logger?.debug(
-      `${re}attach block number ${this.currentBlock} timestamp ${this.timestamp}`
-    );
-    this.#addressProvider = await createAddressProvider(this, addressProvider);
-    this.logger?.debug(
-      `address provider version: ${this.#addressProvider.version}`
-    );
-    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
-      });
-    }
-    const pluginsList = TypedObjectUtils.entries(this.plugins);
-    const pluginResponse = await Promise.allSettled(
-      pluginsList.map(([name, plugin]) => {
-        if (plugin.attach) {
-          this.logger?.debug(`${re}attaching plugin ${name}`);
-          return plugin.attach();
-        }
-        return void 0;
-      })
-    );
-    pluginResponse.forEach((r, i) => {
-      const [name, plugin] = pluginsList[i];
-      if (plugin.attach && r.status === "fulfilled") {
-        this.logger?.debug(`${re}attached plugin ${name}`);
-      } else if (plugin.attach && r.status === "rejected") {
-        this.logger?.error(r.reason, `failed to ${re}attach plugin ${name}`);
-      }
-    });
-    this.logger?.info(`${re}attach time: ${Date.now() - time} ms`);
-    return this;
-  }
-  #hydrate(options, state) {
-    const { logger: _logger, ignoreMarkets, ...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.networkType },
-      `${re}hydrating sdk state`
-    );
-    this.#currentBlock = state.currentBlock;
-    this.#timestamp = state.timestamp;
-    this.#priceFeeds = new PriceFeedRegister(this, {
-      redstone: opts.redstone,
-      pyth: opts.pyth
-    });
-    this.#addressProvider = hydrateAddressProvider(this, state.addressProvider);
-    this.logger?.debug(
-      `address provider version: ${this.#addressProvider.version}`
-    );
-    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)) {
-      const pluginState = state.plugins[name];
-      if (plugin.hydrate && pluginState) {
-        if (!pluginState.loaded) {
-          this.logger?.debug(
-            `skipping ${re}hydrating plugin ${name} state: not loaded`
-          );
-          continue;
-        }
-        if (pluginState.version !== plugin.version) {
-          throw new PluginStateVersionError(plugin, pluginState);
-        }
-        plugin.hydrate(pluginState);
-      }
-    }
-    this.logger?.info(`${re}hydrated sdk state`);
-    return this;
-  }
-  /**
-   * 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");
-    }
-    await this.#attach(this.#attachConfig);
-  }
-  /**
-   * 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");
-    }
-    const opts = {
-      ignoreUpdateablePrices: this.#attachConfig.ignoreUpdateablePrices,
-      redstone: this.#attachConfig.redstone,
-      pyth: this.#attachConfig.pyth
-    };
-    this.#hydrate(opts, state);
-    await this.#hooks.triggerHooks("rehydrate", {
-      blockNumber: state.currentBlock,
-      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),
-      timestamp: formatTimestamp(Number(this.timestamp), raw),
-      core: {
-        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,
-          plugin.loaded ? plugin.stateHuman?.(raw) : void 0
-        ])
-      ),
-      ...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,
-      network: this.networkType,
-      chainId: this.chainId,
-      currentBlock: this.currentBlock,
-      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,
-          plugin.loaded ? { version: plugin.version, loaded: true, ...plugin.state } : { version: plugin.version, loaded: false }
-        ])
-      )
-    };
-  }
-  /**
-   * 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,
-      timestamp,
-      ignoreUpdateablePrices = this.#attachConfig?.ignoreUpdateablePrices
-    } = opts ?? {};
-    if (this.#attachConfig?.redstone?.historicTimestamp || this.#attachConfig?.pyth?.historicTimestamp) {
-      throw new Error(
-        "syncState is not supported with redstone or pyth historicTimestamp"
-      );
-    }
-    if (!blockNumber || !timestamp) {
-      const block = await this.client.getBlock({
-        blockTag: "latest"
-      });
-      blockNumber = block.number;
-      timestamp = block.timestamp;
-    }
-    if (blockNumber <= this.currentBlock) {
-      return false;
-    }
-    if (this.#syncing) {
-      this.logger?.warn(
-        `cannot sync to ${blockNumber}, already syncing at ${this.currentBlock}`
-      );
-      return false;
-    }
-    this.#syncing = true;
-    const prevBlock = this.currentBlock;
-    const prevTimestamp = this.timestamp;
-    let success = false;
-    try {
-      let delta = Math.floor(Date.now() / 1e3) - Number(timestamp);
-      this.logger?.debug(
-        `syncing state to block ${blockNumber} (delta ${delta}s )...`
-      );
-      const watchAddresses = [
-        ...Array.from(this.marketRegister.watchAddresses),
-        this.addressProvider.address
-      ];
-      const fromBlock = this.currentBlock + 1n;
-      this.logger?.debug(
-        `getting logs from ${watchAddresses.length} addresses in [${fromBlock}:${blockNumber}]`
-      );
-      const logs = await getLogsSafe(this.client, {
-        fromBlock,
-        toBlock: blockNumber,
-        address: watchAddresses
-      });
-      for (const log of logs) {
-        const contract = this.getContract(log.address);
-        if (contract) {
-          const event = parseEventLogs({
-            abi: contract.abi,
-            logs: [log]
-          })[0];
-          contract.processLog(event);
-        }
-      }
-      this.#currentBlock = blockNumber;
-      this.#timestamp = timestamp;
-      await this.marketRegister.syncState(ignoreUpdateablePrices);
-      await this.#hooks.triggerHooks("syncState", {
-        blockNumber,
-        timestamp,
-        ignoreUpdateablePrices
-      });
-      const pluginsList = TypedObjectUtils.entries(this.plugins);
-      const pluginResponse = await Promise.allSettled(
-        pluginsList.map(([name, plugin]) => {
-          if (plugin.syncState) {
-            this.logger?.debug(`syncing plugin ${name}`);
-            return plugin.syncState();
-          }
-          return void 0;
-        })
-      );
-      pluginResponse.forEach((r, i) => {
-        const [name, plugin] = pluginsList[i];
-        if (plugin.syncState && r.status === "fulfilled") {
-          this.logger?.debug(`synced plugin ${name}`);
-        } else if (plugin.syncState && r.status === "rejected") {
-          this.logger?.error(r.reason, `failed to sync plugin ${name}`);
-        }
-      });
-      delta = Math.floor(Date.now() / 1e3) - Number(timestamp);
-      this.logger?.debug(
-        `synced state to block ${blockNumber} (delta ${delta}s)`
-      );
-      success = true;
-    } catch (e) {
-      this.logger?.error(
-        `sync state to block ${blockNumber} with ts ${timestamp} failed, reverting to old block ${prevBlock} with ts ${prevTimestamp}: ${e}`
-      );
-      this.#currentBlock = prevBlock;
-      this.#timestamp = prevTimestamp;
-    } finally {
-      this.#syncing = false;
-    }
-    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;
-    }
-    return this.#timestamp;
-  }
-  /**
-   * 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(AP_GEAR_TOKEN, NO_VERSION);
-      return g;
-    } catch (e) {
-      this.logger?.warn(e);
-      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;
-    }
-    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.
-   *
-   * @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)) {
-      routerRange = params;
-    } else {
-      let facadeAddr;
-      if ("creditFacade" in params) {
-        facadeAddr = toAddress(params.creditFacade);
-      } else {
-        const cm = this.marketRegister.findCreditManager(
-          toAddress(params.creditManager)
-        );
-        facadeAddr = cm.creditFacade.address;
-      }
-      const facadeV = this.mustGetContract(facadeAddr).version;
-      if (isV310(facadeV)) {
-        routerRange = VERSION_RANGE_310;
-      } else {
-        throw new Error(`Unsupported credit facade version ${facadeV}`);
-      }
-    }
-    const routerEntry = this.addressProvider.getLatest(AP_ROUTER, routerRange);
-    if (!routerEntry) {
-      throw new Error(`router not found in version range ${routerRange}`);
-    }
-    const [routerAddr, routerV] = routerEntry;
-    return createRouter(this, routerAddr, routerV);
-  }
-}
-export {
-  GearboxSDK,
-  STATE_VERSION
-};