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

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

@@ -0,0 +1,144 @@
+import type { NetworkType } from "./chain/chains.js";
+import { type PythOptions, type RedstoneOptions } from "./market/pricefeeds/updates/index.js";
+import { type AttachOptions, type ClientOptions, type HydrateOptions, OnchainSDK } from "./OnchainSDK.js";
+import type { PluginFactoriesMap, PluginsMap } from "./plugins/index.js";
+import type { ILogger, MultichainState, MultichainStateHuman } from "./types/index.js";
+/**
+ * Per-chain configuration for {@link MultichainSDK}.
+ **/
+export interface ChainConfig {
+    /**
+     * Gas limit for read-only `eth_call` requests. `null` disables, `undefined` uses default.
+     **/
+    gasLimit?: bigint | null;
+}
+/**
+ * Options for creating a {@link MultichainSDK} instance.
+ *
+ * @typeParam Plugins - Map of plugin names to plugin instances.
+ **/
+export interface MultichainSDKOptions<Plugins extends PluginsMap> {
+    /**
+     * Per-chain client and configuration.
+     **/
+    chains: Partial<Record<NetworkType, ChainConfig & ClientOptions>>;
+    /**
+     * Plugin factories — called once per chain to produce independent instances.
+     **/
+    plugins?: PluginFactoriesMap<Plugins>;
+    /**
+     * Shared default logger
+     **/
+    logger?: ILogger;
+    /**
+     * When `true`, throw on unrecognised contract types instead of falling back to a generic contract wrapper.
+     **/
+    strictContractTypes?: boolean;
+    /**
+     * Default gas limit for read-only `eth_call` requests on all chains. `null` disables, `undefined` uses default.
+     **/
+    gasLimit?: bigint | null;
+}
+/**
+ * Options for {@link MultichainSDK.attach}.
+ **/
+export interface MultichainAttachOptions {
+    /**
+     * Per-chain attach options.
+     **/
+    perChain?: Partial<Record<NetworkType, AttachOptions>>;
+    /**
+     * Options for Redstone price-feed updates (shared cache across chains).
+     **/
+    redstone?: RedstoneOptions;
+    /**
+     * Options for Pyth price-feed updates (shared cache across chains).
+     **/
+    pyth?: PythOptions;
+}
+/**
+ * Options for {@link MultichainSDK.hydrate}.
+ **/
+export interface MultichainHydrateOptions {
+    /**
+     * Per-chain hydrate options.
+     **/
+    perChain?: Partial<Record<NetworkType, HydrateOptions>>;
+    /**
+     * Options for Redstone price-feed updates (shared cache across chains).
+     **/
+    redstone?: RedstoneOptions;
+    /**
+     * Options for Pyth price-feed updates (shared cache across chains).
+     **/
+    pyth?: PythOptions;
+    /**
+     * When `true`, chains missing from the serialised state are silently skipped
+     * instead of throwing {@link SdkMissingChainStateError}.
+     *
+     * Useful when a deprecated chain is no longer included in cached state snapshots
+     * but users still need it in legacy mode to exit existing positions.
+     **/
+    allowMissingChains?: boolean;
+}
+/**
+ * Options for {@link MultichainSDK.syncState}.
+ **/
+export interface MultichainSyncStateOptions {
+    /**
+     * When `true`, skip refreshing updatable price feeds.
+     **/
+    ignoreUpdateablePrices?: boolean;
+}
+/**
+ * Thin wrapper around multiple {@link OnchainSDK} instances, one per chain.
+ *
+ * @typeParam Plugins - Map of plugin names to plugin instances.
+ **/
+export declare class MultichainSDK<const Plugins extends PluginsMap = {}> {
+    #private;
+    constructor(options: MultichainSDKOptions<Plugins>);
+    /**
+     * Attach all configured chains in parallel.
+     *
+     * @param options - Shared and per-chain attach options.
+     */
+    attach(options?: MultichainAttachOptions): Promise<void>;
+    /**
+     * Hydrate all configured chains from serialised state.
+     *
+     * @param state - Multichain serialised state.
+     * @param options - Shared and per-chain hydrate options.
+     * @throws {@link SdkStateVersionMismatchError} if version doesn't match.
+     * @throws {@link SdkMissingChainStateError} if a configured chain has no
+     *   state and `allowMissingChains` is not set.
+     */
+    hydrate(state: MultichainState<Plugins>, options?: MultichainHydrateOptions): void;
+    /**
+     * Returns the {@link OnchainSDK} for a given network or chain ID.
+     *
+     * @param networkOrChainId - Network type string or numeric chain ID.
+     * @throws If the network/chain is not configured.
+     */
+    chain(networkOrChainId: NetworkType | number): OnchainSDK<Plugins>;
+    /**
+     * Read-only map of all configured chains.
+     **/
+    get chains(): ReadonlyMap<NetworkType, OnchainSDK<Plugins>>;
+    /**
+     * Sync state for all chains in parallel.
+     *
+     * @param opts - Sync options.
+     * @throws {@link SdkSyncFailedError} if any chain fails.
+     */
+    syncState(opts?: MultichainSyncStateOptions): Promise<void>;
+    /**
+     * Serialisable snapshot of all chains' state.
+     **/
+    get state(): MultichainState<Plugins>;
+    /**
+     * Human-readable snapshot of all chains' state.
+     * @param raw - When `true`, include raw numeric values.
+     */
+    stateHuman(raw?: boolean): MultichainStateHuman;
+}

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

