Merge branch 'main' into router/hr/ENG-4171-Implement-Pause

foundry/test/Constants.sol

@@ -8,9 +8,23 @@ contract Constants is Test {
     address BOB = makeAddr("bob"); //bob=someone!=us
     address FUND_RESCUER = makeAddr("fundRescuer");
     address FEE_SETTER = makeAddr("feeSetter");
-    // dummy contracts
+    address FEE_RECEIVER = makeAddr("feeReceiver");
+
+    // Dummy contracts
     address DUMMY = makeAddr("dummy");
     address FEE_RECEIVER = makeAddr("feeReceiver");
     address PAUSER = makeAddr("pauser");
     address UNPAUSER = makeAddr("unpauser");
+
+    // Assets
+    address WETH_ADDR = address(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
+    address DAI_ADDR = address(0x6B175474E89094C44Da98b954EedeAC495271d0F);
+
+    /**
+     * @dev Deploys a dummy contract with non-empty bytecode
+     */
+    function deployDummyContract() internal {
+        bytes memory minimalBytecode = hex"01"; // Single-byte bytecode
+        vm.etch(DUMMY, minimalBytecode); // Deploy minimal bytecode
+    }
 }

foundry/test/ExecutionDispatcher.t.sol

@@ -0,0 +1,149 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.28;
+
+import "@src/ExecutionDispatcher.sol";
+import "./TychoRouterTestSetup.sol";
+
+contract ExecutionDispatcherExposed is ExecutionDispatcher {
+    function exposedCallExecutor(uint256 amount, bytes calldata data)
+        external
+        returns (uint256 calculatedAmount)
+    {
+        return _callExecutor(amount, data);
+    }
+
+    function exposedDecodeExecutorAndSelector(bytes calldata data)
+        external
+        pure
+        returns (address executor, bytes4 selector, bytes memory protocolData)
+    {
+        return _decodeExecutorAndSelector(data);
+    }
+
+    function exposedSetExecutor(address target) external {
+        _setExecutor(target);
+    }
+
+    function exposedRemoveExecutor(address target) external {
+        _removeExecutor(target);
+    }
+}
+
+contract ExecutionDispatcherTest is Constants {
+    ExecutionDispatcherExposed dispatcherExposed;
+
+    event ExecutorSet(address indexed executor);
+    event ExecutorRemoved(address indexed executor);
+
+    function setUp() public {
+        uint256 forkBlock = 20673900;
+        vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
+        dispatcherExposed = new ExecutionDispatcherExposed();
+        deal(WETH_ADDR, address(dispatcherExposed), 15 ether);
+        deployDummyContract();
+    }
+
+    function testSetValidExecutor() public {
+        vm.expectEmit();
+        // Define the event we expect to be emitted at the next step
+        emit ExecutorSet(DUMMY);
+        dispatcherExposed.exposedSetExecutor(DUMMY);
+        assert(dispatcherExposed.executors(DUMMY) == true);
+    }
+
+    function testRemoveExecutor() public {
+        dispatcherExposed.exposedSetExecutor(DUMMY);
+        vm.expectEmit();
+        // Define the event we expect to be emitted at the next step
+        emit ExecutorRemoved(DUMMY);
+        dispatcherExposed.exposedRemoveExecutor(DUMMY);
+        assert(dispatcherExposed.executors(DUMMY) == false);
+    }
+
+    function testRemoveUnSetExecutor() public {
+        dispatcherExposed.exposedRemoveExecutor(BOB);
+        assert(dispatcherExposed.executors(BOB) == false);
+    }
+
+    function testSetExecutorNonContract() public {
+        vm.expectRevert(
+            abi.encodeWithSelector(
+                ExecutionDispatcher__NonContractExecutor.selector
+            )
+        );
+        dispatcherExposed.exposedSetExecutor(BOB);
+    }
+
+    function testCallExecutor() public {
+        // Test case taken from existing transaction
+        // 0x755d603962b30f416cf3eefae8d55204d6ffdf746465b2a94aca216faab63804
+        // For this test, we can use any executor and any calldata that we know works
+        // for this executor. We don't care about which calldata/executor, since we are
+        // only testing the functionality of the delegatecall and not the inner
+        // workings of the executor.
+        // Thus, we chose a previously-deployed Hashflow executor for simplicity. To
+        // change this test, we can find any of our transactions that succeeded, and
+        // obtain the calldata passed to the executor via Tenderly.
+        dispatcherExposed.exposedSetExecutor(
+            address(0xe592557AB9F4A75D992283fD6066312FF013ba3d)
+        );
+        bytes memory data =
+            hex"e592557AB9F4A75D992283fD6066312FF013ba3dbd0625ab5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72fc8c39af7983bf329086de522229a7be5fc4e41cc51c72848c68a965f66fa7a88855f9f7784502a7f2606beffe61000613d6a25b5bfef4cd7652aa94777d4a46b39f2e206411280a12c9344b769ff1066c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000d02ab486cedc0000000000000000000000000000000000000000000000000000000000082ec8ad1b0000000000000000000000000000000000000000000000000000000066d7b65800000000000000000000000000000000000000000000000000000191ba9f843c125000064000640000d52de09955f0ffffffffffffff00225c389e595fe9000001fcc910754b349f821e4bb5d8444822a63920be943aba6f1b31ee14ef0fc6840b6d28d604e04a78834b668dba24a6c082ffb901e4fffa9600649e8d991af593c81c";
+        uint256 givenAmount = 15 ether;
+        uint256 amount =
+            dispatcherExposed.exposedCallExecutor(givenAmount, data);
+        assert(amount == 35144641819);
+    }
+
+    function testCallExecutorNoSelector() public {
+        // Test case taken from existing transaction
+        // 0x755d603962b30f416cf3eefae8d55204d6ffdf746465b2a94aca216faab63804
+        // No selector is passed, so the standard swap selector should be used
+
+        // For this test, we can use any executor and any calldata that we know works
+        // for this executor. We don't care about which calldata/executor, since we are
+        // only testing the functionality of the delegatecall and not the inner
+        // workings of the executor.
+        // Thus, we chose a previously-deployed Hashflow executor for simplicity. To
+        // change this test, we can find any of our transactions that succeeded, and
+        // obtain the calldata passed to the executor via Tenderly.
+        dispatcherExposed.exposedSetExecutor(
+            address(0xe592557AB9F4A75D992283fD6066312FF013ba3d)
+        );
+        bytes memory data =
+            hex"e592557AB9F4A75D992283fD6066312FF013ba3d000000005615dEB798BB3E4dFa0139dFa1b3D433Cc23b72fc8c39af7983bf329086de522229a7be5fc4e41cc51c72848c68a965f66fa7a88855f9f7784502a7f2606beffe61000613d6a25b5bfef4cd7652aa94777d4a46b39f2e206411280a12c9344b769ff1066c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000d02ab486cedc0000000000000000000000000000000000000000000000000000000000082ec8ad1b0000000000000000000000000000000000000000000000000000000066d7b65800000000000000000000000000000000000000000000000000000191ba9f843c125000064000640000d52de09955f0ffffffffffffff00225c389e595fe9000001fcc910754b349f821e4bb5d8444822a63920be943aba6f1b31ee14ef0fc6840b6d28d604e04a78834b668dba24a6c082ffb901e4fffa9600649e8d991af593c81c";
+        uint256 givenAmount = 15 ether;
+        uint256 amount =
+            dispatcherExposed.exposedCallExecutor(givenAmount, data);
+        assert(amount == 35144641819);
+    }
+
+    function testCallExecutorCallFailed() public {
+        // Bad data is provided to an approved executor - causing the call to fail
+        dispatcherExposed.exposedSetExecutor(
+            address(0xe592557AB9F4A75D992283fD6066312FF013ba3d)
+        );
+        bytes memory data =
+            hex"e592557AB9F4A75D992283fD6066312FF013ba3dbd0625ab5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72fc8c39af7983bf329086de522229a7be5fc4e41cc51c72848c68a965f66fa7a88855f9f7784502a7f2606beffe61000613d6a25b5bfef4cd7652aa94777d4a46b39f2e206411280a12c9344b769ff1066c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000d02ab486cedc0000000000000000000000000000000000000000000000000000000000082ec8ad1b0000000000000000000000000000000000000000000000000000000066d7b65800000000000000000000000000000000000000000000000000000191ba9f843c125000064000640000d52de09955f0ffffffffffffff00225c389e595fe9000001fcc910754b349f821e4bb5d8444822a63920be943aba6f1b31ee14ef0fc6840b6d28d604e04a78834b668dba24a6c082ffb901e4fffa9600649e8d991af593";
+        vm.expectRevert();
+        dispatcherExposed.exposedCallExecutor(0, data);
+    }
+
+    function testCallExecutorUnapprovedExecutor() public {
+        bytes memory data =
+            hex"5d622C9053b8FFB1B3465495C8a42E603632bA70aabbccdd1111111111111111";
+        vm.expectRevert();
+        dispatcherExposed.exposedCallExecutor(0, data);
+    }
+
+    function testDecodeExecutorAndSelector() public {
+        bytes memory data =
+            hex"6611e616d2db3244244a54c754a16dd3ac7ca7a2aabbccdd1111111111111111";
+        (address executor, bytes4 selector, bytes memory protocolData) =
+            dispatcherExposed.exposedDecodeExecutorAndSelector(data);
+        assert(executor == address(0x6611e616d2db3244244A54c754A16dd3ac7cA7a2));
+        assert(selector == bytes4(0xaabbccdd));
+        // Direct bytes comparison not supported - must use keccak
+        assert(keccak256(protocolData) == keccak256(hex"1111111111111111"));
+    }
+}

foundry/test/TychoRouter.t.sol

@@ -14,56 +14,26 @@ contract TychoRouterTest is TychoRouterTestSetup {
     bytes32 public constant FUND_RESCUER_ROLE =
         0x912e45d663a6f4cc1d0491d8f046e06c616f40352565ea1cdb86a0e1aaefa41b;
 
-    event ExecutorSet(address indexed executor);
     event CallbackVerifierSet(address indexed callbackVerifier);
     event Withdrawal(
         address indexed token, uint256 amount, address indexed receiver
     );
 
-    function testSetValidExecutor() public {
+    function testSetExecutorValidRole() public {
         vm.startPrank(executorSetter);
-        vm.expectEmit();
-        // Define the event we expect to be emitted at the next step
-        emit ExecutorSet(DUMMY);
-
-        tychoRouter.setSwapExecutor(DUMMY);
+        tychoRouter.setExecutor(DUMMY);
         vm.stopPrank();
-
-        assert(tychoRouter.swapExecutors(DUMMY) == true);
-    }
-
-    function testRemoveExecutor() public {
-        vm.startPrank(executorSetter);
-        tychoRouter.setSwapExecutor(DUMMY);
-        tychoRouter.removeSwapExecutor(DUMMY);
-        vm.stopPrank();
-        assert(tychoRouter.swapExecutors(DUMMY) == false);
-    }
-
-    function testRemoveUnSetExecutor() public {
-        vm.startPrank(executorSetter);
-        tychoRouter.removeSwapExecutor(BOB);
-        vm.stopPrank();
-        assert(tychoRouter.swapExecutors(BOB) == false);
+        assert(tychoRouter.executors(DUMMY) == true);
     }
 
     function testRemoveExecutorMissingSetterRole() public {
         vm.expectRevert();
-        tychoRouter.removeSwapExecutor(BOB);
+        tychoRouter.removeExecutor(BOB);
     }
 
     function testSetExecutorMissingSetterRole() public {
         vm.expectRevert();
-        tychoRouter.setSwapExecutor(DUMMY);
-    }
-
-    function testSetExecutorNonContract() public {
-        vm.startPrank(executorSetter);
-        vm.expectRevert(
-            abi.encodeWithSelector(TychoRouter__NonContractExecutor.selector)
-        );
-        tychoRouter.setSwapExecutor(BOB);
-        vm.stopPrank();
+        tychoRouter.setExecutor(DUMMY);
     }
 
     function testSetValidVerifier() public {

foundry/test/TychoRouterTestSetup.sol

@@ -30,14 +30,6 @@ contract TychoRouterTestSetup is Test, Constants {
         vm.stopPrank();
     }
 
-    /**
-     * @dev Deploys a dummy contract with non-empty bytecode
-     */
-    function deployDummyContract() internal {
-        bytes memory minimalBytecode = hex"01"; // Single-byte bytecode
-        vm.etch(DUMMY, minimalBytecode); // Deploy minimal bytecode
-    }
-
     /**
      * @dev Mints tokens to the given address
      * @param amount The amount of tokens to mint

foundry/test/executors/UniswapV2Executor.t.sol

@@ -0,0 +1,97 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.28;
+
+import "@src/executors/UniswapV2Executor.sol";
+import {Test} from "../../lib/forge-std/src/Test.sol";
+import {Constants} from "../Constants.sol";
+
+contract UniswapV2ExecutorExposed is UniswapV2Executor {
+    function decodeParams(bytes calldata data)
+        external
+        pure
+        returns (
+            IERC20 inToken,
+            address target,
+            address receiver,
+            bool zeroForOne
+        )
+    {
+        return _decodeData(data);
+    }
+
+    function getAmountOut(address target, uint256 amountIn, bool zeroForOne)
+        external
+        view
+        returns (uint256 amount)
+    {
+        return _getAmountOut(target, amountIn, zeroForOne);
+    }
+}
+
+contract UniswapV2ExecutorTest is UniswapV2ExecutorExposed, Test, Constants {
+    using SafeERC20 for IERC20;
+
+    UniswapV2ExecutorExposed uniswapV2Exposed;
+    IERC20 WETH = IERC20(WETH_ADDR);
+    IERC20 DAI = IERC20(DAI_ADDR);
+    address WETH_DAI_POOL = 0xA478c2975Ab1Ea89e8196811F51A7B7Ade33eB11;
+
+    function setUp() public {
+        uint256 forkBlock = 17323404;
+        vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
+        uniswapV2Exposed = new UniswapV2ExecutorExposed();
+    }
+
+    function testDecodeParams() public view {
+        bytes memory params =
+            abi.encodePacked(WETH_ADDR, address(2), address(3), false);
+
+        (IERC20 tokenIn, address target, address receiver, bool zeroForOne) =
+            uniswapV2Exposed.decodeParams(params);
+
+        assertEq(address(tokenIn), WETH_ADDR);
+        assertEq(target, address(2));
+        assertEq(receiver, address(3));
+        assertEq(zeroForOne, false);
+    }
+
+    function testDecodeParamsInvalidDataLength() public {
+        bytes memory invalidParams =
+            abi.encodePacked(WETH_ADDR, address(2), address(3));
+
+        vm.expectRevert(UniswapV2Executor__InvalidDataLength.selector);
+        uniswapV2Exposed.decodeParams(invalidParams);
+    }
+
+    function testAmountOut() public view {
+        uint256 amountOut =
+            uniswapV2Exposed.getAmountOut(WETH_DAI_POOL, 10 ** 18, false);
+        uint256 expAmountOut = 1847751195973566072891;
+        assertEq(amountOut, expAmountOut);
+    }
+
+    // triggers a uint112 overflow on purpose
+    function testAmountOutInt112Overflow() public view {
+        address target = 0x0B9f5cEf1EE41f8CCCaA8c3b4c922Ab406c980CC;
+        uint256 amountIn = 83638098812630667483959471576;
+
+        uint256 amountOut =
+            uniswapV2Exposed.getAmountOut(target, amountIn, true);
+
+        assertGe(amountOut, 0);
+    }
+
+    function testSwap() public {
+        uint256 amountIn = 10 ** 18;
+        uint256 amountOut = 1847751195973566072891;
+        bool zeroForOne = false;
+        bytes memory protocolData =
+            abi.encodePacked(WETH_ADDR, WETH_DAI_POOL, BOB, zeroForOne);
+
+        deal(WETH_ADDR, address(uniswapV2Exposed), amountIn);
+        uniswapV2Exposed.swap(amountIn, protocolData);
+
+        uint256 finalBalance = DAI.balanceOf(BOB);
+        assertGe(finalBalance, amountOut);
+    }
+}