EthVault

Git Source ↗

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

Defines the Ethereum staking Vault

State Variables

_version

uint8 private constant _version = 5

__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)
    VaultImmutables(args.keeper, args.vaultsRegistry)
    VaultValidators(
        args.depositDataRegistry,
        args.validatorsRegistry,
        args.validatorsWithdrawals,
        args.validatorsConsolidations,
        args.consolidationsChecker
    )
    VaultEnterExit(args.exitingAssetsClaimDelay)
    VaultOsToken(args.osTokenVaultController, args.osTokenConfig, args.osTokenVaultEscrow)
    VaultMev(args.sharedMevEscrow);

Parameters

Name	Type	Description
args	EthVaultConstructorArgs	The arguments for initializing the EthVault contract

initialize

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

function initialize(bytes calldata params) external payable virtual override reinitializer(_version);

Parameters

Name	Type	Description
params	bytes	The encoded parameters for initializing the EthVault contract

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.

For ERC-20 vault variants, balanceOf(vault) does not reflect queued exit shares despite the emitted Transfer event.

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.

donateShares

Donates shares to the Vault by burning them from the caller, increasing the value per share for remaining holders

function donateShares(uint256 shares) public virtual override(IVaultState, VaultState, VaultOsToken);

Parameters

Name	Type	Description
shares	uint256	The number of shares to donate

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

__EthVault_upgrade

Upgrades the EthVault contract

function __EthVault_upgrade() internal;

__EthVault_init

Initializes the EthVault contract

function __EthVault_init(address admin, address ownMevEscrow, EthVaultInitParams memory params)
    internal
    onlyInitializing;

Parameters

Name	Type	Description
admin	address	The address of the admin of the Vault
ownMevEscrow	address	The address of the MEV escrow owned by the Vault. Zero address if shared MEV escrow is used.
params	EthVaultInitParams	The decoded parameters for initializing the EthVault contract