Merge branch 'v1.2'

Author: kanewallmann

.gitignore

@@ -1,13 +1,6 @@
-app
-bin
-build
-app/config
-node_modules
-scTopics
-coverage.json
-coverage/
-coverageEnv/
+node_modules/
 .vscode
-@openzeppelin
-1.0
-.idea
+.idea/
+cache/
+artifacts/
+.env

.mocharc.json

@@ -0,0 +1,4 @@
+{
+  "require": "hardhat/register",
+  "timeout": 0
+}

.prettierignore

@@ -1,40 +1,79 @@
-# Rocket Pool - Decentralised Ethereum liquid staking protocol
+# Rocket Pool - A next generation Ethereum proof of stake (PoS) infrastructure service and pool
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/logo.png?raw=true" alt="Rocket Pool - Next Generation Decentralised Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool" width="250" />
+  <img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/logo.png?raw=true" alt="Rocket Pool - Next Generation Decentralised Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool" width="500" />
 </p>
 
-Rocket Pool is the base layer protocol for decentralised and trustless ETH staking, both liquid using rETH and node operator staking.
+---
 
-Designed to support stakers of all shapes and sizes, Rocket Pool was built with the intent to allow anyone to trustlessly stake ETH to a network of decentralised node operators with full autonomy using protocol based incentives to make sure all parties work in each others best interests.
+`Rocket Pool` is a first of its kind Ethereum Proof of Stake (PoS) infrastructure service, designed to be highly decentralised, distributed and compatible with staking in Ethereum  2.0 on the beacon chain. It was first conceived in late 2016 and has since had several successful public betas over the life span of ETH2 development. The staking network allows any individual, business, defi dapp, wallet provider, SaaS provider, exchange — just about any service — the ability to provide their users with the option to earn staking rewards on their ETH holdings without worrying about maintaining an extensive staking infrastructure, just plug and play.
 
-The core premise behind a protocol is to ensure the network is not beholden to any one party. This is a principle directly linked to Ethereum itself, and a mindset used at every stage of the process as Rocket Pool was developed.
+Staking with the Rocket Pool network is very flexible and unlike any other staking infrastructure for Ethereum 2.0 to date. When depositing ETH into the Rocket Pool smart contracts, you will be instantly issued a token called rETH which represents a tokenised staking deposit in the network. Its value and the rewards it gains over time will be reflected by the work each individual decentralised node operator gives the Rocket Pool network. Rocket Pool’s unique decentralised staking infrastructure is economically bonded to both be secure and scalable.
 
