Add etherscan verification info (#147)

circlefin · Dec 9, 2022 · 9953ca8 · 9953ca8
1 parent fc06499
commit 9953ca8
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -1,5 +1,9 @@
+# Goerli
 GOERLI_URL=
 GOERLI_ADMIN=
 GOERLI_OPERATOR=
 GOERLI_DEPLOYER=
 GOERLI_PAUSER=
+
+# Etherscan
+ETHERSCAN_API_KEY=
diff --git a/README.md b/README.md
@@ -85,3 +85,23 @@ Here is an example command to pause a hypothetical contract:
 ```sh
 npx hardhat setPaused --address 0x5FbDB2315678afecb367f032d93F642f64180aa3 --paused true
 ```
+
+### Etherscan Verification
+
+Contract source can be uploaded and verified to Etherscan. Update `.env` to include your etherscan API key.
+
+For each deployed contract, run the following:
+
+```
+npx hardhat verify --network goerli CONTRACT_ADDRESS
+```
+
+There are three contracts that require constructor arguments:
+
+- WithdrawControllerFactory
+- PoolControllerFactory
+- PoolFactory
+
+```
+npx hardhat verify --network goerli CONTRACT_ADDRESS arg1 arg2 arg3
+```
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -1,5 +1,6 @@
 import { HardhatUserConfig } from "hardhat/config";
 import "@nomicfoundation/hardhat-toolbox";
+import "@nomiclabs/hardhat-etherscan";
 import "@openzeppelin/hardhat-upgrades";
 import "hardhat-contract-sizer";
 import "./tasks/serviceConfiguration";
@@ -48,6 +49,11 @@ const config: HardhatUserConfig | ExtendedHardhatUserConfig = {
   },
   docgen: {
     pages: "files"
+  },
+  etherscan: {
+    // Your API key for Etherscan
+    // Obtain one at https://etherscan.io/
+    apiKey: process.env.ETHERSCAN_API_KEY
   }
 };