hardhat 2.11.0-dev.0 → 2.11.0

package/src/internal/cli/cli.ts

@@ -4,12 +4,20 @@ import debug from "debug";
 import semver from "semver";
 import "source-map-support/register";
 
-import { TASK_COMPILE, TASK_HELP } from "../../builtin-tasks/task-names";
+import {
+  TASK_COMPILE,
+  TASK_HELP,
+  TASK_TEST,
+} from "../../builtin-tasks/task-names";
 import { TaskArguments } from "../../types";
 import { HARDHAT_NAME } from "../constants";
 import { HardhatContext } from "../context";
 import { loadConfigAndTasks } from "../core/config/config-loading";
-import { HardhatError, HardhatPluginError } from "../core/errors";
+import {
+  assertHardhatInvariant,
+  HardhatError,
+  HardhatPluginError,
+} from "../core/errors";
 import { ERRORS, getErrorCode } from "../core/errors-list";
 import { isHardhatInstalledLocallyOrLinked } from "../core/execution-mode";
 import { getEnvHardhatArguments } from "../core/params/env-variables";
@@ -27,7 +35,7 @@ import {
 } from "../util/global-dir";
 import { getPackageJson, PackageJson } from "../util/packageInfo";
 
-import { applyWorkaround } from "../util/antlr-prototype-pollution-workaround";
+import { saveFlamegraph } from "../core/flamegraph";
 import { Analytics } from "./analytics";
 import { ArgumentsParser } from "./ArgumentsParser";
 import { enableEmoji } from "./emoji";
