Merge pull request #4693 from NomicFoundation/sourcify-options

hardhat-verify: add apiUrl and browserUrl in sourcify options

Author: schaable

.changeset/bright-plums-watch.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/hardhat-verify": patch
+---
+
+Add apiUrl and browserUrl to Sourcify configuration.

packages/hardhat-verify/README.md

@@ -186,6 +186,10 @@ To verify a contract using Sourcify, you need to add to your Hardhat config:
 ```js
 sourcify: {
   enabled: true,
+  // Optional: specify a different Sourcify server
+  apiUrl: "https://sourcify.dev/server",
+  // Optional: specify a different Sourcify repository
+  browserUrl: "https://repo.sourcify.dev",
 }
 ```
 
@@ -285,7 +289,11 @@ Both Etherscan and Sourcify classes can be imported from the plugin for direct u
   ```js
   import { Sourcify } from "@nomicfoundation/hardhat-verify/sourcify";
 
-  const instance = new Sourcify(1); // Set chainId
+  const instance = new Sourcify(
+    1,
+    "https://sourcify.dev/server",
+    "https://repo.sourcify.dev"
+  ); // Set chainId
 
   if (!instance.isVerified("0x123abc...")) {
     const sourcifyResponse = await instance.verify("0x123abc...", {

packages/hardhat-verify/src/internal/config.ts

@@ -37,6 +37,8 @@ export function sourcifyConfigExtender(
 ): void {
   const defaultSourcifyConfig: SourcifyConfig = {
     enabled: false,
+    apiUrl: "https://sourcify.dev/server",
+    browserUrl: "https://repo.sourcify.dev",
   };
   const cloneDeep = require("lodash.clonedeep") as typeof LodashCloneDeepT;
   const userSourcifyConfig = cloneDeep(userConfig.sourcify);

packages/hardhat-verify/src/internal/sourcify.ts

@@ -12,10 +12,11 @@ import { ContractStatus } from "./sourcify.types";
 import { ValidationResponse } from "./utilities";
 
 export class Sourcify {
-  public apiUrl: string = "https://sourcify.dev/server";
-  public browserUrl: string = "https://repo.sourcify.dev";
-
-  constructor(public chainId: number) {}
+  constructor(
+    public chainId: number,
+    public apiUrl: string,
+    public browserUrl: string
+  ) {}
 
   // https://sourcify.dev/server/api-docs/#/Repository/get_check_all_by_addresses
   public async isVerified(address: string) {

packages/hardhat-verify/src/internal/tasks/sourcify.ts

@@ -14,6 +14,7 @@ import {
   CompilerVersionsMismatchError,
   ContractVerificationFailedError,
   HardhatNetworkNotSupportedError,
+  HardhatVerifyError,
   InvalidAddressError,
   InvalidContractNameError,
   MissingAddressError,
@@ -67,7 +68,17 @@ subtask(TASK_VERIFY_SOURCIFY)
       16
     );
 
-    const sourcify = new Sourcify(currentChainId);
+    const { apiUrl, browserUrl } = config.sourcify;
+
+    if (apiUrl === undefined) {
+      throw new HardhatVerifyError("Sourcify `apiUrl` is not defined");
+    }
+
+    if (browserUrl === undefined) {
+      throw new HardhatVerifyError("Sourcify `browserUrl` is not defined");
+    }
+
+    const sourcify = new Sourcify(currentChainId, apiUrl, browserUrl);
 
     const status = await sourcify.isVerified(address);
     if (status !== false) {

packages/hardhat-verify/src/types.ts

@@ -15,6 +15,8 @@ export interface EtherscanConfig {
 
 export interface SourcifyConfig {
   enabled: boolean;
+  apiUrl?: string;
+  browserUrl?: string;
 }
 
 export type ApiKey = string | Record<string, string>;

packages/hardhat-verify/test/unit/config.ts

@@ -168,6 +168,8 @@ describe("Extend config", () => {
       const userConfig: HardhatUserConfig = {};
       const expected: SourcifyConfig = {
         enabled: false,
+        apiUrl: "https://sourcify.dev/server",
+        browserUrl: "https://repo.sourcify.dev",
       };
       sourcifyConfigExtender(hardhatConfig, userConfig);
 

packages/hardhat-verify/test/unit/sourcify.ts

@@ -9,7 +9,11 @@ describe("Sourcify", () => {
     it("should return the contract url", () => {
       const expectedContractAddress =
         "https://repo.sourcify.dev/contracts/full_match/100/0xC4c622862a8F548997699bE24EA4bc504e5cA865/";
-      const sourcify = new Sourcify(chainId);
+      const sourcify = new Sourcify(
+        chainId,
+        "https://sourcify.dev/server",
+        "https://repo.sourcify.dev"
+      );
       const contractUrl = sourcify.getContractUrl(
         "0xC4c622862a8F548997699bE24EA4bc504e5cA865",
         ContractStatus.PERFECT