hardhat 3.0.0-next.4 → 3.0.0-next.6

package/src/internal/cli/init/init.ts

@@ -23,7 +23,6 @@ import * as semver from "semver";
 import { findClosestHardhatConfig } from "../../config-loading.js";
 import { HARDHAT_NAME } from "../../constants.js";
 import { getHardhatVersion } from "../../utils/package.js";
-import { ensureTelemetryConsent } from "../telemetry/telemetry-permissions.js";
 
 import {
   getDevDependenciesInstallationCommand,
@@ -101,10 +100,6 @@ export async function initHardhat(options?: InitHardhatOptions): Promise<void> {
     // Overwrite existing files only if the user opts-in to it
     await copyProjectFiles(workspace, template, options?.force);
 
-    // Ensure telemetry consent first so that we are allowed to also track
-    // the unfinished init flows
-    await ensureTelemetryConsent();
-
     // Print the commands to install the project dependencies
     // Run them only if the user opts-in to it
     await installProjectDependencies(workspace, template, options?.install);

package/src/internal/cli/main.ts

@@ -38,7 +38,6 @@ import { getGlobalHelpString } from "./help/get-global-help-string.js";
 import { getHelpString } from "./help/get-help-string.js";
 import { sendTaskAnalytics } from "./telemetry/analytics/analytics.js";
 import { sendErrorTelemetry } from "./telemetry/sentry/reporter.js";
-import { ensureTelemetryConsent } from "./telemetry/telemetry-permissions.js";
 import { printVersionMessage } from "./version.js";
 
 export interface MainOptions {
@@ -81,10 +80,6 @@ export async function main(
       return await initHardhat();
     }
 
-    await ensureTelemetryConsent();
-
-    log("Retrieved telemetry consent");
-
     configPath = await resolveHardhatConfigPath(
       builtinGlobalOptions.configPath,
     );

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

@@ -2,7 +2,7 @@ import type {
   EventNames,
   Payload,
   TaskParams,
-  TelemetryConsentPayload,
+  TelemetryConfigPayload,
 } from "./types.js";
 
 import os from "node:os";
@@ -24,25 +24,25 @@ const SESSION_ID = Math.random().toString();
 const ENGAGEMENT_TIME_MSEC = "10000";
 
 // Return a boolean for testing purposes to verify that analytics are not sent in CI environments
-export async function sendTelemetryConsentAnalytics(
-  consent: boolean,
+export async function sendTelemetryConfigAnalytics(
+  enabled: boolean,
 ): Promise<boolean> {
-  // This is a special scenario where only the consent is sent, all the other analytics info
-  // (like node version, hardhat version, etc.) are stripped.
+  // This is a special scenario where only the telemetry config is sent,
+  // all the other analytics info (like node version, hardhat version, etc.) are stripped.
 
   if (!isTelemetryAllowedInEnvironment()) {
     return false;
   }
 
-  const payload: TelemetryConsentPayload = {
-    client_id: "hardhat_telemetry_consent",
-    user_id: "hardhat_telemetry_consent",
+  const payload: TelemetryConfigPayload = {
+    client_id: "hardhat_telemetry_config",
+    user_id: "hardhat_telemetry_config",
     user_properties: {},
     events: [
       {
-        name: "TelemetryConsentResponse",
+        name: "TelemetryConfig",
         params: {
-          userConsent: consent ? "yes" : "no",
+          enabled,
         },
       },
     ],
@@ -78,7 +78,7 @@ async function sendAnalytics(
 }
 
 async function createSubprocessToSendAnalytics(
-  payload: TelemetryConsentPayload | Payload,
+  payload: TelemetryConfigPayload | Payload,
 ): Promise<void> {
   log(
     `Sending analytics for '${payload.events[0].name}'. Payload: ${JSON.stringify(payload)}`,

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

@@ -22,11 +22,11 @@ export interface BasePayload {
   }>;
 }
 
-export interface TelemetryConsentPayload extends BasePayload {
+export interface TelemetryConfigPayload extends BasePayload {
   events: Array<{
-    name: "TelemetryConsentResponse";
+    name: "TelemetryConfig";
     params: {
-      userConsent: "yes" | "no";
+      enabled: boolean;
       session_id?: string;
     };
   }>;

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

@@ -11,6 +11,7 @@ import { SENTRY_DSN } from "./reporter.js";
 try {
   init({
     dsn: SENTRY_DSN,
+    serverName: "<user-server>",
   });
 } catch (error) {
   process.exit(1);

package/src/internal/cli/telemetry/telemetry-permissions.ts

@@ -9,68 +9,33 @@ import {
 import { getTelemetryDir } from "@nomicfoundation/hardhat-utils/global-dir";
 import debug from "debug";
 
-import { confirmationPromptWithTimeout } from "../prompt/prompt.js";
-
-import { sendTelemetryConsentAnalytics } from "./analytics/analytics.js";
+import { sendTelemetryConfigAnalytics } from "./analytics/analytics.js";
 
 const log = debug("hardhat:cli:telemetry:telemetry-permissions");
 
-interface TelemetryConsent {
-  consent: boolean;
+interface TelemetryConfig {
+  enabled: boolean;
 }
 
 /**
- * Ensure that the user's telemetry consent is set. If the consent is already provided, returns the answer.
- * If not, prompts the user to provide it.
- * Consent is only asked in interactive environments.
+ * Checks whether telemetry is supported in the current environment and whether the user did not explicitly disable it.
  *
- * @param telemetryConsentFilePath - The path to the telemetry consent file,
- * which should only be provided in tests.
- * @returns True if the user consents to telemetry and if current environment supports telemetry, false otherwise.
- */
-export async function ensureTelemetryConsent(
-  telemetryConsentFilePath?: string,
-): Promise<boolean> {
-  log("Ensuring that user has provided telemetry consent");
-
-  if (!isTelemetryAllowedInEnvironment()) {
-    return false;
-  }
-
-  const consent = await getTelemetryConsent(telemetryConsentFilePath);
-  if (consent !== undefined) {
-    return consent;
-  }
-
-  // Telemetry consent not provided yet, ask for it
-  return requestTelemetryConsent();
-}
-
-/**
- * Checks whether telemetry is supported in the current environment and whether the user has provided consent.
- *
- * @param telemetryConsentFilePath - The path to the telemetry consent file,
- * which should only be provided in tests.
- * @returns True if the user consents to telemetry and if current environment supports telemetry, false otherwise.
+ * @param telemetryConfigFilePath - The path to the telemetry config file, which should only be provided in tests.
+ * @returns True if the user did not explicitly disable telemetry and if current environment supports it, false otherwise.
  */
 export async function isTelemetryAllowed(
-  telemetryConsentFilePath?: string,
+  telemetryConfigFilePath?: string,
 ): Promise<boolean> {
   if (!isTelemetryAllowedInEnvironment()) {
     return false;
   }
 
   // ATTENTION: only for testing
-  if (process.env.HARDHAT_TEST_TELEMETRY_CONSENT_VALUE !== undefined) {
-    return process.env.HARDHAT_TEST_TELEMETRY_CONSENT_VALUE === "true"
-      ? true
-      : false;
+  if (process.env.HARDHAT_TEST_TELEMETRY_ENABLED !== undefined) {
+    return process.env.HARDHAT_TEST_TELEMETRY_ENABLED === "true" ? true : false;
   }
 
-  const consent = await getTelemetryConsent(telemetryConsentFilePath);
-  log(`Telemetry consent value: ${consent}`);
-
-  return consent !== undefined ? consent : false;
+  return isTelemetryEnabled(telemetryConfigFilePath);
 }
 
 /**
@@ -85,7 +50,7 @@ export function isTelemetryAllowedInEnvironment(): boolean {
   const allowed =
     (!isCi() &&
       process.stdout.isTTY === true &&
-      process.env.HARDHAT_DISABLE_TELEMETRY_PROMPT !== "true") ||
+      process.env.HARDHAT_DISABLE_TELEMETRY !== "true") ||
     // ATTENTION: used in tests to force telemetry execution
     process.env.HARDHAT_TEST_INTERACTIVE_ENV === "true";
 
@@ -95,58 +60,44 @@ export function isTelemetryAllowedInEnvironment(): boolean {
 }
 
 /**
- * Retrieves the user's telemetry consent status from the consent file.
+ * Retrieves the user's telemetry enabled status from the config file.
  *
- * @param telemetryConsentFilePath - The path to the telemetry consent file,
- * which should only be provided in tests.
- * @returns True if the user consents to telemetry, false if they do not consent,
- * and undefined if no consent has been provided.
+ * @param telemetryConfigFilePath - The path to the telemetry config file, which should only be provided in tests.
+ * @returns True if the user did not explicitly disable telemetry, false otherwise.
  */
-async function getTelemetryConsent(telemetryConsentFilePath?: string) {
-  telemetryConsentFilePath ??= await getTelemetryConsentFilePath();
-
-  log(`Looking for telemetry consent file at ${telemetryConsentFilePath}`);
+async function isTelemetryEnabled(
+  telemetryConfigFilePath?: string,
+): Promise<boolean> {
+  telemetryConfigFilePath ??= await getTelemetryConfigFilePath();
 
-  if (await exists(telemetryConsentFilePath)) {
-    // Telemetry consent was already provided, hence return the answer
-    const consent = (
-      await readJsonFile<TelemetryConsent>(telemetryConsentFilePath)
-    ).consent;
+  log(`Looking for telemetry config file at ${telemetryConfigFilePath}`);
 
-    log(`Telemetry consent value: ${consent}`);
+  if (await exists(telemetryConfigFilePath)) {
+    // Telemetry enabled value was explicitly set, hence return the answer
+    const { enabled } = await readJsonFile<TelemetryConfig>(
+      telemetryConfigFilePath,
+    );
+    log(`Telemetry enabled value: ${enabled}`);
 
-    return consent;
+    return enabled;
   }
 
-  log("No telemetry consent file found");
+  log("No telemetry config file found, assuming telemetry is enabled");
 
-  return undefined;
+  return true;
 }
 
-async function getTelemetryConsentFilePath() {
+async function getTelemetryConfigFilePath() {
   const configDir = await getTelemetryDir();
-  return path.join(configDir, "telemetry-consent.json");
+  return path.join(configDir, "telemetry-config.json");
 }
 
-async function requestTelemetryConsent(): Promise<boolean> {
-  const consent = await confirmTelemetryConsent();
+export async function setTelemetryEnabled(value: boolean): Promise<boolean> {
+  log(`Storing telemetry enabled value: ${value}`);
 
-  if (consent === undefined) {
-    return false;
-  }
-
-  log(`Storing telemetry consent with value: ${consent}`);
-
-  await writeJsonFile(await getTelemetryConsentFilePath(), { consent });
+  await writeJsonFile(await getTelemetryConfigFilePath(), { enabled: value });
 
-  await sendTelemetryConsentAnalytics(consent);
-
-  return consent;
-}
+  await sendTelemetryConfigAnalytics(value);
 
-async function confirmTelemetryConsent(): Promise<boolean | undefined> {
-  return confirmationPromptWithTimeout(
-    "telemetryConsent",
-    "Help us improve Hardhat with anonymous crash reports & basic usage data?",
-  );
+  return value;
 }

package/src/types/utils.ts

@@ -43,3 +43,10 @@ export type Params<T> = T extends (...args: infer P) => any ? P : never;
  * The return type of a function.
  */
 export type Return<T> = T extends (...args: any[]) => infer Ret ? Ret : never;
+
+/**
+ * The same type as T, but with the specified keys required.
+ */
+export type RequireField<T, K extends keyof T> = T & {
+  [P in K]-?: T[P];
+};

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

@@ -5,8 +5,8 @@
   "description": "A TypeScript Hardhat project using Node Test Runner and Viem",
   "type": "module",
   "devDependencies": {
-    "hardhat": "workspace:^3.0.0-next.4",
-    "@nomicfoundation/hardhat-toolbox-viem": "workspace:^4.0.0-next.4",
+    "hardhat": "workspace:^3.0.0-next.6",
+    "@nomicfoundation/hardhat-toolbox-viem": "workspace:^4.0.0-next.6",
     "@types/node": "^22.8.5",
     "forge-std": "foundry-rs/forge-std#v1.9.4",
     "typescript": "~5.5.0",

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

@@ -5,8 +5,8 @@
   "description": "A TypeScript Hardhat project using Mocha and Ethers.js",
   "type": "module",
   "devDependencies": {
-    "hardhat": "workspace:^3.0.0-next.4",
-    "@nomicfoundation/hardhat-toolbox-mocha-ethers": "workspace:^3.0.0-next.4",
+    "hardhat": "workspace:^3.0.0-next.6",
+    "@nomicfoundation/hardhat-toolbox-mocha-ethers": "workspace:^3.0.0-next.6",
     "@types/chai": "^4.2.0",
     "@types/chai-as-promised": "^8.0.1",
     "@types/mocha": ">=10.0.10",

package/dist/src/internal/builtin-plugins/coverage/task-action.d.ts

@@ -1,2 +0,0 @@
-export default function (): Promise<void>;
-//# sourceMappingURL=task-action.d.ts.map

package/dist/src/internal/builtin-plugins/coverage/task-action.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"task-action.d.ts","sourceRoot":"","sources":["../../../../../src/internal/builtin-plugins/coverage/task-action.ts"],"names":[],"mappings":"AAEA,4BAAkC,OAAO,CAAC,IAAI,CAAC,CAM9C"}

package/dist/src/internal/builtin-plugins/coverage/task-action.js

@@ -1,5 +0,0 @@
-import chalk from "chalk";
-export default async function () {
-    console.log(chalk.yellow("This task will be implemented soon. Check back soon for more updates."));
-}
-//# sourceMappingURL=task-action.js.map

package/dist/src/internal/builtin-plugins/coverage/task-action.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"task-action.js","sourceRoot":"","sources":["../../../../../src/internal/builtin-plugins/coverage/task-action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,CAAC,OAAO,CAAC,KAAK;IAClB,OAAO,CAAC,GAAG,CACT,KAAK,CAAC,MAAM,CACV,uEAAuE,CACxE,CACF,CAAC;AACJ,CAAC"}

package/dist/src/internal/cli/prompt/prompt.d.ts

@@ -1,9 +0,0 @@
-/**
- * Display a confirmation prompt to the user. The prompt will be canceled if no response is given within a specified time limit.
- * @param name Used as the key for the answer on the returned values (answers) object.
- * @param message The message to display when the prompt is rendered in the terminal.
- * @param timeoutMilliseconds After how much time the prompt will be cancelled if no answer is given.
- * @returns True or false based on the user input, or undefined if the prompt times out.
- */
-export declare function confirmationPromptWithTimeout(name: string, message: string, timeoutMilliseconds?: number): Promise<boolean | undefined>;
-//# sourceMappingURL=prompt.d.ts.map

package/dist/src/internal/cli/prompt/prompt.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../../../../src/internal/cli/prompt/prompt.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAsB,6BAA6B,CACjD,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,mBAAmB,GAAE,MAAe,GACnC,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CA+B9B"}

package/dist/src/internal/cli/prompt/prompt.js

@@ -1,43 +0,0 @@
-/**
- * Display a confirmation prompt to the user. The prompt will be canceled if no response is given within a specified time limit.
- * @param name Used as the key for the answer on the returned values (answers) object.
- * @param message The message to display when the prompt is rendered in the terminal.
- * @param timeoutMilliseconds After how much time the prompt will be cancelled if no answer is given.
- * @returns True or false based on the user input, or undefined if the prompt times out.
- */
-export async function confirmationPromptWithTimeout(name, message, timeoutMilliseconds = 10_000) {
-    let timeout;
-    try {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- The types in the module "enquirer" are not properly defined
-        const { default: enquirer } = (await import("enquirer"));
-        const prompt = new enquirer.prompts.Confirm(createConfirmationPrompt(name, message));
-        // The timeout is a safety measure in case Hardhat is executed in a CI or another non-interactive environment and we do not detect it.
-        // Instead of blocking the process indefinitely, we abort the prompt after a while.
-        const timeoutPromise = new Promise((resolve) => {
-            timeout = setTimeout(resolve, timeoutMilliseconds);
-        });
-        const result = await Promise.race([
-            prompt.run(),
-            timeoutPromise,
-        ]);
-        if (result === undefined) {
-            await prompt.cancel();
-        }
-        return result;
-    }
-    finally {
-        // We can always clear the timeout, even if not set, this API is safe to
-        // call with invalid values.
-        clearTimeout(timeout);
-    }
-}
-function createConfirmationPrompt(name, message) {
-    return {
-        type: "confirm",
-        name,
-        message,
-        initial: "y",
-        default: "(Y/n)",
-    };
-}
-//# sourceMappingURL=prompt.js.map

package/dist/src/internal/cli/prompt/prompt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../../src/internal/cli/prompt/prompt.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,IAAY,EACZ,OAAe,EACf,sBAA8B,MAAM;IAEpC,IAAI,OAAO,CAAC;IACZ,IAAI,CAAC;QACH,wIAAwI;QACxI,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,CAAQ,CAAC;QAEhE,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CACzC,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CACxC,CAAC;QAEF,sIAAsI;QACtI,mFAAmF;QACnF,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7C,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAwB,MAAM,OAAO,CAAC,IAAI,CAAC;YACrD,MAAM,CAAC,GAAG,EAAE;YACZ,cAAc;SACf,CAAC,CAAC;QAEH,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;QACxB,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;YAAS,CAAC;QACT,wEAAwE;QACxE,4BAA4B;QAC5B,YAAY,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAY,EAAE,OAAe;IAC7D,OAAO;QACL,IAAI,EAAE,SAAS;QACf,IAAI;QACJ,OAAO;QACP,OAAO,EAAE,GAAG;QACZ,OAAO,EAAE,OAAO;KACjB,CAAC;AACJ,CAAC"}

package/src/internal/builtin-plugins/coverage/task-action.ts

@@ -1,9 +0,0 @@
-import chalk from "chalk";
-
-export default async function (): Promise<void> {
-  console.log(
-    chalk.yellow(
-      "This task will be implemented soon. Check back soon for more updates.",
-    ),
-  );
-}

package/src/internal/cli/prompt/prompt.ts

@@ -1,53 +0,0 @@
-/**
- * Display a confirmation prompt to the user. The prompt will be canceled if no response is given within a specified time limit.
- * @param name Used as the key for the answer on the returned values (answers) object.
- * @param message The message to display when the prompt is rendered in the terminal.
- * @param timeoutMilliseconds After how much time the prompt will be cancelled if no answer is given.
- * @returns True or false based on the user input, or undefined if the prompt times out.
- */
-export async function confirmationPromptWithTimeout(
-  name: string,
-  message: string,
-  timeoutMilliseconds: number = 10_000,
-): Promise<boolean | undefined> {
-  let timeout;
-  try {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- The types in the module "enquirer" are not properly defined
-    const { default: enquirer } = (await import("enquirer")) as any;
-
-    const prompt = new enquirer.prompts.Confirm(
-      createConfirmationPrompt(name, message),
-    );
-
-    // The timeout is a safety measure in case Hardhat is executed in a CI or another non-interactive environment and we do not detect it.
-    // Instead of blocking the process indefinitely, we abort the prompt after a while.
-    const timeoutPromise = new Promise((resolve) => {
-      timeout = setTimeout(resolve, timeoutMilliseconds);
-    });
-
-    const result: boolean | undefined = await Promise.race([
-      prompt.run(),
-      timeoutPromise,
-    ]);
-
-    if (result === undefined) {
-      await prompt.cancel();
-    }
-
-    return result;
-  } finally {
-    // We can always clear the timeout, even if not set, this API is safe to
-    // call with invalid values.
-    clearTimeout(timeout);
-  }
-}
-
-function createConfirmationPrompt(name: string, message: string) {
-  return {
-    type: "confirm",
-    name,
-    message,
-    initial: "y",
-    default: "(Y/n)",
-  };
-}