Merge pull request #37 from akropolisio/add-mint-started

Add mintStarted method

Author: in19farkt

.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.231.5/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g ganache" 2>&1

.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.231.5/containers/python-3
+{
+  "name": "Python 3",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": "..",
+    "args": {
+      // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+      // Append -bullseye or -buster to pin to an OS version.
+      // Use -bullseye variants on local on arm64/Apple Silicon.
+      "VARIANT": "3.8",
+      // Options
+      "NODE_VERSION": "10"
+    }
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "python.defaultInterpreterPath": "/usr/local/bin/python",
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
+    "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+    "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+    "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+    "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+    "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+    "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+    "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+    "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+    "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+  },
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "streetsidesoftware.code-spell-checker",
+    "esbenp.prettier-vscode",
+    "juanblanco.solidity"
+  ],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "git config --global url.\"https://github.com/\".insteadOf git://github.com/",
+
+  // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
+}

.example.env

@@ -0,0 +1,3 @@
+INFURA_API_KEY=""
+METAMASK_MNEMONIC=""
+ETHERSCAN_API_KEY=""

README.md

@@ -1,6 +1,74 @@
 # AkropolisToken
-	Mintable, Burnable, Standard ERC20 with ability to upgrade to a more secure Pausable and Lockable ERC20
-	
+
+    Mintable, Burnable, Standard ERC20 with ability to upgrade to a more secure Pausable and Lockable ERC20
+
+## Development
+
+### Clone repository
+
+clone using HTTPS:
+
+```bash
+git clone https://github.com/akropolisio/AkropolisToken.git
+```
+
+change directory:
+
+```bash
+cd AkropolisToken
+```
+
+### Setup environment
+
+#### VSCode + Docker (recommended)
+
+- install [Docker](https://docs.docker.com/get-docker/)
+- install [VSCode](https://code.visualstudio.com/)
+- install [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode extension
+- open cloned repository in VSCode
+- click F1 and run `>Remote-Containers: Reopen in Container`
+- wait until all dependencies are installed (you will see the message "Done. Press any key to close the terminal." in the terminal `Configuring`)
+- install local dependencies:
+  ```bash
+  npm install
+  ```
+
+#### Manual
+
+- you will need Python 3.8 and Node.js v10
+- install Ganache:
+  ```bash
+  npm install -g ganache
+  ```
+- install local dependencies:
+  ```bash
+  npm install
+  ```
+
+### Run tests
+
+#### Default development network
+
+- start Ganache in a separate terminal `ganache`
+- run all tests with `npm run test-all`
+
+#### Mainnet Fork
+
+- start Ganache in a separate terminal `scripts/rpc_fork.sh`
+- run all tests with `npm run test-fork`
+- Ganache will fork from Mainnet starting from a specific block number configured in `scripts/rpc_fork.sh`
+- make sure to restart Ganache before launching tests
+
+### Deployment
+
+- setup .env:
+  - run `cp .example.env .env`
+  - insert keys into `.env`
+- run truffle migrations:
+  - deploy to development `npm run deploy` (make sure Ganache is running)
+  - deploy to live networks `npm run deploy -- --network rinkeby`
+  - to run all migrations from the beginning use `npm run deploy -- --network rinkeby --reset`
+
 MIT License
 
 Copyright (c) 2019 A Labs Ltd.

contracts/token/AkropolisBaseToken.sol

@@ -7,22 +7,31 @@ import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";
 import "../helpers/Ownable.sol";
 
 /**
-* @title AkropolisBaseToken
-* @notice A basic ERC20 token with modular data storage
-*/
+ * @title AkropolisBaseToken
+ * @notice A basic ERC20 token with modular data storage
+ */
 contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
     using SafeMath for uint256;
 
     /** Events */
     event Mint(address indexed to, uint256 value);
     event MintFinished();
+    event MintStarted();
     event Burn(address indexed burner, uint256 value);
     event Transfer(address indexed from, address indexed to, uint256 value);
-    event Approval(address indexed owner, address indexed spender, uint256 value);
-
-
-    constructor (address _balances, address _allowances, string _name, uint8 _decimals, string _symbol) public 
-    TokenStorage(_balances, _allowances, _name, _decimals, _symbol) {}
+    event Approval(
+        address indexed owner,
+        address indexed spender,
+        uint256 value
+    );
+
+    constructor(
+        address _balances,
+        address _allowances,
+        string _name,
+        uint8 _decimals,
+        string _symbol
+    ) public TokenStorage(_balances, _allowances, _name, _decimals, _symbol) {}
 
     /** Modifiers **/
 
@@ -41,7 +50,6 @@ contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
         _burn(msg.sender, _amount);
     }
 
-
     function isMintingFinished() public view returns (bool) {
         bytes32 slot = keccak256(abi.encode("Minting", "mint"));
         uint256 v;
@@ -51,7 +59,6 @@ contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
         return v != 0;
     }
 
-
     function setMintingFinished(bool value) internal {
         bytes32 slot = keccak256(abi.encode("Minting", "mint"));
         uint256 v = value ? 1 : 0;
@@ -65,30 +72,42 @@ contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
         emit MintFinished();
     }
 
+    function mintStarted() public onlyOwner {
+        setMintingFinished(false);
+        emit MintStarted();
+    }
 
-    function approve(address _spender, uint256 _value) 
-    public returns (bool) {
+    function approve(address _spender, uint256 _value) public returns (bool) {
         allowances.setAllowance(msg.sender, _spender, _value);
         emit Approval(msg.sender, _spender, _value);
         return true;
     }
 
     function transfer(address _to, uint256 _amount) public returns (bool) {
-        require(_to != address(0),"to address cannot be 0x0");
-        require(_amount <= balanceOf(msg.sender),"not enough balance to transfer");
+        require(_to != address(0), "to address cannot be 0x0");
+        require(
+            _amount <= balanceOf(msg.sender),
+            "not enough balance to transfer"
+        );
 
         balances.subBalance(msg.sender, _amount);
         balances.addBalance(_to, _amount);
         emit Transfer(msg.sender, _to, _amount);
         return true;
     }
 
-    function transferFrom(address _from, address _to, uint256 _amount) 
-    public returns (bool) {
-        require(_amount <= allowance(_from, msg.sender),"not enough allowance to transfer");
-        require(_to != address(0),"to address cannot be 0x0");
-        require(_amount <= balanceOf(_from),"not enough balance to transfer");
-        
+    function transferFrom(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) public returns (bool) {
+        require(
+            _amount <= allowance(_from, msg.sender),
+            "not enough allowance to transfer"
+        );
+        require(_to != address(0), "to address cannot be 0x0");
+        require(_amount <= balanceOf(_from), "not enough balance to transfer");
+
         allowances.subAllowance(_from, msg.sender, _amount);
         balances.addBalance(_to, _amount);
         balances.subBalance(_from, _amount);
@@ -97,31 +116,34 @@ contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
     }
 
     /**
-    * @notice Implements balanceOf() as specified in the ERC20 standard.
-    */
+     * @notice Implements balanceOf() as specified in the ERC20 standard.
+     */
     function balanceOf(address who) public view returns (uint256) {
         return balances.balanceOf(who);
     }
 
     /**
-    * @notice Implements allowance() as specified in the ERC20 standard.
-    */
-    function allowance(address owner, address spender) public view returns (uint256) {
+     * @notice Implements allowance() as specified in the ERC20 standard.
+     */
+    function allowance(address owner, address spender)
+        public
+        view
+        returns (uint256)
+    {
         return allowances.allowanceOf(owner, spender);
     }
 
     /**
-    * @notice Implements totalSupply() as specified in the ERC20 standard.
-    */
+     * @notice Implements totalSupply() as specified in the ERC20 standard.
+     */
     function totalSupply() public view returns (uint256) {
         return balances.totalSupply();
     }
 
-
     /** Internal functions **/
 
     function _burn(address _tokensOf, uint256 _amount) internal {
-        require(_amount <= balanceOf(_tokensOf),"not enough balance to burn");
+        require(_amount <= balanceOf(_tokensOf), "not enough balance to burn");
         // no need to require value <= totalSupply, since that would imply the
         // sender's balance is greater than the totalSupply, which *should* be an assertion failure
         balances.subBalance(_tokensOf, _amount);
@@ -136,5 +158,4 @@ contract AkropolisBaseToken is ERC20, TokenStorage, Ownable {
         emit Mint(_to, _amount);
         emit Transfer(address(0), _to, _amount);
     }
-
-}
+}

migrations/2_deploy_token_logic.js

@@ -1,8 +1,8 @@
 var AkropolisToken = artifacts.require("./AkropolisToken.sol");
 
-module.exports = function(deployer, network, accounts) {
+module.exports = function (deployer, network, accounts) {
   const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
   let owner = accounts[0];
   console.log('owner of token contracts: ' + owner)
-  deployer.deploy(AkropolisToken, ZERO_ADDRESS, ZERO_ADDRESS, "", 0, "", {from:owner});
+  deployer.deploy(AkropolisToken, ZERO_ADDRESS, ZERO_ADDRESS, "", 0, "", { from: owner });
 };