Add ERC20 token with snapshoting mechanism (#1209)

.eslintrc

@@ -25,7 +25,7 @@
 
     // Code style
     "camelcase": ["error", {"properties": "always"}],
-    "comma-dangle": ["warn", "always-multiline"],
+    "comma-dangle": ["error", "always-multiline"],
     "comma-spacing": ["error", {"before": false, "after": true}],
     "dot-notation": ["error", {"allowKeywords": true, "allowPattern": ""}],
     "eol-last": ["error", "always"],

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Bug report
+about: Report a bug in OpenZeppelin
+
+---
+
+<!-- Briefly describe the issue you're experiencing. Tell us what you were trying to do and what happened instead. -->
+
+<!-- Remember, this is not a place to ask for help debugging code. For that, we welcome you in the OpenZeppelin Slack channel: https://slack.openzeppelin.org/. -->
+
+**💻 Environment**
+
+<!-- Tell us what version of OpenZeppelin you're using, and how you're using it: Truffle, Remix, etc. -->
+
+**📝 Details**
+
+<!-- Describe the problem you have been experiencing in more detail. Include as much information as you think is relevant. Keep in mind that transactions can fail for many reasons; context is key here. -->
+
+**🔢 Code to reproduce bug**
+
+<!-- We will be able to better help if you provide a minimal example that triggers the bug. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for OpenZeppelin
+
+---
+
+**🧐 Motivation**
+<!-- Is your feature request related to a specific problem? Is it just a crazy idea? Tell us about it! -->
+
+**📝 Details**
+<!-- Please describe your feature request in detail. -->
+
+<!-- Make sure that you have reviewed the OpenZeppelin Contributor Guidelines. -->
+<!-- https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/CONTRIBUTING.md -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +1,20 @@
 <!-- 0. 🎉 Thank you for submitting a PR! -->
 
-<!-- 1. **Does this close any open issues?** If so, list them here. If not, remove the `Fixes #` line. -->
+<!-- 1. Does this close any open issues? Please list them below. -->
 
-Fixes #
+<!-- Keep in mind that new features have a better chance of being merged fast if
+they were first discussed and designed with the maintainers. If there is no
+corresponding issue, please consider opening one for discussion first! -->
 
-# 🚀 Description
+Fixes #
 
-<!-- 2. Describe the changes introduced in this pull request -->
+<!-- 2. Describe the changes introduced in this pull request. -->
 <!--    Include any context necessary for understanding the PR's purpose. -->
 
-<!-- 3. Before submitting, please review the following checklist: -->
-
-- [ ] 📘 I've reviewed the [OpenZeppelin Contributor Guidelines](../blob/master/CONTRIBUTING.md)
-- [ ] ✅ I've added tests where applicable to test my new functionality.
-- [ ] 📖 I've made sure that my contracts are well-documented.
-- [ ] 🎨 I've run the JS/Solidity linters and fixed any issues (`npm run lint:fix`).
+<!-- 3. Before submitting, please make sure that you have:
+  - reviewed the OpenZeppelin Contributor Guidelines
+    (https://github.com/OpenZeppelin/openzeppelin-solidity/blob/master/CONTRIBUTING.md),
+  - added tests where applicable to test new functionality,
+  - made sure that your contracts are well-documented, and
+  - run the JS/Solidity linters and fixed any issues (`npm run lint:fix`).
+-->

RELEASING.md

@@ -34,6 +34,12 @@ git push upstream vX.Y.Z-rc.R
 
 Draft the release notes in our [GitHub releases](https://github.com/OpenZeppelin/openzeppelin-solidity/releases). Make sure to mark it as a pre-release! Try to be consistent with our previous release notes in the title and format of the text. Release candidates don't need a detailed changelog, but make sure to include a link to GitHub's compare page.
 
+Before publishing on npm you need to generate the build artifacts. This is not done automatically at the moment because of a bug in Truffle. Since some of the contracts should not be included in the package, this is a _hairy_ process that you need to do with care.
+
+1. Delete the `contracts/mocks` and `contracts/examples` directories.
+2. Run `truffle compile`. (Note that the Truffle process may never exit and you will have to interrupt it.)
+3. Recover the directories using `git checkout`. It doesn't matter if you do this now or later.
+
 Once the CI run for the new tag is green, publish on npm under the `next` tag.
 
 ```
@@ -62,6 +68,12 @@ git push upstream vX.Y.Z
 
 Draft the release notes in GitHub releases. Try to be consistent with our previous release notes in the title and format of the text. Make sure to include a detailed changelog.
 
+Before publishing on npm you need to generate the build artifacts. This is not done automatically at the moment because of a bug in Truffle. Since some of the contracts should not be included in the package, this is a _hairy_ process that you need to do with care.
+
+1. Delete the `contracts/mocks` and `contracts/examples` directories.
+2. Run `truffle compile`. (Note that the Truffle process may never exit and you will have to interrupt it.)
+3. Recover the directories using `git checkout`. It doesn't matter if you do this now or later.
+
 Once the CI run for the new tag is green, publish on npm.
 
 ```

contracts/access/roles/CapperRole.sol

@@ -11,7 +11,7 @@ contract CapperRole {
   Roles.Role private cappers;
 
   constructor() public {
-    cappers.add(msg.sender);
+    _addCapper(msg.sender);
   }
 
   modifier onlyCapper() {
@@ -24,12 +24,16 @@ contract CapperRole {
   }
 
   function addCapper(address account) public onlyCapper {
-    cappers.add(account);
-    emit CapperAdded(account);
+    _addCapper(account);
   }
 
   function renounceCapper() public {
-    cappers.remove(msg.sender);
+    _removeCapper(msg.sender);
+  }
+
+  function _addCapper(address account) internal {
+    cappers.add(account);
+    emit CapperAdded(account);
   }
 
   function _removeCapper(address account) internal {

contracts/access/roles/MinterRole.sol

@@ -11,7 +11,7 @@ contract MinterRole {
   Roles.Role private minters;
 
   constructor() public {
-    minters.add(msg.sender);
+    _addMinter(msg.sender);
   }
 
   modifier onlyMinter() {
@@ -24,12 +24,16 @@ contract MinterRole {
   }
 
   function addMinter(address account) public onlyMinter {
-    minters.add(account);
-    emit MinterAdded(account);
+    _addMinter(account);
   }
 
   function renounceMinter() public {
-    minters.remove(msg.sender);
+    _removeMinter(msg.sender);
+  }
+
+  function _addMinter(address account) internal {
+    minters.add(account);
+    emit MinterAdded(account);
   }
 
   function _removeMinter(address account) internal {

contracts/access/roles/PauserRole.sol

@@ -11,7 +11,7 @@ contract PauserRole {
   Roles.Role private pausers;
 
   constructor() public {
-    pausers.add(msg.sender);
+    _addPauser(msg.sender);
   }
 
   modifier onlyPauser() {
@@ -24,12 +24,16 @@ contract PauserRole {
   }
 
   function addPauser(address account) public onlyPauser {
-    pausers.add(account);
-    emit PauserAdded(account);
+    _addPauser(account);
   }
 
   function renouncePauser() public {
-    pausers.remove(msg.sender);
+    _removePauser(msg.sender);
+  }
+
+  function _addPauser(address account) internal {
+    pausers.add(account);
+    emit PauserAdded(account);
   }
 
   function _removePauser(address account) internal {

contracts/access/roles/SignerRole.sol

@@ -11,7 +11,7 @@ contract SignerRole {
   Roles.Role private signers;
 
   constructor() public {
-    signers.add(msg.sender);
+    _addSigner(msg.sender);
   }
 
   modifier onlySigner() {
@@ -24,12 +24,16 @@ contract SignerRole {
   }
 
   function addSigner(address account) public onlySigner {
-    signers.add(account);
-    emit SignerAdded(account);
+    _addSigner(account);
   }
 
   function renounceSigner() public {
-    signers.remove(msg.sender);
+    _removeSigner(msg.sender);
+  }
+
+  function _addSigner(address account) internal {
+    signers.add(account);
+    emit SignerAdded(account);
   }
 
   function _removeSigner(address account) internal {

contracts/bounties/BreakInvariantBounty.sol

@@ -8,24 +8,29 @@ import "../ownership/Ownable.sol";
  * @dev This bounty will pay out to a researcher if they break invariant logic of the contract.
  */
 contract BreakInvariantBounty is PullPayment, Ownable {
-  bool private _claimed;
+  bool private _claimable;
   mapping(address => address) private _researchers;
 
   event TargetCreated(address createdAddress);
+  event BountyCanceled();
+
+  constructor() public {
+    _claimable = true;
+  }
 
   /**
    * @dev Fallback function allowing the contract to receive funds, if they haven't already been claimed.
    */
   function() external payable {
-    require(!_claimed);
+    require(_claimable);
   }
 
   /**
-   * @dev Determine if the bounty was claimed.
-   * @return true if the bounty was claimed, false otherwise.
+   * @dev Determine if the bounty is claimable.
+   * @return false if the bounty was claimed, true otherwise.
    */
-  function claimed() public view returns(bool) {
-    return _claimed;
+  function claimable() public view returns(bool) {
+    return _claimable;
   }
 
   /**
@@ -45,19 +50,23 @@ contract BreakInvariantBounty is PullPayment, Ownable {
    * @param target contract
    */
   function claim(Target target) public {
+    require(_claimable);
     address researcher = _researchers[target];
     require(researcher != address(0));
     // Check Target contract invariants
     require(!target.checkInvariant());
     _asyncTransfer(researcher, address(this).balance);
-    _claimed = true;
+    _claimable = false;
   }
 
   /**
-   * @dev Transfers the current balance to the owner and terminates the contract.
+   * @dev Cancels the bounty and transfers all funds to the owner
    */
-  function destroy() public onlyOwner {
-    selfdestruct(owner());
+  function cancelBounty() public onlyOwner{
+    require(_claimable);
+    _asyncTransfer(owner(), address(this).balance);
+    _claimable = false;
+    emit BountyCanceled();
   }
 
   /**

contracts/mocks/ArraysImpl.sol

@@ -0,0 +1,18 @@
+pragma solidity ^0.4.24;
+
+import "../utils/Arrays.sol";
+
+contract ArraysImpl {
+
+  using Arrays for uint256[];
+
+  uint256[] private array;
+
+  constructor(uint256[] _array) public {
+    array = _array;
+  }
+
+  function findUpperBound(uint256 _element) external view returns (uint256) {
+    return array.findUpperBound(_element);
+  }
+}

contracts/mocks/SecureInvariantTargetBounty.sol → contracts/mocks/BreakInvariantBountyMock.sol

@@ -5,14 +5,24 @@ pragma solidity ^0.4.24;
 // solium-disable-next-line max-len
 import {BreakInvariantBounty, Target} from "../bounties/BreakInvariantBounty.sol";
 
-contract SecureInvariantTargetMock is Target {
-  function checkInvariant() public returns(bool) {
+contract TargetMock is Target {
+  bool private exploited;
+
+  function exploitVulnerability() public {
+    exploited = true;
+  }
+
+  function checkInvariant() public returns (bool) {
+    if (exploited) {
+      return false;
+    }
+
     return true;
   }
 }
 
-contract SecureInvariantTargetBounty is BreakInvariantBounty {
+contract BreakInvariantBountyMock is BreakInvariantBounty {
   function _deployContract() internal returns (address) {
-    return new SecureInvariantTargetMock();
+    return new TargetMock();
   }
 }

contracts/mocks/ERC20SnapshotMock.sol

@@ -0,0 +1,19 @@
+pragma solidity ^0.4.24;
+
+import "../token/ERC20/ERC20Snapshot.sol";
+
+
+contract ERC20SnapshotMock is ERC20Snapshot {
+
+  constructor(address initialAccount, uint256 initialBalance) public {
+    _mint(initialAccount, initialBalance);
+  }
+
+  function mint(address account, uint256 amount) public {
+    _mint(account, amount);
+  }
+
+  function burn(address account, uint256 amount) public {
+    _burn(account, amount);
+  }
+}