EIP-4626 Vault Functions

12 Main functions

previewmaxexecute
depositpreviewDeposit()maxDeposit()deposit()
mintpreviewMint()maxMint()mint()
withdrawpreviewWithdraw()maxWithdraw()withdraw()
redeempreviewRedeem()maxRedeem()redeem()

All 4626 functions

CategoryFunctionDescription
PreviewpreviewDeposit(uint256)Simulates shares received for a given asset deposit
PreviewpreviewMint(uint256)Simulates assets required to mint a given amount of shares
PreviewpreviewWithdraw(uint256)Simulates shares needed to withdraw a given amount of assets
PreviewpreviewRedeem(uint256)Simulates assets received for redeeming a given amount of shares
MaxmaxDeposit(address)Max assets that address can deposit
MaxmaxMint(address)Max shares that address can mint
MaxmaxWithdraw(address)Max assets that address can withdraw
MaxmaxRedeem(address)Max shares that address can redeem
Executedeposit(uint256 assets, address receiver)Deposit assets and receive shares
Executemint(uint256 shares, address receiver)Mint shares by depositing equivalent assets
Executewithdraw(uint256 assets, address receiver, address owner)Withdraw assets by burning shares
Executeredeem(uint256 shares, address receiver, address owner)Redeem shares for assets
Otherasset()Returns the underlying asset address (ERC-20)
OthertotalAssets()Total amount of underlying assets managed by the vault
OtherconvertToShares(uint256 assets)Converts assets to shares
OtherconvertToAssets(uint256 shares)Converts shares to assets
ERC-20balanceOf(address)Returns share balance of an account
ERC-20totalSupply()Total supply of shares
ERC-20transfer(address, uint256)Transfers shares to another address
ERC-20transferFrom(address, address, uint256)Transfers shares on behalf of another
ERC-20approve(address, uint256)Approves a spender
ERC-20allowance(address, address)Returns remaining allowance for a spender
ERC-20name()Share token name
ERC-20symbol()Share token symbol
ERC-20decimals()Share token decimals (commonly 18)