Merge branch 'main' into 7253

Author: michalbrabec

.changeset/chilled-ladybugs-watch.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-viem-assertions": patch
+---
+
+Support panic errors in `hardhat-viem-assetions` and improve error messages [7354](https://github.com/NomicFoundation/hardhat/pull/7354) [7384](https://github.com/NomicFoundation/hardhat/pull/7384)

.changeset/kind-avocados-compete.md

@@ -0,0 +1,8 @@
+---
+"@nomicfoundation/hardhat-mocha": patch
+"@nomicfoundation/hardhat-node-test-runner": patch
+"@nomicfoundation/hardhat-utils": patch
+"hardhat": patch
+---
+
+Load resolved global options into environment variables during tests ([#7305](https://github.com/NomicFoundation/hardhat/pull/7305))

v-next/hardhat-mocha/src/task-action.ts

@@ -5,6 +5,7 @@ import type { MochaOptions } from "mocha";
 import { resolve as pathResolve } from "node:path";
 
 import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import { setGlobalOptionsAsEnvVariables } from "@nomicfoundation/hardhat-utils/env";
 import { getAllFilesMatching } from "@nomicfoundation/hardhat-utils/fs";
 import {
   markTestRunDone,
@@ -53,6 +54,8 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   // Set an environment variable that plugins can use to detect when a process is running tests
   process.env.HH_TEST = "true";
 
+  setGlobalOptionsAsEnvVariables(hre.globalOptions);
+
   if (!noCompile) {
     await hre.tasks.getTask("compile").run({});
     console.log();
@@ -71,10 +74,6 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
     imports.push(tsx.href);
 
     if (hre.globalOptions.coverage === true) {
-      // NOTE: We set the HARDHAT_COVERAGE environment variable here because, as of now,
-      // the global options are not automatically passed to the child processes.
-      process.env.HARDHAT_COVERAGE = "true";
-
       const coverage = new URL(
         import.meta.resolve("@nomicfoundation/hardhat-mocha/coverage"),
       );
@@ -83,10 +82,6 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
       hre.config.test.mocha.require.push(coverage.href);
     }
 
-    if (hre.globalOptions.network !== undefined) {
-      process.env.HARDHAT_NETWORK = hre.globalOptions.network;
-    }
-
     process.env.NODE_OPTIONS = imports
       .map((href) => `--import "${href}"`)
       .join(" ");

v-next/hardhat-node-test-runner/src/task-action.ts

@@ -7,6 +7,7 @@ import { run } from "node:test";
 import { URL } from "node:url";
 
 import { hardhatTestReporter } from "@nomicfoundation/hardhat-node-test-reporter";
+import { setGlobalOptionsAsEnvVariables } from "@nomicfoundation/hardhat-utils/env";
 import { getAllFilesMatching } from "@nomicfoundation/hardhat-utils/fs";
 import { createNonClosingWriter } from "@nomicfoundation/hardhat-utils/stream";
 import { markTestRunStart, markTestRunDone } from "hardhat/internal/coverage";
@@ -59,6 +60,8 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   // Set an environment variable that plugins can use to detect when a process is running tests
   process.env.HH_TEST = "true";
 
+  setGlobalOptionsAsEnvVariables(hre.globalOptions);
+
   if (!noCompile) {
     await hre.tasks.getTask("compile").run({});
     console.log();
@@ -76,20 +79,12 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   imports.push(tsx.href);
 
   if (hre.globalOptions.coverage === true) {
-    // NOTE: We set the HARDHAT_COVERAGE environment variable here because, as of now,
-    // the global options are not automatically passed to the child processes.
-    process.env.HARDHAT_COVERAGE = "true";
-
     const coverage = new URL(
       import.meta.resolve("@nomicfoundation/hardhat-node-test-runner/coverage"),
     );
     imports.push(coverage.href);
   }
 
-  if (hre.globalOptions.network !== undefined) {
-    process.env.HARDHAT_NETWORK = hre.globalOptions.network;
-  }
-
   process.env.NODE_OPTIONS = imports
     .map((href) => `--import "${href}"`)
     .join(" ");

v-next/hardhat-utils/package.json

@@ -20,6 +20,7 @@
     "./crypto": "./dist/src/crypto.js",
     "./date": "./dist/src/date.js",
     "./debug": "./dist/src/debug.js",
+    "./env": "./dist/src/env.js",
     "./error": "./dist/src/error.js",
     "./eth": "./dist/src/eth.js",
     "./fs": "./dist/src/fs.js",
@@ -28,6 +29,7 @@
     "./lang": "./dist/src/lang.js",
     "./number": "./dist/src/number.js",
     "./package": "./dist/src/package.js",
+    "./panic-errors": "./dist/src/panic-errors.js",
     "./path": "./dist/src/path.js",
     "./request": "./dist/src/request.js",
     "./string": "./dist/src/string.js",

v-next/hardhat-utils/src/env.ts

@@ -0,0 +1,33 @@
+import { camelToSnakeCase } from "./string.js";
+
+/**
+ * Sets the resolved global options as environment variables.
+ *
+ * @param globalOptions An object containing the resolved global options,
+ * with each option adhering to its definition in the globalOptionDefinitions.
+ */
+export function setGlobalOptionsAsEnvVariables<
+  T extends Record<keyof T, string | boolean>,
+>(globalOptions: T): void {
+  for (const [name, value] of Object.entries(globalOptions)) {
+    const envName = getEnvVariableNameFromGlobalOption(name);
+
+    if (value !== undefined) {
+      process.env[envName] = String(value);
+    }
+  }
+}
+
+/**
+ * Converts a global option name to its corresponding environment variable name.
+ * The conversion involves transforming the option name from camelCase to
+ * SNAKE_CASE and prefixing it with "HARDHAT_".
+ *
+ * @param globalOptionName The name of the global option in camelCase.
+ *
+ * @returns The corresponding environment variable name in the format
+ * "HARDHAT_<OPTION_NAME_IN_SNAKE_CASE>".
+ */
+export function getEnvVariableNameFromGlobalOption(globalOptionName: string) {
+  return `HARDHAT_${camelToSnakeCase(globalOptionName).toUpperCase()}`;
+}

v-next/hardhat/src/internal/builtin-plugins/network-manager/edr/stack-traces/panic-errors.ts renamed to v-next/hardhat-utils/src/panic-errors.ts

@@ -1,4 +1,4 @@
-import { numberToHexString } from "@nomicfoundation/hardhat-utils/hex";
+import { numberToHexString } from "./hex.js";
 
 export function panicErrorCodeToMessage(errorCode: bigint): string {
   const reason = panicErrorCodeToReason(errorCode);

v-next/hardhat-utils/test/env.ts

@@ -0,0 +1,30 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import {
+  getEnvVariableNameFromGlobalOption,
+  setGlobalOptionsAsEnvVariables,
+} from "../src/env.js";
+
+describe("env", () => {
+  describe("getEnvVariableNameFromGlobalOption", () => {
+    it("should load the global options in the env variables", async () => {
+      setGlobalOptionsAsEnvVariables({
+        network: "test-network",
+        coverage: true,
+      });
+
+      assert.equal(process.env.HARDHAT_NETWORK, "test-network");
+      assert.equal(process.env.HARDHAT_COVERAGE, "true");
+    });
+  });
+
+  describe("getEnvVariableNameFromGlobalOption", () => {
+    it("should return the global option name in env variable format", async () => {
+      assert.equal(
+        getEnvVariableNameFromGlobalOption("someOptionName"),
+        "HARDHAT_SOME_OPTION_NAME",
+      );
+    });
+  });
+});

v-next/hardhat-viem-assertions/src/internal/assertions/revert/error-string.ts

@@ -0,0 +1,17 @@
+import type { Hex } from "viem";
+
+const ERROR_STRING_SELECTOR = "0x08c379a0"; // Error(string)
+const PANIC_SELECTOR = "0x4e487b71"; // Panic(uint256)
+
+export function isKnownErrorSelector(data: Hex): boolean {
+  const standardizedData = data.toLowerCase();
+
+  return (
+    standardizedData.startsWith(ERROR_STRING_SELECTOR) ||
+    standardizedData.startsWith(PANIC_SELECTOR)
+  );
+}
+
+export function isPanicErrorSelector(data: Hex): boolean {
+  return data.toLowerCase().startsWith(PANIC_SELECTOR);
+}

v-next/hardhat-viem-assertions/src/internal/assertions/revert/extract-revert-data.ts renamed to v-next/hardhat-viem-assertions/src/internal/assertions/revert/extract-revert-error.ts

@@ -1,10 +1,11 @@
 import type { Hex } from "viem";
 
 import { assertHardhatInvariant } from "@nomicfoundation/hardhat-errors";
+import { ensureError } from "@nomicfoundation/hardhat-utils/error";
 import { isPrefixedHexString } from "@nomicfoundation/hardhat-utils/hex";
 
 /**
- * Recursively extracts, if it exists, the revert data hex string from a nested Viem error.
+ * Recursively extracts, if it exists, the revert data hex string from an error.
  *
  * When a contract call reverts, Viem throws an `Error` whose `data` property
  * contains the hex-encoded revert reason. That `data` may live on the top-level
@@ -17,29 +18,41 @@ import { isPrefixedHexString } from "@nomicfoundation/hardhat-utils/hex";
  *
  * @throws If no valid `0x` prefixed hex string revert data is found anywhere in the error chain.
  */
-export function extractRevertData(
-  error: Error & { data?: unknown; cause?: unknown },
-): Hex {
-  let errorData: Hex | undefined;
-  let current: typeof error | undefined = error;
+export function extractRevertError(error: unknown): {
+  name: string;
+  message: string;
+  data: Hex;
+} {
+  ensureError(error);
 
+  let dataReason: Hex | undefined;
+
+  let current: Error | undefined = error;
+  let message: string = "";
   while (current !== undefined) {
-    const { data } = current;
+    // Traverse the cause chain to find a valid raw error reason, if one exists.
+    if ("data" in current) {
+      const { data } = current;
 
-    if (typeof data === "string" && isPrefixedHexString(data)) {
-      errorData = data;
+      if (typeof data === "string" && isPrefixedHexString(data)) {
+        dataReason = data;
+        message = current.message;
+      }
     }
 
     /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     -- all the nested errors might contain a `cause` field */
-    current = current.cause as typeof error | undefined;
+    current = current.cause as Error | undefined;
   }
 
-  // In a revert scenario, a data field containing the revert reason is always expected
   assertHardhatInvariant(
-    errorData !== undefined,
-    "No revert data found on error",
+    dataReason !== undefined,
+    `No revert data found on error.\nError name: "${error.name}", message: ${error.message}`,
   );
 
-  return errorData;
+  return {
+    name: error.name,
+    message,
+    data: dataReason,
+  };
 }