Improve error messages for viem assertions (#7384)

Author: ChristopherDedominici

.changeset/clever-days-remain.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Fixed coverage report when loading data from large test suites ([#7385](https://github.com/NomicFoundation/hardhat/issues/7385))

.changeset/cold-shrimps-float.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-ethers": patch
+---
+
+Fixed index resolution in clearEventListeners ([#7359](https://github.com/NomicFoundation/hardhat/pull/7359))

.changeset/healthy-dryers-mate.md

@@ -1,8 +1,6 @@
 ---
 "@nomicfoundation/hardhat-errors": patch
 "hardhat": patch
-"@nomicfoundation/hardhat-utils": patch
-"@nomicfoundation/hardhat-zod-utils": patch
 ---
 
 Display an error message when attempting to use a global hardhat installation in a local repo ([#5362](https://github.com/NomicFoundation/hardhat/issues/5362))

.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-ethers/src/internal/hardhat-ethers-provider/hardhat-ethers-provider.ts

@@ -1283,7 +1283,7 @@ export class HardhatEthersProvider implements HardhatEthersProviderI {
     } else {
       const index = await this.#findEventListenerIndex(event);
 
-      if (index === -1) {
+      if (index !== -1) {
         const { listenersMap } = this.#eventListeners[index];
         this.#eventListeners.splice(index, 1);
         for (const blockListener of listenersMap.values()) {

v-next/hardhat-ethers/test/provider-events.ts

@@ -1,4 +1,5 @@
 import type { HardhatEthers } from "../src/types.js";
+import type { EventFilter } from "ethers";
 import type { EthereumProvider } from "hardhat/types/providers";
 
 import assert from "node:assert/strict";
@@ -327,6 +328,30 @@ describe("provider events", () => {
       // remove subscription
       await ethers.provider.off("block", listener);
     });
+
+    it("should be a no-op when removeAllListeners(unregistered event filter) is called", async () => {
+      const blockListener = mock.fn();
+      await ethers.provider.on("block", blockListener);
+
+      // event filter that was never registered
+      const unregisteredEventFilter: EventFilter = {
+        address: "0x0000000000000000000000000000000000000001",
+        topics: [],
+      };
+
+      // should not affect existing block listeners
+      await ethers.provider.removeAllListeners(unregisteredEventFilter);
+
+      // mine a block and ensure the block listener still fires
+      const [s] = await ethers.getSigners();
+      await s.sendTransaction({ to: s });
+
+      await tryUntil(() => {
+        assert.equal(blockListener.mock.callCount(), 1);
+      });
+
+      await ethers.provider.off("block", blockListener);
+    });
   });
 
   describe("listeners getters", () => {

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()}`;
+}