@nomicfoundation/hardhat-utils 3.0.0-next.3 → 3.0.0-next.30

package/src/fs.ts

@@ -2,13 +2,14 @@ import type { JsonTypes, ParsedElementInfo } from "@streamparser/json-node";
 import type { FileHandle } from "node:fs/promises";
 
 import fsPromises from "node:fs/promises";
+import { tmpdir } from "node:os";
 import path from "node:path";
 import { pipeline } from "node:stream/promises";
 
 import { JSONParser } from "@streamparser/json-node";
 import { JsonStreamStringify } from "json-stream-stringify";
 
-import { ensureError } from "./error.js";
+import { ensureError, ensureNodeErrnoExceptionError } from "./error.js";
 import {
   FileNotFoundError,
   FileSystemAccessError,
@@ -31,7 +32,7 @@ export async function getRealPath(absolutePath: string): Promise<string> {
   try {
     return await fsPromises.realpath(path.normalize(absolutePath));
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -46,6 +47,7 @@ export async function getRealPath(absolutePath: string): Promise<string> {
  *
  * @param dirFrom The absolute path of the directory to start the search from.
  * @param matches A function to filter files (not directories).
+ * @param directoryFilter A function to filter which directories to recurse into
  * @returns An array of absolute paths. Each file has its true case, except
  *  for the initial dirFrom part, which preserves the given casing.
  *  No order is guaranteed. If dirFrom doesn't exist `[]` is returned.
@@ -54,7 +56,8 @@ export async function getRealPath(absolutePath: string): Promise<string> {
  */
 export async function getAllFilesMatching(
   dirFrom: string,
-  matches?: (absolutePathToFile: string) => boolean,
+  matches?: (absolutePathToFile: string) => Promise<boolean> | boolean,
+  directoryFilter?: (absolutePathToDir: string) => Promise<boolean> | boolean,
 ): Promise<string[]> {
   const dirContent = await readdirOrEmpty(dirFrom);
 
@@ -62,8 +65,19 @@ export async function getAllFilesMatching(
     dirContent.map(async (file) => {
       const absolutePathToFile = path.join(dirFrom, file);
       if (await isDirectory(absolutePathToFile)) {
-        return getAllFilesMatching(absolutePathToFile, matches);
-      } else if (matches === undefined || matches(absolutePathToFile)) {
+        if (
+          directoryFilter === undefined ||
+          (await directoryFilter(absolutePathToFile))
+        ) {
+          return getAllFilesMatching(
+            absolutePathToFile,
+            matches,
+            directoryFilter,
+          );
+        }
+
+        return [];
+      } else if (matches === undefined || (await matches(absolutePathToFile))) {
         return absolutePathToFile;
       } else {
         return [];
@@ -79,7 +93,7 @@ export async function getAllFilesMatching(
  * satisfy the specified condition, returning their absolute paths. Once a
  * directory is found, its subdirectories are not searched.
  *
- * Note: dirFrom is never returned, nor `matches` is called on it.
+ * Note: dirFrom is never returned, nor is `matches` called on it.
  *
  * @param dirFrom The absolute path of the directory to start the search from.
  * @param matches A function to filter directories (not files).
@@ -91,7 +105,7 @@ export async function getAllFilesMatching(
  */
 export async function getAllDirectoriesMatching(
   dirFrom: string,
-  matches?: (absolutePathToDir: string) => boolean,
+  matches?: (absolutePathToDir: string) => Promise<boolean> | boolean,
 ): Promise<string[]> {
   const dirContent = await readdirOrEmpty(dirFrom);
 
@@ -102,7 +116,7 @@ export async function getAllDirectoriesMatching(
         return [];
       }
 
-      if (matches === undefined || matches(absolutePathToFile)) {
+      if (matches === undefined || (await matches(absolutePathToFile))) {
         return absolutePathToFile;
       }
 
@@ -165,7 +179,7 @@ export async function isDirectory(absolutePath: string): Promise<boolean> {
   try {
     return (await fsPromises.lstat(absolutePath)).isDirectory();
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -189,7 +203,7 @@ export async function readJsonFile<T>(absolutePathToFile: string): Promise<T> {
   try {
     return JSON.parse(content.toString());
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureError(e);
     throw new InvalidFileFormatError(absolutePathToFile, e);
   }
 }
@@ -241,19 +255,22 @@ export async function readJsonFileAsStream<T>(
 
     return result;
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureError(e);
 
-    if (e.code === "ENOENT") {
-      throw new FileNotFoundError(absolutePathToFile, e);
-    }
+    // If the code is defined, we assume the error to be related to the file system
+    if ("code" in e) {
+      if (e.code === "ENOENT") {
+        throw new FileNotFoundError(absolutePathToFile, e);
+      }
 
-    if (e.code === "EISDIR") {
-      throw new IsDirectoryError(absolutePathToFile, e);
-    }
+      if (e.code === "EISDIR") {
+        throw new IsDirectoryError(absolutePathToFile, e);
+      }
 
-    // If the code is defined, we assume the error to be related to the file system
-    if (e.code !== undefined) {
-      throw new FileSystemAccessError(absolutePathToFile, e);
+      // If the code is defined, we assume the error to be related to the file system
+      if (e.code !== undefined) {
+        throw new FileSystemAccessError(absolutePathToFile, e);
+      }
     }
 
     // Otherwise, we assume the error to be related to the file formatting
@@ -281,7 +298,7 @@ export async function writeJsonFile<T>(
   try {
     content = JSON.stringify(object, null, 2);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureError(e);
     throw new JsonSerializationError(absolutePathToFile, e);
   }
 
@@ -318,17 +335,17 @@ export async function writeJsonFileAsStream<T>(
 
     await pipeline(jsonStream, fileWriteStream);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureError(e);
     // if the directory was created, we should remove it
     if (dirExists === false) {
       try {
         await remove(dirPath);
         // we don't want to override the original error
-      } catch (err) {}
+      } catch (_error) {}
     }
 
     // If the code is defined, we assume the error to be related to the file system
-    if (e.code !== undefined) {
+    if ("code" in e && e.code !== undefined) {
       throw new FileSystemAccessError(e.message, e);
     }
 
@@ -356,7 +373,7 @@ export async function readUtf8File(
   try {
     return await fsPromises.readFile(absolutePathToFile, { encoding: "utf8" });
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
 
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePathToFile, e);
@@ -398,13 +415,13 @@ export async function writeUtf8File(
       flag,
     });
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     // if the directory was created, we should remove it
     if (dirExists === false) {
       try {
         await remove(dirPath);
         // we don't want to override the original error
-      } catch (err) {}
+      } catch (_error) {}
     }
 
     if (e.code === "ENOENT") {
@@ -436,7 +453,7 @@ export async function readBinaryFile(
     const buffer = await fsPromises.readFile(absolutePathToFile);
     return new Uint8Array(buffer);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
 
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePathToFile, e);
@@ -463,7 +480,7 @@ export async function readdir(absolutePathToDir: string): Promise<string[]> {
   try {
     return await fsPromises.readdir(absolutePathToDir);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePathToDir, e);
     }
@@ -503,7 +520,7 @@ export async function mkdir(absolutePath: string): Promise<void> {
   try {
     await fsPromises.mkdir(absolutePath, { recursive: true });
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     throw new FileSystemAccessError(e.message, e);
   }
 }
@@ -514,6 +531,24 @@ export async function mkdir(absolutePath: string): Promise<void> {
  */
 export const ensureDir: typeof mkdir = mkdir;
 
+/**
+ * Creates a temporary directory with the specified prefix.
+ *
+ * @param prefix The prefix to use for the temporary directory.
+ * @returns The absolute path to the created temporary directory.
+ * @throws FileSystemAccessError for any error.
+ */
+export async function mkdtemp(prefix: string): Promise<string> {
+  try {
+    return await getRealPath(
+      await fsPromises.mkdtemp(path.join(tmpdir(), prefix)),
+    );
+  } catch (e) {
+    ensureNodeErrnoExceptionError(e);
+    throw new FileSystemAccessError(e.message, e);
+  }
+}
+
 /**
  * Retrieves the last change time of a file or directory's properties.
  * This includes changes to the file's metadata or contents.
@@ -528,7 +563,7 @@ export async function getChangeTime(absolutePath: string): Promise<Date> {
     const stats = await fsPromises.stat(absolutePath);
     return stats.ctime;
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -550,7 +585,7 @@ export async function getAccessTime(absolutePath: string): Promise<Date> {
     const stats = await fsPromises.stat(absolutePath);
     return stats.atime;
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -572,7 +607,7 @@ export async function getFileSize(absolutePath: string): Promise<number> {
     const stats = await fsPromises.stat(absolutePath);
     return stats.size;
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -591,7 +626,7 @@ export async function exists(absolutePath: string): Promise<boolean> {
   try {
     await fsPromises.access(absolutePath);
     return true;
-  } catch (e) {
+  } catch (_error) {
     return false;
   }
 }
@@ -610,7 +645,7 @@ export async function copy(source: string, destination: string): Promise<void> {
   try {
     await fsPromises.copyFile(source, destination);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       if (!(await exists(source))) {
         throw new FileNotFoundError(source, e);
@@ -654,7 +689,7 @@ export async function move(source: string, destination: string): Promise<void> {
   try {
     await fsPromises.rename(source, destination);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       if (!(await exists(source))) {
         throw new FileNotFoundError(source, e);
@@ -689,9 +724,10 @@ export async function remove(absolutePath: string): Promise<void> {
       recursive: true,
       force: true,
       maxRetries: 3,
+      retryDelay: 300,
     });
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     throw new FileSystemAccessError(e.message, e);
   }
 }
@@ -711,7 +747,7 @@ export async function chmod(
   try {
     await fsPromises.chmod(absolutePath, mode);
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       throw new FileNotFoundError(absolutePath, e);
     }
@@ -748,7 +784,7 @@ export async function emptyDir(absolutePath: string): Promise<void> {
     isDir = stats.isDirectory();
     mode = stats.mode;
   } catch (e) {
-    ensureError<NodeJS.ErrnoException>(e);
+    ensureNodeErrnoExceptionError(e);
     if (e.code === "ENOENT") {
       await mkdir(absolutePath);
       return;
@@ -763,7 +799,7 @@ export async function emptyDir(absolutePath: string): Promise<void> {
 
   await remove(absolutePath);
   await mkdir(absolutePath);
-  // eslint-disable-next-line no-bitwise -- Bitwise as common in fs permissions
+  // eslint-disable-next-line no-bitwise -- Bitwise is common in fs permissions
   await chmod(absolutePath, mode & 0o777);
 }
 

package/src/internal/bytecode.ts

@@ -12,7 +12,7 @@ import { isAddress } from "../eth.js";
 export interface Artifact {
   bytecode: string;
   linkReferences: {
-    [sourceName: string]: {
+    [inputSourceName: string]: {
       [libraryName: string]: Array<{ start: number; length: number }>;
     };
   };

package/src/package.ts

@@ -10,6 +10,31 @@ import { exists, findUp, getRealPath, readJsonFile } from "./fs.js";
 import { getFilePath } from "./internal/package.js";
 import { ensureTrailingSlash } from "./string.js";
 
+/* Adapted from `resolve.exports`. License: https://github.com/lukeed/resolve.exports/blob/master/license */
+
+export type PackageExports =
+  | PackageExportPath
+  | {
+      [path: PackageExportsEntry]: PackageExportsValue;
+      [condition: string]: PackageExportsValue;
+    };
+
+/** Allows "." and "./{name}" */
+export type PackageExportsEntry = `.${string}`;
+
+/** Internal path */
+export type PackageExportPath = `./${string}`;
+
+export type PackageExportsValue =
+  | PackageExportPath
+  | null
+  | {
+      [condition: string]: PackageExportsValue;
+    }
+  | PackageExportsValue[];
+
+/* End of `resolve.exports` adaptation */
+
 /**
  * The structure of a `package.json` file. This is a subset of the actual
  * `package.json` file, if you need to access other fields you add them here.
@@ -22,6 +47,7 @@ export interface PackageJson {
   engines?: {
     node?: string;
   };
+  exports?: PackageExports;
   dependencies?: Record<string, string>;
   devDependencies?: Record<string, string>;
   peerDependencies?: Record<string, string>;

package/src/path.ts

@@ -22,7 +22,7 @@ export function resolveFromRoot(root: string, target: string): string {
  * Tries to return a shorter version of the path if its inside the given folder.
  *
  * This is useful for displaying paths in the terminal, as they can be shorter
- * when they are insidde the current working directory. For example, if the
+ * when they are inside the current working directory. For example, if the
  * current working directory is `/home/user/project`, and the path is
  * `/home/user/project/contracts/File.sol`, the shorter path is
  * `contracts/File.sol`.
@@ -31,11 +31,21 @@ export function resolveFromRoot(root: string, target: string): string {
  * @param folder The absolute path to the folder.
  * @returns The shorter path, if possible, or the original path.
  */
-export function shortenPath(
-  absolutePath: string,
-  folder: string = process.cwd(),
-): string {
-  const relativePath = path.relative(folder, absolutePath);
+export function shortenPath(absolutePath: string): string {
+  const cwd = process.cwd();
+  let relativePath = path.relative(cwd, absolutePath);
+
+  if (relativePath === "..") {
+    return ".." + path.sep;
+  }
+
+  if (
+    !relativePath.startsWith(".." + path.sep) &&
+    !relativePath.startsWith("." + path.sep) &&
+    !path.isAbsolute(relativePath)
+  ) {
+    relativePath = "." + path.sep + relativePath;
+  }
 
   if (relativePath.length < absolutePath.length) {
     return relativePath;

package/src/request.ts

@@ -62,13 +62,22 @@ export interface RequestOptions {
   abortSignal?: AbortSignal | EventEmitter;
 }
 
+export interface HttpResponse {
+  statusCode: number;
+  body: {
+    json(): Promise<any>;
+    text(): Promise<string>;
+  };
+}
+
 /**
  * Performs a HTTP request.
  *
  * @param url The url to make the request to.
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
- * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
+ * @returns An object containing the status code and the response body. The body can be accessed as JSON or text.
+ * `body` can not be consumed twice. For example, calling `text()` after `json()` throws `TypeError`.
  * @throws ConnectionRefusedError If the connection is refused by the server.
  * @throws RequestTimeoutError If the request times out.
  * @throws RequestError If the request fails for any other reason.
@@ -77,7 +86,7 @@ export async function getRequest(
   url: string,
   requestOptions: RequestOptions = {},
   dispatcherOrDispatcherOptions?: UndiciT.Dispatcher | DispatcherOptions,
-): Promise<UndiciT.Dispatcher.ResponseData> {
+): Promise<HttpResponse> {
   const { request } = await import("undici");
 
   try {
@@ -106,7 +115,8 @@ export async function getRequest(
  * @param body The body of the request, represented as an object.
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
- * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
+ * @returns An object containing the status code and the response body. The body can be accessed as JSON or text.
+ * `body` can not be consumed twice. For example, calling `text()` after `json()` throws `TypeError`.
  * @throws ConnectionRefusedError If the connection is refused by the server.
  * @throws RequestTimeoutError If the request times out.
  * @throws RequestError If the request fails for any other reason.
@@ -116,7 +126,7 @@ export async function postJsonRequest(
   body: unknown,
   requestOptions: RequestOptions = {},
   dispatcherOrDispatcherOptions?: UndiciT.Dispatcher | DispatcherOptions,
-): Promise<UndiciT.Dispatcher.ResponseData> {
+): Promise<HttpResponse> {
   const { request } = await import("undici");
 
   try {
@@ -150,7 +160,8 @@ export async function postJsonRequest(
  * @param body The body of the request, represented as an object.
  * @param requestOptions The options to configure the request. See {@link RequestOptions}.
  * @param dispatcherOrDispatcherOptions Either a dispatcher or dispatcher options. See {@link DispatcherOptions}.
- * @returns The response data object. See {@link https://undici.nodejs.org/#/docs/api/Dispatcher?id=parameter-responsedata}.
+ * @returns An object containing the status code and the response body. The body can be accessed as JSON or text.
+ * `body` can not be consumed twice. For example, calling `text()` after `json()` throws `TypeError`.
  * @throws ConnectionRefusedError If the connection is refused by the server.
  * @throws RequestTimeoutError If the request times out.
  * @throws RequestError If the request fails for any other reason.
@@ -160,7 +171,7 @@ export async function postFormRequest(
   body: unknown,
   requestOptions: RequestOptions = {},
   dispatcherOrDispatcherOptions?: UndiciT.Dispatcher | DispatcherOptions,
-): Promise<UndiciT.Dispatcher.ResponseData> {
+): Promise<HttpResponse> {
   const { request } = await import("undici");
 
   try {
@@ -208,11 +219,16 @@ export async function download(
   let statusCode: number | undefined;
 
   try {
-    const response = await getRequest(
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    -- We need the full Dispatcher.ResponseData here for stream.pipeline,
+    but HttpResponse doesn’t expose the raw ReadableStream.
+    TODO: wrap undici's request so we can keep the public API
+    strictly typed without falling back to Undici types. */
+    const response = (await getRequest(
       url,
       requestOptions,
       dispatcherOrDispatcherOptions,
-    );
+    )) as UndiciT.Dispatcher.ResponseData;
     const { body } = response;
     statusCode = response.statusCode;
 

package/src/stream.ts

@@ -1,7 +1,7 @@
 import { Writable } from "node:stream";
 
 /**
- * Creates a Tansform that writes everything to actualWritable, without closing it
+ * Creates a Transform that writes everything to actualWritable, without closing it
  * when finished.
  *
  * This is useful to pipe things to stdout, without closing it, while being

package/src/subprocess.ts

@@ -33,7 +33,7 @@ export async function spawnDetachedSubProcess(
   const subprocessArgs = [absolutePathToSubProcessFile, ...args];
 
   if (absolutePathToSubProcessFile.endsWith(".ts")) {
-    subprocessArgs.unshift("--import", "tsx/esm");
+    subprocessArgs.unshift("--import", import.meta.resolve("tsx/esm"));
   }
 
   const subprocess = spawn(process.execPath, subprocessArgs, {

package/src/synchronization.ts

@@ -13,7 +13,7 @@ import path from "node:path";
 
 import debug from "debug";
 
-import { ensureError } from "./error.js";
+import { ensureNodeErrnoExceptionError } from "./error.js";
 import { FileSystemAccessError } from "./errors/fs.js";
 import { sleep } from "./lang.js";
 
@@ -62,7 +62,7 @@ export class MultiProcessMutex {
       fs.writeFileSync(this.#mutexFilePath, "", { flag: "wx+" });
       return true;
     } catch (e) {
-      ensureError<NodeJS.ErrnoException>(e);
+      ensureNodeErrnoExceptionError(e);
 
       if (e.code === "EEXIST") {
         // File already exists, so the mutex is already acquired
@@ -91,7 +91,7 @@ export class MultiProcessMutex {
     try {
       fileStat = fs.statSync(this.#mutexFilePath);
     } catch (e) {
-      ensureError<NodeJS.ErrnoException>(e);
+      ensureNodeErrnoExceptionError(e);
 
       if (e.code === "ENOENT") {
         // The file might have been deleted by another process while this function was trying to access it.
@@ -113,7 +113,7 @@ export class MultiProcessMutex {
       log(`Deleting mutex file at path '${this.#mutexFilePath}'`);
       fs.unlinkSync(this.#mutexFilePath);
     } catch (e) {
-      ensureError<NodeJS.ErrnoException>(e);
+      ensureNodeErrnoExceptionError(e);
 
       if (e.code === "ENOENT") {
         // The file might have been deleted by another process while this function was trying to access it.