IERC4626DispatcherTrait

MUST NOT be inclusive of any fees that are charged against assets in the Vault.
MUST NOT show any variations depending on the caller.
MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
MUST round down towards 0.

NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::convert_to_shares

fn convert_to_shares(self: T, assets: u256) -> u256

convert_to_assets

Returns the amount of assets that the Vault would exchange for the amount of shares provided irrespective of slippage or fees.

Requirements:

MUST NOT be inclusive of any fees that are charged against assets in the Vault.
MUST NOT show any variations depending on the caller.
MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
MUST round down towards 0.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::convert_to_assets

fn convert_to_assets(self: T, shares: u256) -> u256

max_deposit

Returns the maximum amount of the underlying asset that can be deposited into the Vault for receiver, through a deposit call.

Requirements:

MUST return a limited value if receiver is subject to some deposit limit.
MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
MUST NOT panic.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_deposit

fn max_deposit(self: T, receiver: ContractAddress) -> u256

preview_deposit

Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions.

Requirements:

MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit call in the same transaction i.e. deposit should return the same or more shares as preview_deposit if called in the same transaction.
MUST NOT account for deposit limits like those returned from max_deposit and should always act as though the deposit would be accepted, regardless if the user has enough tokens approved, etc.
MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
MUST NOT panic.

NOTE: Any unfavorable discrepancy between convert_to_shares and preview_deposit SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by depositing.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_deposit

fn preview_deposit(self: T, assets: u256) -> u256

deposit

Mints Vault shares to receiver by depositing exactly amount of assets.

Requirements:

MUST emit the Deposit event.
MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the deposit execution, and are accounted for during deposit.
MUST panic if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).

NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::deposit

fn deposit(self: T, assets: u256, receiver: ContractAddress) -> u256

max_mint

Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.

Requirements:

MUST return a limited value if receiver is subject to some mint limit.
MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
MUST NOT panic.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_mint

fn max_mint(self: T, receiver: ContractAddress) -> u256

preview_mint

Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current on-chain conditions.

Requirements:

MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call in the same transaction. I.e. mint should return the same or fewer assets as preview_mint if called in the same transaction.
MUST NOT account for mint limits like those returned from max_mint and should always act as though the mint would be accepted, regardless if the user has enough tokens approved, etc.
MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
MUST NOT panic.

NOTE: Any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by minting.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_mint

fn preview_mint(self: T, shares: u256) -> u256

mint

Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.

Requirements:

MUST emit the Deposit event.
MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint execution, and are accounted for during mint.
MUST panic if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).

NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::mint

fn mint(self: T, shares: u256, receiver: ContractAddress) -> u256

max_withdraw

Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the Vault, through a withdraw call.

Requirements:

MUST return a limited value if owner is subject to some withdrawal limit or timelock.
MUST NOT panic.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_withdraw

fn max_withdraw(self: T, owner: ContractAddress) -> u256

preview_withdraw

Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given current on-chain conditions.

Requirements:

MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw call in the same transaction i.e. withdraw should return the same or fewer shares as preview_withdraw if called in the same transaction.
MUST NOT account for withdrawal limits like those returned from max_withdraw and should always act as though the withdrawal would be accepted, regardless if the user has enough shares, etc.
MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
MUST not panic.

NOTE: Any unfavorable discrepancy between convert_to_shares and preview_withdraw SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by depositing.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_withdraw

fn preview_withdraw(self: T, assets: u256) -> u256

withdraw

Burns shares from owner and sends exactly assets of underlying tokens to receiver.

Requirements:

MUST emit the Withdraw event.
MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the withdraw execution, and are accounted for during withdraw.
MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).

NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::withdraw

fn withdraw(self: T, assets: u256, receiver: ContractAddress, owner: ContractAddress) -> u256

max_redeem

Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, through a redeem call.

Requirements:

MUST return a limited value if owner is subject to some withdrawal limit or timelock.
MUST return ERC20::balance_of(owner) if owner is not subject to any withdrawal limit or timelock.
MUST NOT panic.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_redeem

fn max_redeem(self: T, owner: ContractAddress) -> u256

preview_redeem

Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given current on-chain conditions.

Requirements:

MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call in the same transaction i.e. redeem should return the same or more assets as preview_redeem if called in the same transaction.
MUST NOT account for redemption limits like those returned from max_redeem and should always act as though the redemption would be accepted, regardless if the user has enough shares, etc.
MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
MUST NOT panic.

NOTE: Any unfavorable discrepancy between convert_to_assets and preview_redeem SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by redeeming.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_redeem

fn preview_redeem(self: T, shares: u256) -> u256

redeem

Burns exactly shares from owner and sends assets of underlying tokens to receiver.

Requirements:

MUST emit the Withdraw event.
MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the redeem execution, and are accounted for during redeem.
MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).

NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.

Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::redeem

fn redeem(self: T, shares: u256, receiver: ContractAddress, owner: ContractAddress) -> u256

Keyboard shortcuts

openzeppelin_interfaces - Cairo