fix: simplify price feed constructors a bit

Author: doomsower

.gitignore

@@ -4,6 +4,7 @@
 .DS_Store
 /forge-out/
 /cache/
+/dist/
 .env
 .eslint.local.json
 example-state.json

src/base/BaseContract.ts

@@ -28,28 +28,32 @@ import { SDKConstruct } from "./SDKConstruct";
 
 export interface BaseContractOptions<abi extends Abi | readonly unknown[]> {
   abi: abi;
-  address: Address;
+  addr: Address;
   name?: string;
-  version?: number;
+  version?: number | bigint;
   contractType?: string;
 }
 
 export abstract class BaseContract<
   abi extends Abi | readonly unknown[],
 > extends SDKConstruct {
-  contract: GetContractReturnType<abi, { public: Client }, Address>;
+  public readonly contract: GetContractReturnType<
+    abi,
+    { public: Client },
+    Address
+  >;
   public readonly abi: abi;
   public readonly logger?: ILogger;
+  public readonly contractType: string;
+  public version: number;
 
-  version: number;
-  contractType: string;
   #name: string;
   #address: Address;
 
   constructor(sdk: GearboxSDK, args: BaseContractOptions<abi>) {
     super(sdk);
     this.abi = args.abi;
-    this.#address = args.address.toLowerCase() as Address;
+    this.#address = args.addr;
 
     this.contract = getContract({
       address: this.address,
@@ -58,7 +62,7 @@ export abstract class BaseContract<
         public: sdk.provider.publicClient,
       },
     });
-    this.version = args.version || 0;
+    this.version = Number(args.version || 0);
     this.contractType = args.contractType ?? "";
     if (isHex(this.contractType)) {
       this.contractType = bytes32ToString(this.contractType);
@@ -71,35 +75,35 @@ export abstract class BaseContract<
     sdk.contracts.upsert(this.address, this);
   }
 
-  get address(): Address {
+  public get address(): Address {
     return this.#address;
   }
 
-  set address(address: Address) {
+  public set address(address: Address) {
     if (this.#address !== ADDRESS_0X0) {
       throw new Error(`Address can't be changed, currently: ${this.#address}`);
     }
     this.#address = address;
     this.addressLabels.set(address, this.#name);
   }
 
-  test_setAddress(address: Address) {
+  public test_setAddress(address: Address) {
     this.#address = address;
     this.addressLabels.set(address, this.#name);
   }
 
-  get name(): string {
+  public get name(): string {
     return this.#name;
   }
 
-  set name(name: string) {
+  public set name(name: string) {
     this.#name = name;
     if (this.#address !== ADDRESS_0X0) {
       this.addressLabels.set(this.#address, name);
     }
   }
 
-  get contractData(): BaseContractState {
+  public get contractData(): BaseContractState {
     return {
       address: this.address,
       version: this.version,
@@ -113,6 +117,11 @@ export abstract class BaseContract<
    */
   public parseLog(_log: Log): void {}
 
+  /**
+   * Converts contract calldata to some human-friendly string
+   * @param calldata
+   * @returns
+   */
   public parseFunctionData(calldata: Hex): string {
     const decoded = decodeFunctionData({
       abi: this.abi,
@@ -147,13 +156,13 @@ export abstract class BaseContract<
     return `${this.name}.${decoded.functionName}({${paramsHuman.join(", ")}})`;
   }
 
-  parseFunctionParams(
+  public parseFunctionParams(
     _params: DecodeFunctionDataReturnType<abi>,
   ): Array<string> | undefined {
     return undefined;
   }
 
-  async getVersion(): Promise<number> {
+  public async getVersion(): Promise<number> {
     this.version = Number(
       await this.sdk.provider.publicClient.readContract({
         abi: iVersionAbi,

src/core/AddressProviderV3_1Contract.ts

@@ -16,7 +16,7 @@ export class AddressProviderContractV3_1 extends BaseContract<abi> {
 
   constructor(sdk: GearboxSDK, address: Address) {
     super(sdk, {
-      address,
+      addr: address,
       name: "AddressProviderV3",
       abi: iAddressProviderV3_1Abi,
     });

src/core/BotListV3Contract.ts

@@ -13,7 +13,7 @@ export class BotListContract extends BaseContract<abi> {
   approvedCreditManagers: Set<Address> = new Set();
 
   constructor(sdk: GearboxSDK, address: Address) {
-    super(sdk, { address, name: "BotListV3", abi: botListV3Abi });
+    super(sdk, { addr: address, name: "BotListV3", abi: botListV3Abi });
   }
 
   public parseFunctionParams(

src/core/GearStakingV3Contract.ts

@@ -10,7 +10,7 @@ type abi = typeof gearStakingV3Abi;
 
 export class GearStakingContract extends BaseContract<abi> {
   constructor(sdk: GearboxSDK, address: Address) {
-    super(sdk, { address, name: "GearStakingV3", abi: gearStakingV3Abi });
+    super(sdk, { addr: address, name: "GearStakingV3", abi: gearStakingV3Abi });
   }
 
   parseFunctionParams(

src/market/CreditConfiguratorContract.ts

@@ -19,9 +19,7 @@ export class CreditConfiguratorContract extends BaseContract<abi> {
     emergencyLiquidators: readonly Address[],
   ) {
     super(sdk, {
-      address: creditConfigurator.baseParams.addr,
-      contractType: creditConfigurator.baseParams.contractType,
-      version: Number(creditConfigurator.baseParams.version),
+      ...creditConfigurator.baseParams,
       name: `CreditConfigurator(${creditManager.name})`,
       abi: creditConfiguratorV3Abi,
     });

src/market/CreditFacadeContract.ts

@@ -17,9 +17,7 @@ export class CreditFacadeContract extends BaseContract<abi> {
     { creditFacade, creditManager }: CreditManagerData,
   ) {
     super(sdk, {
-      address: creditFacade.baseParams.addr,
-      version: Number(creditFacade.baseParams.version),
-      contractType: creditFacade.baseParams.contractType,
+      ...creditFacade.baseParams,
       name: `CreditFacadeV3(${creditManager.name})`,
       abi: creditFacadeV3Abi,
     });

src/market/CreditManagerContract.ts

@@ -17,9 +17,7 @@ export class CreditManagerContract extends BaseContract<abi> {
     pool: PoolData,
   ) {
     super(sdk, {
-      address: creditManager.baseParams.addr,
-      version: Number(creditManager.baseParams.version),
-      contractType: creditManager.baseParams.contractType,
+      ...creditManager.baseParams,
       name: `CreditManagerV3(${creditManager.name})`,
       abi: creditManagerV3Abi,
     });

src/market/GaugeContract.ts

@@ -14,9 +14,7 @@ export class GaugeContract extends BaseContract<abi> {
 
   constructor(sdk: GearboxSDK, pool: PoolData, gauge: RateKeeperData) {
     super(sdk, {
-      address: gauge.baseParams.addr,
-      contractType: gauge.baseParams.contractType,
-      version: Number(gauge.baseParams.version),
+      ...gauge.baseParams,
       name: `Gauge(${pool.name})`,
       abi: gaugeV3Abi,
     });

src/market/LinearModelContract.ts

@@ -13,9 +13,7 @@ export class LinearModelContract extends BaseContract<abi> {
 
   constructor(sdk: GearboxSDK, { interestRateModel }: MarketData) {
     super(sdk, {
-      address: interestRateModel.baseParams.addr,
-      contractType: interestRateModel.baseParams.contractType,
-      version: Number(interestRateModel.baseParams.version),
+      ...interestRateModel.baseParams,
       name: "LinearInterestRateModel",
       abi: linearInterestRateModelV3Abi,
     });