fix: remove static BaseContract methods

Author: doomsower

src/GearboxSDK.ts

@@ -1,9 +1,10 @@
 import type { NetworkType } from "@gearbox-protocol/sdk-gov";
 import { formatBN, TIMELOCK } from "@gearbox-protocol/sdk-gov";
 import { EventEmitter } from "eventemitter3";
-import { type Address, http } from "viem";
+import type { Address, Hex, Log } from "viem";
+import { http } from "viem";
 
-import { BaseContract } from "./base";
+import type { BaseContract } from "./base";
 import { Provider } from "./chain";
 import {
   ADDRESS_PROVIDER,
@@ -22,7 +23,7 @@ import { PriceFeedRegister } from "./market/pricefeeds";
 import { RouterV3Contract } from "./router";
 import type { SDKEventsMap } from "./SDKEvents";
 import type { GearboxState } from "./state/state";
-import type { ILogger } from "./types";
+import type { ILogger, MultiCall } from "./types";
 import { AddressMap } from "./utils";
 import { createAnvilClient } from "./utils/viem";
 
@@ -88,8 +89,14 @@ export class GearboxSDK extends EventEmitter<SDKEventsMap> {
   public readonly interestRateModels = new AddressMap<
     BaseContract<readonly unknown[]>
   >();
-
+  /**
+   * All price feeds known to sdk, without oracle-related data (stalenessPeriod, main/reserve, etc.)
+   */
   public readonly priceFeeds: PriceFeedRegister;
+  /**
+   * All contracts known to sdk
+   */
+  public readonly contracts = new AddressMap<BaseContract<any>>();
 
   public static async attach(options: SDKAttachOptions): Promise<GearboxSDK> {
     const { rpcURL, timeout, logger } = options;
@@ -174,6 +181,36 @@ export class GearboxSDK extends EventEmitter<SDKEventsMap> {
     return this;
   }
 
+  public parseLogs(logs: Array<Log>): void {
+    logs.forEach(log => {
+      const contract = this.contracts.get(log.address);
+      contract?.parseLog(log);
+    });
+  }
+
+  /**
+   * Converts contract call into some human-friendly string
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  public parseFunctionData(address: Address, calldata: Hex): string {
+    const contract = this.contracts.mustGet(address);
+    return contract.parseFunctionData(calldata);
+  }
+
+  /**
+   * Converts multicalls into some human-friendly strings
+   * @param address
+   * @param calldata
+   * @returns
+   */
+  public parseMultiCall(calls: MultiCall[]): string[] {
+    return calls.map(call =>
+      this.parseFunctionData(call.target, call.callData),
+    );
+  }
+
   public async updateBlock(): Promise<void> {
     const block = await this.provider.publicClient.getBlock({
       blockTag: "latest",
@@ -215,7 +252,7 @@ export class GearboxSDK extends EventEmitter<SDKEventsMap> {
       toBlock: BigInt(toBlock),
     });
 
-    BaseContract.parseLogs(events);
+    this.parseLogs(events);
 
     for (const pf of this.marketRegister.getPoolFactories()) {
       if (pf.poolContract.hasOperation) {

src/base/BaseContract.ts

@@ -16,7 +16,7 @@ import { iVersionAbi } from "../abi";
 import { ADDRESS_0X0 } from "../constants";
 import type { GearboxSDK } from "../GearboxSDK";
 import type { BaseContractState } from "../state";
-import type { ILogger, MultiCall, RawTx } from "../types";
+import type { ILogger, RawTx } from "../types";
 import { childLogger, createRawTx, json_stringify } from "../utils";
 import type { IAddressLabeller } from "./IAddressLabeller";
 import { SDKConstruct } from "./SDKConstruct";
@@ -36,8 +36,6 @@ export abstract class BaseContract<
   public readonly abi: abi;
   public readonly logger?: ILogger;
 
-  protected static register: Record<Address, BaseContract<any>> = {};
-
   version: number;
   contractType: string;
   #name: string;
@@ -55,12 +53,14 @@ export abstract class BaseContract<
         public: sdk.provider.publicClient,
       },
     });
-    this.#name = args.name || args.contractType || this.#address;
+    this.name = this.#name = args.name || args.contractType || this.#address;
     this.version = args.version || 0;
     this.contractType = args.contractType || "";
-    this.logger = childLogger(this.#name, sdk.logger);
+    this.logger = childLogger(this.name, sdk.logger);
 
-    BaseContract.register[this.#address.toLowerCase() as Address] = this;
+    // register contract by address
+    // TODO: I don't like it, this is side-effect. why do we even need this?
+    sdk.contracts.upsert(this.address, this);
   }
 
   get address(): Address {
@@ -99,19 +99,13 @@ export abstract class BaseContract<
     };
   }
 
-  public static parseLogs(logs: Array<Log>): void {
-    logs.forEach(log => {
-      const contract =
-        BaseContract.register[log.address.toLowerCase() as Address];
-      if (contract) {
-        contract.parseLog(log);
-      }
-    });
-  }
+  /**
+   * Updates contract's internal state from event
+   * @param _log
+   */
+  public parseLog(_log: Log): void {}
 
-  protected parseLog(_log: Log) {}
-
-  protected parseFunctionData(calldata: Hex): string {
+  public parseFunctionData(calldata: Hex): string {
     const decoded = decodeFunctionData({
       abi: this.abi,
       data: calldata,
@@ -151,19 +145,6 @@ export abstract class BaseContract<
     return undefined;
   }
 
-  public static parseMultiCall(calls: Array<MultiCall>): Array<string> {
-    return calls.map(call => BaseContract.parse(call.target, call.callData));
-  }
-
-  public static parse(address: Address, calldata: Hex): string {
-    const contract = BaseContract.register[address.toLowerCase() as Address];
-    if (contract) {
-      return contract.parseFunctionData(calldata);
-    } else {
-      throw new Error(`Contract not found: ${address}`);
-    }
-  }
-
   async getVersion(): Promise<number> {
     this.version = Number(
       await this.sdk.provider.publicClient.readContract({

src/core/AddressProviderV3_1Contract.ts

@@ -22,7 +22,7 @@ export class AddressProviderContractV3_1 extends BaseContract<abi> {
     });
   }
 
-  parseFunctionParams(
+  public parseFunctionParams(
     params: DecodeFunctionDataReturnType<abi>,
   ): Array<string> | undefined {
     switch (params.functionName) {
@@ -100,7 +100,7 @@ export class AddressProviderContractV3_1 extends BaseContract<abi> {
     };
   }
 
-  protected parseLog(log: Log): void {
+  public override parseLog(log: Log): void {
     const parsedLog = parseEventLogs({
       abi: this.abi,
       logs: [log],

src/core/BotListV3Contract.ts

@@ -16,7 +16,7 @@ export class BotListContract extends BaseContract<abi> {
     super(sdk, { address, name: "BotListV3", abi: botListV3Abi });
   }
 
-  parseFunctionParams(
+  public parseFunctionParams(
     params: DecodeFunctionDataReturnType<abi>,
   ): Array<string> | undefined {
     switch (params.functionName) {
@@ -37,7 +37,7 @@ export class BotListContract extends BaseContract<abi> {
     }
   }
 
-  async fetchState(toBlock: bigint) {
+  public async fetchState(toBlock: bigint) {
     const logs = await this.provider.publicClient.getContractEvents({
       address: this.address,
       abi: this.abi,
@@ -48,7 +48,7 @@ export class BotListContract extends BaseContract<abi> {
     logs.forEach(e => this.parseLog(e));
   }
 
-  protected parseLog(log: Log): void {
+  public override parseLog(log: Log): void {
     const parsedLog = parseEventLogs({
       abi: this.abi,
       logs: [log],

src/market/CreditFacadeContract.ts

@@ -67,23 +67,23 @@ export class CreditFacadeContract extends BaseContract<abi> {
         const [onBehalfOf, calls, referralCode] = params.args;
         return [
           this.addressLabels.get(onBehalfOf),
-          BaseContract.parseMultiCall([...calls]).join(","),
+          this.sdk.parseMultiCall([...calls]).join(","),
           `${referralCode}`,
         ];
       }
       case "closeCreditAccount": {
         const [creditAccount, calls] = params.args;
         return [
           this.addressLabels.get(creditAccount),
-          BaseContract.parseMultiCall([...calls]).join(","),
+          this.sdk.parseMultiCall([...calls]).join(","),
         ];
       }
       case "liquidateCreditAccount": {
         const [creditAccount, to, calls] = params.args;
         return [
           this.addressLabels.get(creditAccount),
           this.addressLabels.get(to),
-          BaseContract.parseMultiCall([...calls]).join(","),
+          this.sdk.parseMultiCall([...calls]).join(","),
         ];
       }
       case "setBotPermissions": {

src/market/CreditManagerContract.ts

@@ -38,13 +38,11 @@ export class CreditManagerContract extends BaseContract<abi> {
         collateralTokens.map((t, i) => [t, liquidationThresholds[i]]),
       ),
 
-      feeInterest: Number(creditManager.feeInterest),
-      feeLiquidation: Number(creditManager.feeLiquidation),
-      liquidationDiscount: Number(creditManager.liquidationDiscount),
-      feeLiquidationExpired: Number(creditManager.feeLiquidationExpired),
-      liquidationDiscountExpired: Number(
-        creditManager.liquidationDiscountExpired,
-      ),
+      feeInterest: creditManager.feeInterest,
+      feeLiquidation: creditManager.feeLiquidation,
+      liquidationDiscount: creditManager.liquidationDiscount,
+      feeLiquidationExpired: creditManager.feeLiquidationExpired,
+      liquidationDiscountExpired: creditManager.liquidationDiscountExpired,
       quotedTokensMask: 0n,
       contractsToAdapters: {}, // cmd.adapters.reduce(
       //   (acc, adapter) => {

src/market/PoolContract.ts

@@ -14,7 +14,7 @@ export class PoolContract extends BaseContract<typeof abi> {
   state: PoolState;
 
   // Contracts
-  hasOperation = false;
+  public hasOperation = false;
 
   constructor(sdk: GearboxSDK, data: PoolData) {
     super(sdk, {
@@ -49,9 +49,7 @@ export class PoolContract extends BaseContract<typeof abi> {
     };
   }
 
-  // LOGS
-
-  protected parseLog(log: Log): void {
+  public override parseLog(log: Log): void {
     const parsedLog = parseEventLogs({
       abi: this.abi,
       logs: [log],
@@ -70,7 +68,7 @@ export class PoolContract extends BaseContract<typeof abi> {
     }
   }
 
-  parseFunctionParams(
+  public parseFunctionParams(
     params: DecodeFunctionDataReturnType<typeof abi>,
   ): Array<string> | undefined {
     switch (params.functionName) {

src/market/pricefeeds/PriceFeedsRegister.ts

@@ -52,7 +52,6 @@ export class PriceFeedRegister extends SDKConstruct {
 
   /**
    * Returns RawTxs to update price feeds
-   * This method is static because price feeds may belong to different markets with different PriceFeedFactory instances
    * @param priceFeeds top-level price feeds, actual updatable price feeds will be derived. If not provided will use all price feeds that are attached
    * @returns
    */

tsconfig.json

@@ -8,7 +8,8 @@
     "skipLibCheck": true,
     "lib": ["ESNext"],
     "declaration": true,
-    "removeComments": false
+    "removeComments": false,
+    "resolveJsonModule": true
   },
   "include": ["src", "scripts", "tsup.config.ts"],
   "exclude": ["dist", "node_modules"]