Implement capital distribution process

Author: kanewallmann

contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsMegapool.sol

@@ -21,6 +21,7 @@ contract RocketDAOProtocolSettingsMegapool is RocketDAOProtocolSettings, RocketD
     function initialise() override public {
         // Set defaults
         _setSettingUint("megapool.time.before.dissolve", 2 weeks);               // 2 weeks (RPIP-59)
+        _setSettingUint("maximum.megapool.eth.penalty", 612 ether);              // RPIP-42
         // Update deploy flag
         require (!getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed"))), "Already initialised");
         setBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")), true);
@@ -36,6 +37,10 @@ contract RocketDAOProtocolSettingsMegapool is RocketDAOProtocolSettings, RocketD
             if (settingKey == keccak256(abi.encodePacked("megapool.time.before.dissolve"))) {
                 // TODO: No guardrail is specified in RPIP-59 but there should probably be a minimum?
                 require(_value >= 48 hours, "Time must be greater than 48 hours");
+            } else if (settingKey == keccak256(abi.encodePacked("maximum.megapool.eth.penalty"))) {
+                // Per RPIP-42
+                // TODO: This is a placeholder value
+                require(_value <= 300 ether, "Penalty must equal or exceed 300 ETH");
             }
         }
         // Update setting now

contracts/contract/deposit/RocketDepositPool.sol

@@ -480,13 +480,11 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
         linkedListStorage.removeItem(namespace, key);
         // Perform balance accounting
         subUint(keccak256("deposit.pool.requested.total"), value.requestedValue * milliToWei);
-        // Add to node's credit for the amount supplied
-        RocketMegapoolDelegateInterface megapool = RocketMegapoolDelegateInterface(msg.sender);
-        address nodeAddress = megapool.getNodeAddress();
-        addUint(keccak256(abi.encodePacked("node.deposit.credit.balance", nodeAddress)), value.suppliedValue * milliToWei);
         if (_expressQueue) {
             // Refund express ticket
+            RocketMegapoolDelegateInterface megapool = RocketMegapoolDelegateInterface(msg.sender);
             RocketNodeManagerInterface rocketNodeManager = RocketNodeManagerInterface(getContractAddress("rocketNodeManager"));
+            address nodeAddress = megapool.getNodeAddress();
             rocketNodeManager.refundExpressTicket(nodeAddress);
             // Update head moved block
             if (isAtHead) {
@@ -502,6 +500,13 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
         emit QueueExited(msg.sender, block.timestamp);
     }
 
+    function applyCredit(uint256 _amount) external onlyRegisteredMegapool(msg.sender) {
+        // Add to node's credit for the amount supplied
+        RocketMegapoolDelegateInterface megapool = RocketMegapoolDelegateInterface(msg.sender);
+        address nodeAddress = megapool.getNodeAddress();
+        addUint(keccak256(abi.encodePacked("node.deposit.credit.balance", nodeAddress)), _amount);
+    }
+
     /// @notice Allows node operator to withdraw any ETH credit they have as rETH
     /// @param _amount Amount in ETH to withdraw
     function withdrawCredit(uint256 _amount) override external onlyRegisteredNode(msg.sender) {

contracts/contract/megapool/RocketMegapoolDelegate.sol

@@ -27,13 +27,18 @@ abstract contract RocketMegapoolStorageLayout {
         uint32 lastAssignmentTime;  // Timestamp of when the last fund assignment took place
         uint32 lastRequestedValue;  // Value in milliether last requested
         uint32 lastRequestedBond;   // Value in milliether of the bond supplied for last request for funds
+        uint32 depositValue;        // Total amount deposited to beaconchain in gwei
 
         bool staked;        // Whether the validator has staked the minimum required to begin validating (32 ETH)
         bool exited;        // Whether the validator has exited the beacon chain
         bool inQueue;       // Whether the validator is currently awaiting funds from the deposit pool
         bool inPrestake;    // Whether the validator is currently awaiting the stake operation
         bool expressUsed;   // Whether the last request for funds consumed an express ticket
         bool dissolved;     // Whether the validator failed to prestake their initial deposit in time
+        bool exiting;       // Whether the validator is queued to exit on the beaconchain
+
+        uint64 validatorIndex;      // Index of the validator on the beaconchain
+        uint64 exitBalance;         // Final balance of the validator at withdrawable_epoch in gwei (amount returned to EL)
     }
 
     // Extra data temporarily stored for prestake operation
@@ -68,7 +73,6 @@ abstract contract RocketMegapoolStorageLayout {
     uint256 internal nodeRewards;     // Unclaimed ETH rewards for the owner
 
     uint256 internal nodeBond;        // Total value of bond supplied by node operator
-    uint256 internal nodeCapital;     // Value of capital on the beacon chain supplied by the owner
     uint256 internal userCapital;     // Value of capital on the beacon chain supplied by the DP
 
     uint256 internal debt;            // Amount the owner owes the DP
@@ -77,4 +81,7 @@ abstract contract RocketMegapoolStorageLayout {
 
     mapping(uint32 => ValidatorInfo) internal validators;
     mapping(uint32 => PrestakeData) internal prestakeData;
+
+    uint32 internal numExitingValidators;
+    uint32 internal soonestWithdrawableEpoch;
 }

contracts/contract/megapool/RocketMegapoolStorageLayout.sol

@@ -3,20 +3,17 @@ pragma solidity 0.8.18;
 
 import {RocketStorageInterface} from "../../interface/RocketStorageInterface.sol";
 import {RocketVaultInterface} from "../../interface/RocketVaultInterface.sol";
-import {RocketDAOProtocolSettingsMinipoolInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";
+import {RocketVaultWithdrawerInterface} from "../../interface/RocketVaultWithdrawerInterface.sol";
 import {RocketDAOProtocolSettingsNodeInterface} from "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNodeInterface.sol";
 import {RocketDepositPoolInterface} from "../../interface/deposit/RocketDepositPoolInterface.sol";
 import {RocketMegapoolFactoryInterface} from "../../interface/megapool/RocketMegapoolFactoryInterface.sol";
 import {RocketMegapoolInterface} from "../../interface/megapool/RocketMegapoolInterface.sol";
-import {RocketNetworkFeesInterface} from "../../interface/network/RocketNetworkFeesInterface.sol";
-import {RocketNetworkVotingInterface} from "../../interface/network/RocketNetworkVotingInterface.sol";
+import {RocketMegapoolManagerInterface} from "../../interface/megapool/RocketMegapoolManagerInterface.sol";
 import {RocketNetworkSnapshotsInterface} from "../../interface/network/RocketNetworkSnapshotsInterface.sol";
+import {RocketNetworkVotingInterface} from "../../interface/network/RocketNetworkVotingInterface.sol";
 import {RocketNodeDepositInterface} from "../../interface/node/RocketNodeDepositInterface.sol";
-import {RocketNodeManagerInterface} from "../../interface/node/RocketNodeManagerInterface.sol";
 import {RocketNodeStakingInterface} from "../../interface/node/RocketNodeStakingInterface.sol";
 import {RocketBase} from "../RocketBase.sol";
-import {RocketMegapoolManagerInterface} from "../../interface/megapool/RocketMegapoolManagerInterface.sol";
-import {RocketVaultWithdrawerInterface} from "../../interface/RocketVaultWithdrawerInterface.sol";
 
 /// @notice Entry point for node operators to perform deposits for the creation of new validators on the network
 contract RocketNodeDeposit is RocketBase, RocketNodeDepositInterface, RocketVaultWithdrawerInterface {
@@ -41,15 +38,18 @@ contract RocketNodeDeposit is RocketBase, RocketNodeDepositInterface, RocketVaul
 
     /// @notice Returns the bond requirement for the given number of validators
     function getBondRequirement(uint256 _numValidators) override public view returns (uint256) {
+        if (_numValidators == 0) {
+            return 0;
+        }
         // Get contracts
         RocketDAOProtocolSettingsNodeInterface rocketDAOProtocolSettingsNode = RocketDAOProtocolSettingsNodeInterface(getContractAddress("rocketDAOProtocolSettingsNode"));
         // Calculate bond requirement
         uint256[] memory baseBondArray = rocketDAOProtocolSettingsNode.getBaseBondArray();
-        if (_numValidators < baseBondArray.length) {
-            return baseBondArray[_numValidators];
+        if (_numValidators - 1 < baseBondArray.length) {
+            return baseBondArray[_numValidators - 1];
         }
         uint256 reducedBond = rocketDAOProtocolSettingsNode.getReducedBond();
-        return baseBondArray[baseBondArray.length - 1] + (1 + _numValidators - baseBondArray.length) * reducedBond;
+        return baseBondArray[baseBondArray.length - 1] + (_numValidators - baseBondArray.length) * reducedBond;
     }
 
     /// @notice Returns a node operator's credit balance in wei
@@ -188,9 +188,6 @@ contract RocketNodeDeposit is RocketBase, RocketNodeDepositInterface, RocketVaul
         RocketMegapoolFactoryInterface rocketMegapoolFactory = RocketMegapoolFactoryInterface(getContractAddress("rocketMegapoolFactory"));
         RocketMegapoolInterface megapool = RocketMegapoolInterface(rocketMegapoolFactory.getOrDeployContract(msg.sender));
         RocketMegapoolManagerInterface rocketMegapoolManager = RocketMegapoolManagerInterface(getContractAddress("rocketMegapoolManager"));
-        // Check bond requirements
-        checkBondRequirement(megapool, _bondAmount);
-        checkDebtRequirement(megapool);
         // Request a new validator from the megapool
         rocketMegapoolManager.addValidator(address(megapool), megapool.getValidatorCount());
         megapool.newValidator(_bondAmount, _useExpressTicket, _validatorPubkey, _validatorSignature, _depositDataRoot);
@@ -229,19 +226,6 @@ contract RocketNodeDeposit is RocketBase, RocketNodeDepositInterface, RocketVaul
         rocketNetworkSnapshots.push(key, uint224(ethProvided));
     }
 
-    /// @dev Checks the bond requirements for a node deposit
-    function checkBondRequirement(RocketMegapoolInterface _megapool, uint256 _bondAmount) internal {
-        uint256 totalBondRequired = getBondRequirement(_megapool.getActiveValidatorCount());
-        uint256 currentBond = _megapool.getNodeBond();
-        uint256 requiredBond = totalBondRequired - currentBond;
-        require(_bondAmount == requiredBond, "Bond requirement not met");
-    }
-
-    /// @dev Checks the debt requirements for a node deposit
-    function checkDebtRequirement(RocketMegapoolInterface _megapool) internal {
-        require(_megapool.getDebt() == 0, "Cannot create validator while debt exists");
-    }
-
     /// @dev Initialises node's voting power if not already done
     function checkVotingInitialised() private {
         // Ensure voting has been initialised for this node

contracts/contract/node/RocketNodeDeposit.sol

@@ -51,7 +51,7 @@ contract BeaconStateVerifier is RocketBase, BeaconStateVerifierInterface {
         // TODO: Extract this out into a parameterised system for updating the gindices alongside hardforks
         SSZ.Path memory path = SSZ.from(3, 3); // 0b011 (BeaconBlockHeader -> state_root)
         if (isHistorical) {
-            path = SSZ.concat(path, SSZ.from(11, 5)); // 0b01011 (BeaconState -> validators)
+            path = SSZ.concat(path, SSZ.from(27, 5)); // 0b01011 (BeaconState -> historical_summaries)
             path = SSZ.concat(path, SSZ.intoVector(uint256(_withdrawalSlot) / SLOTS_PER_HISTORICAL_ROOT, 24)); // historical_summaries -> historical_summaries[n]
             path = SSZ.concat(path, SSZ.from(0, 1)); // 0b0 (HistoricalSummary -> block_summary_root)
         } else {

contracts/contract/util/BeaconStateVerifier.sol

@@ -19,6 +19,7 @@ interface RocketDepositPoolInterface {
     function withdrawExcessBalance(uint256 _amount) external;
     function requestFunds(uint256 _bondAmount, uint32 _validatorId, uint256 _amount, bool _useExpressTicket) external;
     function exitQueue(uint32 _validatorId, bool _expressQueue) external;
+    function applyCredit(uint256 _amount) external;
     function withdrawCredit(uint256 _amount) external;
     function getQueueTop() external view returns (address receiver, bool assignmentPossible, uint256 headMovedBlock);
     function getQueueIndex() external view returns (uint256);

contracts/interface/deposit/RocketDepositPoolInterface.sol

@@ -1,4 +1,4 @@
-// SPDX-License-Identifier: GPL-3.0-only
+// SPDX-License-Identifier: GPL-3.0-onl1000000000y
 pragma solidity >0.5.0 <0.9.0;
 
 import "../util/BeaconStateVerifierInterface.sol";
@@ -22,11 +22,13 @@ interface RocketMegapoolDelegateInterface is RocketMegapoolDelegateBaseInterface
 
     function getValidatorCount() external view returns (uint32);
     function getActiveValidatorCount() external view returns (uint32);
+    function getExitingValidatorCount() external view returns (uint32);
+    function getSoonestWithdrawableEpoch() external view returns (uint32);
     function getValidatorInfo(uint32 _validatorId) external view returns (RocketMegapoolStorageLayout.ValidatorInfo memory);
     function getAssignedValue() external view returns (uint256);
     function getDebt() external view returns (uint256);
     function getRefundValue() external view returns (uint256);
-    function getNodeCapital() external view returns (uint256);
+    function getNodeRewards() external view returns (uint256);
     function getNodeBond() external view returns (uint256);
     function getUserCapital() external view returns (uint256);
     function calculatePendingRewards() external view returns (uint256 nodeRewards, uint256 voterRewards, uint256 rethRewards);

contracts/interface/megapool/RocketMegapoolDelegateInterface.sol

@@ -10,7 +10,7 @@ struct Withdrawal {
 
 struct ValidatorProof {
     uint64 slot;
-    uint256 validatorIndex;
+    uint64 validatorIndex;
     bytes pubkey;
     bytes32 withdrawalCredentials;
     bytes32[] witnesses;

contracts/interface/util/BeaconStateVerifierInterface.sol

@@ -138,5 +138,7 @@ export async function deployUpgrade(rocketStorageAddress) {
         };
     }
 
+    console.log(addresses);
+
     return upgradeContract;
 }