Merge pull request #41 from propeller-heads/router/tnl/ENG-4052-integration-test-split

feat: Router split swap integration test

foundry/test/TychoRouter.t.sol

@@ -683,9 +683,10 @@ contract TychoRouterTest is TychoRouterTestSetup {
         // Approve permit2
         vm.startPrank(ALICE);
         IERC20(WETH_ADDR).approve(address(permit2Address), type(uint256).max);
-        // Encoded solution generated using `test_split_swap_strategy_encoder` but
+        // Encoded solution generated using `test_split_swap_strategy_encoder_simple`
-        // manually replacing the executor address `5c2f5a71f67c01775180adc06909288b4c329308`
+        // but manually replacing the executor address
-        // with the one in this test `5615deb798bb3e4dfa0139dfa1b3d433cc23b72f`
+        // `5c2f5a71f67c01775180adc06909288b4c329308` with the one in this test
+        // `5615deb798bb3e4dfa0139dfa1b3d433cc23b72f`
         (bool success,) = tychoRouterAddr.call(
             hex"4860f9ed0000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc20000000000000000000000006b175474e89094c44da98b954eedeac495271d0f0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000cd09f75e2bf2a4d11f3ab23f1389fcc1621c0cc2000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc20000000000000000000000000000000000000000000000000de0b6b3a76400000000000000000000000000000000000000000000000000000000000067c43ba900000000000000000000000000000000000000000000000000000000000000000000000000000000000000003ede3eca2a72b3aecc820e955b36f38437d0139500000000000000000000000000000000000000000000000000000000679cb5b10000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000028000000000000000000000000000000000000000000000000000000000000000415bfd02ffd61c11192d1b54d76e0af125afbb32568aad37ec35f918bd5fb304cd314954213ed77c0d071301ddc45243ad57e86fe18f2905b682acc4f1a43ad8dc1c00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000005c005a00010000005615deb798bb3e4dfa0139dfa1b3d433cc23b72fbd0625abc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a478c2975ab1ea89e8196811f51a7b7ade33eb113ede3eca2a72b3aecc820e955b36f38437d013950000000000"
         );
@@ -695,6 +696,41 @@ contract TychoRouterTest is TychoRouterTestSetup {
         uint256 balancerAfter = IERC20(DAI_ADDR).balanceOf(ALICE);
 
         assertTrue(success, "Call Failed");
-        assertGt(balancerAfter, balancerBefore);
+        assertGt(balancerAfter - balancerBefore, 26173932);
+    }
+
+    function testSplitSwapIntegration() public {
+        // Test created with calldata from our router encoder, replacing the executor
+        // address with the USV2 executor address.
+
+        // Performs a split swap from WETH to USDC though WBTC and DAI using USV2 pools
+        //
+        //         ┌──(USV2)──> WBTC ───(USV2)──> USDC
+        //   WETH ─┤
+        //         └──(USV2)──> DAI  ───(USV2)──> USDC
+        deal(WETH_ADDR, ALICE, 1 ether);
+        uint256 balancerBefore = IERC20(USDC_ADDR).balanceOf(ALICE);
+
+        // Approve permit2
+        vm.startPrank(ALICE);
+        IERC20(WETH_ADDR).approve(address(permit2Address), type(uint256).max);
+        // Encoded solution generated using `test_split_swap_strategy_encoder_complex`
+        // but manually replacing the executor address
+        // `5c2f5a71f67c01775180adc06909288b4c329308` with the one in this test
+        // `5615deb798bb3e4dfa0139dfa1b3d433cc23b72f`
+        (bool success,) = tychoRouterAddr.call(
+            hex"4860f9ed0000000000000000000000000000000000000000000000000de0b6b3a7640000000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb480000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000000000000000cd09f75e2bf2a4d11f3ab23f1389fcc1621c0cc2000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc20000000000000000000000000000000000000000000000000de0b6b3a76400000000000000000000000000000000000000000000000000000000000067c48ea700000000000000000000000000000000000000000000000000000000000000000000000000000000000000003ede3eca2a72b3aecc820e955b36f38437d0139500000000000000000000000000000000000000000000000000000000679d08af00000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000280000000000000000000000000000000000000000000000000000000000000004197c2ff7801fa573e4e8e4af1df41499045485c2b48d090833dc85be38e002c1a1e7ef354285d79c2dcb40c4837e5156069de9aaf42365aef54fdc4cca2c76ccb1b000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000170005a00028000005615deb798bb3e4dfa0139dfa1b3d433cc23b72fbd0625abc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a478c2975ab1ea89e8196811f51a7b7ade33eb113ede3eca2a72b3aecc820e955b36f38437d0139500005a00010000005615deb798bb3e4dfa0139dfa1b3d433cc23b72fbd0625abc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2bb2b8038a1640196fbe3e38816f3e67cba72d9403ede3eca2a72b3aecc820e955b36f38437d0139500005a02030000005615deb798bb3e4dfa0139dfa1b3d433cc23b72fbd0625ab6b175474e89094c44da98b954eedeac495271d0fae461ca67b15dc8dc81ce7615e0320da1a9ab8d53ede3eca2a72b3aecc820e955b36f38437d0139501005a01030000005615deb798bb3e4dfa0139dfa1b3d433cc23b72fbd0625ab2260fac5e5542a773aa44fbcfedf7c193bc2c599004375dff511095cc5a197a54140a24efef3a4163ede3eca2a72b3aecc820e955b36f38437d013950100000000000000000000000000000000"
+        );
+
+        vm.stopPrank();
+
+        uint256 balancerAfter = IERC20(USDC_ADDR).balanceOf(ALICE);
+
+        assertTrue(success, "Call Failed");
+        assertGe(balancerAfter - balancerBefore, 26173932);
+
+        // All input tokens are transferred to the router at first. Make sure we used
+        // all of it (and thus our splits are correct).
+        assertEq(IERC20(WETH_ADDR).balanceOf(tychoRouterAddr), 0);
     }
 }

