Skip to content

Commit

Permalink
Megapool - WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
@0xfornax
0xfornax committed Sep 10, 2024
1 parent 30e1cda commit 1f50b45
Show file tree
Hide file tree
Showing 14 changed files with 520 additions and 485 deletions.
8 changes: 8 additions & 0 deletions contracts/contract/RocketBase.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ abstract contract RocketBase {
require(getBool(keccak256(abi.encodePacked("minipool.exists", _minipoolAddress))), "Invalid minipool");
_;
}

/**
* @dev Throws if called by any sender that isn't a registered megapool
*/
modifier onlyRegisteredMegapool(address _megapoolAddress) {
require(getBool(keccak256(abi.encodePacked("megapool.exists", _megapoolAddress))), "Invalid megapool");
_;
}


/**
Expand Down
26 changes: 26 additions & 0 deletions contracts/contract/dao/protocol/settings/RocketDAOProtocolSettingsMegapool.sol
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// SPDX-License-Identifier: GPL-3.0-only
pragma solidity 0.8.18;

import "./RocketDAOProtocolSettings.sol";
import "../../../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMegapoolInterface.sol";

/// @notice Network minipool settings
contract RocketDAOProtocolSettingsMegapool is RocketDAOProtocolSettings, RocketDAOProtocolSettingsMegapoolInterface {


constructor(RocketStorageInterface _rocketStorageAddress) RocketDAOProtocolSettings(_rocketStorageAddress, "minipool") {
version = 1;
// Initialize settings on deployment
if(!getBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")))) {
// Apply settings
// Settings initialised
setBool(keccak256(abi.encodePacked(settingNameSpace, "deployed")), true);
}
}

/// @notice
function getUnstakingPeriod() override external view returns (uint256) {
return getSettingUint("megapool.unstaking.period");
}

}
87 changes: 62 additions & 25 deletions contracts/contract/deposit/RocketDepositPool.sol
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
// SPDX-License-Identifier: GPL-3.0-only
pragma solidity 0.7.6;

import "@openzeppelin/contracts/math/SafeMath.sol";
import "@openzeppelin/contracts/math/SignedSafeMath.sol";
import "@openzeppelin/contracts/utils/SafeCast.sol";
pragma solidity 0.8.18;

import "../RocketBase.sol";
import "../../interface/RocketVaultInterface.sol";
Expand All @@ -15,16 +11,14 @@ import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsDepositIn
import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsMinipoolInterface.sol";
import "../../interface/dao/protocol/settings/RocketDAOProtocolSettingsNetworkInterface.sol";
import "../../interface/token/RocketTokenRETHInterface.sol";
import "../../interface/util/LinkedListStorageInterface.sol";
import "../../interface/megapool/RocketMegapoolInterface.sol";
import "../../interface/node/RocketNodeManagerInterface.sol";
import "../../types/MinipoolDeposit.sol";

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

// Libs
using SafeMath for uint256;
using SignedSafeMath for int256;
using SafeCast for uint256;

// Immutables
RocketVaultInterface immutable rocketVault;
RocketTokenRETHInterface immutable rocketTokenRETH;
Expand Down Expand Up @@ -69,7 +63,7 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
/// @notice Returns the user owned portion of the deposit pool (negative indicates more ETH has been "lent" to the
/// deposit pool by node operators in the queue than is available from user deposits)
function getUserBalance() override public view returns (int256) {
return getBalance().toInt256().sub(getNodeBalance().toInt256());
return int256(getBalance()) - int256(getNodeBalance());
}

/// @notice Excess deposit pool balance (in excess of minipool queue capacity)
Expand All @@ -80,7 +74,7 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
uint256 balance = getBalance();
// Calculate and return
if (minipoolCapacity >= balance) { return 0; }
else { return balance.sub(minipoolCapacity); }
else { return balance - minipoolCapacity; }
}

/// @dev Callback required to receive ETH withdrawal from the vault
Expand All @@ -102,22 +96,22 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
maxCapacity = maximumDepositPoolSize + queueEffectiveCapacity
assert(capacityNeeded <= maxCapacity)
*/
uint256 capacityNeeded = getBalance().add(msg.value);
uint256 capacityNeeded = getBalance() + msg.value;
uint256 maxDepositPoolSize = rocketDAOProtocolSettingsDeposit.getMaximumDepositPoolSize();
if (capacityNeeded > maxDepositPoolSize) {
// Doing a conditional require() instead of a single one optimises for the common
// case where capacityNeeded fits in the deposit pool without looking at the queue
if (rocketDAOProtocolSettingsDeposit.getAssignDepositsEnabled()) {
RocketMinipoolQueueInterface rocketMinipoolQueue = RocketMinipoolQueueInterface(getContractAddress("rocketMinipoolQueue"));
require(capacityNeeded <= maxDepositPoolSize.add(rocketMinipoolQueue.getEffectiveCapacity()),
require(capacityNeeded <= maxDepositPoolSize + rocketMinipoolQueue.getEffectiveCapacity(),
"The deposit pool size after depositing (and matching with minipools) exceeds the maximum size");
} else {
revert("The deposit pool size after depositing exceeds the maximum size");
}
}
// Calculate deposit fee
uint256 depositFee = msg.value.mul(rocketDAOProtocolSettingsDeposit.getDepositFee()).div(calcBase);
uint256 depositNet = msg.value.sub(depositFee);
uint256 depositFee = msg.value * rocketDAOProtocolSettingsDeposit.getDepositFee() / calcBase;
uint256 depositNet = msg.value - depositFee;
// Mint rETH to user account
rocketTokenRETH.mint(depositNet, msg.sender);
// Emit deposit received event
Expand All @@ -138,13 +132,13 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
// When assignments are enabled, we can accept the max amount plus whatever space is available in the minipool queue
if (rocketDAOProtocolSettingsDeposit.getAssignDepositsEnabled()) {
RocketMinipoolQueueInterface rocketMinipoolQueue = RocketMinipoolQueueInterface(getContractAddress("rocketMinipoolQueue"));
maxCapacity = maxCapacity.add(rocketMinipoolQueue.getEffectiveCapacity());
maxCapacity = maxCapacity + rocketMinipoolQueue.getEffectiveCapacity();
}
// Check we aren't already over
if (depositPoolBalance >= maxCapacity) {
return 0;
}
return maxCapacity.sub(depositPoolBalance);
return maxCapacity - depositPoolBalance;
}

