Script to deploy smart contract changes to a network via governance

.circleci/config.yml

@@ -476,7 +476,7 @@ jobs:
             ssh-keyscan github.com >> ~/.ssh/known_hosts
             git fetch --all
             RELEASE_BRANCH=$(git branch -a --list *release/contracts/* | tail -1 | sed -e 's/remotes\/origin\///g')
-            yarn --cwd packages/protocol check-versions -o $RELEASE_BRANCH -n $CIRCLE_BRANCH
+            yarn --cwd packages/protocol check-versions -a $RELEASE_BRANCH -b $CIRCLE_BRANCH
 
             LIBRARIES_CHANGED=$(git diff $RELEASE_BRANCH --name-only packages/protocol/contracts/common/linkedlists)
             if [[ $LIBRARIES_CHANGED ]]; then

packages/contractkit/src/base.ts

@@ -26,29 +26,7 @@ export enum CeloContract {
   Validators = 'Validators',
 }
 
-export const ProxyContracts = [
-  'AccountsProxy',
-  'AttestationsProxy',
-  'BlockchainParametersProxy',
-  'DoubleSigningSlasherProxy',
-  'DowntimeSlasherProxy',
-  'ElectionProxy',
-  'EpochRewardsProxy',
-  'EscrowProxy',
-  'ExchangeProxy',
-  'FeeCurrencyWhitelistProxy',
-  'FreezerProxy',
-  'GasPriceMinimumProxy',
-  'GoldTokenProxy',
-  'GovernanceApproverMultiSigProxy',
-  'GovernanceProxy',
-  'LockedGoldProxy',
-  'ReserveProxy',
-  'ReserveSpenderMultiSigProxy',
-  'StableTokenProxy',
-  'SortedOraclesProxy',
-  'RegistryProxy',
-]
+export const ProxyContracts = Object.keys(CeloContract).map((c) => `${c}Proxy`)
 
 export type CeloToken = CeloContract.GoldToken | CeloContract.StableToken
 

packages/protocol/contracts/common/Accounts.sol

@@ -6,11 +6,19 @@ import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 import "./interfaces/IAccounts.sol";
 
 import "../common/Initializable.sol";
+import "../common/interfaces/ICeloVersionedContract.sol";
 import "../common/Signatures.sol";
 import "../common/UsingRegistry.sol";
 import "../common/libraries/ReentrancyGuard.sol";
 
-contract Accounts is IAccounts, Ownable, ReentrancyGuard, Initializable, UsingRegistry {
+contract Accounts is
+  IAccounts,
+  ICeloVersionedContract,
+  Ownable,
+  ReentrancyGuard,
+  Initializable,
+  UsingRegistry
+{
   using SafeMath for uint256;
 
   struct Signers {
@@ -60,6 +68,14 @@ contract Accounts is IAccounts, Ownable, ReentrancyGuard, Initializable, UsingRe
   event AccountWalletAddressSet(address indexed account, address walletAddress);
   event AccountCreated(address indexed account);
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Used in place of the constructor to allow the contract to be upgradable via proxy.
    * @param registryAddress The address of the registry core smart contract.

packages/protocol/contracts/common/FixidityLib.sol

@@ -17,6 +17,14 @@ library FixidityLib {
     uint256 value;
   }
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Number of positions that the comma is shifted to the right.
    */

packages/protocol/contracts/common/GasPriceMinimum.sol

@@ -5,14 +5,21 @@ import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 
 import "./CalledByVm.sol";
 import "./Initializable.sol";
+import "./interfaces/ICeloVersionedContract.sol";
 import "./FixidityLib.sol";
 import "./UsingRegistry.sol";
 import "../stability/interfaces/ISortedOracles.sol";
 
 /**
  * @title Stores and provides gas price minimum for various currencies.
  */
-contract GasPriceMinimum is Ownable, Initializable, UsingRegistry, CalledByVm {
+contract GasPriceMinimum is
+  ICeloVersionedContract,
+  Ownable,
+  Initializable,
+  UsingRegistry,
+  CalledByVm
+{
   using FixidityLib for FixidityLib.Fraction;
   using SafeMath for uint256;
 
@@ -30,6 +37,14 @@ contract GasPriceMinimum is Ownable, Initializable, UsingRegistry, CalledByVm {
   // Speed of gas price minimum adjustment due to congestion.
   FixidityLib.Fraction public adjustmentSpeed;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Used in place of the constructor to allow the contract to be upgradable via proxy.
    * @param _registryAddress The address of the registry core smart contract.

packages/protocol/contracts/common/Signatures.sol

@@ -3,6 +3,14 @@ pragma solidity ^0.5.3;
 import "openzeppelin-solidity/contracts/cryptography/ECDSA.sol";
 
 library Signatures {
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
   * @notice Given a signed address, returns the signer of the address.
   * @param message The address that was signed.

packages/protocol/contracts/common/linkedlists/AddressLinkedList.sol

@@ -12,6 +12,14 @@ library AddressLinkedList {
   using LinkedList for LinkedList.List;
   using SafeMath for uint256;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   function toBytes(address a) public pure returns (bytes32) {
     return bytes32(uint256(a) << 96);
   }

packages/protocol/contracts/common/linkedlists/AddressSortedLinkedList.sol

@@ -12,6 +12,14 @@ library AddressSortedLinkedList {
   using SafeMath for uint256;
   using SortedLinkedList for SortedLinkedList.List;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   function toBytes(address a) public pure returns (bytes32) {
     return bytes32(uint256(a) << 96);
   }

packages/protocol/contracts/common/linkedlists/AddressSortedLinkedListWithMedian.sol

@@ -11,6 +11,14 @@ library AddressSortedLinkedListWithMedian {
   using SafeMath for uint256;
   using SortedLinkedListWithMedian for SortedLinkedListWithMedian.List;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   function toBytes(address a) public pure returns (bytes32) {
     return bytes32(uint256(a) << 96);
   }

packages/protocol/contracts/common/linkedlists/IntegerSortedLinkedList.sol

@@ -11,6 +11,14 @@ library IntegerSortedLinkedList {
   using SafeMath for uint256;
   using SortedLinkedList for SortedLinkedList.List;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Inserts an element into a doubly linked list.
    * @param list A storage pointer to the underlying list.

packages/protocol/contracts/common/linkedlists/LinkedList.sol

@@ -22,6 +22,14 @@ library LinkedList {
     mapping(bytes32 => Element) elements;
   }
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Inserts an element into a doubly linked list.
    * @param list A storage pointer to the underlying list.

packages/protocol/contracts/common/linkedlists/SortedLinkedList.sol

@@ -15,6 +15,14 @@ library SortedLinkedList {
     mapping(bytes32 => uint256) values;
   }
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Inserts an element into a doubly linked list.
    * @param list A storage pointer to the underlying list.

packages/protocol/contracts/common/linkedlists/SortedLinkedListWithMedian.sol

@@ -21,6 +21,14 @@ library SortedLinkedListWithMedian {
     mapping(bytes32 => MedianRelation) relation;
   }
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Inserts an element into a doubly linked list.
    * @param list A storage pointer to the underlying list.

packages/protocol/contracts/common/proxies/AddressLinkedListProxy.sol

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

packages/protocol/contracts/common/proxies/AddressSortedLinkedListProxy.sol

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

packages/protocol/contracts/common/proxies/AddressSortedLinkedListWithMedianProxy.sol

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

packages/protocol/contracts/common/proxies/FixidityLibProxy.sol

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

packages/protocol/contracts/common/proxies/IntegerSortedLinkedListProxy.sol

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

packages/protocol/contracts/common/proxies/LinkedListProxy.sol

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

packages/protocol/contracts/common/proxies/SignaturesProxy.sol

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

packages/protocol/contracts/common/proxies/SortedLinkedListProxy.sol

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

packages/protocol/contracts/common/proxies/SortedLinkedListWithMedianProxy.sol

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

packages/protocol/contracts/governance/Proposals.sol

@@ -48,6 +48,14 @@ library Proposals {
     string descriptionUrl;
   }
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Constructs a proposal.
    * @param proposal The proposal struct to be constructed.

packages/protocol/contracts/governance/proxies/ProposalsProxy.sol

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

packages/protocol/contracts/identity/Escrow.sol

@@ -7,11 +7,19 @@ import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";
 import "./interfaces/IAttestations.sol";
 import "./interfaces/IEscrow.sol";
 import "../common/Initializable.sol";
+import "../common/interfaces/ICeloVersionedContract.sol";
 import "../common/UsingRegistry.sol";
 import "../common/Signatures.sol";
 import "../common/libraries/ReentrancyGuard.sol";
 
-contract Escrow is IEscrow, ReentrancyGuard, Ownable, Initializable, UsingRegistry {
+contract Escrow is
+  IEscrow,
+  ICeloVersionedContract,
+  ReentrancyGuard,
+  Ownable,
+  Initializable,
+  UsingRegistry
+{
   using SafeMath for uint256;
 
   event Transfer(
@@ -61,6 +69,14 @@ contract Escrow is IEscrow, ReentrancyGuard, Ownable, Initializable, UsingRegist
   // Maps senders' addresses to a list of sent escrowed payment IDs.
   mapping(address => address[]) public sentPaymentIds;
 
+  /**
+   * @notice Returns the storage, major, minor, and patch version of the contract.
+   * @return The storage, major, minor, and patch version of the contract.
+   */
+  function getVersionNumber() external pure returns (uint256, uint256, uint256, uint256) {
+    return (1, 1, 1, 0);
+  }
+
   /**
    * @notice Used in place of the constructor to allow the contract to be upgradable via proxy.
    * @param registryAddress The address of the registry core smart contract.

packages/protocol/contracts/identity/test/TestAttestations.sol → packages/protocol/contracts/identity/test/AttestationsTest.sol

@@ -7,7 +7,7 @@ import "../Attestations.sol";
  * but mocks the implementations of the validator set getters. Otherwise we
  * couldn't test `request` with the current ganache local testnet.
  */
-contract TestAttestations is Attestations {
+contract AttestationsTest is Attestations {
   address[] private __testValidators;
 
   function __setValidators(address[] memory validators) public {

packages/protocol/contracts/identity/test/TestRandom.sol → packages/protocol/contracts/identity/test/RandomTest.sol

@@ -2,7 +2,7 @@ pragma solidity ^0.5.3;
 
 import "../Random.sol";
 
-contract TestRandom is Random {
+contract RandomTest is Random {
   function addTestRandomness(uint256 blockNumber, bytes32 randomness) external {
     addRandomness(blockNumber, randomness);
   }