Governance ContractKit + CLI changes

packages/celotool/src/cmds/transactions/list.ts

@@ -73,7 +73,7 @@ async function fetchTx(
   console.info(
     `${parsedTransaction.callDetails.contract}#${
       parsedTransaction.callDetails.function
-    }(${JSON.stringify(parsedTransaction.callDetails.parameters)}) ${parsedTransaction.tx.hash}`
+    }(${JSON.stringify(parsedTransaction.callDetails.paramMap)}) ${parsedTransaction.tx.hash}`
   )
 
   if (receipt.logs) {

packages/cli/src/commands/governance/approve.ts

@@ -0,0 +1,24 @@
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class Approve extends BaseCommand {
+  static description = 'Approve a dequeued governance proposal'
+
+  static flags = {
+    ...BaseCommand.flags,
+    proposalID: flags.string({ required: true, description: 'UUID of proposal to approve' }),
+    from: Flags.address({ required: true, description: "Approver's address" }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(Approve)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const tx = await governance.approve(res.flags.proposalID)
+    await displaySendTx('approveTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/approvehotfix.ts

@@ -0,0 +1,26 @@
+import { flags } from '@oclif/command'
+import { toBuffer } from 'ethereumjs-util'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class ApproveHotfix extends BaseCommand {
+  static description = 'Approve a governance hotfix'
+
+  static flags = {
+    ...BaseCommand.flags,
+    from: Flags.address({ required: true, description: "Approver's address" }),
+    hash: flags.string({ required: true, description: 'Hash of hotfix transactions' }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(ApproveHotfix)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const hash = toBuffer(res.flags.hash) as Buffer
+    const tx = governance.approveHotfix(hash)
+    await displaySendTx('approveHotfixTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/execute.ts

@@ -0,0 +1,25 @@
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class Execute extends BaseCommand {
+  static description = 'Execute a passing governance proposal'
+
+  static flags = {
+    ...BaseCommand.flags,
+    proposalID: flags.string({ required: true, description: 'UUID of proposal to execute' }),
+    from: Flags.address({ required: true, description: "Executor's address" }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(Execute)
+
+    const governance = await this.kit.contracts.getGovernance()
+
+    const tx = await governance.execute(res.flags.proposalID)
+    await displaySendTx('executeTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/executehotfix.ts

@@ -0,0 +1,26 @@
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+import { buildProposalFromJsonFile } from '../../utils/governance'
+
+export default class ExecuteHotfix extends BaseCommand {
+  static description = 'Execute a governance hotfix prepared for the current epoch'
+
+  static flags = {
+    ...BaseCommand.flags,
+    from: Flags.address({ required: true, description: "Executors's address" }),
+    jsonTransactions: flags.string({ required: true, description: 'Path to json transactions' }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(ExecuteHotfix)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const hotfix = await buildProposalFromJsonFile(this.kit, res.flags.jsonTransactions)
+    const tx = governance.executeHotfix(hotfix)
+    await displaySendTx('executeHotfixTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/preparehotfix.ts

@@ -0,0 +1,26 @@
+import { flags } from '@oclif/command'
+import { toBuffer } from 'ethereumjs-util'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class PrepareHotfix extends BaseCommand {
+  static description = 'Prepare a governance hotfix for execution in the current epoch'
+
+  static flags = {
+    ...BaseCommand.flags,
+    from: Flags.address({ required: true, description: "Preparer's address" }),
+    hash: flags.string({ required: true, description: 'Hash of hotfix transactions' }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(PrepareHotfix)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const hash = toBuffer(res.flags.hash) as Buffer
+    const tx = governance.prepareHotfix(hash)
+    await displaySendTx('prepareHotfixTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/propose.ts

@@ -0,0 +1,30 @@
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+import { buildProposalFromJsonFile } from '../../utils/governance'
+
+export default class Propose extends BaseCommand {
+  static description = 'Submit a governance proposal'
+
+  static flags = {
+    ...BaseCommand.flags,
+    jsonTransactions: flags.string({ required: true, description: 'Path to json transactions' }),
+    deposit: flags.string({ required: true, description: 'Amount of Gold to attach to proposal' }),
+    from: Flags.address({ required: true, description: "Proposer's address" }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(Propose)
+
+    const governance = await this.kit.contracts.getGovernance()
+
+    const proposal = await buildProposalFromJsonFile(this.kit, res.flags.jsonTransactions)
+    const tx = governance.propose(proposal)
+    await displaySendTx('proposeTx', tx, { from: res.flags.from, value: res.flags.deposit })
+    // const proposalID = await tx.txo.call()
+    // this.log(`ProposalID: ${proposalID}`)
+  }
+}

packages/cli/src/commands/governance/upvote.ts

@@ -0,0 +1,24 @@
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class Upvote extends BaseCommand {
+  static description = 'Upvote a queued governance proposal'
+
+  static flags = {
+    ...BaseCommand.flags,
+    proposalID: flags.string({ required: true, description: 'UUID of proposal to upvote' }),
+    from: Flags.address({ required: true, description: "Upvoter's address" }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(Upvote)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const tx = await governance.upvote(res.flags.proposalID, res.flags.from)
+    await displaySendTx('upvoteTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/vote.ts

@@ -0,0 +1,29 @@
+import { VoteValue } from '@celo/contractkit/lib/wrappers/Governance'
+import { flags } from '@oclif/command'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class Vote extends BaseCommand {
+  static description = 'Vote on an approved governance proposal'
+
+  static voteOptions = ['Abstain', 'No', 'Yes']
+
+  static flags = {
+    ...BaseCommand.flags,
+    proposalID: flags.string({ required: true, description: 'UUID of proposal to vote on' }),
+    vote: flags.enum({ options: Vote.voteOptions, required: true, description: 'Vote' }),
+    from: Flags.address({ required: true, description: "Voter's address" }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(Vote)
+
+    const governance = await this.kit.contracts.getGovernance()
+
+    const tx = await governance.vote(res.flags.proposalID, res.flags.vote as keyof typeof VoteValue)
+    await displaySendTx('voteTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/commands/governance/whitelisthotfix.ts

@@ -0,0 +1,26 @@
+import { flags } from '@oclif/command'
+import { toBuffer } from 'ethereumjs-util'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class WhitelistHotfix extends BaseCommand {
+  static description = 'Whitelist a governance hotfix'
+
+  static flags = {
+    ...BaseCommand.flags,
+    from: Flags.address({ required: true, description: "Whitelister's address" }),
+    hash: flags.string({ required: true, description: 'Hash of hotfix transactions' }),
+  }
+
+  static examples = []
+
+  async run() {
+    const res = this.parse(WhitelistHotfix)
+
+    const governance = await this.kit.contracts.getGovernance()
+    const hash = toBuffer(res.flags.hash) as Buffer
+    const tx = governance.whitelistHotfix(hash)
+    await displaySendTx('whitelistHotfixTx', tx, { from: res.flags.from })
+  }
+}

packages/cli/src/utils/command.ts

@@ -1,4 +1,4 @@
-import { ensureHexLeader, stripHexLeader } from '@celo/utils/lib/address'
+import { ensureLeading0x, trimLeading0x } from '@celo/utils/lib/address'
 import { BLS_POP_SIZE, BLS_PUBLIC_KEY_SIZE } from '@celo/utils/lib/bls'
 import { URL_REGEX } from '@celo/utils/lib/io'
 import { isE164NumberStrict } from '@celo/utils/lib/phoneNumbers'
@@ -13,14 +13,14 @@ const parseBytes = (input: string, length: number, msg: string) => {
   // Check that the string is hex and and has byte length of `length`.
   const expectedLength = input.startsWith('0x') ? length * 2 + 2 : length * 2
   if (Web3.utils.isHex(input) && input.length === expectedLength) {
-    return ensureHexLeader(input)
+    return ensureLeading0x(input)
   } else {
     throw new CLIError(msg)
   }
 }
 
 const parseEcdsaPublicKey: ParseFn<string> = (input) => {
-  const stripped = stripHexLeader(input)
+  const stripped = trimLeading0x(input)
   // ECDSA public keys may be passed as 65 byte values. When this happens, we drop the first byte.
   if (stripped.length === 65 * 2) {
     return parseBytes(stripped.slice(2), 64, `${input} is not an ECDSA public key`)

packages/cli/src/utils/governance.ts

@@ -0,0 +1,14 @@
+import { ContractKit } from '@celo/contractkit'
+import {
+  ProposalBuilder,
+  ProposalTransactionJSON,
+} from '@celo/contractkit/lib/governance/proposals'
+import { readFileSync } from 'fs-extra'
+
+export const buildProposalFromJsonFile = async (kit: ContractKit, jsonFile: string) => {
+  const builder = new ProposalBuilder(kit)
+  const jsonString = readFileSync(jsonFile).toString()
+  const jsonTransactions: ProposalTransactionJSON[] = JSON.parse(jsonString)
+  jsonTransactions.forEach((tx) => builder.addJsonTx(tx))
+  return builder.build()
+}

packages/contractkit/src/explorer/block-explorer.ts

@@ -7,7 +7,8 @@ import { ContractDetails, mapFromPairs, obtainKitContractDetails } from './base'
 export interface CallDetails {
   contract: string
   function: string
-  parameters: Record<string, any>
+  paramMap: Record<string, any>
+  argList: any[]
 }
 
 export interface ParsedTx {
@@ -93,23 +94,24 @@ export class BlockExplorer {
       return null
     }
 
-    const parameters: Record<string, any> = abi.decodeParameters(
-      matchedAbi.inputs!,
-      encodedParameters
-    )
+    const parameters = abi.decodeParameters(matchedAbi.inputs!, encodedParameters)
 
-    // remove number & number keys
+    // remove numbers and number keys from parameters and build ordered list of arguments
+    const args = new Array(parameters.__length__)
     delete parameters.__length__
     Object.keys(parameters).forEach((key) => {
-      if (Number.parseInt(key, 10) >= 0) {
+      const argIndex = parseInt(key, 10)
+      if (argIndex >= 0) {
+        args[argIndex] = parameters[key]
         delete parameters[key]
       }
     })
 
     const callDetails: CallDetails = {
       contract: contractMapping.details.name,
       function: matchedAbi.name!,
-      parameters,
+      paramMap: parameters,
+      argList: args,
     }
 
     return {

packages/contractkit/src/explorer/log-explorer.ts

@@ -1,26 +1,9 @@
 import { Address } from '@celo/utils/lib/address'
 import abi, { ABIDefinition } from 'web3-eth-abi'
-import { Block, Transaction } from 'web3/eth/types'
 import { EventLog, Log, TransactionReceipt } from 'web3/types'
 import { ContractKit } from '../kit'
 import { ContractDetails, mapFromPairs, obtainKitContractDetails } from './base'
 
-export interface CallDetails {
-  contract: string
-  function: string
-  parameters: Record<string, any>
-}
-
-export interface ParsedTx {
-  callDetails: CallDetails
-  tx: Transaction
-}
-
-export interface ParsedBlock {
-  block: Block
-  parsedTx: ParsedTx[]
-}
-
 interface ContractMapping {
   details: ContractDetails
   logMapping: Map<string, ABIDefinition>

packages/contractkit/src/governance/index.ts

@@ -0,0 +1 @@
+export * from './proposals'