Merge pull request #18 from propeller-heads/router/tnl/ENG-4044-set-executors

feat: Set swap executors and verifiers

foundry/src/CallbackVerificationDispatcher.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+/**
+ * @title Dispatch callback verification to external contracts
+ * @author PropellerHeads Devs
+ * @dev Provides the ability call external contracts to perform callback
+ *  verification. This allows dynamically adding new supported protocols
+ *  without needing to upgrade any contracts.
+ *
+ *  Note Verifier contracts need to implement the ICallbackVerifier interface
+ */
+contract CallbackVerificationDispatcher {
+    mapping(address => bool) public callbackVerifiers;
+}

foundry/src/SwapExecutionDispatcher.sol

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.28;
+
+/**
+ * @title SwapExecutionDispatcher - Dispatch swap execution to external contracts
+ * @author PropellerHeads Devs
+ * @dev Provides the ability to delegate execution of swaps to external
+ *  contracts. This allows dynamically adding new supported protocols
+ *  without needing to upgrade any contracts. External contracts will
+ *  be called using delegatecall so they can share state with the main
+ *  contract if needed.
+ *
+ *  Note Executor contracts need to implement the ISwapExecutor interface
+ */
+contract SwapExecutionDispatcher {
+    mapping(address => bool) public swapExecutors;
+}

foundry/src/TychoRouter.sol

@@ -2,14 +2,22 @@
 pragma solidity ^0.8.28;
 
 import "@openzeppelin/contracts/access/AccessControl.sol";
-import "@permit2/src/interfaces/IAllowanceTransfer.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import "@permit2/src/interfaces/IAllowanceTransfer.sol";
+import "./SwapExecutionDispatcher.sol";
+import "./CallbackVerificationDispatcher.sol";
 
 error TychoRouter__WithdrawalFailed();
 error TychoRouter__InvalidReceiver();
+error TychoRouter__NonContractExecutor();
+error TychoRouter__NonContractVerifier();
 
