@gearbox-protocol/sdk 4.1.8 → 4.2.0-next.1

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

@@ -11,6 +11,10 @@ import { type PluginInstances, type PluginMap } from "./plugins/index.js";
 import { type IRouterContract } from "./router/index.js";
 import type { GearboxState, GearboxStateHuman, ILogger, MultiCall } from "./types/index.js";
 import { AddressMap } from "./utils/index.js";
+/**
+ * State version, checked duryng hydration
+ */
+export declare const STATE_VERSION = 1;
 export interface SDKOptions<Plugins extends PluginMap = {}> {
     /**
      * If not set, address provider address is determinted automatically from networkType
@@ -51,6 +55,7 @@ export interface SDKOptions<Plugins extends PluginMap = {}> {
      */
     logger?: ILogger;
 }
+export type HydrateOptions = Pick<SDKOptions, "ignoreUpdateablePrices" | "logger" | "redstoneGateways" | "redstoneHistoricTimestamp" | "strictContractTypes">;
 export interface SyncStateOptions {
     blockNumber: bigint;
     timestamp: bigint;
@@ -87,6 +92,7 @@ export declare class GearboxSDK<Plugins extends PluginMap = {}> {
     addHook: <K extends "syncState">(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
     removeHook: <K extends "syncState">(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
     static attach<Plugins extends PluginMap>(options: SDKOptions<Plugins> & Partial<NetworkOptions> & ConnectionOptions & TransportOptions): Promise<GearboxSDK<Plugins>>;
+    static hydrate(options: HydrateOptions & ConnectionOptions & TransportOptions, state: GearboxState): GearboxSDK;
     private constructor();
     /**
      * Reattach SDK with the same config as before, without re-creating instance. Will load all state from scratch
@@ -147,8 +153,8 @@ export declare class GearboxSDK<Plugins extends PluginMap = {}> {
     get timestamp(): bigint;
     get gear(): Address | undefined;
     get addressProvider(): IAddressProviderContract;
-    get botListContract(): BotListContract;
-    get gearStakingContract(): GearStakingContract;
+    get botListContract(): BotListContract | undefined;
+    get gearStakingContract(): GearStakingContract | undefined;
     get marketRegister(): MarketRegister;
     /**
      * Returns router contract that will work for given credit manager or credit facade

package/dist/types/sdk/core/address-provider/{AddressProviderV3Contract.d.ts → AddressProviderV300Contract.d.ts}

@@ -88,8 +88,8 @@ declare const abi: readonly [{
     readonly anonymous: false;
 }];
 type abi = typeof abi;
-export declare class AddressProviderContractV3 extends AbstractAddressProviderContract<abi> implements IAddressProviderContract {
-    constructor(sdk: GearboxSDK, address: Address, addresses?: Record<string, Record<number, Address>>);
+export declare class AddressProviderV300Contract extends AbstractAddressProviderContract<abi> implements IAddressProviderContract {
+    constructor(sdk: GearboxSDK, address: Address, version: number, addresses?: Record<string, Record<number, Address>>);
     protected parseFunctionParams(params: DecodeFunctionDataReturnType<abi>): Array<string> | undefined;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     syncState(blockNumber?: bigint): Promise<void>;

package/dist/types/sdk/core/address-provider/{AddressProviderV3_1Contract.d.ts → AddressProviderV310Contract.d.ts}

@@ -253,8 +253,8 @@ declare const abi: readonly [{
     readonly name: "ZeroAddressException";
 }];
 type abi = typeof abi;
-export declare class AddressProviderContractV3_1 extends AbstractAddressProviderContract<abi> implements IAddressProviderContract {
-    constructor(sdk: GearboxSDK, address: Address, addresses?: Record<string, Record<number, Address>>);
+export declare class AddressProviderV310Contract extends AbstractAddressProviderContract<abi> implements IAddressProviderContract {
+    constructor(sdk: GearboxSDK, address: Address, version: number, addresses?: Record<string, Record<number, Address>>);
     protected parseFunctionParams(params: DecodeFunctionDataReturnType<abi>): Array<string> | undefined;
     processLog(log: Log<bigint, number, false, undefined, undefined, abi, ContractEventName<abi>>): void;
     syncState(blockNumber?: bigint): Promise<void>;

package/dist/types/sdk/core/address-provider/createAddressProvider.d.ts

@@ -1,8 +1,5 @@
 import type { Address } from "viem";
 import type { GearboxSDK } from "../../GearboxSDK.js";
 import type { AddressProviderState, IAddressProviderContract } from "./types.js";
-export interface CreateAddressProviderOptions {
-    version?: number;
-    state?: AddressProviderState;
-}
-export declare function createAddressProvider(sdk: GearboxSDK, address: Address, options?: CreateAddressProviderOptions): Promise<IAddressProviderContract>;
+export declare function createAddressProvider(sdk: GearboxSDK, address: Address): Promise<IAddressProviderContract>;
+export declare function hydrateAddressProvider(sdk: GearboxSDK, state: AddressProviderState): IAddressProviderContract;

package/dist/types/sdk/core/address-provider/index.d.ts

@@ -1,4 +1,4 @@
-export * from "./AddressProviderV3_1Contract.js";
-export * from "./AddressProviderV3Contract.js";
+export * from "./AddressProviderV300Contract.js";
+export * from "./AddressProviderV310Contract.js";
 export * from "./createAddressProvider.js";
 export * from "./types.js";

package/dist/types/sdk/market/MarketRegister.d.ts

@@ -10,7 +10,8 @@ import { MarketSuite } from "./MarketSuite.js";
 import type { PoolSuite } from "./pool/index.js";
 export declare class MarketRegister extends SDKConstruct {
     #private;
-    constructor(sdk: GearboxSDK, markets?: MarketData[]);
+    constructor(sdk: GearboxSDK);
+    hydrate(state: MarketData[]): void;
     loadMarkets(marketConfigurators: Address[], ignoreUpdateablePrices?: boolean): Promise<void>;
     get marketFilter(): {
         configurators: readonly `0x${string}`[];

package/dist/types/sdk/types/state-human.d.ts

@@ -16,8 +16,8 @@ export interface GearStakingV3StateHuman extends BaseContractStateHuman {
 export type BotListStateHuman = BaseContractStateHuman;
 export interface CoreStateHuman {
     addressProviderV3: AddressProviderV3StateHuman;
-    botList: BotListStateHuman;
-    gearStakingV3: GearStakingV3StateHuman;
+    botList?: BotListStateHuman;
+    gearStakingV3?: GearStakingV3StateHuman;
 }
 export type PriceFeedStateHuman = BoundedOracleStateHuman | AssetPriceFeedStateHuman | RedstonePriceFeedStateHuman | LPPriceFeedStateHuman | BalancerWeightedPriceFeedStateHuman;
 export interface BasePriceFeedStateHuman extends BaseContractStateHuman {

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

@@ -1,7 +1,16 @@
 import type { MarketData } from "../base/index.js";
+import type { NetworkType } from "../chain/chains.js";
 import type { AddressProviderState } from "../core/index.js";
 export interface GearboxState {
+    /**
+     * State version, checked duryng hydration
+     * This is not the same as @gearbox-protocol/sdk package version
+     */
+    version: number;
+    network: NetworkType;
+    chainId: number;
     currentBlock: bigint;
+    timestamp: bigint;
     addressProvider: AddressProviderState;
     markets: MarketData[];
 }

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

@@ -10,3 +10,4 @@ export * from "./json.js";
 export * from "./mappers.js";
 export * from "./retry.js";
 export * from "./toAddress.js";
+export * from "./version.js";

package/dist/types/sdk/utils/version.d.ts

@@ -0,0 +1,2 @@
+export declare function isV300(version: number): boolean;
+export declare function isV310(version: number): boolean;

package/package.json

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

package/dist/cjs/dev/setLTZero.js

@@ -1,124 +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 setLTZero_exports = {};
-__export(setLTZero_exports, {
-  setLTZero: () => setLTZero
-});
-module.exports = __toCommonJS(setLTZero_exports);
-var import_viem = require("viem");
-var import_v300 = require("../abi/v300.js");
-var import_sdk = require("../sdk/index.js");
-var import_abi = require("./abi.js");
-async function setLTZero(anvil, cm, logger) {
-  const aclAddr = await anvil.readContract({
-    address: cm.creditConfigurator,
-    abi: import_abi.iaclTraitAbi,
-    functionName: "acl"
-  });
-  const configuratorAddr = await anvil.readContract({
-    address: aclAddr,
-    abi: import_abi.iOwnableAbi,
-    functionName: "owner"
-  });
-  await anvil.impersonateAccount({
-    address: configuratorAddr
-  });
-  await anvil.setBalance({
-    address: configuratorAddr,
-    value: (0, import_viem.parseEther)("100")
-  });
-  let hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.creditConfigurator,
-    account: configuratorAddr,
-    abi: import_v300.iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      cm.feeInterest,
-      cm.liquidationDiscount - 1,
-      Number(import_sdk.PERCENTAGE_FACTOR) - cm.liquidationDiscount,
-      cm.feeLiquidationExpired,
-      cm.liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setFees part 2`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.creditConfigurator,
-    account: configuratorAddr,
-    abi: import_v300.iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      cm.feeInterest,
-      cm.feeLiquidation,
-      Number(import_sdk.PERCENTAGE_FACTOR) - cm.liquidationDiscount,
-      cm.feeLiquidationExpired,
-      cm.liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setFees done`);
-  await anvil.impersonateAccount({
-    address: cm.creditConfigurator
-  });
-  await anvil.setBalance({
-    address: cm.creditConfigurator,
-    value: (0, import_viem.parseEther)("100")
-  });
-  logger?.debug(
-    `[${cm.name}] impresonating creditConfigurator ${cm.creditConfigurator}`
-  );
-  logger?.debug(`[${cm.name}] setting liquidation threshold`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.baseParams.addr,
-    account: cm.creditConfigurator,
-    abi: import_v300.iCreditManagerV300Abi,
-    functionName: "setCollateralTokenData",
-    args: [cm.underlying, 1, 1, Number(2n ** 40n - 1n), 0]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setting configurator ${cm.creditConfigurator}`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.baseParams.addr,
-    account: cm.creditConfigurator,
-    abi: import_v300.iCreditManagerV300Abi,
-    functionName: "setCreditConfigurator",
-    args: [cm.creditConfigurator]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] done`);
-  await anvil.stopImpersonatingAccount({
-    address: cm.creditConfigurator
-  });
-  await anvil.stopImpersonatingAccount({ address: configuratorAddr });
-  const lt = await anvil.readContract({
-    address: cm.baseParams.addr,
-    abi: import_v300.iCreditManagerV300Abi,
-    functionName: "liquidationThresholds",
-    args: [cm.underlying]
-  });
-  logger?.debug(`[${cm.name}] underlying lt: ${lt}`);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  setLTZero
-});

package/dist/cjs/dev/setLTs.js

@@ -1,73 +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 setLTs_exports = {};
-__export(setLTs_exports, {
-  setLTs: () => setLTs
-});
-module.exports = __toCommonJS(setLTs_exports);
-var import_viem = require("viem");
-var import_v300 = require("../abi/v300.js");
-var import_v310 = require("../abi/v310.js");
-var import_abi = require("./abi.js");
-async function setLTs(anvil, cm, newLTs, logger) {
-  const aclAddr = await anvil.readContract({
-    address: cm.creditConfigurator,
-    abi: import_abi.iaclTraitAbi,
-    functionName: "acl"
-  });
-  const configuratorAddr = await anvil.readContract({
-    address: aclAddr,
-    abi: import_abi.iOwnableAbi,
-    functionName: "owner"
-  });
-  await anvil.impersonateAccount({
-    address: configuratorAddr
-  });
-  await anvil.setBalance({
-    address: configuratorAddr,
-    value: (0, import_viem.parseEther)("100")
-  });
-  for (const [t, lt] of Object.entries(newLTs)) {
-    try {
-      await anvil.writeContract({
-        chain: anvil.chain,
-        address: cm.creditConfigurator,
-        account: configuratorAddr,
-        abi: import_v300.iCreditConfiguratorV300Abi,
-        functionName: "setLiquidationThreshold",
-        args: [t, lt]
-      });
-      const newLT = await anvil.readContract({
-        address: cm.address,
-        abi: import_v310.iCreditManagerV310Abi,
-        functionName: "liquidationThresholds",
-        args: [t]
-      });
-      logger?.debug(`set ${t} LT to ${newLT}`);
-    } catch {
-    }
-  }
-  await anvil.stopImpersonatingAccount({
-    address: configuratorAddr
-  });
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  setLTs
-});