/// @dev Accepts ETH deposit from the node deposit contract (does not mint rETH)
Expand Down Expand Up @@ -242,9 +236,9 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
// Calculate the number of minipools to assign
uint256 maxAssignments = _rocketDAOProtocolSettingsDeposit.getMaximumDepositAssignments();
uint256 variableDepositAmount = rocketDAOProtocolSettingsMinipool.getVariableDepositAmount();
uint256 scalingCount = msg.value.div(variableDepositAmount);
uint256 totalEthCount = getBalance().div(variableDepositAmount);
uint256 assignments = _rocketDAOProtocolSettingsDeposit.getMaximumDepositSocialisedAssignments().add(scalingCount);
uint256 scalingCount = msg.value / variableDepositAmount;
uint256 totalEthCount = getBalance() / variableDepositAmount;
uint256 assignments = _rocketDAOProtocolSettingsDeposit.getMaximumDepositSocialisedAssignments() + scalingCount;
if (assignments > totalEthCount) {
assignments = totalEthCount;
}
Expand All @@ -254,15 +248,15 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
address[] memory minipools = _rocketMinipoolQueue.dequeueMinipools(assignments);
if (minipools.length > 0){
// Withdraw ETH from vault
uint256 totalEther = minipools.length.mul(variableDepositAmount);
uint256 totalEther = minipools.length / variableDepositAmount;
rocketVault.withdrawEther(totalEther);
uint256 nodeBalanceUsed = 0;
// Loop over minipools and deposit the amount required to reach launch balance
for (uint256 i = 0; i < minipools.length; ++i) {
RocketMinipoolInterface minipool = RocketMinipoolInterface(minipools[i]);
// Assign deposit to minipool
minipool.deposit{value: variableDepositAmount}();
nodeBalanceUsed = nodeBalanceUsed.add(minipool.getNodeTopUpValue());
nodeBalanceUsed = nodeBalanceUsed + minipool.getNodeTopUpValue();
// Emit deposit assigned event
emit DepositAssigned(minipools[i], variableDepositAmount, block.timestamp);
}
Expand Down Expand Up @@ -293,11 +287,11 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
minipoolCapacity = rocketDAOProtocolSettingsMinipool.getDepositUserAmount(depositType);
}
count--;
if (minipoolCapacity == 0 || balance.sub(totalEther) < minipoolCapacity) { break; }
if (minipoolCapacity == 0 || balance - totalEther < minipoolCapacity) { break; }
// Dequeue the minipool
address minipoolAddress = _rocketMinipoolQueue.dequeueMinipoolByDepositLegacy(depositType);
// Update running total
totalEther = totalEther.add(minipoolCapacity);
totalEther = totalEther + minipoolCapacity;
// Add assignment
assignments[i].etherAssigned = minipoolCapacity;
assignments[i].minipoolAddress = minipoolAddress;
Expand Down Expand Up @@ -331,4 +325,47 @@ contract RocketDepositPool is RocketBase, RocketDepositPoolInterface, RocketVaul
emit ExcessWithdrawn(msg.sender, _amount, block.timestamp);
}

/// @notice Requests
function requestFunds(uint256 validatorId, uint256 amount, bool _expressQueue) external payable onlyRegisteredMegapool(msg.sender) {
LinkedListStorageInterface linkedListStorage = LinkedListStorageInterface(getContractAddress("linkedListStorage"));

address nodeAddress = RocketMegapoolInterface(msg.sender).getNodeAddress();
//uint256 ethSupplied = RocketNodeManagerInterface.getEthSupplied(nodeAddress) + msg.value;
//uint256 ethMatched = RocketNodeManagerInterface.getEthMatched(nodeAddress) + amount;

// Check that the ratio of ethSupplied and ethMatched meets minimum requirement
// If useExpressTicket, subtract an express ticket

DepositQueueValue memory value = DepositQueueValue({
receiver: msg.sender, // Megapool address
validatorId: uint32(validatorId), // Incrementing id per validator in a megapool
suppliedValue: uint32(msg.value / 10 ** 15), // NO bond amount
requestedValue: uint32(amount / 10 ** 15) // Amount being requested
});

bytes32 namespace;
if (_expressQueue) {
namespace = keccak256("deposit.queue.express");
} else {
namespace = keccak256("deposit.queue.standard");
}
linkedListStorage.enqueueItem(namespace, value);
}

function exitQueue(uint256 _validatorId, bool _expressQueue) external onlyRegisteredMegapool(msg.sender) {
LinkedListStorageInterface linkedListStorage = LinkedListStorageInterface(getContractAddress("linkedListStorage"));
DepositQueueValue memory key = DepositQueueValue({
receiver: msg.sender,
validatorId: uint32(_validatorId),
suppliedValue: 0,
requestedValue: 0
});
bytes32 namespace;
if (_expressQueue) {
namespace = keccak256("deposit.queue.express");
} else {
namespace = keccak256("deposit.queue.standard");
}
linkedListStorage.removeItem(namespace, key);
}
}
Loading

0 comments on commit 1f50b45

Please sign in to comment.