@gearbox-protocol/sdk 9.17.0 → 10.0.0

package/dist/esm/sdk/market/pricefeeds/Erc4626PriceFeed.js

@@ -11,12 +11,12 @@ class Erc4626PriceFeedContract extends AbstractLPPriceFeedContract {
     });
   }
   async getValue() {
-    const decimals = await this.sdk.provider.publicClient.readContract({
+    const decimals = await this.sdk.client.readContract({
       abi: ierc20Abi,
       address: this.lpContract,
       functionName: "decimals"
     });
-    const price = await this.sdk.provider.publicClient.readContract({
+    const price = await this.sdk.client.readContract({
       abi: erc4626Abi,
       address: this.lpContract,
       functionName: "convertToAssets",

package/dist/esm/sdk/market/pricefeeds/MellowLRTPriceFeed.js

@@ -9,7 +9,7 @@ class MellowLRTPriceFeedContract extends AbstractLPPriceFeedContract {
     });
   }
   async getValue() {
-    const stack = await this.sdk.provider.publicClient.readContract({
+    const stack = await this.sdk.client.readContract({
       abi: iMellowVaultAbi,
       address: this.lpContract,
       functionName: "calculateStack"

package/dist/esm/sdk/market/pricefeeds/PriceFeedsRegister.js

@@ -157,7 +157,7 @@ class PriceFeedRegister extends SDKConstruct {
       VERSION_RANGE_310
     );
     const blockParam = block ?? { blockNumber: this.sdk.currentBlock };
-    const result = await this.provider.publicClient.readContract({
+    const result = await this.client.readContract({
       address: priceFeedCompressorAddress,
       abi: priceFeedCompressorAbi,
       functionName: "loadPriceFeedTree",
@@ -214,7 +214,7 @@ class PriceFeedRegister extends SDKConstruct {
       { configurators, pools },
       `calling getUpdatablePriceFeeds in block ${this.sdk.currentBlock}`
     );
-    const result = await this.provider.publicClient.readContract({
+    const result = await this.client.readContract({
       address: priceFeedCompressorAddress,
       abi: priceFeedCompressorAbi,
       functionName: "getUpdatablePriceFeeds",

package/dist/esm/sdk/market/pricefeeds/WstETHPriceFeed.js

@@ -9,7 +9,7 @@ class WstETHPriceFeedContract extends AbstractLPPriceFeedContract {
     });
   }
   async getValue() {
-    return await this.sdk.provider.publicClient.readContract({
+    return await this.sdk.client.readContract({
       abi: iwstEthAbi,
       address: this.lpContract,
       functionName: "stEthPerToken"

package/dist/esm/sdk/market/pricefeeds/YearnPriceFeed.js

@@ -9,7 +9,7 @@ class YearnPriceFeedContract extends AbstractLPPriceFeedContract {
     });
   }
   async getValue() {
-    return await this.sdk.provider.publicClient.readContract({
+    return await this.sdk.client.readContract({
       abi: iyVaultAbi,
       address: this.lpContract,
       functionName: "pricePerShare"

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

@@ -27,17 +27,14 @@ class BasePlugin {
   async syncState() {
     await this.load(false);
   }
-  get provider() {
-    return this.sdk.provider;
-  }
   get network() {
-    return this.provider.networkType;
+    return this.sdk.networkType;
   }
   get client() {
-    return this.provider.publicClient;
+    return this.sdk.client;
   }
   labelAddress(address) {
-    return this.provider.addressLabels.get(address);
+    return this.sdk.labelAddress(address);
   }
 }
 export {

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

@@ -11,7 +11,7 @@ class V300StalenessPeriodPlugin extends BasePlugin {
   #events = [];
   set sdk(sdk) {
     super.sdk = sdk;
-    this.#syncedTo = (sdk.provider.chain.firstBlock ?? 1n) - 1n;
+    this.#syncedTo = (sdk.chain.firstBlock ?? 1n) - 1n;
   }
   get sdk() {
     return super.sdk;

package/dist/esm/sdk/router/RouterV300Contract.js

@@ -39,7 +39,7 @@ class RouterV300Contract extends AbstractRouterContract {
       abi: iRouterV300Abi,
       version
     });
-    this.#connectors = getConnectors(sdk.provider.networkType);
+    this.#connectors = getConnectors(sdk.networkType);
   }
   /**
    * Implements {@link IRouterContract.findAllSwaps}
@@ -267,7 +267,7 @@ class RouterV300Contract extends AbstractRouterContract {
     }));
     const pathOptions = PathOptionFactory.generatePathOptions(
       ca.tokens,
-      this.provider.networkType,
+      this.networkType,
       LOOPS_PER_TX
     );
     const connectors = this.getAvailableConnectors(cm.collateralTokens);
@@ -320,12 +320,12 @@ class RouterV300Contract extends AbstractRouterContract {
       Lisk: "0x0",
       Plasma: "0x0"
     };
-    const pendleRouter = PENDLE_ROUTER_BY_NETWORK[this.sdk.provider.networkType];
+    const pendleRouter = PENDLE_ROUTER_BY_NETWORK[this.sdk.networkType];
     const pendleAdapter = cm.creditManager.adapters.mustGet(pendleRouter);
     const pendleSwapper = getContract({
       address: pendleSwapperAddress,
       abi: iSwapperV300Abi,
-      client: this.sdk.provider.publicClient
+      client: this.sdk.client
     });
     const result = await pendleSwapper.simulate.getBestDirectPairSwap([
       {

package/dist/types/dev/createAnvilClient.d.ts

@@ -48,6 +48,7 @@ export interface AnvilClientConfig<transport extends Transport = Transport, chai
     cacheTime?: number;
     pollingInterval?: number;
 }
+export declare function extendAnvilClient(client: PublicClient): AnvilClient;
 export declare function createAnvilClient({ chain, transport, cacheTime, pollingInterval, }: AnvilClientConfig): AnvilClient;
 /**
  * View action to detect if client is an anvil client

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

@@ -1,8 +1,8 @@
 import type { Address, Hex } from "viem";
+import { type PublicClient, type Transport } from "viem";
 import type { BaseContract, BaseState, IBaseContract } from "./base/index.js";
-import { TokensMeta } from "./base/index.js";
-import type { ConnectionOptions, NetworkOptions, TransportOptions } from "./chain/index.js";
-import { Provider } from "./chain/index.js";
+import { AddressLabeller, TokensMeta } 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 { BotListContract, GearStakingContract } from "./core/index.js";
@@ -17,6 +17,41 @@ import { AddressMap } from "./utils/index.js";
  * State version, checked duryng hydration
  */
 export declare const STATE_VERSION = 1;
+export interface NetworkOptions {
+    /**
+     * Chain Id needs to be set, because we sometimemes use forked testnets with different chain ids
+     */
+    chainId: number;
+    /**
+     * NetworkType needs to be set, because we sometimemes use forked testnets with different chain ids
+     */
+    networkType: NetworkType;
+}
+export type ClientOptions = {
+    /**
+     * RPC URL (and fallbacks) to use.
+     */
+    rpcURLs: string[];
+    /**
+     * RPC client timeout in milliseconds
+     */
+    timeout?: number;
+    /**
+     * Retry count for RPC
+     */
+    retryCount?: number;
+} | {
+    /**
+     * Alternatively, can pass viem transport
+     */
+    transport: Transport;
+} | {
+    /**
+     * Alternatively, can pass entire viem client
+     * If you bring your own client, it is responsible for defining networkType and chainId
+     */
+    client: PublicClient<Transport, GearboxChain>;
+};
 export type HydrateOptions<Plugins extends PluginsMap> = Omit<SDKOptions<Plugins>, "blockNumber" | "addressProvider" | "marketConfigurators">;
 export interface SyncStateOptions {
     blockNumber: bigint;
@@ -32,6 +67,7 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> {
     readonly plugins: Plugins;
     readonly logger?: ILogger;
     readonly gasLimit: bigint | undefined;
+    readonly addressLabels: AddressLabeller;
     /**
      * Interest rate models can be reused across chain (and SDK operates on chain level)
      * TODO: use whatever interface is necessary for InterestRateModels
@@ -51,8 +87,8 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> {
     readonly tokensMeta: TokensMeta;
     addHook: <K extends keyof SDKHooks>(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
     removeHook: <K extends keyof SDKHooks>(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
-    static attach<const Plugins extends PluginsMap>(options: SDKOptions<Plugins> & Partial<NetworkOptions> & ConnectionOptions & TransportOptions): Promise<GearboxSDK<Plugins>>;
-    static hydrate<const Plugins extends PluginsMap>(options: HydrateOptions<Plugins> & ConnectionOptions & TransportOptions, state: GearboxState<Plugins>): GearboxSDK<Plugins>;
+    static attach<const Plugins extends PluginsMap>(options: SDKOptions<Plugins> & ClientOptions & Partial<NetworkOptions>): Promise<GearboxSDK<Plugins>>;
+    static hydrate<const Plugins extends PluginsMap>(options: HydrateOptions<Plugins> & ClientOptions, state: GearboxState<Plugins>): GearboxSDK<Plugins>;
     private constructor();
     /**
      * Reattach SDK with the same config as before, without re-creating instance. Will load all state from scratch
@@ -63,6 +99,16 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> {
      * Rehydrate existing SDK from new state without re-creating instance
      */
     rehydrate(state: GearboxState<Plugins>): Promise<void>;
+    get client(): PublicClient<Transport, GearboxChain>;
+    /**
+     * Replaces client inflight
+     * You're responsible for all inconsistencies between new and old client
+     * @param options
+     */
+    replaceClient(options: ClientOptions, network?: NetworkOptions): void;
+    get networkType(): NetworkType;
+    get chain(): GearboxChain;
+    get chainId(): number;
     /**
      * Converts contract call into some human-friendly string
      * This method is safe and should not throw
@@ -111,7 +157,6 @@ export declare class GearboxSDK<const Plugins extends PluginsMap = {}> {
      * @returns true if successful, false if was skipped or failed
      */
     syncState(opts?: SyncStateOptions): Promise<boolean>;
-    get provider(): Provider;
     get currentBlock(): bigint;
     get timestamp(): bigint;
     /**

package/dist/types/sdk/base/BaseContract.d.ts

@@ -1,7 +1,6 @@
 import type { Abi, Address, Client, ContractEventName, ContractFunctionName, DecodeFunctionDataReturnType, EncodeFunctionDataParameters, GetContractReturnType, Hex, Log } from "viem";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { BaseContractStateHuman, ILogger, RawTx } from "../types/index.js";
-import type { IAddressLabeller } from "./IAddressLabeller.js";
 import { SDKConstruct } from "./SDKConstruct.js";
 export interface BaseContractOptions<abi extends Abi | readonly unknown[]> {
     abi: abi;
@@ -56,5 +55,4 @@ export declare abstract class BaseContract<abi extends Abi | readonly unknown[]>
     createRawTx<functionName extends ContractFunctionName<abi> | undefined = undefined>(parameters: Omit<EncodeFunctionDataParameters<abi, functionName>, "abi"> & {
         description?: string;
     }): RawTx;
-    protected get addressLabels(): IAddressLabeller;
 }

package/dist/types/sdk/base/SDKConstruct.d.ts

@@ -1,13 +1,12 @@
 import type { Address, PublicClient } from "viem";
-import type { NetworkType, Provider } from "../chain/index.js";
+import type { NetworkType } from "../chain/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { PluginsMap } from "../plugins/index.js";
 export declare class SDKConstruct<const Plugins extends PluginsMap = {}> {
     #private;
     readonly sdk: GearboxSDK<Plugins>;
     constructor(sdk: GearboxSDK<Plugins>);
-    get provider(): Provider;
-    get network(): NetworkType;
+    get networkType(): NetworkType;
     get client(): PublicClient;
     /**
      * Indicates that contract state needs to be updated

package/dist/types/sdk/chain/index.d.ts

@@ -1,3 +1,2 @@
 export * from "./chains.js";
 export * from "./detectNetwork.js";
-export * from "./Provider.js";

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

@@ -1,5 +1,5 @@
 import type { Address, PublicClient } from "viem";
-import type { NetworkType, Provider } from "../chain/index.js";
+import type { NetworkType } from "../chain/index.js";
 import type { GearboxSDK } from "../GearboxSDK.js";
 import type { ILogger } from "../index.js";
 export declare abstract class BasePlugin<TState extends Record<keyof TState, unknown> = {}> {
@@ -13,7 +13,6 @@ export declare abstract class BasePlugin<TState extends Record<keyof TState, unk
     attach(): Promise<void>;
     syncState(): Promise<void>;
     abstract load(force?: boolean): Promise<TState>;
-    get provider(): Provider;
     get network(): NetworkType;
     get client(): PublicClient;
     protected labelAddress(address: Address): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "9.17.0",
+  "version": "10.0.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",

package/dist/cjs/sdk/chain/Provider.js

@@ -1,86 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var Provider_exports = {};
-__export(Provider_exports, {
-  Provider: () => Provider,
-  createTransportClient: () => createTransportClient
-});
-module.exports = __toCommonJS(Provider_exports);
-var import_viem = require("viem");
-var import_AddressLabeller = require("../base/AddressLabeller.js");
-var import_chains = require("./chains.js");
-function createTransportClient(opts, chain) {
-  const { timeout = 12e4, retryCount } = opts;
-  let transport;
-  if ("client" in opts) {
-    transport = () => ({
-      config: opts.client.transport.config,
-      request: opts.client.transport.request,
-      value: opts.client.transport.value
-    });
-    return [transport, opts.client];
-  }
-  if ("transport" in opts) {
-    transport = opts.transport;
-  } else {
-    const rpcs = opts.rpcURLs.map((url) => (0, import_viem.http)(url, { timeout, retryCount }));
-    transport = rpcs.length > 1 ? (0, import_viem.fallback)(rpcs) : rpcs[0];
-  }
-  return [transport, (0, import_viem.createPublicClient)({ transport, chain })];
-}
-class Provider {
-  chainId;
-  chain;
-  networkType;
-  addressLabels;
-  #transport;
-  #publicClient;
-  constructor(opts) {
-    const { chainId, networkType } = opts;
-    this.chainId = chainId;
-    this.networkType = networkType;
-    this.chain = (0, import_viem.defineChain)({
-      ...import_chains.chains[networkType],
-      id: chainId
-    });
-    [this.#transport, this.#publicClient] = createTransportClient(
-      opts,
-      this.chain
-    );
-    this.addressLabels = new import_AddressLabeller.AddressLabeller();
-  }
-  get transport() {
-    return this.#transport;
-  }
-  set transport(transport) {
-    this.#transport = transport;
-    this.#publicClient = (0, import_viem.createPublicClient)({
-      chain: this.chain,
-      transport: this.#transport
-    });
-  }
-  get publicClient() {
-    return this.#publicClient;
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Provider,
-  createTransportClient
-});

package/dist/esm/sdk/chain/Provider.js

@@ -1,61 +0,0 @@
-import { createPublicClient, defineChain, fallback, http } from "viem";
-import { AddressLabeller } from "../base/AddressLabeller.js";
-import { chains } from "./chains.js";
-function createTransportClient(opts, chain) {
-  const { timeout = 12e4, retryCount } = opts;
-  let transport;
-  if ("client" in opts) {
-    transport = () => ({
-      config: opts.client.transport.config,
-      request: opts.client.transport.request,
-      value: opts.client.transport.value
-    });
-    return [transport, opts.client];
-  }
-  if ("transport" in opts) {
-    transport = opts.transport;
-  } else {
-    const rpcs = opts.rpcURLs.map((url) => http(url, { timeout, retryCount }));
-    transport = rpcs.length > 1 ? fallback(rpcs) : rpcs[0];
-  }
-  return [transport, createPublicClient({ transport, chain })];
-}
-class Provider {
-  chainId;
-  chain;
-  networkType;
-  addressLabels;
-  #transport;
-  #publicClient;
-  constructor(opts) {
-    const { chainId, networkType } = opts;
-    this.chainId = chainId;
-    this.networkType = networkType;
-    this.chain = defineChain({
-      ...chains[networkType],
-      id: chainId
-    });
-    [this.#transport, this.#publicClient] = createTransportClient(
-      opts,
-      this.chain
-    );
-    this.addressLabels = new AddressLabeller();
-  }
-  get transport() {
-    return this.#transport;
-  }
-  set transport(transport) {
-    this.#transport = transport;
-    this.#publicClient = createPublicClient({
-      chain: this.chain,
-      transport: this.#transport
-    });
-  }
-  get publicClient() {
-    return this.#publicClient;
-  }
-}
-export {
-  Provider,
-  createTransportClient
-};

package/dist/types/sdk/chain/Provider.d.ts

@@ -1,51 +0,0 @@
-import type { Chain, PublicClient, Transport } from "viem";
-import type { IAddressLabeller } from "../base/IAddressLabeller.js";
-import type { GearboxChain, NetworkType } from "./chains.js";
-export interface NetworkOptions {
-    /**
-     * Chain Id needs to be set, because we sometimemes use forked testnets with different chain ids
-     */
-    chainId: number;
-    /**
-     * NetworkType needs to be set, because we sometimemes use forked testnets with different chain ids
-     */
-    networkType: NetworkType;
-}
-export type TransportOptions = {
-    /**
-     * RPC URL (and fallbacks) to use.
-     */
-    rpcURLs: string[];
-} | {
-    /**
-     * Alternatively, can pass viem transport
-     */
-    transport: Transport;
-} | {
-    /**
-     * Alternatively, can pass entire viem client
-     */
-    client: PublicClient;
-};
-export interface ConnectionOptions {
-    /**
-     * RPC client timeout in milliseconds
-     */
-    timeout?: number;
-    /**
-     * Retry count for RPC
-     */
-    retryCount?: number;
-}
-export declare function createTransportClient(opts: TransportOptions & ConnectionOptions, chain?: Chain): [Transport, PublicClient];
-export declare class Provider {
-    #private;
-    readonly chainId: number;
-    readonly chain: GearboxChain;
-    readonly networkType: NetworkType;
-    readonly addressLabels: IAddressLabeller;
-    constructor(opts: NetworkOptions & TransportOptions & ConnectionOptions);
-    get transport(): Transport;
-    set transport(transport: Transport);
-    get publicClient(): PublicClient;
-}