Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix error in comments to previewRedeem function #105

Closed
wants to merge 1 commit into from
Closed

Fix error in comments to previewRedeem function #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions with-foundry/lib/forge-std/src/interfaces/IERC4626.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ interface IERC4626 is IERC20 {
/// - MUST NOT revert.
///
/// NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in
/// share price or some other type of condition, meaning the depositor will lose assets by depositing.
/// share price or some other type of condition, meaning the depositor will lose assets by withdrawing.
function previewWithdraw(uint256 assets) external view returns (uint256 shares);

/// @notice Burns shares from owner and sends exactly assets of underlying tokens to receiver.
Expand All @@ -161,7 +161,7 @@ interface IERC4626 is IERC20 {
/// - MUST NOT revert.
function maxRedeem(address owner) external view returns (uint256 maxShares);

/// @notice Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block,
/// @notice Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block,
/// given current on-chain conditions.
/// @dev
/// - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
Expand Down
Loading