Setup oracle account, Add CLI commands to report oracle values

packages/celotool/src/cmds/deploy/initial/contracts.ts

@@ -120,6 +120,7 @@ export const handler = async (argv: InitialArgv) => {
             () => '60000000000000000000000'
           ), // 60k Celo Dollars
         },
+        oracles: getAddressesFor(AccountType.PRICE_ORACLE, mnemonic, 1),
       },
     })
 

packages/celotool/src/cmds/report_oracle_value.ts

@@ -0,0 +1,99 @@
+import { CeloContract, CeloToken, newKit } from '@celo/contractkit'
+import BigNumber from 'bignumber.js'
+import { switchToClusterFromEnv } from 'src/lib/cluster'
+import { addCeloEnvMiddleware, CeloEnvArgv, envVar, fetchEnv } from 'src/lib/env-utils'
+import { AccountType, generatePrivateKey, privateKeyToAddress } from 'src/lib/generate_utils'
+import { portForwardAnd } from 'src/lib/port_forward'
+import * as yargs from 'yargs'
+
+export const command = 'report-oracle-value'
+
+interface ReportOracleValueArgv extends CeloEnvArgv {
+  token: string
+  price: number
+  // oracleAccount: string
+  runWithPortForward: boolean
+}
+
+export const builder = (argv: yargs.Argv) => {
+  return addCeloEnvMiddleware(argv)
+    .option('token', {
+      type: 'string',
+      description: 'Celo Token in which to report the price of 1 Celo Gold',
+      default: 'StableToken',
+    })
+    .option('price', {
+      type: 'number',
+      description: 'The price of 1 Celo Gold in the specified token (float values allowed)',
+      demand: 'Please specify the price of 1 Celo Gold',
+    })
+    .option('runWithPortForward', {
+      type: 'boolean',
+      description:
+        'Specify whether this command should be run port-forwarded, or is running within the cluster. Default is true',
+      default: true,
+    })
+}
+
+export const handler = async (argv: ReportOracleValueArgv) => {
+  if (argv.runWithPortForward) {
+    await switchToClusterFromEnv(false)
+
+    try {
+      await portForwardAnd(argv.celoEnv, reportCmd.bind(null, argv))
+      console.info('finished with the portforwarding???')
+    } catch (error) {
+      console.error(`Unable to report value of ${argv.token}`)
+      console.error(error.error)
+      process.exit(1)
+    }
+  } else {
+    try {
+      await reportCmd(argv)
+    } catch (error) {
+      console.error(`Unable to report value of ${argv.token}`)
+      console.error(error.error)
+      process.exit(1)
+    }
+  }
+  process.exit()
+}
+
+async function reportCmd(argv: ReportOracleValueArgv) {
+  let token: CeloToken
+  if (argv.token === CeloContract.StableToken) {
+    token = CeloContract.StableToken
+  } else {
+    console.error(`${argv.token} is not a valid token to report upon`)
+    process.exit(1)
+    return
+  }
+
+  let numerator = new BigNumber(argv.price)
+  let denominator = new BigNumber(1)
+
+  if (numerator.decimalPlaces() > 0) {
+    denominator = new BigNumber(10).pow(numerator.decimalPlaces())
+    numerator = numerator.multipliedBy(denominator)
+  }
+
+  const hostEnvVar = `${argv.celoEnv.toUpperCase()}_SERVICE_0_TCP_SERVICE_HOST`
+  const kit = newKit(`http://${fetchEnv(hostEnvVar)}:8545`)
+  const mnemonic = fetchEnv(envVar.MNEMONIC)
+  // TODO: switch this to the right account type after deploying testnet
+  // Or, don't hardcode this at all.
+  const oracleKey = generatePrivateKey(mnemonic, AccountType.ATTESTATION, 0)
+  kit.addAccount(oracleKey)
+  const oracleAddress = privateKeyToAddress(oracleKey)
+
+  const sortedOracles = await kit.contracts.getSortedOracles()
+  const tx = await sortedOracles.report(
+    token,
+    numerator.toNumber(),
+    denominator.toNumber(),
+    oracleAddress
+  )
+
+  await tx.sendAndWaitForReceipt()
+  console.info(`Reported the price of ${argv.price} ${argv.token} for 1 Celo Gold`)
+}

packages/celotool/src/lib/generate_utils.ts

