IERC7575Vault

Git Source

Interface for ERC7575-compliant vault contracts

This interface defines the core vault operations for managing individual collateral assets within the multi-asset ecosystem.

Functions

share

Returns the address of the share token

function share() external view returns (address);

asset

Returns the address of the underlying asset token

Each vault manages a single underlying asset

function asset() external view returns (address);

totalAssets

Returns the total amount of underlying assets managed by the vault

This includes assets held directly in the vault plus assets deployed to yield strategies

function totalAssets() external view returns (uint256);

convertToShares

Converts an amount of assets to the equivalent amount of shares

Returns the exchange rate between vault shares and underlying assets. Always returns a 1:1 ratio because to calculate the proper value via dynamic pricing, the contract would need to know if it's a deposit or withdraw operation.

function convertToShares(uint256 assets) external view returns (uint256);

convertToAssets

Converts an amount of shares to the equivalent amount of assets

Returns the exchange rate between vault shares and underlying assets. Always returns a 1:1 ratio because to calculate the proper value via dynamic pricing, the contract would need to know if it's a deposit or withdraw operation.

function convertToAssets(uint256 shares) external view returns (uint256);

deposit

Deposits assets into the vault and mints shares to the receiver

function deposit(uint256 assets, address receiver) external returns (uint256 shares);

mint

Mints a specific amount of shares by depositing the required assets

function mint(uint256 shares, address receiver) external returns (uint256 assets);

withdraw

Withdraws a specific amount of assets by burning the required shares

function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);

redeem

Burns shares and withdraws the equivalent amount of assets

function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);

previewDeposit

Simulates the effects of a deposit without executing it

Calculates how many shares would be minted for a given asset deposit using current dynamic pricing from the Controller

function previewDeposit(uint256 assets) external view returns (uint256 shares);

previewMint

Simulates the effects of a mint without executing it

Calculates how many assets would be required to mint a given amount of shares using current dynamic pricing from the Controller

function previewMint(uint256 shares) external view returns (uint256 assets);

previewWithdraw

Simulates the effects of a withdrawal without executing it

Calculates how many shares would be burned for a given asset withdrawal using current dynamic pricing from the Controller

function previewWithdraw(uint256 assets) external view returns (uint256 shares);

previewRedeem

Simulates the effects of a redemption without executing it

Calculates how many assets would be withdrawn for a given amount of shares using current dynamic pricing from the Controller

function previewRedeem(uint256 shares) external view returns (uint256 assets);

maxDeposit

Returns the maximum amount of assets that can be deposited for a given receiver

Takes into account vault capacity limits

function maxDeposit(address receiver) external view returns (uint256);

maxMint

Returns the maximum amount of shares that can be minted for a given receiver

Takes into account vault capacity limits

function maxMint(address receiver) external view returns (uint256);

maxWithdraw

Returns the maximum amount of assets that can be withdrawn by a given owner

Takes into account owner's share balance and vault capacity limits

function maxWithdraw(address owner) external view returns (uint256);

maxRedeem

Returns the maximum amount of shares that can be redeemed by a given owner

Takes into account owner's share balance and vault capacity limits

function maxRedeem(address owner) external view returns (uint256);

Events

Deposit

Emitted when assets are deposited into the vault

This event follows the ERC7575 standard for deposit operations

event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);

Withdraw

Emitted when assets are withdrawn from the vault

This event follows the ERC7575 standard for withdrawal operations

event Withdraw(
    address indexed sender, address indexed receiver, address indexed owner, uint256 assets, uint256 shares
);