feat: added EnsoCCIPReceiver tests

Author: vnavascues

src/bridge/EnsoCCIPReceiver.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.24;
 
 import { IEnsoCCIPReceiver } from "../interfaces/IEnsoCCIPReceiver.sol";
 import { IEnsoRouter, Token, TokenType } from "../interfaces/IEnsoRouter.sol";
+import { ITypeAndVersion } from "../interfaces/ITypeAndVersion.sol";
 import { CCIPMessageDecoder } from "../libraries/CCIPMessageDecoder.sol";
 import { CCIPReceiver, Client } from "chainlink-ccip/applications/CCIPReceiver.sol";
 import { Ownable, Ownable2Step } from "openzeppelin-contracts/access/Ownable2Step.sol";
@@ -23,10 +24,10 @@ import { Pausable } from "openzeppelin-contracts/utils/Pausable.sol";
 ///      - For malformed messages (no/too many tokens, zero amount, bad payload, zero address receiver), quarantines
 ///      funds in this contract.
 ///      - Executes Shortcuts using a self-call (`try this.execute(...)`) to catch and handle reverts.
-contract EnsoCCIPReceiver is IEnsoCCIPReceiver, CCIPReceiver, Ownable2Step, Pausable {
+contract EnsoCCIPReceiver is IEnsoCCIPReceiver, CCIPReceiver, Ownable2Step, Pausable, ITypeAndVersion {
     using SafeERC20 for IERC20;
 
-    uint256 private constant VERSION = 1;
+    string public constant override typeAndVersion = "EnsoCCIPReceiver 1.0.0";
 
     /// @dev Immutable Enso Router used to dispatch tokens + call Shortcuts.
     /// forge-lint: disable-next-item(screaming-snake-case-immutable)
@@ -133,11 +134,6 @@ contract EnsoCCIPReceiver is IEnsoCCIPReceiver, CCIPReceiver, Ownable2Step, Paus
         return address(i_ensoRouter);
     }
 
-    /// @inheritdoc IEnsoCCIPReceiver
-    function version() external pure returns (uint256) {
-        return VERSION;
-    }
-
     /// @inheritdoc IEnsoCCIPReceiver
     function wasMessageExecuted(bytes32 _messageId) external view returns (bool) {
         return s_executedMessage[_messageId];

src/interfaces/IEnsoCCIPReceiver.sol

@@ -47,7 +47,7 @@ interface IEnsoCCIPReceiver {
     /// @dev errorData encodings:
     ///  - ALREADY_EXECUTED: (bytes32 messageId)
     ///  - Others: empty bytes unless specified by the implementation.
-    event MessageValidationFailed(bytes32 indexed messageId, ErrorCode errorCode, bytes errorData);
+    event MessageValidationFailed(bytes32 indexed messageId, ErrorCode indexed errorCode, bytes errorData);
 
     /// @notice Funds were quarantined in the receiver instead of delivered to the payload receiver.
     /// @param messageId The CCIP message id.
@@ -56,7 +56,7 @@ interface IEnsoCCIPReceiver {
     /// @param amount Token amount retained.
     /// @param receiver Original payload receiver (informational; may be zero if not decoded).
     event MessageQuarantined(
-        bytes32 indexed messageId, ErrorCode code, address token, uint256 amount, address receiver
+        bytes32 indexed messageId, ErrorCode indexed code, address token, uint256 amount, address receiver
     );
 
     /// @notice Emitted when Enso Shortcuts execution succeeds for a CCIP message.
@@ -69,7 +69,7 @@ interface IEnsoCCIPReceiver {
     event ShortcutExecutionFailed(bytes32 indexed messageId, bytes err);
 
     /// @notice Emitted when the owner recovers tokens from the receiver.
-    event TokensRecovered(address token, address to, uint256 amount);
+    event TokensRecovered(address indexed token, address indexed to, uint256 amount);
 
     // -------------------------------------------------------------------------
     // Errors
@@ -116,10 +116,6 @@ interface IEnsoCCIPReceiver {
     /// @return router Address of the Enso Router.
     function getEnsoRouter() external view returns (address router);
 
-    /// @notice Returns a human-readable version/format indicator for off-chain tooling and tests.
-    /// @return version The version number of this receiver implementation.
-    function version() external view returns (uint256 version);
-
     /// @notice Returns whether a CCIP message was already handled (executed/refunded/quarantined).
     /// @param messageId CCIP message identifier.
     /// @return executed True if the messageId is marked as executed/handled.

src/interfaces/ITypeAndVersion.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+/// @title ITypeAndVersion
+/// @author Enso
+/// @notice Provides a human-readable identifier for the contract type and its version.
+interface ITypeAndVersion {
+    /// @return A string containing the contract type and semantic version.
+    function typeAndVersion() external pure returns (string memory);
+}

test/mocks/MockEnsoRouter.sol

@@ -37,7 +37,9 @@ contract MockEnsoRouter {
             }
         }
         if (isNativeAsset) {
-            shortcuts.call{ value: msg.value }("");
+            (bool success, bytes memory result) = shortcuts.call{ value: msg.value }("");
+            (success);
+            (result);
         }
     }
 

test/shortcuts/ShortcutsEthereum.sol

@@ -144,9 +144,9 @@ library ShortcutsEthereum {
 
         shortcut.txGas = 92_661;
         shortcut.txData = abi.encodePacked(
-            hex"95352c9fad7c5bef027816a800da1736444fb58a807ef4c9603b7848673f7e3a68eb14a51b21602de47c41deb22fa12edf3f9188303132333435363738394142434445460000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000042e1a7d4d0100ffffffffffffc02aaa39b223fe8d0a0e5c4f27ead9083c756cc219198595a30081ffffffffff",
+            hex"95352c9fad7c5bef027816a800da1736444fb58a807ef4c9603b7848673f7e3a68eb14a523e16585efc24d639f861691ad38481130313233343536373839414243444546000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001400000000000000000000000000000000000000000000000000000000000000005a9059cbb010001ffffffffffc02aaa39b223fe8d0a0e5c4f27ead9083c756cc22e1a7d4d0102ffffffffffffc02aaa39b223fe8d0a0e5c4f27ead9083c756cc219198595a30283ffffffffff",
             receiver,
-            hex"6e7a43a3010002ffffffff027e7d64d987cab6eed08a191c4c2459daf2f8ed0b241c59120102ffffffffffff7e7d64d987cab6eed08a191c4c2459daf2f8ed0b0000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000dcef33a6f838000"
+            hex"6e7a43a3010204ffffffff047e7d64d987cab6eed08a191c4c2459daf2f8ed0b241c59120104ffffffffffff7e7d64d987cab6eed08a191c4c2459daf2f8ed0b000000000000000000000000000000000000000000000000000000000000000500000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000e000000000000000000000000000000000000000000000000000000000000001200000000000000000000000000000000000000000000000000000000000000160000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000000200000000000000000000000006aa68c46ed86161eb318b1396f7b79e386e886760000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000dbd2fc137a30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
         );
         shortcut.referralCode = "0123456789ABCDEF";
     }
@@ -158,7 +158,8 @@ library ShortcutsEthereum {
     function getShortcut2(
         address weth,
         address ensoShortcutsHelpers,
-        address receiver
+        address receiver,
+        address feeReceiver
     )
         public
         pure
@@ -182,19 +183,23 @@ library ShortcutsEthereum {
         shortcut.tokensOut = tokensOut;
 
         shortcut.fee = 0.01 ether;
-        shortcut.feeReceiver = 0x6AA68C46eD86161eB318b1396F7b79E386e88676;
+        shortcut.feeReceiver = feeReceiver;
 
         shortcut.txGas = 92_661;
         shortcut.txData = abi.encodePacked(
-            hex"95352c9fad7c5bef027816a800da1736444fb58a807ef4c9603b7848673f7e3a68eb14a51b21602de47c41deb22fa12edf3f9188303132333435363738394142434445460000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000012000000000000000000000000000000000000000000000000000000000000000042e1a7d4d0100ffffffffffff",
+            hex"95352c9fad7c5bef027816a800da1736444fb58a807ef4c9603b7848673f7e3a68eb14a523e16585efc24d639f861691ad38481130313233343536373839414243444546000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001400000000000000000000000000000000000000000000000000000000000000005a9059cbb010001ffffffffff",
+            weth,
+            hex"2e1a7d4d0102ffffffffffff",
             weth,
-            hex"19198595a30081ffffffffff",
+            hex"19198595a30283ffffffffff",
             receiver,
-            hex"6e7a43a3010002ffffffff02",
+            hex"6e7a43a3010204ffffffff04",
             ensoShortcutsHelpers,
-            hex"241c59120102ffffffffffff",
+            hex"241c59120104ffffffffffff",
             ensoShortcutsHelpers,
-            hex"0000000000000000000000000000000000000000000000000000000000000003000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000dcef33a6f838000"
+            hex"000000000000000000000000000000000000000000000000000000000000000500000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000e00000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000016000000000000000000000000000000000000000000000000000000000000001800000000000000000000000000000000000000000000000000000000000000020000000000000000000000000",
+            feeReceiver,
+            hex"0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000002386f26fc1000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000dbd2fc137a30000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000001"
         );
         shortcut.referralCode = "0123456789ABCDEF";
     }

test/unit/concrete/bridge/ensoCCIPReceiver/EnsoCCIPReceiver.t.sol

@@ -1,9 +1,11 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.28;
 
+import { EnsoShortcuts } from "../../../../../src/EnsoShortcuts.sol";
 import { EnsoCCIPReceiver } from "../../../../../src/bridge/EnsoCCIPReceiver.sol";
 import { EnsoShortcutsHelpers } from "../../../../../src/helpers/EnsoShortcutsHelpers.sol";
 import { EnsoRouter } from "../../../../../src/router/EnsoRouter.sol";
+import { MockERC20 } from "../../../../mocks/MockERC20.sol";
 import { WETH9 } from "../../../../mocks/WETH9.sol";
 import { MockCCIPRouter } from "chainlink-ccip/test/mocks/MockRouter.sol";
 import { Test } from "forge-std-1.9.7/Test.sol";
@@ -14,10 +16,13 @@ abstract contract EnsoCCIPReceiver_Unit_Concrete_Test is Test {
     address payable internal s_account1;
     address payable internal s_account2;
     EnsoRouter internal s_ensoRouter;
+    EnsoShortcuts internal s_ensoShortcuts;
     EnsoShortcutsHelpers internal s_ensoShortcutsHelpers;
     MockCCIPRouter internal s_ccipRouter;
     EnsoCCIPReceiver internal s_ensoCcipReceiver;
     WETH9 internal s_weth;
+    MockERC20 internal s_tokenA;
+    MockERC20 internal s_tokenB;
 
     function setUp() public virtual {
         s_deployer = payable(vm.addr(1));
@@ -40,6 +45,9 @@ abstract contract EnsoCCIPReceiver_Unit_Concrete_Test is Test {
         s_ensoRouter = new EnsoRouter();
         vm.label(address(s_ensoRouter), "EnsoRouter");
 
+        s_ensoShortcuts = EnsoShortcuts(payable(s_ensoRouter.shortcuts()));
+        vm.label(address(s_ensoShortcuts), "EnsoShortcuts");
+
         s_ensoShortcutsHelpers = new EnsoShortcutsHelpers();
         vm.label(address(s_ensoShortcutsHelpers), "EnsoShortcutsHelpers");
 
@@ -51,6 +59,15 @@ abstract contract EnsoCCIPReceiver_Unit_Concrete_Test is Test {
 
         s_weth = new WETH9();
         vm.label(address(s_weth), "WETH9");
+
+        s_tokenA = new MockERC20("Token A", "TKNA");
+        vm.label(address(s_tokenA), "TKNA");
+        s_tokenA.mint(s_deployer, 1000 ether);
+
+        s_tokenB = new MockERC20("Token B", "TKNB");
+        vm.label(address(s_tokenB), "TKNB");
+        s_tokenB.mint(s_deployer, 1000 ether);
+
         vm.stopPrank();
     }
 }