Use node:* import protocol for safer module resolution (#3667)

This PR uses `node:*` imports for `fs` and `path` modules as specified in [issue 3664](#3664).

Note that using `node:*` imports requires us to whitelist `node:fs` in the `import/core-modules` `eslint` setting. If we do not whitelist it then our linter fails because it can not identify `node:fs` as a node module.

.eslintrc.js

@@ -133,6 +133,9 @@ module.exports = {
     // Prevents accidentally pushing a commit with .only in Mocha tests
     "no-only-tests/no-only-tests": "error",
   },
+  settings: {
+    "import/core-modules": ["node:fs", "node:path"],
+  },
   overrides: [
     {
       files: ["**/test/**/*.ts"],

packages/beacon-state-transition/test/cache.ts

@@ -1,3 +1,3 @@
-import path from "path";
+import path from "node:path";
 
 export const testCachePath = path.join(__dirname, "../test-cache");

packages/beacon-state-transition/test/perf/analyzeEpochs.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {init} from "@chainsafe/bls";
 import {getClient} from "@chainsafe/lodestar-api";
 import {config} from "@chainsafe/lodestar-config/default";

packages/beacon-state-transition/test/perf/csv.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 
 const DELIMITER = ",";
 

packages/beacon-state-transition/test/perf/util.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {config} from "@chainsafe/lodestar-config/default";
 import {phase0, ssz, Slot, altair, ParticipationFlags} from "@chainsafe/lodestar-types";
 import bls, {CoordType, PublicKey, SecretKey} from "@chainsafe/bls";

packages/beacon-state-transition/test/utils/interop.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {fromHexString, toHexString} from "@chainsafe/ssz";
 import {interopSecretKey} from "../../src";
 import {testCachePath} from "../cache";

packages/beacon-state-transition/test/utils/specTestCases.ts

@@ -1,3 +1,3 @@
-import {join} from "path";
+import {join} from "node:path";
 
 export const SPEC_TEST_LOCATION = join(__dirname, "../../../../node_modules/@chainsafe/eth2-spec-tests");

packages/cli/docsgen/index.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {Options} from "yargs";
 import {omit} from "lodash";
 import {cmds} from "../src/cmds";

packages/cli/src/cmds/account/cmds/validator/import.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import inquirer from "inquirer";
 import {Keystore} from "@chainsafe/bls-keystore";
 import {

packages/cli/src/cmds/account/cmds/validator/recover.ts

@@ -1,4 +1,4 @@
-import * as fs from "fs";
+import * as fs from "node:fs";
 import {add0xPrefix, ICliCommand, initBLS, randomPassword} from "../../../../util";
 import {IGlobalArgs} from "../../../../options";
 import inquirer from "inquirer";

packages/cli/src/cmds/account/cmds/validator/slashingProtection/import.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {Interchange} from "@chainsafe/lodestar-validator";
 import {ICliCommand} from "../../../../../util";
 import {IGlobalArgs} from "../../../../../options";

packages/cli/src/cmds/account/cmds/validator/voluntaryExit.ts

@@ -1,6 +1,6 @@
 import {SlashingProtection, Validator} from "@chainsafe/lodestar-validator";
 import {SignerType} from "@chainsafe/lodestar-validator";
-import {readdirSync} from "fs";
+import {readdirSync} from "node:fs";
 import {LevelDbController} from "@chainsafe/lodestar-db";
 import inquirer from "inquirer";
 import {ICliCommand, initBLS} from "../../../../util";

packages/cli/src/cmds/account/cmds/wallet/recover.ts

@@ -1,4 +1,4 @@
-import * as fs from "fs";
+import * as fs from "node:fs";
 import {ICliCommand, initBLS} from "../../../../util";
 import {IGlobalArgs} from "../../../../options";
 import inquirer from "inquirer";

packages/cli/src/cmds/account/cmds/wallet/utils.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {IGlobalArgs} from "../../../../options";
 import {YargsError, writeFile600Perm, randomPassword, readPassphraseFile} from "../../../../util";
 import {WalletManager} from "../../../../wallet";

packages/cli/src/cmds/account/paths.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import {IGlobalArgs} from "../../options";
 import {IGlobalPaths, getGlobalPaths} from "../../paths/global";
 

packages/cli/src/cmds/beacon/paths.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import {IGlobalArgs} from "../../options";
 import {getGlobalPaths, IGlobalPaths} from "../../paths/global";
 

packages/cli/src/cmds/dev/handler.ts

@@ -1,7 +1,7 @@
-import fs from "fs";
+import fs from "node:fs";
 import {promisify} from "util";
 import rimraf from "rimraf";
-import path from "path";
+import path from "node:path";
 import {fromHexString} from "@chainsafe/ssz";
 import {AbortController} from "@chainsafe/abort-controller";
 import {GENESIS_SLOT} from "@chainsafe/lodestar-params";

packages/cli/src/cmds/init/handler.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {BeaconNodeOptions, getBeaconConfigFromArgs, initPeerId, initEnr, readPeerId, readEnr} from "../../config";
 import {IGlobalArgs, parseBeaconNodeArgs} from "../../options";
 import {mkdir} from "../../util";

packages/cli/src/cmds/validator/keys.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {Keystore} from "@chainsafe/bls-keystore";
 import {CoordType, PublicKey, SecretKey} from "@chainsafe/bls";
 import {deriveEth2ValidatorKeys, deriveKeyFromMnemonic} from "@chainsafe/bls-keygen";

packages/cli/src/cmds/validator/paths.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import {IGlobalArgs} from "../../options";
 import {IGlobalPaths, getGlobalPaths} from "../../paths/global";
 

packages/cli/src/networks/index.ts

@@ -8,7 +8,7 @@ import {RecursivePartial, fromHex} from "@chainsafe/lodestar-utils";
 // eslint-disable-next-line no-restricted-imports
 import {getStateTypeFromBytes} from "@chainsafe/lodestar/lib/util/multifork";
 import {TreeBacked} from "@chainsafe/ssz";
-import fs from "fs";
+import fs from "node:fs";
 import got from "got";
 import * as mainnet from "./mainnet";
 import * as pyrmont from "./pyrmont";

packages/cli/src/paths/rootDir.ts

@@ -1,5 +1,5 @@
 import os from "os";
-import path from "path";
+import path from "node:path";
 import {NetworkName} from "../networks";
 
 /**

packages/cli/src/util/ethers.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {ethers} from "ethers";
 
 /**

packages/cli/src/util/file.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import stream from "stream";
 import {promisify} from "util";
 import got from "got";

packages/cli/src/util/fs.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 
 /**
  * Create a file with `600 (-rw-------)` permissions

packages/cli/src/util/gitData/gitDataPath.ts

@@ -3,8 +3,8 @@
  * at what commit was this src build. This is used in the metrics and to log initially.
  */
 
-import path from "path";
-import fs from "fs";
+import path from "node:path";
+import fs from "node:fs";
 
 /**
  * WARNING!! If you change this path make sure to update:

packages/cli/src/util/passphrase.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {stripOffNewlines} from "./stripOffNewlines";
 import {writeFile600Perm} from "./fs";
 import {getValidatorPassphrasePath} from "../validatorDir/paths";

packages/cli/src/util/recursivelyFind.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {VOTING_KEYSTORE_FILE} from "../validatorDir/paths";
 
 /**

packages/cli/src/util/version.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import findUp from "find-up";
 import {readLodestarGitData} from "./gitData";
 import {GitData} from "./gitData/gitDataPath";

packages/cli/src/validatorDir/ValidatorDir.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import bls, {SecretKey} from "@chainsafe/bls";
 import {Keystore} from "@chainsafe/bls-keystore";
 import {phase0} from "@chainsafe/lodestar-types";

packages/cli/src/validatorDir/ValidatorDirBuilder.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {Keystore} from "@chainsafe/bls-keystore";
 import bls from "@chainsafe/bls";
 import {IEth2ValidatorKeys} from "@chainsafe/bls-keygen";

packages/cli/src/validatorDir/ValidatorDirManager.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {ValidatorDir, IValidatorDirOptions} from "./ValidatorDir";
 import {SecretKey} from "@chainsafe/bls";
 import {YargsError} from "../util";

packages/cli/src/validatorDir/paths.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import {add0xPrefix} from "../util/format";
 
 export const VOTING_KEYSTORE_FILE = "voting-keystore.json";

packages/cli/src/wallet/WalletManager.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {isUuid} from "uuidv4";
 import {Wallet, IWalletKeystoreJson} from "./Wallet";
 import {ensureDirExists, YargsError} from "../util";

packages/cli/test/e2e/cmds/account.test.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import rimraf from "rimraf";
 import {expect} from "chai";
 import {getAccountPaths} from "../../../src/cmds/account/paths";

packages/cli/test/unit/config/beaconNodeOptions.test.ts

@@ -1,7 +1,7 @@
 import {defaultOptions} from "@chainsafe/lodestar";
 import {expect} from "chai";
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import {getBeaconPaths} from "../../../src/cmds/beacon/paths";
 import {BeaconNodeOptions, mergeBeaconNodeOptions} from "../../../src/config";
 import {enrsToNetworkConfig, parseBootnodesFile} from "../../../src/networks";
@@ -101,7 +101,7 @@ describe("config / bootnodes / parsing", () => {
       name: "can parse multiline JSON input",
       input: `
 {
-  "enrs": 
+  "enrs":
     [
       "enr:-cabfg",
       "enr:-deadbeef"

packages/cli/test/unit/config/beaconParams.test.ts

@@ -1,5 +1,5 @@
 import {expect} from "chai";
-import fs from "fs";
+import fs from "node:fs";
 import yaml from "js-yaml";
 import {toHexString} from "@chainsafe/ssz";
 import {getTestdirPath} from "../../utils";

packages/cli/test/unit/config/fileEnr.test.ts

@@ -1,7 +1,7 @@
 import {toHexString} from "@chainsafe/ssz";
 import {expect} from "chai";
 import {before, after} from "mocha";
-import {existsSync} from "fs";
+import {existsSync} from "node:fs";
 import rimraf from "rimraf";
 import {initEnr, initPeerId, readPeerId, FileENR} from "../../../src/config";
 import {testFilesDir} from "../../utils";

packages/cli/test/unit/util/gitData.test.ts

@@ -1,6 +1,6 @@
 import {expect} from "chai";
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import findUp from "find-up";
 import {gitDataPath, readGitDataFile} from "../../../src/util/gitData/gitDataPath";
 

packages/cli/test/unit/validator/keys.test.ts

@@ -1,6 +1,6 @@
 import {expect} from "chai";
 import sinon from "sinon";
-import fs, {Dirent, Stats} from "fs";
+import fs, {Dirent, Stats} from "node:fs";
 import {resolveKeystorePaths} from "../../../src/cmds/validator/keys";
 
 describe("validator / keys / resolveKeystorePaths", () => {

packages/cli/test/utils.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 import tmp from "tmp";
 
 const tmpDir = tmp.dirSync({unsafeCleanup: true});

packages/lodestar/src/api/impl/lodestar/index.ts

@@ -50,7 +50,7 @@ export function getLodestarApi({
         throw Error("Already writing heapdump");
       }
       // Lazily import NodeJS only modules
-      const fs = await import("fs");
+      const fs = await import("node:fs");
       const v8 = await import("v8");
       const snapshotStream = v8.getHeapSnapshot();
       // It's important that the filename end with `.heapsnapshot`,

packages/lodestar/src/chain/chain.ts

@@ -2,7 +2,7 @@
  * @module chain
  */
 
-import fs from "fs";
+import fs from "node:fs";
 import {CachedBeaconStateAllForks, computeStartSlotAtEpoch} from "@chainsafe/lodestar-beacon-state-transition";
 import {IBeaconConfig} from "@chainsafe/lodestar-config";
 import {IForkChoice} from "@chainsafe/lodestar-fork-choice";

packages/lodestar/src/node/utils/state.ts

@@ -2,8 +2,8 @@ import {IBeaconConfig, IChainForkConfig} from "@chainsafe/lodestar-config";
 import {allForks, phase0, ssz} from "@chainsafe/lodestar-types";
 import {interopDeposits} from "./interop/deposits";
 import {getInteropState, InteropStateOpts} from "./interop/state";
-import {mkdirSync, writeFileSync} from "fs";
-import {dirname} from "path";
+import {mkdirSync, writeFileSync} from "node:fs";
+import {dirname} from "node:path";
 import {IBeaconDb} from "../../db";
 import {TreeBacked} from "@chainsafe/ssz";
 import {GENESIS_SLOT} from "../../constants";

packages/lodestar/src/util/file.ts

@@ -2,8 +2,8 @@
  * @module util/file
  */
 
-import fs from "fs";
-import path from "path";
+import fs from "node:fs";
+import path from "node:path";
 
 /**
  * Recursively ensures directory exists by creating any missing directories

packages/lodestar/test/scripts/blsPubkeyBytesFrequency.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import {getClient} from "@chainsafe/lodestar-api";
 import {config} from "@chainsafe/lodestar-config/default";
 import {newZeroedArray} from "@chainsafe/lodestar-beacon-state-transition";

packages/lodestar/test/sim/merge-interop.test.ts

@@ -1,4 +1,4 @@
-import fs from "fs";
+import fs from "node:fs";
 import net from "net";
 import {spawn} from "child_process";
 import {Context} from "mocha";

packages/lodestar/test/sim/multiNodeMultiThread.test.ts

@@ -1,4 +1,4 @@
-import path from "path";
+import path from "node:path";
 import os from "os";
 import {Worker} from "worker_threads";
 import {phase0} from "@chainsafe/lodestar-types";

packages/lodestar/test/sim/threaded/worker.js

@@ -1,4 +1,4 @@
-const path = require("path");
+const path = require("node:path");
 const {workerData} = require("worker_threads");
 
 require("ts-node").register();

packages/lodestar/test/spec/allForks/epochProcessing.ts

@@ -1,5 +1,5 @@
-import {join} from "path";
-import fs from "fs";
+import {join} from "node:path";
+import fs from "node:fs";
 
 import {CachedBeaconStateAllForks, allForks} from "@chainsafe/lodestar-beacon-state-transition";
 import {describeDirectorySpecTest} from "@chainsafe/lodestar-spec-test-util";

packages/lodestar/test/spec/allForks/finality.ts

@@ -1,4 +1,4 @@
-import {join} from "path";
+import {join} from "node:path";
 import {TreeBacked} from "@chainsafe/ssz";
 import {CachedBeaconStateAllForks, allForks, altair} from "@chainsafe/lodestar-beacon-state-transition";
 import {describeDirectorySpecTest} from "@chainsafe/lodestar-spec-test-util";

packages/lodestar/test/spec/allForks/forkChoice.ts

@@ -1,4 +1,4 @@
-import {join} from "path";
+import {join} from "node:path";
 import {expect} from "chai";
 import {
   createCachedBeaconState,