-Rocket Pool strives to bring staking to the masses and embody the core ethos of Ethereum, DeFi, specifically the non-custodial, trustless nature that allows self-sovereignty to truly thrive in a decentralised ecosystem.
-
-This is why creating the decentralised staking protocol layer for ETH is so important, especially with the vast majority of players either not having the technical skills to run a node, or the financial capacity to own 32 ETH.
+Rocket Pool isn't just a whitepaper, it's actual code. Be sure to read the [Rocket Pool 101 - FAQ for more information](https://medium.com/rocket-pool/rocket-pool-101-faq-ee683af10da9).
 
 # Test Rocket Pool
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/rocket-pool-atlas-test.png?raw=true" alt="Rocket Pool - Testing Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool for Ethereum 2.0 Beacon Chain"/>
+  <img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/rocket-pool-casper-pos-beacon-chain-test.png?raw=true" alt="Rocket Pool - Testing Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool for Ethereum 2.0 Beacon Chain"/>
 </p>
 
-To see Rocket Pool in action, clone the repo and run Ganache with the latest version of truffle installed. A quick and easy way to do this is to use the test script provided with the project:
+To see Rocket Pool in action, clone the repo and run the test suite with the following commands:
 ```bash
-$ npm install && npm test
+$ npm install
+$ npm test
 ```
-This will start a local development node (if not already started) and put Rocket Pool through its paces. * These tests are extensive and can take up to 2-10 mins to run depending on your machines specs *.
+
+# Rocket Pool White Paper
+
+You can read the current Rocket Pool white paper here: [http://www.rocketpool.net/files/RocketPoolWhitePaper.pdf](http://www.rocketpool.net/files/RocketPoolWhitePaper.pdf).
 
 # Contact and Additional Information
 
-Check out [our website](https://www.rocketpool.net) for more information on Rocket Pool.
+Check out [our website](http://www.rocketpool.net) for more information on Rocket Pool.
+
+Contact form: https://www.rocketpool.net/#contact
+
+Twitter: https://twitter.com/Rocket_Pool
 
-Read [our explainer series](https://medium.com/rocket-pool/rocket-pool-staking-protocol-part-1-8be4859e5fbd) for a 1000 foot overview of the protocol.
+Join our Discord chat channel! https://discordapp.com/invite/rocketpool
 
-Read [our docs](https://docs.rocketpool.net) for more technical information on running a node.
+---
 
-Follow us on twitter at [@Rocket_Pool](https://twitter.com/Rocket_Pool)
+# A Step-by-Step Beginners Guide
 
-Join [our Discord chat channel](https://discord.gg/rocketpool)! 
+The following worked example uses macOS Sierra 10.12.6 and VMware Fusion 8.5.8 - all versions correct as of 15/09/2017.
 
+Download and install Ubuntu onto a new VM -> https://www.ubuntu.com/download/desktop - tested with v16.04
+
+Open a terminal window and install some pre-requisites:
+
+install git:
+```bash
+$ sudo apt -y install git
+```
+install curl:  
+```bash
+$ sudo apt -y install curl
+```
+install npm:
+```bash
+$ sudo apt -y install npm
+```
+install node.js:
+```bash
+$ curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
+$ sudo apt-get -y install nodejs
+```
+get rocketpool:
+```bash
+$ git clone https://github.com/rocket-pool/rocketpool
+```
+open the rocketpool directory:
+```bash
+$ cd rocketpool
+```
+install npm packages and run tests:
+```bash
+$ npm install && npm test
+```

.solcover.js

@@ -1,6 +1,5 @@
-pragma solidity 0.7.6;
-
 // SPDX-License-Identifier: GPL-3.0-only
+pragma solidity 0.7.6;
 
 import "@openzeppelin/contracts/math/SafeMath.sol";
 
@@ -9,37 +8,33 @@ import "../../../../interface/dao/node/settings/RocketDAONodeTrustedSettingsMini
 import "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";
 
 
-// The Trusted Node DAO Minipool settings
+/// @notice The Trusted Node DAO Minipool settings
 contract RocketDAONodeTrustedSettingsMinipool is RocketDAONodeTrustedSettings, RocketDAONodeTrustedSettingsMinipoolInterface {
 
     using SafeMath for uint;
 
-    // Construct
     constructor(RocketStorageInterface _rocketStorageAddress) RocketDAONodeTrustedSettings(_rocketStorageAddress, "minipool") {
         // Set version
-        version = 1;
+        version = 2;
 
         // If deployed during initial deployment, initialise now (otherwise must be called after upgrade)
-        if (!_rocketStorageAddress.getDeployedStatus()){
-            initialise();
+        if (!getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")))) {
+            // Init settings
+            setSettingUint("minipool.scrub.period", 12 hours);
+            setSettingUint("minipool.promotion.scrub.period", 3 days);
+            setSettingUint("minipool.scrub.quorum", 0.51 ether);
+            setSettingBool("minipool.scrub.penalty.enabled", false);
+            setSettingUint("minipool.bond.reduction.window.start", 2 days);
+            setSettingUint("minipool.bond.reduction.window.length", 2 days);
+            setSettingUint("minipool.cancel.bond.reduction.quorum", 0.51 ether);
+            // Settings initialised
+            setBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")), true);
         }
     }
 
-
-    // Initialise
-    function initialise() public {
-        // Initialize settings on deployment
-        require(!getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed"))), "Already initialised");
-        // Init settings
-        setSettingUint("minipool.scrub.period", 12 hours);
-        setSettingUint("minipool.scrub.quorum", 0.51 ether);
-        setSettingBool("minipool.scrub.penalty.enabled", false);
-        // Settings initialised
-        setBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")), true);
-    }
-
-
-    // Update a setting, overrides inherited setting method with extra checks for this contract
+    /// @notice Update a setting, overrides inherited setting method with extra checks for this contract
+    /// @param _settingPath The path of the setting within this contract's namespace
+    /// @param _value The value to set it to
     function setSettingUint(string memory _settingPath, uint256 _value) override public onlyDAONodeTrustedProposal {
         // Some safety guards for certain settings
         if(getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")))) {
@@ -54,18 +49,45 @@ contract RocketDAONodeTrustedSettingsMinipool is RocketDAONodeTrustedSettings, R
 
     // Getters
 
-    // How long minipools must wait before moving to staking status (can be scrubbed by ODAO before then)
+    /// @notice How long minipools must wait before moving to staking status (can be scrubbed by ODAO before then)
     function getScrubPeriod() override external view returns (uint256) {
         return getSettingUint("minipool.scrub.period");
     }
 
-    // The required number of trusted nodes to vote to scrub a minipool
+    /// @notice How long minipools must wait before promoting a vacant minipool to staking status (can be scrubbed by ODAO before then)
+    function getPromotionScrubPeriod() override external view returns (uint256) {
+        return getSettingUint("minipool.promotion.scrub.period");
+    }
+
+    /// @notice Returns the required number of trusted nodes to vote to scrub a minipool
     function getScrubQuorum() override external view returns (uint256) {
         return getSettingUint("minipool.scrub.quorum");
     }
 
-    // True if scrubbing results in an RPL penalty for the node operator
+    /// @notice Returns the required number of trusted nodes to vote to cancel a bond reduction
+    function getCancelBondReductionQuorum() override external view returns (uint256) {
+        return getSettingUint("minipool.cancel.bond.reduction.quorum");
+    }
+
+    /// @notice Returns true if scrubbing results in an RPL penalty for the node operator
     function getScrubPenaltyEnabled() override external view returns (bool) {
         return getSettingBool("minipool.scrub.penalty.enabled");
     }
+
+    /// @notice Returns true if the given time is within the bond reduction window
+    function isWithinBondReductionWindow(uint256 _time) override external view returns (bool) {
+        uint256 start = getBondReductionWindowStart();
+        uint256 length = getBondReductionWindowLength();
+        return (_time >= start && _time < (start.add(length)));
+    }
+
+    /// @notice Returns the start of the bond reduction window
+    function getBondReductionWindowStart() override public view returns (uint256) {
+        return getSettingUint("minipool.bond.reduction.window.start");
+    }
+
+    /// @notice Returns the length of the bond reduction window
+    function getBondReductionWindowLength() override public view returns (uint256) {
+        return getSettingUint("minipool.bond.reduction.window.length");
+    }
 }

.soliumignore

@@ -1,59 +1,63 @@
-pragma solidity 0.7.6;
-
 // SPDX-License-Identifier: GPL-3.0-only
+pragma solidity 0.7.6;
 
 import "./RocketDAOProtocolSettings.sol";
 import "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsDepositInterface.sol";
 
-// Network deposit settings
-
+/// @notice Network deposit settings
 contract RocketDAOProtocolSettingsDeposit is RocketDAOProtocolSettings, RocketDAOProtocolSettingsDepositInterface {
 
-    // Construct
     constructor(RocketStorageInterface _rocketStorageAddress) RocketDAOProtocolSettings(_rocketStorageAddress, "deposit") {
         // Set version
-        version = 2;
+        version = 3;
         // Initialize settings on deployment
         if(!getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")))) {
             // Apply settings
             setSettingBool("deposit.enabled", false);
             setSettingBool("deposit.assign.enabled", true);
             setSettingUint("deposit.minimum", 0.01 ether);
             setSettingUint("deposit.pool.maximum", 160 ether);
-            setSettingUint("deposit.assign.maximum", 2);
+            setSettingUint("deposit.assign.maximum", 90);
+            setSettingUint("deposit.assign.socialised.maximum", 2);
             setSettingUint("deposit.fee", 0.0005 ether);    // Set to approx. 1 day of rewards at 18.25% APR
             // Settings initialised
             setBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")), true);
         }
     }
 
-    // Deposits currently enabled
+    /// @notice Returns true if deposits are currently enabled
     function getDepositEnabled() override external view returns (bool) {
         return getSettingBool("deposit.enabled");
     }
 
-    // Deposit assignments currently enabled
+    /// @notice Returns true if deposit assignments are currently enabled
     function getAssignDepositsEnabled() override external view returns (bool) {
         return getSettingBool("deposit.assign.enabled");
     }
 
-    // Minimum deposit size
+    /// @notice Returns the minimum deposit size
     function getMinimumDeposit() override external view returns (uint256) {
         return getSettingUint("deposit.minimum");
     }
 
-    // The maximum size of the deposit pool
+    /// @notice Returns the maximum size of the deposit pool
     function getMaximumDepositPoolSize() override external view returns (uint256) {
         return getSettingUint("deposit.pool.maximum");
     }
 
-    // The maximum number of deposit assignments to perform at once
+    /// @notice Returns the maximum number of deposit assignments to perform at once
     function getMaximumDepositAssignments() override external view returns (uint256) {
         return getSettingUint("deposit.assign.maximum");
     }
 
-    // Get the fee paid on deposits
+    /// @notice Returns the maximum number of socialised (ie, not related to deposit size) assignments to perform
+    function getMaximumDepositSocialisedAssignments() override external view returns (uint256) {
+        return getSettingUint("deposit.assign.socialised.maximum");
+    }
+
+    /// @notice Returns the current fee paid on user deposits
     function getDepositFee() override external view returns (uint256) {
         return getSettingUint("deposit.fee");
     }
+
 }