@@ -28,6 +28,7 @@ export enum AccountType {
   BOOTNODE = 3,
   FAUCET = 4,
   ATTESTATION = 5,
+  PRICE_ORACLE = 6,
 }
 
 export enum ConsensusType {
@@ -47,6 +48,7 @@ export const MNEMONIC_ACCOUNT_TYPE_CHOICES = [
   'bootnode',
   'faucet',
   'attestation',
+  'price_oracle',
 ]
 
 export const add0x = (str: string) => {
@@ -143,11 +145,13 @@ export const generateGenesisFromEnv = (enablePetersburg: boolean = true) => {
   // Assing DEFAULT ammount of gold to 2 faucet accounts
   const faucetAddresses = getStrippedAddressesFor(AccountType.FAUCET, mnemonic, 2)
 
+  const oracleAddress = getStrippedAddressesFor(AccountType.PRICE_ORACLE, mnemonic, 1)
+
   return generateGenesis({
     validators,
     consensusType,
     blockTime,
-    initialAccounts: faucetAddresses,
+    initialAccounts: faucetAddresses.concat(oracleAddress),
     epoch,
     chainId,
     requestTimeout,

packages/cli/src/base.ts

@@ -1,9 +1,10 @@
-import { ContractKit, newKitFromWeb3 } from '@celo/contractkit'
+import { CeloProvider, ContractKit, newKitFromWeb3 } from '@celo/contractkit'
 import { Command, flags } from '@oclif/command'
 import Web3 from 'web3'
 import { getNodeUrl } from './utils/config'
 import { injectDebugProvider } from './utils/eth-debug-provider'
 import { requireNodeIsSynced } from './utils/helpers'
+import { addKeysToKit } from './utils/local_accounts'
 
 export abstract class BaseCommand extends Command {
   static flags = {
@@ -46,6 +47,7 @@ export abstract class BaseCommand extends Command {
     if (this.requireSynced) {
       await requireNodeIsSynced(this.web3)
     }
+    addKeysToKit(this.kit, this.config.configDir)
   }
 
   // TODO(yorke): implement log(msg) switch on logLevel with chalk colored output
@@ -59,8 +61,16 @@ export abstract class BaseCommand extends Command {
 
   finally(arg: Error | undefined): Promise<any> {
     try {
-      // Close the web3 connection or the CLI hangs forever.
+      // If local-signing accounts are added, the debug wrapper is itself wrapped
+      // with a CeloProvider. This class has a stop() function that handles closing
+      // the connection for underlying providers
+      if (this.web3.currentProvider instanceof CeloProvider) {
+        const celoProvider = this.web3.currentProvider as CeloProvider
+        celoProvider.stop()
+      }
+
       if (this._originalProvider && this._originalProvider.hasOwnProperty('connection')) {
+        // Close the web3 connection or the CLI hangs forever.
         const connection = this._originalProvider.connection
         if (connection.hasOwnProperty('_connection')) {
           connection._connection.close()

packages/cli/src/commands/localaccounts/add.ts

@@ -0,0 +1,31 @@
+import { cli } from 'cli-ux'
+import * as fs from 'fs-extra'
+// import * as path from 'path'
+import { BaseCommand } from '../../base'
+import { addPrivateKeyToConfig } from '../../utils/local_accounts'
+
+export default class AddLocalAccount extends BaseCommand {
+  static description = 'Add a private key to locally sign transactions from an account'
+
+  static args = [
+    {
+      name: 'keyPath',
+      required: true,
+      description: 'Private key to add',
+    },
+  ]
+
+  async run() {
+    const res = this.parse(AddLocalAccount)
+    try {
+      const absolutePath = fs.realpathSync(res.args.keyPath)
+      const key = fs.readFileSync(absolutePath).toString()
+      this.kit.addAccount(key)
+
+      addPrivateKeyToConfig(this.config.configDir, absolutePath)
+    } catch (error) {
+      cli.info('Failed to add private key')
+      cli.error(error)
+    }
+  }
+}

packages/cli/src/commands/oracle/rates.ts

@@ -0,0 +1,33 @@
+import { CeloContract } from '@celo/contractkit'
+import { cli } from 'cli-ux'
+import { BaseCommand } from '../../base'
+
+export default class GetRates extends BaseCommand {
+  static description = 'Get the current set oracle-reported rates for the given token'
+
+  static flags = {
+    ...BaseCommand.flags,
+  }
+
+  static args = [
+    {
+      name: 'token',
+      required: true,
+      description: 'Token to get the rates for',
+      options: [CeloContract.StableToken],
+    },
+  ]
+
+  static example = ['rates StableToken']
+
+  async run() {
+    const res = this.parse(GetRates)
+    const sortedOracles = await this.kit.contracts.getSortedOracles()
+
+    const rates = await sortedOracles.getRates(res.args.token)
+    cli.table(rates, {
+      address: {},
+      rate: { get: (r) => r.rate.toNumber() },
+    })
+  }
+}

packages/cli/src/commands/oracle/report.ts

@@ -0,0 +1,64 @@
+import { CeloContract } from '@celo/contractkit'
+import { flags } from '@oclif/command'
+import BigNumber from 'bignumber.js'
+import { BaseCommand } from '../../base'
+import { displaySendTx } from '../../utils/cli'
+import { Flags } from '../../utils/command'
+
+export default class ReportPrice extends BaseCommand {
+  static description =
+    'Report the price of Celo Gold in a specified token (currently just Celo Dollar, aka: "StableToken")'
+
+  static args = [
+    {
+      name: 'token',
+      required: true,
+      description: 'Token to report on',
+      options: [CeloContract.StableToken],
+    },
+  ]
+  static flags = {
+    ...BaseCommand.flags,
+    from: Flags.address({ required: true, description: 'Address of the oracle account' }),
+    numerator: flags.string({
+      required: true,
+      description: 'Amount of the specified token equal to the amount of cGLD in the denominator',
+    }),
+    denominator: flags.string({
+      required: false,
+      description: 'Amount of cGLD equal to the numerator. Defaults to 1 if left blank',
+    }),
+  }
+
+  static example = [
+    'report --token StableToken --numerator 1.02 --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1',
+    'report --token StableToken --numerator 102 --denominator 100 --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1',
+  ]
+
+  async run() {
+    const res = this.parse(ReportPrice)
+    const sortedOracles = await this.kit.contracts.getSortedOracles()
+    let numerator = new BigNumber(res.flags.numerator)
+    let denominator = new BigNumber(res.flags.denominator || 1)
+    if (numerator.decimalPlaces() > 0) {
+      const multiplier = new BigNumber(10).pow(numerator.decimalPlaces()).toNumber()
+      numerator = numerator.multipliedBy(multiplier)
+      denominator = denominator.multipliedBy(multiplier)
+    }
+
+    await displaySendTx(
+      'sortedOracles.report',
+      await sortedOracles.report(
+        res.args.token,
+        numerator.toNumber(),
+        denominator.toNumber(),
+        res.flags.from
+      )
+    )
+    this.log(
+      `Reported oracle value of ${numerator.div(denominator).toNumber()} ${
+        res.args.token
+      } for 1 CeloGold`
+    )
+  }
+}

packages/cli/src/utils/local_accounts.ts

@@ -0,0 +1,42 @@
+import { ContractKit } from '@celo/contractkit'
+import * as fs from 'fs-extra'
+import * as path from 'path'
+
+export interface CeloLocalKeys {
+  files: string[]
+}
+
+const keyFileList = 'keys.json'
+
+export const defaultKeyList: CeloLocalKeys = {
+  files: [],
+}
+
+export function keyListPath(configDir: string) {
+  return path.join(configDir, keyFileList)
+}
+
+export function addKeysToKit(kit: ContractKit, configDir: string) {
+  const keyPaths = readKeyList(configDir)
+
+  for (const kp of keyPaths.files) {
+    if (fs.pathExistsSync(kp)) {
+      kit.addAccount(fs.readFileSync(kp).toString())
+    } else {
+      console.error(`no key found at ${kp}, skipping...`)
+    }
+  }
+}
+
+export function readKeyList(configDir: string): CeloLocalKeys {
+  if (fs.pathExistsSync(keyListPath(configDir))) {
+    return fs.readJSONSync(keyListPath(configDir))
+  } else {
+    return defaultKeyList
+  }
+}
+
+export function addPrivateKeyToConfig(configDir: string, keyPath: string) {
+  const existingFiles = readKeyList(configDir).files
+  fs.writeJSONSync(keyListPath(configDir), { files: existingFiles.concat(keyPath) })
+}

packages/contractkit/src/index.ts

@@ -3,6 +3,7 @@ import Web3 from 'web3'
 export { Address, AllContracts, CeloContract, CeloToken, NULL_ADDRESS } from './base'
 export { IdentityMetadataWrapper } from './identity'
 export * from './kit'
+export { CeloProvider } from './providers/celo-provider'
 export { CeloTransactionObject } from './wrappers/BaseWrapper'
 
 /**

packages/docs/command-line-interface/localaccounts.md

@@ -0,0 +1,19 @@
+---
+description: Add a private key to locally sign transactions from an account
+---
+
+## Commands
+
+### Add
+
+Add a private key to locally sign transactions from an account
+
+```
+USAGE
+  $ celocli localaccounts:add KEYPATH
+
+ARGUMENTS
+  KEYPATH  Private key to add
+```
+
+_See code: [packages/cli/src/commands/localaccounts/add.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/localaccounts/add.ts)_