Use @nomiclabs/hardhat-etherscan for Etherscan verification #125

michalinacienciala · 2022-09-19T13:20:07Z

@nomiclabs/hardhat-etherscan exposes verification functions for Etherscan that
are recommended by the hardhat team.

See https://hardhat.org/hardhat-runner/plugins/nomiclabs-hardhat-etherscan

Previously we were using etherscan-verify from hardhat-deploy plugin, which
had problems with verification of some contracts.

Apart from this change we also do a cleanup of supported testnets - we remove
configuration related to Ropsten and Rinkeby testnets, as they're
going to be deprecated soon and we've transitioned to using Goerli testnet.

@nomiclabs/hardhat-etherscan exposes verification functions for Etherscan that are recommended by the hardhat team. See https://hardhat.org/hardhat-runner/plugins/nomiclabs-hardhat-etherscan Previously we were using `etherscan-verify` from `hardhat-deploy` plugin, which had problems with verification of some contracts. Note: We introduce temporary changes helping with testing of the new verification method. They will be removed before merge to `main`.

Previously used `0.9.29` version was causing conflicts with the `@nomiclabs/hardhat-etherscan` plugin (`Property 'etherscan' must be of type 'EtherscanUserConfig', but here has type '{ apiKey?: string; }'` during `npm pubish`). According to wighawag/hardhat-deploy#257 upgrading `hardhat-deploy` to version `0.10.0` or higher should fix the issue.

Without it, deployment/verification was throwing following message: ``` Verifying contract 0x... on Etherscan... Nothing to compile NomicLabsHardhatPluginError: More than one contract was found to match the deployed bytecode. Please use the contract parameter with one of the following contracts: * contracts/governance/BaseTokenholderGovernor.sol:BaseTokenholderGovernor * contracts/governance/TokenholderGovernor.sol:TokenholderGovernor * contracts/test/TestGovernorTestSet.sol:TestTokenholderGovernor For example: hardhat verify --contract contracts/Example.sol:ExampleContract <other args> If you are running the verify subtask from within Hardhat instead: await run("verify:verify", { <other args>, contract: "contracts/Example.sol:ExampleContract" }; ```

Without the change, the deployment/verification was logging: ``` Verifying contract 0x... on Etherscan... Nothing to compile NomicLabsHardhatPluginError: Failed to send contract verification request. Endpoint URL: https://api-goerli.etherscan.io/api Reason: The Etherscan API responded that the address 0x... does not have bytecode. This can happen if the contract was recently deployed and this fact hasn't propagated to the backend yet. Try waiting for a minute before verifying your contract. If you are invoking this from a script, try to wait for five confirmations of your contract deployment transaction before running the verification subtask. ```

