BlockscapeValidatorNFT

Git Source

Inherits: ERC1155Supply, ReentrancyGuard, BlockscapeAccess, BlockscapeShared

State Variables

name

name constant used for blockexplorers (as to be lower case as per blockexplorer standards)

string public constant name = "Blockscape Validator NFTs";

symbol

symbol constant used for blockexplorers (as to be lower case as per blockexplorer standards)

string public constant symbol = "BSV";

curETHlimit

Current Rocketpool Minipool Limit

uint256 private curETHlimit = 16 ether;

tokenIDtoValidator

mapping of tokenID to validator minipool address

mapping(uint256 => address) private tokenIDtoValidator;

Functions

constructor

each validator related vault gets its separate tokenID which depicts the nft for each staker

the IPNS makes sure the nfts stay reachable via this link while new nfts get added to the underlying ipfs folder

constructor()
    ERC1155(
        "https://ipfs.blockscape.network/ipns/" "k51qzi5uqu5di5eo5fzr1zypdsz0zct39zpct9s4wesjustul1caeofak3zoej/"
        "{id}.json"
    )
    BlockscapeAccess(msg.sender, BlockscapeShared.blockscapeRocketPoolNode, msg.sender);

supportsInterface

needed as the OZ ERC1155 && AccessControl does both implement the supportsInterface function

function supportsInterface(bytes4 interfaceId) public view virtual override(ERC1155, AccessControl) returns (bool);

depositValidatorNFT

used by stakers to deposit ETH into the contract

the vault must be open and equal the depositing amount

enought RPL must be staked in the rocketpool by the node

function depositValidatorNFT() external payable;

withdrawBatch

this gets triggered by the backend controller when a new token is minted

the backend controller is only able to withdraw the current ETH limit

function withdrawBatch() external onlyRole(RP_BACKEND_ROLE) nonReentrant;

updateValidator

update validator address for given token id only once after the NFT has been issued and the validator was created by the backend this function will only be called by the backend

works only once for a tokenID; it will reopen the vault

emits no event by design to reduce maintenance costs

function updateValidator(uint256 _tokenID, address _vali) external onlyRole(RP_BACKEND_ROLE);

Parameters

prepareWithdrawalProcess

Withdraw is a two step process, first the staker has to call prepareWithdrawalProcess()

fist step used by the staker when he or she wants to unstake

function prepareWithdrawalProcess(uint256 _tokenID) external override;

Parameters

withdrawFunds

used by the staker after prepareWithdrawalProcess() & the timelock has passed to withdraw the funds

the rewards are calculated by the backend controller and are then stored in the contract, this is needed to be able to calculate the rewards correctly including MEV rewards.

There off-chain calculated rewards cannot be lower than the on-chain estimated rewards.

function withdrawFunds(uint256 _tokenID) external override;

calcRewards

this function is called by the backend controller when the UserRequestedWithdrawal is emited

the rewards are calculated by the backend controller and are then stored in the contract, this is needed to be able to calculate the rewards correctly including MEV rewards. There off-chain calculated rewards cannot be lower than the on-chain estimated rewards.

function calcRewards(uint256 _tokenID, uint256 _calcReward) public onlyRole(RP_BACKEND_ROLE);

Parameters

changeETHLimit8

the limit might change in the future if rocketpool supports smaller pool sizes (RPIP-8)

this function is only callable by our multisig wallet with ADJ_CONFIG_ROLE

it will only allow to set the limit to 8 ETH

function changeETHLimit8() external onlyRole(ADJ_CONFIG_ROLE);

lowerRPCommFee8

this function is only callable by our multisig wallet with ADJ_CONFIG_ROLE

this will set the comission fee for 8 ETH minipools

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

Parameters

getCurrentEthLimit

the current depositing threshold

function getCurrentEthLimit() public view returns (uint256);

Returns

calcWithdrawFee

how much fees would the user has to pay if he or she would unstake now within the first year of staking the fee is starting at 20% & decreasing linearly, afterwards 0.5%

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

Parameters

Returns

getValidatorAddress

this function is used to get the validator address from the tokenID

function getValidatorAddress(uint256 _tokenID) public view returns (address);

Parameters

Returns

estRewardsNoMEV

this function is a on-chain calculation of the rocketpool ETH rewards. It does not take MEV into account & will only work correctly after the Shapella/Shanghai upgrade

function estRewardsNoMEV(uint256 _tokenID) internal view returns (uint256);

Parameters

Returns

totalSupply

total amount of supply

function totalSupply() external view returns (uint256);

Returns

contractURI

stake nft metdata location

this path will never change as the contract defines a collection

function contractURI() external pure returns (string memory);

Returns

uri

gets the url to the metadata of a given pool

function uri(uint256 _tokenID) public pure override returns (string memory);

Parameters

Returns