hardhat 3.5.0 → 3.6.0

package/src/internal/core/tasks/resolved-task.ts

@@ -22,7 +22,7 @@ import { ensureError } from "@nomicfoundation/hardhat-utils/error";
 
 import { detectPluginNpmDependencyProblems } from "../plugins/detect-plugin-npm-dependency-problems.js";
 
-import { formatTaskId } from "./utils.js";
+import { formatTaskId, isArgumentRequired } from "./utils.js";
 import { validateTaskArgumentValue } from "./validations.js";
 
 export class ResolvedTask implements Task {
@@ -203,7 +203,10 @@ export class ResolvedTask implements Task {
     argument: PositionalArgumentDefinition,
     value: ArgumentValue | ArgumentValue[],
   ) {
-    if (argument.defaultValue === undefined && value === undefined) {
+    if (
+      isArgumentRequired(argument.type, argument.defaultValue) &&
+      value === undefined
+    ) {
       throw new HardhatError(
         HardhatError.ERRORS.CORE.TASK_DEFINITIONS.MISSING_VALUE_FOR_TASK_ARGUMENT,
         {

package/src/internal/core/tasks/utils.ts

@@ -1,3 +1,5 @@
+import type { ArgumentType, ArgumentValue } from "../../../types/arguments.js";
+
 export function formatTaskId(taskId: string | string[]): string {
   if (typeof taskId === "string") {
     return taskId;
@@ -9,3 +11,14 @@ export function formatTaskId(taskId: string | string[]): string {
 export function getActorFragment(pluginId: string | undefined): string {
   return pluginId !== undefined ? `Plugin ${pluginId} is` : "You are";
 }
+
+export function isOptionalArgumentType(type: ArgumentType): boolean {
+  return type.endsWith("_WITHOUT_DEFAULT");
+}
+
+export function isArgumentRequired(
+  type: ArgumentType,
+  defaultValue: ArgumentValue | ArgumentValue[] | undefined,
+): boolean {
+  return defaultValue === undefined && !isOptionalArgumentType(type);
+}

package/src/internal/core/tasks/validations.ts

@@ -19,7 +19,7 @@ import {
   validateArgumentValue,
 } from "../arguments.js";
 
-import { formatTaskId } from "./utils.js";
+import { isArgumentRequired, formatTaskId } from "./utils.js";
 
 export function validateId(id: string | string[]): void {
   if (id.length === 0) {
@@ -133,8 +133,8 @@ export function validatePositionalArgument(
 
   if (
     lastArg !== undefined &&
-    lastArg.defaultValue !== undefined &&
-    defaultValue === undefined
+    !isArgumentRequired(lastArg.type, lastArg.defaultValue) &&
+    isArgumentRequired(type, defaultValue)
   ) {
     throw new HardhatError(
       HardhatError.ERRORS.CORE.TASK_DEFINITIONS.REQUIRED_ARG_AFTER_OPTIONAL,

package/src/internal/using-hardhat2-plugin-errors.ts

@@ -13,21 +13,18 @@ export class UsingHardhat2PluginError extends CustomError {
     if (callerPath !== undefined) {
       message = `You are trying to use a Hardhat 2 plugin in a Hardhat 3 project.
 
-This file is part of a Hardhat 2 plugin calling an API that was removed in Hardhat 3: ${styleText("bold", callerPath)}
-
-Please read https://hardhat.org/migrate-from-hardhat2 to learn how to migrate your project to Hardhat 3.
-`;
+This file is part of a Hardhat 2 plugin calling an API that was removed in Hardhat 3: ${styleText("bold", callerPath)}`;
     } else {
-      message = `You are trying to use a Hardhat 2 plugin in a Hardhat 3 project.
-      
-Check the stack trace below to identify which plugin is causing this.
-
-Please read https://hardhat.org/migrate-from-hardhat2 to learn how to migrate your project to Hardhat 3.
-`;
+      message = `You are trying to use a Hardhat 2 plugin in a Hardhat 3 project.`;
     }
 
     super(message);
-    this.callerRelativePath = callerPath;
+    // Use a non-enumerable property so that `console.error(error)` does not
+    // print `{ callerRelativePath: '…' }` after the stack trace.
+    Object.defineProperty(this, "callerRelativePath", {
+      value: callerPath,
+      enumerable: false,
+    });
   }
 }
 

package/src/types/solidity/build-system.ts

@@ -52,18 +52,36 @@ export interface BuildOptions {
    * and produce separate compilation passes.
    */
   scope?: BuildScope;
+
+  /**
+   * If `true`, a clean up process is run after a successful build.
+   *
+   * The clean up deletes all the orphan artifacts that aren't reachable from
+   * the provided `rootFilePaths`.
+   *
+   * When building with `"contracts"` scope, it also updates the top-level
+   * `artifacts.d.ts`.
+   *
+   * Only use this option when the provided `rootFilePaths` represent the
+   * entire set of contracts for the scope you are using (i.e. not during
+   * partial builds). Otherwise, you'll delete artifacts generated in previous
+   * builds, despite their sources still being available.
+   */
+  cleanupArtifacts?: boolean;
 }
 
+/**
+ * The resolved BuildOptions used to run a build.
+ */
+export type ResolvedBuildOptions = Required<BuildOptions>;
+
 /**
  * The options of the `getCompilationJobs` method.
  *
  * Note that this option object includes a `quiet` property, as this process
  * may require downloading compilers, and potentially printing some output.
  */
-export type GetCompilationJobsOptions = Omit<
-  BuildOptions,
-  "removeUnusedArtifacts"
->;
+export type GetCompilationJobsOptions = Omit<BuildOptions, "cleanupArtifacts">;
 
 /**
  * The options of the `runCompilationJob` method.
@@ -434,11 +452,12 @@ export interface SolidityBuildSystem {
    *      used.
    *
    * @param rootFilePaths All the root files of the project.
+   * @returns The list of artifact paths that remain after the cleanup.
    */
   cleanupArtifacts(
     rootFilePaths: string[],
     options?: { scope?: BuildScope },
-  ): Promise<void>;
+  ): Promise<string[]>;
 
   /**
    * Compiles a build info, returning the output of the compilation, verbatim,

package/templates/hardhat-3/01-node-test-runner-viem/AGENTS.md

@@ -0,0 +1,20 @@
+# Hardhat + viem project
+
+## Project layout
+
+```
+contracts/        Solidity source files (*.sol) and unit tests (*.t.sol)
+test/             TypeScript integration tests and Solidity unit tests (*.sol)
+ignition/         Hardhat Ignition deployment modules
+scripts/          Standalone scripts run with `hardhat run`
+hardhat.config.ts
+```
+
+## Working in this project
+
+When writing or modifying tests, configuring `hardhat.config.ts`, or interacting with the network from TypeScript, invoke the **`hardhat`** skill. It covers Solidity and TypeScript testing, how to choose between them, `forge-std` cheatcodes, the `network.create()` API, `networkHelpers`, and the compile-then-typecheck workflow. The skill itself points to the matching `hardhat-toolbox-*` skill for toolbox-specific guidance (clients, contract interaction, assertions).
+
+## Docs
+
+- Hardhat 3 — https://hardhat.org/llms.txt
+- viem — https://viem.sh/llms.txt

package/templates/hardhat-3/01-node-test-runner-viem/package.json

@@ -5,7 +5,7 @@
   "description": "A TypeScript Hardhat project using Node Test Runner and Viem",
   "type": "module",
   "devDependencies": {
-    "hardhat": "workspace:^3.5.0",
+    "hardhat": "workspace:^3.6.0",
     "@nomicfoundation/hardhat-toolbox-viem": "workspace:^5.0.6",
     "@nomicfoundation/hardhat-ignition": "workspace:^3.1.6",
     "@types/node": "^22.8.5",
@@ -15,11 +15,11 @@
   },
   "peerDependencies": {
     "@nomicfoundation/hardhat-ignition-viem": "workspace:^3.1.5",
-    "@nomicfoundation/hardhat-keystore": "workspace:^3.0.10",
+    "@nomicfoundation/hardhat-keystore": "workspace:^3.0.11",
     "@nomicfoundation/hardhat-network-helpers": "workspace:^3.0.9",
     "@nomicfoundation/hardhat-node-test-runner": "workspace:^3.0.16",
     "@nomicfoundation/hardhat-viem": "workspace:^3.0.8",
-    "@nomicfoundation/hardhat-viem-assertions": "workspace:^3.0.12",
+    "@nomicfoundation/hardhat-viem-assertions": "workspace:^3.1.0",
     "@nomicfoundation/hardhat-verify": "workspace:^3.0.18",
     "@nomicfoundation/ignition-core": "workspace:^3.1.6"
   }

package/templates/hardhat-3/02-mocha-ethers/AGENTS.md

@@ -0,0 +1,20 @@
+# Hardhat + ethers project
+
+## Project layout
+
+```
+contracts/        Solidity source files (*.sol) and unit tests (*.t.sol)
+test/             TypeScript integration tests and Solidity unit tests (*.sol)
+ignition/         Hardhat Ignition deployment modules
+scripts/          Standalone scripts run with `hardhat run`
+hardhat.config.ts
+```
+
+## Working in this project
+
+When writing or modifying tests, configuring `hardhat.config.ts`, or interacting with the network from TypeScript, invoke the **`hardhat`** skill. It covers Solidity and TypeScript testing, how to choose between them, `forge-std` cheatcodes, the `network.create()` API, `networkHelpers`, and the compile-then-typecheck workflow. The skill itself points to the matching `hardhat-toolbox-*` skill for toolbox-specific guidance (signers, contract interaction, assertions).
+
+## Docs
+
+- Hardhat 3 — https://hardhat.org/llms.txt
+- ethers.js — https://docs.ethers.org/v6/

package/templates/hardhat-3/02-mocha-ethers/package.json

@@ -5,7 +5,7 @@
   "description": "A TypeScript Hardhat project using Mocha and Ethers.js",
   "type": "module",
   "devDependencies": {
-    "hardhat": "workspace:^3.5.0",
+    "hardhat": "workspace:^3.6.0",
     "@nomicfoundation/hardhat-toolbox-mocha-ethers": "workspace:^3.0.6",
     "@nomicfoundation/hardhat-ethers": "workspace:^4.0.12",
     "@nomicfoundation/hardhat-ignition": "workspace:^3.1.6",
@@ -24,10 +24,10 @@
     "@nomicfoundation/hardhat-ethers-chai-matchers": "workspace:^3.0.9",
     "@nomicfoundation/hardhat-ignition": "workspace:^3.1.6",
     "@nomicfoundation/hardhat-ignition-ethers": "workspace:^3.1.5",
-    "@nomicfoundation/hardhat-keystore": "workspace:^3.0.10",
+    "@nomicfoundation/hardhat-keystore": "workspace:^3.0.11",
     "@nomicfoundation/hardhat-mocha": "workspace:^3.0.20",
     "@nomicfoundation/hardhat-network-helpers": "workspace:^3.0.9",
-    "@nomicfoundation/hardhat-typechain": "workspace:^3.0.9",
+    "@nomicfoundation/hardhat-typechain": "workspace:^3.1.0",
     "@nomicfoundation/hardhat-verify": "workspace:^3.0.18",
     "@nomicfoundation/ignition-core": "workspace:^3.1.6"
   }

package/templates/hardhat-3/03-minimal/package.json

@@ -5,7 +5,7 @@
   "description": "A minimal Hardhat project",
   "type": "module",
   "devDependencies": {
-    "hardhat": "workspace:^3.5.0",
+    "hardhat": "workspace:^3.6.0",
     "@types/node": "^22.8.5",
     "typescript": "~6.0.3"
   }