From 35e706d6ea1a657164410a050a3d2950acec8e70 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Thu, 27 Feb 2025 22:38:14 +0530 Subject: [PATCH 1/6] test: add GasTest to compare with Universal Router gas usage --- foundry/interfaces/IUniversalRouter.sol | 25 +++++ foundry/test/Constants.sol | 6 ++ foundry/test/GasTest.t.sol | 117 ++++++++++++++++++++++++ foundry/test/TychoRouter.t.sol | 14 +-- foundry/test/TychoRouterTestSetup.sol | 7 +- 5 files changed, 158 insertions(+), 11 deletions(-) create mode 100644 foundry/interfaces/IUniversalRouter.sol create mode 100644 foundry/test/GasTest.t.sol diff --git a/foundry/interfaces/IUniversalRouter.sol b/foundry/interfaces/IUniversalRouter.sol new file mode 100644 index 0000000..472e579 --- /dev/null +++ b/foundry/interfaces/IUniversalRouter.sol @@ -0,0 +1,25 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +pragma solidity ^0.8.24; + +interface IUniversalRouter { + /// @notice Thrown when a required command has failed + error ExecutionFailed(uint256 commandIndex, bytes message); + + /// @notice Thrown when attempting to send ETH directly to the contract + error ETHNotAccepted(); + + /// @notice Thrown when executing commands with an expired deadline + error TransactionDeadlinePassed(); + + /// @notice Thrown when attempting to execute commands and an incorrect number of inputs are provided + error LengthMismatch(); + + // @notice Thrown when an address that isn't WETH tries to send ETH to the router without calldata + error InvalidEthSender(); + + /// @notice Executes encoded commands along with provided inputs. Reverts if deadline has expired. + /// @param commands A set of concatenated commands, each 1 byte in length + /// @param inputs An array of byte strings containing abi encoded inputs for each command + /// @param deadline The deadline by which the transaction must be executed + function execute(bytes calldata commands, bytes[] calldata inputs, uint256 deadline) external payable; +} \ No newline at end of file diff --git a/foundry/test/Constants.sol b/foundry/test/Constants.sol index 6f552f8..98eb77d 100644 --- a/foundry/test/Constants.sol +++ b/foundry/test/Constants.sol @@ -50,6 +50,12 @@ contract Constants is Test, BaseConstants { address USV3_FACTORY = 0x1F98431c8aD98523631AE4a59f267346ea31F984; address DAI_WETH_USV3 = 0xC2e9F25Be6257c210d7Adf0D4Cd6E3E881ba25f8; + // universal router + address UNIVERSAL_ROUTER = 0x66a9893cC07D91D95644AEDD05D03f95e1dBA8Af; + + // permit2 + address PERMIT2_ADDRESS = 0x000000000022D473030F116dDEE9F6B43aC78BA3; + /** * @dev Deploys a dummy contract with non-empty bytecode */ diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol new file mode 100644 index 0000000..847ec68 --- /dev/null +++ b/foundry/test/GasTest.t.sol @@ -0,0 +1,117 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +pragma solidity ^0.8.24; + +import {IUniversalRouter} from "../interfaces/IUniversalRouter.sol"; +import {IPermit2} from "../lib/permit2/src/interfaces/IPermit2.sol"; +import {Constants} from "./Constants.sol"; +import {Actions} from "../lib/v4-periphery/src/libraries/Actions.sol"; +import {PoolKey} from "../lib/v4-core/src/types/PoolKey.sol"; +import {IV4Router} from "../lib/v4-periphery/src/interfaces/IV4Router.sol"; +import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; +import {Currency} from "../lib/v4-core/src/types/Currency.sol"; +import {IHooks} from "../lib/v4-core/src/interfaces/IHooks.sol"; +import "forge-std/Test.sol"; + +contract Commands { + uint256 constant V2_SWAP_EXACT_IN = 0x08; + uint256 constant V3_SWAP_EXACT_IN = 0x00; + uint256 constant V4_SWAP = 0x10; +} + +// A gas test to compare the gas usage of the UniversalRouter with the TychoRouter +// The gas usage quoted from the TychoRouter is without any asserts after the swap +// The path executed on TychoRouter is the same as the path executed on UniversalRouter +contract GasTest is Commands, Test, Constants { + IUniversalRouter universalRouter = IUniversalRouter(UNIVERSAL_ROUTER); + IPermit2 permit2 = IPermit2(PERMIT2_ADDRESS); + + function setUp() public { + uint256 forkBlock = 21817316; + vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock); + } + + // Gas usage: 248717 + // TychoRouter:testSwapSimple costs 255123 + function testUniversalRouterUniswapV2() public { + uint256 amountIn = 10 ** 18; + + bytes memory commands = + abi.encodePacked(uint8(Commands.V2_SWAP_EXACT_IN)); + + address[] memory path = new address[](2); + path[0] = WETH_ADDR; + path[1] = DAI_ADDR; + + bytes[] memory inputs = new bytes[](1); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, false); + + deal(WETH_ADDR, address(universalRouter), amountIn); + universalRouter.execute(commands, inputs, block.timestamp + 1000); + } + + // Gas usage: 251900 + // TychoRouter:testSwapSingleUSV3 costs 264195 + function testUniversalRouterUniswapV3() public { + uint256 amountIn = 10 ** 18; + + bytes memory commands = + abi.encodePacked(uint8(Commands.V3_SWAP_EXACT_IN)); + + uint24 poolFee = 3000; + bytes memory path = abi.encodePacked(WETH_ADDR, poolFee, DAI_ADDR); + + bytes[] memory inputs = new bytes[](1); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, false); + + deal(WETH_ADDR, address(universalRouter), amountIn); + universalRouter.execute(commands, inputs, block.timestamp + 1000); + } + + // Gas usage: 299427 + // TychoRouter:testSwapSingleUSV4Callback costs 286025 + function testUniversalRouterUniswapV4() public { + uint128 amountIn = uint128(100 ether); + uint128 amountOutMinimum = uint128(0); + uint256 deadline = block.timestamp + 1000; + + bytes memory commands = abi.encodePacked(uint8(Commands.V4_SWAP)); + + bytes memory actions = abi.encodePacked( + uint8(Actions.SWAP_EXACT_IN_SINGLE), + uint8(Actions.SETTLE_ALL), + uint8(Actions.TAKE_ALL) + ); + + PoolKey memory key = PoolKey({ + currency0: Currency.wrap(USDE_ADDR), + currency1: Currency.wrap(USDT_ADDR), + fee: 100, + tickSpacing: int24(1), + hooks: IHooks(address(0)) + }); + + bytes[] memory params = new bytes[](3); + params[0] = abi.encode( + IV4Router.ExactInputSingleParams({ + poolKey: key, + zeroForOne: true, + amountIn: amountIn, + amountOutMinimum: amountOutMinimum, + hookData: bytes("") + }) + ); + + params[1] = abi.encode(key.currency0, amountIn); + params[2] = abi.encode(key.currency1, amountOutMinimum); + + bytes[] memory inputs = new bytes[](1); + inputs[0] = abi.encode(actions, params); + + deal(USDE_ADDR, address(this), amountIn); + IERC20(USDE_ADDR).approve(PERMIT2_ADDRESS, amountIn); + permit2.approve( + USDE_ADDR, address(universalRouter), amountIn, uint48(deadline) + ); + universalRouter.execute(commands, inputs, deadline); + } +} diff --git a/foundry/test/TychoRouter.t.sol b/foundry/test/TychoRouter.t.sol index 5c7caee..d23e276 100644 --- a/foundry/test/TychoRouter.t.sol +++ b/foundry/test/TychoRouter.t.sol @@ -650,7 +650,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - IERC20(WETH_ADDR).approve(address(permit2Address), type(uint256).max); + IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, type(uint256).max); // Encoded solution generated using `test_split_swap_strategy_encoder_simple` // but manually replacing the executor address // `5c2f5a71f67c01775180adc06909288b4c329308` with the one in this test @@ -688,7 +688,7 @@ contract TychoRouterTest is TychoRouterTestSetup { assertEq(balancerAfter - balancerBefore, 2659881924818443699787); } - function testUSV4Integration4() public { + function testUSV4Integration() public { // Test created with calldata from our router encoder. // Performs a sequential swap from USDC to PEPE though ETH using two @@ -701,7 +701,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - IERC20(USDC_ADDR).approve(address(permit2Address), type(uint256).max); + IERC20(USDC_ADDR).approve(PERMIT2_ADDRESS, type(uint256).max); // Encoded solution generated using `test_split_encoding_strategy_usv4` // and ensuring that the encoded executor address is the one in this test // `f62849f9a0b5bf2913b396098f7c7019b51a820a` @@ -754,7 +754,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - IERC20(USDC_ADDR).approve(address(permit2Address), type(uint256).max); + IERC20(USDC_ADDR).approve(PERMIT2_ADDRESS, type(uint256).max); // Encoded solution generated using `test_split_encoding_strategy_usv4_eth_out` // and ensuring that the encoded executor address is the one in this test @@ -783,7 +783,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - // IERC20(WETH_ADDR).approve(address(permit2Address), type(uint256).max); + // IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, type(uint256).max); // Encoded solution generated using // `test_split_swap_strategy_encoder_simple_route_wrap` // but manually replacing the executor address @@ -812,7 +812,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - IERC20(DAI_ADDR).approve(address(permit2Address), type(uint256).max); + IERC20(DAI_ADDR).approve(PERMIT2_ADDRESS, type(uint256).max); // Encoded solution generated using // `test_split_swap_strategy_encoder_simple_route_unwrap` // but manually replacing the executor address @@ -844,7 +844,7 @@ contract TychoRouterTest is TychoRouterTestSetup { // Approve permit2 vm.startPrank(ALICE); - IERC20(WETH_ADDR).approve(address(permit2Address), type(uint256).max); + IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, 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 diff --git a/foundry/test/TychoRouterTestSetup.sol b/foundry/test/TychoRouterTestSetup.sol index 59264a5..2609fa4 100644 --- a/foundry/test/TychoRouterTestSetup.sol +++ b/foundry/test/TychoRouterTestSetup.sol @@ -34,7 +34,6 @@ contract TychoRouterExposed is TychoRouter { contract TychoRouterTestSetup is Test, Constants { TychoRouterExposed tychoRouter; address tychoRouterAddr; - address permit2Address = address(0x000000000022D473030F116dDEE9F6B43aC78BA3); UniswapV2Executor public usv2Executor; UniswapV3Executor public usv3Executor; UniswapV4Executor public usv4Executor; @@ -48,7 +47,7 @@ contract TychoRouterTestSetup is Test, Constants { address factoryV3 = USV3_FACTORY; address poolManagerAddress = 0x000000000004444c5dc75cB358380D2e3dE08A90; IPoolManager poolManager = IPoolManager(poolManagerAddress); - tychoRouter = new TychoRouterExposed(permit2Address, WETH_ADDR); + tychoRouter = new TychoRouterExposed(PERMIT2_ADDRESS, WETH_ADDR); tychoRouterAddr = address(tychoRouter); tychoRouter.grantRole(keccak256("FUND_RESCUER_ROLE"), FUND_RESCUER); tychoRouter.grantRole(keccak256("FEE_SETTER_ROLE"), FEE_SETTER); @@ -107,7 +106,7 @@ contract TychoRouterTestSetup is Test, Constants { internal returns (IAllowanceTransfer.PermitSingle memory, bytes memory) { - IERC20(tokenIn).approve(permit2Address, amount_in); + IERC20(tokenIn).approve(PERMIT2_ADDRESS, amount_in); IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer .PermitSingle({ details: IAllowanceTransfer.PermitDetails({ @@ -147,7 +146,7 @@ contract TychoRouterTestSetup is Test, Constants { ), keccak256("Permit2"), block.chainid, - permit2Address + PERMIT2_ADDRESS ) ); bytes32 detailsHash = From 9014fc73837c30ee32d00a66525438a4efae5b93 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Fri, 28 Feb 2025 00:39:20 +0530 Subject: [PATCH 2/6] test: add permit2 tests for simple swaps in TychoRouter and GasTest --- foundry/test/Constants.sol | 10 +-- foundry/test/GasTest.t.sol | 65 ++++++++++++++-- foundry/test/TychoRouter.t.sol | 134 +++++++++++++++++++++++++++++++++ 3 files changed, 197 insertions(+), 12 deletions(-) diff --git a/foundry/test/Constants.sol b/foundry/test/Constants.sol index 98eb77d..1f0762d 100644 --- a/foundry/test/Constants.sol +++ b/foundry/test/Constants.sol @@ -7,7 +7,7 @@ contract BaseConstants { address BASE_USDC = 0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913; address BASE_MAG7 = 0x9E6A46f294bB67c20F1D1E7AfB0bBEf614403B55; - // uniswap v2 + // Uniswap v2 address USDC_MAG7_POOL = 0x739c2431670A12E2cF8e11E3603eB96e6728a789; } @@ -40,20 +40,20 @@ contract Constants is Test, BaseConstants { address USDT_ADDR = address(0xdAC17F958D2ee523a2206206994597C13D831ec7); address PEPE_ADDR = address(0x6982508145454Ce325dDbE47a25d4ec3d2311933); - // uniswap v2 + // Uniswap v2 address WETH_DAI_POOL = 0xA478c2975Ab1Ea89e8196811F51A7B7Ade33eB11; address DAI_USDC_POOL = 0xAE461cA67B15dc8dc81CE7615e0320dA1A9aB8D5; address WETH_WBTC_POOL = 0xBb2b8038a1640196FbE3e38816F3e67Cba72D940; address USDC_WBTC_POOL = 0x004375Dff511095CC5A197A54140a24eFEF3A416; - // uniswap v3 + // Uniswap v3 address USV3_FACTORY = 0x1F98431c8aD98523631AE4a59f267346ea31F984; address DAI_WETH_USV3 = 0xC2e9F25Be6257c210d7Adf0D4Cd6E3E881ba25f8; - // universal router + // Uniswap universal router address UNIVERSAL_ROUTER = 0x66a9893cC07D91D95644AEDD05D03f95e1dBA8Af; - // permit2 + // Permit2 address PERMIT2_ADDRESS = 0x000000000022D473030F116dDEE9F6B43aC78BA3; /** diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol index 847ec68..90217ab 100644 --- a/foundry/test/GasTest.t.sol +++ b/foundry/test/GasTest.t.sol @@ -30,8 +30,8 @@ contract GasTest is Commands, Test, Constants { vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock); } - // Gas usage: 248717 - // TychoRouter:testSwapSimple costs 255123 + // Gas usage: 248511 + // TychoRouter:testSwapSimple costs 113647 function testUniversalRouterUniswapV2() public { uint256 amountIn = 10 ** 18; @@ -49,8 +49,34 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 251900 - // TychoRouter:testSwapSingleUSV3 costs 264195 + // Gas usage: 296248 + // TychoRouter:testSwapSimplePermit2 costs 184993 + function testUniversalRouterUniswapV2Permit2() public { + uint256 amountIn = 10 ** 18; + + bytes memory commands = + abi.encodePacked(uint8(Commands.V2_SWAP_EXACT_IN)); + + address[] memory path = new address[](2); + path[0] = WETH_ADDR; + path[1] = DAI_ADDR; + + bytes[] memory inputs = new bytes[](1); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, true); + + deal(WETH_ADDR, address(this), amountIn); + IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); + permit2.approve( + WETH_ADDR, + address(universalRouter), + uint160(amountIn), + uint48(block.timestamp + 1000) + ); + universalRouter.execute(commands, inputs, block.timestamp + 1000); + } + + // Gas usage: 252003 + // TychoRouter:testSwapSingleUSV3 costs 126181 function testUniversalRouterUniswapV3() public { uint256 amountIn = 10 ** 18; @@ -67,9 +93,34 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 299427 - // TychoRouter:testSwapSingleUSV4Callback costs 286025 - function testUniversalRouterUniswapV4() public { + // Gas usage: 299036 + // TychoRouter:testSwapSingleUSV3Permit2 costs 192780 + function testUniversalRouterUniswapV3Permit2() public { + uint256 amountIn = 10 ** 18; + + bytes memory commands = + abi.encodePacked(uint8(Commands.V3_SWAP_EXACT_IN)); + + uint24 poolFee = 3000; + bytes memory path = abi.encodePacked(WETH_ADDR, poolFee, DAI_ADDR); + + bytes[] memory inputs = new bytes[](1); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, true); + + deal(WETH_ADDR, address(this), amountIn); + IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); + permit2.approve( + WETH_ADDR, + address(universalRouter), + uint160(amountIn), + uint48(block.timestamp + 1000) + ); + universalRouter.execute(commands, inputs, block.timestamp + 1000); + } + + // Gas usage: 299523 + // TychoRouter:testSwapSingleUSV4CallbackPermit2 costs 217751 + function testUniversalRouterUniswapV4Permit2() public { uint128 amountIn = uint128(100 ether); uint128 amountOutMinimum = uint128(0); uint256 deadline = block.timestamp + 1000; diff --git a/foundry/test/TychoRouter.t.sol b/foundry/test/TychoRouter.t.sol index d23e276..fd80824 100644 --- a/foundry/test/TychoRouter.t.sol +++ b/foundry/test/TychoRouter.t.sol @@ -231,6 +231,50 @@ contract TychoRouterTest is TychoRouterTestSetup { assertEq(IERC20(WETH_ADDR).balanceOf(tychoRouterAddr), 0); } + function testSwapSimplePermit2() public { + // Trade 1 WETH for DAI with 1 swap on Uniswap V2 using Permit2 + // 1 WETH -> DAI + // (USV2) + vm.startPrank(ALICE); + + uint256 amountIn = 1 ether; + deal(WETH_ADDR, ALICE, amountIn); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(WETH_ADDR, amountIn); + + bytes memory protocolData = encodeUniswapV2Swap( + WETH_ADDR, WETH_DAI_POOL, tychoRouterAddr, false + ); + + bytes memory swap = encodeSwap( + uint8(0), uint8(1), uint24(0), address(usv2Executor), protocolData + ); + bytes[] memory swaps = new bytes[](1); + swaps[0] = swap; + + tychoRouter.swapPermit2( + amountIn, + WETH_ADDR, + DAI_ADDR, + 0, + false, + false, + 2, + ALICE, + permitSingle, + signature, + pleEncode(swaps) + ); + + uint256 daiBalance = IERC20(DAI_ADDR).balanceOf(ALICE); + assertEq(daiBalance, 2659881924818443699787); + assertEq(IERC20(WETH_ADDR).balanceOf(ALICE), 0); + + vm.stopPrank(); + } + function testSwapMultipleHops() public { // Trade 1 WETH for USDC through DAI with 2 swaps on Uniswap V2 // 1 WETH -> DAI -> USDC @@ -633,6 +677,50 @@ contract TychoRouterTest is TychoRouterTestSetup { assertGe(finalBalance, expAmountOut); } + function testSwapSingleUSV3Permit2() public { + // Trade 1 WETH for DAI with 1 swap on Uniswap V3 using Permit2 + // 1 WETH -> DAI + // (USV3) + vm.startPrank(ALICE); + uint256 amountIn = 10 ** 18; + deal(WETH_ADDR, ALICE, amountIn); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(WETH_ADDR, amountIn); + + uint256 expAmountOut = 1205_128428842122129186; //Swap 1 WETH for 1205.12 DAI + bool zeroForOne = false; + bytes memory protocolData = encodeUniswapV3Swap( + WETH_ADDR, DAI_ADDR, tychoRouterAddr, DAI_WETH_USV3, zeroForOne + ); + bytes memory swap = encodeSwap( + uint8(0), uint8(1), uint24(0), address(usv3Executor), protocolData + ); + + bytes[] memory swaps = new bytes[](1); + swaps[0] = swap; + + tychoRouter.swapPermit2( + amountIn, + WETH_ADDR, + DAI_ADDR, + 0, + false, + false, + 2, + ALICE, + permitSingle, + signature, + pleEncode(swaps) + ); + + uint256 finalBalance = IERC20(DAI_ADDR).balanceOf(ALICE); + assertGe(finalBalance, expAmountOut); + + vm.stopPrank(); + } + function testEmptySwapsRevert() public { uint256 amountIn = 10 ** 18; bytes memory swaps = ""; @@ -944,6 +1032,52 @@ contract TychoRouterTest is TychoRouterTestSetup { assertEq(IERC20(USDT_ADDR).balanceOf(tychoRouterAddr), 99943852); } + function testSwapSingleUSV4CallbackPermit2() public { + vm.startPrank(ALICE); + uint256 amountIn = 100 ether; + deal(USDE_ADDR, ALICE, amountIn); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(USDE_ADDR, amountIn); + + UniswapV4Executor.UniswapV4Pool[] memory pools = + new UniswapV4Executor.UniswapV4Pool[](1); + pools[0] = UniswapV4Executor.UniswapV4Pool({ + intermediaryToken: USDT_ADDR, + fee: uint24(100), + tickSpacing: int24(1) + }); + + bytes memory protocolData = UniswapV4Utils.encodeExactInput( + USDE_ADDR, USDT_ADDR, true, address(usv4Executor), pools + ); + + bytes memory swap = encodeSwap( + uint8(0), uint8(1), uint24(0), address(usv4Executor), protocolData + ); + + bytes[] memory swaps = new bytes[](1); + swaps[0] = swap; + + tychoRouter.swapPermit2( + amountIn, + USDE_ADDR, + USDT_ADDR, + 0, + false, + false, + 2, + ALICE, + permitSingle, + signature, + pleEncode(swaps) + ); + + assertEq(IERC20(USDT_ADDR).balanceOf(ALICE), 99943852); + vm.stopPrank(); + } + function testSwapMultipleUSV4Callback() public { // This test has two uniswap v4 hops that will be executed inside of the V4 pool manager // USDE -> USDT -> WBTC From 5db95781e5afdf8d0270676d7d2845927efedcd2 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Fri, 28 Feb 2025 10:11:04 +0530 Subject: [PATCH 3/6] test: add isPermit2 bool in GasTest for readability --- foundry/test/GasTest.t.sol | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol index 90217ab..629b5e1 100644 --- a/foundry/test/GasTest.t.sol +++ b/foundry/test/GasTest.t.sol @@ -33,6 +33,7 @@ contract GasTest is Commands, Test, Constants { // Gas usage: 248511 // TychoRouter:testSwapSimple costs 113647 function testUniversalRouterUniswapV2() public { + bool isPermit2 = false; uint256 amountIn = 10 ** 18; bytes memory commands = @@ -43,7 +44,7 @@ contract GasTest is Commands, Test, Constants { path[1] = DAI_ADDR; bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, false); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); deal(WETH_ADDR, address(universalRouter), amountIn); universalRouter.execute(commands, inputs, block.timestamp + 1000); @@ -52,6 +53,7 @@ contract GasTest is Commands, Test, Constants { // Gas usage: 296248 // TychoRouter:testSwapSimplePermit2 costs 184993 function testUniversalRouterUniswapV2Permit2() public { + bool isPermit2 = true; uint256 amountIn = 10 ** 18; bytes memory commands = @@ -62,7 +64,7 @@ contract GasTest is Commands, Test, Constants { path[1] = DAI_ADDR; bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, true); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); deal(WETH_ADDR, address(this), amountIn); IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); @@ -78,6 +80,7 @@ contract GasTest is Commands, Test, Constants { // Gas usage: 252003 // TychoRouter:testSwapSingleUSV3 costs 126181 function testUniversalRouterUniswapV3() public { + bool isPermit2 = false; uint256 amountIn = 10 ** 18; bytes memory commands = @@ -87,7 +90,7 @@ contract GasTest is Commands, Test, Constants { bytes memory path = abi.encodePacked(WETH_ADDR, poolFee, DAI_ADDR); bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, false); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); deal(WETH_ADDR, address(universalRouter), amountIn); universalRouter.execute(commands, inputs, block.timestamp + 1000); @@ -96,6 +99,7 @@ contract GasTest is Commands, Test, Constants { // Gas usage: 299036 // TychoRouter:testSwapSingleUSV3Permit2 costs 192780 function testUniversalRouterUniswapV3Permit2() public { + bool isPermit2 = true; uint256 amountIn = 10 ** 18; bytes memory commands = @@ -105,7 +109,7 @@ contract GasTest is Commands, Test, Constants { bytes memory path = abi.encodePacked(WETH_ADDR, poolFee, DAI_ADDR); bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, true); + inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); deal(WETH_ADDR, address(this), amountIn); IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); From 6f69748ba42c0de3b0b45c2d4e199aa9db371e24 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Fri, 28 Feb 2025 22:02:21 +0530 Subject: [PATCH 4/6] test: update gas usage numbers in GasTest --- foundry/test/GasTest.t.sol | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol index 629b5e1..a47aa4f 100644 --- a/foundry/test/GasTest.t.sol +++ b/foundry/test/GasTest.t.sol @@ -30,7 +30,7 @@ contract GasTest is Commands, Test, Constants { vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock); } - // Gas usage: 248511 + // Gas usage: 72783 // TychoRouter:testSwapSimple costs 113647 function testUniversalRouterUniswapV2() public { bool isPermit2 = false; @@ -50,7 +50,7 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 296248 + // Gas usage: 74822 // TychoRouter:testSwapSimplePermit2 costs 184993 function testUniversalRouterUniswapV2Permit2() public { bool isPermit2 = true; @@ -77,7 +77,7 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 252003 + // Gas usage: 75917 // TychoRouter:testSwapSingleUSV3 costs 126181 function testUniversalRouterUniswapV3() public { bool isPermit2 = false; @@ -96,7 +96,7 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 299036 + // Gas usage: 77962 // TychoRouter:testSwapSingleUSV3Permit2 costs 192780 function testUniversalRouterUniswapV3Permit2() public { bool isPermit2 = true; @@ -122,7 +122,7 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 299523 + // Gas usage: 76112 // TychoRouter:testSwapSingleUSV4CallbackPermit2 costs 217751 function testUniversalRouterUniswapV4Permit2() public { uint128 amountIn = uint128(100 ether); From ec8d59eeae75b4c1cdab5efd2a1d22a1921dd1d9 Mon Sep 17 00:00:00 2001 From: royvardhan Date: Sat, 1 Mar 2025 00:09:15 +0530 Subject: [PATCH 5/6] test: remove gas usage numbers from GasTest --- foundry/test/GasTest.t.sol | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol index a47aa4f..33c95a6 100644 --- a/foundry/test/GasTest.t.sol +++ b/foundry/test/GasTest.t.sol @@ -19,8 +19,7 @@ contract Commands { } // A gas test to compare the gas usage of the UniversalRouter with the TychoRouter -// The gas usage quoted from the TychoRouter is without any asserts after the swap -// The path executed on TychoRouter is the same as the path executed on UniversalRouter + contract GasTest is Commands, Test, Constants { IUniversalRouter universalRouter = IUniversalRouter(UNIVERSAL_ROUTER); IPermit2 permit2 = IPermit2(PERMIT2_ADDRESS); @@ -30,8 +29,6 @@ contract GasTest is Commands, Test, Constants { vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock); } - // Gas usage: 72783 - // TychoRouter:testSwapSimple costs 113647 function testUniversalRouterUniswapV2() public { bool isPermit2 = false; uint256 amountIn = 10 ** 18; @@ -50,8 +47,6 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 74822 - // TychoRouter:testSwapSimplePermit2 costs 184993 function testUniversalRouterUniswapV2Permit2() public { bool isPermit2 = true; uint256 amountIn = 10 ** 18; @@ -77,8 +72,6 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 75917 - // TychoRouter:testSwapSingleUSV3 costs 126181 function testUniversalRouterUniswapV3() public { bool isPermit2 = false; uint256 amountIn = 10 ** 18; @@ -96,8 +89,6 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 77962 - // TychoRouter:testSwapSingleUSV3Permit2 costs 192780 function testUniversalRouterUniswapV3Permit2() public { bool isPermit2 = true; uint256 amountIn = 10 ** 18; @@ -122,8 +113,6 @@ contract GasTest is Commands, Test, Constants { universalRouter.execute(commands, inputs, block.timestamp + 1000); } - // Gas usage: 76112 - // TychoRouter:testSwapSingleUSV4CallbackPermit2 costs 217751 function testUniversalRouterUniswapV4Permit2() public { uint128 amountIn = uint128(100 ether); uint128 amountOutMinimum = uint128(0); From db9c8cde5aaa6cb32dbe74df228fb65d358687a3 Mon Sep 17 00:00:00 2001 From: Diana Carvalho Date: Mon, 3 Mar 2025 18:33:22 +0000 Subject: [PATCH 6/6] fix: Make permit2 permit an action in the universal router --- don't change below this line --- ENG-4286 Took 1 hour 35 minutes --- foundry/test/GasTest.t.sol | 135 ++++++++++++++++++++++++++++--------- 1 file changed, 103 insertions(+), 32 deletions(-) diff --git a/foundry/test/GasTest.t.sol b/foundry/test/GasTest.t.sol index 33c95a6..2bf9bdd 100644 --- a/foundry/test/GasTest.t.sol +++ b/foundry/test/GasTest.t.sol @@ -11,11 +11,13 @@ import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {Currency} from "../lib/v4-core/src/types/Currency.sol"; import {IHooks} from "../lib/v4-core/src/interfaces/IHooks.sol"; import "forge-std/Test.sol"; +import "@permit2/src/interfaces/IAllowanceTransfer.sol"; contract Commands { uint256 constant V2_SWAP_EXACT_IN = 0x08; uint256 constant V3_SWAP_EXACT_IN = 0x00; uint256 constant V4_SWAP = 0x10; + uint256 constant PERMIT2_PERMIT = 0x0a; } // A gas test to compare the gas usage of the UniversalRouter with the TychoRouter @@ -51,24 +53,26 @@ contract GasTest is Commands, Test, Constants { bool isPermit2 = true; uint256 amountIn = 10 ** 18; - bytes memory commands = - abi.encodePacked(uint8(Commands.V2_SWAP_EXACT_IN)); + bytes memory commands = abi.encodePacked( + uint8(Commands.PERMIT2_PERMIT), uint8(Commands.V2_SWAP_EXACT_IN) + ); + + vm.startPrank(ALICE); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(WETH_ADDR, amountIn); address[] memory path = new address[](2); path[0] = WETH_ADDR; path[1] = DAI_ADDR; - bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); + bytes[] memory inputs = new bytes[](2); + inputs[0] = abi.encode(permitSingle, signature); + inputs[1] = abi.encode(ALICE, amountIn, uint256(0), path, isPermit2); + + deal(WETH_ADDR, ALICE, amountIn); - deal(WETH_ADDR, address(this), amountIn); - IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); - permit2.approve( - WETH_ADDR, - address(universalRouter), - uint160(amountIn), - uint48(block.timestamp + 1000) - ); universalRouter.execute(commands, inputs, block.timestamp + 1000); } @@ -93,23 +97,25 @@ contract GasTest is Commands, Test, Constants { bool isPermit2 = true; uint256 amountIn = 10 ** 18; - bytes memory commands = - abi.encodePacked(uint8(Commands.V3_SWAP_EXACT_IN)); + bytes memory commands = abi.encodePacked( + uint8(Commands.PERMIT2_PERMIT), uint8(Commands.V3_SWAP_EXACT_IN) + ); + + vm.startPrank(ALICE); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(WETH_ADDR, amountIn); uint24 poolFee = 3000; bytes memory path = abi.encodePacked(WETH_ADDR, poolFee, DAI_ADDR); - bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(BOB, amountIn, uint256(0), path, isPermit2); + bytes[] memory inputs = new bytes[](2); + inputs[0] = abi.encode(permitSingle, signature); + inputs[1] = abi.encode(ALICE, amountIn, uint256(0), path, isPermit2); + + deal(WETH_ADDR, ALICE, amountIn); - deal(WETH_ADDR, address(this), amountIn); - IERC20(WETH_ADDR).approve(PERMIT2_ADDRESS, amountIn); - permit2.approve( - WETH_ADDR, - address(universalRouter), - uint160(amountIn), - uint48(block.timestamp + 1000) - ); universalRouter.execute(commands, inputs, block.timestamp + 1000); } @@ -118,7 +124,9 @@ contract GasTest is Commands, Test, Constants { uint128 amountOutMinimum = uint128(0); uint256 deadline = block.timestamp + 1000; - bytes memory commands = abi.encodePacked(uint8(Commands.V4_SWAP)); + bytes memory commands = abi.encodePacked( + uint8(Commands.PERMIT2_PERMIT), uint8(Commands.V4_SWAP) + ); bytes memory actions = abi.encodePacked( uint8(Actions.SWAP_EXACT_IN_SINGLE), @@ -126,6 +134,12 @@ contract GasTest is Commands, Test, Constants { uint8(Actions.TAKE_ALL) ); + vm.startPrank(ALICE); + ( + IAllowanceTransfer.PermitSingle memory permitSingle, + bytes memory signature + ) = handlePermit2Approval(USDE_ADDR, amountIn); + PoolKey memory key = PoolKey({ currency0: Currency.wrap(USDE_ADDR), currency1: Currency.wrap(USDT_ADDR), @@ -148,14 +162,71 @@ contract GasTest is Commands, Test, Constants { params[1] = abi.encode(key.currency0, amountIn); params[2] = abi.encode(key.currency1, amountOutMinimum); - bytes[] memory inputs = new bytes[](1); - inputs[0] = abi.encode(actions, params); + bytes[] memory inputs = new bytes[](2); + inputs[0] = abi.encode(permitSingle, signature); + inputs[1] = abi.encode(actions, params); + + deal(USDE_ADDR, ALICE, amountIn); - deal(USDE_ADDR, address(this), amountIn); - IERC20(USDE_ADDR).approve(PERMIT2_ADDRESS, amountIn); - permit2.approve( - USDE_ADDR, address(universalRouter), amountIn, uint48(deadline) - ); universalRouter.execute(commands, inputs, deadline); } + + function handlePermit2Approval(address tokenIn, uint256 amount_in) + internal + returns (IAllowanceTransfer.PermitSingle memory, bytes memory) + { + IERC20(tokenIn).approve(PERMIT2_ADDRESS, amount_in); + IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer + .PermitSingle({ + details: IAllowanceTransfer.PermitDetails({ + token: tokenIn, + amount: uint160(amount_in), + expiration: uint48(block.timestamp + 1 days), + nonce: 0 + }), + spender: UNIVERSAL_ROUTER, + sigDeadline: block.timestamp + 1 days + }); + + bytes memory signature = signPermit2(permitSingle, ALICE_PK); + return (permitSingle, signature); + } + + function signPermit2( + IAllowanceTransfer.PermitSingle memory permit, + uint256 privateKey + ) internal view returns (bytes memory) { + bytes32 _PERMIT_DETAILS_TYPEHASH = keccak256( + "PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)" + ); + bytes32 _PERMIT_SINGLE_TYPEHASH = keccak256( + "PermitSingle(PermitDetails details,address spender,uint256 sigDeadline)PermitDetails(address token,uint160 amount,uint48 expiration,uint48 nonce)" + ); + bytes32 domainSeparator = keccak256( + abi.encode( + keccak256( + "EIP712Domain(string name,uint256 chainId,address verifyingContract)" + ), + keccak256("Permit2"), + block.chainid, + PERMIT2_ADDRESS + ) + ); + bytes32 detailsHash = + keccak256(abi.encode(_PERMIT_DETAILS_TYPEHASH, permit.details)); + bytes32 permitHash = keccak256( + abi.encode( + _PERMIT_SINGLE_TYPEHASH, + detailsHash, + permit.spender, + permit.sigDeadline + ) + ); + + bytes32 digest = + keccak256(abi.encodePacked("\x19\x01", domainSeparator, permitHash)); + (uint8 v, bytes32 r, bytes32 s) = vm.sign(privateKey, digest); + + return abi.encodePacked(r, s, v); + } }