EthVault

Git Source ↗

Inherits: VaultImmutables →, Initializable ↗, VaultAdmin →, VaultVersion →, VaultFee →, VaultState →, VaultValidators →, VaultEnterExit →, VaultOsToken →, VaultMev →, VaultEthStaking →, Multicall →, IEthVault

Defines the Ethereum staking Vault.

Structs

EthVaultConstructorArgs

Struct for deploying the EthVault contract

struct EthVaultConstructorArgs {
    address keeper;
    address vaultsRegistry;
    address validatorsRegistry;
    address validatorsWithdrawals;
    address validatorsConsolidations;
    address consolidationsChecker;
    address osTokenVaultController;
    address osTokenConfig;
    address osTokenVaultEscrow;
    address sharedMevEscrow;
    address depositDataRegistry;
    uint64 exitingAssetsClaimDelay;
}

Properties

Name	Type	Description
keeper	address	The address of the Keeper contract
vaultsRegistry	address	The address of the VaultsRegistry contract
validatorsRegistry	address	The contract address used for registering validators in beacon chain
validatorsWithdrawals	address	The contract address used for withdrawing validators in beacon chain
validatorsConsolidations	address	The contract address used for consolidating validators in beacon chain
consolidationsChecker	address	The contract address used for checking consolidations
osTokenVaultController	address	The address of the OsTokenVaultController contract
osTokenConfig	address	The address of the OsTokenConfig contract
osTokenVaultEscrow	address	The address of the OsTokenVaultEscrow contract
sharedMevEscrow	address	The address of the shared MEV escrow
depositDataRegistry	address	The address of the DepositDataRegistry contract
exitingAssetsClaimDelay	uint64	The delay after which the assets can be claimed after exiting from staking

EthVaultInitParams

Struct for initializing the EthVault contract

struct EthVaultInitParams {
    uint256 capacity;
    uint16 feePercent;
    string metadataIpfsHash;
}

Properties

Name	Type	Description
capacity	uint256	The Vault stops accepting deposits after exceeding the capacity
feePercent	uint16	The fee percent that is charged by the Vault
metadataIpfsHash	string	The IPFS hash of the Vault's metadata file

Functions

depositAndMintOsToken

Deposits assets to the vault and mints OsToken shares to the receiver

function depositAndMintOsToken(address receiver, uint256 osTokenShares, address referrer)
    public
    payable
    override
    returns (uint256);

Parameters

Name	Type	Description
receiver	address	The address to receive the OsToken
osTokenShares	uint256	The amount of OsToken shares to mint. If set to type(uint256).max, max OsToken shares will be minted.
referrer	address	The address of the referrer

Returns

Name	Type	Description
<none>	uint256	The amount of OsToken assets minted

updateStateAndDepositAndMintOsToken

Updates the state, deposits assets to the vault and mints OsToken shares to the receiver

function updateStateAndDepositAndMintOsToken(
    address receiver,
    uint256 osTokenShares,
    address referrer,
    IKeeperRewards.HarvestParams calldata harvestParams
) external payable override returns (uint256);

Parameters

Name	Type	Description
receiver	address	The address to receive the OsToken
osTokenShares	uint256	The amount of OsToken shares to mint. If set to type(uint256).max, max OsToken shares will be minted.
referrer	address	The address of the referrer
harvestParams	IKeeperRewards.HarvestParams	The parameters for the harvest

Returns

Name	Type	Description
<none>	uint256	The amount of OsToken assets minted

enterExitQueue

Locks shares to the exit queue. The shares continue earning rewards until they will be burned by the Vault.

function enterExitQueue(uint256 shares, address receiver)
    public
    virtual
    override(IVaultEnterExit, VaultEnterExit, VaultOsToken)
    returns (uint256 positionTicket);

Parameters

Name	Type	Description
shares	uint256	The number of shares to lock
receiver	address	The address that will receive assets upon withdrawal

Returns

Name	Type	Description
positionTicket	uint256	The position ticket of the exit queue. Returns uint256 max if no ticket created.

vaultId

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

version

Version

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

Returns

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