Skip to content

Commit

Permalink
docs(slippage): highlight slippage behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
Rubilmax committed Dec 21, 2023
1 parent d728c82 commit 8deebc8
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/ERC4626Bundler.sol
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ abstract contract ERC4626Bundler is BaseBundler {
/// @dev Initiator must have previously transferred their assets to the bundler.
/// @dev Assumes the given `vault` implements EIP-4626.
/// @param vault The address of the vault.
/// @param assets The amount of assets to deposit. Will be capped at the bundler's assets.
/// @param minShares The minimum amount of shares to mint in exchange for `assets`.
/// @param assets The amount of assets to deposit. Pass `type(uint256).max` to deposit the bundler's assets.
/// @param minShares The minimum amount of shares to mint in exchange for `assets`. This parameter is proportionally
/// scaled down in case there are fewer assets than `assets` on the bundler.
/// @param receiver The address to which shares will be minted.
function erc4626Deposit(address vault, uint256 assets, uint256 minShares, address receiver)
external
Expand Down Expand Up @@ -94,8 +95,9 @@ abstract contract ERC4626Bundler is BaseBundler {
/// @notice Redeems the given amount of `shares` from the given ERC4626 `vault`, transferring assets to `receiver`.
/// @dev Assumes the given `vault` implements EIP-4626.
/// @param vault The address of the vault.
/// @param shares The amount of shares to burn. Will be capped at the bundler's shares.
/// @param minAssets The minimum amount of assets to withdraw in exchange for `shares`.
/// @param shares The amount of shares to burn. Pass `type(uint256).max` to redeem the bundler's shares.
/// @param minAssets The minimum amount of assets to withdraw in exchange for `shares`. This parameter is
/// proportionally scaled down in case there are fewer shares than `shares` on the bundler.
/// @param receiver The address that will receive the withdrawn assets.
/// @param owner The address on behalf of which the shares are redeemed. Can only be the bundler or the initiator.
/// If `owner` is the initiator, they must have previously approved the bundler to spend their vault shares.
Expand Down

0 comments on commit 8deebc8

Please sign in to comment.