feat: add state as json

Author: doomsower

src/sdk/GearboxSDK.ts

@@ -25,7 +25,12 @@ import {
 import { MarketRegister } from "./market/MarketRegister";
 import { PriceFeedRegister } from "./market/pricefeeds";
 import { RouterV3Contract } from "./router";
-import type { GearboxStateHuman, ILogger, MultiCall } from "./types";
+import type {
+  GearboxState,
+  GearboxStateHuman,
+  ILogger,
+  MultiCall,
+} from "./types";
 import { AddressMap, formatBN } from "./utils";
 import { Hooks } from "./utils/internal";
 import { detectNetwork } from "./utils/viem";
@@ -326,6 +331,14 @@ export class GearboxSDK {
     };
   }
 
+  public get state(): GearboxState {
+    return {
+      currentBlock: this.currentBlock,
+      addressProvider: this.addressProvider.state,
+      markets: this.marketRegister.state,
+    };
+  }
+
   public async tvl(): Promise<void> {
     const { tvl, tvlUSD } = await this.marketRegister.tvl();
     this.logger?.info(tvl);

src/sdk/core/address-provider/AbstractAddressProviderContract.ts

@@ -1,16 +1,27 @@
-import type { Abi, Address } from "viem";
+import { type Abi, type Address, stringToHex } from "viem";
 
 import { BaseContract } from "../../base";
+import type { BaseContractOptions } from "../../base/BaseContract";
 import { NO_VERSION } from "../../constants";
+import type { GearboxSDK } from "../../GearboxSDK";
 import type { AddressProviderV3StateHuman } from "../../types";
+import type { AddressProviderState } from "./types";
 
 export default abstract class AbstractAddressProviderContract<
   abi extends Abi | readonly unknown[],
 > extends BaseContract<abi> {
   #addresses: Record<string, Record<number, Address>> = {};
-  #versions: Record<string, Set<number>> = {};
   #latest: Record<string, number> = {};
 
+  constructor(
+    sdk: GearboxSDK,
+    args: BaseContractOptions<abi>,
+    addresses: Record<string, Record<number, Address>> = {},
+  ) {
+    super(sdk, args);
+    this.#addresses = addresses;
+  }
+
   protected setInternalAddress(key: string, address: Address, version: number) {
     if (!this.#addresses[key]) {
       this.#addresses[key] = {};
@@ -20,12 +31,6 @@ export default abstract class AbstractAddressProviderContract<
     if (!this.#latest[key] || version > this.#latest[key]) {
       this.#latest[key] = version;
     }
-
-    if (!this.#versions[key]) {
-      this.#versions[key] = new Set();
-    }
-
-    this.#versions[key].add(version);
   }
 
   public getAddress(contract: string, version = NO_VERSION): Address {
@@ -53,6 +58,18 @@ export default abstract class AbstractAddressProviderContract<
     return this.getAddress(contract, this.#latest[contract]);
   }
 
+  public get state(): AddressProviderState {
+    return {
+      baseParams: {
+        addr: this.address,
+        version: BigInt(this.version),
+        contractType: stringToHex(this.contractType, { size: 32 }),
+        serializedParams: "0x0",
+      },
+      addresses: this.#addresses,
+    };
+  }
+
   public override stateHuman(raw = true): AddressProviderV3StateHuman {
     return {
       ...super.stateHuman(raw),

src/sdk/core/address-provider/AddressProviderV3Contract.ts

@@ -19,13 +19,21 @@ export class AddressProviderContractV3
   extends AbstractAddressProviderContract<abi>
   implements IAddressProviderContract
 {
-  constructor(sdk: GearboxSDK, address: Address) {
-    super(sdk, {
-      addr: address,
-      name: "AddressProviderV3",
-      abi,
-      version: 3_00,
-    });
+  constructor(
+    sdk: GearboxSDK,
+    address: Address,
+    addresses: Record<string, Record<number, Address>> = {},
+  ) {
+    super(
+      sdk,
+      {
+        addr: address,
+        name: "AddressProviderV3",
+        abi,
+        version: 3_00,
+      },
+      addresses,
+    );
   }
 
   public parseFunctionParams(

src/sdk/core/address-provider/AddressProviderV3_1Contract.ts

@@ -18,13 +18,21 @@ export class AddressProviderContractV3_1
   extends AbstractAddressProviderContract<abi>
   implements IAddressProviderContract
 {
-  constructor(sdk: GearboxSDK, address: Address) {
-    super(sdk, {
-      addr: address,
-      name: "AddressProviderV3_1",
-      abi,
-      version: 3_10,
-    });
+  constructor(
+    sdk: GearboxSDK,
+    address: Address,
+    addresses: Record<string, Record<number, Address>> = {},
+  ) {
+    super(
+      sdk,
+      {
+        addr: address,
+        name: "AddressProviderV3_1",
+        abi,
+        version: 3_10,
+      },
+      addresses,
+    );
   }
 
   public parseFunctionParams(

src/sdk/core/address-provider/getAddressProvider.ts

@@ -4,28 +4,41 @@ import { iVersionAbi } from "../../abi";
 import type { GearboxSDK } from "../../GearboxSDK";
 import { AddressProviderContractV3_1 } from "./AddressProviderV3_1Contract";
 import { AddressProviderContractV3 } from "./AddressProviderV3Contract";
-import type { IAddressProviderContract } from "./types";
+import type { AddressProviderState, IAddressProviderContract } from "./types";
+
+export interface GetAddressProviderOptions {
+  version?: number;
+  state?: AddressProviderState;
+}
 
 export async function getAddressProvider(
   sdk: GearboxSDK,
   address: Address,
-  version?: number,
+  options?: GetAddressProviderOptions,
 ): Promise<IAddressProviderContract> {
-  let v = version;
+  const addr = options?.state?.baseParams.addr ?? address;
+  let v = options?.state?.baseParams.version ?? options?.version;
   if (!v) {
     const vv = await sdk.provider.publicClient.readContract({
-      address,
+      address: addr,
       abi: iVersionAbi,
       functionName: "version",
     });
     v = Number(vv);
   }
-
   switch (v) {
     case 3_00:
-      return new AddressProviderContractV3(sdk, address);
+      return new AddressProviderContractV3(
+        sdk,
+        addr,
+        options?.state?.addresses,
+      );
     case 3_10:
-      return new AddressProviderContractV3_1(sdk, address);
+      return new AddressProviderContractV3_1(
+        sdk,
+        addr,
+        options?.state?.addresses,
+      );
     default:
       throw new Error(`Unsupported address provider version: ${v}`);
   }

src/sdk/core/address-provider/types.ts

@@ -1,9 +1,15 @@
 import type { Address } from "viem";
 
-import type { IBaseContract } from "../../base";
+import type { BaseParams, IBaseContract } from "../../base";
 import type { AddressProviderV3StateHuman } from "../../types";
 
+export interface AddressProviderState {
+  baseParams: BaseParams;
+  addresses: Record<string, Record<number, Address>>;
+}
+
 export interface IAddressProviderContract extends IBaseContract {
+  state: AddressProviderState;
   getAddress: (contract: string, version?: number) => Address;
   getLatestVersion: (contract: string) => Address;
   syncState: (blockNumber: bigint) => Promise<void>;

src/sdk/market/MarketRegister.ts

@@ -21,9 +21,15 @@ export class MarketRegister extends SDKConstruct {
    */
   #markets = new AddressMap<MarketFactory>();
 
-  constructor(sdk: GearboxSDK) {
+  constructor(sdk: GearboxSDK, markets?: MarketData[]) {
     super(sdk);
     this.#logger = childLogger("MarketRegister", sdk.logger);
+    for (const data of markets ?? []) {
+      this.#markets.upsert(
+        data.pool.baseParams.addr,
+        new MarketFactory(this.sdk, data),
+      );
+    }
   }
 
   public async loadMarkets(

src/sdk/types/index.ts

@@ -1,4 +1,5 @@
 export type * from "./logger";
+export type * from "./state";
 export type * from "./state-human";
 export type * from "./transactions";
 export type * from "./tvl";

src/sdk/types/state.ts

@@ -0,0 +1,8 @@
+import type { MarketData } from "../base";
+import type { AddressProviderState } from "../core";
+
+export interface GearboxState {
+  currentBlock: bigint;
+  addressProvider: AddressProviderState;
+  markets: MarketData[];
+}