Verify proxy/implementation on etherscan

DEPLOYMENT_CHECKLIST.md

@@ -55,6 +55,7 @@ To deploy run `yarn deploy --network NETWORK` in `packages/contracts` and replac
 - [ ] Go to the blockchain explorer and verify that each address is verified
   - [ ] If it is not try to verfiy it with `npx hardhat verify --network NETWORK ADDRESS CONTRUCTOR-ARGS`. More infos on how to use this command can be found here: [https://hardhat.org/hardhat-runner/docs/guides/verifying](https://hardhat.org/hardhat-runner/docs/guides/verifying)
   - [ ] If it is a proxy try to activate the blockchain explorer's proxy feature
+    - [ ] Try running `yarn verifyProxies --network <network>` to automate this
   - [ ] If the proxies are not verified with the `Similar Match Source Code` feature
     - [ ] Verify one of the proxies
     - [ ] Check if the other proxies are now verified with `Similar Match Source Code`

UPDATE_CHECKLIST.md

@@ -65,6 +65,7 @@ If the deployer **is** allowed to create a proposal
 - [ ] Go to the blockchain explorer and verify that each address is verified
   - [ ] If it is not try to verfiy it with `npx hardhat verify --network NETWORK ADDRESS CONTRUCTOR-ARGS`. More infos on how to use this command can be found here: [https://hardhat.org/hardhat-runner/docs/guides/verifying](https://hardhat.org/hardhat-runner/docs/guides/verifying)
   - [ ] If it is a proxy try to activate the blockchain explorer's proxy feature
+    - [ ] Try running `yarn verifyProxies --network <network>` to automate this
   - [ ] If the proxies are not verified with the `Similar Match Source Code` feature
     - [ ] Remove `import '@openzeppelin/hardhat-upgrades'` from `packages/contracts/hardhat.config.ts`
     - [ ] Verify one of the proxies

packages/contracts/README.md

@@ -58,19 +58,15 @@ Please do not use the issue tracker for security issues.
 
 ## Etherscan verification
 
-To try out Etherscan verification, you first need to deploy a contract to an Ethereum testnet that's supported by Etherscan, such as [goerli](https://goerli.etherscan.io) or [sepolia](https://sepolia.etherscan.io).
+Verification of contracts is currently handled by the etherscan verify plugin, invoked as a hardhat deploy stage. Contracts are bound to the HRE during deployment and then used as part of verification.
 
-In this project, copy the `.env.example` file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Goerli node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:
+Make sure you have your Etherscan key setup in the HH config before running the deploy script.
 
-```shell
-hardhat run --network goerli scripts/sample-script.ts
-```
+### Proxy Verification
 
-Then, copy the deployment address and paste it in to replace `DEPLOYED_CONTRACT_ADDRESS` in this command:
+To avoid having to manually set 'Is this a Proxy?' in etherscan, you may call the Proxy Verification script, once your contracts have been verified. To do this run: `yarn verifyProxies --network <network>`.
 
-```shell
-npx hardhat verify --network goerli DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"
-```
+This can be run multiple times provided you haven't used the `--reset` flag to clear the deployment data. The etherscan API can be a little flaky at times so be patient with it and try multiple times if necessary.
 
 ## Testing with Previous Contract Versions
 

packages/contracts/deploy/verification/99_conclude/10_verify-contracts.ts

@@ -27,7 +27,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   }
 };
 export default func;
-func.tags = ['New', 'Verify'];
+func.tags = ['New', 'Verify', 'VerifyContracts'];
 func.runAtTheEnd = true;
 func.skip = (hre: HardhatRuntimeEnvironment) =>
   Promise.resolve(isLocal(hre.network));

packages/contracts/deploy/verification/99_conclude/11_verify-proxies.ts

@@ -0,0 +1,46 @@
+import {isLocal} from '../../../utils/environment';
+import {
+  collectProxyWithImplementation,
+  generateExplorerIsThisAProxyURL,
+  handleLinkProxyRequest,
+} from '../../../utils/etherscan';
+import {DeployFunction} from 'hardhat-deploy/types';
+import {HardhatRuntimeEnvironment} from 'hardhat/types';
+
+/**
+ * This script can be run manually after the deployment of the contracts and contract verification,
+ * call `yarn verifyProxies --network <network>` to run this script.
+ *
+ * It searches deployments for proxies and their implementations and links them on Etherscan.
+ * This avoids the need to call 'Is this a proxy?' for each contract using the UI.
+ * The script will request the linkage for all proxies and implementations and return a GUID to check the status
+ * of the request.
+ *
+ * The API is inconsistent when linking proxies, so we don't include this as part of the default deployment process.
+ */
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  console.log('\nLinking Proxies on Etherscan');
+
+  const url = generateExplorerIsThisAProxyURL(hre);
+  const verifyData = collectProxyWithImplementation(
+    await hre.deployments.all()
+  );
+
+  console.log(
+    `Linking ${verifyData.length} proxies on Etherscan, please be patient.`
+  );
+
+  for (const {proxy, implementation} of verifyData) {
+    await handleLinkProxyRequest(url, proxy, implementation);
+  }
+};
+export default func;
+
+func.tags = ['New', 'Verify', 'VerifyProxies'];
+func.dependencies = ['VerifyContracts'];
+func.runAtTheEnd = true;
+
+func.skip = (hre: HardhatRuntimeEnvironment) => {
+  const verifyProxies = process.env.VERIFY_PROXIES === 'true';
+  return Promise.resolve(isLocal(hre.network) || !verifyProxies);
+};

packages/contracts/package.json

@@ -24,6 +24,7 @@
     "flatten": "hardhat flatten",
     "analyze": "mythx analyze",
     "deploy": "hardhat deploy",
+    "verifyProxies": "VERIFY_PROXIES=true yarn deploy --tags VerifyProxies",
     "deploy:local": "yarn deploy --network localhost --reset",
     "dev": "yarn hardhat node --hostname 0.0.0.0",
     "prepublishOnly": "yarn build && yarn build:npm",