Преглед на файлове

Add note about opinionated design to ERC4626Fees (#5129)

Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Ernesto García преди 1 година
родител
ревизия
234427adda
променени са 1 файла, в които са добавени 6 реда и са изтрити 0 реда
  1. 6 0
      contracts/mocks/docs/ERC4626Fees.sol

+ 6 - 0
contracts/mocks/docs/ERC4626Fees.sol

@@ -8,6 +8,12 @@ import {SafeERC20} from "../../token/ERC20/utils/SafeERC20.sol";
 import {Math} from "../../utils/math/Math.sol";
 
 /// @dev ERC-4626 vault with entry/exit fees expressed in https://en.wikipedia.org/wiki/Basis_point[basis point (bp)].
+///
+/// NOTE: The contract charges fees in terms of assets, not shares. This means that the fees are calculated based on the
+/// amount of assets that are being deposited or withdrawn, and not based on the amount of shares that are being minted or
+/// redeemed. This is an opinionated design decision that should be taken into account when integrating this contract.
+///
+/// WARNING: This contract has not been audited and shouldn't be considered production ready. Consider using it with caution.
 abstract contract ERC4626Fees is ERC4626 {
     using Math for uint256;