Both testnets are soon to be deprecated (https://blog.ethereum.org/2022/06/21/testnet-deprecation). We've transisioned to using Goerli testnet instead and we no longer need to have any code relating to Ropsten/Rinkeby.

michalinacienciala · 2022-09-19T13:20:47Z

Workflow dry-runned here: https://github.com/threshold-network/solidity-contracts/actions/runs/3081781328/jobs/4981728262.

cygnusv · 2022-09-19T13:38:44Z

FWIW, I've had issues with v3.1.0 in this project (see commit bf90cd5), so I had to pin 3.0.4.

michalinacienciala · 2022-09-19T13:47:27Z

FWIW, I've had issues with v3.1.0 in this project (see commit bf90cd5), so I had to pin 3.0.4.

Do you remember what kind of issues was it, @cygnusv? Some problem with deploy/verification? I was able to deploy and verify contracts without issues...

cygnusv · 2022-09-19T15:43:13Z

Thank goodness I never close my console tabs. Found it:

david@Davids-MacBook-Pro solidity-contracts % npx hardhat verify --network mainnet 0x57E1a87603bD1960D734243f8b2f5133911E009D 0xCdF7028ceAB81fA0C6971208e83fa7872994beE5 0x1293a54e160D1cd7075487898d65266081A15458 0xbbD3C0C794F40c4f993B03F65343aCC6fcfCb2e2 0xE47c80e8c23f6B4A1aE41c34837a0599D5D16bb0 0x1CCA7E410eE41739792eA0A24e00349Dd247680e 0x10DE37cF84202A20cae61069C617B3Aa874aF8b4
An unexpected error occurred:

TypeError: customChains is not iterable
    at getEtherscanEndpoints (/Users/david/dev/t/solidity-contracts/node_modules/@nomiclabs/hardhat-etherscan/src/network/prober.ts:33:37)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async Environment.run (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:131:14)
    at async SimpleTaskDefinition.verifySubtask [as action] (/Users/david/dev/t/solidity-contracts/node_modules/@nomiclabs/hardhat-etherscan/src/index.ts:209:30)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async Environment.run (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:131:14)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async hardhatVerify (/Users/david/dev/t/solidity-contracts/node_modules/@openzeppelin/hardhat-upgrades/src/verify-proxy.ts:110:12)
    at async OverriddenTaskDefinition._action (/Users/david/dev/t/solidity-contracts/node_modules/@openzeppelin/hardhat-upgrades/src/index.ts:155:12)

Higher version (^3.1.0) reportedly causes problems with etherscan verification on Mainnet (`TypeError: customChains is not iterable`). See commit bf90cd5.

michalinacienciala · 2022-09-20T10:11:16Z

Thank goodness I never close my console tabs. Found it:

david@Davids-MacBook-Pro solidity-contracts % npx hardhat verify --network mainnet 0x57E1a87603bD1960D734243f8b2f5133911E009D 0xCdF7028ceAB81fA0C6971208e83fa7872994beE5 0x1293a54e160D1cd7075487898d65266081A15458 0xbbD3C0C794F40c4f993B03F65343aCC6fcfCb2e2 0xE47c80e8c23f6B4A1aE41c34837a0599D5D16bb0 0x1CCA7E410eE41739792eA0A24e00349Dd247680e 0x10DE37cF84202A20cae61069C617B3Aa874aF8b4
An unexpected error occurred:

TypeError: customChains is not iterable
    at getEtherscanEndpoints (/Users/david/dev/t/solidity-contracts/node_modules/@nomiclabs/hardhat-etherscan/src/network/prober.ts:33:37)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async Environment.run (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:131:14)
    at async SimpleTaskDefinition.verifySubtask [as action] (/Users/david/dev/t/solidity-contracts/node_modules/@nomiclabs/hardhat-etherscan/src/index.ts:209:30)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async Environment.run (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:131:14)
    at async Environment._runTaskDefinition (/Users/david/dev/t/solidity-contracts/node_modules/hardhat/src/internal/core/runtime-environment.ts:219:14)
    at async hardhatVerify (/Users/david/dev/t/solidity-contracts/node_modules/@openzeppelin/hardhat-upgrades/src/verify-proxy.ts:110:12)
    at async OverriddenTaskDefinition._action (/Users/david/dev/t/solidity-contracts/node_modules/@openzeppelin/hardhat-upgrades/src/index.ts:155:12)

@cygnusv, I had a bit similar-sounding issue (TypeError: undefined is not iterable (cannot read property Symbol(Symbol.iterator))) before I upgraded hardhat-deploy to 0.11.15.
Just to be safe, I downgraded the @nomiclabs/hardhat-etherscan to 3.0.4.

cygnusv · 2022-09-20T10:37:11Z

deploy/31_deploy_tokenholder_governor.ts

+    await hre.ethers.provider.waitForTransaction(
+      timelock.transactionHash,
+      5,
+      300000


I understand the occasional need for this, but there's nothing inherent to TokenholderGovernor that requires an extra waiting time. It can happen to other deployments with some small probability. Can we instead add this to all Etherscan verification calls? Ideally, we can introduce it as part of a helper function.

michalinacienciala · 2022-09-22T09:44:27Z

Before I do any further changes, I want to wait for the fix of the problem with failing unit tests which is introduced by upgrading hardhat-deploy dependency. PR for that: #126.

Without the change, the verification of contracts on Etherscan could sometimes fail with error like this: ``` Verifying contract 0x... on Etherscan... Nothing to compile NomicLabsHardhatPluginError: Failed to send contract verification request. Endpoint URL: https://api-goerli.etherscan.io/api Reason: The Etherscan API responded that the address 0x... does not have bytecode. This can happen if the contract was recently deployed and this fact hasn't propagated to the backend yet. Try waiting for a minute before verifying your contract. If you are invoking this from a script, try to wait for five confirmations of your contract depiloyment transaction before running the verification subtask. ```

In PR #126 (#126) we've upgraded the `hardhat-deploy` plugin to latest version (^0.11.15). As part of this change, the way of storing Etherscan API key has changed - to be different from how the key is stored for @nomiclabs/hardhat-etherscan plugin use. When we merged those changes from `main` to the current feature branch, we no longer had a correct format of the Etherscan API key config to use it with the `@nomiclabs/hardhat-etherscan` plugin. As we don't want to verify contracts using `hardhat-deploy` plugin anymore, we need to adjust the config to fit `@nomiclabs/hardhat-etherscan`'s syntax.

michalinacienciala · 2022-10-07T14:35:38Z

Workflow verified in run: https://github.com/threshold-network/solidity-contracts/actions/runs/3205279132/jobs/5237683036.

nkuba · 2022-10-07T21:01:34Z

deploy/01_deploy_t.ts

  const { deployer } = await getNamedAccounts()

  const T = await deployments.deploy("T", {
    from: deployer,
    log: true,
  })

+  if (hre.network.tags.etherscan) {
+    await hre.ethers.provider.waitForTransaction(T.transactionHash, 5, 300000)


Could we try using waitForConfirmations as we did in https://github.com/keep-network/keep-core/blob/4049dc0153c33c3c4cbb2e9a1808581bf76144fb/solidity/random-beacon/deploy/01_deploy_reimbursement_pool.ts#L15?

I tried to use waitForConfirmations: 1 and waitForConfirmations: 5, but nome of the options was good:

waitForConfirmations: 5 was causing hanging of the deploy function when executed on the hardhat network (see waitConfirmations > 1 on hardhat network stalls deployment wighawag/hardhat-deploy#304)

waitForConfirmations: 1 was not enough, the deploy of TokenholderGovernor was failing.

The force-pushes seen below were a result of me going back to the original solution (i.e. using hre.ethers.provider.waitForTransaction).

The Görli testnet currently used by Threshold/Keep for development purposes is planned to become deprecated with the end of year 2023. The testnet that was created to replace it is called [Holešky](https://github.com/eth-clients/holesky), however it will take some time until it gets integrated with by some of the projects we rely on. As a solution, we decided to switch first to another testnet that is currently live - Sepolia. This testnet's EOL is planned for 2026, which gives us plenty of time to move to Holešky before Sepolia gets deprecated. Until Görli is not dead we want to support both testnets, which is what we did in some of the projects already. In `coverage-pools` however we were missing some Görli configuration. So for now, for consistency between projects, we've added the missing part for Görli support and also added full support of Sepolia testnet. Some other changes: - we've removed the `contracts-etherscan-verification` job from CI (it was needed when `hardhat-deploy` was used to verify contracts, but in threshold-network/solidity-contracts#125 we switched to using `@nomiclabs/hardhat-etherscan` plugin - we've updated the versions of some of the actions used in our CI, as the previously set versions were running on `node14` which will be no longer supported by GH at some point in the future

michalinacienciala added 6 commits September 19, 2022 10:26

Remove temporary config

e3ba353

No longer support Ropsten and Rinkeby testnets

8b16cac

Both testnets are soon to be deprecated (https://blog.ethereum.org/2022/06/21/testnet-deprecation). We've transisioned to using Goerli testnet instead and we no longer need to have any code relating to Ropsten/Rinkeby.

Use fixed 3.0.4 version of @nomiclabs/hardhat-etherscan dependency

ca8a08b

Higher version (^3.1.0) reportedly causes problems with etherscan verification on Mainnet (`TypeError: customChains is not iterable`). See commit bf90cd5.

michalinacienciala marked this pull request as draft September 20, 2022 10:17

cygnusv reviewed Sep 20, 2022

View reviewed changes

michalinacienciala added 3 commits September 27, 2022 15:53

Merge remote-tracking branch 'origin/main' into etherscan-verification

8ec6cc0

michalinacienciala force-pushed the etherscan-verification branch from 5203c81 to c12c494 Compare October 7, 2022 14:31

michalinacienciala added 2 commits October 7, 2022 16:32

Merge remote-tracking branch 'origin/main' into etherscan-verification

592191e

Fix formatting

e565fbf

michalinacienciala marked this pull request as ready for review October 7, 2022 14:35

michalinacienciala requested review from nkuba and cygnusv October 7, 2022 14:36

nkuba requested changes Oct 7, 2022

View reviewed changes

michalinacienciala marked this pull request as draft October 10, 2022 06:56

michalinacienciala force-pushed the etherscan-verification branch 2 times, most recently from 2957914 to e565fbf Compare October 12, 2022 13:13

michalinacienciala marked this pull request as ready for review October 12, 2022 13:18

michalinacienciala requested a review from nkuba October 12, 2022 13:18

michalinacienciala mentioned this pull request Oct 18, 2023

Support deployment on Sepolia keep-network/coverage-pools#235

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use @nomiclabs/hardhat-etherscan for Etherscan verification #125

Use @nomiclabs/hardhat-etherscan for Etherscan verification #125

michalinacienciala commented Sep 19, 2022

michalinacienciala commented Sep 19, 2022

cygnusv commented Sep 19, 2022

michalinacienciala commented Sep 19, 2022

cygnusv commented Sep 19, 2022

michalinacienciala commented Sep 20, 2022

cygnusv Sep 20, 2022

michalinacienciala commented Sep 22, 2022

michalinacienciala commented Oct 7, 2022

nkuba Oct 7, 2022

michalinacienciala Oct 12, 2022 •

edited

Loading

Use @nomiclabs/hardhat-etherscan for Etherscan verification #125

Are you sure you want to change the base?

Use @nomiclabs/hardhat-etherscan for Etherscan verification #125

Conversation

michalinacienciala commented Sep 19, 2022

michalinacienciala commented Sep 19, 2022

cygnusv commented Sep 19, 2022

michalinacienciala commented Sep 19, 2022

cygnusv commented Sep 19, 2022

michalinacienciala commented Sep 20, 2022

cygnusv Sep 20, 2022

Choose a reason for hiding this comment

michalinacienciala commented Sep 22, 2022

michalinacienciala commented Oct 7, 2022

nkuba Oct 7, 2022

Choose a reason for hiding this comment

michalinacienciala Oct 12, 2022 • edited Loading

Choose a reason for hiding this comment

michalinacienciala Oct 12, 2022 •

edited

Loading