chore(stuff): added matic-mumbai, review comments

Author: bitbeckers

README.md

@@ -27,6 +27,25 @@ Ganache
 2. Start Ganache on port 8545
 3. In second terminal```npx buidler run --network localhost scripts/deploy.ts  ```
 
+#### Deploying to Matic
+1. ```npm install truffle -g```
+2. ```npm install truffle-flattener -g```
+
+Mumbai Testnet configured in ```./truffle-config.js```
+
+Test deployment using Truffle against a runnning Ganache instance: ```truffle migrate```
+Deploy to Mumbai testnet: ```truffle migrate --network matic```
+
+Verify deployment using contract address at the [Matic Explorer](https://explorer-mumbai.maticvigil.com/)
+
+*Verifying & publishing the contract code*
+In the [Matic Explorer](https://explorer-mumbai.maticvigil.com/) find your contract based on the address reported by Truffle.
+Go to the tab ```Code```
+
+Quite note on setting up Matic:
+* Configure Matic network in [MetaMask](https://docs.matic.network/docs/develop/metamask/config-matic/)
+* Request funds at [faucet](https://faucet.matic.network/)
+* Use this wallet's seed phrase in the .env file to pay the deployment
 
 #### Interacting with the contract
 After deploying to a local node
@@ -37,7 +56,7 @@ After deploying to a local node
 Example for interacting:
 ```await commitPool.withdraw(1000)```
 ## Features
-
+[Technical documentation](https://ipfs.io/ipfs/QmdJsGYi822G1azEMtGL39LRwXZtJRC58KT393TGPixP6z)
 #### Creation of Commitment
 
 A commitment consists of an ```activity```, a ```goalValue``` for given activity, a ```startTime```, and ```stake```. We will automagically set the ```endTime``` 7 days after the startdate.

contracts/Migrations.sol

@@ -0,0 +1,27 @@
+//SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.6.10;
+
+contract Migrations {
+  address public owner;
+
+  // A function with the signature `last_completed_migration()`, returning a uint, is required.
+  uint public last_completed_migration;
+
+  modifier restricted() {
+    if (msg.sender == owner) _;
+  }
+
+  constructor() public {
+    owner = msg.sender;
+  }
+
+  // A function with the signature `setCompleted(uint)` is required.
+  function setCompleted(uint completed) public restricted {
+    last_completed_migration = completed;
+  }
+
+  function upgrade(address new_address) public restricted {
+    Migrations upgraded = Migrations(new_address);
+    upgraded.setCompleted(last_completed_migration);
+  }
+}

contracts/SinglePlayerCommit.sol

@@ -148,7 +148,7 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
             available = available.sub(commitment.stake);
         }
 
-        require(amount >= available, "SPC::withdraw - not enough (unstaked) balance available");
+        require(amount <= available, "SPC::withdraw - not enough (unstaked) balance available");
 
         _changeCommitterBalance(amount, false);
 
@@ -250,12 +250,13 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
     /// @dev Process commitment by lookup based on address, checking metrics, state and updating balances
     function processCommitment(address committer) public {
         console.log("Processing commitment");
+        require(commitments[committer].exists, "SPC::processCommitment - commitment does not exist");
         Commitment storage commitment = commitments[committer];
 
         require(commitment.endTime < block.timestamp, "SPC::processCommitment - commitment is still active");
         require(commitment.endTime < commitment.lastActivityUpdate, "SPC::processCommitment - update activity");
 
-        commitment.met = commitment.reportedValue > commitment.goalValue;
+        commitment.met = commitment.reportedValue >= commitment.goalValue;
 
         if (!commitment.met) {
             _slashFunds(commitment.stake, committer);
@@ -269,6 +270,7 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
     /// @dev Process commitment by lookup msg.sender, checking metrics, state and updating balances
     function processCommitmentUser() public {
         console.log("Processing commitment");
+        require(commitments[msg.sender].exists, "SPC::processCommitmentUser - commitment does not exist");
         Commitment storage commitment = commitments[msg.sender];
 
         commitment.met = commitment.reportedValue > commitment.goalValue;
@@ -289,8 +291,9 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
         console.log("Received call for owner withdrawal for amount %s", amount);
 
         require(amount <= slashedBalance, "SPC::ownerWithdraw - not enough available balance");
+        slashedBalance = slashedBalance.sub(amount);
+
         require(token.transfer(msg.sender, amount), "SPC::ownerWithdraw - token transfer failed");
-        slashedBalance -= amount;
 
         return true;
     }
@@ -318,7 +321,7 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
     function _slashFunds(uint256 amount, address committer) internal returns (bool success) {
         require(committerBalances[committer] >= amount, "SPC::_slashFunds - funds not available");
         _changeCommitterBalance(amount, false);
-        slashedBalance += amount;
+        slashedBalance = slashedBalance.add(amount);
         return true;
     }
 
@@ -337,10 +340,10 @@ contract SinglePlayerCommit is ChainlinkClient, Ownable {
         console.log("All provided activities added");
     }
 
-    /// @notice Add activity to contract's activityList
+    /// @notice Add activity to contract's activityKeyList
     /// @param _activityName String name of activity
     /// @param _oracleAddress Contract address of oracle
-    /// @dev Create key from name, create activity, push to activityList, return key
+    /// @dev Create key from name, create activity, push to activityKeyList, return key
     function _addActivity(string memory _activityName, address _oracleAddress) 
         internal 
         returns (bytes32 activityKey) 

migrations/01_intial_migration.js

@@ -0,0 +1,6 @@
+var Migrations = artifacts.require("Migrations");
+
+module.exports = function(deployer) {
+  // Deploy the Migrations contract as our only task
+  deployer.deploy(Migrations);
+};

migrations/02_intial_release_spc.js

@@ -0,0 +1,9 @@
+const SinglePlayerCommit = artifacts.require("SinglePlayerCommit");
+
+module.exports = function(deployer) {
+  // Deploy the Migrations contract as our only task
+  const activities = ["biking", "cycling"];
+  const oracle = "0x70d1F773A9f81C852087B77F6Ae6d3032B02D2AB";
+  const token = "0xcB1e72786A6eb3b44C2a2429e317c8a2462CFeb1";
+  deployer.deploy(SinglePlayerCommit, activities, oracle, token);
+};