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

docs/sdk/explorer/classes/block_explorer.BlockExplorer.md

@@ -180,7 +180,7 @@ ___
 ▸ **getContractMappingFromSourcify**(`address`): `Promise`\<`undefined` \| [`ContractMapping`](../interfaces/base.ContractMapping.md)\>
 
 Returns the ContractMapping for the contract at that address, or undefined
-by looking up the contract address in Sourcify.
+by looking up the contract address on various contract verification services.
 
 #### Parameters
 

docs/sdk/explorer/classes/sourcify.Metadata.md

@@ -19,6 +19,7 @@ light runtime verification.
 - [abi](sourcify.Metadata.md#abi)
 - [contractName](sourcify.Metadata.md#contractname)
 - [fnMapping](sourcify.Metadata.md#fnmapping)
+- [implementationAddress](sourcify.Metadata.md#implementationaddress)
 
 ### Accessors
 
@@ -42,15 +43,15 @@ light runtime verification.
 | :------ | :------ |
 | `connection` | `Connection` |
 | `address` | `string` |
-| `response` | `any` |
+| `response` | [`MetadataResponse`](../interfaces/sourcify.MetadataResponse.md) |
 
 #### Returns
 
 [`Metadata`](sourcify.Metadata.md)
 
 #### Defined in
 
-[sourcify.ts:73](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L73)
+[sourcify.ts:76](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L76)
 
 ## Properties
 
@@ -60,7 +61,7 @@ light runtime verification.
 
 #### Defined in
 
-[sourcify.ts:65](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L65)
+[sourcify.ts:67](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L67)
 
 ___
 
@@ -70,7 +71,7 @@ ___
 
 #### Defined in
 
-[sourcify.ts:66](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L66)
+[sourcify.ts:68](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L68)
 
 ___
 
@@ -80,7 +81,17 @@ ___
 
 #### Defined in
 
-[sourcify.ts:67](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L67)
+[sourcify.ts:70](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L70)
+
+___
+
+### implementationAddress
+
+• **implementationAddress**: ``null`` \| `string` = `null`
+
+#### Defined in
+
+[sourcify.ts:69](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L69)
 
 ## Accessors
 
@@ -100,7 +111,7 @@ ___
 
 #### Defined in
 
-[sourcify.ts:83](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L83)
+[sourcify.ts:88](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L88)
 
 ## Methods
 
@@ -127,7 +138,7 @@ and array of AbiItems matching the query
 
 #### Defined in
 
-[sourcify.ts:152](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L152)
+[sourcify.ts:158](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L158)
 
 ___
 
@@ -151,7 +162,7 @@ an AbiItem if found or null
 
 #### Defined in
 
-[sourcify.ts:136](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L136)
+[sourcify.ts:142](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L142)
 
 ___
 
@@ -167,4 +178,4 @@ Turn the ABI into a mapping of function selectors to ABI items.
 
 #### Defined in
 
-[sourcify.ts:119](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L119)
+[sourcify.ts:125](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L125)

docs/sdk/explorer/interfaces/sourcify.MetadataResponse.md

@@ -42,6 +42,8 @@ ___
 | Name | Type |
 | :------ | :------ |
 | `compilationTarget?` | `Record`\<`string`, `string`\> |
+| `implementation?` | `string` |
+| `name?` | `string` |
 
 #### Defined in
 

docs/sdk/explorer/modules/sourcify.md

@@ -23,8 +23,8 @@
 
 ▸ **fetchMetadata**(`connection`, `contract`, `strict?`): `Promise`\<[`Metadata`](../classes/sourcify.Metadata.md) \| ``null``\>
 
-Fetch the sourcify response and instantiate a Metadata wrapper class around it.
-Try a full_match but fallback to partial_match when not strict.
+Fetch the sourcify or celoscan response and instantiate a Metadata wrapper class around it.
+Try a full_match but fallback to partial_match when not strict. (only valid for sourcify)
 
 #### Parameters
 
@@ -42,7 +42,7 @@ Metadata or null
 
 #### Defined in
 
-[sourcify.ts:179](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L179)
+[sourcify.ts:185](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L185)
 
 ___
 
@@ -73,4 +73,4 @@ the implementation address or null
 
 #### Defined in
 
-[sourcify.ts:228](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L228)
+[sourcify.ts:300](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/explorer/src/sourcify.ts#L300)

docs/sdk/governance/classes/proposals.InteractiveProposalBuilder.md

@@ -33,7 +33,7 @@
 
 #### Defined in
 
-[proposals.ts:466](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L466)
+[proposals.ts:464](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L464)
 
 ## Methods
 
@@ -47,7 +47,7 @@
 
 #### Defined in
 
-[proposals.ts:468](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L468)
+[proposals.ts:466](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L466)
 
 ___
 
@@ -61,4 +61,4 @@ ___
 
 #### Defined in
 
-[proposals.ts:473](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L473)
+[proposals.ts:471](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L471)

docs/sdk/governance/classes/proposals.ProposalBuilder.md

@@ -144,7 +144,7 @@ ___
 
 #### Defined in
 
-[proposals.ts:460](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L460)
+[proposals.ts:458](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/governance/src/proposals.ts#L458)
 
 ___
 

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', '<rootDir>/src/test-utils/setupAfterEnv.ts'],
   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

@@ -83,6 +83,7 @@
     "@types/ledgerhq__hw-transport-node-hid": "^4.22.5",
     "@types/node": "^18.7.16",
     "@types/prompts": "^1.1.1",
+    "fetch-mock": "^9.11.0",
     "jest": "^29.7.0",
     "oclif": "^4.3.4",
     "prettier": "1.19.1",

packages/cli/src/base.ts

@@ -7,13 +7,16 @@ 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 { getFeeCurrencyContractWrapper } from './utils/fee-currency'
 import { requireNodeIsSynced } from './utils/helpers'
 
+const debug = debugFactory('cli:base')
+
 export abstract class BaseCommand extends Command {
   static flags = {
     privateKey: Flags.string({
@@ -126,10 +129,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)
@@ -231,10 +238,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/election/list.test.ts

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