NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix issues in the ERC4646Fee documentation (#4487)

Browse Source 
(cherry picked from commit d6b63a48ba)
This commit is contained in:
Hadrien Croubois
2023-07-29 17:30:47 +02:00
committed by Francisco Giordano
parent 1014ac2924
commit 98c7a4cf95
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
contracts/mocks/docs/ERC4626Fees.sol
View File

@ -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.