Browse Source

Add a caution note to ERC4626 about EOA access (#3503)

(cherry picked from commit 450c569d78aa57e8e73547f99ec412409c73d852)
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Francisco 3 years ago
parent
commit
4307d74966
1 changed files with 4 additions and 0 deletions
  1. 4 0
      contracts/token/ERC20/extensions/ERC4626.sol

+ 4 - 0
contracts/token/ERC20/extensions/ERC4626.sol

@@ -17,6 +17,10 @@ import "../../../utils/math/Math.sol";
  * the ERC20 standard. Any additional extensions included along it would affect the "shares" token represented by this
  * contract and not the "assets" token which is an independent contract.
  *
+ * CAUTION: Deposits and withdrawals may incur unexpected slippage. Users should verify that the amount received of
+ * shares or assets is as expected. EOAs should operate through a wrapper that performs these checks such as
+ * https://github.com/fei-protocol/ERC4626#erc4626router-and-base[ERC4626Router].
+ *
  * _Available since v4.7._
  */
 abstract contract ERC4626 is ERC20, IERC4626 {