Merge pull request #7107 from NomicFoundation/compiler-selection-changes

Compiler selection changes

Author: kanej

.changeset/nine-lies-press.md

@@ -0,0 +1,6 @@
+---
+"@nomicfoundation/hardhat-utils": patch
+"hardhat": patch
+---
+
+Add preferWasm flag to config. Default to wasm on production profile. Support linux-aarch64 native compiler ([#5993](https://github.com/NomicFoundation/hardhat/issues/5993))

v-next/hardhat-utils/src/crypto.ts

@@ -1,4 +1,5 @@
 import { keccak256 as keccak256Impl } from "ethereum-cryptography/keccak";
+import { sha256 as sha256Impl } from "ethereum-cryptography/sha256";
 
 /**
  * Computes the Keccak-256 hash of the input bytes.
@@ -10,6 +11,16 @@ export async function keccak256(bytes: Uint8Array): Promise<Uint8Array> {
   return keccak256Impl(bytes);
 }
 
+/**
+ * Computes the SHA-256 hash of the input bytes.
+ *
+ * @param bytes The input bytes to hash.
+ * @returns The SHA-256 hash of the input bytes.
+ */
+export async function sha256(bytes: Uint8Array): Promise<Uint8Array> {
+  return sha256Impl(bytes);
+}
+
 /**
  * Creates a non-cryptographic hash-based identifier for the given input.
  *

v-next/hardhat-verify/test/solc-versions.ts

@@ -28,6 +28,7 @@ describe("solc-versions", () => {
           },
         ],
         overrides: {},
+        preferWasm: false,
       };
       const expected = ["0.8.18", "0.7.2", "0.4.11"];
 
@@ -50,6 +51,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        preferWasm: false,
       };
       const expected = ["0.5.5", "0.6.4"];
 
@@ -81,6 +83,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        preferWasm: false,
       };
       const expected = ["0.8.18", "0.7.2", "0.5.5", "0.6.4"];
 
@@ -104,6 +107,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        preferWasm: false,
       };
       const expected = ["0.8.18", "0.8.18"];
 
@@ -131,6 +135,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        preferWasm: false,
       };
 
       await assertRejectsWithHardhatError(
@@ -160,6 +165,7 @@ describe("solc-versions", () => {
             settings: {},
           },
         },
+        preferWasm: false,
       };
 
       await assertRejectsWithHardhatError(

v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts

@@ -1,4 +1,5 @@
 import type { CompileCache } from "./cache.js";
+import type { Compiler } from "./compiler/compiler.js";
 import type { DependencyGraphImplementation } from "./dependency-graph.js";
 import type { Artifact } from "../../../../types/artifacts.js";
 import type { SolcConfig, SolidityConfig } from "../../../../types/config.js";
@@ -13,6 +14,7 @@ import type {
   RunCompilationJobOptions,
   GetCompilationJobsResult,
   EmitArtifactsResult,
+  RunCompilationJobResult,
 } from "../../../../types/solidity/build-system.js";
 import type { CompilationJob } from "../../../../types/solidity/compilation-job.js";
 import type {
@@ -76,6 +78,7 @@ interface CompilationResult {
   compilationJob: CompilationJob;
   compilerOutput: CompilerOutput;
   cached: boolean;
+  compiler: Compiler;
 }
 
 export interface SolidityBuildSystemOptions {
@@ -152,21 +155,19 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       ),
     );
 
-    const runCompilationJobOptions: RunCompilationJobOptions = {
-      quiet: options?.quiet,
-    };
     const results: CompilationResult[] = await pMap(
       runnableCompilationJobs,
       async (runnableCompilationJob) => {
-        const compilerOutput = await this.runCompilationJob(
+        const { output, compiler } = await this.runCompilationJob(
           runnableCompilationJob,
-          runCompilationJobOptions,
+          options,
         );
 
         return {
           compilationJob: runnableCompilationJob,
-          compilerOutput,
+          compilerOutput: output,
           cached: false,
+          compiler,
         };
       },
       {
@@ -301,22 +302,15 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       readSourceFileFactory(this.#hooks),
     );
 
-    const buildProfileName = options?.buildProfile ?? DEFAULT_BUILD_PROFILE;
-
-    if (this.#options.solidityConfig.profiles[buildProfileName] === undefined) {
-      throw new HardhatError(
-        HardhatError.ERRORS.CORE.SOLIDITY.BUILD_PROFILE_NOT_FOUND,
-        {
-          buildProfileName,
-        },
-      );
-    }
+    const { buildProfileName, buildProfile } = this.#getBuildProfile(
+      options?.buildProfile,
+    );
 
     log(`Using build profile ${buildProfileName}`);
 
     const solcConfigSelector = new SolcConfigSelector(
       buildProfileName,
-      this.#options.solidityConfig.profiles[buildProfileName],
+      buildProfile,
       dependencyGraph,
     );
 
@@ -340,15 +334,19 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       subgraphsWithConfig.push([configOrError, subgraph]);
     }
 
-    // build version => longVersion map
+    // get longVersion and isWasm from the compiler for each version
     const solcVersionToLongVersion = new Map<string, string>();
+    const versionIsWasm = new Map<string, boolean>();
     for (const [solcConfig] of subgraphsWithConfig) {
       let solcLongVersion = solcVersionToLongVersion.get(solcConfig.version);
 
       if (solcLongVersion === undefined) {
-        const compiler = await getCompiler(solcConfig.version);
+        const compiler = await getCompiler(solcConfig.version, {
+          preferWasm: buildProfile.preferWasm,
+        });
         solcLongVersion = compiler.longVersion;
         solcVersionToLongVersion.set(solcConfig.version, solcLongVersion);
+        versionIsWasm.set(solcConfig.version, compiler.isSolcJs);
       }
     }
 
@@ -394,13 +392,20 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     for (const [rootFile, compilationJob] of indexedIndividualJobs.entries()) {
       const jobHash = await compilationJob.getBuildId();
       const cacheResult = this.#compileCache[rootFile];
+      const isWasm = versionIsWasm.get(compilationJob.solcConfig.version);
+
+      assertHardhatInvariant(
+        isWasm !== undefined,
+        `Version ${compilationJob.solcConfig.version} not present in isWasm map`,
+      );
 
       // If there's no cache for the root file, or the compilation job changed, or using force flag, or isolated mode changed, compile it
       if (
         options?.force === true ||
         cacheResult === undefined ||
         cacheResult.jobHash !== jobHash ||
-        cacheResult.isolated !== isolated
+        cacheResult.isolated !== isolated ||
+        cacheResult.wasm !== isWasm
       ) {
         rootFilesToCompile.add(rootFile);
         continue;
@@ -506,10 +511,26 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     return { compilationJobsPerFile, indexedIndividualJobs };
   }
 
+  #getBuildProfile(buildProfileName: string = DEFAULT_BUILD_PROFILE) {
+    const buildProfile =
+      this.#options.solidityConfig.profiles[buildProfileName];
+
+    if (buildProfile === undefined) {
+      throw new HardhatError(
+        HardhatError.ERRORS.CORE.SOLIDITY.BUILD_PROFILE_NOT_FOUND,
+        {
+          buildProfileName,
+        },
+      );
+    }
+
+    return { buildProfileName, buildProfile };
+  }
+
   public async runCompilationJob(
     runnableCompilationJob: CompilationJob,
     options?: RunCompilationJobOptions,
-  ): Promise<CompilerOutput> {
+  ): Promise<RunCompilationJobResult> {
     await this.#downloadConfiguredCompilers(options?.quiet);
 
     let numberOfFiles = 0;
@@ -520,8 +541,11 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     const numberOfRootFiles =
       runnableCompilationJob.dependencyGraph.getRoots().size;
 
+    const { buildProfile } = this.#getBuildProfile(options?.buildProfile);
+
     const compiler = await getCompiler(
       runnableCompilationJob.solcConfig.version,
+      { preferWasm: buildProfile.preferWasm },
     );
 
     log(
@@ -533,7 +557,10 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
       "The long version of the compiler should match the long version of the compilation job",
     );
 
-    return compiler.compile(await runnableCompilationJob.getSolcInput());
+    const output = await compiler.compile(
+      await runnableCompilationJob.getSolcInput(),
+    );
+    return { output, compiler };
   }
 
   public async remapCompilerError(
@@ -906,6 +933,7 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
         buildInfoPath: emitArtifactsResult.buildInfoPath,
         buildInfoOutputPath: emitArtifactsResult.buildInfoOutputPath,
         typeFilePath,
+        wasm: result.compiler.isSolcJs,
       };
     }
   }

v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/cache.ts

@@ -21,6 +21,7 @@ export interface CompileCacheEntry {
   buildInfoOutputPath: string;
   artifactPaths: string[];
   typeFilePath: string;
+  wasm: boolean;
 }
 
 const CACHE_FILE_NAME = `compile-cache.json`;

v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/compiler/compiler.ts

@@ -137,11 +137,7 @@ export class SolcJsCompiler implements Compiler {
       const compilerFileUrl = pathToFileURL(this.compilerPath);
       // NOTE: The script path passed to a tsx/esm loader is an exception to the
       // above rule since the tsx/esm loader doesn't support URLs with a scheme.
-      if (scriptPath.endsWith(".ts")) {
-        args.push(scriptPath);
-      } else {
-        args.push(scriptFileUrl);
-      }
+      args.push(scriptPath);
       args.push(compilerFileUrl.href);
     } else {
       args.push(scriptPath, this.compilerPath);