Merge pull request #6995 from NomicFoundation/ignition/verify-v3

Re-enable verification for Hardhat Ignition

Author: kanej

.changeset/breezy-jars-dress.md

@@ -0,0 +1,7 @@
+---
+"@nomicfoundation/ignition-core": patch
+"@nomicfoundation/hardhat-ignition": patch
+"@nomicfoundation/hardhat-verify": patch
+---
+
+Add `--verify` option for Ignition deploy task to verify all contracts of a deployment on Etherscan ([#6817](https://github.com/NomicFoundation/hardhat/issues/6817))

pnpm-lock.yaml

@@ -1,3 +1,5 @@
+import { SolidityParameterType } from "./module.js";
+
 /**
  * The configuration info needed to verify a contract on Etherscan on a given chain.
  *
@@ -32,19 +34,17 @@ export interface SourceToLibraryToAddress {
  */
 export interface VerifyInfo {
   address: string;
-  compilerVersion: string;
-  sourceCode: string;
-  name: string;
-  args: string;
+  constructorArgs: SolidityParameterType[];
+  libraries: Record<string, string>;
+  contract: string;
 }
 
 /**
  * The result of requesting the verification info for a deployment.
- * It returns the chainConfig followed by an array of VerifyInfo objects, one for each contract to be verified.
- * Alternatively, it returns null and the contract name if the contract used external artifacts that could not be resolved for verification.
+ * It returns a VerifyInfo object for each contract to be verified.
+ * Alternatively, it returns the contract name if the contract used
+ * external artifacts that could not be resolved for verification.
  *
  * @beta
  */
-export type VerifyResult =
-  | [ChainConfig, VerifyInfo]
-  | [_null: null, name: string];
+export type VerifyResult = VerifyInfo | string;

v-next/hardhat-ignition-core/src/types/verify.ts

@@ -1,22 +1,11 @@
-import type { DeploymentState } from "./internal/execution/types/deployment-state.js";
 import type { DeploymentExecutionState } from "./internal/execution/types/execution-state.js";
-import type { Artifact, BuildInfo, CompilerInput } from "./types/artifact.js";
-import type {
-  ChainConfig,
-  SourceToLibraryToAddress,
-  VerifyInfo,
-  VerifyResult,
-} from "./types/verify.js";
-
-import path from "node:path";
+import type { Artifact } from "./types/artifact.js";
+import type { VerifyInfo, VerifyResult } from "./types/verify.js";
 
 import { HardhatError } from "@nomicfoundation/hardhat-errors";
 import { FileNotFoundError } from "@nomicfoundation/hardhat-utils/fs";
-import { analyze } from "@nomicfoundation/solidity-analyzer";
 
-import { builtinChains } from "./internal/chain-config.js";
 import { FileDeploymentLoader } from "./internal/deployment-loader/file-deployment-loader.js";
-import { encodeDeploymentArguments } from "./internal/execution/abi.js";
 import { loadDeploymentState } from "./internal/execution/deployment-state-helpers.js";
 import { ExecutionResultType } from "./internal/execution/types/execution-result.js";
 import {
@@ -30,14 +19,11 @@ import { findExecutionStatesByType } from "./internal/views/find-execution-state
  * Retrieve the information required to verify all contracts from a deployment on Etherscan.
  *
  * @param deploymentDir - the file directory of the deployment
- * @param customChains - an array of custom chain configurations
  *
  * @beta
  */
 export async function* getVerificationInformation(
   deploymentDir: string,
-  customChains: ChainConfig[] = [],
-  includeUnrelatedContracts = false,
 ): AsyncGenerator<VerifyResult> {
   const deploymentLoader = new FileDeploymentLoader(deploymentDir);
 
@@ -52,8 +38,6 @@ export async function* getVerificationInformation(
     );
   }
 
-  const chainConfig = resolveChainConfig(deploymentState, customChains);
-
   const deploymentExStates = findExecutionStatesByType(
     ExecutionSateType.DEPLOYMENT_EXECUTION_STATE,
     deploymentState,
@@ -72,85 +56,25 @@ export async function* getVerificationInformation(
     const verifyInfo = await convertExStateToVerifyInfo(
       exState,
       deploymentLoader,
-      includeUnrelatedContracts,
     );
 
     if (typeof verifyInfo === "string") {
-      yield [null, verifyInfo];
+      yield verifyInfo;
       continue;
     }
 
-    const verifyResult: VerifyResult = [chainConfig, verifyInfo];
-
-    yield verifyResult;
-  }
-}
-
-function resolveChainConfig(
-  deploymentState: DeploymentState,
-  customChains: ChainConfig[],
-) {
-  // implementation note:
-  // if a user has set a custom chain with the same chainId as a builtin chain,
-  // the custom chain will be used instead of the builtin chain
-  const chainConfig = [...customChains, ...builtinChains].find(
-    (c) => c.chainId === deploymentState.chainId,
-  );
-
-  if (chainConfig === undefined) {
-    throw new HardhatError(
-      HardhatError.ERRORS.IGNITION.VERIFY.UNSUPPORTED_CHAIN,
-      {
-        chainId: deploymentState.chainId,
-      },
-    );
-  }
-
-  return chainConfig;
-}
-
-export function getImportSourceNames(
-  sourceName: string,
-  buildInfo: BuildInfo,
-  visited: Record<string, boolean> = {},
-): string[] {
-  if (visited[sourceName]) {
-    return [];
+    yield verifyInfo;
   }
-
-  visited[sourceName] = true;
-
-  const contractSource = buildInfo.input.sources[sourceName].content;
-  const { imports } = analyze(contractSource);
-
-  const importSources = imports.map((i) => {
-    if (/^\.\.?[\/|\\]/.test(i)) {
-      return path.join(path.dirname(sourceName), i).replaceAll("\\", "/");
-    }
-
-    return i;
-  });
-
-  return [
-    ...importSources,
-    ...importSources.flatMap((i) =>
-      getImportSourceNames(i, buildInfo, visited),
-    ),
-  ];
 }
 
 async function convertExStateToVerifyInfo(
   exState: DeploymentExecutionState,
   deploymentLoader: FileDeploymentLoader,
-  includeUnrelatedContracts: boolean = false,
 ): Promise<VerifyInfo | string> {
-  let result: [BuildInfo, Artifact];
+  let artifact: Artifact;
 
   try {
-    result = await Promise.all([
-      deploymentLoader.readBuildInfo(exState.artifactId),
-      deploymentLoader.loadArtifact(exState.artifactId),
-    ]);
+    artifact = await deploymentLoader.loadArtifact(exState.artifactId);
   } catch (e) {
     assertIgnitionInvariant(
       e instanceof FileNotFoundError,
@@ -164,8 +88,6 @@ async function convertExStateToVerifyInfo(
     return exState.artifactId;
   }
 
-  const [buildInfo, artifact] = result;
-
   const { contractName, constructorArgs, libraries } = exState;
 
   assertIgnitionInvariant(
@@ -174,78 +96,12 @@ async function convertExStateToVerifyInfo(
     `Deployment execution state ${exState.id} should have a successful result to retrieve address`,
   );
 
-  const sourceCode = prepareInputBasedOn(buildInfo, artifact, libraries);
-
-  if (!includeUnrelatedContracts) {
-    const sourceNames = [
-      artifact.sourceName,
-      ...getImportSourceNames(artifact.sourceName, buildInfo),
-    ];
-
-    for (const source of Object.keys(sourceCode.sources)) {
-      if (!sourceNames.includes(source)) {
-        delete sourceCode.sources[source];
-      }
-    }
-  }
-
-  const verifyInfo = {
+  const verifyInfo: VerifyInfo = {
+    constructorArgs,
+    libraries,
     address: exState.result.address,
-    compilerVersion: buildInfo.solcLongVersion.startsWith("v")
-      ? buildInfo.solcLongVersion
-      : `v${buildInfo.solcLongVersion}`,
-    sourceCode: JSON.stringify(sourceCode),
-    name: `${artifact.sourceName}:${contractName}`,
-    args: encodeDeploymentArguments(artifact, constructorArgs),
+    contract: `${artifact.sourceName}:${contractName}`,
   };
 
   return verifyInfo;
 }
-
-function prepareInputBasedOn(
-  buildInfo: BuildInfo,
-  artifact: Artifact,
-  libraries: Record<string, string>,
-): CompilerInput {
-  const sourceToLibraryAddresses = resolveLibraryInfoForArtifact(
-    artifact,
-    libraries,
-  );
-
-  if (sourceToLibraryAddresses === null) {
-    return buildInfo.input;
-  }
-
-  const { input } = buildInfo;
-  input.settings.libraries = sourceToLibraryAddresses;
-
-  return input;
-}
-
-function resolveLibraryInfoForArtifact(
-  artifact: Artifact,
-  libraries: Record<string, string>,
-): SourceToLibraryToAddress | null {
-  const sourceToLibraryToAddress: SourceToLibraryToAddress = {};
-
-  for (const [sourceName, refObj] of Object.entries(artifact.linkReferences)) {
-    for (const [libName] of Object.entries(refObj)) {
-      sourceToLibraryToAddress[sourceName] ??= {};
-
-      const libraryAddress = libraries[libName];
-
-      assertIgnitionInvariant(
-        libraryAddress !== undefined,
-        `Could not find address for library ${libName}`,
-      );
-
-      sourceToLibraryToAddress[sourceName][libName] = libraryAddress;
-    }
-  }
-
-  if (Object.entries(sourceToLibraryToAddress).length === 0) {
-    return null;
-  }
-
-  return sourceToLibraryToAddress;
-}