hardhat 3.1.9 → 3.1.11

package/src/internal/cli/main.ts

@@ -28,6 +28,7 @@ import {
   type OptionDefinition,
   type PositionalArgumentDefinition,
 } from "../../types/arguments.js";
+import { isResult } from "../../utils/result.js";
 import { BUILTIN_GLOBAL_OPTIONS_DEFINITIONS } from "../builtin-global-options.js";
 import { builtinPlugins } from "../builtin-plugins/index.js";
 import {
@@ -217,7 +218,24 @@ export async function main(
 
     log(`Running task "${task.id.join(" ")}"`);
 
-    await Promise.all([task.run(taskArguments), sendTaskAnalytics(task.id)]);
+    const [taskResult] = await Promise.all([
+      task.run(taskArguments),
+      sendTaskAnalytics(task.id),
+    ]);
+
+    if (isResult(taskResult) && !taskResult.success) {
+      process.exitCode = 1;
+    }
+
+    if (!isCi() && process.stdout.isTTY === true) {
+      try {
+        const { BannerManager } = await import("./banner-manager.js");
+        const bannerManager = await BannerManager.getInstance();
+        await bannerManager.showBanner(200);
+      } catch (bannerError) {
+        log("Error showing banner", bannerError);
+      }
+    }
   } catch (error) {
     ensureError(error);
     printErrorMessages(error, builtinGlobalOptions?.showStackTraces);

package/src/internal/cli/telemetry/analytics/subprocess.ts

@@ -5,7 +5,9 @@ import { postJsonRequest } from "@nomicfoundation/hardhat-utils/request";
 
 // These keys are expected to be public
 const ANALYTICS_URL = "https://www.google-analytics.com/mp/collect";
+/* cspell:disable-next-line */
 // const API_SECRET = "iXzTRik5RhahYpgiatSv1w"; // DEV
+/* cspell:disable-next-line */
 // const MEASUREMENT_ID = "G-ZFZWHGZ64H"; // DEV
 const API_SECRET = "fQ5joCsDRTOp55wX8a2cVw"; // PROD
 const MEASUREMENT_ID = "G-8LQ007N2QJ"; // PROD

package/src/internal/cli/telemetry/sentry/anonymize-paths.ts

@@ -107,7 +107,7 @@ function anonymizeSinglePath(path: string): string {
     return normalizedPath;
   }
 
-  // We first get the index of the first /node_modules to desambiguate some
+  // We first get the index of the first /node_modules to disambiguate some
   // special cases below
   const nodeModulesIndex = normalizedPath.indexOf("/node_modules");
 

package/src/internal/cli/telemetry/sentry/reporter.ts

@@ -8,6 +8,7 @@ import {
   ProviderError,
   UnknownError,
 } from "../../../builtin-plugins/network-manager/provider-errors.js";
+import { UsingHardhat2PluginError } from "../../../using-hardhat2-plugin-errors.js";
 import { getHardhatVersion } from "../../../utils/package.js";
 import { isTelemetryAllowed } from "../telemetry-permissions.js";
 
@@ -134,6 +135,10 @@ class Reporter {
       return false;
     }
 
+    if (error instanceof UsingHardhat2PluginError) {
+      return false;
+    }
+
     if (HardhatPluginError.isHardhatPluginError(error)) {
       // Don't log errors from third-party plugins
       return false;

package/src/internal/cli/telemetry/sentry/vendor/integrations/contextlines.ts

@@ -1,15 +1,15 @@
 /* eslint-disable -- This file is vendored from https://github.com/getsentry/sentry-javascript/blob/9.4.0/packages/node/src/integrations/contextlines.ts */
 
-import { createReadStream } from 'node:fs';
-import { createInterface } from 'node:readline';
-import type { Event, IntegrationFn, StackFrame } from '@sentry/core';
-import { LRUMap, defineIntegration, logger, snipLine } from '@sentry/core';
-import { DEBUG_BUILD } from '../debug-build.js';
+import { createReadStream } from "node:fs";
+import { createInterface } from "node:readline";
+import type { Event, IntegrationFn, StackFrame } from "@sentry/core";
+import { LRUMap, defineIntegration, logger, snipLine } from "@sentry/core";
+import { DEBUG_BUILD } from "../debug-build.js";
 
 const LRU_FILE_CONTENTS_CACHE = new LRUMap<string, Record<number, string>>(10);
 const LRU_FILE_CONTENTS_FS_READ_FAILED = new LRUMap<string, 1>(20);
 const DEFAULT_LINES_OF_CONTEXT = 7;
-const INTEGRATION_NAME = 'ContextLines';
+const INTEGRATION_NAME = "ContextLines";
 // Determines the upper bound of lineno/colno that we will attempt to read. Large colno values are likely to be
 // minified code while large lineno values are likely to be bundled code.
 // Exported for testing purposes.
@@ -36,7 +36,11 @@ export function resetFileContentCache(): void {
 /**
  * Get or init map value
  */
-function emplace<T extends LRUMap<K, V>, K extends string, V>(map: T, key: K, contents: V): V {
+function emplace<T extends LRUMap<K, V>, K extends string, V>(
+  map: T,
+  key: K,
+  contents: V,
+): V {
   const value = map.get(key);
 
   if (value === undefined) {
@@ -49,18 +53,18 @@ function emplace<T extends LRUMap<K, V>, K extends string, V>(map: T, key: K, co
 
 /**
  * Determines if context lines should be skipped for a file.
- * - .min.(mjs|cjs|js) files are and not useful since they dont point to the original source
+ * - .min.(mjs|cjs|js) files are and not useful since they don't point to the original source
  * - node: prefixed modules are part of the runtime and cannot be resolved to a file
  * - data: skip json, wasm and inline js https://nodejs.org/api/esm.html#data-imports
  */
 function shouldSkipContextLinesForFile(path: string): boolean {
   // Test the most common prefix and extension first. These are the ones we
   // are most likely to see in user applications and are the ones we can break out of first.
-  if (path.startsWith('node:')) return true;
-  if (path.endsWith('.min.js')) return true;
-  if (path.endsWith('.min.cjs')) return true;
-  if (path.endsWith('.min.mjs')) return true;
-  if (path.startsWith('data:')) return true;
+  if (path.startsWith("node:")) return true;
+  if (path.endsWith(".min.js")) return true;
+  if (path.endsWith(".min.cjs")) return true;
+  if (path.endsWith(".min.mjs")) return true;
+  if (path.startsWith("data:")) return true;
   return false;
 }
 
@@ -68,14 +72,19 @@ function shouldSkipContextLinesForFile(path: string): boolean {
  * Determines if we should skip contextlines based off the max lineno and colno values.
  */
 function shouldSkipContextLinesForFrame(frame: StackFrame): boolean {
-  if (frame.lineno !== undefined && frame.lineno > MAX_CONTEXTLINES_LINENO) return true;
-  if (frame.colno !== undefined && frame.colno > MAX_CONTEXTLINES_COLNO) return true;
+  if (frame.lineno !== undefined && frame.lineno > MAX_CONTEXTLINES_LINENO)
+    return true;
+  if (frame.colno !== undefined && frame.colno > MAX_CONTEXTLINES_COLNO)
+    return true;
   return false;
 }
 /**
  * Checks if we have all the contents that we need in the cache.
  */
-function rangeExistsInContentCache(file: string, range: ReadlineRange): boolean {
+function rangeExistsInContentCache(
+  file: string,
+  range: ReadlineRange,
+): boolean {
   const contents = LRU_FILE_CONTENTS_CACHE.get(file);
   if (contents === undefined) return false;
 
@@ -92,7 +101,10 @@ function rangeExistsInContentCache(file: string, range: ReadlineRange): boolean
  * Creates contiguous ranges of lines to read from a file. In the case where context lines overlap,
  * the ranges are merged to create a single range.
  */
-function makeLineReaderRanges(lines: number[], linecontext: number): ReadlineRange[] {
+function makeLineReaderRanges(
+  lines: number[],
+  linecontext: number,
+): ReadlineRange[] {
   if (!lines.length) {
     return [];
   }
@@ -100,7 +112,7 @@ function makeLineReaderRanges(lines: number[], linecontext: number): ReadlineRan
   let i = 0;
   const line = lines[0];
 
-  if (typeof line !== 'number') {
+  if (typeof line !== "number") {
     return [];
   }
 
@@ -115,7 +127,7 @@ function makeLineReaderRanges(lines: number[], linecontext: number): ReadlineRan
 
     // If the next line falls into the current range, extend the current range to lineno + linecontext.
     const next = lines[i + 1];
-    if (typeof next !== 'number') {
+    if (typeof next !== "number") {
       break;
     }
     if (next <= current[1]) {
@@ -134,13 +146,17 @@ function makeLineReaderRanges(lines: number[], linecontext: number): ReadlineRan
 /**
  * Extracts lines from a file and stores them in a cache.
  */
-function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output: Record<number, string>): Promise<void> {
+function getContextLinesFromFile(
+  path: string,
+  ranges: ReadlineRange[],
+  output: Record<number, string>,
+): Promise<void> {
   return new Promise((resolve, _reject) => {
     // It is important *not* to have any async code between createInterface and the 'line' event listener
     // as it will cause the 'line' event to
     // be emitted before the listener is attached.
     const stream = createReadStream(path);
-    const lineReaded = createInterface({
+    const lineRead = createInterface({
       input: stream,
     });
 
@@ -170,18 +186,18 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
       // Mark file path as failed to read and prevent multiple read attempts.
       LRU_FILE_CONTENTS_FS_READ_FAILED.set(path, 1);
       DEBUG_BUILD && logger.error(`Failed to read file: ${path}. Error: ${e}`);
-      lineReaded.close();
-      lineReaded.removeAllListeners();
+      lineRead.close();
+      lineRead.removeAllListeners();
       destroyStreamAndResolve();
     }
 
     // We need to handle the error event to prevent the process from crashing in < Node 16
     // https://github.com/nodejs/node/pull/31603
-    stream.on('error', onStreamError);
-    lineReaded.on('error', onStreamError);
-    lineReaded.on('close', destroyStreamAndResolve);
+    stream.on("error", onStreamError);
+    lineRead.on("error", onStreamError);
+    lineRead.on("close", destroyStreamAndResolve);
 
-    lineReaded.on('line', line => {
+    lineRead.on("line", (line) => {
       lineNumber++;
       if (lineNumber < rangeStart) return;
 
@@ -191,16 +207,16 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
       if (lineNumber >= rangeEnd) {
         if (currentRangeIndex === ranges.length - 1) {
           // We need to close the file stream and remove listeners, else the reader will continue to run our listener;
-          lineReaded.close();
-          lineReaded.removeAllListeners();
+          lineRead.close();
+          lineRead.removeAllListeners();
           return;
         }
         currentRangeIndex++;
         const range = ranges[currentRangeIndex];
         if (range === undefined) {
           // This should never happen as it means we have a bug in the context.
-          lineReaded.close();
-          lineReaded.removeAllListeners();
+          lineRead.close();
+          lineRead.removeAllListeners();
           return;
         }
         rangeStart = range[0];
@@ -217,7 +233,10 @@ function getContextLinesFromFile(path: string, ranges: ReadlineRange[], output:
  * failing reads from happening.
  */
 
-async function addSourceContext(event: Event, contextLines: number): Promise<Event> {
+async function addSourceContext(
+  event: Event,
+  contextLines: number,
+): Promise<Event> {
   // keep a lookup map of which files we've already enqueued to read,
   // so we don't enqueue the same file multiple times which would cause multiple i/o reads
   const filesToLines: Record<string, number[]> = {};
@@ -236,8 +255,8 @@ async function addSourceContext(event: Event, contextLines: number): Promise<Eve
 
         if (
           !frame ||
-          typeof filename !== 'string' ||
-          typeof frame.lineno !== 'number' ||
+          typeof filename !== "string" ||
+          typeof frame.lineno !== "number" ||
           shouldSkipContextLinesForFile(filename) ||
           shouldSkipContextLinesForFrame(frame)
         ) {
@@ -258,7 +277,7 @@ async function addSourceContext(event: Event, contextLines: number): Promise<Eve
 
   const readlinePromises: Promise<void>[] = [];
   for (const file of files) {
-    // If we failed to read this before, dont try reading it again.
+    // If we failed to read this before, don't try reading it again.
     if (LRU_FILE_CONTENTS_FS_READ_FAILED.get(file)) {
       continue;
     }
@@ -272,7 +291,7 @@ async function addSourceContext(event: Event, contextLines: number): Promise<Eve
     filesToLineRanges.sort((a, b) => a - b);
     // Check if the contents are already in the cache and if we can avoid reading the file again.
     const ranges = makeLineReaderRanges(filesToLineRanges, contextLines);
-    if (ranges.every(r => rangeExistsInContentCache(file, r))) {
+    if (ranges.every((r) => rangeExistsInContentCache(file, r))) {
       continue;
     }
 
@@ -282,15 +301,25 @@ async function addSourceContext(event: Event, contextLines: number): Promise<Eve
 
   // The promise rejections are caught in order to prevent them from short circuiting Promise.all
   await Promise.all(readlinePromises).catch(() => {
-    DEBUG_BUILD && logger.log('Failed to read one or more source files and resolve context lines');
+    DEBUG_BUILD &&
+      logger.log(
+        "Failed to read one or more source files and resolve context lines",
+      );
   });
 
   // Perform the same loop as above, but this time we can assume all files are in the cache
   // and attempt to add source context to frames.
   if (contextLines > 0 && event.exception?.values) {
     for (const exception of event.exception.values) {
-      if (exception.stacktrace?.frames && exception.stacktrace.frames.length > 0) {
-        addSourceContextToFrames(exception.stacktrace.frames, contextLines, LRU_FILE_CONTENTS_CACHE);
+      if (
+        exception.stacktrace?.frames &&
+        exception.stacktrace.frames.length > 0
+      ) {
+        addSourceContextToFrames(
+          exception.stacktrace.frames,
+          contextLines,
+          LRU_FILE_CONTENTS_CACHE,
+        );
       }
     }
   }
@@ -307,7 +336,11 @@ function addSourceContextToFrames(
 ): void {
   for (const frame of frames) {
     // Only add context if we have a filename and it hasn't already been added
-    if (frame.filename && frame.context_line === undefined && typeof frame.lineno === 'number') {
+    if (
+      frame.filename &&
+      frame.context_line === undefined &&
+      typeof frame.lineno === "number"
+    ) {
       const contents = cache.get(frame.filename);
       if (contents === undefined) {
         continue;
@@ -340,29 +373,34 @@ export function addContextToFrame(
   // When there is no line number in the frame, attaching context is nonsensical and will even break grouping.
   // We already check for lineno before calling this, but since StackFrame lineno ism optional, we check it again.
   if (frame.lineno === undefined || contents === undefined) {
-    DEBUG_BUILD && logger.error('Cannot resolve context for frame with no lineno or file contents');
+    DEBUG_BUILD &&
+      logger.error(
+        "Cannot resolve context for frame with no lineno or file contents",
+      );
     return;
   }
 
   frame.pre_context = [];
   for (let i = makeRangeStart(lineno, contextLines); i < lineno; i++) {
-    // We always expect the start context as line numbers cannot be negative. If we dont find a line, then
+    // We always expect the start context as line numbers cannot be negative. If we don't find a line, then
     // something went wrong somewhere. Clear the context and return without adding any linecontext.
     const line = contents[i];
     if (line === undefined) {
       clearLineContext(frame);
-      DEBUG_BUILD && logger.error(`Could not find line ${i} in file ${frame.filename}`);
+      DEBUG_BUILD &&
+        logger.error(`Could not find line ${i} in file ${frame.filename}`);
       return;
     }
 
     frame.pre_context.push(line);
   }
 
-  // We should always have the context line. If we dont, something went wrong, so we clear the context and return
+  // We should always have the context line. If we don't, something went wrong, so we clear the context and return
   // without adding any linecontext.
   if (contents[lineno] === undefined) {
     clearLineContext(frame);
-    DEBUG_BUILD && logger.error(`Could not find line ${lineno} in file ${frame.filename}`);
+    DEBUG_BUILD &&
+      logger.error(`Could not find line ${lineno} in file ${frame.filename}`);
     return;
   }
 
@@ -371,7 +409,7 @@ export function addContextToFrame(
   const end = makeRangeEnd(lineno, contextLines);
   frame.post_context = [];
   for (let i = lineno + 1; i <= end; i++) {
-    // Since we dont track when the file ends, we cant clear the context if we dont find a line as it could
+    // Since we don't track when the file ends, we cant clear the context if we don't find a line as it could
     // just be that we reached the end of the file.
     const line = contents[i];
     if (line === undefined) {
@@ -393,13 +431,21 @@ function makeRangeEnd(line: number, linecontext: number): number {
   return line + linecontext;
 }
 // Determine start and end indices for context range (inclusive);
-function makeContextRange(line: number, linecontext: number): [start: number, end: number] {
+function makeContextRange(
+  line: number,
+  linecontext: number,
+): [start: number, end: number] {
   return [makeRangeStart(line, linecontext), makeRangeEnd(line, linecontext)];
 }
 
 /** Exported only for tests, as a type-safe variant. */
-export const _contextLinesIntegration: any = ((options: ContextLinesOptions = {}) => {
-  const contextLines = options.frameContextLines !== undefined ? options.frameContextLines : DEFAULT_LINES_OF_CONTEXT;
+export const _contextLinesIntegration: any = ((
+  options: ContextLinesOptions = {},
+) => {
+  const contextLines =
+    options.frameContextLines !== undefined
+      ? options.frameContextLines
+      : DEFAULT_LINES_OF_CONTEXT;
 
   return {
     name: INTEGRATION_NAME,
@@ -412,4 +458,6 @@ export const _contextLinesIntegration: any = ((options: ContextLinesOptions = {}
 /**
  * Capture the lines before and after the frame's context.
  */
-export const contextLinesIntegration: any = defineIntegration(_contextLinesIntegration);
+export const contextLinesIntegration: any = defineIntegration(
+  _contextLinesIntegration,
+);

package/src/internal/core/config-validation.ts

@@ -18,9 +18,9 @@ import {
 } from "../../types/arguments.js";
 import {
   type EmptyTaskDefinition,
+  TaskDefinitionType,
   type NewTaskDefinition,
   type TaskDefinition,
-  TaskDefinitionType,
   type TaskOverrideDefinition,
 } from "../../types/tasks.js";
 
@@ -185,6 +185,7 @@ function validatePath(
 export function validateTasksConfig(
   tasks: TaskDefinition[],
   path: Array<string | number> = [],
+  isPlugin: boolean = false,
 ): HardhatUserConfigValidationError[] {
   const validationErrors: HardhatUserConfigValidationError[] = [];
 
@@ -207,13 +208,13 @@ export function validateTasksConfig(
       }
       case TaskDefinitionType.NEW_TASK: {
         validationErrors.push(
-          ...validateNewTask(task, [...path, "tasks", index]),
+          ...validateNewTask(task, [...path, "tasks", index], isPlugin),
         );
         break;
       }
       case TaskDefinitionType.TASK_OVERRIDE: {
         validationErrors.push(
-          ...validateTaskOverride(task, [...path, "tasks", index]),
+          ...validateTaskOverride(task, [...path, "tasks", index], isPlugin),
         );
         break;
       }
@@ -252,6 +253,7 @@ export function validateEmptyTask(
 export function validateNewTask(
   task: NewTaskDefinition,
   path: Array<string | number>,
+  isPlugin: boolean = false,
 ): HardhatUserConfigValidationError[] {
   const validationErrors: HardhatUserConfigValidationError[] = [];
 
@@ -272,13 +274,7 @@ export function validateNewTask(
     });
   }
 
-  if (typeof task.action !== "function") {
-    validationErrors.push({
-      path: [...path, "action"],
-      message:
-        "task action must be a lazy import function returning a module with a default export",
-    });
-  }
+  validationErrors.push(...validateActionFields(task, path, isPlugin));
 
   if (isObject(task.options)) {
     validationErrors.push(
@@ -308,6 +304,7 @@ export function validateNewTask(
 export function validateTaskOverride(
   task: TaskOverrideDefinition,
   path: Array<string | number>,
+  isPlugin: boolean = false,
 ): HardhatUserConfigValidationError[] {
   const validationErrors: HardhatUserConfigValidationError[] = [];
 
@@ -328,13 +325,7 @@ export function validateTaskOverride(
     });
   }
 
-  if (typeof task.action !== "function") {
-    validationErrors.push({
-      path: [...path, "action"],
-      message:
-        "task action must be a lazy import function returning a module with a default export",
-    });
-  }
+  validationErrors.push(...validateActionFields(task, path, isPlugin));
 
   if (isObject(task.options)) {
     validationErrors.push(
@@ -350,6 +341,60 @@ export function validateTaskOverride(
   return validationErrors;
 }
 
+function validateActionFields(
+  task: { action?: unknown; inlineAction?: unknown },
+  path: Array<string | number>,
+  isPlugin: boolean = false,
+): HardhatUserConfigValidationError[] {
+  const validationErrors: HardhatUserConfigValidationError[] = [];
+
+  // Mutual exclusivity: cannot have both action and inlineAction
+  if (task.action !== undefined && task.inlineAction !== undefined) {
+    validationErrors.push({
+      path: [...path],
+      message: 'task cannot define both "action" and "inlineAction"',
+    });
+  }
+
+  if (isPlugin && task.inlineAction !== undefined) {
+    validationErrors.push({
+      path: [...path, "inlineAction"],
+      message:
+        "plugins cannot use inline actions. Use a lazy action import instead",
+    });
+  }
+
+  // At least one action must be defined
+  if (task.action === undefined && task.inlineAction === undefined) {
+    validationErrors.push({
+      path: [...path, "action"],
+      message: 'task must define either "action" or "inlineAction"',
+    });
+  }
+
+  if (task.action !== undefined) {
+    if (typeof task.action !== "function") {
+      validationErrors.push({
+        path: [...path, "action"],
+        message:
+          "task action must be a lazy import function returning a module with a default export",
+      });
+    }
+  }
+
+  if (task.inlineAction !== undefined) {
+    if (typeof task.inlineAction !== "function") {
+      validationErrors.push({
+        path: [...path, "inlineAction"],
+        message:
+          "task inlineAction must be a function implementing the task's behavior",
+      });
+    }
+  }
+
+  return validationErrors;
+}
+
 export function validateOptions(
   options: Record<string, OptionDefinition>,
   path: Array<string | number>,
@@ -665,7 +710,11 @@ export function validatePluginsConfig(
     if (plugin.tasks !== undefined) {
       if (Array.isArray(plugin.tasks)) {
         validationErrors.push(
-          ...validateTasksConfig(plugin.tasks, [...path, "plugins", index]),
+          ...validateTasksConfig(
+            plugin.tasks,
+            [...path, "plugins", index],
+            true,
+          ),
         );
       } else {
         validationErrors.push({