Address new PR comments

marianfe · marianfe · commit 0d075d2d0da1 · 2026-03-23T12:22:43.000+01:00
diff --git a/.changeset/good-eels-buy.md b/.changeset/good-eels-buy.md
@@ -2,4 +2,4 @@
 "hardhat": patch
 ---
 
-Add `downloadCompilers` and `getCompiler` hooks for extensible custom compiler support
+Add `SolidityHooks#downloadCompilers` and `SolidityHooks#getCompiler` hooks for extensible custom compiler support ([#8009](https://github.com/NomicFoundation/hardhat/pull/8009))
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts
@@ -58,6 +58,7 @@ import pMap from "p-map";
 
 import { FileBuildResultType } from "../../../../types/solidity/build-system.js";
 import { DEFAULT_BUILD_PROFILE } from "../build-profiles.js";
+import { getSolcCompilerForConfig } from "../solidity-hooks.js";
 
 import {
   getArtifactsDeclarationFile,
@@ -91,20 +92,6 @@ export function isSolcSolidityCompilerConfig(
   return config.type === undefined || config.type === "solc";
 }
 
-/**
- * Resolves the preferWasm setting for a given compiler config, falling back
- * to the build profile's preferWasm if not set on the compiler.
- */
-function resolvePreferWasm(
-  compilerConfig: SolidityCompilerConfig,
-  buildProfilePreferWasm: boolean,
-): boolean {
-  if (isSolcSolidityCompilerConfig(compilerConfig)) {
-    return compilerConfig.preferWasm ?? buildProfilePreferWasm;
-  }
-  return false;
-}
-
 // Compiler warnings to suppress from build output.
 // Each rule specifies a warning message and the source file it applies to.
 // This allows suppressing known warnings from internal files (e.g., console.sol)
@@ -511,10 +498,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
           "getCompiler",
           [compilerConfig],
           async (_context, cfg) =>
-            getCompiler(cfg.version, {
-              preferWasm: resolvePreferWasm(cfg, buildProfile.preferWasm),
-              compilerPath: cfg.path,
-            }),
+            getSolcCompilerForConfig(cfg, buildProfile.preferWasm),
         );
         longVersion = compiler.longVersion;
         longVersionMap.set(compilerConfig.version, longVersion);
@@ -758,10 +742,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       "getCompiler",
       [runnableCompilationJob.solcConfig],
       async (_context, cfg) =>
-        getCompiler(cfg.version, {
-          preferWasm: resolvePreferWasm(cfg, buildProfile.preferWasm),
-          compilerPath: cfg.path,
-        }),
+        getSolcCompilerForConfig(cfg, buildProfile.preferWasm),
     );
 
     log(
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/hook-handlers/solidity.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/hook-handlers/solidity.ts
@@ -1,16 +1,9 @@
 import type { SolidityHooks } from "../../../../types/hooks.js";
 
-import { isSolcConfig } from "../build-system/build-system.js";
-import { downloadSolcCompilers } from "../build-system/compiler/index.js";
+import { downloadSolcCompilersHandler } from "../solidity-hooks.js";
 
 export default async (): Promise<Partial<SolidityHooks>> => ({
   downloadCompilers: async (_context, compilerConfigs, quiet) => {
-    const solcVersions = new Set(
-      compilerConfigs.filter(isSolcConfig).map((c) => c.version),
-    );
-
-    if (solcVersions.size > 0) {
-      await downloadSolcCompilers(solcVersions, quiet);
-    }
+    await downloadSolcCompilersHandler(compilerConfigs, quiet);
   },
 });
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/solidity-hooks.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/solidity-hooks.ts
@@ -0,0 +1,53 @@
+import type { SolidityCompilerConfig } from "../../../types/config.js";
+import type { Compiler } from "../../../types/solidity.js";
+
+import { isSolcSolidityCompilerConfig } from "./build-system/build-system.js";
+import {
+  downloadSolcCompilers,
+  getCompiler,
+} from "./build-system/compiler/index.js";
+
+/**
+ * Downloads solc compilers for the given configs, filtering out non-solc types.
+ * This is the default implementation of the `downloadCompilers` hook handler.
+ */
+export async function downloadSolcCompilersHandler(
+  compilerConfigs: SolidityCompilerConfig[],
+  quiet: boolean,
+): Promise<void> {
+  const solcVersions = new Set(
+    compilerConfigs.filter(isSolcSolidityCompilerConfig).map((c) => c.version),
+  );
+
+  if (solcVersions.size > 0) {
+    await downloadSolcCompilers(solcVersions, quiet);
+  }
+}
+
+/**
+ * Resolves the preferWasm setting for a given compiler config, falling back
+ * to the build profile's preferWasm if not set on the compiler.
+ */
+export function resolvePreferWasm(
+  compilerConfig: SolidityCompilerConfig,
+  buildProfilePreferWasm: boolean,
+): boolean {
+  if (isSolcSolidityCompilerConfig(compilerConfig)) {
+    return compilerConfig.preferWasm ?? buildProfilePreferWasm;
+  }
+  return false;
+}
+
+/**
+ * Creates a solc Compiler for the given config. This is the default
+ * implementation used as the fallback in the `getCompiler` hook chain.
+ */
+export async function getSolcCompilerForConfig(
+  compilerConfig: SolidityCompilerConfig,
+  buildProfilePreferWasm: boolean,
+): Promise<Compiler> {
+  return getCompiler(compilerConfig.version, {
+    preferWasm: resolvePreferWasm(compilerConfig, buildProfilePreferWasm),
+    compilerPath: compilerConfig.path,
+  });
+}
diff --git a/v-next/hardhat/test/internal/builtin-plugins/solidity/hooks.ts b/v-next/hardhat/test/internal/builtin-plugins/solidity/hooks.ts
@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/consistent-type-assertions -- We use `as any` casts
+   for non-solc compiler configs in tests because "solx" is not registered in the base type system. */
 import type {
   ConfigurationVariableResolver,
   HardhatConfig,
@@ -464,7 +466,7 @@ describe("solidity - hooks", () => {
         solidity: {
           compilers: [
             { version: "0.8.23" },
-            { type: "solx", version: "0.8.23" },
+            { type: "solx", version: "0.8.23" } as any,
           ],
         },
       });
@@ -482,7 +484,7 @@ describe("solidity - hooks", () => {
         "Should include solc configs (type undefined)",
       );
       assert.equal(
-        capturedConfigs.filter((c) => c.type === "solx").length > 0,
+        capturedConfigs.filter((c) => (c as any).type === "solx").length > 0,
         true,
         "Should include non-solc configs (type solx)",
       );
@@ -498,7 +500,11 @@ describe("solidity - hooks", () => {
         solidity: {
           compilers: [
             { version: "0.8.23" },
-            { type: "solx", version: "0.8.23", path: "/mock/path/to/solx" },
+            {
+              type: "solx",
+              version: "0.8.23",
+              path: "/mock/path/to/solx",
+            } as any,
           ],
         },
       });
