Просмотр исходного кода

Improve ERC-1363 documentation (#4854)

Co-authored-by: Ernesto García <ernestognw@gmail.com>
Co-authored-by: Vittorio Minacori <vittoriominacori@gmail.com>
Hadrien Croubois 1 год назад
Родитель
Сommit
b5a7f977d8
1 измененных файлов с 7 добавлено и 7 удалено
  1. 7 7
      contracts/token/ERC20/extensions/ERC1363.sol

+ 7 - 7
contracts/token/ERC20/extensions/ERC1363.sol

@@ -58,7 +58,7 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363 {
      *
      * - The target has code (i.e. is a contract).
      * - The target `to` must implement the {IERC1363Receiver} interface.
-     * - The target should return the {IERC1363Receiver} interface id.
+     * - The target must return the {IERC1363Receiver-onTransferReceived} selector to accept the transfer.
      * - The internal {transfer} must succeed (returned `true`).
      */
     function transferAndCall(address to, uint256 value) public returns (bool) {
@@ -85,7 +85,7 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363 {
      *
      * - The target has code (i.e. is a contract).
      * - The target `to` must implement the {IERC1363Receiver} interface.
-     * - The target should return the {IERC1363Receiver} interface id.
+     * - The target must return the {IERC1363Receiver-onTransferReceived} selector to accept the transfer.
      * - The internal {transferFrom} must succeed (returned `true`).
      */
     function transferFromAndCall(address from, address to, uint256 value) public returns (bool) {
@@ -116,8 +116,8 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363 {
      * Requirements:
      *
      * - The target has code (i.e. is a contract).
-     * - The target `to` must implement the {IERC1363Spender} interface.
-     * - The target should return the {IERC1363Spender} interface id.
+     * - The target `spender` must implement the {IERC1363Spender} interface.
+     * - The target must return the {IERC1363Spender-onApprovalReceived} selector to accept the approval.
      * - The internal {approve} must succeed (returned `true`).
      */
     function approveAndCall(address spender, uint256 value) public returns (bool) {
@@ -143,7 +143,7 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363 {
      *
      * - The target has code (i.e. is a contract).
      * - The target `to` must implement the {IERC1363Receiver} interface.
-     * - The target should return the {IERC1363Receiver} interface id.
+     * - The target must return the {IERC1363Receiver-onTransferReceived} selector to accept the transfer.
      */
     function _checkOnTransferReceived(address from, address to, uint256 value, bytes memory data) private {
         if (to.code.length == 0) {
@@ -172,8 +172,8 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363 {
      * Requirements:
      *
      * - The target has code (i.e. is a contract).
-     * - The target `to` must implement the {IERC1363Spender} interface.
-     * - The target should return the {IERC1363Spender} interface id.
+     * - The target `spender` must implement the {IERC1363Spender} interface.
+     * - The target must return the {IERC1363Spender-onApprovalReceived} selector to accept the approval.
      */
     function _checkOnApprovalReceived(address spender, uint256 value, bytes memory data) private {
         if (spender.code.length == 0) {