cREAL contract release

.circleci/config.yml

@@ -34,7 +34,7 @@ defaults: &defaults
 contract-defaults: &contract-defaults
   <<: *defaults
   environment:
-    RELEASE_TAG: core-contracts.v4
+    RELEASE_TAG: core-contracts.v5
 
 e2e-defaults: &e2e-defaults
   <<: *defaults

packages/protocol/contracts/stability/ExchangeBRL.sol

@@ -0,0 +1,18 @@
+import "./Exchange.sol";
+
+contract ExchangeBRL is Exchange {
+  /**
+       * @notice Sets initialized == true on implementation contracts
+     * @param test Set to true to skip implementation initialization
+     */
+  constructor(bool test) public Exchange(test) {}
+
+  /**
+  * @notice Returns the storage, major, minor, and patch version of the contract.
+* @dev This function is overloaded to maintain a distinct version from Exchange.sol.
+* @return The storage, major, minor, and patch version of the contract.
+*/
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 0, 0);
+  }
+}

packages/protocol/contracts/stability/StableTokenBRL.sol

@@ -0,0 +1,20 @@
+pragma solidity ^0.5.13;
+
+import "./StableToken.sol";
+
+contract StableTokenBRL is StableToken {
+  /**
+       * @notice Sets initialized == true on implementation contracts.
+     * @param test Set to true to skip implementation initialization.
+     */
+  constructor(bool test) public StableToken(test) {}
+
+  /**
+      * @notice Returns the storage, major, minor, and patch version of the contract.
+    * @dev This function is overloaded to maintain a distinct version from StableToken.sol.
+    * @return The storage, major, minor, and patch version of the contract.
+    */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 0, 0);
+  }
+}

packages/protocol/contracts/stability/proxies/ExchangeBRLProxy.sol

@@ -0,0 +1,6 @@
+pragma solidity ^0.5.13;
+
+import "../../common/Proxy.sol";
+
+/* solhint-disable no-empty-blocks */
+contract ExchangeBRLProxy is Proxy {}

packages/protocol/contracts/stability/proxies/StableTokenBRLProxy.sol

@@ -0,0 +1,6 @@
+pragma solidity ^0.5.13;
+
+import "../../common/Proxy.sol";
+
+/* solhint-disable no-empty-blocks */
+contract StableTokenBRLProxy is Proxy {}

packages/protocol/governanceConstitution.js

@@ -62,6 +62,15 @@ const DefaultConstitution = {
     setSpread: 0.8,
     setReserveFraction: 0.8,
   },
