Skip to content

Commit

Permalink
Integrate state proof and megapool work
Browse files Browse the repository at this point in the history
  • Loading branch information
@kanewallmann
kanewallmann committed Oct 24, 2024
1 parent a37f149 commit 95ecece
Show file tree
Hide file tree
Showing 15 changed files with 298 additions and 78 deletions.
15 changes: 6 additions & 9 deletions contracts/contract/deposit/RocketDepositPool.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {RocketNodeStakingInterface} from "../../interface/node/RocketNodeStaking
import "hardhat/console.sol";
import {RocketMegapoolFactoryInterface} from "../../interface/megapool/RocketMegapoolFactoryInterface.sol";

/// @notice Accepts user deposits and mints rETH; handles assignment of deposited ETH to minipools
/// @notice Accepts user deposits and mints rETH; handles assignment of deposited ETH to megapools
contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaultWithdrawerInterface {

// Constants
Expand Down Expand Up @@ -54,13 +54,10 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
}

constructor(RocketStorageInterface _rocketStorageAddress) RocketBase(_rocketStorageAddress) {
version = 3;

version = 4;
// Pre-retrieve non-upgradable contract addresses to save gas
rocketVault = RocketVaultInterface(getContractAddress("rocketVault"));
rocketTokenRETH = RocketTokenRETHInterface(getContractAddress("rocketTokenRETH"));

// Precompute common keys
}

/// @notice Returns the current deposit pool balance
Expand Down Expand Up @@ -175,7 +172,7 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
require(success, "Failed to send ETH");
}

/// @dev Recycle a deposit from a dissolved minipool
/// @dev Recycle a deposit from a dissolved validator
function recycleDissolvedDeposit() override external payable onlyThisLatestContract onlyRegisteredMinipoolOrMegapool(msg.sender) {
// Load contracts
RocketDAOProtocolSettingsDepositInterface rocketDAOProtocolSettingsDeposit = RocketDAOProtocolSettingsDepositInterface(getContractAddress("rocketDAOProtocolSettingsDeposit"));
Expand Down Expand Up @@ -236,15 +233,16 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
AddressQueueStorageInterface addressQueueStorage = AddressQueueStorageInterface(getContractAddress("addressQueueStorage"));
if (addressQueueStorage.getLength(queueKeyVariable) > 0) {
RocketMinipoolQueueInterface rocketMinipoolQueue = RocketMinipoolQueueInterface(getContractAddress("rocketMinipoolQueue"));
return _assignDepositsLegacy(rocketMinipoolQueue, _rocketDAOProtocolSettingsDeposit);
_assignDepositsLegacy(rocketMinipoolQueue, _rocketDAOProtocolSettingsDeposit);
return true;
}
// Assign megapools
assignMegapools(msg.value / 32 ether);
return true;
}

/// @dev Assigns deposits using the legacy minipool queue
function _assignDepositsLegacy(RocketMinipoolQueueInterface _rocketMinipoolQueue, RocketDAOProtocolSettingsDepositInterface _rocketDAOProtocolSettingsDeposit) private returns (bool) {
function _assignDepositsLegacy(RocketMinipoolQueueInterface _rocketMinipoolQueue, RocketDAOProtocolSettingsDepositInterface _rocketDAOProtocolSettingsDeposit) private {
// Load contracts
RocketDAOProtocolSettingsMinipoolInterface rocketDAOProtocolSettingsMinipool = RocketDAOProtocolSettingsMinipoolInterface(getContractAddress("rocketDAOProtocolSettingsMinipool"));
// Calculate the number of minipools to assign
Expand Down Expand Up @@ -277,7 +275,6 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
// Decrease node balance
subUint("deposit.pool.node.balance", nodeBalanceUsed);
}
return true;
}

/// @dev Withdraw excess deposit pool balance for rETH collateral
Expand Down
42 changes: 42 additions & 0 deletions contracts/contract/helper/BeaconStateVerifierMock.sol
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// SPDX-License-Identifier: GPL-3.0-only
pragma solidity 0.8.18;

import "../../interface/RocketStorageInterface.sol";
import "../../interface/util/BeaconStateVerifierInterface.sol";
import {BeaconStateVerifier} from "../util/BeaconStateVerifier.sol";

