From 98c7a4cf958f7014e3c5347aeb0678b585eb870d Mon Sep 17 00:00:00 2001 From: Hadrien Croubois Date: Sat, 29 Jul 2023 17:30:47 +0200 Subject: [PATCH] Fix issues in the ERC4646Fee documentation (#4487) (cherry picked from commit d6b63a48ba440ad8d551383697db6e5b0ef84137) --- contracts/mocks/docs/ERC4626Fees.sol | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contracts/mocks/docs/ERC4626Fees.sol b/contracts/mocks/docs/ERC4626Fees.sol index 084278984..315aa18fa 100644 --- a/contracts/mocks/docs/ERC4626Fees.sol +++ b/contracts/mocks/docs/ERC4626Fees.sol @@ -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) { @@ -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) { @@ -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.