Get metadata for contracts verified on celoscan

.changeset/tough-ears-study.md

@@ -0,0 +1,5 @@
+---
+'@celo/celocli': minor
+---
+
+Add ability to build and view governance proposals which interact with contracts verified on celoscan

.changeset/young-foxes-compete.md

@@ -0,0 +1,5 @@
+---
+'@celo/explorer': minor
+---
+
+Adds Celoscan as source for fetching verified contract metadata

.gitignore

@@ -91,3 +91,4 @@ package.json-e
 # Ignore generated credentials from google-github-actions/auth
 gha-creds-*.json
 transactions.json
+transactions2.json

packages/cli/.gitignore

@@ -10,3 +10,5 @@ oclif.manifest.json
 src/generated
 .devchain/
 .devchain.tar.gz
+transactions.json
+transactions2.json

packages/cli/jest.config.js

@@ -5,4 +5,7 @@ module.exports = {
   setupFilesAfterEnv: ['@celo/dev-utils/lib/matchers'],
   globalSetup: '<rootDir>/src/test-utils/setup.global.ts',
   globalTeardown: '<rootDir>/src/test-utils/teardown.global.ts',
+  testTimeout: 10 * 1000, // set default timeout to 10 seconds
+  slowTestThreshold: 10, // this is also 10 seconds.
+  openHandlesTimeout: 0, // disables
 }

packages/cli/package.json

@@ -29,7 +29,7 @@
     "lint": "yarn run --top-level eslint -c .eslintrc.js ",
     "prepublish": "",
     "prepack": "yarn run build && oclif manifest && oclif readme",
