Merge pull request #7154 from NomicFoundation/solidity-config-resolution

Solidity Config Resolution Enhancements

Author: kanej

.changeset/pink-crabs-bow.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Update how production profiles are derived from the default config ([#7154](https://github.com/NomicFoundation/hardhat/pull/7154))

v-next/hardhat-ignition-core/test/helpers/execution-result-fixtures.ts

@@ -405,7 +405,7 @@ export const staticCallResultFixturesArtifacts: {
     deployedLinkReferences: {},
     immutableReferences: {},
     inputSourceName: "project/contracts/C.sol",
-    buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+    buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
   },
 };
 
@@ -442,7 +442,7 @@ export const deploymentFixturesArtifacts: { [contractName: string]: Artifact } =
       deployedLinkReferences: {},
       immutableReferences: {},
       inputSourceName: "project/contracts/C.sol",
-      buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+      buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
     },
     WithLibrary: {
       _format: "hh3-artifact-1",
@@ -471,7 +471,7 @@ export const deploymentFixturesArtifacts: { [contractName: string]: Artifact } =
       deployedLinkReferences: {},
       immutableReferences: {},
       inputSourceName: "project/contracts/C.sol",
-      buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+      buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
     },
     WithAmbiguousLibraryName: {
       _format: "hh3-artifact-1",
@@ -508,7 +508,7 @@ export const deploymentFixturesArtifacts: { [contractName: string]: Artifact } =
       deployedLinkReferences: {},
       immutableReferences: {},
       inputSourceName: "project/contracts/C.sol",
-      buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+      buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
     },
   };
 
@@ -590,7 +590,7 @@ export const callEncodingFixtures: { [contractName: string]: Artifact } = {
     deployedLinkReferences: {},
     immutableReferences: {},
     inputSourceName: "project/contracts/C.sol",
-    buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+    buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
   },
   ToTestEthersEncodingConversion: {
     _format: "hh3-artifact-1",
@@ -949,7 +949,7 @@ export const callEncodingFixtures: { [contractName: string]: Artifact } = {
     deployedLinkReferences: {},
     immutableReferences: {},
     inputSourceName: "project/contracts/C.sol",
-    buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+    buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
   },
   FunctionNameValidation: {
     _format: "hh3-artifact-1",
@@ -1069,6 +1069,6 @@ export const callEncodingFixtures: { [contractName: string]: Artifact } = {
     deployedLinkReferences: {},
     immutableReferences: {},
     inputSourceName: "project/contracts/C.sol",
-    buildInfoId: "solc-0_8_19-a45ba3c37b2deb0d1fadc772202f4cbff6d5a67a",
+    buildInfoId: "solc-0_8_19-2fe1cba8ef218c727cd1ce3da3aaa170f8016338",
   },
 };

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

@@ -1,8 +1,3 @@
 export const DEFAULT_BUILD_PROFILE = "default";
 
-export const DEFAULT_BUILD_PROFILES = [
-  "default",
-  "production",
-  "solidity-tests",
-  "javascript-tests",
-] as const;
+export const DEFAULT_BUILD_PROFILES = ["default", "production"] as const;

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

@@ -158,16 +158,26 @@ export class CompilationJobImplementation implements CompilationJob {
       };
     }
 
+    const resolvedSettings: CompilerInput["settings"] = {
+      ...settings,
+      evmVersion:
+        settings.evmVersion ??
+        getEvmVersionFromSolcVersion(this.solcConfig.version),
+      outputSelection: this.#dedupeAndSortOutputSelection(outputSelection),
+      remappings: this.dependencyGraph.getAllRemappings(),
+    };
+
+    /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions --
+      We just sort the same object to make the builds more consistent */
+    const sortedSettings = Object.fromEntries(
+      Object.entries(resolvedSettings).sort(([keyA], [keyB]) =>
+        keyA.localeCompare(keyB),
+      ),
+    ) as CompilerInput["settings"];
+
     return {
       language: "Solidity",
-      settings: {
-        ...settings,
-        evmVersion:
-          settings.evmVersion ??
-          getEvmVersionFromSolcVersion(this.solcConfig.version),
-        outputSelection: this.#dedupeAndSortOutputSelection(outputSelection),
-        remappings: this.dependencyGraph.getAllRemappings(),
-      },
+      settings: sortedSettings,
       sources,
     };
   }

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

