build: add script to verify contracts from address-book in Etherscan (#236)

* build: add script to verify contracts from address-book in Etherscan
* build: ignore if contract address is not defined

Author: abarmat

.env.example

@@ -0,0 +1,3 @@
+MNEMONIC=
+ETHERSCAN_API_KEY=
+INFURA_KEY=

buidler.config.ts

@@ -1,14 +1,16 @@
 import * as dotenv from 'dotenv'
 import { Wallet } from 'ethers'
-import { BuidlerConfig, task, usePlugin, types } from '@nomiclabs/buidler/config'
+import { BuidlerConfig, task, usePlugin } from '@nomiclabs/buidler/config'
 
 import { cliOpts } from './scripts/cli/constants'
 import { migrate } from './scripts/cli/commands/migrate'
+import { verify } from './scripts/cli/commands/verify'
 
 dotenv.config()
 
 // Plugins
 
+usePlugin('@nomiclabs/buidler-etherscan')
 usePlugin('@nomiclabs/buidler-waffle')
 usePlugin('solidity-coverage')
 
@@ -26,7 +28,6 @@ function getInfuraProviderURL(network: string) {
 
 task('accounts', 'Prints the list of accounts', async (taskArgs, bre) => {
   const accounts = await bre.ethers.getSigners()
-
   for (const account of accounts) {
     console.log(await account.getAddress())
   }
@@ -41,6 +42,13 @@ task('migrate', 'Migrate contracts')
     await migrate(accounts[0] as Wallet, taskArgs.addressBook, taskArgs.graphConfig, taskArgs.force)
   })
 
+task('verify', 'Verify contracts in Etherscan')
+  .addParam('addressBook', cliOpts.addressBook.description, cliOpts.addressBook.default)
+  .setAction(async (taskArgs, bre) => {
+    const accounts = await bre.ethers.getSigners()
+    await verify(accounts[0] as Wallet, taskArgs.addressBook)
+  })
+
 // Config - Go to https://buidler.dev/config/ to learn more
 
 const config: BuidlerConfig = {
@@ -120,7 +128,11 @@ const config: BuidlerConfig = {
         mnemonic: getAccountMnemonic(),
       },
     },
-  }
+  },
+  etherscan: {
+    url: 'https://api-kovan.etherscan.io/api',
+    apiKey: process.env.ETHERSCAN_API_KEY,
+  },
 }
 
 export default config

package-lock.json

@@ -17,6 +17,7 @@
     "@graphprotocol/common-ts": "0.0.32",
     "@nomiclabs/buidler": "^1.3.7",
     "@nomiclabs/buidler-ethers": "^2.0.0-alpha.1",
+    "@nomiclabs/buidler-etherscan": "^1.3.3",
     "@nomiclabs/buidler-waffle": "^2.0.0-alpha.1",
     "@openzeppelin/contracts": "3.0.1",
     "@types/bs58": "^4.0.1",
@@ -69,7 +70,7 @@
     "migrate": "buidler migrate",
     "test": "npm run typechain && buidler test",
     "coverage": "SOLIDITY_COVERAGE=true npm run evm:test",
-    "evm:test": "scripts/evm.sh",
+    "evm:test": "scripts/evm",
     "lint": "npm run lint:ts && npm run lint:sol",
     "lint:fix": "npm run lint:ts:fix && npm run lint:sol:fix",
     "lint:ts": "eslint '*/**/*.{js,ts}'",
@@ -79,9 +80,10 @@
     "prettier": "npm run prettier:ts && npm run prettier:sol",
     "prettier:ts": "prettier --write 'test/**/*.ts'",
     "prettier:sol": "prettier --write 'contracts/*.sol'",
-    "flatten": "scripts/flatten.sh",
+    "flatten": "scripts/flatten",
     "abi:extract": "truffle-abi -d ./build/contracts -o ./build/abis/ -v",
-    "typechain": "typechain --target abarmat-ethers-v5 --outDir build/typechain/contracts 'build/abis/*.json'"
+    "typechain": "typechain --target abarmat-ethers-v5 --outDir build/typechain/contracts 'build/abis/*.json'",
+    "verify": "buidler verify"
   },
   "lint-staged": {
     "contracts/*.sol": [

package.json

@@ -3,8 +3,14 @@
 import yargs from 'yargs'
 
 import { migrateCommand } from './commands/migrate'
+import { verifyCommand } from './commands/verify'
+import { cliOpts } from './constants'
 
 yargs
+  .option('a', cliOpts.addressBook)
+  .option('m', cliOpts.mnemonic)
+  .option('p', cliOpts.ethProvider)
   .command(migrateCommand)
+  .command(verifyCommand)
   .demandCommand(1, 'Choose a command from the above list')
   .help().argv

scripts/cli/cli.ts

@@ -97,11 +97,7 @@ export const migrateCommand = {
   command: 'migrate',
   describe: 'Migrate contracts',
   builder: (yargs: Argv) => {
-    return yargs
-      .option('a', cliOpts.addressBook)
-      .option('c', cliOpts.graphConfig)
-      .option('m', cliOpts.mnemonic)
-      .option('p', cliOpts.ethProvider)
+    return yargs.option('c', cliOpts.graphConfig)
   },
   handler: async (argv: { [key: string]: any } & Argv['argv']) => {
     await migrate(

scripts/cli/commands/migrate.ts

@@ -0,0 +1,65 @@
+import { Wallet, constants, utils, ContractTransaction } from 'ethers'
+
+import { Argv } from 'yargs'
+
+import { getAddressBook } from '../address-book'
+import { getProvider } from '../utils'
+import { spawn, execSync, spawnSync } from 'child_process'
+
+const coreContracts = [
+  'EpochManager',
+  'GNS',
+  'GraphToken',
+  'ServiceRegistry',
+  'Curation',
+  'RewardsManager',
+  'Staking',
+  'DisputeManager',
+  'IndexerCTDT',
+  'IndexerSingleAssetInterpreter',
+  'IndexerMultiAssetInterpreter',
+  'IndexerWithdrawInterpreter',
+  'MinimumViableMultisig',
+]
+
+export const verify = async (wallet: Wallet, addressBookPath: string): Promise<void> => {
+  const chainId = (await wallet.provider.getNetwork()).chainId
+  const addressBook = getAddressBook(addressBookPath, chainId.toString())
+  console.log(
+    `* Verifying contracts for chainId (${chainId}) using address-book (${addressBookPath})`,
+  )
+
+  for (const contractName of coreContracts) {
+    const contract = addressBook.getEntry(contractName)
+    if (!contract) {
+      console.log(
+        `- ERROR: Contract ${contractName} not found in address-book for network ${chainId}`,
+      )
+      continue
+    }
+
+    const address = contract.address
+    const args = contract.constructorArgs ? contract.constructorArgs.map(e => e.value) : []
+    const argsList = args.map(e => `"${e}"`).join(' ')
+    const cmd = `buidler verify-contract --contract-name ${contractName} --address ${address} ${argsList}`
+
+    try {
+      console.log(`> Verifying contract ${contractName}::${address} ...`)
+      await execSync(cmd)
+      console.log(`+ Contract ${contractName}::${address} verified`)
+    } catch (err) {
+      console.log(`- ERROR: ${contractName}::${address}`)
+    }
+  }
+}
+
+export const verifyCommand = {
+  command: 'verify',
+  describe: 'Verify contracts',
+  handler: async (argv: { [key: string]: any } & Argv['argv']) => {
+    await verify(
+      Wallet.fromMnemonic(argv.mnemonic).connect(getProvider(argv.ethProvider)),
+      argv.addressBook,
+    )
+  },
+}