Skip to content

Commit

Permalink
Merge pull request #609 from nnsW3/docs-fix-spelling-issues
Browse files Browse the repository at this point in the history
docs fix spelling issues
  • Loading branch information
mattsse authored Sep 26, 2024
2 parents 5a802d7 + 3c18324 commit 28724ea
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ contract Storage {

### stdCheats

This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for address that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.
This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for addresses that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you.


#### Example usage:
Expand Down
2 changes: 1 addition & 1 deletion src/StdCheats.sol
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ abstract contract StdCheatsSafe {

// Checks that `addr` is not blacklisted by token contracts that have a blacklist.
// This is identical to `assumeNotBlacklisted(address,address)` but with a different name, for
// backwards compatibility, since this name was used in the original PR which has already has
// backwards compatibility, since this name was used in the original PR which already has
// a release. This function can be removed in a future release once we want a breaking change.
function assumeNoBlacklisted(address token, address addr) internal view virtual {
assumeNotBlacklisted(token, addr);
Expand Down
4 changes: 2 additions & 2 deletions src/interfaces/IERC4626.sol
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ interface IERC4626 is IERC20 {
function mint(uint256 shares, address receiver) external returns (uint256 assets);

/// @notice Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
/// Vault, through a withdraw call.
/// Vault, through a withdrawal call.
/// @dev
/// - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
/// - MUST NOT revert.
Expand All @@ -145,7 +145,7 @@ interface IERC4626 is IERC20 {
/// @dev
/// - 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.
/// withdraw execution, and are accounted for during withdrawal.
/// - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
/// not having enough shares, etc).
///
Expand Down

0 comments on commit 28724ea

Please sign in to comment.