@@ -41,8 +49,6 @@ import {
 
 const log = debug("hardhat:core:cli");
 
-applyWorkaround();
-
 const ANALYTICS_SLOW_TASK_THRESHOLD = 300;
 
 async function printVersionMessage(packageJson: PackageJson) {
@@ -167,7 +173,13 @@ async function main() {
     }
 
     if (willRunWithTypescript(hardhatArguments.config)) {
-      loadTsNode(hardhatArguments.tsconfig);
+      loadTsNode(hardhatArguments.tsconfig, hardhatArguments.typecheck);
+    } else {
+      if (hardhatArguments.typecheck === true) {
+        throw new HardhatError(
+          ERRORS.ARGUMENTS.TYPECHECK_USED_IN_JAVASCRIPT_PROJECT
+        );
+      }
     }
 
     let taskName = parsedTaskName ?? TASK_HELP;
@@ -251,23 +263,37 @@ async function main() {
 
     ctx.setHardhatRuntimeEnvironment(env);
 
-    const timestampBeforeRun = new Date().getTime();
+    try {
+      const timestampBeforeRun = new Date().getTime();
 
-    await env.run(taskName, taskArguments);
+      await env.run(taskName, taskArguments);
 
-    const timestampAfterRun = new Date().getTime();
-    if (
-      timestampAfterRun - timestampBeforeRun >
-      ANALYTICS_SLOW_TASK_THRESHOLD
-    ) {
-      await hitPromise;
-    } else {
-      abortAnalytics();
+      const timestampAfterRun = new Date().getTime();
+
+      if (
+        timestampAfterRun - timestampBeforeRun >
+          ANALYTICS_SLOW_TASK_THRESHOLD &&
+        taskName !== TASK_COMPILE
+      ) {
+        await hitPromise;
+      } else {
+        abortAnalytics();
+      }
+    } finally {
+      if (hardhatArguments.flamegraph === true) {
+        assertHardhatInvariant(
+          env.entryTaskProfile !== undefined,
+          "--flamegraph was set but entryTaskProfile is not defined"
+        );
+
+        const flamegraphPath = saveFlamegraph(env.entryTaskProfile);
+        console.log("Created flamegraph file", flamegraphPath);
+      }
     }
 
     // VSCode extension prompt for installation
     if (
-      taskName === "test" &&
+      taskName === TASK_TEST &&
       !isRunningOnCiServer() &&
       process.stdout.isTTY === true
     ) {

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

@@ -12,12 +12,12 @@ import {
   HardhatUserConfig,
 } from "../../../types";
 import { HardhatContext } from "../../context";
-import { SUPPORTED_SOLIDITY_VERSION_RANGE } from "../../hardhat-network/stack-traces/solidityTracer";
 import { findClosestPackageJson } from "../../util/packageInfo";
 import { HardhatError } from "../errors";
 import { ERRORS } from "../errors-list";
 import { getUserConfigPath } from "../project-structure";
 
+import { SUPPORTED_SOLIDITY_VERSION_RANGE } from "../../hardhat-network/stack-traces/constants";
 import { resolveConfig } from "./config-resolution";
 import { validateConfig } from "./config-validation";
 import { DEFAULT_SOLC_VERSION } from "./default-config";

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

@@ -1,4 +1,3 @@
-import * as fs from "fs";
 import cloneDeep from "lodash/cloneDeep";
 import path from "path";
 
@@ -32,11 +31,11 @@ import {
   SolidityUserConfig,
 } from "../../../types";
 import { HARDHAT_NETWORK_NAME } from "../../constants";
-import { BigIntUtils } from "../../util/bigint";
 import { HardforkName } from "../../util/hardforks";
 import { fromEntries } from "../../util/lang";
 import { assertHardhatInvariant } from "../errors";
 
+import { getRealPathSync } from "../../util/fs-utils";
 import {
   DEFAULT_SOLC_VERSION,
   defaultDefaultNetwork,
@@ -157,9 +156,7 @@ function resolveHardhatNetworkConfig(
   if (forking !== undefined) {
     const blockNumber = hardhatNetworkConfig?.forking?.blockNumber;
     if (blockNumber !== undefined) {
-      forking.blockNumber = BigIntUtils.mapNumberToBigInt(
-        hardhatNetworkConfig?.forking?.blockNumber
-      );
+      forking.blockNumber = hardhatNetworkConfig?.forking?.blockNumber;
     }
 
     const httpHeaders = hardhatNetworkConfig.forking?.httpHeaders;
@@ -175,21 +172,16 @@ function resolveHardhatNetworkConfig(
       clonedDefaultHardhatNetworkParams.minGasPrice
   );
 
-  const blockGasLimit = BigInt(
+  const blockGasLimit =
     hardhatNetworkConfig.blockGasLimit ??
-      clonedDefaultHardhatNetworkParams.blockGasLimit
-  );
+    clonedDefaultHardhatNetworkParams.blockGasLimit;
 
-  const gas = BigIntUtils.mapNumberToBigInt(
-    hardhatNetworkConfig.gas ?? blockGasLimit
-  );
-  const gasPrice = BigIntUtils.mapNumberToBigInt(
-    hardhatNetworkConfig.gasPrice ?? clonedDefaultHardhatNetworkParams.gasPrice
-  );
-  const initialBaseFeePerGas = BigIntUtils.mapNumberToBigInt(
+  const gas = hardhatNetworkConfig.gas ?? blockGasLimit;
+  const gasPrice =
+    hardhatNetworkConfig.gasPrice ?? clonedDefaultHardhatNetworkParams.gasPrice;
+  const initialBaseFeePerGas =
     hardhatNetworkConfig.initialBaseFeePerGas ??
-      clonedDefaultHardhatNetworkParams.initialBaseFeePerGas
-  );
+    clonedDefaultHardhatNetworkParams.initialBaseFeePerGas;
 
   const initialDate =
     hardhatNetworkConfig.initialDate ?? new Date().toISOString();
@@ -277,12 +269,8 @@ function resolveHttpNetworkConfig(
     ...networkConfig,
     accounts,
     url,
-    gas: BigIntUtils.mapNumberToBigInt(
-      networkConfig.gas ?? defaultHttpNetworkParams.gas
-    ),
-    gasPrice: BigIntUtils.mapNumberToBigInt(
-      networkConfig.gasPrice ?? defaultHttpNetworkParams.gasPrice
-    ),
+    gas: networkConfig.gas ?? defaultHttpNetworkParams.gas,
+    gasPrice: networkConfig.gasPrice ?? defaultHttpNetworkParams.gasPrice,
   };
 }
 
@@ -455,7 +443,7 @@ export function resolveProjectPaths(
   userConfigPath: string,
   userPaths: ProjectPathsUserConfig = {}
 ): ProjectPathsConfig {
-  const configFile = fs.realpathSync(userConfigPath);
+  const configFile = getRealPathSync(userConfigPath);
   const configDir = path.dirname(configFile);
 
   const root = resolvePathFrom(configDir, "", userPaths.root);

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

@@ -37,7 +37,7 @@ export const defaultHardhatNetworkParams: Omit<
   "gas" | "initialDate"
 > = {
   hardfork: "arrowGlacier",
-  blockGasLimit: 30_000_000n,
+  blockGasLimit: 30_000_000,
   gasPrice: HARDHAT_NETWORK_DEFAULT_GAS_PRICE,
   chainId: 31337,
   throwOnTransactionFailures: true,

package/src/internal/core/errors-list.ts

@@ -668,6 +668,16 @@ Please double check how you invoked Hardhat or ran your task.`,
 This is not supported. Please run the help task to see the available options.`,
       shouldBeReported: false,
     },
+    TYPECHECK_USED_IN_JAVASCRIPT_PROJECT: {
+      number: 313,
+      title: "The --typecheck flag was used in a javascript project",
+      message:
+        "Trying to use the --typecheck flag, but the project is not in typescript",
+      description: `You tried to run Hardhat with the \`--typecheck\` flag in a javascript project.
+
+This flag can only be used in typescript projects.`,
+      shouldBeReported: false,
+    },
   },
   RESOLVER: {
     FILE_NOT_FOUND: {
@@ -787,42 +797,48 @@ Try installing the library using npm.`,
   SOLC: {
     INVALID_VERSION: {
       number: 500,
-      message:
-        "Solidity version %version% is invalid or hasn't been released yet.",
-      title: "Invalid `solc` version",
+      message: `Solidity version %version% is invalid or hasn't been released yet.
+        
+If you are certain it has been released, run "npx hardhat clean --global" and try again`,
+      title: "Invalid or unreleased `solc` version",
       description: `The Solidity version in your config is invalid or hasn't been released yet. 
 
-Please double check your \`solc\` config.`,
+If you are certain it has been released, run \`npx hardhat clean --global\` and try again.`,
       shouldBeReported: false,
     },
     DOWNLOAD_FAILED: {
       number: 501,
       message:
-        "Couldn't download compiler version %remoteVersion%. Please check your connection.",
+        "Couldn't download compiler version %remoteVersion%. Please check your internet connection and try again.",
       title: "`solc` download failed",
       description: `Couldn't download \`solc\`. 
       
-Please check your Internet connection.`,
+Please check your internet connection and try again.`,
       shouldBeReported: false,
     },
     VERSION_LIST_DOWNLOAD_FAILED: {
       number: 502,
       message:
-        "Couldn't download compiler versions list. Please check your connection.",
+        "Couldn't download compiler version list. Please check your internet connection and try again.",
       title: "Couldn't obtain `solc` version list",
       description: `Couldn't download \`solc\`'s version list. 
       
-Please check your Internet connection.`,
+Please check your internet connection and try again.`,
       shouldBeReported: false,
     },
     INVALID_DOWNLOAD: {
       number: 503,
-      message:
-        "Couldn't download compiler version %remoteVersion%. Checksum verification failed. Please check your connection.",
+      message: `Couldn't download compiler version %remoteVersion%: Checksum verification failed.
+
+Please check your internet connection and try again.
+
+If this error persists, run "npx hardhat clean --global".`,
       title: "Downloaded `solc` checksum verification failed",
-      description: `Downloaded \`solc\` verification failed.
-      
-Please check your Internet connection.`,
+      description: `Hardhat downloaded a version of the Solidity compiler, and its checksum verification failed.
+ 
+Please check your internet connection and try again.
+
+If this error persists, run \`npx hardhat clean --global\`.`,
       shouldBeReported: false,
     },
     CANT_GET_COMPILER: {

package/src/internal/core/errors.ts

@@ -6,6 +6,8 @@ import { ErrorDescriptor, ERRORS, getErrorCode } from "./errors-list";
 const inspect = Symbol.for("nodejs.util.inspect.custom");
 
 export class CustomError extends Error {
+  private _stack: string;
+
   constructor(message: string, public readonly parent?: Error) {
     // WARNING: Using super when extending a builtin class doesn't work well
     // with TS if you are compiling to a version of JavaScript that doesn't have
@@ -20,10 +22,16 @@ export class CustomError extends Error {
     if ((Error as any).captureStackTrace !== undefined) {
       (Error as any).captureStackTrace(this, this.constructor);
     }
+
+    this._stack = this.stack ?? "";
+
+    Object.defineProperty(this, "stack", {
+      get: () => this[inspect](),
+    });
   }
 
-  public [inspect]() {
-    let str = this.stack;
+  public [inspect](): string {
+    let str = this._stack;
     if (this.parent !== undefined) {
       const parentAsAny = this.parent as any;
       const causeString =

package/src/internal/core/execution-mode.ts

@@ -1,6 +1,5 @@
-import * as fs from "fs";
-
 import { getPackageJsonPath } from "../util/packageInfo";
+import { getRealPathSync } from "../util/fs-utils";
 
 /**
  * Returns true if Hardhat is installed locally or linked from its repository,
@@ -20,7 +19,7 @@ export function isHardhatInstalledLocallyOrLinked(configPath?: string) {
     // We need to get the realpaths here, as hardhat may be linked and
     // running with `node --preserve-symlinks`
     return (
-      fs.realpathSync(resolvedPackageJson) === fs.realpathSync(thisPackageJson)
+      getRealPathSync(resolvedPackageJson) === getRealPathSync(thisPackageJson)
     );
   } catch {
     return false;

package/src/internal/core/flamegraph.ts

@@ -0,0 +1,270 @@
+import fs from "fs";
+import { assertHardhatInvariant } from "./errors";
+import { flagParallelChildren, TaskProfile } from "./task-profiling";
+
+export interface Flamegraph {
+  name: string;
+  value: number;
+  children: Flamegraph[];
+  parallel: boolean;
+}
+
+export function profileToFlamegraph(profile: TaskProfile): Flamegraph {
+  assertHardhatInvariant(
+    profile.end !== undefined,
+    `Formatting invalid task profile for ${profile.name}. No end was recorded.`
+  );
+
+  return {
+    name: profile.name,
+    // We assume this is a safe int, which is ok unless a task runs for months
+    value: Number(profile.end - profile.start),
+    children: profile.children.map((c) => profileToFlamegraph(c)),
+    parallel: profile.parallel === true,
+  };
+}
+
+/**
+ * Merges compatible children of toFold and its children.
+ *
+ * Compatible in a traditional Flamegraph means having the same name. We
+ * modified that notion and also require their `parallel` flag to have the same
+ * value. This means that parallel and non-parallel calls to the same function
+ * are shown with two Flamegraph "blocks".
+ *
+ * The parallel block shows the max running time, instead of the sum of them.
+ **/
+function foldFramegraph(toFold: Flamegraph): Flamegraph {
+  if (toFold.children.length === 0) {
+    return {
+      name: toFold.name,
+      value: toFold.value,
+      children: [],
+      parallel: toFold.parallel,
+    };
+  }
+
+  const children = toFold.children.map((c) => foldFramegraph(c));
+  children.sort((a, b) =>
+    a.parallel === b.parallel ? 0 : b.parallel ? -1 : 1
+  );
+  children.sort((a, b) => a.name.localeCompare(b.name));
+
+  const foldedChildren = [children[0]];
+  const mergedChildren = new Set<number>();
+  for (let i = 1; i < children.length; i++) {
+    const latest = foldedChildren[foldedChildren.length - 1];
+    if (
+      children[i].name === latest.name &&
+      children[i].parallel === latest.parallel
+    ) {
+      if (latest.parallel) {
+        latest.value = Math.max(latest.value, children[i].value);
+      } else {
+        latest.value += children[i].value;
+      }
+
+      latest.children.push(...children[i].children);
+      mergedChildren.add(foldedChildren.length - 1);
+    } else {
+      foldedChildren.push(children[i]);
+    }
+  }
+
+  for (const i of mergedChildren.values()) {
+    foldedChildren[i] = foldFramegraph(foldedChildren[i]);
+  }
+
+  return {
+    name: toFold.name,
+    value: toFold.value,
+    children: foldedChildren,
+    parallel: toFold.parallel,
+  };
+}
+
+export function createFlamegraphHtmlFile(flamegraph: Flamegraph): string {
+  const content = getFlamegraphFileContent(foldFramegraph(flamegraph));
+  const path = "flamegraph.html";
+
+  fs.writeFileSync(path, content, { encoding: "utf8" });
+
+  return path;
+}
+
+function getFlamegraphFileContent(flamegraph: Flamegraph): string {
+  const data = JSON.stringify(foldFramegraph(flamegraph), undefined, 2);
+  return `<!-- Based on d3-flamegraph's example. See its license in: https://github.com/spiermar/d3-flame-graph/blob/master/LICENSE -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+    <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.css">
+
+    <style>
+    /* Space out content a bit */
+    body {
+      padding-top: 20px;
+      padding-bottom: 20px;
+    }
+
+    /* Custom page header */
+    .header {
+      padding-bottom: 20px;
+      padding-right: 15px;
+      padding-left: 15px;
+      border-bottom: 1px solid #e5e5e5;
+    }
+
+    /* Make the masthead heading the same height as the navigation */
+    .header h3 {
+      margin-top: 0;
+      margin-bottom: 0;
+      line-height: 40px;
+    }
+
+    /* Customize container */
+    .container {
+      max-width: 990px;
+    }
+    </style>
+
+    <title>Hardhat task flamegraph</title>
+  </head>
+  <body>
+    <div class="container">
+      <div class="header clearfix">
+        <nav>
+          <div class="pull-right">
+            <form class="form-inline" id="form">
+              <a class="btn" href="javascript: resetZoom();">Reset zoom</a>
+              <a class="btn" href="javascript: clear();">Clear</a>
+              <div class="form-group">
+                <input type="text" class="form-control" id="term">
+              </div>
+              <a class="btn btn-primary" href="javascript: search();">Search</a>
+            </form>
+          </div>
+        </nav>
+        <h3 class="text-muted">Hardhat task flamegraph</h3>
+      </div>
+      <div id="chart">
+      </div>
+      <hr>
+      <div id="details">
+      </div>
+    </div>
+
+    <!-- D3.js -->
+    <script src="https://d3js.org/d3.v4.min.js" charset="utf-8"></script>
+    
+    <!-- d3-tip -->
+    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/d3-tip/0.9.1/d3-tip.min.js"></script>
+
+    <!-- d3-flamegraph -->
+    <script type="text/javascript" src="https://cdn.jsdelivr.net/gh/spiermar/d3-flame-graph@2.0.3/dist/d3-flamegraph.min.js"></script>
+
+    <script type="text/javascript">
+    const flameGraph = d3.flamegraph()
+      .width(960)
+      .cellHeight(18)
+      .transitionDuration(750)
+      .minFrameSize(5)
+      .transitionEase(d3.easeCubic)
+      .sort(true)
+      .title("")
+      .onClick(onClick)
+      .differential(false)
+      .selfValue(false);
+
+    function label(d) {
+      if (d.data.parallel) {
+        return "(multiple parallel runs) task: " + d.data.name + ", max time: " + readableTime(d.data.value);  
+      }
+        
+      return "task: " + d.data.name + ", time: " + readableTime(d.data.value);
+    }
+    
+    function readableTime(t) {
+      const NANOSECONDS_TO_MILLISECONDS = 1_000_000;
+      const NANOSECONDS_TO_SECONDS = 1_000_000_000;
+      
+      if (t < NANOSECONDS_TO_MILLISECONDS) {
+        return t + "ns";
+      }
+      
+      if (t < NANOSECONDS_TO_SECONDS) {
+          return (t / NANOSECONDS_TO_MILLISECONDS).toFixed(4) + "ms";
+      }
+      
+      return (t / NANOSECONDS_TO_SECONDS).toFixed(4) + "s";
+    }
+    
+    const tip = d3.tip()
+      .direction("s")
+      .offset([8, 0])
+      .attr('class', 'd3-flame-graph-tip')
+      .html(label);
+
+    flameGraph.tooltip(tip);
+
+    const details = document.getElementById("details");
+    flameGraph.setDetailsElement(details);
+
+    flameGraph.label(label);
+    
+    flameGraph.setColorMapper(function(d, originalColor) {
+      if (d.highlight) {
+        return '#E600E6';
+      }
+
+      if (d.data.parallel) {
+        return '#1478eb'
+      }
+
+      return "#EB5414"
+    });
+    
+    d3.select("#chart")
+          .datum(${data})
+          .call(flameGraph);
+
+    document.getElementById("form").addEventListener("submit", function(event){
+      event.preventDefault();
+      search();
+    });
+
+    function search() {
+      const term = document.getElementById("term").value;
+      flameGraph.search(term);
+    }
+
+    function clear() {
+      document.getElementById('term').value = '';
+      flameGraph.clear();
+    }
+
+    function resetZoom() {
+      flameGraph.resetZoom();
+    }
+
+    function onClick(d) {
+      console.info("Clicked on " + d.data.name);
+    }
+    </script>
+  </body>
+</html>
+`;
+}
+
+/**
+ * Converts the TaskProfile into a flamegraph, saves it, and returns its path.
+ */
+export function saveFlamegraph(profile: TaskProfile): string {
+  flagParallelChildren(profile);
+  const flamegraph = profileToFlamegraph(profile);
+  return createFlamegraphHtmlFile(flamegraph);
+}

package/src/internal/core/jsonrpc/types/base-types.ts

@@ -1,7 +1,11 @@
-import { bufferToHex, isValidAddress, toBuffer } from "@ignored/util";
+import {
+  bufferToHex,
+  isValidAddress,
+  toBuffer,
+} from "@nomicfoundation/ethereumjs-util";
 import * as t from "io-ts";
 
-import { BigIntUtils } from "../../../util/bigint";
+import * as BigIntUtils from "../../../util/bigint";
 import { assertHardhatInvariant, HardhatError } from "../../errors";
 import { ERRORS } from "../../errors-list";
 
@@ -128,7 +132,7 @@ export function numberToRpcStorageSlot(n: number | bigint): string {
     "Expected number"
   );
 
-  return `0x${BigIntUtils.toWord(n)}`;
+  return `0x${BigIntUtils.toEvmWord(n)}`;
 }
 
 /**

package/src/internal/core/params/hardhat-params.ts

@@ -84,4 +84,22 @@ export const HARDHAT_PARAM_DEFINITIONS: HardhatParamDefinitions = {
     isFlag: false,
     isVariadic: false,
   },
+  flamegraph: {
+    name: "flamegraph",
+    defaultValue: undefined,
+    description: "Generate a flamegraph of your Hardhat tasks",
+    type: types.boolean,
+    isOptional: true,
+    isFlag: true,
+    isVariadic: false,
+  },
+  typecheck: {
+    name: "typecheck",
+    defaultValue: false,
+    description: "Enable TypeScript type-checking of your scripts/tests",
+    type: types.boolean,
+    isFlag: true,
+    isOptional: true,
+    isVariadic: false,
+  },
 };