Merge pull request #6937 from NomicFoundation/verify-config-update

feat: enable providers by default and throw if apiKey is empty

Author: kanej

.changeset/wild-boats-study.md

@@ -0,0 +1,7 @@
+---
+"@nomicfoundation/hardhat-errors": patch
+"@nomicfoundation/hardhat-verify": patch
+"hardhat": patch
+---
+
+Enable verification providers by default and throw if Etherscan apiKey is empty ([#6937](https://github.com/NomicFoundation/hardhat/pull/6937))

v-next/hardhat-errors/src/descriptors.ts

@@ -2620,6 +2620,17 @@ chainDescriptors: {
         websiteDescription: `The block explorer responded that the address does not contain a contract. This usually means the address is incorrect, the contract was not deployed on the selected network, or there is a temporary issue with the block explorer not updating its index.
 Please verify the address and network, and try again later if necessary.`,
       },
+      EXPLORER_API_KEY_EMPTY: {
+        number: 80030,
+        messageTemplate: `The {verificationProvider} API key is empty.`,
+        websiteTitle: "Block explorer API key is empty",
+        websiteDescription: `The provided API key for the block explorer is empty. This can happen in the following cases:
+- No "apiKey" field is configured in the hardhat config.
+- The "apiKey" is explicitly set to an empty string in the Hardhat config.
+- The "apiKey" is assigned to a config variable that resolves to an empty string at runtime.
+
+To resolve this, set a valid non-empty API key in your Hardhat config, then try again.`,
+      },
     },
     VALIDATION: {
       INVALID_ADDRESS: {

v-next/hardhat-verify/src/internal/etherscan.ts

@@ -53,12 +53,21 @@ export class Etherscan implements VerificationProvider {
     this.name = etherscanConfig.name ?? "Etherscan";
     this.url = etherscanConfig.url;
     this.apiUrl = ETHERSCAN_API_URL;
-    this.apiKey = etherscanConfig.apiKey;
     this.#dispatcher = etherscanConfig.dispatcher;
     this.#pollingIntervalMs =
       etherscanConfig.dispatcher !== undefined
         ? 0
         : VERIFICATION_STATUS_POLLING_SECONDS;
+
+    if (etherscanConfig.apiKey === "") {
+      throw new HardhatError(
+        HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_API_KEY_EMPTY,
+        {
+          verificationProvider: this.name,
+        },
+      );
+    }
+    this.apiKey = etherscanConfig.apiKey;
   }
 
   public getContractUrl(address: string) {

v-next/hardhat-verify/src/internal/hook-handlers/config.ts

@@ -72,7 +72,7 @@ export async function resolveUserConfig(
 
 function resolveBlockscoutConfig(
   blockscoutConfig: BlockscoutUserConfig | undefined = {
-    enabled: false,
+    enabled: true,
   },
 ): BlockscoutConfig {
   return {
@@ -83,7 +83,7 @@ function resolveBlockscoutConfig(
 function resolveEtherscanConfig(
   etherscanConfig: EtherscanUserConfig | undefined = {
     apiKey: "",
-    enabled: false,
+    enabled: true,
   },
   resolveConfigurationVariable: ConfigurationVariableResolver,
 ): EtherscanConfig {

v-next/hardhat-verify/test/etherscan.ts

@@ -3,7 +3,10 @@ import querystring from "node:querystring";
 import { beforeEach, describe, it } from "node:test";
 
 import { HardhatError } from "@nomicfoundation/hardhat-errors";
-import { assertRejectsWithHardhatError } from "@nomicfoundation/hardhat-test-utils";
+import {
+  assertRejectsWithHardhatError,
+  assertThrowsHardhatError,
+} from "@nomicfoundation/hardhat-test-utils";
 
 import { Etherscan, ETHERSCAN_API_URL } from "../src/internal/etherscan.js";
 
@@ -44,6 +47,20 @@ describe("etherscan", () => {
 
         assert.equal(etherscan.name, "Etherscan");
       });
+
+      it("should throw an error if the apiKey is empty", () => {
+        assertThrowsHardhatError(
+          () =>
+            new Etherscan({
+              ...etherscanConfig,
+              apiKey: "",
+            }),
+          HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_API_KEY_EMPTY,
+          {
+            verificationProvider: etherscanConfig.name,
+          },
+        );
+      });
     });
 
     describe("getContractUrl", () => {

v-next/hardhat-verify/test/hook-handlers/config.ts

@@ -264,11 +264,11 @@ describe("hook-handlers/config", () => {
 
       assert.deepEqual(resolvedConfig.verify, {
         blockscout: {
-          enabled: false,
+          enabled: true,
         },
         etherscan: {
           apiKey: new MockResolvedConfigurationVariable(""),
-          enabled: false,
+          enabled: true,
         },
       });
     });