/// @dev NOT USED IN PRODUCTION - This contract only exists to bypass state proofs during tests
contract BeaconStateVerifierMock is BeaconStateVerifierInterface {
bool private disabled = false;

BeaconStateVerifierInterface private immutable verifier;

constructor(RocketStorageInterface _rocketStorageAddress) {
verifier = new BeaconStateVerifier(_rocketStorageAddress);
}

function setDisabled(bool _disabled) external {
disabled = _disabled;
}

function verifyValidator(ValidatorProof calldata _proof) override external view returns(bool) {
if (disabled) {
return true;
}
return verifier.verifyValidator(_proof);
}

function verifyExit(uint256 _validatorIndex, uint256 _withdrawableEpoch, uint64 _slot, bytes32[] calldata _proof) override external view returns(bool) {
if (disabled) {
return true;
}
return verifier.verifyExit(_validatorIndex, _withdrawableEpoch, _slot, _proof);
}

function verifyWithdrawal(uint256 _validatorIndex, uint64 _withdrawalSlot, uint256 _withdrawalNum, Withdrawal calldata _withdrawal, uint64 _slot, bytes32[] calldata _proof) override external view returns(bool) {
if (disabled) {
return true;
}
return verifier.verifyWithdrawal(_validatorIndex, _withdrawalSlot, _withdrawalNum, _withdrawal, _slot, _proof);
}
}
6 changes: 1 addition & 5 deletions contracts/contract/helper/MegapoolUpgradeHelper.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ pragma solidity 0.8.18;
import "../RocketBase.sol";
import {RocketMegapoolFactoryInterface} from "../../interface/megapool/RocketMegapoolFactoryInterface.sol";

import "hardhat/console.sol";

// THIS CONTRACT IS NOT DEPLOYED TO MAINNET

// Helper contract used to insert arbitrary snapshots in for testing
/// @dev NOT USED IN PRODUCTION - Helper contract used to insert arbitrary snapshots in for testing
contract MegapoolUpgradeHelper is RocketBase {

// Construct
Expand Down
92 changes: 54 additions & 38 deletions contracts/contract/megapool/RocketMegapoolDelegate.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {RocketMegapoolProxy} from "./RocketMegapoolProxy.sol";
import "./RocketMegapoolDelegateBase.sol";

import "hardhat/console.sol";
import {BeaconStateVerifier} from "../util/BeaconStateVerifier.sol";

/// @title RocketMegapool
/// @notice This contract manages multiple validators. It serves as the target of Beacon Chain withdrawal credentials.
Expand Down Expand Up @@ -72,7 +73,7 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
prestake._signature = _validatorSignature;
prestakeData[validatorId] = prestake;
}
// Increase bond
// Increase total bond used for bond requirement calculations
nodeBond += _bondAmount;
// Request full deposit amount from deposit pool
rocketDepositPool.requestFunds(_bondAmount, validatorId, fullDepositValue, _useExpressTicket);
Expand All @@ -83,17 +84,20 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
/// @notice Removes a validator from the deposit queue
/// @param _validatorId the validator ID
function dequeue(uint32 _validatorId) external onlyLatestContract("rocketNodeDeposit", msg.sender) {
ValidatorInfo memory validator = validators[_validatorId];
// Validate validator status
require(validators[_validatorId].inQueue, "Validator must be in queue");
require(validator.inQueue, "Validator must be in queue");
// Dequeue validator from the deposit pool
RocketDepositPoolInterface rocketDepositPool = RocketDepositPoolInterface(getContractAddress("rocketDepositPool"));
rocketDepositPool.exitQueue(_validatorId, validators[_validatorId].expressUsed);
ValidatorInfo memory validator = validators[_validatorId];
rocketDepositPool.exitQueue(_validatorId, validator.expressUsed);
// Decrease total bond used for bond requirement calculations
nodeBond -= validator.lastRequestedBond;
// TODO: Apply an ETH credit of validator.lastRequestedBond
// Update validator state
validator.inQueue = false;
validator.lastRequestedBond = 0;
validator.lastRequestedValue = 0;
validators[_validatorId] = validator;
// TODO: Apply an ETH credit
// Emit event
emit MegapoolValidatorDequeued(address(this), _validatorId, block.timestamp);
}
Expand All @@ -110,11 +114,10 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
validators[_validatorId] = validator;
// Record value assigned from deposit pool (subtract prestakeValue as it is going to deposit contract now)
assignedValue += msg.value - prestakeValue;
nodeCapital += prestakeValue;
// Execute prestake operation
PrestakeData memory validatorPrestakeData = prestakeData[_validatorId];
DepositInterface casperDeposit = DepositInterface(getContractAddress("casperDeposit"));
casperDeposit.deposit{value: prestakeValue}(validator.pubKey, getWithdrawalCredentials(), validatorPrestakeData._signature, validatorPrestakeData._depositDataRoot);
casperDeposit.deposit{value: prestakeValue}(validator.pubKey, abi.encodePacked(getWithdrawalCredentials()), validatorPrestakeData._signature, validatorPrestakeData._depositDataRoot);
// Clean up prestake data
delete prestakeData[_validatorId];
// Emit event
Expand All @@ -123,33 +126,36 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel

