EthPrivVault

Git Source ↗

Inherits: Initializable ↗, EthVault →, VaultWhitelist →, IEthPrivVault

Defines the Ethereum staking Vault with whitelist.

Functions

deposit

Deposit ETH to the Vault

function deposit(address receiver, address referrer)
    public
    payable
    virtual
    override(IVaultEthStaking, VaultEthStaking)
    returns (uint256 shares);

Parameters

Name	Type	Description
receiver	address	The address that will receive Vault's shares
referrer	address	The address of the referrer. Set to zero address if not used.

Returns

Name	Type	Description
shares	uint256	The number of shares minted

receive

Function for depositing using fallback function

receive() external payable virtual override;

mintOsToken

Mints OsToken shares

function mintOsToken(address receiver, uint256 osTokenShares, address referrer)
    public
    virtual
    override(IVaultOsToken, VaultOsToken)
    returns (uint256 assets);

Parameters

Name	Type	Description
receiver	address	The address that will receive the minted OsToken shares
osTokenShares	uint256	The number of OsToken shares to mint to the receiver. To mint the maximum amount of shares, use 2^256 - 1.
referrer	address	The address of the referrer

Returns

Name	Type	Description
assets	uint256	The number of assets minted to the receiver

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