src/encoding/evm/strategy_encoder/strategy_encoders.rs

@@ -308,7 +308,9 @@ mod tests {
     }
 
     #[test]
-    fn test_split_swap_strategy_encoder() {
+    fn test_split_swap_strategy_encoder_simple_route() {
+        // Performs a single swap from WETH to DAI on a USV2 pool
+
         // Set up a mock private key for signing
         let private_key =
             "0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234".to_string();
@@ -400,4 +402,91 @@ mod tests {
         assert_eq!(hex_calldata[..520], expected_input);
         assert_eq!(hex_calldata[1288..], expected_swaps);
     }
+
+    #[test]
+    fn test_split_swap_strategy_encoder_complex_route() {
+        // Note: This test does not assert anything. It is only used to obtain integration test
+        // data for our router solidity test.
+        //
+        // Performs a split swap from WETH to USDC though WBTC and DAI using USV2 pools
+        //
+        //         ┌──(USV2)──> WBTC ───(USV2)──> USDC
+        //   WETH ─┤
+        //         └──(USV2)──> DAI  ───(USV2)──> USDC
+        //
+
+        // Set up a mock private key for signing
+        let private_key =
+            "0x123456789abcdef123456789abcdef123456789abcdef123456789abcdef1234".to_string();
+
+        let weth = Bytes::from_str("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2").unwrap();
+        let dai = Bytes::from_str("0x6b175474e89094c44da98b954eedeac495271d0f").unwrap();
+        let wbtc = Bytes::from_str("0x2260fac5e5542a773aa44fbcfedf7c193bc2c599").unwrap();
+        let usdc = Bytes::from_str("0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48").unwrap();
+
+        let swap_weth_dai = Swap {
+            component: ProtocolComponent {
+                id: "0xA478c2975Ab1Ea89e8196811F51A7B7Ade33eB11".to_string(),
+                protocol_system: "uniswap_v2".to_string(),
+                ..Default::default()
+            },
+            token_in: weth.clone(),
+            token_out: dai.clone(),
+            split: 0.5f64,
+        };
+        let swap_weth_wbtc = Swap {
+            component: ProtocolComponent {
+                id: "0xBb2b8038a1640196FbE3e38816F3e67Cba72D940".to_string(),
+                protocol_system: "uniswap_v2".to_string(),
+                ..Default::default()
+            },
+            token_in: weth.clone(),
+            token_out: wbtc.clone(),
+            // This represents the remaining 50%, but to avoid any rounding errors we set this to
+            // 0 to signify "the remainder of the WETH value". It should still be very close to 50%
+            split: 0f64,
+        };
+        let swap_dai_usdc = Swap {
+            component: ProtocolComponent {
+                id: "0xAE461cA67B15dc8dc81CE7615e0320dA1A9aB8D5".to_string(),
+                protocol_system: "uniswap_v2".to_string(),
+                ..Default::default()
+            },
+            token_in: dai.clone(),
+            token_out: usdc.clone(),
+            split: 0f64,
+        };
+        let swap_wbtc_usdc = Swap {
+            component: ProtocolComponent {
+                id: "0x004375Dff511095CC5A197A54140a24eFEF3A416".to_string(),
+                protocol_system: "uniswap_v2".to_string(),
+                ..Default::default()
+            },
+            token_in: wbtc.clone(),
+            token_out: usdc.clone(),
+            split: 0f64,
+        };
+
+        let encoder = SplitSwapStrategyEncoder::new(private_key, Chain::Ethereum).unwrap();
+        let solution = Solution {
+            exact_out: false,
+            given_token: weth,
+            given_amount: BigUint::from_str("1_000000000000000000").unwrap(),
+            checked_token: usdc,
+            expected_amount: BigUint::from_str("3_000_000000").unwrap(),
+            check_amount: None,
+            sender: Bytes::from_str("0xcd09f75E2BF2A4d11F3AB23f1389FcC1621c0cc2").unwrap(),
+            receiver: Bytes::from_str("0xcd09f75E2BF2A4d11F3AB23f1389FcC1621c0cc2").unwrap(),
+            swaps: vec![swap_weth_dai, swap_weth_wbtc, swap_dai_usdc, swap_wbtc_usdc],
+            ..Default::default()
+        };
+        let router_address = Bytes::from_str("0x3Ede3eCa2a72B3aeCC820E955B36f38437D01395").unwrap();
+
+        let (calldata, _) = encoder
+            .encode_strategy(solution, router_address)
+            .unwrap();
+
+        let _hex_calldata = encode(&calldata);
+        println!("{}", _hex_calldata);
+    }
 }

src/encoding/evm/utils.rs

@@ -44,11 +44,11 @@ pub fn encode_input(selector: &str, mut encoded_args: Vec<u8>) -> Vec<u8> {
     call_data
 }
 
-/// Converts a percentage to a `U24` value. The percentage is a `f64` value between 0 and 100.
+/// Converts a decimal to a `U24` value. The percentage is a `f64` value between 0 and 1.
 /// MAX_UINT24 corresponds to 100%.
-pub fn percentage_to_uint24(percentage: f64) -> U24 {
+pub fn percentage_to_uint24(decimal: f64) -> U24 {
     const MAX_UINT24: u32 = 16_777_215; // 2^24 - 1
 
-    let scaled = (percentage / 100.0) * (MAX_UINT24 as f64);
+    let scaled = (decimal / 1.0) * (MAX_UINT24 as f64);
     U24::from(scaled.round())
 }