-    "test": "TZ=UTC yarn jest --runInBand"
+    "test": "TZ=UTC yarn jest --runInBand --forceExit --silent"
   },
   "dependencies": {
     "@celo/abis": "11.0.0",
@@ -83,6 +83,7 @@
     "@types/ledgerhq__hw-transport-node-hid": "^4.22.2",
     "@types/node": "^18.7.16",
     "@types/prompts": "^1.1.1",
+    "fetch-mock": "^9.11.0",
     "jest": "^29.0.2",
     "oclif": "^4.3.4",
     "prettier": "1.19.1",

packages/cli/src/base.ts

@@ -7,12 +7,15 @@ import { LocalWallet } from '@celo/wallet-local'
 import _TransportNodeHid from '@ledgerhq/hw-transport-node-hid'
 import { Command, Flags } from '@oclif/core'
 import chalk from 'chalk'
+import debugFactory from 'debug'
 import net from 'net'
 import Web3 from 'web3'
 import { CustomFlags } from './utils/command'
 import { getNodeUrl } from './utils/config'
 import { requireNodeIsSynced } from './utils/helpers'
 
+const debug = debugFactory('cli:base')
+
 export abstract class BaseCommand extends Command {
   static flags = {
     privateKey: Flags.string({
@@ -122,10 +125,14 @@ export abstract class BaseCommand extends Command {
   }
 
   async getKit() {
-    if (!this._kit) {
-      this._kit = newKitFromWeb3(await this.getWeb3())
+    // return now if kit already has been built instead of doing all that parsing and awaiting
+    // because this.getKit is called when closing down the command by not returning early this.parse would be called and weird logs occure
+    if (this._kit) {
+      return this._kit
     }
 
+    this._kit = newKitFromWeb3(await this.getWeb3())
+
     const res = await this.parse()
     if (res.flags && res.flags.privateKey && !res.flags.useLedger && !res.flags.useAKV) {
       this._kit.connection.addAccount(res.flags.privateKey)
@@ -228,10 +235,11 @@ export abstract class BaseCommand extends Command {
   async finally(arg: Error | undefined): Promise<any> {
     try {
       if (arg) {
-        console.error('received error while cleaning up', arg)
+        debug('received error while cleaning up:', arg)
       }
-      const kit = await this.getKit()
-      kit.connection.stop()
+      // we only need to stop the kit if one exists. if there is an error on this.parse for flags then there is no kit and thus none to stop
+      // if we use this.getKit then this.parse is called and errors out. throwing and logging failed to close the connection
+      this._kit && this._kit.connection.stop()
     } catch (error) {
       this.log(`Failed to close the connection: ${error}`)
     }

packages/cli/src/commands/account/register.test.ts

@@ -13,8 +13,6 @@ testWithGanache('account:register cmd', (web3: Web3) => {
   })
 
   test('fails if from is missing', async () => {
-    // const accounts = await web3.eth.getAccounts()
-
     await expect(testLocally(Register, [])).rejects.toThrow('Missing required flag')
   })
 })

packages/cli/src/commands/account/set-name.test.ts

@@ -23,15 +23,15 @@ testWithGanache('account:set-name cmd', (web3: Web3) => {
 
   test('fails if account is not provided', async () => {
     await expect(testLocally(SetName, ['--name', 'TestName'])).rejects.toThrow(
-      'Missing required flag'
+      'Missing required flag account'
     )
   })
 
   test('fails if name is not provided', async () => {
     const accounts = await web3.eth.getAccounts()
 
     await expect(testLocally(SetName, ['--account', accounts[0]])).rejects.toThrow(
-      'Missing required flag'
+      'Missing required flag name'
     )
   })
 })

packages/cli/src/commands/election/list.test.ts

@@ -52,5 +52,5 @@ describe('election:list cmd', () => {
         ],
       ]
     `)
-  })
+  }, 4000)
 })

packages/cli/src/commands/election/revoke.test.ts

@@ -8,7 +8,7 @@ import {
   setupGroupAndAffiliateValidator,
   voteForGroupFromAndActivateVotes,
 } from '../../test-utils/chain-setup'
-import { testLocally } from '../../test-utils/cliUtils'
+import { EXTRA_LONG_TIMEOUT_MS, testLocally } from '../../test-utils/cliUtils'
 import Revoke from './revoke'
 
 process.env.NO_SYNCCHECK = 'true'
@@ -34,73 +34,85 @@ testWithGanache('election:revoke', (web3: Web3) => {
     )
   })
 
-  it('fails when trying to revoke more votes than voted', async () => {
-    const kit = newKitFromWeb3(web3)
-    const [fromAddress, groupAddress] = await web3.eth.getAccounts()
-
-    await registerAccount(kit, fromAddress)
-
-    await expect(
-      testLocally(Revoke, ['--from', fromAddress, '--for', groupAddress, '--value', '1'])
-    ).rejects.toThrow(
-      `can't revoke more votes for ${groupAddress} than have been made by ${fromAddress}`
-    )
-  })
-
-  it('successfuly revokes all votes', async () => {
-    const kit = newKitFromWeb3(web3)
-    const election = await kit.contracts.getElection()
-    const amount = new BigNumber(12345)
-    const [fromAddress, validatorAddress, groupAddress] = await web3.eth.getAccounts()
-
-    await registerAccountWithLockedGold(kit, fromAddress)
-    await setupGroupAndAffiliateValidator(kit, groupAddress, validatorAddress)
-    await voteForGroupFromAndActivateVotes(kit, fromAddress, groupAddress, amount)
-
-    expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
-      amount
-    )
-
-    await testLocally(Revoke, [
-      '--from',
-      fromAddress,
-      '--for',
-      groupAddress,
-      '--value',
-      amount.toFixed(),
-    ])
-
-    expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
-      new BigNumber(0)
-    )
-  })
-
-  it('successfuly revokes votes partially', async () => {
-    const kit = newKitFromWeb3(web3)
-    const election = await kit.contracts.getElection()
-    const amount = new BigNumber(54321)
-    const revokeAmount = new BigNumber(4321)
-    const [fromAddress, validatorAddress, groupAddress] = await web3.eth.getAccounts()
-
-    await registerAccountWithLockedGold(kit, fromAddress)
-    await setupGroupAndAffiliateValidator(kit, groupAddress, validatorAddress)
-    await voteForGroupFromAndActivateVotes(kit, fromAddress, groupAddress, amount)
-
-    expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
-      amount
-    )
-
-    await testLocally(Revoke, [
-      '--from',
-      fromAddress,
-      '--for',
-      groupAddress,
-      '--value',
-      revokeAmount.toFixed(),
-    ])
-
-    expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
-      amount.minus(revokeAmount)
-    )
-  })
+  it(
+    'fails when trying to revoke more votes than voted',
+    async () => {
+      const kit = newKitFromWeb3(web3)
+      const [fromAddress, groupAddress] = await web3.eth.getAccounts()
+
+      await registerAccount(kit, fromAddress)
+
+      await expect(
+        testLocally(Revoke, ['--from', fromAddress, '--for', groupAddress, '--value', '1'])
+      ).rejects.toThrow(
+        `can't revoke more votes for ${groupAddress} than have been made by ${fromAddress}`
+      )
+    },
+    EXTRA_LONG_TIMEOUT_MS
+  )
+
+  it(
+    'successfuly revokes all votes',
+    async () => {
+      const kit = newKitFromWeb3(web3)
+      const election = await kit.contracts.getElection()
+      const amount = new BigNumber(12345)
+      const [fromAddress, validatorAddress, groupAddress] = await web3.eth.getAccounts()
+
+      await registerAccountWithLockedGold(kit, fromAddress)
+      await setupGroupAndAffiliateValidator(kit, groupAddress, validatorAddress)
+      await voteForGroupFromAndActivateVotes(kit, fromAddress, groupAddress, amount)
+
+      expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
+        amount
+      )
+
+      await testLocally(Revoke, [
+        '--from',
+        fromAddress,
+        '--for',
+        groupAddress,
+        '--value',
+        amount.toFixed(),
+      ])
+
+      expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
+        new BigNumber(0)
+      )
+    },
+    EXTRA_LONG_TIMEOUT_MS
+  )
+
+  it(
+    'successfuly revokes votes partially',
+    async () => {
+      const kit = newKitFromWeb3(web3)
+      const election = await kit.contracts.getElection()
+      const amount = new BigNumber(54321)
+      const revokeAmount = new BigNumber(4321)
+      const [fromAddress, validatorAddress, groupAddress] = await web3.eth.getAccounts()
+
+      await registerAccountWithLockedGold(kit, fromAddress)
+      await setupGroupAndAffiliateValidator(kit, groupAddress, validatorAddress)
+      await voteForGroupFromAndActivateVotes(kit, fromAddress, groupAddress, amount)
+
+      expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
+        amount
+      )
+
+      await testLocally(Revoke, [
+        '--from',
+        fromAddress,
+        '--for',
+        groupAddress,
+        '--value',
+        revokeAmount.toFixed(),
+      ])
+
+      expect((await election.getVotesForGroupByAccount(fromAddress, groupAddress)).active).toEqual(
+        amount.minus(revokeAmount)
+      )
+    },
+    EXTRA_LONG_TIMEOUT_MS
+  )
 })