feat: added JSON network config

Author: Tarens2

devnet-configs/devnet.example.json

@@ -0,0 +1,13 @@
+{
+  "contracts": {
+    "withdrawalQueue": "0x0..",
+    "lido": "0x0..",
+    "oracleReportSanityChecker": "0x0..",
+    "accountingOracleHashConsensus": "0x0..",
+    "validatorsExitBusOracleHashConsensus": "0x0..",
+    "lidoLocator": "0x0.."
+  },
+  "apis": {
+    "keysApiBasePath": ""
+  }
+}

network-configs/network.example.json

@@ -8,10 +8,22 @@ import {
   WithdrawalQueueContractModule,
 } from '@lido-nestjs/contracts';
 import { EnvironmentVariables } from './env.validation';
-import { findDevnetConfig } from './utils/find-devnet-config';
+import { findNetworkConfig } from './networks/utils/find-network-config';
 import { KEYS_API_PATHS } from '../../jobs/validators/lido-keys/lido-keys.constants';
+import { Injectable } from '@nestjs/common';
+import { NetworkConfig } from './networks';
 
+@Injectable()
 export class ConfigService extends ConfigServiceSource<EnvironmentVariables> {
+  networkConfig: NetworkConfig;
+  constructor(internalConfig?: Partial<EnvironmentVariables>) {
+    super(internalConfig);
+
+    const name = this.get('CUSTOM_NETWORK_FILE_NAME');
+    if (name) {
+      this.networkConfig = findNetworkConfig(name);
+    }
+  }
   /**
    * List of env variables that should be hidden
    */
@@ -30,31 +42,33 @@ export class ConfigService extends ConfigServiceSource<EnvironmentVariables> {
   }
 
   public async getCustomConfigContractsAddressMap() {
-    const name = this.get('DEVNET_NAME');
+    const name = this.get('CUSTOM_NETWORK_FILE_NAME');
 
     if (!name) {
       return null;
     }
 
-    const devnetConfig = await findDevnetConfig(name);
+    if (!this.networkConfig) {
+      return null;
+    }
 
-    return new Map<symbol, string>([
-      [WithdrawalQueueContractModule.contractToken, devnetConfig['WithdrawalQueue']],
+    const contracts = this.networkConfig.contracts;
 
-      [LidoContractModule.contractToken, devnetConfig['Lido']],
-      [OracleReportSanityCheckerModule.contractToken, devnetConfig['OracleReportSanityChecker']],
-      [AccountingOracleHashConsensusModule.contractToken, devnetConfig['AccountingOracleHashConsensus']],
-      [ValidatorsExitBusOracleHashConsensusModule.contractToken, devnetConfig['ValidatorsExitBusOracleHashConsensus']],
-      [LidoLocatorContractModule.contractToken, devnetConfig['LidoLocator']],
+    return new Map<symbol, string>([
+      [WithdrawalQueueContractModule.contractToken, contracts.withdrawalQueue],
+      [LidoContractModule.contractToken, contracts.lido],
+      [OracleReportSanityCheckerModule.contractToken, contracts.oracleReportSanityChecker],
+      [AccountingOracleHashConsensusModule.contractToken, contracts.accountingOracleHashConsensus],
+      [ValidatorsExitBusOracleHashConsensusModule.contractToken, contracts.validatorsExitBusOracleHashConsensus],
+      [LidoLocatorContractModule.contractToken, contracts.lidoLocator],
     ]);
   }
 
   public async getKeysApiBasePath(): Promise<string> {
-    const name = this.get('DEVNET_NAME');
+    const name = this.get('CUSTOM_NETWORK_FILE_NAME');
 
     if (name) {
-      const devnetConfig = await findDevnetConfig(name);
-      const keysApiBasePath = devnetConfig['KeysApiBasePath'];
+      const keysApiBasePath = this.networkConfig.apis.keysApiBasePath;
 
       if (keysApiBasePath) {
         return keysApiBasePath;

src/common/config/config.service.ts

@@ -113,7 +113,7 @@ export class EnvironmentVariables {
 
   @IsOptional()
   @IsString()
-  DEVNET_NAME: string = null;
+  CUSTOM_NETWORK_FILE_NAME: string;
 }
 export const ENV_KEYS = Object.keys(new EnvironmentVariables());
 

src/common/config/devnets/devnet-config.interface.ts

@@ -0,0 +1 @@
+export * from './network-config.interface';

src/common/config/devnets/index.ts

@@ -0,0 +1,13 @@
+export interface NetworkConfig {
+  contracts: {
+    withdrawalQueue: string;
+    lido: string;
+    oracleReportSanityChecker: string;
+    accountingOracleHashConsensus: string;
+    validatorsExitBusOracleHashConsensus: string;
+    lidoLocator: string;
+  };
+  apis: {
+    keysApiBasePath: string;
+  };
+}

src/common/config/env.validation.ts

@@ -0,0 +1,21 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { NetworkConfig } from '../index';
+
+export function findNetworkConfig(name: string, directory = './network-configs'): NetworkConfig {
+  const fileName = `${name}.json`;
+  const filePath = path.join(directory, fileName);
+
+  if (!fs.existsSync(filePath)) {
+    console.error(`Error: Custom network config "${fileName}" doesn't exists `);
+    process.exit(1);
+  }
+
+  try {
+    const content = fs.readFileSync(filePath, 'utf8');
+    return JSON.parse(content);
+  } catch (err) {
+    console.error(`Error reading file ${fileName}: ${err.message}`);
+    process.exit(1);
+  }
+}