@@ -0,0 +1,257 @@
+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 { PythOptions, RedstoneOptions } from "./market/pricefeeds/updates/index.js";
+import type { PluginsMap } from "./plugins/index.js";
+import { type IRouterContract } from "./router/index.js";
+import type { GearboxState, GearboxStateHuman, ILogger } from "./types/index.js";
+/**
+ * Serialised state format version, checked during hydration to detect
+ * incompatible snapshots.
+ **/
+export declare const STATE_VERSION = 1;
+/**
+ * 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`.
+ **/
+export type ClientOptions = {
+    /**
+     * One or more JSON-RPC endpoint URLs.
+     **/
+    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.
+     **/
+    client: PublicClient<Transport, GearboxChain>;
+};
+/**
+ * Options for creating an {@link OnchainSDK} instance.
+ *
+ * @typeParam Plugins - Map of plugin names to plugin instances.
+ **/
+export interface OnchainSDKOptions<Plugins extends PluginsMap> {
+    /**
+     * Custom logger implementation.
+     **/
+    logger?: ILogger;
+    /**
+     * When `true`, throw on unrecognised contract types instead of falling back to a generic contract wrapper.
+     **/
+    strictContractTypes?: boolean;
+    /**
+     * Explicit gas limit for read-only `eth_call` requests.
+     * `null` disables the gas limit entirely; `undefined` uses the SDK default (550M).
+     */
+    gasLimit?: bigint | null;
+    /**
+     * Plugins that extend SDK functionality.
+     **/
+    plugins?: Plugins;
+}
+/**
+ * Options accepted by {@link OnchainSDK.attach}.
+ **/
+export interface AttachOptions {
+    /**
+     * Override address of the Gearbox AddressProvider contract.
+     **/
+    addressProvider?: Address;
+    /**
+     * Addresses of market configurator contracts to load.
+     **/
+    marketConfigurators?: Address[];
+    /**
+     * Pin SDK to a specific block number during attach.
+     **/
+    blockNumber?: bigint | number;
+    /**
+     * Skip fetching updatable price feeds on attach and sync.
+     **/
+    ignoreUpdateablePrices?: boolean;
+    /**
+     * Pool addresses whose markets should be skipped.
+     **/
+    ignoreMarkets?: Address[];
+    /**
+     * Options for Redstone price-feed updates.
+     **/
+    redstone?: RedstoneOptions;
+    /**
+     * Options for Pyth price-feed updates.
+     **/
+    pyth?: PythOptions;
+}
+/**
+ * Options accepted by {@link OnchainSDK.hydrate}.
+ **/
+export interface HydrateOptions {
+    /**
+     * Pool addresses whose markets should be skipped.
+     **/
+    ignoreMarkets?: Address[];
+    /**
+     * Options for Redstone price-feed updates.
+     **/
+    redstone?: RedstoneOptions;
+    /**
+     * Options for Pyth price-feed updates.
+     **/
+    pyth?: PythOptions;
+}
+/**
+ * Options for {@link OnchainSDK.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;
+}
+/**
+ * Single-chain entry point for the Gearbox SDK.
+ *
+ * `OnchainSDK` 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}.
+ *
+ * Create an instance with `new OnchainSDK(network, clientOptions, options)`,
+ * then call {@link attach} (live chain data) or {@link hydrate} (saved snapshot).
+ *
+ * @typeParam Plugins - Map of plugin names to plugin instances that extend
+ *   the SDK with additional domain-specific functionality.
+ **/
+export declare class OnchainSDK<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.
+     **/
+    readonly gasLimit: bigint | undefined;
+    /**
+     * When `true`, the SDK throws on unrecognised contract types.
+     **/
+    readonly strictContractTypes: boolean;
+    /**
+     * @param network - Gearbox network type (e.g. `"Mainnet"`, `"Monad"`).
+     * @param clientOptions - Connection options (RPC URLs, transport, or client).
+     * @param options - SDK configuration options.
+     */
+    constructor(network: NetworkType, clientOptions: ClientOptions, options?: OnchainSDKOptions<Plugins>);
+    /**
+     * Initialises the SDK by reading live on-chain state.
+     *
+     * @param options - Attach configuration.
+     * @throws {@link SdkAlreadyAttachedError} if already attached.
+     */
+    attach(options?: AttachOptions): Promise<void>;
+    /**
+     * Restores SDK state from a previously serialised {@link GearboxState}
+     * snapshot, without making any on-chain calls.
+     *
+     * @param state - Serialised state obtained from {@link OnchainSDK.state}.
+     * @param options - Hydrate configuration.
+     * @throws {@link SdkAlreadyAttachedError} if already attached.
+     * @throws {@link SdkStateVersionMismatchError} if snapshot version doesn't match.
+     * @throws {@link SdkChainMismatchError} if snapshot network doesn't match.
+     */
+    hydrate(state: GearboxState<Plugins>, options?: HydrateOptions): void;
+    /**
+     * Gearbox network type the SDK is connected to (e.g. `"Mainnet"`, `"Arbitrum"`).
+     **/
+    get networkType(): NetworkType;
+    /**
+     * Whether the SDK has been initialised via {@link attach} or {@link hydrate}.
+     **/
+    get attached(): boolean;
+    /**
+     * Returns a human-readable snapshot of the entire SDK state.
+     * @param raw - When `true`, include raw numeric values alongside formatted ones.
+     */
+    stateHuman(raw?: boolean): GearboxStateHuman;
+    /** Serialisable snapshot of the current SDK state. */
+    get state(): GearboxState<Plugins>;
+    /**
+     * Incrementally updates SDK state by replaying on-chain events.
+     *
+     * @param opts - Target block and sync behaviour.
+     * @returns `true` if the sync completed successfully.
+     */
+    syncState(opts?: SyncStateOptions): Promise<boolean>;
+    /**
+     * Block number that the SDK state corresponds to.
+     * @throws {@link SdkNotAttachedError} if not attached.
+     */
+    get currentBlock(): bigint;
+    /**
+     * Block timestamp (Unix epoch seconds) corresponding to {@link currentBlock}.
+     * @throws {@link SdkNotAttachedError} if not attached.
+     */
+    get timestamp(): bigint;
+    /**
+     * Global registry of all price feeds known to the SDK.
+     * @throws {@link SdkNotAttachedError} if not attached.
+     */
+    get priceFeeds(): PriceFeedRegister;
+    /** GEAR governance token address, or `undefined` if not listed. */
+    get gear(): Address | undefined;
+    /**
+     * The chain's address provider contract.
+     * @throws {@link SdkNotAttachedError} if not attached.
+     */
+    get addressProvider(): IAddressProviderContract;
+    /**
+     * Registry of all loaded markets.
+     * @throws {@link SdkNotAttachedError} if not attached.
+     */
+    get marketRegister(): MarketRegister;
+    /**
+     * Resolves the appropriate router contract for a given credit manager,
+     * credit facade, or explicit version range.
+     */
+    routerFor(params: {
+        creditManager: Address | BaseState | IBaseContract;
+    } | {
+        creditFacade: Address | BaseState | IBaseContract;
+    } | VersionRange): IRouterContract;
+}

