feat: check erc20 return behavior (#22)

* feat: check erc20 transfers and approvals return value

* feat: rename class and removed reserved words

* chore: bump version

contracts/mocks/ERC1363ReceiverMock.sol

@@ -15,19 +15,19 @@ contract ERC1363ReceiverMock is IERC1363Receiver {
     }
 
     bytes4 private _retval;
-    RevertType private _error;
+    RevertType private _err;
 
     event Received(address operator, address from, uint256 value, bytes data);
     error CustomError(bytes4);
 
     constructor() {
         _retval = IERC1363Receiver.onTransferReceived.selector;
-        _error = RevertType.None;
+        _err = RevertType.None;
     }
 
-    function setUp(bytes4 retval, RevertType error) public {
+    function setUp(bytes4 retval, RevertType err) public {
         _retval = retval;
-        _error = error;
+        _err = err;
     }
 
     function onTransferReceived(
@@ -36,13 +36,13 @@ contract ERC1363ReceiverMock is IERC1363Receiver {
         uint256 value,
         bytes calldata data
     ) external override returns (bytes4) {
-        if (_error == RevertType.RevertWithoutMessage) {
+        if (_err == RevertType.RevertWithoutMessage) {
             revert();
-        } else if (_error == RevertType.RevertWithMessage) {
+        } else if (_err == RevertType.RevertWithMessage) {
             revert("ERC1363ReceiverMock: reverting");
-        } else if (_error == RevertType.RevertWithCustomError) {
+        } else if (_err == RevertType.RevertWithCustomError) {
             revert CustomError(_retval);
-        } else if (_error == RevertType.Panic) {
+        } else if (_err == RevertType.Panic) {
             uint256 a = uint256(0) / uint256(0);
             a;
         }

contracts/mocks/ERC1363ReturnFalseOnERC20Mock.sol

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+import {IERC20, ERC20, ERC1363} from "../token/ERC1363/ERC1363.sol";
+
+// mock class testing an ERC-20 token that returns false
+abstract contract ERC1363ReturnFalseOnERC20Mock is ERC1363 {
+    function transfer(address, uint256) public pure override(IERC20, ERC20) returns (bool) {
+        return false;
+    }
+
+    function transferFrom(address, address, uint256) public pure override(IERC20, ERC20) returns (bool) {
+        return false;
+    }
+
+    function approve(address, uint256) public pure override(IERC20, ERC20) returns (bool) {
+        return false;
+    }
+}

contracts/mocks/ERC1363SpenderMock.sol

@@ -15,29 +15,29 @@ contract ERC1363SpenderMock is IERC1363Spender {
     }
 
     bytes4 private _retval;
-    RevertType private _error;
+    RevertType private _err;
 
     event Approved(address owner, uint256 value, bytes data);
     error CustomError(bytes4);
 
     constructor() {
         _retval = IERC1363Spender.onApprovalReceived.selector;
-        _error = RevertType.None;
+        _err = RevertType.None;
     }
 
-    function setUp(bytes4 retval, RevertType error) public {
+    function setUp(bytes4 retval, RevertType err) public {
         _retval = retval;
-        _error = error;
+        _err = err;
     }
 
     function onApprovalReceived(address owner, uint256 value, bytes calldata data) external override returns (bytes4) {
-        if (_error == RevertType.RevertWithoutMessage) {
+        if (_err == RevertType.RevertWithoutMessage) {
             revert();
-        } else if (_error == RevertType.RevertWithMessage) {
+        } else if (_err == RevertType.RevertWithMessage) {
             revert("ERC1363SpenderMock: reverting");
-        } else if (_error == RevertType.RevertWithCustomError) {
+        } else if (_err == RevertType.RevertWithCustomError) {
             revert CustomError(_retval);
-        } else if (_error == RevertType.Panic) {
+        } else if (_err == RevertType.Panic) {
             uint256 a = uint256(0) / uint256(0);
             a;
         }

contracts/token/ERC1363/ERC1363.sol

@@ -2,7 +2,7 @@
 
 pragma solidity ^0.8.20;
 
-import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import {IERC20, ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import {IERC165, ERC165} from "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 
 import {IERC1363} from "./IERC1363.sol";
@@ -35,7 +35,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
      * @inheritdoc IERC1363
      */
     function transferAndCall(address to, uint256 value, bytes memory data) public virtual returns (bool) {
-        transfer(to, value);
+        if (!transfer(to, value)) {
+            revert ERC1363TransferFailed(to, value);
+        }
         _checkOnTransferReceived(_msgSender(), to, value, data);
         return true;
     }
@@ -56,7 +58,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
         uint256 value,
         bytes memory data
     ) public virtual returns (bool) {
-        transferFrom(from, to, value);
+        if (!transferFrom(from, to, value)) {
+            revert ERC1363TransferFromFailed(from, to, value);
+        }
         _checkOnTransferReceived(from, to, value, data);
         return true;
     }
@@ -72,7 +76,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
      * @inheritdoc IERC1363
      */
     function approveAndCall(address spender, uint256 value, bytes memory data) public virtual returns (bool) {
-        approve(spender, value);
+        if (!approve(spender, value)) {
+            revert ERC1363ApproveFailed(spender, value);
+        }
         _checkOnApprovalReceived(spender, value, data);
         return true;
     }

contracts/token/ERC1363/IERC1363Errors.sol

@@ -30,4 +30,26 @@ interface IERC1363Errors {
      * @param spender The address which will spend the funds.
      */
     error ERC1363InvalidSpender(address spender);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `transfer` during a `transferAndCall` operation. Used in transfers.
+     * @param receiver The address to which tokens are being transferred.
+     * @param value The amount of tokens to be transferred.
+     */
+    error ERC1363TransferFailed(address receiver, uint256 value);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `transferFrom` during a `transferFromAndCall` operation. Used in transfers.
+     * @param sender The address from which to send tokens.
+     * @param receiver The address to which tokens are being transferred.
+     * @param value The amount of tokens to be transferred.
+     */
+    error ERC1363TransferFromFailed(address sender, address receiver, uint256 value);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `approve` during a `approveAndCall` operation. Used in approvals.
+     * @param spender The address which will spend the funds.
+     * @param value The amount of tokens to be spent.
+     */
+    error ERC1363ApproveFailed(address spender, uint256 value);
 }

dist/ERC1363.dist.sol

@@ -802,6 +802,28 @@ interface IERC1363Errors {
      * @param spender The address which will spend the funds.
      */
     error ERC1363InvalidSpender(address spender);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `transfer` during a `transferAndCall` operation. Used in transfers.
+     * @param receiver The address to which tokens are being transferred.
+     * @param value The amount of tokens to be transferred.
+     */
+    error ERC1363TransferFailed(address receiver, uint256 value);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `transferFrom` during a `transferFromAndCall` operation. Used in transfers.
+     * @param sender The address from which to send tokens.
+     * @param receiver The address to which tokens are being transferred.
+     * @param value The amount of tokens to be transferred.
+     */
+    error ERC1363TransferFromFailed(address sender, address receiver, uint256 value);
+
+    /**
+     * @dev Indicates a failure with the ERC-20 `approve` during a `approveAndCall` operation. Used in approvals.
+     * @param spender The address which will spend the funds.
+     * @param value The amount of tokens to be spent.
+     */
+    error ERC1363ApproveFailed(address spender, uint256 value);
 }
 
 
@@ -900,7 +922,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
      * @inheritdoc IERC1363
      */
     function transferAndCall(address to, uint256 value, bytes memory data) public virtual returns (bool) {
-        transfer(to, value);
+        if (!transfer(to, value)) {
+            revert ERC1363TransferFailed(to, value);
+        }
         _checkOnTransferReceived(_msgSender(), to, value, data);
         return true;
     }
@@ -921,7 +945,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
         uint256 value,
         bytes memory data
     ) public virtual returns (bool) {
-        transferFrom(from, to, value);
+        if (!transferFrom(from, to, value)) {
+            revert ERC1363TransferFromFailed(from, to, value);
+        }
         _checkOnTransferReceived(from, to, value, data);
         return true;
     }
@@ -937,7 +963,9 @@ abstract contract ERC1363 is ERC20, ERC165, IERC1363, IERC1363Errors {
      * @inheritdoc IERC1363
      */
     function approveAndCall(address spender, uint256 value, bytes memory data) public virtual returns (bool) {
-        approve(spender, value);
+        if (!approve(spender, value)) {
+            revert ERC1363ApproveFailed(spender, value);
+        }
         _checkOnApprovalReceived(spender, value, data);
         return true;
     }

docs/index.md

@@ -347,6 +347,52 @@ _Indicates a failure with the token `spender`. Used in approvals._
 | ---- | ---- | ----------- |
 | spender | address | The address which will spend the funds. |
 
+### ERC1363TransferFailed
+
+```solidity
+error ERC1363TransferFailed(address receiver, uint256 value)
+```
+
+_Indicates a failure with the ERC-20 `transfer` during a `transferAndCall` operation. Used in transfers._
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| receiver | address | The address to which tokens are being transferred. |
+| value | uint256 | The amount of tokens to be transferred. |
+
+### ERC1363TransferFromFailed
+
+```solidity
+error ERC1363TransferFromFailed(address sender, address receiver, uint256 value)
+```
+
+_Indicates a failure with the ERC-20 `transferFrom` during a `transferFromAndCall` operation. Used in transfers._
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| sender | address | The address from which to send tokens. |
+| receiver | address | The address to which tokens are being transferred. |
+| value | uint256 | The amount of tokens to be transferred. |
+
+### ERC1363ApproveFailed
+
+```solidity
+error ERC1363ApproveFailed(address spender, uint256 value)
+```
+
+_Indicates a failure with the ERC-20 `approve` during a `approveAndCall` operation. Used in approvals._
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| spender | address | The address which will spend the funds. |
+| value | uint256 | The amount of tokens to be spent. |
+
 ## IERC1363Receiver
 
 _Interface for any contract that wants to support `transferAndCall` or `transferFromAndCall` from ERC-1363 token contracts._

package.json

@@ -1,6 +1,6 @@
 {
   "name": "erc-payable-token",
-  "version": "5.1.7",
+  "version": "5.2.0",
   "description": "ERC-1363 Payable Token Implementation",
   "files": [
     "contracts",

test/helpers/enums.js

@@ -3,6 +3,5 @@ function Enum(...options) {
 }
 
 module.exports = {
-  Enum,
   RevertType: Enum('None', 'RevertWithoutMessage', 'RevertWithMessage', 'RevertWithCustomError', 'Panic'),
 };