chore: upgrade eslint and fix the warnings (#6420)

* Update eslint packages

* Fix elsint warnings

* Update the code comment

* Fix the build issue

* Sort the eslint rules

* Update name for an import

* Update the import

.eslintrc.js

@@ -64,6 +64,10 @@ module.exports = {
       },
       //ignore rules on destructured params
       {selector: "variable", modifiers: ["destructured"], format: null},
+      {
+        selector: "import",
+        format: ["camelCase", "PascalCase"],
+      },
     ],
     "@typescript-eslint/no-explicit-any": "error",
     "@typescript-eslint/no-floating-promises": "error",
@@ -94,6 +98,7 @@ module.exports = {
     "func-call-spacing": "off",
     // Force to add names to all functions to ease CPU profiling
     "func-names": ["error", "always"],
+    "import/namespace": "off",
     //if --fix is run it messes imports like /lib/presets/minimal & /lib/presets/mainnet
     "import/no-duplicates": "off",
     "import/no-extraneous-dependencies": [

package.json

@@ -50,18 +50,18 @@
     "@dapplion/benchmark": "^0.2.4",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.6.5",
-    "@typescript-eslint/eslint-plugin": "6.7.2",
-    "@typescript-eslint/parser": "6.7.2",
+    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/parser": "6.21.0",
     "@vitest/coverage-v8": "^1.2.1",
     "@vitest/browser": "^1.2.1",
     "crypto-browserify": "^3.12.0",
     "dotenv": "^16.4.1",
     "electron": "^26.2.2",
-    "eslint": "^8.50.0",
+    "eslint": "^8.56.0",
     "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-vitest": "^0.3.20",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-vitest": "^0.3.22",
     "https-browserify": "^1.0.0",
     "jsdom": "^23.0.1",
     "lerna": "^7.3.0",

packages/api/src/utils/client/format.ts

@@ -1,11 +1,11 @@
-import qs from "qs";
+import {stringify as queryStringStringify} from "qs";
 
 /**
  * Ethereum Beacon API requires the query with format:
  * - arrayFormat: repeat `topic=topic1&topic=topic2`
  */
 export function stringifyQuery(query: unknown): string {
-  return qs.stringify(query, {arrayFormat: "repeat"});
+  return queryStringStringify(query, {arrayFormat: "repeat"});
 }
 
 /**

packages/api/test/unit/client/httpClient.test.ts

@@ -1,6 +1,6 @@
 import {IncomingMessage} from "node:http";
 import {describe, it, afterEach, expect} from "vitest";
-import fastify, {RouteOptions} from "fastify";
+import {RouteOptions, fastify} from "fastify";
 import {ErrorAborted, TimeoutError, toBase64} from "@lodestar/utils";
 import {HttpClient, HttpError} from "../../../src/utils/client/index.js";
 import {HttpStatusCode} from "../../../src/utils/client/httpStatusCode.js";

packages/api/test/utils/utils.ts

@@ -1,6 +1,6 @@
 import {MockedObject, vi} from "vitest";
 import qs from "qs";
-import fastify, {FastifyInstance} from "fastify";
+import {FastifyInstance, fastify} from "fastify";
 import {mapValues} from "@lodestar/utils";
 import {ServerApi} from "../../src/interfaces.js";
 

packages/beacon-node/src/api/rest/base.ts

@@ -1,6 +1,6 @@
-import qs from "qs";
-import fastify, {FastifyInstance} from "fastify";
-import fastifyCors from "@fastify/cors";
+import {parse as parseQueryString} from "qs";
+import {FastifyInstance, fastify} from "fastify";
+import {fastifyCors} from "@fastify/cors";
 import bearerAuthPlugin from "@fastify/bearer-auth";
 import {RouteConfig} from "@lodestar/api/beacon/server";
 import {ErrorAborted, Gauge, Histogram, Logger} from "@lodestar/utils";
@@ -48,7 +48,7 @@ export class RestApiServer {
       logger: false,
       ajv: {customOptions: {coerceTypes: "array"}},
       querystringParser: (str) =>
-        qs.parse(str, {
+        parseQueryString(str, {
           // Array as comma-separated values must be supported to be OpenAPI spec compliant
           comma: true,
           // Drop support for array query strings like `id[0]=1&id[1]=2&id[2]=3` as those are not required to

packages/beacon-node/src/chain/emitter.ts

@@ -1,5 +1,5 @@
 import {EventEmitter} from "events";
-import StrictEventEmitter from "strict-event-emitter-types";
+import {StrictEventEmitter} from "strict-event-emitter-types";
 
 import {routes} from "@lodestar/api";
 import {phase0} from "@lodestar/types";

packages/beacon-node/src/eth1/provider/jsonRpcHttpClient.ts

@@ -1,5 +1,5 @@
 import {EventEmitter} from "events";
-import StrictEventEmitter from "strict-event-emitter-types";
+import {StrictEventEmitter} from "strict-event-emitter-types";
 import {fetch} from "@lodestar/api";
 import {ErrorAborted, Gauge, Histogram, TimeoutError, isValidHttpUrl, retry} from "@lodestar/utils";
 import {IJson, RpcPayload} from "../interface.js";

packages/beacon-node/src/eth1/provider/jwt.ts

@@ -2,6 +2,7 @@ import type {TAlgorithm} from "jwt-simple";
 // TODO: fix jwt-simple types
 import jwt from "jwt-simple";
 
+// eslint-disable-next-line import/no-named-as-default-member
 const {encode, decode} = jwt;
 
 /**

packages/beacon-node/src/monitoring/system.ts

@@ -1,5 +1,9 @@
+// We want to keep `system` export to be used as namespace
+/* eslint-disable import/no-named-as-default-member */
 import os from "node:os";
 import path from "node:path";
+// We want to keep `system` export as it's more readable and easier to understand
+// eslint-disable-next-line import/no-named-as-default
 import system from "systeminformation";
 import {Logger} from "@lodestar/utils";
 

packages/beacon-node/src/network/core/networkCoreWorkerHandler.ts

@@ -1,5 +1,5 @@
 import path from "node:path";
-import worker_threads from "node:worker_threads";
+import workerThreads from "node:worker_threads";
 import {PeerScoreStatsDump} from "@chainsafe/libp2p-gossipsub/dist/src/score/peer-score.js";
 import {PublishOpts} from "@chainsafe/libp2p-gossipsub/types";
 import {ModuleThread, Thread, Worker, spawn} from "@chainsafe/threads";
@@ -78,14 +78,14 @@ export class WorkerNetworkCore implements INetworkCore {
     wireEventsOnMainThread<NetworkEventData>(
       NetworkWorkerThreadEventType.networkEvent,
       modules.events,
-      modules.worker as unknown as worker_threads.Worker,
+      modules.worker as unknown as workerThreads.Worker,
       modules.metrics,
       networkEventDirection
     );
     wireEventsOnMainThread<ReqRespBridgeEventData>(
       NetworkWorkerThreadEventType.reqRespBridgeEvents,
       this.reqRespBridgeEventBus,
-      modules.worker as unknown as worker_threads.Worker,
+      modules.worker as unknown as workerThreads.Worker,
       modules.metrics,
       reqRespBridgeEventDirection
     );

packages/beacon-node/src/network/discv5/index.ts

@@ -1,6 +1,6 @@
 import EventEmitter from "events";
 import {PeerId} from "@libp2p/interface";
-import StrictEventEmitter from "strict-event-emitter-types";
+import {StrictEventEmitter} from "strict-event-emitter-types";
 import {exportToProtobuf} from "@libp2p/peer-id-factory";
 import {createPrivateKeyFromPeerId, ENR, ENRData, SignableENR} from "@chainsafe/enr";
 import {spawn, Thread, Worker} from "@chainsafe/threads";

packages/beacon-node/src/sync/range/range.ts

@@ -1,5 +1,5 @@
 import {EventEmitter} from "events";
-import StrictEventEmitter from "strict-event-emitter-types";
+import {StrictEventEmitter} from "strict-event-emitter-types";
 import {computeStartSlotAtEpoch} from "@lodestar/state-transition";
 import {BeaconConfig} from "@lodestar/config";
 import {Epoch, phase0} from "@lodestar/types";

packages/beacon-node/src/util/blobs.ts

@@ -1,4 +1,4 @@
-import SHA256 from "@chainsafe/as-sha256";
+import {digest as sha256Digest} from "@chainsafe/as-sha256";
 import {Tree} from "@chainsafe/persistent-merkle-tree";
 import {VERSIONED_HASH_VERSION_KZG, KZG_COMMITMENT_GINDEX0, ForkName} from "@lodestar/params";
 import {deneb, ssz, allForks} from "@lodestar/types";
@@ -8,7 +8,7 @@ import {signedBlockToSignedHeader} from "@lodestar/state-transition";
 type VersionHash = Uint8Array;
 
 export function kzgCommitmentToVersionedHash(kzgCommitment: deneb.KZGCommitment): VersionHash {
-  const hash = SHA256.digest(kzgCommitment);
+  const hash = sha256Digest(kzgCommitment);
   // Equivalent to `VERSIONED_HASH_VERSION_KZG + hash(kzg_commitment)[1:]`
   hash[0] = VERSIONED_HASH_VERSION_KZG;
   return hash;

packages/beacon-node/src/util/clock.ts

@@ -1,5 +1,5 @@
 import EventEmitter from "node:events";
-import type StrictEventEmitter from "strict-event-emitter-types";
+import type {StrictEventEmitter} from "strict-event-emitter-types";
 import type {Epoch, Slot} from "@lodestar/types";
 import {ChainForkConfig} from "@lodestar/config";
 import {ErrorAborted} from "@lodestar/utils";

packages/beacon-node/test/e2e/network/onWorker/workerEchoHandler.ts

@@ -1,4 +1,4 @@
-import worker_threads from "node:worker_threads";
+import workerThreads from "node:worker_threads";
 import {spawn, Worker} from "@chainsafe/threads";
 
 export type EchoWorker = {
@@ -8,7 +8,7 @@ export type EchoWorker = {
 
 export async function getEchoWorker(): Promise<EchoWorker> {
   const workerThreadjs = new Worker("./workerEcho.js");
-  const worker = workerThreadjs as unknown as worker_threads.Worker;
+  const worker = workerThreadjs as unknown as workerThreads.Worker;
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   await spawn<any>(workerThreadjs, {

packages/beacon-node/test/unit/monitoring/remoteService.ts

@@ -1,4 +1,4 @@
-import fastify from "fastify";
+import {fastify} from "fastify";
 import {afterAll, expect} from "vitest";
 import {RemoteServiceError} from "../../../src/monitoring/service.js";
 import {ProcessType} from "../../../src/monitoring/types.js";

packages/beacon-node/test/utils/db.ts

@@ -1,4 +1,4 @@
-import child_process from "node:child_process";
+import childProcess from "node:child_process";
 import {FilterOptions, LevelDbController} from "@lodestar/db";
 import {ChainForkConfig} from "@lodestar/config";
 import {BeaconDb} from "../../src/index.js";
@@ -8,7 +8,7 @@ export const TEMP_DB_LOCATION = ".tmpdb";
 
 export async function startTmpBeaconDb(config: ChainForkConfig): Promise<BeaconDb> {
   // Clean-up db first
-  child_process.execSync(`rm -rf ${TEMP_DB_LOCATION}`);
+  childProcess.execSync(`rm -rf ${TEMP_DB_LOCATION}`);
 
   return new BeaconDb(config, await LevelDbController.create({name: TEMP_DB_LOCATION}, {logger: testLogger()}));
 }

packages/cli/test/utils/simulation/ExternalSignerServer.ts

@@ -1,4 +1,4 @@
-import fastify from "fastify";
+import {fastify} from "fastify";
 import {fromHexString} from "@chainsafe/ssz";
 import type {SecretKey} from "@chainsafe/bls/types";
 import {EXTERNAL_SIGNER_BASE_PORT} from "./constants.js";

packages/cli/test/utils/simulation/SimulationTracker.ts

@@ -1,5 +1,5 @@
 import EventEmitter from "node:events";
-import Debug from "debug";
+import createDebug from "debug";
 import {routes} from "@lodestar/api/beacon";
 import {ChainForkConfig} from "@lodestar/config";
 import {Epoch, Slot} from "@lodestar/types";
@@ -20,7 +20,7 @@ import {defaultAssertions} from "./assertions/defaults/index.js";
 import {TableReporter} from "./TableReporter.js";
 import {fetchBlock} from "./utils/network.js";
 
-const debug = Debug("lodestar:sim:tracker");
+const debug = createDebug("lodestar:sim:tracker");
 
 interface SimulationTrackerInitOptions {
   nodes: NodePair[];

packages/light-client/test/utils/server.ts

@@ -1,6 +1,6 @@
-import qs from "qs";
-import fastify, {FastifyInstance} from "fastify";
-import fastifyCors from "@fastify/cors";
+import {parse as queryStringParse} from "qs";
+import {FastifyInstance, fastify} from "fastify";
+import {fastifyCors} from "@fastify/cors";
 import {Api, ServerApi} from "@lodestar/api";
 import {registerRoutes} from "@lodestar/api/beacon/server";
 import {ChainForkConfig} from "@lodestar/config";
@@ -18,7 +18,7 @@ export async function startServer(
   const server = fastify({
     logger: false,
     ajv: {customOptions: {coerceTypes: "array"}},
-    querystringParser: (str) => qs.parse(str, {comma: true, parseArrays: false}),
+    querystringParser: (str) => queryStringParse(str, {comma: true, parseArrays: false}),
   });
 
   registerRoutes(server, config, api, ["lightclient", "proof", "events"]);

packages/logger/src/node.ts

@@ -1,6 +1,8 @@
 import path from "node:path";
 import DailyRotateFile from "winston-daily-rotate-file";
 import TransportStream from "winston-transport";
+// We want to keep `winston` export as it's more readable and easier to understand
+// eslint-disable-next-line import/no-named-as-default-member
 import winston from "winston";
 import type {Logger as Winston} from "winston";
 import {Logger, LogLevel, TimestampFormat} from "./interface.js";

packages/logger/src/utils/format.ts

@@ -1,11 +1,11 @@
-import winston from "winston";
+// We want to keep `winston` export as it's more readable and easier to understand
+// eslint-disable-next-line import/no-named-as-default-member
+import winston, {format} from "winston";
 import {LodestarError, isEmptyObject} from "@lodestar/utils";
 import {LoggerOptions, TimestampFormatCode} from "../interface.js";
 import {logCtxToJson, logCtxToString, LogData} from "./json.js";
 import {formatEpochSlotTime} from "./timeFormat.js";
 
-const {format} = winston;
-
 type Format = ReturnType<typeof winston.format.combine>;
 
 // TODO: Find a more typesafe way of enforce this properties

packages/logger/src/winston.ts

@@ -1,4 +1,6 @@
-import winston from "winston";
+// We want to keep `winston` export as it's more readable and easier to understand
+// eslint-disable-next-line import/no-named-as-default-member
+import winston, {createLogger as winstonCreateLogger} from "winston";
 import type {Logger as Winston} from "winston";
 import {Logger, LoggerOptions, LogLevel, logLevelNum} from "./interface.js";
 import {getFormat} from "./utils/format.js";
@@ -46,7 +48,7 @@ export class WinstonLogger implements Logger {
   static createWinstonInstance(options: Partial<LoggerOptions> = {}, transports?: winston.transport[]): Winston {
     const defaultMeta: DefaultMeta = {module: options?.module || ""};
 
-    return winston.createLogger({
+    return winstonCreateLogger({
       // Do not set level at the logger level. Always control by Transport, unless for testLogger
       level: options.level,
       defaultMeta,

packages/logger/test/e2e/logger/workerLoggerHandler.ts

@@ -1,4 +1,4 @@
-import worker_threads from "node:worker_threads";
+import workerThreads from "node:worker_threads";
 import {spawn, Worker} from "@chainsafe/threads";
 
 export type LoggerWorker = {
@@ -12,7 +12,7 @@ export async function getLoggerWorker(opts: WorkerData): Promise<LoggerWorker> {
   const workerThreadjs = new Worker("./workerLogger.js", {
     workerData: opts,
   });
-  const worker = workerThreadjs as unknown as worker_threads.Worker;
+  const worker = workerThreadjs as unknown as workerThreads.Worker;
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   await spawn<any>(workerThreadjs, {

packages/prover/test/e2e/cli/cmds/start.test.ts

@@ -2,7 +2,7 @@ import childProcess from "node:child_process";
 import {writeFile, mkdir} from "node:fs/promises";
 import path from "node:path";
 import {describe, it, expect, beforeAll, afterAll} from "vitest";
-import Web3 from "web3";
+import {Web3} from "web3";
 import {runCliCommand, spawnCliCommand, stopChildProcess} from "@lodestar/test-utils";
 import {sleep} from "@lodestar/utils";
 import {ChainConfig, chainConfigToJson} from "@lodestar/config";

packages/prover/test/e2e/web3_batch_request.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {describe, it, expect, beforeAll} from "vitest";
-import Web3 from "web3";
+import {Web3} from "web3";
 import {LCTransport} from "../../src/interfaces.js";
 import {createVerifiedExecutionProvider} from "../../src/web3_provider.js";
 import {rpcUrl, beaconUrl, config, waitForCapellaFork} from "../utils/e2e_env.js";

packages/prover/test/e2e/web3_provider.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/naming-convention */
 import {describe, it, expect, beforeAll} from "vitest";
-import Web3 from "web3";
+import {Web3} from "web3";
 import {ethers} from "ethers";
 import {LCTransport} from "../../src/interfaces.js";
 import {createVerifiedExecutionProvider} from "../../src/web3_provider.js";

packages/prover/test/unit/utils/assertion.test.ts

@@ -1,6 +1,6 @@
 import {describe, it, expect} from "vitest";
 import {ethers} from "ethers";
-import Web3 from "web3";
+import {Web3} from "web3";
 import {isSendProvider, isWeb3jsProvider, isEthersProvider} from "../../../src/utils/assertion.js";
 
 describe("utils/assertion", () => {

packages/prover/test/unit/verified_requests/eth_getBalance.test.ts

@@ -3,12 +3,12 @@ import {createForkConfig} from "@lodestar/config";
 import {NetworkName, networksChainConfig} from "@lodestar/config/networks";
 import {VERIFICATION_FAILED_RESPONSE_CODE} from "../../../src/constants.js";
 import {eth_getBalance} from "../../../src/verified_requests/eth_getBalance.js";
-import eth_getBalance_eoa from "../../fixtures/sepolia/eth_getBalance_eoa.json" assert {type: "json"};
-import eth_getBalance_contract from "../../fixtures/sepolia/eth_getBalance_contract.json" assert {type: "json"};
+import ethGetBalanceEoa from "../../fixtures/sepolia/eth_getBalance_eoa.json" assert {type: "json"};
+import ethGetBalanceContract from "../../fixtures/sepolia/eth_getBalance_contract.json" assert {type: "json"};
 import {cloneTestFixture, generateReqHandlerOptionsMock} from "../../mocks/request_handler.js";
 import {getVerificationFailedMessage} from "../../../src/utils/json_rpc.js";
 
-const testCases = [eth_getBalance_eoa, eth_getBalance_contract];
+const testCases = [ethGetBalanceEoa, ethGetBalanceContract];
 
 describe("verified_requests / eth_getBalance", () => {
   for (const testCase of testCases) {

packages/prover/test/unit/verified_requests/eth_getBlockByHash.test.ts

@@ -3,13 +3,13 @@ import {createForkConfig} from "@lodestar/config";
 import {NetworkName, networksChainConfig} from "@lodestar/config/networks";
 import {VERIFICATION_FAILED_RESPONSE_CODE} from "../../../src/constants.js";
 import {eth_getBlockByHash} from "../../../src/verified_requests/eth_getBlockByHash.js";
-import eth_getBlock_with_contractCreation from "../../fixtures/sepolia/eth_getBlock_with_contractCreation.json" assert {type: "json"};
-import eth_getBlock_with_no_accessList from "../../fixtures/sepolia/eth_getBlock_with_no_accessList.json" assert {type: "json"};
+import ethGetBlockWithContractCreation from "../../fixtures/sepolia/eth_getBlock_with_contractCreation.json" assert {type: "json"};
+import ethGetBlockWithNoAccessList from "../../fixtures/sepolia/eth_getBlock_with_no_accessList.json" assert {type: "json"};
 import {TestFixture, cloneTestFixture, generateReqHandlerOptionsMock} from "../../mocks/request_handler.js";
 import {ELBlock} from "../../../src/types.js";
 import {getVerificationFailedMessage} from "../../../src/utils/json_rpc.js";
 
-const testCases = [eth_getBlock_with_no_accessList, eth_getBlock_with_contractCreation] as [
+const testCases = [ethGetBlockWithNoAccessList, ethGetBlockWithContractCreation] as [
   TestFixture<ELBlock>,
   TestFixture<ELBlock>,
 ];