@@ -1,13 +1,19 @@
 import type { HardhatUserConfig } from "../../../config.js";
 import type {
   HardhatConfig,
+  MultiVersionSolidityUserConfig,
+  SingleVersionSolidityUserConfig,
+  SolcConfig,
+  SolcUserConfig,
   SolidityBuildProfileConfig,
   SolidityConfig,
   SolidityUserConfig,
 } from "../../../types/config.js";
 import type { HardhatUserConfigValidationError } from "../../../types/hooks.js";
 
-import { isObject } from "@nomicfoundation/hardhat-utils/lang";
+import os from "node:os";
+
+import { deepMerge, isObject } from "@nomicfoundation/hardhat-utils/lang";
 import { resolveFromRoot } from "@nomicfoundation/hardhat-utils/path";
 import {
   conditionalUnionType,
@@ -213,126 +219,57 @@ function resolveSolidityConfig(
     solidityConfig = [solidityConfig];
   }
 
+  // user provided an array of versions or a single version
   if (Array.isArray(solidityConfig)) {
-    return {
-      profiles: {
-        default: {
-          compilers: solidityConfig.map((version) => ({
-            version,
-            settings: {},
-          })),
-          overrides: {},
-          isolated: false,
-          preferWasm: false,
-        },
-      },
-      npmFilesToBuild: [],
+    const defaultSolidityConfig = {
+      compilers: solidityConfig.map((version) => ({ version })),
     };
-  }
-
-  if ("version" in solidityConfig) {
     return {
       profiles: {
-        default: {
-          compilers: [
-            {
-              version: solidityConfig.version,
-              settings: solidityConfig.settings ?? {},
-            },
-          ],
-          overrides: {},
-          isolated: solidityConfig.isolated ?? false,
-          preferWasm: solidityConfig.preferWasm ?? false,
-        },
+        default: resolveBuildProfileConfig(defaultSolidityConfig),
+        production: resolveBuildProfileConfig(
+          copyFromDefault(defaultSolidityConfig),
+          true,
+        ),
       },
-      npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
+      npmFilesToBuild: [],
     };
   }
 
-  if ("compilers" in solidityConfig) {
+  // user provided a single version config or a multi version config
+  if ("version" in solidityConfig || "compilers" in solidityConfig) {
     return {
       profiles: {
-        default: {
-          preferWasm: solidityConfig.preferWasm ?? false,
-          compilers: solidityConfig.compilers.map((compiler) => ({
-            version: compiler.version,
-            settings: compiler.settings ?? {},
-          })),
-          overrides: Object.fromEntries(
-            Object.entries(solidityConfig.overrides ?? {}).map(
-              ([userSourceName, override]) => {
-                return [
-                  userSourceName,
-                  {
-                    version: override.version,
-                    settings: override.settings ?? {},
-                  },
-                ];
-              },
-            ),
-          ),
-          isolated: solidityConfig.isolated ?? false,
-        },
+        default: resolveBuildProfileConfig(solidityConfig),
+        production: resolveBuildProfileConfig(
+          copyFromDefault(solidityConfig),
+          true,
+        ),
       },
       npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
     };
   }
 
+  // user provided a build profiles config
   const profiles: Record<string, SolidityBuildProfileConfig> = {};
 
-  // TODO: Merge the profiles
   for (const [profileName, profile] of Object.entries(
     solidityConfig.profiles,
   )) {
-    const isolated = profile.isolated ?? profileName === "production";
-    const preferWasm = profile.preferWasm ?? profileName === "production";
-
-    if ("version" in profile) {
-      profiles[profileName] = {
-        compilers: [
-          {
-            version: profile.version,
-            settings: profile.settings ?? {},
-          },
-        ],
-        overrides: {},
-        isolated,
-        preferWasm,
-      };
-      continue;
-    }
-
-    profiles[profileName] = {
-      compilers: profile.compilers.map((compiler) => ({
-        version: compiler.version,
-        settings: compiler.settings ?? {},
-      })),
-      overrides: Object.fromEntries(
-        Object.entries(profile.overrides ?? {}).map(
-          ([userSourceName, override]) => {
-            return [
-              userSourceName,
-              {
-                version: override.version,
-                settings: override.settings ?? {},
-              },
-            ];
-          },
-        ),
-      ),
-      isolated,
-      preferWasm,
-    };
+    profiles[profileName] = resolveBuildProfileConfig(
+      profile,
+      profileName === "production",
+    );
   }
 
-  // This will generate default build profiles (e.g. production) when they are not specified in the config, cloning from 'default', which is always present
+  // This will generate default build profiles (e.g. production) when they are
+  // not specified in the config, cloning from 'default', which is always present
   for (const profile of DEFAULT_BUILD_PROFILES) {
     if (!(profile in profiles)) {
-      profiles[profile] = {
-        ...profiles.default,
-        isolated: profile === "production",
-        preferWasm: profile === "production",
-      };
+      profiles[profile] = resolveBuildProfileConfig(
+        copyFromDefault(solidityConfig.profiles.default),
+        profile === "production",
+      );
     }
   }
 
@@ -341,3 +278,99 @@ function resolveSolidityConfig(
     npmFilesToBuild: solidityConfig.npmFilesToBuild ?? [],
   };
 }
+
+function resolveBuildProfileConfig(
+  solidityConfig:
+    | SingleVersionSolidityUserConfig
+    | MultiVersionSolidityUserConfig,
+  production: boolean = false,
+): SolidityBuildProfileConfig {
+  if ("version" in solidityConfig) {
+    return {
+      compilers: [resolveSolcConfig(solidityConfig, production)],
+      overrides: {},
+      isolated: solidityConfig.isolated ?? production,
+      preferWasm: solidityConfig.preferWasm ?? (production && shouldUseWasm()),
+    };
+  }
+
+  return {
+    compilers: solidityConfig.compilers.map((compiler) =>
+      resolveSolcConfig(compiler, production),
+    ),
+    overrides: Object.fromEntries(
+      Object.entries(solidityConfig.overrides ?? {}).map(
+        ([userSourceName, override]) => [
+          userSourceName,
+          resolveSolcConfig(override, production),
+        ],
+      ),
+    ),
+    isolated: solidityConfig.isolated ?? production,
+    preferWasm: solidityConfig.preferWasm ?? (production && shouldUseWasm()),
+  };
+}
+
+function resolveSolcConfig(
+  solcConfig: SolcUserConfig,
+  production: boolean = false,
+): SolcConfig {
+  const defaultSolcConfigSettings: SolcConfig["settings"] = {
+    outputSelection: {
+      "*": {
+        "": ["ast"],
+        "*": [
+          "abi",
+          "evm.bytecode",
+          "evm.deployedBytecode",
+          "evm.methodIdentifiers",
+          "metadata",
+        ],
+      },
+    },
+  };
+
+  if (production) {
+    defaultSolcConfigSettings.optimizer = {
+      enabled: true,
+      runs: 200,
+    };
+  }
+
+  return {
+    version: solcConfig.version,
+    settings: deepMerge(defaultSolcConfigSettings, solcConfig.settings ?? {}),
+  };
+}
+
+function copyFromDefault(
+  defaultSolidityConfig:
+    | SingleVersionSolidityUserConfig
+    | MultiVersionSolidityUserConfig,
+): SingleVersionSolidityUserConfig | MultiVersionSolidityUserConfig {
+  if ("version" in defaultSolidityConfig) {
+    return {
+      version: defaultSolidityConfig.version,
+    };
+  }
+
+  return {
+    compilers: defaultSolidityConfig.compilers.map((c) => ({
+      version: c.version,
+    })),
+    overrides: Object.fromEntries(
+      Object.entries(defaultSolidityConfig.overrides ?? {}).map(
+        ([userSourceName, override]) => [
+          userSourceName,
+          { version: override.version },
+        ],
+      ),
+    ),
+  };
+}
+
+// We use wasm builds in production to avoid using unofficial builds for deployments
+// This should change once https://github.com/ethereum/solidity/issues/11351 gets resolved
+export function shouldUseWasm(): boolean {
+  return os.platform() === "linux" && os.arch() === "arm64";
+}