@openzeppelin/upgrades-core 1.44.2 → 1.45.0-alpha.1

package/src/cli/validate/build-info-file.ts

@@ -129,7 +129,7 @@ async function exists(dir: string) {
 
 async function getJsonFiles(dir: string): Promise<string[]> {
   const files = await fs.readdir(dir);
-  const jsonFiles = files.filter(file => file.endsWith('.json'));
+  const jsonFiles = files.filter(file => file.endsWith('.json') && !file.endsWith('.output.json'));
   return jsonFiles.map(file => path.join(dir, file));
 }
 
@@ -137,44 +137,169 @@ async function readBuildInfo(buildInfoFilePaths: string[], dirShortName: string)
   const buildInfoFiles: BuildInfoFile[] = [];
 
   for (const buildInfoFilePath of buildInfoFilePaths) {
-    const buildInfoJson = await readJSON(buildInfoFilePath);
-    if (
-      buildInfoJson.input === undefined ||
-      buildInfoJson.output === undefined ||
-      buildInfoJson.solcVersion === undefined
-    ) {
+    const buildInfo = await loadBuildInfo(buildInfoFilePath);
+
+    checkOutputSelection(buildInfo.input, buildInfoFilePath);
+
+    buildInfoFiles.push({
+      input: buildInfo.input,
+      output: buildInfo.output,
+      solcVersion: buildInfo.solcVersion,
+      dirShortName,
+    });
+  }
+  return buildInfoFiles;
+}
+
+const FOUNDRY_BUILD_INFO_HELP = `\
+Foundry build-info files must contain Solidity compiler input, output, and solcVersion.
+Ensure foundry.toml has:
+  [profile.default]
+  build_info = true
+  extra_output = ["storageLayout"]
+Then run: ${FOUNDRY_COMPILE_COMMAND}`;
+
+const HH3_BUILD_INFO_HELP = `\
+Hardhat 3's build-info uses a main .json file (input, solcVersion) and a separate .output.json (output).
+Ensure you compile with Hardhat 3 so that artifacts/build-info/ contains both the main files and the .output.json files.
+Run: ${HARDHAT_COMPILE_COMMAND}`;
+
+const GENERIC_BUILD_INFO_HELP = `\
+If using Foundry, ensure foundry.toml has build_info = true and extra_output = ["storageLayout"], then compile with '${FOUNDRY_COMPILE_COMMAND}'.
+If using Hardhat, compile with '${HARDHAT_COMPILE_COMMAND}'.`;
+
+async function loadBuildInfo(buildInfoFilePath: string): Promise<{
+  input: SolcInput;
+  output: SolcOutput;
+  solcVersion: string;
+}> {
+  const buildInfoJson = await readJSON(buildInfoFilePath);
+
+  if (
+    buildInfoJson.input !== undefined &&
+    buildInfoJson.output !== undefined &&
+    buildInfoJson.solcVersion !== undefined
+  ) {
+    return {
+      input: buildInfoJson.input,
+      output: buildInfoJson.output,
+      solcVersion: buildInfoJson.solcVersion,
+    };
+  }
+
+  const format = buildInfoJson._format as string | undefined;
+
+  // Foundry (ethers-rs-sol-build-info-1) normally has input, output, solcVersion at top level.
+  // If we reach here with Foundry format, a field is missing — suggest recompiling.
+  if (typeof format === 'string' && format.startsWith('ethers-rs-sol-build-info')) {
+    throw new ValidateCommandError(
+      `Build info file ${buildInfoFilePath} must contain Solidity compiler input, output, and solcVersion. Got format: ${format}.`,
+      () => FOUNDRY_BUILD_INFO_HELP,
+    );
+  }
+
+  if (typeof format === 'string' && format.startsWith('hh3-sol-build-info')) {
+    if (buildInfoJson.input === undefined || buildInfoJson.solcVersion === undefined) {
       throw new ValidateCommandError(
-        `Build info file ${buildInfoFilePath} must contain Solidity compiler input, output, and solcVersion.`,
+        `Build info file ${buildInfoFilePath} (Hardhat 3 format) must contain input and solcVersion. Got format: ${format}.`,
+        () => HH3_BUILD_INFO_HELP,
       );
-    } else {
-      checkOutputSelection(buildInfoJson, buildInfoFilePath);
-
-      buildInfoFiles.push({
-        input: buildInfoJson.input,
-        output: buildInfoJson.output,
-        solcVersion: buildInfoJson.solcVersion,
-        dirShortName: dirShortName,
-      });
     }
+    let inputData: SolcInput = buildInfoJson.input;
+    let outputData: SolcOutput | undefined = buildInfoJson.output;
+
+    if (outputData === undefined) {
+      const { dir, name } = path.parse(buildInfoFilePath);
+      const outputFilePath = path.join(dir, `${name}.output.json`);
+
+      try {
+        const outputJson = await readJSON(outputFilePath);
+        outputData = outputJson.output ?? outputJson;
+      } catch (error) {
+        throw new ValidateCommandError(
+          `Build info file ${buildInfoFilePath} does not contain output, and output file ${outputFilePath} could not be read.`,
+          () => HH3_BUILD_INFO_HELP,
+        );
+      }
+
+      if (outputData === undefined) {
+        throw new ValidateCommandError(
+          `Build info file ${buildInfoFilePath} does not contain output, and output file ${outputFilePath} is missing Solidity compiler output.`,
+          () => HH3_BUILD_INFO_HELP,
+        );
+      }
+    }
+
+    const userSourceNameMap: Record<string, string> | undefined = buildInfoJson.userSourceNameMap;
+    if (userSourceNameMap !== undefined) {
+      const canonicalToUser: Record<string, string> = {};
+      for (const [userSource, canonicalSource] of Object.entries(userSourceNameMap)) {
+        canonicalToUser[canonicalSource] = userSource;
+      }
+
+      if (inputData.sources !== undefined) {
+        inputData = {
+          ...inputData,
+          sources: remapKeys(inputData.sources, canonicalToUser),
+        };
+      }
+
+      if (outputData.sources !== undefined) {
+        outputData = {
+          ...outputData,
+          sources: remapKeys(outputData.sources, canonicalToUser),
+          contracts:
+            outputData.contracts !== undefined
+              ? remapKeys(outputData.contracts, canonicalToUser)
+              : outputData.contracts,
+        };
+      } else if (outputData.contracts !== undefined) {
+        outputData = {
+          ...outputData,
+          contracts: remapKeys(outputData.contracts, canonicalToUser),
+        };
+      }
+    }
+
+    return {
+      input: inputData,
+      output: outputData,
+      solcVersion: buildInfoJson.solcVersion,
+    };
   }
-  return buildInfoFiles;
+
+  throw new ValidateCommandError(
+    `Build info from ${buildInfoFilePath} must include Solidity compiler input, output, and solcVersion. Got format: ${format ?? 'unknown'}.`,
+    () => GENERIC_BUILD_INFO_HELP,
+  );
 }
 
 /**
  * Gives an error if there is empty output selection for any contract, or a contract does not have storage layout.
  */
-function checkOutputSelection(buildInfoJson: any, buildInfoFilePath: string) {
-  const o = buildInfoJson.input.settings?.outputSelection;
+function checkOutputSelection(input: SolcInput, buildInfoFilePath: string) {
+  const outputSelection = input.settings?.outputSelection;
+
+  if (outputSelection === undefined) {
+    throw new ValidateCommandError(
+      `Build info file ${buildInfoFilePath} does not define compiler outputSelection.`,
+      () => STORAGE_LAYOUT_HELP,
+    );
+  }
+
+  Object.keys(outputSelection).forEach(item => {
+    const selection = outputSelection[item] ?? {};
+    const unnamed = Array.isArray(selection['']) ? selection[''] : [];
+    const wildcard = Array.isArray(selection['*']) ? selection['*'] : [];
 
-  return Object.keys(o).forEach((item: any) => {
-    if ((o[item][''] === undefined || o[item][''].length === 0) && o[item]['*'].length === 0) {
+    if (unnamed.length === 0 && wildcard.length === 0) {
       // No outputs at all for this contract e.g. if there were no changes since the last compile in Foundry.
       // This is not supported for now, since it leads to AST nodes that reference node ids in other build-info files.
       throw new ValidateCommandError(
         `Build info file ${buildInfoFilePath} is not from a full compilation.`,
         () => PARTIAL_COMPILE_HELP,
       );
-    } else if (!o[item]['*'].includes('storageLayout')) {
+    } else if (!wildcard.includes('storageLayout')) {
       throw new ValidateCommandError(
         `Build info file ${buildInfoFilePath} does not contain storage layout for all contracts.`,
         () => STORAGE_LAYOUT_HELP,
@@ -186,3 +311,12 @@ function checkOutputSelection(buildInfoJson: any, buildInfoFilePath: string) {
 async function readJSON(path: string) {
   return JSON.parse(await fs.readFile(path, 'utf8'));
 }
+
+function remapKeys<T>(original: Record<string, T>, canonicalToUser: Record<string, string>): Record<string, T> {
+  const remapped: Record<string, T> = {};
+  for (const [key, value] of Object.entries(original)) {
+    const mappedKey = canonicalToUser[key] ?? key;
+    remapped[mappedKey] = value;
+  }
+  return remapped;
+}

package/src/impl-address.ts

@@ -20,13 +20,18 @@ export class InvalidBeacon extends UpgradesError {}
  * @throws {InvalidBeacon} If the implementation() function could not be called or does not return an address.
  */
 export async function getImplementationAddressFromBeacon(
-  provider: EthereumProvider,
+  provider: EthereumProvider, // v2 may differ from v3
   beaconAddress: string,
 ): Promise<string> {
   const impl = await callOptionalSignature(provider, beaconAddress, 'implementation()');
+
   let parsedImplAddress;
   if (impl !== undefined) {
-    parsedImplAddress = parseAddress(impl);
+    try {
+      parsedImplAddress = parseAddress(impl);
+    } catch (parseErr) {
+      throw new InvalidBeacon(`Contract at ${beaconAddress} doesn't look like a beacon`);
+    }
   }
 
   if (parsedImplAddress === undefined) {