/// @notice Performs the remaining ETH deposit on the Beacon Chain
/// @param _validatorId The validator ID
/// @param _pubKey The valdiator pubkey
/// @param _signature The signature over the deposit data
/// @param _withdrawalCredentialStateProof Merkle proof of the beacon state object proving withdrawal credentials
function stake(uint32 _validatorId, bytes calldata _pubKey, bytes calldata _signature, bytes32 _depositDataRoot, StateProof calldata _withdrawalCredentialStateProof) external onlyMegapoolOwner() {
/// @param _proof A proof struct proving the withdrawal credentials of the validator
function stake(uint32 _validatorId, bytes calldata _signature, bytes32 _depositDataRoot, ValidatorProof calldata _proof) external onlyMegapoolOwner() {
// Retrieve validator from storage
ValidatorInfo memory validator = validators[_validatorId];
// Validate validator status
require(validator.inPrestake, "Validator must be pre-staked");
// Verify proof data
bytes32 withdrawalCredentials = getWithdrawalCredentials();
require(_proof.withdrawalCredentials == withdrawalCredentials, "Invalid withdrawal credentials");
require(keccak256(_proof.pubkey) == keccak256(validator.pubKey));
// Store last requested value for later
uint32 lastRequestedValue = validator.lastRequestedValue;
// Account for assigned value
assignedValue -= lastRequestedValue - prestakeValue;
userCapital += uint256(lastRequestedValue - validator.lastRequestedBond) * milliToWei;
nodeCapital += uint256(validator.lastRequestedBond) * milliToWei - prestakeValue;
nodeCapital += uint256(validator.lastRequestedBond) * milliToWei;
// Update validator status
validator.active = true;
validator.inPrestake = false;
validator.lastAssignmentTime = 0;
validator.lastRequestedBond = 0;
validator.lastRequestedValue = 0;
validators[_validatorId] = validator;
// Verify withdrawal credentials state proof
bytes memory withdrawalCredentials = getWithdrawalCredentials();
// TODO: Verify state proof to ensure validator has correct withdrawal credentials
// Verify state proof to ensure validator has correct withdrawal credentials
BeaconStateVerifierInterface beaconStateVerifier = BeaconStateVerifierInterface(getContractAddress("beaconStateVerifier"));
require(beaconStateVerifier.verifyValidator(_proof), "Invalid proof");
// Perform remaining 31 ETH stake onto beaconchain
DepositInterface casperDeposit = DepositInterface(getContractAddress("casperDeposit"));
casperDeposit.deposit{value: lastRequestedValue}(_pubKey, withdrawalCredentials, _signature, _depositDataRoot);
casperDeposit.deposit{value: lastRequestedValue}(validator.pubKey, abi.encodePacked(withdrawalCredentials), _signature, _depositDataRoot);
}

/// @notice Dissolves a validator that has not staked within the required period
Expand Down Expand Up @@ -243,22 +249,22 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
revert("Not implemented");
// Calculate split of rewards
uint256 rewards = getPendingRewards();
uint256 nodeShare = _getNodeRewards(rewards);
uint256 userShare = rewards - nodeShare;
(uint256 rethRewards, uint256 voterRewards, uint256 nodeRewards) = _calculateRewards(rewards);
// Maybe repay debt from node share
if (debt > 0) {
uint256 amountToRepay = nodeShare;
uint256 amountToRepay = nodeRewards;
if (amountToRepay > debt) {
amountToRepay = debt;
}
nodeShare -= amountToRepay;
nodeRewards -= amountToRepay;
_repayDebt(amountToRepay);
}
// Send user share to rETH
(bool success,) = rocketTokenRETH.call{value: userShare}("");
(bool success,) = rocketTokenRETH.call{value: rethRewards}("");
require(success, "Failed to send ETH to the rETH contract");
// TODO: Send voter share to merkle distributor
// Increase node rewards value
nodeRewards += nodeShare;
nodeRewards += nodeRewards;
// If owner is calling, claim immediately
// TODO: Should this also check withdrawal address?
if (msg.sender == nodeAddress) {
Expand All @@ -269,10 +275,20 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
function claim() public onlyMegapoolOwner() {
revert("Not implemented");
uint256 amountToSend = nodeRewards;
if (debt > 0) {
if (debt > amountToSend) {
debt -= amountToSend;
nodeRewards = 0;
return;
} else {
debt = 0;
amountToSend -= debt;
}
}
nodeRewards = 0;
// Send user share to rETH
// TODO: Send to withdrawal address
(bool success,) = nodeAddress.call{value: amountToSend}("");
// Send to withdrawal address
address nodeWithdrawalAddress = rocketStorage.getNodeWithdrawalAddress(nodeAddress);
(bool success,) = nodeWithdrawalAddress.call{value: amountToSend}("");
require(success, "Failed to send ETH to the node operator");
}

Expand Down Expand Up @@ -310,18 +326,18 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
return userCapital;
}

function getNodeRewards() external returns (uint256) {
return _getNodeRewards(getPendingRewards());
}

function _getNodeRewards(uint256 _rewards) internal returns (uint256) {
uint256 userShare = _getUserRewards(_rewards);
return _rewards - userShare;
}

function _getUserRewards(uint256 _rewards) internal returns (uint256) {
uint256 borrowedPortion = userCapital * calcBase / (nodeCapital + userCapital);
return _rewards * borrowedPortion / calcBase;
function _calculateRewards(uint256 _rewards) internal returns (uint256 rethRewards, uint256 voterRewards, uint256 nodeRewards) {
// TODO: Move this into the UAR calculator and parameterise
uint256 nodeOperatorCommissionShare = 0.05 ether;
uint256 nodeOperatorCommissionShareCouncilAdder = 0;
uint256 voterShare = 0.09 ether;
uint256 newShare = 0;
uint256 rethCommission = nodeOperatorCommissionShare + voterShare + newShare;
uint256 rethShare = 1 ether - rethCommission;
uint256 borrowedPortion = _rewards * userCapital / (nodeCapital + userCapital);
rethRewards = rethShare * borrowedPortion / calcBase;
voterRewards = (voterShare - nodeOperatorCommissionShare) * borrowedPortion / calcBase;
nodeRewards = _rewards - rethRewards - voterRewards;
}

function getPendingRewards() override public view returns (uint256) {
Expand All @@ -332,8 +348,8 @@ contract RocketMegapoolDelegate is RocketMegapoolDelegateBase, RocketMegapoolDel
}

/// @notice Returns the expected withdrawal credentials for any validator within this megapool
function getWithdrawalCredentials() override public view returns (bytes memory) {
return abi.encodePacked(bytes1(0x01), bytes11(0x0), address(this));
function getWithdrawalCredentials() override public view returns (bytes32) {
return bytes32((uint256(0x01) << 248) | uint256(uint160(address(this))));
}

//
Expand Down
2 changes: 1 addition & 1 deletion contracts/contract/node/RocketNodeDeposit.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ contract RocketNodeDeposit is RocketBase, RocketNodeDepositInterface {
event Withdrawal(address indexed nodeAddress, address indexed to, uint256 amount, uint256 time);

constructor(RocketStorageInterface _rocketStorageAddress) RocketBase(_rocketStorageAddress) {
version = 3;
version = 5;
}

/// @dev Accept incoming ETH from the deposit pool
Expand Down
Loading

0 comments on commit 95ecece

Please sign in to comment.