hardhat 3.12.0 → 3.14.0

package/src/internal/core/config.ts

@@ -23,11 +23,33 @@ import {
 
 /**
  * Creates a configuration variable, which will be fetched at runtime.
+ *
+ * The second argument is an options object with an optional `format` (a
+ * template that must include the `{variable}` marker) and an optional
+ * `default` value. The default is used as a fallback when the variable can't
+ * be resolved from any other source (see {@link ConfigurationVariable.default}).
  */
 export function configVariable(
   name: string,
-  format: string = CONFIGURATION_VARIABLE_MARKER,
+  options?: { format?: string; default?: string },
+): ConfigurationVariable;
+/**
+ * @deprecated Passing the `format` as a string is deprecated. Pass an options
+ * object instead: `configVariable(name, { format })`.
+ */
+export function configVariable(
+  name: string,
+  format: string,
+): ConfigurationVariable;
+export function configVariable(
+  name: string,
+  formatOrOptions: string | { format?: string; default?: string } = {},
 ): ConfigurationVariable {
+  const { format = CONFIGURATION_VARIABLE_MARKER, default: defaultValue } =
+    typeof formatOrOptions === "string"
+      ? { format: formatOrOptions }
+      : formatOrOptions;
+
   if (!format.includes(CONFIGURATION_VARIABLE_MARKER)) {
     throw new HardhatError(
       HardhatError.ERRORS.CORE.GENERAL
@@ -35,7 +57,18 @@ export function configVariable(
       { format, marker: CONFIGURATION_VARIABLE_MARKER },
     );
   }
-  return { _type: "ConfigurationVariable", name, format };
+
+  const configurationVariable: ConfigurationVariable = {
+    _type: "ConfigurationVariable",
+    name,
+    format,
+  };
+
+  if (defaultValue !== undefined) {
+    configurationVariable.default = defaultValue;
+  }
+
+  return configurationVariable;
 }
 
 /**

package/src/internal/core/configuration-variables.ts

@@ -131,7 +131,9 @@ export class LazyResolvedConfigurationVariable extends BaseResolvedConfiguration
           "fetchValue",
           [this.#variable],
           async (_context, v) => {
-            const value = process.env[v.name];
+            // Fall back to the default only when the env var is unset. An empty
+            // string still takes precedence
+            const value = process.env[v.name] ?? v.default;
 
             if (typeof value !== "string") {
               throw new HardhatError(

package/src/types/config.ts

@@ -8,6 +8,18 @@ export interface ConfigurationVariable {
   _type: "ConfigurationVariable";
   name: string;
   format?: string;
+
+  /**
+   * An optional fallback value, used only when the variable can't be resolved
+   * from any other source (e.g. an environment variable or the keystore).
+   *
+   * By default, the value is resolved from the environment variable first, then
+   * any plugin source (like hardhat-keystore), and finally this default. Plugins
+   * can customize this, but the built-in resolver and bundled plugins follow this
+   * order. If none of them provide a value and no default is set, resolving the
+   * variable throws.
+   */
+  default?: string;
 }
 
 /**

package/templates/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.12.0",
+    "hardhat": "workspace:^3.14.0",
     "@nomicfoundation/hardhat-toolbox-viem": "workspace:^5.0.7",
     "@nomicfoundation/hardhat-ignition": "workspace:^3.1.8",
     "@types/node": "^22.8.5",

package/templates/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.12.0",
+    "hardhat": "workspace:^3.14.0",
     "@nomicfoundation/hardhat-toolbox-mocha-ethers": "workspace:^3.0.7",
     "@nomicfoundation/hardhat-ethers": "workspace:^4.0.15",
     "@nomicfoundation/hardhat-ignition": "workspace:^3.1.8",

package/templates/03-minimal/package.json

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

package/dist/src/internal/cli/error-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-handler.d.ts","sourceRoot":"","sources":["../../../../src/internal/cli/error-handler.ts"],"names":[],"mappings":"AAyDA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,KAAK,EACZ,qBAAqB,GAAE,OAAe,EACtC,KAAK,GAAE,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,KAAK,IAAoB,GACvD,OAAO,CAAC,IAAI,CAAC,CA8Df"}

package/dist/src/internal/cli/error-handler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../../../src/internal/cli/error-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EACL,YAAY,EACZ,kBAAkB,GACnB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEpE,8EAA8E;AAC9E,qBAAqB;AACrB,IAAI,gBAAgD,CAAC;AAErD;;;;;;GAMG;AACH,IAAK,aAOJ;AAPD,WAAK,aAAa;IAChB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;IACjB,sDAAqC,CAAA;IACrC,8DAA6C,CAAA;IAC7C,8DAA6C,CAAA;IAC7C,gCAAe,CAAA;AACjB,CAAC,EAPI,aAAa,KAAb,aAAa,QAOjB;AA4BD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAY,EACZ,wBAAiC,KAAK,EACtC,QAA2C,OAAO,CAAC,KAAK;IAExD,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAEzE,IAAI,qBAA6B,CAAC;IAClC,IAAI,mBAAuC,CAAC;IAC5C,IAAI,0BAA8C,CAAC;IAEnD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,aAAa,CAAC,OAAO;YACxB,qBAAqB,GAAG,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,gBAAgB,CAAC,SAAS,GAAG,CAAC,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC;YACrI,mBAAmB,GAAG,uBAAuB,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,WAAW,YAAY,2BAA2B,CAAC;YAChJ,MAAM;QACR,KAAK,aAAa,CAAC,MAAM;YACvB,qBAAqB,GAAG,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,gBAAgB,CAAC,SAAS,cAAc,gBAAgB,CAAC,QAAQ,GAAG,CAAC,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC;YAC5K,mBAAmB,GAAG,uBAAuB,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,WAAW,YAAY,2BAA2B,CAAC;YAChJ,MAAM;QACR,KAAK,aAAa,CAAC,gBAAgB;YACjC,qBAAqB,GAAG,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,6BAA6B,gBAAgB,CAAC,QAAQ,GAAG,CAAC,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC/I,mBAAmB,GAAG,qBAAqB,YAAY,2BAA2B,CAAC;YACnF,MAAM;QACR,KAAK,aAAa,CAAC,oBAAoB;YACrC,qBAAqB,GAAG,SAAS,CAC/B,CAAC,KAAK,EAAE,MAAM,CAAC,EACf,4BAA4B,CAC7B,CAAC;YACF,0BAA0B,GAAG,0OAA0O,CAAC;YACxQ,MAAM;QACR,KAAK,aAAa,CAAC,oBAAoB;YACrC,qBAAqB,GAAG,SAAS,CAC/B,CAAC,KAAK,EAAE,MAAM,CAAC,EACf,4BAA4B,CAC7B,CAAC;YACF,0BAA0B,GAAG,sNAAsN,CAAC;YACpP,MAAM;QACR,KAAK,aAAa,CAAC,KAAK;YACtB,qBAAqB,GAAG,SAAS,CAC/B,CAAC,KAAK,EAAE,MAAM,CAAC,EACf,+BAA+B,CAChC,CAAC;YACF,0BAA0B,GAAG,iEAAiE,mBAAmB,YAAY,CAAC;YAC9H,MAAM;IACV,CAAC;IAED,MAAM,eAAe,GACnB,qBAAqB;QACrB,QAAQ,KAAK,aAAa,CAAC,KAAK;QAChC,QAAQ,KAAK,aAAa,CAAC,oBAAoB;QAC/C,QAAQ,KAAK,aAAa,CAAC,oBAAoB,CAAC;IAElD,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAE7B,KAAK,CAAC,EAAE,CAAC,CAAC;IAEV,IAAI,eAAe,EAAE,CAAC;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,0BAA0B,KAAK,SAAS,EAAE,CAAC;YAC7C,KAAK,CAAC,EAAE,CAAC,CAAC;YACV,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;SAAM,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;QAC7C,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,KAAY;IAC9C,IAAI,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO;gBACL,QAAQ,EAAE,aAAa,CAAC,OAAO;gBAC/B,gBAAgB,EAAE,KAAK;aACxB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,QAAQ,EAAE,aAAa,CAAC,MAAM;gBAC9B,gBAAgB,EAAE,KAAK;aACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,kBAAkB,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO;YACL,QAAQ,EAAE,aAAa,CAAC,gBAAgB;YACxC,gBAAgB,EAAE,KAAK;SACxB,CAAC;IACJ,CAAC;IAED,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACnC,gBAAgB;YACd,MAAM,MAAM,CAAC,gDAAgD,CAAC,CAAC;IACnE,CAAC;IAED,6EAA6E;IAC7E,4EAA4E;IAC5E,8EAA8E;IAC9E,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACvE,IACE,kBAAkB;QAClB,gBAAgB,CAAC,aAAa,CAAC,0BAA0B,EACzD,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,aAAa,CAAC,oBAAoB;YAC5C,gBAAgB,EAAE,KAAK;SACxB,CAAC;IACJ,CAAC;IACD,IACE,kBAAkB;QAClB,gBAAgB,CAAC,aAAa,CAAC,0BAA0B,EACzD,CAAC;QACD,OAAO;YACL,QAAQ,EAAE,aAAa,CAAC,oBAAoB;YAC5C,gBAAgB,EAAE,KAAK;SACxB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,aAAa,CAAC,KAAK;QAC7B,gBAAgB,EAAE,KAAK;KACxB,CAAC;AACJ,CAAC"}