EthGenesisVault

Git Source

Inherits: Initializable, EthVault, IEthGenesisVault

Author: StakeWise

Defines the Genesis Vault for Ethereum staking migrated from StakeWise Legacy

State Variables

_version

uint8 private constant _version = 5;

_poolEscrow

Note: oz-upgrades-unsafe-allow: state-variable-immutable

IEthPoolEscrow private immutable _poolEscrow;

_rewardEthToken

Note: oz-upgrades-unsafe-allow: state-variable-immutable

IRewardEthToken private immutable _rewardEthToken;

__gap

This empty reserved space is put in place to allow future versions to add new variables without shifting down storage in the inheritance chain. See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps

uint256[50] private __gap;

Functions

constructor

Constructor

Since the immutable variable value is stored in the bytecode, its value would be shared among all proxies pointing to a given contract instead of each proxy’s storage.

Note: oz-upgrades-unsafe-allow: constructor

constructor(EthVaultConstructorArgs memory args, address poolEscrow, address rewardEthToken) EthVault(args);

Parameters

Name	Type	Description
args	EthVaultConstructorArgs	The arguments for initializing the EthVault contract
poolEscrow	address	The address of the pool escrow contract
rewardEthToken	address	The address of the reward ETH token contract

initialize

Initializes or upgrades the EthVault contract. Must transfer security deposit during the deployment.

function initialize(bytes calldata) external payable virtual override(IEthVault, EthVault) reinitializer(_version);

Parameters

Name	Type	Description
<none>	bytes

vaultId

Vault Unique Identifier

function vaultId() public pure virtual override(IVaultVersion, EthVault) returns (bytes32);

Returns

Name	Type	Description
<none>	bytes32	The unique identifier of the Vault

version

Version

function version() public pure virtual override(IVaultVersion, EthVault) returns (uint8);

Returns

Name	Type	Description
<none>	uint8	The version of the Vault implementation contract

migrate

Function for migrating from StakeWise Legacy. Can be called only by RewardEthToken contract.

function migrate(address receiver, uint256 assets) external override returns (uint256 shares);

Parameters

Name	Type	Description
receiver	address	The address of the receiver
assets	uint256	The amount of assets migrated

Returns

Name	Type	Description
shares	uint256	The amount of shares minted

receive

Function for depositing using fallback function

receive() external payable virtual override;

_calcMaxMintOsTokenShares

Internal function for calculating the maximum amount of osToken shares that can be minted based on the current user balance

function _calcMaxMintOsTokenShares(address user) private view returns (uint256);

Parameters

Name	Type	Description
user	address	The address of the user

Returns

Name	Type	Description
<none>	uint256	The maximum amount of osToken shares that can be minted

_transferVaultAssets

Internal function for transferring assets from the Vault to the receiver

function _transferVaultAssets(address receiver, uint256 assets)
    internal
    virtual
    override(VaultEnterExit, VaultEthStaking);

Parameters

Name	Type	Description
receiver	address	The address that will receive the assets
assets	uint256	The number of assets to transfer

_vaultAssets

Internal function for retrieving the total assets stored in the Vault. NB! Assets can be forcibly sent to the vault, the returned value must be used with caution

function _vaultAssets() internal view virtual override(VaultState, VaultEthStaking) returns (uint256);

Returns

Name	Type	Description
<none>	uint256	The total amount of assets stored in the Vault

_registerValidator

Internal function for registering validator

function _registerValidator(bytes calldata validator, bool isTopUp, bool isV1Validator)
    internal
    virtual
    override(VaultValidators, VaultEthStaking)
    returns (uint256 depositAmount);

Parameters

Name	Type	Description
validator	bytes	The validator registration data
isTopUp	bool	Whether the registration is a balance top-up
isV1Validator	bool	Whether the validator is V1 or V2

Returns

Name	Type	Description
depositAmount	uint256	The amount of assets that was deposited

_pullWithdrawals

Pulls assets from pool escrow

function _pullWithdrawals() private;