feat!: remove success from ERC-20 deposit input

cartesi · Nov 21, 2023 · d063478 · d063478
1 parent 00a5b14
commit d063478
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 11 deletions.
diff --git a/onchain/rollups/.changeset/plenty-feet-help.md b/onchain/rollups/.changeset/plenty-feet-help.md
@@ -0,0 +1,7 @@
+---
+"@cartesi/rollups": major
+---
+
+Removed the boolean `success` flag from ERC-20 deposit inputs.
+This change was made because this flag would always be `true`, giving no extra information to the DApp back-end.
+Consumers of this input should be aware of the new encoding.
diff --git a/onchain/rollups/contracts/common/InputEncoding.sol b/onchain/rollups/contracts/common/InputEncoding.sol
@@ -31,22 +31,19 @@ library InputEncoding {
     }
 
     /// @notice Encode an ERC-20 token deposit.
-    /// @param ret The return value of `transferFrom`
     /// @param token The token contract
     /// @param sender The token sender
     /// @param amount The amount of tokens being sent
     /// @param execLayerData Additional data to be interpreted by the execution layer
     /// @return The encoded input
     function encodeERC20Deposit(
-        bool ret,
         IERC20 token,
         address sender,
         uint256 amount,
         bytes calldata execLayerData
     ) internal pure returns (bytes memory) {
         return
             abi.encodePacked(
-                ret, //                 1B
                 token, //               20B
                 sender, //              20B
                 amount, //              32B

diff --git a/onchain/rollups/contracts/portals/ERC20Portal.sol b/onchain/rollups/contracts/portals/ERC20Portal.sol
@@ -31,7 +31,6 @@ contract ERC20Portal is InputRelay, IERC20Portal {
         _token.safeTransferFrom(msg.sender, _dapp, _amount);
 
         bytes memory input = InputEncoding.encodeERC20Deposit(
-            true,
             _token,
             msg.sender,
             _amount,

diff --git a/onchain/rollups/test/foundry/portals/ERC20Portal.t.sol b/onchain/rollups/test/foundry/portals/ERC20Portal.t.sol
@@ -146,13 +146,7 @@ contract ERC20PortalTest is Test {
         token = new NormalToken(alice, _amount);
 
         // Construct the ERC-20 deposit input
-        bytes memory input = abi.encodePacked(
-            true,
-            token,
-            alice,
-            _amount,
-            _data
-        );
+        bytes memory input = abi.encodePacked(token, alice, _amount, _data);
 
         vm.startPrank(alice);