@gearbox-protocol/sdk 13.6.0 → 14.0.0-next.2

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

@@ -1,317 +0,0 @@
-import type { Address } from "viem";
-import { type PublicClient, type Transport } from "viem";
-import type { HttpRpcClientOptions } from "viem/utils";
-import type { BaseState, IBaseContract } from "./base/index.js";
-import { ChainContractsRegister } from "./base/index.js";
-import type { GearboxChain, NetworkType } from "./chain/chains.js";
-import type { VersionRange } from "./constants/index.js";
-import type { IAddressProviderContract } from "./core/index.js";
-import { MarketRegister } from "./market/MarketRegister.js";
-import { PriceFeedRegister } from "./market/pricefeeds/index.js";
-import type { SDKOptions } from "./options.js";
-import { type PluginsMap } from "./plugins/index.js";
-import { type IRouterContract } from "./router/index.js";
-import type { GearboxState, GearboxStateHuman } from "./types/index.js";
-/**
- * Serialised state format version, checked during hydration to detect
- * incompatible snapshots.
- **/
-export declare const STATE_VERSION = 1;
-/**
- * Explicit network identity, required when working with forked testnets
- * whose chain IDs differ from the canonical mainnet/testnet values.
- **/
-export interface NetworkOptions {
-    /**
-     * EVM chain ID.
-     * Must be set explicitly for forked testnets whose chain ID differs
-     * from the canonical network.
-     **/
-    chainId: number;
-    /**
-     * Gearbox network type (e.g. `"Mainnet"`, `"Arbitrum"`).
-     * Must be set explicitly for forked testnets whose chain ID differs
-     * from the canonical network.
-     **/
-    networkType: NetworkType;
-}
-/**
- * Connection options for the underlying JSON-RPC provider.
- *
- * Supply **one** of the three variants:
- * - `rpcURLs` — the SDK creates a viem transport internally (with optional
- *    fallback when multiple URLs are given).
- * - `transport` — bring your own viem `Transport`.
- * - `client` — bring your own fully-configured viem `PublicClient`.
- *    When using this variant, the client is responsible for carrying the
- *    correct `networkType` and `chainId`.
- *
- * ### Network detection
- *
- * For the `rpcURLs` and `transport` variants, `networkType` and `chainId` are
- * resolved as follows (see {@link NetworkOptions}):
- * - If `networkType` is provided, it is used directly; `chainId` defaults to
- *   the canonical chain ID for that network when omitted.
- * - If `networkType` is **not** provided, it is detected automatically using {@link detectNetwork}.
- *   When `chainId` is also omitted it is fetched via `eth_chainId`.
- *
- **/
-export type ClientOptions = {
-    /**
-     * One or more JSON-RPC endpoint URLs.
-     * When more than one URL is provided, a viem `fallback` transport is created.
-     **/
-    rpcURLs: string[];
-    /**
-     * Per-request timeout in milliseconds.
-     **/
-    timeout?: number;
-    /**
-     * Number of automatic retries per RPC call.
-     **/
-    retryCount?: number;
-    /**
-     * Low-level options forwarded to the viem HTTP transport.
-     **/
-    httpTransportOptions?: HttpRpcClientOptions | undefined;
-} | {
-    /**
-     * Pre-built viem transport.
-     **/
-    transport: Transport;
-} | {
-    /**
-     * Pre-built viem public client.
-     * Must already carry a {@link GearboxChain} definition with `networkType`
-     * and `chainId`.
-     **/
-    client: PublicClient<Transport, GearboxChain>;
-};
-/**
- * Options accepted by {@link GearboxSDK.hydrate}.
- *
- * Same as {@link SDKOptions} but without fields that are already captured
- * inside the serialised {@link GearboxState} (`blockNumber`,
- * `addressProvider`, `marketConfigurators`).
- *
- * @typeParam Plugins - Map of plugin names to plugin instances.
- **/
-export type HydrateOptions<Plugins extends PluginsMap> = Omit<SDKOptions<Plugins>, "blockNumber" | "addressProvider" | "marketConfigurators">;
-/**
- * Options for {@link GearboxSDK.syncState}, controlling which block to
- * sync to and whether updatable price feeds should be refreshed.
- **/
-export interface SyncStateOptions {
-    /**
-     * Target block number to sync to.
-     **/
-    blockNumber: bigint;
-    /**
-     * Block timestamp corresponding to `blockNumber`.
-     **/
-    timestamp: bigint;
-    /**
-     * When `true`, skip refreshing updatable price feeds during this sync.
-     **/
-    ignoreUpdateablePrices?: boolean;
-}
-/**
- * Hook event map for the SDK lifecycle.
- *
- * Register listeners via {@link GearboxSDK.addHook} and remove them
- * with {@link GearboxSDK.removeHook}.
- *
- * - `syncState` — fired after {@link GearboxSDK.syncState} completes.
- * - `rehydrate` — fired after {@link GearboxSDK.rehydrate} completes.
- **/
-export type SDKHooks = {
-    syncState: [SyncStateOptions];
-    rehydrate: [SyncStateOptions];
-};
-/**
- * Main entry point for the Gearbox SDK.
- *
- * `GearboxSDK` aggregates on-chain state for the Gearbox protocol — markets,
- * credit managers, pools, price oracles, and price feeds — into a single
- * queryable object that can be kept up-to-date via {@link syncState} or
- * serialised/restored via {@link state}/{@link hydrate}.
- *
- * It represents on-chain state using instances of js classes that provide convenient methods
- * to read state and prepare transactions to interact with the protocol.
- *
- * Create an instance with the static {@link GearboxSDK.attach | attach}
- * (reads live chain data) or {@link GearboxSDK.hydrate | hydrate}
- * (restores from a saved snapshot) factory methods.
- *
- * @typeParam Plugins - Map of plugin names to plugin instances that extend
- *   the SDK with additional domain-specific functionality.
- **/
-export declare class GearboxSDK<const Plugins extends PluginsMap = {}> extends ChainContractsRegister {
-    #private;
-    /**
-     * Registered plugin instances, keyed by plugin name.
-     **/
-    readonly plugins: Plugins;
-    /**
-     * 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.
-     **/
-    readonly gasLimit: bigint | undefined;
-    /**
-     * When `true`, the SDK throws on unrecognised contract types instead of
-     * falling back to a generic contract wrapper.
-     **/
-    readonly strictContractTypes: boolean;
-    /**
-     * Registers a callback for an SDK lifecycle event.
-     *
-     * @see {@link SDKHooks} for available event names.
-     **/
-    addHook: <K extends keyof SDKHooks>(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
-    /**
-     * Removes a previously registered lifecycle callback.
-     *
-     * @see {@link SDKHooks} for available event names.
-     **/
-    removeHook: <K extends keyof SDKHooks>(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
-    /**
-     * 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 attach<const Plugins extends PluginsMap>(options: SDKOptions<Plugins> & ClientOptions & Partial<NetworkOptions>): Promise<GearboxSDK<Plugins>>;
-    /**
-     * 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<const Plugins extends PluginsMap>(options: HydrateOptions<Plugins> & ClientOptions, state: GearboxState<Plugins>): GearboxSDK<Plugins>;
-    private constructor();
-    /**
-     * 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.
-     **/
-    reattach(): Promise<void>;
-    /**
-     * 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.
-     **/
-    rehydrate(state: GearboxState<Plugins>): Promise<void>;
-    /**
-     * Gearbox network type the SDK is connected to (e.g. `"Mainnet"`, `"Arbitrum"`).
-     **/
-    get networkType(): NetworkType;
-    /**
-     * 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?: boolean): GearboxStateHuman;
-    /**
-     * 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(): GearboxState<Plugins>;
-    /**
-     * 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.
-     **/
-    syncState(opts?: SyncStateOptions): Promise<boolean>;
-    /**
-     * Block number that the SDK state corresponds to.
-     *
-     * @throws If the SDK has not been attached or hydrated yet.
-     **/
-    get currentBlock(): bigint;
-    /**
-     * Block timestamp (Unix epoch seconds) corresponding to {@link currentBlock}.
-     *
-     * @throws If the SDK has not been attached or hydrated yet.
-     **/
-    get timestamp(): bigint;
-    /**
-     * 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(): PriceFeedRegister;
-    /**
-     * Address of the GEAR governance token on this chain, or `undefined`
-     * if the address provider does not list it.
-     **/
-    get gear(): Address | undefined;
-    /**
-     * 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(): IAddressProviderContract;
-    /**
-     * Registry of all loaded markets (pools, credit managers, oracles, etc.).
-     *
-     * @throws If the SDK has not been attached or hydrated yet.
-     **/
-    get marketRegister(): MarketRegister;
-    /**
-     * 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: {
-        creditManager: Address | BaseState | IBaseContract;
-    } | {
-        creditFacade: Address | BaseState | IBaseContract;
-    } | VersionRange): IRouterContract;
-}

package/dist/types/sdk/plugins/errors.d.ts

@@ -1,4 +0,0 @@
-import type { IGearboxSDKPlugin, IPluginState } from "./types.js";
-export declare class PluginStateVersionError<TState extends IPluginState> extends Error {
-    constructor(plugin: IGearboxSDKPlugin<TState>, state: TState);
-}