From 53d48f1bac4bd2f6ac84b62a3ffa427a1770bc45 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Wed, 26 Feb 2025 18:05:29 +0530 Subject: [PATCH 1/3] refactor: centralize swap logic to reduce duplication between swap and swapPermit2 --- foundry/src/TychoRouter.sol | 71 +++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 31 deletions(-) diff --git a/foundry/src/TychoRouter.sol b/foundry/src/TychoRouter.sol index c032a97..0896279 100644 --- a/foundry/src/TychoRouter.sol +++ b/foundry/src/TychoRouter.sol @@ -151,37 +151,16 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { tokenIn = address(_weth); } - amountOut = _swap(amountIn, nTokens, swaps); - - if (fee > 0) { - uint256 feeAmount = (amountOut * fee) / 10000; - amountOut -= feeAmount; - IERC20(tokenOut).safeTransfer(feeReceiver, feeAmount); - } - - if (minAmountOut > 0 && amountOut < minAmountOut) { - revert TychoRouter__NegativeSlippage(amountOut, minAmountOut); - } - - uint256 leftoverAmountIn; - if (tokenIn == address(0)) { - leftoverAmountIn = address(this).balance; - } else { - leftoverAmountIn = IERC20(tokenIn).balanceOf(address(this)); - } - - if (leftoverAmountIn > 0) { - revert TychoRouter__AmountInNotFullySpent(leftoverAmountIn); - } - - if (unwrapEth) { - _unwrapETH(amountOut); - } - if (tokenOut == address(0)) { - Address.sendValue(payable(receiver), amountOut); - } else { - IERC20(tokenOut).safeTransfer(receiver, amountOut); - } + return _executeSwap( + amountIn, + tokenIn, + tokenOut, + minAmountOut, + unwrapEth, + nTokens, + receiver, + swaps + ); } /** @@ -242,6 +221,36 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { ); } + return _executeSwap( + amountIn, + tokenIn, + tokenOut, + minAmountOut, + unwrapEth, + nTokens, + receiver, + swaps + ); + } + + /** + * @notice Internal implementation of the core swap logic shared between swap() and swapPermit2(). + * + * @notice This function centralizes the swap execution logic. + * @notice For detailed documentation on parameters and behavior, see the documentation for + * swap() and swapPermit2() functions. + * + */ + function _executeSwap( + uint256 amountIn, + address tokenIn, + address tokenOut, + uint256 minAmountOut, + bool unwrapEth, + uint256 nTokens, + address receiver, + bytes calldata swaps + ) internal returns (uint256 amountOut) { amountOut = _swap(amountIn, nTokens, swaps); if (fee > 0) { From 0be69c9aea78f486338ab50ba803ac4869df93ac Mon Sep 17 00:00:00 2001 From: royvardhan Date: Wed, 26 Feb 2025 19:04:26 +0530 Subject: [PATCH 2/3] refactor: check if amountIn was fully consumed based on balance changes --- foundry/src/TychoRouter.sol | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/foundry/src/TychoRouter.sol b/foundry/src/TychoRouter.sol index 0896279..6f10fed 100644 --- a/foundry/src/TychoRouter.sol +++ b/foundry/src/TychoRouter.sol @@ -251,8 +251,23 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { address receiver, bytes calldata swaps ) internal returns (uint256 amountOut) { + uint256 initialBalance = tokenIn == address(0) + ? address(this).balance + : IERC20(tokenIn).balanceOf(address(this)); + amountOut = _swap(amountIn, nTokens, swaps); + uint256 currentBalance = tokenIn == address(0) + ? address(this).balance + : IERC20(tokenIn).balanceOf(address(this)); + + uint256 amountConsumed = initialBalance - currentBalance; + + if (amountConsumed < amountIn) { + uint256 leftoverAmount = amountIn - amountConsumed; + revert TychoRouter__AmountInNotFullySpent(leftoverAmount); + } + if (fee > 0) { uint256 feeAmount = (amountOut * fee) / 10000; amountOut -= feeAmount; @@ -263,17 +278,6 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { revert TychoRouter__NegativeSlippage(amountOut, minAmountOut); } - uint256 leftoverAmountIn; - if (tokenIn == address(0)) { - leftoverAmountIn = address(this).balance; - } else { - leftoverAmountIn = IERC20(tokenIn).balanceOf(address(this)); - } - - if (leftoverAmountIn > 0) { - revert TychoRouter__AmountInNotFullySpent(leftoverAmountIn); - } - if (unwrapEth) { _unwrapETH(amountOut); } From 7b0dd5872c7bc04790663cc5578e18c2d6889642 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Wed, 26 Feb 2025 23:26:27 +0530 Subject: [PATCH 3/3] chore: merge main --- foundry/src/TychoRouter.sol | 119 ++++++------------ foundry/test/Constants.sol | 10 +- foundry/test/TychoRouter.t.sol | 22 ++++ .../test/executors/UniswapV2Executor.t.sol | 17 +++ 4 files changed, 89 insertions(+), 79 deletions(-) diff --git a/foundry/src/TychoRouter.sol b/foundry/src/TychoRouter.sol index 6f10fed..c29ad40 100644 --- a/foundry/src/TychoRouter.sol +++ b/foundry/src/TychoRouter.sol @@ -140,27 +140,51 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { uint256 nTokens, address receiver, bytes calldata swaps - ) external payable whenNotPaused nonReentrant returns (uint256 amountOut) { + ) public payable whenNotPaused nonReentrant returns (uint256 amountOut) { if (receiver == address(0)) { revert TychoRouter__AddressZero(); } - - // Assume funds already in our router. + // Assume funds are already in the router. if (wrapEth) { _wrapETH(amountIn); tokenIn = address(_weth); } - return _executeSwap( - amountIn, - tokenIn, - tokenOut, - minAmountOut, - unwrapEth, - nTokens, - receiver, - swaps - ); + uint256 initialBalance = tokenIn == address(0) + ? address(this).balance + : IERC20(tokenIn).balanceOf(address(this)); + + amountOut = _swap(amountIn, nTokens, swaps); + + uint256 currentBalance = tokenIn == address(0) + ? address(this).balance + : IERC20(tokenIn).balanceOf(address(this)); + + uint256 amountConsumed = initialBalance - currentBalance; + + if (amountConsumed < amountIn) { + uint256 leftoverAmount = amountIn - amountConsumed; + revert TychoRouter__AmountInNotFullySpent(leftoverAmount); + } + + if (fee > 0) { + uint256 feeAmount = (amountOut * fee) / 10000; + amountOut -= feeAmount; + IERC20(tokenOut).safeTransfer(feeReceiver, feeAmount); + } + + if (minAmountOut > 0 && amountOut < minAmountOut) { + revert TychoRouter__NegativeSlippage(amountOut, minAmountOut); + } + + if (unwrapEth) { + _unwrapETH(amountOut); + } + if (tokenOut == address(0)) { + Address.sendValue(payable(receiver), amountOut); + } else { + IERC20(tokenOut).safeTransfer(receiver, amountOut); + } } /** @@ -202,16 +226,9 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { IAllowanceTransfer.PermitSingle calldata permitSingle, bytes calldata signature, bytes calldata swaps - ) external payable whenNotPaused nonReentrant returns (uint256 amountOut) { - if (receiver == address(0)) { - revert TychoRouter__AddressZero(); - } - + ) external payable whenNotPaused returns (uint256 amountOut) { // For native ETH, assume funds already in our router. Else, transfer and handle approval. - if (wrapEth) { - _wrapETH(amountIn); - tokenIn = address(_weth); - } else if (tokenIn != address(0)) { + if (tokenIn != address(0)) { permit2.permit(msg.sender, permitSingle, signature); permit2.transferFrom( msg.sender, @@ -221,11 +238,12 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { ); } - return _executeSwap( + return swap( amountIn, tokenIn, tokenOut, minAmountOut, + wrapEth, unwrapEth, nTokens, receiver, @@ -233,61 +251,6 @@ contract TychoRouter is AccessControl, Dispatcher, Pausable, ReentrancyGuard { ); } - /** - * @notice Internal implementation of the core swap logic shared between swap() and swapPermit2(). - * - * @notice This function centralizes the swap execution logic. - * @notice For detailed documentation on parameters and behavior, see the documentation for - * swap() and swapPermit2() functions. - * - */ - function _executeSwap( - uint256 amountIn, - address tokenIn, - address tokenOut, - uint256 minAmountOut, - bool unwrapEth, - uint256 nTokens, - address receiver, - bytes calldata swaps - ) internal returns (uint256 amountOut) { - uint256 initialBalance = tokenIn == address(0) - ? address(this).balance - : IERC20(tokenIn).balanceOf(address(this)); - - amountOut = _swap(amountIn, nTokens, swaps); - - uint256 currentBalance = tokenIn == address(0) - ? address(this).balance - : IERC20(tokenIn).balanceOf(address(this)); - - uint256 amountConsumed = initialBalance - currentBalance; - - if (amountConsumed < amountIn) { - uint256 leftoverAmount = amountIn - amountConsumed; - revert TychoRouter__AmountInNotFullySpent(leftoverAmount); - } - - if (fee > 0) { - uint256 feeAmount = (amountOut * fee) / 10000; - amountOut -= feeAmount; - IERC20(tokenOut).safeTransfer(feeReceiver, feeAmount); - } - - if (minAmountOut > 0 && amountOut < minAmountOut) { - revert TychoRouter__NegativeSlippage(amountOut, minAmountOut); - } - - if (unwrapEth) { - _unwrapETH(amountOut); - } - if (tokenOut == address(0)) { - Address.sendValue(payable(receiver), amountOut); - } else { - IERC20(tokenOut).safeTransfer(receiver, amountOut); - } - } - /** * @dev Executes sequential swaps as defined by the provided swap graph. * diff --git a/foundry/test/Constants.sol b/foundry/test/Constants.sol index 6675759..2f77465 100644 --- a/foundry/test/Constants.sol +++ b/foundry/test/Constants.sol @@ -3,7 +3,15 @@ pragma solidity ^0.8.26; import "forge-std/Test.sol"; -contract Constants is Test { +contract BaseConstants { + address BASE_USDC = 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913; + address BASE_MAG7 = 0x9E6A46f294bB67c20F1D1E7AfB0bBEf614403B55; + + // uniswap v2 + address USDC_MAG7_POOL = 0x739c2431670A12E2cF8e11E3603eB96e6728a789; +} + +contract Constants is Test, BaseConstants { address ADMIN = makeAddr("admin"); //admin=us address BOB = makeAddr("bob"); //bob=someone!=us address FUND_RESCUER = makeAddr("fundRescuer"); diff --git a/foundry/test/TychoRouter.t.sol b/foundry/test/TychoRouter.t.sol index e503f7e..6033feb 100644 --- a/foundry/test/TychoRouter.t.sol +++ b/foundry/test/TychoRouter.t.sol @@ -978,4 +978,26 @@ contract TychoRouterTest is TychoRouterTestSetup { assertEq(IERC20(WBTC_ADDR).balanceOf(tychoRouterAddr), 102718); } + + // Base Network Tests + // Make sure to set the RPC_URL to base network + function testSwapSingleBase() public { + vm.skip(true); + vm.rollFork(26857267); + uint256 amountIn = 10 * 10 ** 6; + deal(BASE_USDC, tychoRouterAddr, amountIn); + + bytes memory protocolData = encodeUniswapV2Swap( + BASE_USDC, USDC_MAG7_POOL, tychoRouterAddr, true + ); + + bytes memory swap = encodeSwap( + uint8(0), uint8(1), uint24(0), address(usv2Executor), protocolData + ); + bytes[] memory swaps = new bytes[](1); + swaps[0] = swap; + + tychoRouter.exposedSwap(amountIn, 2, pleEncode(swaps)); + assertGt(IERC20(BASE_MAG7).balanceOf(tychoRouterAddr), 1379830606); + } } diff --git a/foundry/test/executors/UniswapV2Executor.t.sol b/foundry/test/executors/UniswapV2Executor.t.sol index 01722eb..0b4d705 100644 --- a/foundry/test/executors/UniswapV2Executor.t.sol +++ b/foundry/test/executors/UniswapV2Executor.t.sol @@ -156,4 +156,21 @@ contract UniswapV2ExecutorTest is UniswapV2ExecutorExposed, Test, Constants { vm.expectRevert(UniswapV2Executor__InvalidTarget.selector); uniswapV2Exposed.swap(amountIn, protocolData); } + + // Base Network Tests + // Make sure to set the RPC_URL to base network + function testSwapBaseNetwork() public { + vm.skip(true); + vm.rollFork(26857267); + uint256 amountIn = 10 * 10 ** 6; + bool zeroForOne = true; + bytes memory protocolData = + abi.encodePacked(BASE_USDC, USDC_MAG7_POOL, BOB, zeroForOne); + + deal(BASE_USDC, address(uniswapV2Exposed), amountIn); + + uniswapV2Exposed.swap(amountIn, protocolData); + + assertEq(IERC20(BASE_MAG7).balanceOf(BOB), 1379830606); + } }