Merge pull request #23 from propeller-heads/router/dc/ENG-4033-univ2-executor

feat: UniswapV2 SwapExecutor
This commit is contained in:
dianacarvalho1
2025-01-24 17:04:12 +00:00
committed by GitHub
13 changed files with 257 additions and 85 deletions

3
.gitmodules vendored
View File

@@ -4,3 +4,6 @@
[submodule "foundry/lib/permit2"]
path = foundry/lib/permit2
url = https://github.com/Uniswap/permit2
[submodule "foundry/lib/v2-core"]
path = foundry/lib/v2-core
url = https://github.com/uniswap/v2-core

View File

@@ -16,7 +16,7 @@ To run locally, simply install Slither in your conda env and run it inside the f
conda create --name tycho-execution python=3.10
conda activate tycho-execution
python3 -m pip install slither-analyzer`
pip install slither-analyzer
cd foundry
slither .
```

View File

@@ -4,10 +4,10 @@
Foundry consists of:
- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
## Documentation
@@ -45,12 +45,6 @@ $ forge snapshot
$ anvil
```
### Deploy
```shell
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
```
### Cast
```shell

View File

@@ -5,7 +5,7 @@ import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
pragma abicoder v2;
interface ISwapExecutor {
interface IExecutor {
/**
* @notice Performs a swap on a liquidity pool.
* @dev This method takes the amount of the input token and returns the amount of
@@ -25,7 +25,7 @@ interface ISwapExecutor {
returns (uint256 calculatedAmount);
}
interface ISwapExecutorErrors {
interface IExecutorErrors {
error InvalidParameterLength(uint256);
error UnknownPoolType(uint8);
}

1
foundry/lib/v2-core Submodule

Submodule foundry/lib/v2-core added at 4dd59067c7

View File

@@ -1,4 +1,5 @@
@openzeppelin/=lib/openzeppelin-contracts/
@interfaces/=interfaces/
@permit2/=lib/permit2/
@src/=src/
@src/=src/
@uniswap-v2/=lib/v2-core/

View File

@@ -1,13 +1,13 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;
import "@interfaces/ISwapExecutor.sol";
import "@interfaces/IExecutor.sol";
error SwapExecutionDispatcher__UnapprovedExecutor();
error SwapExecutionDispatcher__NonContractExecutor();
error ExecutionDispatcher__UnapprovedExecutor();
error ExecutionDispatcher__NonContractExecutor();
/**
* @title SwapExecutionDispatcher - Dispatch swap execution to external contracts
* @title ExecutionDispatcher - Dispatch 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
@@ -15,34 +15,34 @@ error SwapExecutionDispatcher__NonContractExecutor();
* be called using delegatecall so they can share state with the main
* contract if needed.
*
* Note Executor contracts need to implement the ISwapExecutor interface unless
* Note Executor contracts need to implement the IExecutor interface unless
* an alternate selector is specified.
*/
contract SwapExecutionDispatcher {
mapping(address => bool) public swapExecutors;
contract ExecutionDispatcher {
mapping(address => bool) public executors;
event ExecutorSet(address indexed executor);
event ExecutorRemoved(address indexed executor);
/**
* @dev Adds or replaces an approved swap executor contract address if it is a
* @dev Adds or replaces an approved executor contract address if it is a
* contract.
* @param target address of the swap executor contract
* @param target address of the executor contract
*/
function _setSwapExecutor(address target) internal {
function _setExecutor(address target) internal {
if (target.code.length == 0) {
revert SwapExecutionDispatcher__NonContractExecutor();
revert ExecutionDispatcher__NonContractExecutor();
}
swapExecutors[target] = true;
executors[target] = true;
emit ExecutorSet(target);
}
/**
* @dev Removes an approved swap executor contract address
* @param target address of the swap executor contract
* @dev Removes an approved executor contract address
* @param target address of the executor contract
*/
function _removeSwapExecutor(address target) internal {
delete swapExecutors[target];
function _removeExecutor(address target) internal {
delete executors[target];
emit ExecutorRemoved(target);
}
@@ -51,7 +51,7 @@ contract SwapExecutionDispatcher {
* protocol-specific data required by the executor.
*/
// slither-disable-next-line dead-code
function _callSwapExecutor(uint256 amount, bytes calldata data)
function _callExecutor(uint256 amount, bytes calldata data)
internal
returns (uint256 calculatedAmount)
{
@@ -62,12 +62,12 @@ contract SwapExecutionDispatcher {
(executor, decodedSelector, protocolData) =
_decodeExecutorAndSelector(data);
if (!swapExecutors[executor]) {
revert SwapExecutionDispatcher__UnapprovedExecutor();
if (!executors[executor]) {
revert ExecutionDispatcher__UnapprovedExecutor();
}
bytes4 selector = decodedSelector == bytes4(0)
? ISwapExecutor.swap.selector
? IExecutor.swap.selector
: decodedSelector;
// slither-disable-next-line low-level-calls
@@ -80,7 +80,7 @@ contract SwapExecutionDispatcher {
string(
result.length > 0
? result
: abi.encodePacked("Swap execution failed")
: abi.encodePacked("Execution failed")
)
);
}

View File

@@ -5,7 +5,7 @@ import "@openzeppelin/contracts/access/AccessControl.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 "./ExecutionDispatcher.sol";
import "./CallbackVerificationDispatcher.sol";
error TychoRouter__WithdrawalFailed();
@@ -14,7 +14,7 @@ error TychoRouter__NonContractVerifier();
contract TychoRouter is
AccessControl,
SwapExecutionDispatcher,
ExecutionDispatcher,
CallbackVerificationDispatcher
{
IAllowanceTransfer public immutable permit2;
@@ -92,30 +92,30 @@ contract TychoRouter is
}
/**
* @dev Entrypoint to add or replace an approved swap executor contract address
* @param target address of the swap executor contract
* @dev Entrypoint to add or replace an approved executor contract address
* @param target address of the executor contract
*/
function setSwapExecutor(address target)
function setExecutor(address target)
external
onlyRole(EXECUTOR_SETTER_ROLE)
{
_setSwapExecutor(target);
_setExecutor(target);
}
/**
* @dev Entrypoint to remove an approved swap executor contract address
* @param target address of the swap executor contract
* @dev Entrypoint to remove an approved executor contract address
* @param target address of the executor contract
*/
function removeSwapExecutor(address target)
function removeExecutor(address target)
external
onlyRole(EXECUTOR_SETTER_ROLE)
{
_removeSwapExecutor(target);
_removeExecutor(target);
}
/**
* @dev Entrypoint to add or replace an approved swap executor contract address
* @param target address of the swap method contract
* @dev Entrypoint to add or replace an approved callback verifier contract address
* @param target address of the callback verifier contract
*/
function setCallbackVerifier(address target)
external
@@ -127,8 +127,8 @@ contract TychoRouter is
}
/**
* @dev Entrypoint to remove an approved swap executor contract address
* @param target address of the swap method contract
* @dev Entrypoint to remove an approved callback verifier contract address
* @param target address of the callback verifier contract
*/
function removeCallbackVerifier(address target)
external

View File

@@ -0,0 +1,75 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;
import "@interfaces/IExecutor.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@uniswap-v2/contracts/interfaces/IUniswapV2Pair.sol";
error UniswapV2Executor__InvalidDataLength();
contract UniswapV2Executor is IExecutor {
using SafeERC20 for IERC20;
function swap(uint256 givenAmount, bytes calldata data)
external
returns (uint256 calculatedAmount)
{
address target;
address receiver;
bool zeroForOne;
IERC20 tokenIn;
(tokenIn, target, receiver, zeroForOne) = _decodeData(data);
calculatedAmount = _getAmountOut(target, givenAmount, zeroForOne);
tokenIn.safeTransfer(target, givenAmount);
IUniswapV2Pair pool = IUniswapV2Pair(target);
if (zeroForOne) {
pool.swap(0, calculatedAmount, receiver, "");
} else {
pool.swap(calculatedAmount, 0, receiver, "");
}
}
function _decodeData(bytes calldata data)
internal
pure
returns (
IERC20 inToken,
address target,
address receiver,
bool zeroForOne
)
{
if (data.length != 61) {
revert UniswapV2Executor__InvalidDataLength();
}
inToken = IERC20(address(bytes20(data[0:20])));
target = address(bytes20(data[20:40]));
receiver = address(bytes20(data[40:60]));
zeroForOne = uint8(data[60]) > 0;
}
function _getAmountOut(address target, uint256 amountIn, bool zeroForOne)
internal
view
returns (uint256 amount)
{
IUniswapV2Pair pair = IUniswapV2Pair(target);
uint112 reserveIn;
uint112 reserveOut;
if (zeroForOne) {
// slither-disable-next-line unused-return
(reserveIn, reserveOut,) = pair.getReserves();
} else {
// slither-disable-next-line unused-return
(reserveOut, reserveIn,) = pair.getReserves();
}
require(reserveIn > 0 && reserveOut > 0, "L");
uint256 amountInWithFee = amountIn * 997;
uint256 numerator = amountInWithFee * uint256(reserveOut);
uint256 denominator = (uint256(reserveIn) * 1000) + amountInWithFee;
amount = numerator / denominator;
}
}

View File

@@ -14,6 +14,7 @@ contract Constants is Test {
address DUMMY = makeAddr("dummy");
address WETH_ADDR = address(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
address DAI_ADDR = address(0x6B175474E89094C44Da98b954EedeAC495271d0F);
/**
* @dev Deploys a dummy contract with non-empty bytecode

View File

@@ -1,15 +1,15 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;
import "@src/SwapExecutionDispatcher.sol";
import "@src/ExecutionDispatcher.sol";
import "./TychoRouterTestSetup.sol";
contract SwapExecutionDispatcherExposed is SwapExecutionDispatcher {
function exposedCallSwapExecutor(uint256 amount, bytes calldata data)
contract ExecutionDispatcherExposed is ExecutionDispatcher {
function exposedCallExecutor(uint256 amount, bytes calldata data)
external
returns (uint256 calculatedAmount)
{
return _callSwapExecutor(amount, data);
return _callExecutor(amount, data);
}
function exposedDecodeExecutorAndSelector(bytes calldata data)
@@ -20,17 +20,17 @@ contract SwapExecutionDispatcherExposed is SwapExecutionDispatcher {
return _decodeExecutorAndSelector(data);
}
function exposedSetSwapExecutor(address target) external {
_setSwapExecutor(target);
function exposedSetExecutor(address target) external {
_setExecutor(target);
}
function exposedRemoveSwapExecutor(address target) external {
_removeSwapExecutor(target);
function exposedRemoveExecutor(address target) external {
_removeExecutor(target);
}
}
contract SwapExecutionDispatcherTest is Constants {
SwapExecutionDispatcherExposed dispatcherExposed;
contract ExecutionDispatcherTest is Constants {
ExecutionDispatcherExposed dispatcherExposed;
event ExecutorSet(address indexed executor);
event ExecutorRemoved(address indexed executor);
@@ -38,7 +38,7 @@ contract SwapExecutionDispatcherTest is Constants {
function setUp() public {
uint256 forkBlock = 20673900;
vm.createSelectFork(vm.rpcUrl("mainnet"), forkBlock);
dispatcherExposed = new SwapExecutionDispatcherExposed();
dispatcherExposed = new ExecutionDispatcherExposed();
deal(WETH_ADDR, address(dispatcherExposed), 15 ether);
deployDummyContract();
}
@@ -47,34 +47,34 @@ contract SwapExecutionDispatcherTest is Constants {
vm.expectEmit();
// Define the event we expect to be emitted at the next step
emit ExecutorSet(DUMMY);
dispatcherExposed.exposedSetSwapExecutor(DUMMY);
assert(dispatcherExposed.swapExecutors(DUMMY) == true);
dispatcherExposed.exposedSetExecutor(DUMMY);
assert(dispatcherExposed.executors(DUMMY) == true);
}
function testRemoveExecutor() public {
dispatcherExposed.exposedSetSwapExecutor(DUMMY);
dispatcherExposed.exposedSetExecutor(DUMMY);
vm.expectEmit();
// Define the event we expect to be emitted at the next step
emit ExecutorRemoved(DUMMY);
dispatcherExposed.exposedRemoveSwapExecutor(DUMMY);
assert(dispatcherExposed.swapExecutors(DUMMY) == false);
dispatcherExposed.exposedRemoveExecutor(DUMMY);
assert(dispatcherExposed.executors(DUMMY) == false);
}
function testRemoveUnSetExecutor() public {
dispatcherExposed.exposedRemoveSwapExecutor(BOB);
assert(dispatcherExposed.swapExecutors(BOB) == false);
dispatcherExposed.exposedRemoveExecutor(BOB);
assert(dispatcherExposed.executors(BOB) == false);
}
function testSetExecutorNonContract() public {
vm.expectRevert(
abi.encodeWithSelector(
SwapExecutionDispatcher__NonContractExecutor.selector
ExecutionDispatcher__NonContractExecutor.selector
)
);
dispatcherExposed.exposedSetSwapExecutor(BOB);
dispatcherExposed.exposedSetExecutor(BOB);
}
function testCallSwapExecutor() public {
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
@@ -84,18 +84,18 @@ contract SwapExecutionDispatcherTest is Constants {
// 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.exposedSetSwapExecutor(
dispatcherExposed.exposedSetExecutor(
address(0xe592557AB9F4A75D992283fD6066312FF013ba3d)
);
bytes memory data =
hex"e592557AB9F4A75D992283fD6066312FF013ba3dbd0625ab5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72fc8c39af7983bf329086de522229a7be5fc4e41cc51c72848c68a965f66fa7a88855f9f7784502a7f2606beffe61000613d6a25b5bfef4cd7652aa94777d4a46b39f2e206411280a12c9344b769ff1066c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000d02ab486cedc0000000000000000000000000000000000000000000000000000000000082ec8ad1b0000000000000000000000000000000000000000000000000000000066d7b65800000000000000000000000000000000000000000000000000000191ba9f843c125000064000640000d52de09955f0ffffffffffffff00225c389e595fe9000001fcc910754b349f821e4bb5d8444822a63920be943aba6f1b31ee14ef0fc6840b6d28d604e04a78834b668dba24a6c082ffb901e4fffa9600649e8d991af593c81c";
uint256 givenAmount = 15 ether;
uint256 amount =
dispatcherExposed.exposedCallSwapExecutor(givenAmount, data);
dispatcherExposed.exposedCallExecutor(givenAmount, data);
assert(amount == 35144641819);
}
function testCallSwapExecutorNoSelector() public {
function testCallExecutorNoSelector() public {
// Test case taken from existing transaction
// 0x755d603962b30f416cf3eefae8d55204d6ffdf746465b2a94aca216faab63804
// No selector is passed, so the standard swap selector should be used
@@ -107,33 +107,33 @@ contract SwapExecutionDispatcherTest is Constants {
// 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.exposedSetSwapExecutor(
dispatcherExposed.exposedSetExecutor(
address(0xe592557AB9F4A75D992283fD6066312FF013ba3d)
);
bytes memory data =
hex"e592557AB9F4A75D992283fD6066312FF013ba3d000000005615dEB798BB3E4dFa0139dFa1b3D433Cc23b72fc8c39af7983bf329086de522229a7be5fc4e41cc51c72848c68a965f66fa7a88855f9f7784502a7f2606beffe61000613d6a25b5bfef4cd7652aa94777d4a46b39f2e206411280a12c9344b769ff1066c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000d02ab486cedc0000000000000000000000000000000000000000000000000000000000082ec8ad1b0000000000000000000000000000000000000000000000000000000066d7b65800000000000000000000000000000000000000000000000000000191ba9f843c125000064000640000d52de09955f0ffffffffffffff00225c389e595fe9000001fcc910754b349f821e4bb5d8444822a63920be943aba6f1b31ee14ef0fc6840b6d28d604e04a78834b668dba24a6c082ffb901e4fffa9600649e8d991af593c81c";
uint256 givenAmount = 15 ether;
uint256 amount =
dispatcherExposed.exposedCallSwapExecutor(givenAmount, data);
dispatcherExposed.exposedCallExecutor(givenAmount, data);
assert(amount == 35144641819);
}
function testCallSwapExecutorCallFailed() public {
// Bad data is provided to an approved swap executor - causing the call to fail
dispatcherExposed.exposedSetSwapExecutor(
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.exposedCallSwapExecutor(0, data);
dispatcherExposed.exposedCallExecutor(0, data);
}
function testCallSwapExecutorUnapprovedExecutor() public {
function testCallExecutorUnapprovedExecutor() public {
bytes memory data =
hex"5d622C9053b8FFB1B3465495C8a42E603632bA70aabbccdd1111111111111111";
vm.expectRevert();
dispatcherExposed.exposedCallSwapExecutor(0, data);
dispatcherExposed.exposedCallExecutor(0, data);
}
function testDecodeExecutorAndSelector() public {

View File

@@ -21,19 +21,19 @@ contract TychoRouterTest is TychoRouterTestSetup {
function testSetExecutorValidRole() public {
vm.startPrank(executorSetter);
tychoRouter.setSwapExecutor(DUMMY);
tychoRouter.setExecutor(DUMMY);
vm.stopPrank();
assert(tychoRouter.swapExecutors(DUMMY) == true);
assert(tychoRouter.executors(DUMMY) == true);
}
function testRemoveExecutorMissingSetterRole() public {
vm.expectRevert();
tychoRouter.removeSwapExecutor(BOB);
tychoRouter.removeExecutor(BOB);
}
function testSetExecutorMissingSetterRole() public {
vm.expectRevert();
tychoRouter.setSwapExecutor(DUMMY);
tychoRouter.setExecutor(DUMMY);
}
function testSetValidVerifier() public {

View File

@@ -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);
}
}