EthErc20MetaVault

Git Source ↗

Inherits: VaultImmutables, Initializable ↗, ReentrancyGuardUpgradeable ↗, VaultAdmin, VaultVersion, VaultFee, VaultState, VaultEnterExit, VaultOsToken, VaultToken, VaultSubVaults, Multicall, IEthErc20MetaVault

Defines the Meta Vault functionality with ERC-20 token on Ethereum

State Variables

_version

uint8 private constant _version = 7

_securityDeposit

uint256 private constant _securityDeposit = 1e9

__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(EthErc20MetaVaultConstructorArgs memory args)
    VaultImmutables(args.keeper, args.vaultsRegistry)
    VaultEnterExit(args.exitingAssetsClaimDelay)
    VaultOsToken(args.osTokenVaultController, args.osTokenConfig, args.osTokenVaultEscrow)
    VaultSubVaults(args.subVaultsRegistryFactory);

Parameters

Name	Type	Description
`args`	`EthErc20MetaVaultConstructorArgs`	The arguments for initializing the EthErc20MetaVault contract

initialize

Initializes or upgrades the EthErc20MetaVault 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 EthErc20MetaVault contract

deposit

Deposit ETH to the Vault

function deposit(address receiver, address referrer) public payable virtual override 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;

updateStateAndDeposit

Updates Vault state and deposits ETH to the Vault

function updateStateAndDeposit(
    address receiver,
    address referrer,
    IKeeperRewards.HarvestParams calldata harvestParams
) public payable virtual override 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.
`harvestParams`	`IKeeperRewards.HarvestParams`	The parameters for harvesting Keeper rewards

Returns

Name	Type	Description
`shares`	`uint256`	The number of shares minted

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

donateAssets

Donate assets to the Vault. Must transfer ETH together with the call.

function donateAssets() external payable override;

transfer

Moves amount tokens from the caller's account to to.

function transfer(address to, uint256 amount) public virtual override(IERC20, ERC20Upgradeable) returns (bool);

transferFrom

Moves amount tokens from from to to using the allowance mechanism. amount is then deducted from the caller's allowance.

function transferFrom(address from, address to, uint256 amount)
    public
    virtual
    override(IERC20, ERC20Upgradeable)
    returns (bool);

transferOsTokenPositionToEscrow

Transfers minted osToken shares to the OsTokenVaultEscrow contract, enters the exit queue for staked assets

function transferOsTokenPositionToEscrow(uint256 osTokenShares)
    public
    virtual
    override(IVaultOsToken, VaultOsToken)
    returns (uint256 positionTicket);

Parameters

Name	Type	Description
`osTokenShares`	`uint256`	The number of osToken shares to transfer

Returns

Name	Type	Description
`positionTicket`	`uint256`	The exit position ticket

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

Vault Unique Identifier

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

Returns

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

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

_depositToVault

Internal function to deposit assets to the sub-vault

function _depositToVault(address vault, uint256 assets) internal override returns (uint256);

Parameters

Name	Type	Description
`vault`	`address`	The address of the vault
`assets`	`uint256`	The amount of assets to deposit

Returns

Name	Type	Description
`<none>`	`uint256`	The amount of vault shares received

_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 returns (uint256);

Returns

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

_transferVaultAssets

Internal function for transferring assets from the Vault to the receiver

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

Parameters

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

isStateUpdateRequired

Check whether state update is required

function isStateUpdateRequired()
    public
    view
    virtual
    override(IVaultState, VaultState, VaultSubVaults)
    returns (bool);

Returns

Name	Type	Description
`<none>`	`bool`	`true` if state update is required, `false` otherwise

updateState

Updates the total amount of assets in the Vault and its exit queue

function updateState(IKeeperRewards.HarvestParams calldata harvestParams)
    public
    virtual
    override(IVaultState, VaultState, VaultSubVaults);

Parameters

Name	Type	Description
`harvestParams`	`IKeeperRewards.HarvestParams`	The parameters for harvesting Keeper rewards

_updateExitQueue

Internal function that must be used to process exit queue

function _updateExitQueue() internal virtual override(VaultState, VaultToken) returns (uint256 burnedShares);

Returns

Name	Type	Description
`burnedShares`	`uint256`	The total amount of burned shares

_mintShares

Internal function for minting shares

function _mintShares(address owner, uint256 shares) internal virtual override(VaultState, VaultToken);

Parameters

Name	Type	Description
`owner`	`address`	The address of the owner to mint shares to
`shares`	`uint256`	The number of shares to mint

_burnShares

Internal function for burning shares

function _burnShares(address owner, uint256 shares) internal virtual override(VaultState, VaultToken);

Parameters

Name	Type	Description
`owner`	`address`	The address of the owner to burn shares for
`shares`	`uint256`	The number of shares to burn

_checkHarvested

Internal method for checking whether the vault is harvested

function _checkHarvested() internal view virtual override(VaultImmutables, VaultSubVaults);

_isCollateralized

Returns whether the vault is collateralized

function _isCollateralized() internal view virtual override(VaultImmutables, VaultSubVaults) returns (bool);

Returns

Name	Type	Description
`<none>`	`bool`	true if the vault is collateralized