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

package/dist/esm/sdk/plugins/BasePlugin.js

@@ -1,3 +1,4 @@
+import { SdkAlreadyAttachedError, SdkNotAttachedError } from "../core/index.js";
 class BasePlugin {
   #sdk;
   logger;
@@ -20,19 +21,25 @@ class BasePlugin {
    **/
   get sdk() {
     if (!this.#sdk) {
-      throw new Error("SDK is not attached");
+      throw new SdkNotAttachedError();
     }
     return this.#sdk;
   }
+  /**
+   * @internal
+   * Set the SDK instance. Called by the SDK constructor.
+   * @param sdk - The SDK instance.
+   * @throws Error if the SDK is already attached.
+   */
   set sdk(sdk) {
     if (this.#sdk) {
-      throw new Error("SDK is already attached");
+      throw new SdkAlreadyAttachedError();
     }
     this.#sdk = sdk;
     this.logger = sdk.logger?.child?.({ name: this.constructor.name }) ?? sdk.logger;
   }
   /**
-   * {@inheritDoc IGearboxSDKPlugin.attach}
+   * {@inheritDoc IOnchainSDKPlugin.attach}
    **/
   async attach() {
     if (this.loadOnAttach) {
@@ -40,7 +47,7 @@ class BasePlugin {
     }
   }
   /**
-   * {@inheritDoc IGearboxSDKPlugin.syncState}
+   * {@inheritDoc IOnchainSDKPlugin.syncState}
    **/
   async syncState() {
     await this.load(false);

package/dist/esm/sdk/utils/viem/index.js

@@ -4,3 +4,4 @@ export * from "./getLogsSafe.js";
 export * from "./sendRawTx.js";
 export * from "./simulateMulticall.js";
 export * from "./simulateWithPriceUpdates.js";
+export * from "./watchBlocksAsync.js";

package/dist/esm/sdk/utils/viem/watchBlocksAsync.js

@@ -0,0 +1,52 @@
+import { getBlock } from "viem/actions";
+import { getAction } from "viem/utils";
+function watchBlocksAsync(client, parameters) {
+  const {
+    onBlock,
+    onError,
+    onDrop,
+    pollingInterval = client.pollingInterval
+  } = parameters;
+  let active = true;
+  let busy = false;
+  let prevBlock;
+  const poll = async () => {
+    if (!active) return;
+    let block;
+    try {
+      block = await getAction(
+        client,
+        getBlock,
+        "getBlock"
+      )({});
+    } catch (err) {
+      onError?.(err);
+      return;
+    }
+    if (!active) return;
+    if (block.number !== null && prevBlock?.number != null && block.number <= prevBlock.number) {
+      return;
+    }
+    if (busy) {
+      onDrop?.(block);
+      return;
+    }
+    busy = true;
+    try {
+      await onBlock(block, prevBlock);
+      prevBlock = block;
+    } catch (err) {
+      onError?.(err);
+    } finally {
+      busy = false;
+    }
+  };
+  const timer = setInterval(poll, pollingInterval);
+  return () => {
+    active = false;
+    clearInterval(timer);
+  };
+}
+export {
+  watchBlocksAsync
+};

package/dist/types/{dev → src/dev}/calcLiquidatableLTs.d.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
-import type { CreditAccountData, GearboxSDK, ILogger } from "../sdk/index.js";
+import type { CreditAccountData, ILogger, OnchainSDK } from "../sdk/index.js";
 /**
  * Given credit accounts, calculates new liquidation thresholds that needs to be set to drop account health factor a bit to make it eligible for partial liquidation
  * @param ca
  */
-export declare function calcLiquidatableLTs(sdk: GearboxSDK, ca: CreditAccountData, factor?: bigint, logger?: ILogger): Promise<Record<Address, number>>;
+export declare function calcLiquidatableLTs(sdk: OnchainSDK, ca: CreditAccountData, factor?: bigint, logger?: ILogger): Promise<Record<Address, number>>;

package/dist/types/{dev → src/dev}/claimFromFaucet.d.ts

@@ -1,11 +1,11 @@
 import { type Account, type Address, type PublicClient, type WalletClient } from "viem";
-import { type GearboxSDK, type ILogger } from "../sdk/index.js";
+import { type ILogger, type OnchainSDK } from "../sdk/index.js";
 interface TokenClaim {
     token: Address;
     amount: bigint;
 }
 interface ClaimFromFaucetOptions {
-    sdk?: GearboxSDK;
+    sdk?: OnchainSDK;
     publicClient: PublicClient;
     wallet: WalletClient;
     faucet: Address;

package/dist/types/{dev → src/dev}/create2.d.ts

@@ -1,6 +1,6 @@
 import type { Abi } from "abitype";
 import type { Account, Address, Chain, Client, ContractConstructorArgs, GetChainParameter, Hash, Hex, SendTransactionParameters, SendTransactionReturnType, Transport, UnionEvaluate, UnionOmit, WalletClient } from "viem";
-import type { GearboxSDK } from "../sdk/index.js";
+import type { OnchainSDK } from "../sdk/index.js";
 import { Construct } from "../sdk/index.js";
 export declare const PUBLIC_CREATE2_FACTORY: Address;
 export declare const DEFAULT_CREATE2_SALT = "GEARBOX";
@@ -26,7 +26,7 @@ export interface EnsureExistsUsingPublicCreate2ReturnType {
 }
 export declare class Create2Deployer<transport extends Transport = Transport, chain extends Chain = Chain, account extends Account = Account> extends Construct {
     #private;
-    constructor(sdk: GearboxSDK, walletClient: WalletClient<transport, chain, account>);
+    constructor(sdk: OnchainSDK, walletClient: WalletClient<transport, chain, account>);
     ensureExists<abi extends Abi | readonly unknown[], chainOverride extends Chain | undefined = Chain | undefined>(parameters: Create2Parameters<abi, chain, account, chainOverride>): Promise<EnsureExistsUsingPublicCreate2ReturnType>;
 }
 /**

package/dist/types/{dev → src/dev}/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./AccountOpener.js";
-export * from "./CachedStateSubscriber.js";
 export * from "./calcLiquidatableLTs.js";
 export * from "./claimFromFaucet.js";
 export * from "./create2.js";

package/dist/types/{dev → src/dev}/migrateFaucet.d.ts

@@ -1,9 +1,9 @@
 import type { Address } from "viem";
-import type { GearboxSDK } from "../sdk/index.js";
+import type { OnchainSDK } from "../sdk/index.js";
 /**
  * Sets faucet address on address provider
  * @param sdk
  * @param faucet - faucet address.
  * @returns faucet address as read from address provider
  */
-export declare function migrateFaucet(sdk: GearboxSDK, faucet: Address): Promise<Address>;
+export declare function migrateFaucet(sdk: OnchainSDK, faucet: Address): Promise<Address>;

package/dist/types/{dev → src/dev}/mint/AbstractMinter.d.ts

@@ -1,11 +1,11 @@
 import { type Address } from "viem";
-import { type GearboxSDK, SDKConstruct } from "../../sdk/index.js";
+import { type OnchainSDK, SDKConstruct } from "../../sdk/index.js";
 import type { AnvilClient } from "../createAnvilClient.js";
 import type { IMinter } from "./types.js";
 export default abstract class AbstractMinter extends SDKConstruct implements IMinter {
     protected readonly anvil: AnvilClient;
     name: string;
-    constructor(sdk: GearboxSDK, anvil: AnvilClient);
+    constructor(sdk: OnchainSDK, anvil: AnvilClient);
     tryMint(token: Address, dest: Address, amount: bigint): Promise<bigint>;
     abstract mint(token: Address, dest: Address, amount: bigint): Promise<void>;
     protected getOwner(address: Address): Promise<Address>;

package/dist/types/{dev → src/dev}/mint/FallbackMinter.d.ts

@@ -1,10 +1,10 @@
 import type { Address } from "viem";
-import type { GearboxSDK } from "../../sdk/index.js";
+import type { OnchainSDK } from "../../sdk/index.js";
 import type { AnvilClient } from "../createAnvilClient.js";
 import AbstractMinter from "./AbstractMinter.js";
 import type { IMinter } from "./types.js";
 export declare class FallbackMinter extends AbstractMinter implements IMinter {
     #private;
-    constructor(sdk: GearboxSDK, anvil: AnvilClient, minters: IMinter[]);
+    constructor(sdk: OnchainSDK, anvil: AnvilClient, minters: IMinter[]);
     mint(token: Address, dest: Address, amount: bigint): Promise<void>;
 }

package/dist/types/{dev → src/dev}/mint/factory.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { GearboxSDK } from "../../sdk/index.js";
+import type { OnchainSDK } from "../../sdk/index.js";
 import type { AnvilClient } from "../createAnvilClient.js";
 import type { IMinter } from "./types.js";
-export declare function createMinter(sdk: GearboxSDK, anvil: AnvilClient, _token: Address): IMinter;
+export declare function createMinter(sdk: OnchainSDK, anvil: AnvilClient, _token: Address): IMinter;

package/dist/types/{permissionless → src/permissionless}/utils/price-update/get-updatable-feeds.d.ts

@@ -1,7 +1,7 @@
 import { type Address, type PublicClient } from "viem";
-import { type GearboxSDK, type IPriceFeedContract } from "../../../sdk/index.js";
+import { type IPriceFeedContract, type OnchainSDK } from "../../../sdk/index.js";
 export declare function getUpdatablePriceFeeds(args: {
-    sdk: GearboxSDK;
+    sdk: OnchainSDK;
     client: PublicClient;
     pfCompressor: Address;
     priceFeeds: Address[];

package/dist/types/{plugins → src/plugins}/accounts/AccountsPlugin.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { CreditAccountData, GetCreditAccountsOptions, IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { CreditAccountData, GetCreditAccountsOptions, IOnchainSDKPlugin } from "../../sdk/index.js";
 import { BasePlugin } from "../../sdk/index.js";
 export interface AccountsPluginState {
     /**
@@ -7,7 +7,7 @@ export interface AccountsPluginState {
      */
     accounts: CreditAccountData[];
 }
-export declare class AccountsPlugin extends BasePlugin<AccountsPluginState> implements IGearboxSDKPlugin<AccountsPluginState> {
+export declare class AccountsPlugin extends BasePlugin<AccountsPluginState> implements IOnchainSDKPlugin<AccountsPluginState> {
     #private;
     constructor(options?: GetCreditAccountsOptions, loadOnAttach?: boolean);
     get accounts(): CreditAccountData[];

package/dist/types/{plugins → src/plugins}/accounts-counter/AccountsCounterPlugin.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { IOnchainSDKPlugin } from "../../sdk/index.js";
 import { AddressMap, BasePlugin } from "../../sdk/index.js";
 export interface AccountsCounterPluginState {
     /**
@@ -7,7 +7,7 @@ export interface AccountsCounterPluginState {
      */
     accounts: Record<Address, bigint>;
 }
-export declare class AccountsCounterPlugin extends BasePlugin<AccountsCounterPluginState> implements IGearboxSDKPlugin<AccountsCounterPluginState> {
+export declare class AccountsCounterPlugin extends BasePlugin<AccountsCounterPluginState> implements IOnchainSDKPlugin<AccountsCounterPluginState> {
     #private;
     constructor(loadOnAttach?: boolean);
     get accounts(): AddressMap<bigint>;

package/dist/types/{plugins → src/plugins}/adapters/AdaptersPlugin.d.ts

@@ -1,6 +1,6 @@
-import type { BaseState, IBaseContract, IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { BaseState, IBaseContract, IOnchainSDKPlugin } from "../../sdk/index.js";
 import { BasePlugin } from "../../sdk/index.js";
-export declare class AdaptersPlugin extends BasePlugin<{}> implements IGearboxSDKPlugin<{}> {
+export declare class AdaptersPlugin extends BasePlugin<{}> implements IOnchainSDKPlugin<{}> {
     readonly name = "Adapters";
     readonly version = 1;
     readonly loaded = true;

package/dist/types/{plugins → src/plugins}/apy/ApyPlugin.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { IOnchainSDKPlugin } from "../../sdk/index.js";
 import { AddressMap, BasePlugin } from "../../sdk/index.js";
 import type { GetPoolsAPYResult } from "./pool-apy-types.js";
 import type { ApySnapshotState, Pool7DAgoState, Pools7DAgoStateHuman } from "./types.js";
@@ -20,7 +20,7 @@ export interface ApyPluginLoadOptions {
      */
     loadPools7DAgo?: boolean;
 }
-export declare class ApyPlugin extends BasePlugin<ApyPluginState> implements IGearboxSDKPlugin<ApyPluginState> {
+export declare class ApyPlugin extends BasePlugin<ApyPluginState> implements IOnchainSDKPlugin<ApyPluginState> {
     #private;
     constructor(loadOnAttach?: boolean, options?: ApyPluginConstructorOptions);
     load(force?: boolean, loadOptions?: ApyPluginLoadOptions): Promise<ApyPluginState>;

package/dist/types/{plugins → src/plugins}/bots/BotsPlugin.d.ts

@@ -1,8 +1,8 @@
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { IOnchainSDKPlugin } from "../../sdk/index.js";
 import { BasePlugin } from "../../sdk/index.js";
 import { PartialLiquidationBotV310Contract } from "./PartialLiquidationBotV310Contract.js";
 import { type BotsPluginState, type BotsPluginStateHuman, type MigrationBotState } from "./types.js";
-export declare class BotsPlugin extends BasePlugin<BotsPluginState> implements IGearboxSDKPlugin<BotsPluginState> {
+export declare class BotsPlugin extends BasePlugin<BotsPluginState> implements IOnchainSDKPlugin<BotsPluginState> {
     #private;
     get loaded(): boolean;
     get bots(): PartialLiquidationBotV310Contract[];

package/dist/types/{plugins → src/plugins}/bots/PartialLiquidationBotV310Contract.d.ts

@@ -1,5 +1,5 @@
 import { type Address, type Hex } from "viem";
-import { BaseContract, type GearboxSDK } from "../../sdk/index.js";
+import { BaseContract, type OnchainSDK } from "../../sdk/index.js";
 import { type BotStateV310Human } from "./types.js";
 declare const abi: readonly [{
     readonly type: "function";
@@ -205,7 +205,7 @@ export declare class PartialLiquidationBotV310Contract extends BaseContract<abi>
     readonly maxHealthFactor: number;
     readonly premiumScaleFactor: number;
     readonly feeScaleFactor: number;
-    constructor(sdk: GearboxSDK, args: PartialLiquidationBotV310Params);
+    constructor(sdk: OnchainSDK, args: PartialLiquidationBotV310Params);
     stateHuman(raw?: boolean): BotStateV310Human;
     get state(): PartialLiquidationBotV310Params;
 }

package/dist/types/{plugins → src/plugins}/degen-distributors/DegenDistributorsPlugin.d.ts

@@ -1,11 +1,11 @@
 import type { Address } from "viem";
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { IOnchainSDKPlugin } from "../../sdk/index.js";
 import { AddressMap, BasePlugin } from "../../sdk/index.js";
 import type { DegenDistributorsStateHuman } from "./types.js";
 export interface DegenDistributorsPluginState {
     distributors: Record<Address, Address>;
 }
-export declare class DegenDistributorsPlugin extends BasePlugin<DegenDistributorsPluginState> implements IGearboxSDKPlugin<DegenDistributorsPluginState> {
+export declare class DegenDistributorsPlugin extends BasePlugin<DegenDistributorsPluginState> implements IOnchainSDKPlugin<DegenDistributorsPluginState> {
     #private;
     load(force?: boolean): Promise<DegenDistributorsPluginState>;
     get loaded(): boolean;

package/dist/types/{plugins → src/plugins}/delayed-withdrawal/DelayedWithdrawalPlugin.d.ts

@@ -1,11 +1,11 @@
 import type { Address } from "viem";
-import type { IGearboxSDKPlugin } from "../../sdk/index.js";
+import type { IOnchainSDKPlugin } from "../../sdk/index.js";
 import { AddressMap, BasePlugin } from "../../sdk/index.js";
 import type { WithdrawableAsset, WithdrawableAssetStateHuman } from "./types.js";
 export interface DelayedWithdrawalPluginState {
     withdrawableAssets: Record<Address, Array<WithdrawableAsset>>;
 }
-export declare class DelayedWithdrawalPlugin extends BasePlugin<DelayedWithdrawalPluginState> implements IGearboxSDKPlugin<DelayedWithdrawalPluginState> {
+export declare class DelayedWithdrawalPlugin extends BasePlugin<DelayedWithdrawalPluginState> implements IOnchainSDKPlugin<DelayedWithdrawalPluginState> {
     #private;
     load(force?: boolean): Promise<DelayedWithdrawalPluginState>;
     get loaded(): boolean;

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

@@ -0,0 +1,135 @@
+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;
+}
+/**
+ * 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.
+     */
+    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;
+}