-contract TychoRouter is AccessControl {
+contract TychoRouter is
+    AccessControl,
+    SwapExecutionDispatcher,
+    CallbackVerificationDispatcher
+{
     IAllowanceTransfer public immutable permit2;
 
     using SafeERC20 for IERC20;
@@ -27,6 +35,8 @@ contract TychoRouter is AccessControl {
     event Withdrawal(
         address indexed token, uint256 amount, address indexed receiver
     );
+    event ExecutorSet(address indexed executor);
+    event CallbackVerifierSet(address indexed callbackVerifier);
 
     constructor(address _permit2) {
         permit2 = IAllowanceTransfer(_permit2);
@@ -68,7 +78,57 @@ contract TychoRouter is AccessControl {
         external
         onlyRole(DEFAULT_ADMIN_ROLE)
     {
-        // TODO
+        for (uint256 i = 0; i < accounts.length; i++) {
+            _grantRole(role, accounts[i]);
+        }
+    }
+
+    /**
+     * @dev Entrypoint to add or replace an approved swap executor contract address
+     * @param target address of the swap method contract
+     */
+    function setSwapExecutor(address target)
+        external
+        onlyRole(EXECUTOR_SETTER_ROLE)
+    {
+        if (target.code.length == 0) revert TychoRouter__NonContractExecutor();
+        swapExecutors[target] = true;
+        emit ExecutorSet(target);
+    }
+
+    /**
+     * @dev Entrypoint to remove an approved swap executor contract address
+     * @param target address of the swap method contract
+     */
+    function removeSwapExecutor(address target)
+        external
+        onlyRole(EXECUTOR_SETTER_ROLE)
+    {
+        delete swapExecutors[target];
+    }
+
+    /**
+     * @dev Entrypoint to add or replace an approved swap executor contract address
+     * @param target address of the swap method contract
+     */
+    function setCallbackVerifier(address target)
+        external
+        onlyRole(EXECUTOR_SETTER_ROLE)
+    {
+        if (target.code.length == 0) revert TychoRouter__NonContractVerifier();
+        callbackVerifiers[target] = true;
+        emit CallbackVerifierSet(target);
+    }
+
+    /**
+     * @dev Entrypoint to remove an approved swap executor contract address
+     * @param target address of the swap method contract
+     */
+    function removeCallbackVerifier(address target)
+        external
+        onlyRole(EXECUTOR_SETTER_ROLE)
+    {
+        delete callbackVerifiers[target];
     }
 
     /**

foundry/test/Constants.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+contract Constants {
+    address ADMIN = address(12395012351212343412541234); //admin=us
+    address BOB = address(123); //bob=someone!=us
+
+    // dummy contracts
+    address DUMMY = address(0x1234);
+}

foundry/test/TestTemplate.sol

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import "forge-std/Test.sol";
+import "@src/TychoRouter.sol";
+import "./Constants.sol";
+
+contract TychoRouterTestTemplate is Test, Constants {
+    TychoRouter tychoRouter;
+    address tychoRouterAddress;
+    address executorSetter;
+
+    function deployTychoRouter() internal {
+        vm.startPrank(ADMIN);
+
+        address permit2Address =
+            address(0x000000000022D473030F116dDEE9F6B43aC78BA3);
+        tychoRouter = new TychoRouter(permit2Address);
+        tychoRouterAddress = address(tychoRouter);
+        tychoRouter.grantRole(keccak256("EXECUTOR_SETTER_ROLE"), BOB);
+        executorSetter = BOB;
+
+        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
+    }
+}

foundry/test/TychoRouter.t.sol

@@ -1,19 +1,149 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.28;
 
-import {Test, console} from "forge-std/Test.sol";
 import {TychoRouter} from "@src/TychoRouter.sol";
+import "./TestTemplate.sol";
 
-contract TychoRouterTest is Test {
-    TychoRouter public tychoRouter;
+contract TychoRouterTest is TychoRouterTestTemplate {
+    bytes32 public constant EXECUTOR_SETTER_ROLE =
+        0x6a1dd52dcad5bd732e45b6af4e7344fa284e2d7d4b23b5b09cb55d36b0685c87;
+    bytes32 public constant FEE_SETTER_ROLE =
+        0xe6ad9a47fbda1dc18de1eb5eeb7d935e5e81b4748f3cfc61e233e64f88182060;
+    bytes32 public constant PAUSER_ROLE =
+        0x65d7a28e3265b37a6474929f336521b332c1681b933f6cb9f3376673440d862a;
+    bytes32 public constant FUND_RESCUER_ROLE =
+        0x912e45d663a6f4cc1d0491d8f046e06c616f40352565ea1cdb86a0e1aaefa41b;
+
+    event ExecutorSet(address indexed executor);
+    event CallbackVerifierSet(address indexed callbackVerifier);
 
     function setupTychoRouter() public {
-        address permit2Address =
-            address(0x000000000022D473030F116dDEE9F6B43aC78BA3);
-        tychoRouter = new TychoRouter(permit2Address);
+        deployTychoRouter();
     }
 
-    function testSetupTychoRouter() public {
+    function testSetValidExecutor() public {
         setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        vm.expectEmit();
+        // Define the event we expect to be emitted at the next step
+        emit ExecutorSet(DUMMY);
+
+        tychoRouter.setSwapExecutor(DUMMY);
+        vm.stopPrank();
+
+        assert(tychoRouter.swapExecutors(DUMMY) == true);
+    }
+
+    function testRemoveExecutor() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        tychoRouter.setSwapExecutor(DUMMY);
+        tychoRouter.removeSwapExecutor(DUMMY);
+        vm.stopPrank();
+        assert(tychoRouter.swapExecutors(DUMMY) == false);
+    }
+
+    function testRemoveUnSetExecutor() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        tychoRouter.removeSwapExecutor(BOB);
+        vm.stopPrank();
+        assert(tychoRouter.swapExecutors(BOB) == false);
+    }
+
+    function testRemoveExecutorMissingSetterRole() public {
+        setupTychoRouter();
+        deployDummyContract();
+        vm.expectRevert();
+        tychoRouter.removeSwapExecutor(BOB);
+    }
+
+    function testSetExecutorMissingSetterRole() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.expectRevert();
+        tychoRouter.setSwapExecutor(DUMMY);
+    }
+
+    function testSetExecutorNonContract() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        vm.expectRevert(
+            abi.encodeWithSelector(TychoRouter__NonContractExecutor.selector)
+        );
+        tychoRouter.setSwapExecutor(BOB);
+        vm.stopPrank();
+    }
+
+    function testSetValidVerifier() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        vm.expectEmit();
+        // Define the event we expect to be emitted at the next step
+        emit CallbackVerifierSet(DUMMY);
+
+        tychoRouter.setCallbackVerifier(DUMMY);
+        vm.stopPrank();
+
+        assert(tychoRouter.callbackVerifiers(DUMMY) == true);
+    }
+
+    function testRemoveVerifier() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        tychoRouter.setCallbackVerifier(DUMMY);
+        tychoRouter.removeCallbackVerifier(DUMMY);
+        vm.stopPrank();
+        assert(tychoRouter.callbackVerifiers(DUMMY) == false);
+    }
+
+    function testRemoveUnSetVerifier() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        tychoRouter.removeCallbackVerifier(BOB);
+        vm.stopPrank();
+        assert(tychoRouter.callbackVerifiers(BOB) == false);
+    }
+
+    function testRemoveVerifierMissingSetterRole() public {
+        setupTychoRouter();
+        deployDummyContract();
+        vm.expectRevert();
+        tychoRouter.removeCallbackVerifier(BOB);
+    }
+
+    function testSetVerifierMissingSetterRole() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.expectRevert();
+        tychoRouter.setCallbackVerifier(DUMMY);
+    }
+
+    function testSetVerifierNonContract() public {
+        setupTychoRouter();
+        deployDummyContract();
+
+        vm.startPrank(executorSetter);
+        vm.expectRevert(
+            abi.encodeWithSelector(TychoRouter__NonContractVerifier.selector)
+        );
+        tychoRouter.setCallbackVerifier(BOB);
+        vm.stopPrank();
     }
 }