hardhat 2.23.0-dev.2 → 2.23.0

package/src/internal/cli/banner-manager.ts

@@ -0,0 +1,182 @@
+import path from "node:path";
+import fs from "node:fs/promises";
+import debug from "debug";
+import { getCacheDir } from "../util/global-dir";
+import { requestJson } from "../util/request";
+
+const log = debug("hardhat:util:banner-manager");
+
+interface BannerConfig {
+  enabled: boolean;
+  formattedMessages: string[];
+  minSecondsBetweenDisplays: number;
+  minSecondsBetweenRequests: number;
+}
+
+const BANNER_CONFIG_URL =
+  "https://raw.githubusercontent.com/NomicFoundation/hardhat/refs/heads/main/banner-config.json";
+
+const BANNER_CACHE_FILE_NAME = "banner-config.json";
+
+export class BannerManager {
+  private static _instance: BannerManager | undefined;
+
+  private constructor(
+    private _bannerConfig: BannerConfig | undefined,
+    private _lastDisplayTime: number,
+    private _lastRequestTime: number
+  ) {}
+
+  public static async getInstance(): Promise<BannerManager> {
+    if (this._instance === undefined) {
+      log("Initializing BannerManager");
+      const { bannerConfig, lastDisplayTime, lastRequestTime } =
+        await readCache();
+      this._instance = new BannerManager(
+        bannerConfig,
+        lastDisplayTime,
+        lastRequestTime
+      );
+    }
+
+    return this._instance;
+  }
+
+  private async _requestBannerConfig(timeout?: number): Promise<void> {
+    if (this._bannerConfig !== undefined) {
+      const timeSinceLastRequest = Date.now() - this._lastRequestTime;
+      if (
+        timeSinceLastRequest <
+        this._bannerConfig.minSecondsBetweenRequests * 1000
+      ) {
+        log(
+          `Skipping banner config request. Time since last request: ${timeSinceLastRequest}ms`
+        );
+        return;
+      }
+    }
+
+    try {
+      const bannerConfig = await requestJson(BANNER_CONFIG_URL, timeout);
+
+      if (!this._isBannerConfig(bannerConfig)) {
+        log(`Invalid banner config received:`, bannerConfig);
+        return;
+      }
+
+      this._bannerConfig = bannerConfig;
+      this._lastRequestTime = Date.now();
+
+      await writeCache({
+        bannerConfig: this._bannerConfig,
+        lastDisplayTime: this._lastDisplayTime,
+        lastRequestTime: this._lastRequestTime,
+      });
+    } catch (error) {
+      log(
+        `Error requesting banner config: ${
+          error instanceof Error ? error.message : JSON.stringify(error)
+        }`
+      );
+    }
+  }
+
+  private _isBannerConfig(value: unknown): value is BannerConfig {
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+      return false;
+    }
+
+    return (
+      Object.getOwnPropertyNames(value).length === 4 &&
+      "enabled" in value &&
+      typeof value.enabled === "boolean" &&
+      "formattedMessages" in value &&
+      Array.isArray(value.formattedMessages) &&
+      value.formattedMessages.every((message) => typeof message === "string") &&
+      "minSecondsBetweenDisplays" in value &&
+      typeof value.minSecondsBetweenDisplays === "number" &&
+      "minSecondsBetweenRequests" in value &&
+      typeof value.minSecondsBetweenRequests === "number"
+    );
+  }
+
+  public async showBanner(timeout?: number): Promise<void> {
+    await this._requestBannerConfig(timeout);
+
+    if (
+      this._bannerConfig === undefined ||
+      !this._bannerConfig.enabled ||
+      this._bannerConfig.formattedMessages.length === 0
+    ) {
+      log("Banner is disabled or no messages available.");
+      return;
+    }
+
+    const { formattedMessages, minSecondsBetweenDisplays } = this._bannerConfig;
+
+    const timeSinceLastDisplay = Date.now() - this._lastDisplayTime;
+    if (timeSinceLastDisplay < minSecondsBetweenDisplays * 1000) {
+      log(
+        `Skipping banner display. Time since last display: ${timeSinceLastDisplay}ms`
+      );
+      return;
+    }
+
+    // select a random message from the formattedMessages array
+    const randomIndex = Math.floor(Math.random() * formattedMessages.length);
+    const message = formattedMessages[randomIndex];
+
+    console.log(message);
+    this._lastDisplayTime = Date.now();
+    await writeCache({
+      bannerConfig: this._bannerConfig,
+      lastDisplayTime: this._lastDisplayTime,
+      lastRequestTime: this._lastRequestTime,
+    });
+  }
+}
+
+interface BannerCache {
+  bannerConfig: BannerConfig | undefined;
+  lastDisplayTime: number;
+  lastRequestTime: number;
+}
+
+async function readCache(): Promise<BannerCache> {
+  const cacheDir = await getCacheDir();
+  const bannerCacheFilePath = path.join(cacheDir, BANNER_CACHE_FILE_NAME);
+
+  let cache: BannerCache = {
+    bannerConfig: undefined,
+    lastDisplayTime: 0,
+    lastRequestTime: 0,
+  };
+  try {
+    const fileContents = await fs.readFile(bannerCacheFilePath, "utf-8");
+    cache = JSON.parse(fileContents);
+  } catch (error) {
+    log(
+      `Error reading cache file: ${
+        error instanceof Error ? error.message : JSON.stringify(error)
+      }`
+    );
+  }
+
+  return cache;
+}
+
+async function writeCache(cache: BannerCache) {
+  const cacheDir = await getCacheDir();
+  const bannerCacheFilePath = path.join(cacheDir, BANNER_CACHE_FILE_NAME);
+
+  try {
+    await fs.mkdir(cacheDir, { recursive: true });
+    await fs.writeFile(bannerCacheFilePath, JSON.stringify(cache, null, 2));
+  } catch (error) {
+    log(
+      `Error writing cache file:  ${
+        error instanceof Error ? error.message : JSON.stringify(error)
+      }`
+    );
+  }
+}

