Skip to content

Commit

Permalink
Fix issues in the ERC4646Fee documentation (#4487)
Browse files Browse the repository at this point in the history
(cherry picked from commit d6b63a4)
  • Loading branch information
Amxx authored and frangio committed Sep 21, 2023
1 parent 1014ac2 commit 98c7a4c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions contracts/mocks/docs/ERC4626Fees.sol
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ abstract contract ERC4626Fees is ERC4626 {

uint256 private constant _BASIS_POINT_SCALE = 1e4;

// === Overrides === ///
// === Overrides ===

/// @dev Preview taking an entry fee on deposit. See {IERC4626-previewDeposit}.
function previewDeposit(uint256 assets) public view virtual override returns (uint256) {
Expand Down Expand Up @@ -66,14 +66,14 @@ abstract contract ERC4626Fees is ERC4626 {
}
}

// === Fee configuration === ///
// === Fee configuration ===

function _entryFeeBasisPoints() internal view virtual returns (uint256) {
return 0; // replace with e.g. 1_000 for 1%
return 0; // replace with e.g. 100 for 1%
}

function _exitFeeBasisPoints() internal view virtual returns (uint256) {
return 0; // replace with e.g. 1_000 for 1%
return 0; // replace with e.g. 100 for 1%
}

function _entryFeeRecipient() internal view virtual returns (address) {
Expand All @@ -84,7 +84,7 @@ abstract contract ERC4626Fees is ERC4626 {
return address(0); // replace with e.g. a treasury address
}

// === Fee operations === ///
// === Fee operations ===

/// @dev Calculates the fees that should be added to an amount `assets` that does not already include fees.
/// Used in {IERC4626-mint} and {IERC4626-withdraw} operations.
Expand Down

0 comments on commit 98c7a4c

Please sign in to comment.