BlockscapeShared

Git Source

Inherits: BlockscapeAccess, BlockscapeErrors, BlockscapeEvents

State Variables

vaultOpen

using OZs sendValue implementation

the initial vault state is open

bool internal vaultOpen = true;

rpComm8

current initial RP commission for 8 ETH minipools, public for transparency

uint256 public rpComm8 = 14;

blockscapeRocketPoolNode

Blockscape Rocket Pool Node Address, public for transparency

address payable public blockscapeRocketPoolNode = payable(0xF6132f532ABc3902EA2DcaE7f8D7FCCdF7Ba4982);

tokenID

initial tokenID

the tokenID is used to identify the NFTs

uint256 internal tokenID = 1;

timelockWithdraw

the current timelock for a withdrawal request, public for transparency

uint256 public timelockWithdraw = 7 days;

initWithdrawFee

current initial withdraw fee, public for transparency

uint256 public initWithdrawFee = 20 * 1e18;

senderToTimestamp

Mapping withdrawal requester to timestamp of request to keep record, public for use in UI

mapping(address => uint256) public senderToTimestamp;

tokenIDtoMetadata

Mappings of tokenID to Metadata

mapping(uint256 => Metadata) internal tokenIDtoMetadata;

tokenIDToExitReward

Mappings of tokenID to the final exit reward for the staker

mapping(uint256 => uint256) public tokenIDToExitReward;

ROCKET_STORAGE

RocketStorageInterface of rocketpool

RocketStorageInterface internal constant ROCKET_STORAGE =
    RocketStorageInterface(0x1d8f8f00cfa6758d7bE78336684788Fb0ee0Fa46);

Functions

getAvailableRPLStake

show the currently available RPL stake which is needed to create a pool on rocketscape

function getAvailableRPLStake() public view returns (uint256);

Returns

getLatestRocketNodeStaking

rocketpool contract interface for interactions with the rocketNodeStaking contract

function getLatestRocketNodeStaking() internal view returns (RocketNodeStakingInterface);

Returns

getReqRPLStake

calculates the required RPL needed to stake according to poolsize

if the minipoollimit is 0 then the required stake is also 0!

function getReqRPLStake() public view returns (uint256);

Returns

hasNodeEnoughRPLStake

has the node enough RPL to stake another minipool

function hasNodeEnoughRPLStake() public view returns (bool);

Returns

setBlockscapeRocketPoolNode

gets used if blockscape changes the address of their rp node

function setBlockscapeRocketPoolNode(address _newBlockscapeRocketPoolNode) external onlyRole(ADJ_CONFIG_ROLE);

Parameters

_setMetadataForStakeInternal

sets the stakedETH and stakedTimestamp for a given tokenID inm the Metadata struct

function _setMetadataForStakeInternal(uint256 _stakedETH, uint256 _tokenID) internal;

Parameters

getTokenID

the tokenID is incremented with every pool

function getTokenID() public view returns (uint256);

Returns

getBalance

how much balance does this contract current have

function getBalance() external view returns (uint256);

Returns

getMetadata

gets the metadata of a given pool

function getMetadata(uint256 _tokenID) external view returns (Metadata memory);

Parameters

Returns

openVault

makes the vault stakable again after it has been closed

is triggered when the vault can be staked at rocketpool

function openVault() external onlyRole(EMERGENCY_ROLE);

_openVaultInternal

opens the vault after the recent Validator data has been updated and is associated with the recent _tokenID

function _openVaultInternal() internal;

closeVault

is triggered when the vault can be staked at rocketpool

future staking interactions are prevented afterwards

function closeVault() external onlyRole(EMERGENCY_ROLE);

_closeVaultInternal

closes the vault to temporarily prevent further depositing

function _closeVaultInternal() internal;

isVaultOpen

does the vault currently allow depositing

the backend controller will reopen then vault after the stake have been transferred

function isVaultOpen() public view returns (bool);

Returns

changeWithdrawFee

the withdraw fee might be changed in the future, but cannot be higher than 20%

only the user with the ADJ_CONFIG_ROLE can call this function

function changeWithdrawFee(uint256 _amount) external onlyRole(ADJ_CONFIG_ROLE);

Parameters

changeTimelockWithdraw

the timelock for withdraw might be changed in the future, but cannot be higher than 7 days

only the user with the ADJ_CONFIG_ROLE can call this function

function changeTimelockWithdraw(uint256 _newTimelock) external onlyRole(ADJ_CONFIG_ROLE);

Parameters

receive

allow contract to receive ETH without making a delegated call

receive() external payable;

prepareWithdrawalProcess

allow user to request a withdrawal

function prepareWithdrawalProcess(uint256 _tokenID) external virtual;

withdrawFunds

enable the user to withdraw his/her funds

function withdrawFunds(uint256 _tokenID) external virtual;

calcWithdrawFee

calculates the withdraw fee for a given user and tokenID

function calcWithdrawFee(uint256 _tokenID, address _user) public view virtual returns (uint256 _amount);

Structs

Metadata

Metadata struct

struct Metadata {
    uint256 stakedETH;
    uint256 stakedTimestamp;
}