package/src/internal/cli/bootstrap.ts

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
-import semver from "semver";
-import chalk from "chalk";
 
-import { SUPPORTED_NODE_VERSIONS } from "./constants";
+import picocolors from "picocolors";
 
-if (!semver.satisfies(process.version, SUPPORTED_NODE_VERSIONS.join(" || "))) {
+import { isNodeVersionToWarnOn } from "./is-node-version-to-warn-on";
+
+if (isNodeVersionToWarnOn(process.version)) {
   console.warn(
-    chalk.yellow.bold(`WARNING:`),
+    picocolors.yellow(picocolors.bold(`WARNING:`)),
     `You are currently using Node.js ${process.version}, which is not supported by Hardhat. This can lead to unexpected behavior. See https://hardhat.org/nodejs-versions`
   );
   console.log();

package/src/internal/cli/cli.ts

@@ -1,4 +1,4 @@
-import chalk from "chalk";
+import picocolors from "picocolors";
 import debug from "debug";
 import "source-map-support/register";
 
@@ -49,6 +49,7 @@ import {
   isHardhatVSCodeInstalled,
 } from "./hardhat-vscode-installation";
 import { handleVars } from "./vars";
+import { BannerManager } from "./banner-manager";
 
 const log = debug("hardhat:core:cli");
 
@@ -102,7 +103,7 @@ function showViaIRWarning(resolvedConfig: HardhatConfig) {
   if (viaIREnabled) {
     console.warn();
     console.warn(
-      chalk.yellow(
+      picocolors.yellow(
         `Your solidity settings have viaIR enabled, which is not fully supported yet. You can still use Hardhat, but some features, like stack traces, might not work correctly.
 
 Learn more at https://hardhat.org/solc-viair`
@@ -170,14 +171,16 @@ async function main() {
 
         // Warning for Hardhat V3 deprecation
         console.warn(
-          chalk.yellow.bold("\n\nDEPRECATION WARNING\n\n"),
-          chalk.yellow(
-            `Initializing a project with ${chalk.white.italic(
-              "npx hardhat"
+          picocolors.yellow(picocolors.bold("\n\nDEPRECATION WARNING\n\n")),
+          picocolors.yellow(
+            `Initializing a project with ${picocolors.white(
+              picocolors.italic("npx hardhat")
             )} is deprecated and will be removed in the future.\n`
           ),
-          chalk.yellow(
-            `Please use ${chalk.white.italic("npx hardhat init")} instead.\n\n`
+          picocolors.yellow(
+            `Please use ${picocolors.white(
+              picocolors.italic("npx hardhat init")
+            )} instead.\n\n`
           )
         );
 
@@ -234,7 +237,6 @@ async function main() {
       taskDefinitions,
       scopesDefinitions,
       envExtenders,
-      ctx.experimentalHardhatNetworkMessageTraceHooks,
       userConfig,
       providerExtenders
     );
@@ -276,7 +278,7 @@ async function main() {
 
     let taskArguments: TaskArguments;
 
-    // --help is a also special case
+    // --help is an also special case
     if (hardhatArguments.help && taskName !== TASK_HELP) {
       // we "move" the task and scope names to the task arguments,
       // and run the help task
@@ -381,6 +383,11 @@ async function main() {
       }
     }
 
+    if (!isRunningOnCiServer() && process.stdout.isTTY === true) {
+      const hardhat3BannerManager = await BannerManager.getInstance();
+      await hardhat3BannerManager.showBanner(200);
+    }
+
     log(`Killing Hardhat after successfully running task ${taskName}`);
   } catch (error) {
     let isHardhatError = false;
@@ -388,20 +395,22 @@ async function main() {
     if (HardhatError.isHardhatError(error)) {
       isHardhatError = true;
       console.error(
-        chalk.red.bold("Error"),
-        error.message.replace(/^\w+:/, (t) => chalk.red.bold(t))
+        picocolors.red(picocolors.bold("Error")),
+        error.message.replace(/^\w+:/, (t) =>
+          picocolors.red(picocolors.bold(t))
+        )
       );
     } else if (HardhatPluginError.isHardhatPluginError(error)) {
       isHardhatError = true;
       console.error(
-        chalk.red.bold(`Error in plugin ${error.pluginName}:`),
+        picocolors.red(picocolors.bold(`Error in plugin ${error.pluginName}:`)),
         error.message
       );
     } else if (error instanceof Error) {
-      console.error(chalk.red("An unexpected error occurred:"));
+      console.error(picocolors.red("An unexpected error occurred:"));
       showStackTraces = true;
     } else {
-      console.error(chalk.red("An unexpected error occurred."));
+      console.error(picocolors.red("An unexpected error occurred."));
       showStackTraces = true;
     }
 

package/src/internal/cli/constants.ts

@@ -1 +1 @@
-export const SUPPORTED_NODE_VERSIONS = ["^18.0.0", "^20.0.0"];
+export const SUPPORTED_NODE_VERSIONS = ["^18.0.0", "^20.0.0", "^22.0.0"];

package/src/internal/cli/is-node-version-to-warn-on.ts

@@ -0,0 +1,54 @@
+import semver from "semver";
+
+import { assertHardhatInvariant } from "../core/errors";
+import { SUPPORTED_NODE_VERSIONS } from "./constants";
+
+/**
+ * Determine if the node version should trigger an unsupported
+ * warning.
+ *
+ * The current rule is that an unsupported warning will be shown if
+ *
+ * 1. An odd numbered version of Node.js is used - as this will never go to LTS
+ * 2. The version is less than the minimum supported version
+ *
+ * We intentionally do not warn on newer **even** versions of Node.js.
+ */
+export function isNodeVersionToWarnOn(nodeVersion: string): boolean {
+  const supportedVersions = SUPPORTED_NODE_VERSIONS.join(" || ");
+
+  // If the version is supported, no need to warn and short circuit
+  if (semver.satisfies(nodeVersion, supportedVersions)) {
+    return false;
+  }
+
+  if (_onOddNumberedVersion(nodeVersion)) {
+    return true;
+  }
+
+  if (_lessThanMinimumSupportedVersion(nodeVersion, supportedVersions)) {
+    return true;
+  }
+
+  // A newer version of Node.js that will go to LTS
+  // we have opted not to warn.
+  return false;
+}
+
+function _onOddNumberedVersion(nodeVersion: string) {
+  return semver.major(nodeVersion) % 2 === 1;
+}
+
+function _lessThanMinimumSupportedVersion(
+  nodeVersion: string,
+  supportedVersions: string
+) {
+  const minSupportedVersion = semver.minVersion(supportedVersions);
+
+  assertHardhatInvariant(
+    minSupportedVersion !== null,
+    "Unexpectedly failed to parse the minimum supported version of Node.js"
+  );
+
+  return semver.lt(nodeVersion, minSupportedVersion);
+}

package/src/internal/cli/project-creation.ts

@@ -1,4 +1,4 @@
-import chalk from "chalk";
+import picocolors from "picocolors";
 import fsExtra from "fs-extra";
 import path from "path";
 
@@ -23,6 +23,7 @@ import {
 import { emoji } from "./emoji";
 import { Dependencies, PackageManager } from "./types";
 import { requestTelemetryConsent } from "./analytics";
+import { BannerManager } from "./banner-manager";
 
 enum Action {
   CREATE_JAVASCRIPT_PROJECT_ACTION = "Create a JavaScript project",
@@ -97,28 +98,34 @@ const TYPESCRIPT_VIEM_PEER_DEPENDENCIES: Dependencies = {
 // generated with the "colossal" font
 function printAsciiLogo() {
   console.log(
-    chalk.blue("888    888                      888 888               888")
+    picocolors.blue("888    888                      888 888               888")
   );
   console.log(
-    chalk.blue("888    888                      888 888               888")
+    picocolors.blue("888    888                      888 888               888")
   );
   console.log(
-    chalk.blue("888    888                      888 888               888")
+    picocolors.blue("888    888                      888 888               888")
   );
   console.log(
-    chalk.blue("8888888888  8888b.  888d888 .d88888 88888b.   8888b.  888888")
+    picocolors.blue(
+      "8888888888  8888b.  888d888 .d88888 88888b.   8888b.  888888"
+    )
   );
   console.log(
-    chalk.blue('888    888     "88b 888P"  d88" 888 888 "88b     "88b 888')
+    picocolors.blue('888    888     "88b 888P"  d88" 888 888 "88b     "88b 888')
   );
   console.log(
-    chalk.blue("888    888 .d888888 888    888  888 888  888 .d888888 888")
+    picocolors.blue("888    888 .d888888 888    888  888 888  888 .d888888 888")
   );
   console.log(
-    chalk.blue("888    888 888  888 888    Y88b 888 888  888 888  888 Y88b.")
+    picocolors.blue(
+      "888    888 888  888 888    Y88b 888 888  888 888  888 Y88b."
+    )
   );
   console.log(
-    chalk.blue('888    888 "Y888888 888     "Y88888 888  888 "Y888888  "Y888')
+    picocolors.blue(
+      '888    888 "Y888888 888     "Y88888 888  888 "Y888888  "Y888'
+    )
   );
   console.log("");
 }
@@ -127,7 +134,7 @@ async function printWelcomeMessage() {
   const packageJson = await getPackageJson();
 
   console.log(
-    chalk.cyan(
+    picocolors.cyan(
       `${emoji("👷 ")}Welcome to ${HARDHAT_NAME} v${packageJson.version}${emoji(
         " 👷‍"
       )}\n`
@@ -200,7 +207,7 @@ Please delete or rename ${pluralize(
       "it",
       "them"
     )} and try again.`;
-    console.log(chalk.red(errorMsg));
+    console.log(picocolors.red(errorMsg));
     process.exit(1);
   }
 
@@ -254,7 +261,7 @@ async function printRecommendedDepsInstallationInstructions(
 // exported so we can test that it uses the latest supported version of solidity
 export const EMPTY_HARDHAT_CONFIG = `/** @type import('hardhat/config').HardhatUserConfig */
 module.exports = {
-  solidity: "0.8.24",
+  solidity: "0.8.28",
 };
 `;
 
@@ -356,23 +363,25 @@ async function createPackageJson() {
 
 function showStarOnGitHubMessage() {
   console.log(
-    chalk.cyan("Give Hardhat a star on Github if you're enjoying it!") +
+    picocolors.cyan("Give Hardhat a star on Github if you're enjoying it!") +
       emoji(" ⭐️✨")
   );
   console.log();
-  console.log(chalk.cyan("     https://github.com/NomicFoundation/hardhat"));
+  console.log(
+    picocolors.cyan("     https://github.com/NomicFoundation/hardhat")
+  );
 }
 
 export function showSoliditySurveyMessage() {
-  if (new Date() > new Date("2024-01-07 23:39")) {
+  if (new Date() > new Date("2025-01-31 23:39")) {
     // the survey has finished
     return;
   }
 
   console.log();
   console.log(
-    chalk.cyan(
-      "Please take a moment to complete the 2023 Solidity Survey: https://hardhat.org/solidity-survey-2023"
+    picocolors.cyan(
+      "Please take a moment to complete the 2024 Solidity Survey: https://hardhat.org/solidity-survey-2024"
     )
   );
 }
@@ -405,7 +414,7 @@ export async function createProject() {
   if (action === Action.CREATE_EMPTY_HARDHAT_CONFIG_ACTION) {
     await writeEmptyHardhatConfig(isEsm);
     console.log(
-      `${emoji("✨ ")}${chalk.cyan(`Config file created`)}${emoji(" ✨")}`
+      `${emoji("✨ ")}${picocolors.cyan(`Config file created`)}${emoji(" ✨")}`
     );
 
     if (!isInstalled(HARDHAT_PACKAGE_NAME)) {
@@ -504,7 +513,9 @@ export async function createProject() {
 
         if (!installed) {
           console.warn(
-            chalk.red("Failed to install the sample project's dependencies")
+            picocolors.red(
+              "Failed to install the sample project's dependencies"
+            )
           );
         }
 
@@ -519,13 +530,16 @@ export async function createProject() {
   }
 
   console.log(
-    `\n${emoji("✨ ")}${chalk.cyan("Project created")}${emoji(" ✨")}`
+    `\n${emoji("✨ ")}${picocolors.cyan("Project created")}${emoji(" ✨")}`
   );
   console.log();
   console.log("See the README.md file for some example tasks you can run");
   console.log();
   showStarOnGitHubMessage();
   showSoliditySurveyMessage();
+
+  const hardhat3BannerManager = await BannerManager.getInstance();
+  await hardhat3BannerManager.showBanner();
 }
 
 async function canInstallRecommendedDeps() {
@@ -544,12 +558,24 @@ function isInstalled(dep: string) {
   return dep in allDependencies;
 }
 
+function getProjectTypeFromUserAgent() {
+  const userAgent = process.env.npm_config_user_agent;
+  // Get first part of user agent string
+  const [projectType] = userAgent?.split("/") ?? [];
+  return projectType;
+}
+
 async function isYarnProject() {
-  return fsExtra.pathExists("yarn.lock");
+  return (
+    getProjectTypeFromUserAgent() === "yarn" || fsExtra.pathExists("yarn.lock")
+  );
 }
 
 async function isPnpmProject() {
-  return fsExtra.pathExists("pnpm-lock.yaml");
+  return (
+    getProjectTypeFromUserAgent() === "pnpm" ||
+    fsExtra.pathExists("pnpm-lock.yaml")
+  );
 }
 
 async function getProjectPackageManager(): Promise<PackageManager> {

package/src/internal/cli/vars.ts

@@ -1,4 +1,4 @@
-import chalk from "chalk";
+import picocolors from "picocolors";
 import debug from "debug";
 import { HardhatError, assertHardhatInvariant } from "../core/errors";
 import { ERRORS } from "../core/errors-list";
@@ -35,7 +35,7 @@ export async function handleVars(
     case "setup":
       return setup(configPath);
     default:
-      console.error(chalk.red(`Invalid task '${taskDefinition.name}'`));
+      console.error(picocolors.red(`Invalid task '${taskDefinition.name}'`));
       return 1; // Error code
   }
 }
@@ -65,7 +65,7 @@ function get(key: string): number {
   }
 
   console.warn(
-    chalk.yellow(
+    picocolors.yellow(
       `The configuration variable '${key}' is not set in ${HardhatContext.getHardhatContext().varsManager.getStoragePath()}`
     )
   );
@@ -88,7 +88,7 @@ function list(): number {
   } else {
     if (process.stdout.isTTY) {
       console.warn(
-        chalk.yellow(
+        picocolors.yellow(
           `There are no configuration variables stored in ${varsStoragePath}`
         )
       );
@@ -112,7 +112,7 @@ function del(key: string): number {
   }
 
   console.warn(
-    chalk.yellow(
+    picocolors.yellow(
       `There is no configuration variable '${key}' to delete from ${varsStoragePath}`
     )
   );
@@ -137,7 +137,7 @@ function setup(configPath: string | undefined) {
     loadConfigFile(configPath);
   } catch (err: any) {
     console.error(
-      chalk.red(
+      picocolors.red(
         "There is an error in your Hardhat configuration file. Please double check it.\n"
       )
     );
@@ -187,7 +187,7 @@ function listVarsToSetup(varsManagerSetup: VarsManagerSetup) {
 
   if (requiredKeysToSet.length === 0 && optionalKeysToSet.length === 0) {
     console.log(
-      chalk.green(
+      picocolors.green(
         "There are no configuration variables that need to be set for this project"
       )
     );
@@ -198,7 +198,7 @@ function listVarsToSetup(varsManagerSetup: VarsManagerSetup) {
 
   if (requiredKeysToSet.length > 0) {
     console.log(
-      chalk.bold(
+      picocolors.bold(
         `${emoji("❗ ")}The following configuration variables need to be set:\n`
       )
     );
@@ -210,7 +210,7 @@ function listVarsToSetup(varsManagerSetup: VarsManagerSetup) {
 
   if (optionalKeysToSet.length > 0) {
     console.log(
-      chalk.bold(
+      picocolors.bold(
         `${emoji("💡 ")}The following configuration variables are optional:\n`
       )
     );
@@ -237,7 +237,7 @@ function printAlreadySetKeys(varsManagerSetup: VarsManagerSetup) {
   }
 
   console.log(
-    `${chalk.bold(`${emoji("✔️  ")}Configuration variables already set:`)}`
+    `${picocolors.bold(`${emoji("✔️  ")}Configuration variables already set:`)}`
   );
   console.log();
 

package/src/internal/cli/version-notifier.ts

@@ -1,5 +1,5 @@
 import boxen from "boxen";
-import chalk from "chalk";
+import picocolors from "picocolors";
 import fsExtra from "fs-extra";
 import { join } from "node:path";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
@@ -111,9 +111,9 @@ export async function showNewVersionNotification() {
 
     console.log(
       boxen(
-        `New Hardhat release available! ${chalk.red(
+        `New Hardhat release available! ${picocolors.red(
           hardhatVersion
-        )} -> ${chalk.green(latestV2Version)}.
+        )} -> ${picocolors.green(latestV2Version)}.
 
 Changelog: https://hardhat.org/release/${latestV2Version}
 

package/src/internal/constants.ts

@@ -23,6 +23,7 @@ export const HARDHAT_NETWORK_SUPPORTED_HARDFORKS = [
   "merge",
   "shanghai",
   "cancun",
+  "prague",
 ];
 
 export const HARDHAT_MEMPOOL_SUPPORTED_ORDERS = ["fifo", "priority"] as const;

package/src/internal/context.ts

@@ -1,7 +1,6 @@
 import {
   ConfigExtender,
   EnvironmentExtender,
-  ExperimentalHardhatNetworkMessageTraceHook,
   HardhatRuntimeEnvironment,
   ProviderExtender,
 } from "../types";
@@ -60,10 +59,6 @@ export class HardhatContext {
 
   public readonly configExtenders: ConfigExtender[] = [];
 
-  // NOTE: This is experimental and will be removed. Please contact our team if
-  // you are planning to use it.
-  public readonly experimentalHardhatNetworkMessageTraceHooks: ExperimentalHardhatNetworkMessageTraceHook[] =
-    [];
   private _filesLoadedBeforeConfig?: string[];
   private _filesLoadedAfterConfig?: string[];