Skip to content

Commit e3386f2

Browse files
authored
fix(IERC4626): fix grammatical errors and typos in comments (#781)
1 parent 1801b05 commit e3386f2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/interfaces/IERC4626.sol

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ interface IERC4626 is IERC20 {
7979
/// - MUST emit the Deposit event.
8080
/// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
8181
/// deposit execution, and are accounted for during deposit.
82-
/// - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
82+
/// - MUST revert if all assets cannot be deposited (due to deposit limit being reached, slippage, the user not
8383
/// approving enough underlying tokens to the Vault contract, etc).
8484
///
8585
/// NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
@@ -112,7 +112,7 @@ interface IERC4626 is IERC20 {
112112
/// - MUST emit the Deposit event.
113113
/// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint
114114
/// execution, and are accounted for during mint.
115-
/// - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
115+
/// - MUST revert if all shares cannot be minted (due to deposit limit being reached, slippage, the user not
116116
/// approving enough underlying tokens to the Vault contract, etc).
117117
///
118118
/// NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
@@ -146,7 +146,7 @@ interface IERC4626 is IERC20 {
146146
/// - MUST emit the Withdraw event.
147147
/// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
148148
/// withdraw execution, and are accounted for during withdrawal.
149-
/// - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
149+
/// - MUST revert if all assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
150150
/// not having enough shares, etc).
151151
///
152152
/// Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
@@ -161,7 +161,7 @@ interface IERC4626 is IERC20 {
161161
/// - MUST NOT revert.
162162
function maxRedeem(address owner) external view returns (uint256 maxShares);
163163

164-
/// @notice Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block,
164+
/// @notice Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block,
165165
/// given current on-chain conditions.
166166
/// @dev
167167
/// - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
@@ -181,7 +181,7 @@ interface IERC4626 is IERC20 {
181181
/// - MUST emit the Withdraw event.
182182
/// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
183183
/// redeem execution, and are accounted for during redeem.
184-
/// - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
184+
/// - MUST revert if all shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
185185
/// not having enough shares, etc).
186186
///
187187
/// NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed.

0 commit comments

Comments
 (0)