+  ExchangeBRL: {
+    default: 0.8,
+    setRegistry: 0.9,
+    setUpdateFrequency: 0.8,
+    setMinimumReports: 0.8,
+    setStableToken: 0.8,
+    setSpread: 0.8,
+    setReserveFraction: 0.8,
+  },
   FeeCurrencyWhitelist: {
     default: 0.8,
     addToken: 0.8,
@@ -171,6 +180,14 @@ const DefaultConstitution = {
     transferWithComment: 0.6,
     approve: 0.6,
   },
+  StableTokenBRL: {
+    default: 0.8,
+    setRegistry: 0.9,
+    setInflationParameters: 0.9,
+    transfer: 0.6,
+    transferWithComment: 0.6,
+    approve: 0.6,
+  },
   Validators: {
     default: 0.7,
     setRegistry: 0.9,

packages/protocol/lib/registry-utils.ts

@@ -19,6 +19,7 @@ export enum CeloContractName {
   Escrow = 'Escrow',
   Exchange = 'Exchange',
   ExchangeEUR = 'ExchangeEUR',
+  ExchangeBRL = 'ExchangeBRL',
   FeeCurrencyWhitelist = 'FeeCurrencyWhitelist',
   Freezer = 'Freezer',
   GasPriceMinimum = 'GasPriceMinimum',
@@ -34,6 +35,7 @@ export enum CeloContractName {
   SortedOracles = 'SortedOracles',
   StableToken = 'StableToken',
   StableTokenEUR = 'StableTokenEUR',
+  StableTokenBRL = 'StableTokenBRL',
   TransferWhitelist = 'TransferWhitelist',
   Validators = 'Validators',
 }

packages/protocol/migrations/09_2_stableToken_BRL.ts

@@ -0,0 +1,92 @@
+/* tslint:disable:no-console */
+import { ensureLeading0x, eqAddress, NULL_ADDRESS } from '@celo/base/lib/address'
+import { CeloContractName } from '@celo/protocol/lib/registry-utils'
+import {
+  deploymentForCoreContract,
+  getDeployedProxiedContract,
+} from '@celo/protocol/lib/web3-utils'
+import { config } from '@celo/protocol/migrationsConfig'
+import { toFixed } from '@celo/utils/lib/fixidity'
+import {
+  FeeCurrencyWhitelistInstance,
+  FreezerInstance,
+  ReserveInstance,
+  SortedOraclesInstance,
+  StableTokenBRLInstance,
+} from 'types'
+import Web3 from 'web3'
+
+const truffle = require('@celo/protocol/truffle-config.js')
+
+const initializeArgs = async (): Promise<any[]> => {
+  const rate = toFixed(config.stableTokenBRL.inflationRate)
+  return [
+    config.stableTokenBRL.tokenName,
+    config.stableTokenBRL.tokenSymbol,
+    config.stableTokenBRL.decimals,
+    config.registry.predeployedProxyAddress,
+    rate.toString(),
+    config.stableTokenBRL.inflationPeriod,
+    config.stableTokenBRL.initialBalances.addresses,
+    config.stableTokenBRL.initialBalances.values,
+    'ExchangeBRL',
+  ]
+}
+
+// TODO make this general
+module.exports = deploymentForCoreContract<StableTokenBRLInstance>(
+  web3,
+  artifacts,
+  CeloContractName.StableTokenBRL,
+  initializeArgs,
+  async (stableToken: StableTokenBRLInstance, _web3: Web3, networkName: string) => {
+    if (config.stableTokenBRL.frozen) {
+      const freezer: FreezerInstance = await getDeployedProxiedContract<FreezerInstance>(
+        'Freezer',
+        artifacts
+      )
+      await freezer.freeze(stableToken.address)
+    }
+    const sortedOracles: SortedOraclesInstance = await getDeployedProxiedContract<SortedOraclesInstance>(
+      'SortedOracles',
+      artifacts
+    )
+
+    for (const oracle of config.stableTokenBRL.oracles) {
+      console.info(`Adding ${oracle} as an Oracle for StableToken (BRL)`)
+      await sortedOracles.addOracle(stableToken.address, ensureLeading0x(oracle))
+    }
+
+    const goldPrice = config.stableTokenBRL.goldPrice
+    if (goldPrice) {
+      const fromAddress = truffle.networks[networkName].from
+      const isOracle = config.stableTokenBRL.oracles.some((o) => eqAddress(o, fromAddress))
+      if (!isOracle) {
+        console.warn(
+          `Gold price specified in migration but ${fromAddress} not explicitly authorized as oracle, authorizing...`
+        )
+        await sortedOracles.addOracle(stableToken.address, ensureLeading0x(fromAddress))
+      }
+      console.info('Reporting price of StableToken (BRL) to oracle')
+      await sortedOracles.report(
+        stableToken.address,
+        toFixed(goldPrice),
+        NULL_ADDRESS,
+        NULL_ADDRESS
+      )
+      const reserve: ReserveInstance = await getDeployedProxiedContract<ReserveInstance>(
+        'Reserve',
+        artifacts
+      )
+      console.info('Adding StableToken (BRL) to Reserve')
+      await reserve.addToken(stableToken.address)
+    }
+
+    console.info('Whitelisting StableToken (BRL) as a fee currency')
+    const feeCurrencyWhitelist: FeeCurrencyWhitelistInstance = await getDeployedProxiedContract<FeeCurrencyWhitelistInstance>(
+      'FeeCurrencyWhitelist',
+      artifacts
+    )
+    await feeCurrencyWhitelist.addToken(stableToken.address)
+  }
+)

packages/protocol/migrations/10_2_exchange_BRL.ts

@@ -0,0 +1,53 @@
+/* tslint:disable:no-console */
+
+import { CeloContractName } from '@celo/protocol/lib/registry-utils'
+import {
+  deploymentForCoreContract,
+  getDeployedProxiedContract,
+} from '@celo/protocol/lib/web3-utils'
+import { config } from '@celo/protocol/migrationsConfig'
+import { toFixed } from '@celo/utils/lib/fixidity'
+import {
+  ExchangeBRLInstance,
+  FreezerInstance,
+  ReserveInstance,
+  StableTokenBRLInstance,
+} from 'types'
+
+const initializeArgs = async (): Promise<any[]> => {
+  const stableTokenBRL: StableTokenBRLInstance = await getDeployedProxiedContract<StableTokenBRLInstance>(
+    'StableTokenBRL',
+    artifacts
+  )
+  return [
+    config.registry.predeployedProxyAddress,
+    stableTokenBRL.address,
+    toFixed(config.exchange.spread).toString(),
+    toFixed(config.exchange.reserveFraction).toString(),
+    config.exchange.updateFrequency,
+    config.exchange.minimumReports,
+  ]
+}
+
+module.exports = deploymentForCoreContract<ExchangeBRLInstance>(
+  web3,
+  artifacts,
+  CeloContractName.ExchangeBRL,
+  initializeArgs,
+  async (exchange: ExchangeBRLInstance) => {
+    if (config.exchange.frozen) {
+      const freezer: FreezerInstance = await getDeployedProxiedContract<FreezerInstance>(
+        'Freezer',
+        artifacts
+      )
+      await freezer.freeze(exchange.address)
+    }
+
+    const reserve: ReserveInstance = await getDeployedProxiedContract<ReserveInstance>(
+      'Reserve',
+      artifacts
+    )
+    // cUSD doesn't need to be added as it currently harcoded in Reserve.sol
+    await reserve.addExchangeSpender(exchange.address)
+  }
+)

packages/protocol/migrationsConfig.js

@@ -182,6 +182,20 @@ const DefaultConfig = {
     oracles: [network.from],
     frozen: false,
   },
+  stableTokenBRL: {
+    decimals: 18,
+    goldPrice: 1.2,
+    tokenName: 'Celo Euro',
+    tokenSymbol: 'cEUR',
+    inflationRate: 1,
+    inflationPeriod: 1.5 * YEAR,
+    initialBalances: {
+      addresses: [network.from],
+      values: ['5000000000000000000000000'],
+    },
+    oracles: [network.from],
+    frozen: false,
+  },
   transferWhitelist: {
     addresses: [],
     registryIds: [],

packages/protocol/releaseData/initializationData/release6.json

@@ -0,0 +1,4 @@
+{
+  "StableTokenBRL": ["Celo Brazilian Real", "cREAL", 18, "0x000000000000000000000000000000000000ce10", "1000000000000000000000000", "47304000", ["0xD533Ca259b330c7A88f74E000a3FaEa2d63B7972", "0x989e1a3B344A43911e02cCC609D469fbc15AB1F1"], ["2000000000000000000000000", "6000000000000000000000000"], "ExchangeBRL"],
+  "ExchangeBRL": ["0x000000000000000000000000000000000000ce10", "0x0000000000000000000000000000000000000000", "2500000000000000000000", "1300000000000000000000", "300", "5"]
+}

packages/protocol/releaseData/versionReports/release5-report.json

@@ -0,0 +1,105 @@
+{
+  "oldArtifactsFolder": "/home/circleci/app/packages/protocol/build/core-contracts.v4/contracts",
+  "newArtifactsFolder": "/home/circleci/app/packages/protocol/build/core-contracts.v5/contracts",
+  "exclude": "/.*Test|Mock.*|I[A-Z].*|.*Proxy|MultiSig.*|ReleaseGold|SlasherUtil|UsingPrecompiles/",
+  "report": {
+    "contracts": {
+      "GrandaMento": {
+        "changes": {
+          "storage": [],
+          "major": [
+            {
+              "contract": "GrandaMento",
+              "type": "NewContract"
+            }
+          ],
+          "minor": [],
+          "patch": []
+        },
+        "versionDelta": {
+          "storage": "=",
+          "major": "+1",
+          "minor": "0",
+          "patch": "0"
+        }
+      },
+      "UsingRegistryV2": {
+        "changes": {
+          "storage": [],
+          "major": [
+            {
+              "contract": "UsingRegistryV2",
+              "type": "NewContract"
+            }
+          ],
+          "minor": [],
+          "patch": []
+        },
+        "versionDelta": {
+          "storage": "=",
+          "major": "+1",
+          "minor": "0",
+          "patch": "0"
+        }
+      },
+      "StableToken": {
+        "changes": {
+          "storage": [],
+          "major": [],
+          "minor": [],
+          "patch": [
+            {
+              "contract": "StableToken",
+              "type": "DeployedBytecode"
+            }
+          ]
+        },
+        "versionDelta": {
+          "storage": "=",
+          "major": "=",
+          "minor": "=",
+          "patch": "+1"
+        }
+      },
+      "StableTokenEUR": {
+        "changes": {
+          "storage": [],
+          "major": [],
+          "minor": [],
+          "patch": [
+            {
+              "contract": "StableTokenEUR",
+              "type": "DeployedBytecode"
+            }
+          ]
+        },
+        "versionDelta": {
+          "storage": "=",
+          "major": "=",
+          "minor": "=",
+          "patch": "+1"
+        }
+      },
+      "Validators": {
+        "changes": {
+          "storage": [],
+          "major": [],
+          "minor": [],
+          "patch": [
+            {
+              "contract": "Validators",
+              "type": "DeployedBytecode"
+            }
+          ]
+        },
+        "versionDelta": {
+          "storage": "=",
+          "major": "=",
+          "minor": "=",
+          "patch": "+1"
+        }
+      }
+    },
+    "libraries": {}
+  }
+}