Skip to main content

Module IERC4626

Module IERC4626 

Source
Expand description

Module containing a contract’s types and functions.

interface IERC4626 {
    function asset() external view returns (address assetTokenAddress);
    function totalAssets() external view returns (uint256 totalManagedAssets);
    function convertToShares(uint256 assets) external view returns (uint256 shares);
    function convertToAssets(uint256 shares) external view returns (uint256 assets);
    function maxDeposit(address receiver) external view returns (uint256 maxAssets);
    function previewDeposit(uint256 assets) external view returns (uint256 shares);
    function deposit(uint256 assets, address receiver) external returns (uint256 shares);
    function maxMint(address receiver) external view returns (uint256 maxShares);
    function previewMint(uint256 shares) external view returns (uint256 assets);
    function mint(uint256 shares, address receiver) external returns (uint256 assets);
    function maxWithdraw(address owner) external view returns (uint256 maxAssets);
    function previewWithdraw(uint256 assets) external view returns (uint256 shares);
    function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
    function maxRedeem(address owner) external view returns (uint256 maxShares);
    function previewRedeem(uint256 shares) external view returns (uint256 assets);
    function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
    function name() external view returns (string);
    function symbol() external view returns (string);
    function decimals() external view returns (uint8);
    function totalSupply() external view returns (uint256 shares);
    function balanceOf(address owner) external view returns (uint256 shares);
    function allowance(address owner, address spender) external view returns (uint256 shares);
}

Structs§

IERC4626Instance
A IERC4626 instance.
allowanceCall
Function with signature allowance(address,address) and selector 0xdd62ed3e.
allowanceReturn
Container type for the return parameters of the allowance(address,address) function.
assetCall
Function with signature asset() and selector 0x38d52e0f.
assetReturn
Container type for the return parameters of the asset() function.
balanceOfCall
Function with signature balanceOf(address) and selector 0x70a08231.
balanceOfReturn
Container type for the return parameters of the balanceOf(address) function.
convertToAssetsCall
Function with signature convertToAssets(uint256) and selector 0x07a2d13a.
convertToAssetsReturn
Container type for the return parameters of the convertToAssets(uint256) function.
convertToSharesCall
Function with signature convertToShares(uint256) and selector 0xc6e6f592.
convertToSharesReturn
Container type for the return parameters of the convertToShares(uint256) function.
decimalsCall
Function with signature decimals() and selector 0x313ce567.
decimalsReturn
Container type for the return parameters of the decimals() function.
depositCall
Function with signature deposit(uint256,address) and selector 0x6e553f65.
depositReturn
Container type for the return parameters of the deposit(uint256,address) function.
maxDepositCall
Function with signature maxDeposit(address) and selector 0x402d267d.
maxDepositReturn
Container type for the return parameters of the maxDeposit(address) function.
maxMintCall
Function with signature maxMint(address) and selector 0xc63d75b6.
maxMintReturn
Container type for the return parameters of the maxMint(address) function.
maxRedeemCall
Function with signature maxRedeem(address) and selector 0xd905777e.
maxRedeemReturn
Container type for the return parameters of the maxRedeem(address) function.
maxWithdrawCall
Function with signature maxWithdraw(address) and selector 0xce96cb77.
maxWithdrawReturn
Container type for the return parameters of the maxWithdraw(address) function.
mintCall
Function with signature mint(uint256,address) and selector 0x94bf804d.
mintReturn
Container type for the return parameters of the mint(uint256,address) function.
nameCall
Function with signature name() and selector 0x06fdde03.
nameReturn
Container type for the return parameters of the name() function.
previewDepositCall
Function with signature previewDeposit(uint256) and selector 0xef8b30f7.
previewDepositReturn
Container type for the return parameters of the previewDeposit(uint256) function.
previewMintCall
Function with signature previewMint(uint256) and selector 0xb3d7f6b9.
previewMintReturn
Container type for the return parameters of the previewMint(uint256) function.
previewRedeemCall
Function with signature previewRedeem(uint256) and selector 0x4cdad506.
previewRedeemReturn
Container type for the return parameters of the previewRedeem(uint256) function.
previewWithdrawCall
Function with signature previewWithdraw(uint256) and selector 0x0a28a477.
previewWithdrawReturn
Container type for the return parameters of the previewWithdraw(uint256) function.
redeemCall
Function with signature redeem(uint256,address,address) and selector 0xba087652.
redeemReturn
Container type for the return parameters of the redeem(uint256,address,address) function.
symbolCall
Function with signature symbol() and selector 0x95d89b41.
symbolReturn
Container type for the return parameters of the symbol() function.
totalAssetsCall
Function with signature totalAssets() and selector 0x01e1d114.
totalAssetsReturn
Container type for the return parameters of the totalAssets() function.
totalSupplyCall
Function with signature totalSupply() and selector 0x18160ddd.
totalSupplyReturn
Container type for the return parameters of the totalSupply() function.
withdrawCall
Function with signature withdraw(uint256,address,address) and selector 0xb460af94.
withdrawReturn
Container type for the return parameters of the withdraw(uint256,address,address) function.

Enums§

IERC4626Calls
Container for all the IERC4626 function calls.

Functions§

new
Creates a new wrapper around an on-chain IERC4626 contract instance.