Fix: Resolve Type Warnings for ConfigService.get()

packages/config-service/src/commands/printEnvs.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2024 Hedera Hashgraph, LLC 
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/config-service/src/services/globalConfig.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2024 Hedera Hashgraph, LLC 
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,15 +18,30 @@
  *
  */
 
+type TypeStrToType<Tstr extends string> = Tstr extends 'string'
+  ? string
+  : Tstr extends 'boolean'
+    ? boolean
+    : Tstr extends 'number'
+      ? number
+      : Tstr extends 'array'
+        ? unknown[]
+        : never;
+
+type GetTypeStrOfKey<K extends string> = K extends keyof typeof _CONFIG 
+  ? typeof _CONFIG[K]['type'] 
+  : never;
+
+export type TypeOfKey<K extends string> = TypeStrToType<GetTypeStrOfKey<K>>;
+
 export interface ConfigProperty {
   envName: string;
   type: string;
   required: boolean;
   defaultValue: string | number | boolean | null;
 }
 
-export class GlobalConfig {
-  public static readonly ENTRIES: Record<string, ConfigProperty> = {
+const _CONFIG = {
     BATCH_REQUESTS_ENABLED: {
       envName: 'BATCH_REQUESTS_ENABLED',
       type: 'boolean',
@@ -568,6 +583,12 @@ export class GlobalConfig {
       required: false,
       defaultValue: null,
     },
+    SERVER_HOST: {
+      envName: 'SERVER_HOST',
+      type: 'string',
+      required: false,
+      defaultValue: null,
+    },
     SERVER_PORT: {
       envName: 'SERVER_PORT',
       type: 'number',
@@ -742,5 +763,44 @@ export class GlobalConfig {
       required: false,
       defaultValue: null,
     },
-  };
+} satisfies { [key: string]: ConfigProperty };
+
+export type ConfigKey = keyof typeof _CONFIG;
+
+export class ConfigService {
+  private static config: typeof _CONFIG = _CONFIG;
+
+  public static get<K extends ConfigKey>(name: K): TypeOfKey<K> | undefined {
+    const configItem = this.config[name];
+    if (!configItem) {
+      return undefined;
+    }
+
+    const value = process.env[configItem.envName];
+
+    if (value === undefined) {
+      return configItem.defaultValue as TypeOfKey<K>;
+    }
+
+    switch (configItem.type) {
+      case 'boolean':
+        return (value.toLowerCase() === 'true') as TypeOfKey<K>;
+      case 'number':
+        return Number(value) as TypeOfKey<K>;
+      case 'string':
+        return value as TypeOfKey<K>;
+      case 'array':
+        try {
+          return JSON.parse(value) as TypeOfKey<K>;
+        } catch {
+          return undefined;
+        }
+      default:
+        return undefined;
+    }
+  }
+}
+
+export class GlobalConfig {
+  public static readonly ENTRIES: Record<ConfigKey, ConfigProperty> = _CONFIG;
 }

packages/config-service/src/services/index.ts

@@ -23,6 +23,7 @@ import findConfig from 'find-config';
 import pino from 'pino';
 import { LoggerService } from './loggerService';
 import { ValidationService } from './validationService';
+import type { ConfigKey } from './globalConfig';
 
 const mainLogger = pino({
   name: 'hedera-json-rpc-relay',
@@ -97,7 +98,7 @@ export class ConfigService {
    * @param name string
    * @returns string | undefined
    */
-  public static get(name: string): string | number | boolean | null | undefined {
+  public static get(name: ConfigKey): string | number | boolean | null | undefined {
     return this.getInstance().envs[name];
   }
 }

packages/config-service/src/services/loggerService.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/config-service/tests/src/services/configService.spec.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2024 Hedera Hashgraph, LLC 
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 import chai, { expect } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import { ConfigService } from '../../../src/services';
+import type { ConfigKey } from '../../../src/services/globalConfig';
 
 chai.use(chaiAsPromised);
 
@@ -55,7 +56,7 @@ describe('ConfigService tests', async function () {
   });
 
   it('should return undefined for non-existing variable', async () => {
-    const res = ConfigService.get('NON_EXISTING_VAR');
+    const res = ConfigService.get('NON_EXISTING_VAR' as ConfigKey);
 
     expect(res).to.equal(undefined);
   });

packages/config-service/tests/src/services/loggerService.spec.ts

@@ -47,8 +47,8 @@ describe('LoggerService tests', async function () {
   });
 
   it('should be able to return plain information', async () => {
-    const envName = GlobalConfig.ENTRIES.CHAIN_ID.envName;
-    const res = ConfigService.get(envName);
+    const envName = 'CHAIN_ID';
+    const res = ConfigService.get(envName) as string | undefined;
 
     expect(LoggerService.maskUpEnv(envName, res)).to.equal(`${envName} = ${res}`);
   });

packages/relay/src/lib/types/ITracerConfig.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/lib/types/ITracerConfigWrapper.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/lib/types/ITransactionReceipt.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/lib/types/RequestDetails.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/lib/types/index.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/logsBloomUtils.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/receiptsRootUtils.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/src/utils.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

packages/relay/tests/lib/config/hbarSpendingPlanConfigService.spec.ts

@@ -1,4 +1,4 @@
-/*
+/*-
  *
  * Hedera JSON RPC Relay
  *

packages/relay/tests/lib/eth/eth-config.ts

@@ -19,6 +19,9 @@
  */
 
 import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
+
+import { nanOrNumberTo0x,numberTo0x } from '../../../dist/formatters';
+import constants from '../../../src/lib/constants';
 import {
   defaultDetailedContractResultByHash,
   defaultEvmAddress,
@@ -29,8 +32,6 @@ import {
   mockData,
   toHex,
 } from '../../helpers';
-import { numberTo0x, nanOrNumberTo0x } from '../../../dist/formatters';
-import constants from '../../../src/lib/constants';
 
 export const BLOCK_TRANSACTION_COUNT = 77;
 export const GAS_USED_1 = 200000;

packages/relay/tests/lib/eth/eth_common.spec.ts

@@ -20,9 +20,10 @@
 
 import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
 import { expect, use } from 'chai';
-import { Registry } from 'prom-client';
-import pino from 'pino';
 import chaiAsPromised from 'chai-as-promised';
+import pino from 'pino';
+import { Registry } from 'prom-client';
+
 import { RelayImpl } from '../../../src';
 import { RequestDetails } from '../../../src/lib/types';
 

packages/relay/tests/lib/eth/eth_sendRawTransaction.spec.ts

@@ -135,7 +135,7 @@ describe('@ethSendRawTransaction eth_sendRawTransaction spec', async function ()
       },
       receiver_sig_required: false,
     };
-    const useAsyncTxProcessing = ConfigService.get('USE_ASYNC_TX_PROCESSING') as boolean;
+    const useAsyncTxProcessing = ConfigService.get('USE_ASYNC_TX_PROCESSING');
 
     beforeEach(() => {
       clock = useFakeTimers();

packages/relay/tests/lib/hapiService.spec.ts

@@ -85,7 +85,9 @@ describe('HAPI Service', async function () {
   withOverriddenEnvsInMochaTest({ HAPI_CLIENT_TRANSACTION_RESET: 2 }, () => {
     it('should be able to reinitialise SDK instance upon reaching transaction limit', async function () {
       hapiService = new HAPIService(logger, registry, cacheService, eventEmitter, hbarLimitService);
-      expect(hapiService.getTransactionCount()).to.eq(parseInt(ConfigService.get('HAPI_CLIENT_TRANSACTION_RESET')!));
+      expect(hapiService.getTransactionCount()).to.eq(
+        parseInt(ConfigService.get('HAPI_CLIENT_TRANSACTION_RESET')!),
+      );
 
       const oldClientInstance = hapiService.getMainClientInstance();
       let oldSDKInstance = hapiService.getSDKClient(); // decrease transaction limit by taking the instance
@@ -105,15 +107,19 @@ describe('HAPI Service', async function () {
   withOverriddenEnvsInMochaTest({ HAPI_CLIENT_DURATION_RESET: 100 }, () => {
     it('should be able to reinitialise SDK instance upon reaching time limit', async function () {
       hapiService = new HAPIService(logger, registry, cacheService, eventEmitter, hbarLimitService);
-      expect(hapiService.getTimeUntilReset()).to.eq(parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')!));
+      expect(hapiService.getTimeUntilReset()).to.eq(
+        parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')!),
+      );
 
       const oldClientInstance = hapiService.getMainClientInstance();
       await new Promise((r) => setTimeout(r, 200)); // await to reach time limit
       const oldSDKInstance = hapiService.getSDKClient();
       const newSDKInstance = hapiService.getSDKClient();
       const newClientInstance = hapiService.getMainClientInstance();
 
-      expect(hapiService.getTimeUntilReset()).to.eq(parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')!));
+      expect(hapiService.getTimeUntilReset()).to.eq(
+        parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')),
+      );
       expect(oldSDKInstance).to.not.be.equal(newSDKInstance);
       expect(oldClientInstance).to.not.be.equal(newClientInstance);
     });
@@ -122,7 +128,9 @@ describe('HAPI Service', async function () {
   withOverriddenEnvsInMochaTest({ HAPI_CLIENT_ERROR_RESET: '[50]' }, () => {
     it('should be able to reinitialise SDK instance upon error status code encounter', async function () {
       hapiService = new HAPIService(logger, registry, cacheService, eventEmitter, hbarLimitService);
-      expect(hapiService.getErrorCodes()[0]).to.eq(JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0]);
+      expect(hapiService.getErrorCodes()[0]).to.eq(
+        JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0],
+      );
 
       const oldClientInstance = hapiService.getMainClientInstance();
       const oldSDKInstance = hapiService.getSDKClient();
@@ -132,7 +140,9 @@ describe('HAPI Service', async function () {
 
       expect(oldSDKInstance).to.not.be.equal(newSDKInstance);
       expect(oldClientInstance).to.not.be.equal(newClientInstance);
-      expect(hapiService.getErrorCodes()[0]).to.eq(JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0]);
+      expect(hapiService.getErrorCodes()[0]).to.eq(
+        JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0],
+      );
     });
   });
 
@@ -146,15 +156,21 @@ describe('HAPI Service', async function () {
       it('should be able to reset all counter upon reinitialization of the SDK Client', async function () {
         hapiService = new HAPIService(logger, registry, cacheService, eventEmitter, hbarLimitService);
 
-        expect(hapiService.getErrorCodes()[0]).to.eq(JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0]);
+        expect(hapiService.getErrorCodes()[0]).to.eq(
+          JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0],
+        );
         const oldClientInstance = hapiService.getMainClientInstance();
         const oldSDKInstance = hapiService.getSDKClient();
         hapiService.decrementErrorCounter(errorStatus);
         const newSDKInstance = hapiService.getSDKClient();
         const newClientInstance = hapiService.getMainClientInstance();
 
-        expect(hapiService.getTimeUntilReset()).to.eq(parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')!));
-        expect(hapiService.getErrorCodes()[0]).to.eq(JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0]);
+        expect(hapiService.getTimeUntilReset()).to.eq(
+          parseInt(ConfigService.get('HAPI_CLIENT_DURATION_RESET')!),
+        );
+        expect(hapiService.getErrorCodes()[0]).to.eq(
+          JSON.parse(ConfigService.get('HAPI_CLIENT_ERROR_RESET')!)[0],
+        );
         expect(hapiService.getTransactionCount()).to.eq(
           parseInt(ConfigService.get('HAPI_CLIENT_TRANSACTION_RESET')!) - 1,
         ); // one less because we took the instance once and decreased the counter
@@ -204,7 +220,9 @@ describe('HAPI Service', async function () {
     () => {
       it('should not be able to reinitialise and decrement counters, if it is disabled', async function () {
         hapiService = new HAPIService(logger, registry, cacheService, eventEmitter, hbarLimitService);
-        expect(hapiService.getTransactionCount()).to.eq(parseInt(ConfigService.get('HAPI_CLIENT_TRANSACTION_RESET')!));
+        expect(hapiService.getTransactionCount()).to.eq(
+          parseInt(ConfigService.get('HAPI_CLIENT_TRANSACTION_RESET')!),
+        );
 
         const oldClientInstance = hapiService.getMainClientInstance();
         const oldSDKInstance = hapiService.getSDKClient();

packages/relay/tests/lib/logsBloomUtils.spec.ts

@@ -2,7 +2,7 @@
  *
  * Hedera JSON RPC Relay
  *
- * Copyright (C) 2024 Hedera Hashgraph, LLC
+ * Copyright (C) 2022-2024 Hedera Hashgraph, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.