Enforce contract verification

[rimrakhimov]

• Because this PR includes a bug fix, relevant tests have been included.
• Because this PR includes a new feature, the change was previously discussed on an Issue or with someone from the team.
• I didn't do anything of this.

---

That PR adds the --force verification flag described in #5122, which allows the re-verification of already verified contracts (for blockscout-based explorers).

Notice that sometimes, an underlying explorer may return an error saying that the contract has already been verified. For blockscout-based explorers that happens if the contract is already verified with a full match, while for etherscan that is the only possible option for verified contracts. The PR considers those cases as errors and fails with a corresponding error message. I don't know if that is what is expected, though.

Also I plan to add some test cases, but would be glad to get some suggestions to start with

[changeset-bot]

🦋 Changeset detected

Latest commit: 425dbf4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@nomicfoundation/hardhat-verify	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 8, 2024 10:26pm

[schaable]

Hi @rimrakhimov, the code looks good. I've updated the error message to include the contract FQN, as other error messages also do this. I'll do some manual testing tomorrow. Regarding adding tests, you could add some integration tests by mocking the block explorer's response in packages/hardhat-verify/test/integration/index.ts. I suggest adding a test where etherscan.isVerified is mocked to return true and includes the --force flag, and another test that throws the ContractAlreadyVerifiedError exception.

[rimrakhimov]

Hi, @schaable, thank you for the feedback. I added some test cases as you'd suggested. Also, found a bug in the implementation as etherscan returns different "already verified" messages depending on whether the contract has been actually verified by some user (e.g., 0x7b45A6d08F26ecAD9422fb85FbCAb1a0fec806CB), or has been automatically found verified contract with the same deployed bytecode (e.g., 0x9498322CB2193Bc906d2dF94D7C04A17A59790C8)

[schaable]

Manual testing:

• Unverified contract:
  • Without --force: contract verified.
  • With --force: contract verified.
• Verified contract (full match):
  • Without --force: return with message The contract ${address} has already been verified on the block explorer.
  • With --force: throw ContractAlreadyVerifiedError error.
• Verified contract (partial match - only Blockscout):
  • Without --force: return with message The contract ${address} has already been verified on the block explorer.
  • With --force: contract verified.