package/dist/types/sdk/accounts/AbstractCreditAccountsService.d.ts

@@ -1,13 +1,12 @@
 import type { Address } from "viem";
 import type { CreditAccountData } from "../base/index.js";
 import { SDKConstruct } from "../base/index.js";
-import type { GearboxSDK } from "../GearboxSDK.js";
 import type { CreditSuite } from "../market/index.js";
 import { type PriceUpdate, type UpdatePriceFeedsResult } from "../market/index.js";
-import { type OpenAccountRequirements } from "../market/kyc/index.js";
+import type { OnchainSDK } from "../OnchainSDK.js";
 import { type Asset, type RouterCASlice } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
-import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, CloseCreditAccountProps, CloseCreditAccountResult, CloseOptions, CreditAccountOperationResult, CreditAccountTokensSlice, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, OpenCAProps, PermitResult, PrepareUpdateQuotasProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, Rewards, StartDelayedWithdrawalProps, UpdateQuotasProps } from "./types.js";
 /**
  * Options for configuring the credit account service.
  **/
@@ -29,19 +28,15 @@ export declare function getWithdrawalCompressorAddress(chainId: number): `0x${st
  */
 export declare abstract class AbstractCreditAccountService extends SDKConstruct {
     #private;
-    constructor(sdk: GearboxSDK, options?: CreditAccountServiceOptions);
+    constructor(sdk: OnchainSDK, options?: CreditAccountServiceOptions);
     /**
      * {@inheritDoc ICreditAccountsService.getCreditAccountData}
      **/
-    getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData<true> | undefined>;
+    getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.getCreditAccounts}
      **/
     getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData>>;
-    /**
-     * {@inheritDoc ICreditAccountsService.getBorrowerCreditAccounts}
-     **/
-    getBorrowerCreditAccounts(borrower: Address, options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<Array<CreditAccountData<true>>>;
     /**
      * {@inheritDoc ICreditAccountsService.getRewards}
      **/
@@ -94,14 +89,6 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      * {@inheritDoc ICreditAccountsService.claimDelayed}
      **/
     claimDelayed({ creditAccount, minQuota, averageQuota, claimableNow, }: ClaimDelayedProps): Promise<CreditAccountOperationResult>;
-    /**
-     * {@inheritDoc ICreditAccountsService.getApprovalAddress}
-     **/
-    getApprovalAddress(options: GetApprovalAddressProps): Promise<Address>;
-    /**
-     * {@inheritDoc ICreditAccountsService.getOpenAccountRequirements}
-     */
-    getOpenAccountRequirements(borrower: Address, props: Pick<OpenCAProps, "creditManager">): Promise<OpenAccountRequirements | undefined>;
     /**
      * {@inheritDoc ICreditAccountsService.openCA}
      **/
@@ -115,43 +102,6 @@ export declare abstract class AbstractCreditAccountService extends SDKConstruct
      **/
     getOptimalHFForPartialLiquidation(ca: CreditAccountData): bigint;
     /**
-     * Returns multicall entries to redeem (unwrap) KYC ERC-4626 vault shares into underlying for the given credit manager.
-     * Used when withdrawing debt from a KYC market: redeems adapter vault shares so the underlying can be withdrawn.
-     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
-     * @param amount - Number of vault shares (adapter tokens) to redeem
-     * @param creditManager - Credit manager address
-     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
-     */
-    getKYCUnwrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-    /**
-     * Returns multicall entries to deposit (wrap) underlying into KYC ERC-4626 vault shares for the given credit manager.
-     * Used when adding debt on a KYC market: deposits underlying into the adapter vault so shares are minted on the account.
-     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
-     * @param amount - Amount of underlying assets to deposit into the vault (in underlying decimals)
-     * @param creditManager - Credit manager address
-     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
-     */
-    getKYCWrapCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-    /**
-     * Returns multicall entries to call redeemDiff on the KYC ERC-4626 adapter for the given credit manager.
-     * Redeems the leftover vault shares (e.g. after repaying debt) so the account does not hold excess KYC vault tokens.
-     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
-     * @param amount - Leftover vault share amount to redeem (in adapter/vault decimals)
-     * @param creditManager - Credit manager address
-     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
-     */
-    getRedeemDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-    /**
-     * Returns multicall entries to call depositDiff on the KYC ERC-4626 adapter for the given credit manager.
-     * Deposits the leftover underlying (e.g. after decreasing debt) into the vault so the account does not hold excess underlying.
-     * Only applies when the credit manager's underlying is KYC-gated and has an ERC-4626 adapter configured.
-     * @param amount - Leftover underlying amount to deposit into the vault (in underlying decimals)
-     * @param creditManager - Credit manager address
-     * @returns Array of MultiCall to pass to credit facade multicall, or undefined if underlying is not KYC or no adapter is configured
-     */
-    getDepositDiffCalls(amount: bigint, creditManager: Address): Promise<Array<MultiCall> | undefined>;
-    /**
-     * Returns raw txs that are needed to update all price feeds so that all credit accounts (possibly from different markets) compute
      * {@inheritDoc ICreditAccountsService.getOnDemandPriceUpdates}
      **/
     getOnDemandPriceUpdates(account: CreditAccountTokensSlice, ignoreReservePrices?: boolean): Promise<PriceUpdate[]>;

package/dist/types/sdk/accounts/CreditAccountsServiceV310.d.ts

@@ -21,7 +21,7 @@ export declare class CreditAccountServiceV310 extends AbstractCreditAccountServi
     /**
      * {@inheritDoc ICreditAccountsService.repayCreditAccount}
      */
-    repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, calls: wrapCalls, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
+    repayCreditAccount({ operation, collateralAssets, assetsToWithdraw, creditAccount: ca, permits, to, tokensToClaim, }: RepayCreditAccountProps): Promise<CreditAccountOperationResult>;
     /**
      * {@inheritDoc ICreditAccountsService.repayAndLiquidateCreditAccount}
      */

package/dist/types/sdk/accounts/createCreditAccountService.d.ts

@@ -1,4 +1,4 @@
-import type { GearboxSDK } from "../GearboxSDK.js";
+import type { OnchainSDK } from "../OnchainSDK.js";
 import type { CreditAccountServiceOptions } from "./AbstractCreditAccountsService.js";
 import type { ICreditAccountsService } from "./types.js";
 /**
@@ -6,4 +6,4 @@ import type { ICreditAccountsService } from "./types.js";
  * @version version of desired credit facade
  * @returns
  */
-export declare function createCreditAccountService(sdk: GearboxSDK, version: number, options?: CreditAccountServiceOptions): ICreditAccountsService;
+export declare function createCreditAccountService(sdk: OnchainSDK, version: number, options?: CreditAccountServiceOptions): ICreditAccountsService;