package/dist/esm/dev/setLTZero.js

@@ -1,103 +0,0 @@
-import { parseEther } from "viem";
-import {
-  iCreditConfiguratorV300Abi,
-  iCreditManagerV300Abi
-} from "../abi/v300.js";
-import { PERCENTAGE_FACTOR } from "../sdk/index.js";
-import { iaclTraitAbi, iOwnableAbi } from "./abi.js";
-async function setLTZero(anvil, cm, logger) {
-  const aclAddr = await anvil.readContract({
-    address: cm.creditConfigurator,
-    abi: iaclTraitAbi,
-    functionName: "acl"
-  });
-  const configuratorAddr = await anvil.readContract({
-    address: aclAddr,
-    abi: iOwnableAbi,
-    functionName: "owner"
-  });
-  await anvil.impersonateAccount({
-    address: configuratorAddr
-  });
-  await anvil.setBalance({
-    address: configuratorAddr,
-    value: parseEther("100")
-  });
-  let hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.creditConfigurator,
-    account: configuratorAddr,
-    abi: iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      cm.feeInterest,
-      cm.liquidationDiscount - 1,
-      Number(PERCENTAGE_FACTOR) - cm.liquidationDiscount,
-      cm.feeLiquidationExpired,
-      cm.liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setFees part 2`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.creditConfigurator,
-    account: configuratorAddr,
-    abi: iCreditConfiguratorV300Abi,
-    functionName: "setFees",
-    args: [
-      cm.feeInterest,
-      cm.feeLiquidation,
-      Number(PERCENTAGE_FACTOR) - cm.liquidationDiscount,
-      cm.feeLiquidationExpired,
-      cm.liquidationDiscountExpired
-    ]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setFees done`);
-  await anvil.impersonateAccount({
-    address: cm.creditConfigurator
-  });
-  await anvil.setBalance({
-    address: cm.creditConfigurator,
-    value: parseEther("100")
-  });
-  logger?.debug(
-    `[${cm.name}] impresonating creditConfigurator ${cm.creditConfigurator}`
-  );
-  logger?.debug(`[${cm.name}] setting liquidation threshold`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.baseParams.addr,
-    account: cm.creditConfigurator,
-    abi: iCreditManagerV300Abi,
-    functionName: "setCollateralTokenData",
-    args: [cm.underlying, 1, 1, Number(2n ** 40n - 1n), 0]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] setting configurator ${cm.creditConfigurator}`);
-  hash = await anvil.writeContract({
-    chain: anvil.chain,
-    address: cm.baseParams.addr,
-    account: cm.creditConfigurator,
-    abi: iCreditManagerV300Abi,
-    functionName: "setCreditConfigurator",
-    args: [cm.creditConfigurator]
-  });
-  await anvil.waitForTransactionReceipt({ hash });
-  logger?.debug(`[${cm.name}] done`);
-  await anvil.stopImpersonatingAccount({
-    address: cm.creditConfigurator
-  });
-  await anvil.stopImpersonatingAccount({ address: configuratorAddr });
-  const lt = await anvil.readContract({
-    address: cm.baseParams.addr,
-    abi: iCreditManagerV300Abi,
-    functionName: "liquidationThresholds",
-    args: [cm.underlying]
-  });
-  logger?.debug(`[${cm.name}] underlying lt: ${lt}`);
-}
-export {
-  setLTZero
-};

package/dist/esm/dev/setLTs.js

@@ -1,49 +0,0 @@
-import { parseEther } from "viem";
-import { iCreditConfiguratorV300Abi } from "../abi/v300.js";
-import { iCreditManagerV310Abi } from "../abi/v310.js";
-import { iaclTraitAbi, iOwnableAbi } from "./abi.js";
-async function setLTs(anvil, cm, newLTs, logger) {
-  const aclAddr = await anvil.readContract({
-    address: cm.creditConfigurator,
-    abi: iaclTraitAbi,
-    functionName: "acl"
-  });
-  const configuratorAddr = await anvil.readContract({
-    address: aclAddr,
-    abi: iOwnableAbi,
-    functionName: "owner"
-  });
-  await anvil.impersonateAccount({
-    address: configuratorAddr
-  });
-  await anvil.setBalance({
-    address: configuratorAddr,
-    value: parseEther("100")
-  });
-  for (const [t, lt] of Object.entries(newLTs)) {
-    try {
-      await anvil.writeContract({
-        chain: anvil.chain,
-        address: cm.creditConfigurator,
-        account: configuratorAddr,
-        abi: iCreditConfiguratorV300Abi,
-        functionName: "setLiquidationThreshold",
-        args: [t, lt]
-      });
-      const newLT = await anvil.readContract({
-        address: cm.address,
-        abi: iCreditManagerV310Abi,
-        functionName: "liquidationThresholds",
-        args: [t]
-      });
-      logger?.debug(`set ${t} LT to ${newLT}`);
-    } catch {
-    }
-  }
-  await anvil.stopImpersonatingAccount({
-    address: configuratorAddr
-  });
-}
-export {
-  setLTs
-};

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

@@ -1,5 +0,0 @@
-import type { CreditManagerState, ILogger } from "../sdk/index.js";
-import type { AnvilClient } from "./createAnvilClient.js";
-type ZeroLTCMSlice = Pick<CreditManagerState, "creditConfigurator" | "feeInterest" | "liquidationDiscount" | "feeLiquidationExpired" | "liquidationDiscountExpired" | "feeLiquidation" | "name" | "underlying" | "baseParams">;
-export declare function setLTZero(anvil: AnvilClient, cm: ZeroLTCMSlice, logger?: ILogger): Promise<void>;
-export {};

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

@@ -1,14 +0,0 @@
-import type { Address } from "viem";
-import type { ILogger } from "../sdk/index.js";
-import type { AnvilClient } from "./createAnvilClient.js";
-export interface SetLTsCMSlice {
-    creditConfigurator: Address;
-    address: Address;
-}
-/**
- * Helper function to set liquidation thresholds on credit manager via anvil impersonation
- * @param sdk
- * @param cm
- * @param newLTs
- */
-export declare function setLTs(anvil: AnvilClient, cm: SetLTsCMSlice, newLTs: Record<Address, number>, logger?: ILogger): Promise<void>;