Liquidity.Party/tycho-execution
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: Add transfer out for Curve

Browse Source 
Add transfer in Executor and pass receiver address in encoding
Remove integration test with StETH pool because we don't support it at simulation level and there is something weird with the amounts (that it is not worth it to investigate now)

--- don't change below this line ---
ENG-4315 Took 34 minutes

Took 2 minutes
This commit is contained in:
Diana Carvalho
2025-04-15 13:03:25 +01:00
parent 9bcb58e5aa
commit 328a281a44
4 changed files with 67 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
foundry/src/executors/CurveExecutor.sol
View File

@@ -4,6 +4,7 @@ pragma solidity ^0.8.26;
import "@interfaces/IExecutor.sol"; import "@interfaces/IExecutor.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./TokenTransfer.sol"; import "./TokenTransfer.sol";
import "@openzeppelin/contracts/utils/Address.sol";
error CurveExecutor__AddressZero(); error CurveExecutor__AddressZero();
error CurveExecutor__InvalidDataLength(); error CurveExecutor__InvalidDataLength();
@@ -64,7 +65,8 @@ contract CurveExecutor is IExecutor, TokenTransfer {
int128 i, int128 i,
int128 j, int128 j,
bool tokenApprovalNeeded, bool tokenApprovalNeeded,
TransferType transferType TransferType transferType,
address receiver
) = _decodeData(data); ) = _decodeData(data);
_transfer( _transfer(
@@ -109,7 +111,16 @@ contract CurveExecutor is IExecutor, TokenTransfer {
} }
uint256 balanceAfter = _balanceOf(tokenOut); uint256 balanceAfter = _balanceOf(tokenOut);
return balanceAfter - balanceBefore; uint256 amountOut = balanceAfter - balanceBefore;
if (receiver != address(this)) {
if (tokenOut == nativeToken) {
Address.sendValue(payable(receiver), amountOut);
} else {
IERC20(tokenOut).safeTransfer(receiver, amountOut);
}
}
return amountOut;
} }
function _decodeData(bytes calldata data) function _decodeData(bytes calldata data)
@@ -123,7 +134,7 @@ contract CurveExecutor is IExecutor, TokenTransfer {
int128 i, int128 i,
int128 j, int128 j,
bool tokenApprovalNeeded, bool tokenApprovalNeeded,
TransferType transferType address receiver
) )
{ {
tokenIn = address(bytes20(data[0:20])); tokenIn = address(bytes20(data[0:20]));
@@ -134,6 +145,7 @@ contract CurveExecutor is IExecutor, TokenTransfer {
j = int128(uint128(uint8(data[62]))); j = int128(uint128(uint8(data[62])));
tokenApprovalNeeded = data[63] != 0; tokenApprovalNeeded = data[63] != 0;
transferType = TransferType(uint8(data[64])); transferType = TransferType(uint8(data[64]));
receiver = address(bytes20(data[65:85]));
} }
receive() external payable { receive() external payable {

15
foundry/test/TychoRouterIntegration.t.sol
View File

@@ -312,19 +312,4 @@ contract TychoRouterTestIntegration is TychoRouterTestSetup {
vm.stopPrank(); vm.stopPrank();
} }
function testSplitCurveIntegrationStETH() public {
deal(ALICE, 1 ether);
vm.startPrank(ALICE);
// Encoded solution generated using `test_split_encoding_strategy_curve_st_eth`
(bool success,) = tychoRouterAddr.call{value: 1 ether}(
hex"79b9b93b0000000000000000000000000000000000000000000000000de0b6b3a76400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000ae7ab96520de3a18e5e111b5eaab095312d7fe840000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002000000000000000000000000cd09f75e2bf2a4d11f3ab23f1389fcc1621c0cc20000000000000000000000000000000000000000000000000000000000000120000000000000000000000000000000000000000000000000000000000000005c005a00010000001d1499e622d69689cdf9004d05ec547d650ff211eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeae7ab96520de3a18e5e111b5eaab095312d7fe84dc24316b9ae028f1497c275eb9192a3ea0f67022010001000500000000"
);
assertTrue(success, "Call Failed");
assertEq(IERC20(STETH_ADDR).balanceOf(ALICE), 1000754689941529590);
vm.stopPrank();
}
} }

113
foundry/test/executors/CurveExecutor.t.sol
View File

@@ -37,7 +37,8 @@ contract CurveExecutorExposed is CurveExecutor {
int128 i, int128 i,
int128 j, int128 j,
bool tokenApprovalNeeded, bool tokenApprovalNeeded,
TokenTransfer.TransferType transferType TokenTransfer.TransferType transferType,
address receiver
) )
{ {
return _decodeData(data); return _decodeData(data);
@@ -67,7 +68,8 @@ contract CurveExecutorTest is Test, Constants {
uint8(2), uint8(2),
uint8(0), uint8(0),
true, true,
TokenTransfer.TransferType.NONE TokenTransfer.TransferType.NONE,
ALICE
); );
( (
@@ -78,7 +80,8 @@ contract CurveExecutorTest is Test, Constants {
int128 i, int128 i,
int128 j, int128 j,
bool tokenApprovalNeeded, bool tokenApprovalNeeded,
TokenTransfer.TransferType transferType TokenTransfer.TransferType transferType,
address receiver
) = curveExecutorExposed.decodeData(data); ) = curveExecutorExposed.decodeData(data);
assertEq(tokenIn, WETH_ADDR); assertEq(tokenIn, WETH_ADDR);
@@ -89,6 +92,7 @@ contract CurveExecutorTest is Test, Constants {
assertEq(j, 0); assertEq(j, 0);
assertEq(tokenApprovalNeeded, true); assertEq(tokenApprovalNeeded, true);
assertEq(uint8(transferType), uint8(TokenTransfer.TransferType.NONE)); assertEq(uint8(transferType), uint8(TokenTransfer.TransferType.NONE));
assertEq(receiver, ALICE);
} }
function testTriPool() public { function testTriPool() public {
@@ -96,15 +100,12 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
deal(DAI_ADDR, address(curveExecutorExposed), amountIn); deal(DAI_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(DAI_ADDR, USDC_ADDR, TRIPOOL, 1); bytes memory data = _getData(DAI_ADDR, USDC_ADDR, TRIPOOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 999797); assertEq(amountOut, 999797);
assertEq( assertEq(IERC20(USDC_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDC_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testStEthPool() public { function testStEthPool() public {
@@ -113,14 +114,14 @@ contract CurveExecutorTest is Test, Constants {
deal(address(curveExecutorExposed), amountIn); deal(address(curveExecutorExposed), amountIn);
bytes memory data = bytes memory data =
_getData(ETH_ADDR_FOR_CURVE, STETH_ADDR, STETH_POOL, 1); _getData(ETH_ADDR_FOR_CURVE, STETH_ADDR, STETH_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 1001072414418410897); assertEq(amountOut, 1001072414418410897);
assertEq( assertEq(
IERC20(STETH_ADDR).balanceOf(address(curveExecutorExposed)), IERC20(STETH_ADDR).balanceOf(ALICE),
amountOut amountOut - 1 // there is something weird in this pool, but won't investigate for now because we don't currently support it in the simulation
); );
} }
@@ -129,15 +130,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
deal(WETH_ADDR, address(curveExecutorExposed), amountIn); deal(WETH_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(WETH_ADDR, WBTC_ADDR, TRICRYPTO2_POOL, 3); bytes memory data =
_getData(WETH_ADDR, WBTC_ADDR, TRICRYPTO2_POOL, 3, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 2279618); assertEq(amountOut, 2279618);
assertEq( assertEq(IERC20(WBTC_ADDR).balanceOf(ALICE), amountOut);
IERC20(WBTC_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testSUSDPool() public { function testSUSDPool() public {
@@ -145,15 +144,12 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 100 * 10 ** 6; uint256 amountIn = 100 * 10 ** 6;
deal(USDC_ADDR, address(curveExecutorExposed), amountIn); deal(USDC_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(USDC_ADDR, SUSD_ADDR, SUSD_POOL, 1); bytes memory data = _getData(USDC_ADDR, SUSD_ADDR, SUSD_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 100488101605550214590); assertEq(amountOut, 100488101605550214590);
assertEq( assertEq(IERC20(SUSD_ADDR).balanceOf(ALICE), amountOut);
IERC20(SUSD_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testFraxUsdcPool() public { function testFraxUsdcPool() public {
@@ -161,15 +157,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
deal(FRAX_ADDR, address(curveExecutorExposed), amountIn); deal(FRAX_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(FRAX_ADDR, USDC_ADDR, FRAX_USDC_POOL, 1); bytes memory data =
_getData(FRAX_ADDR, USDC_ADDR, FRAX_USDC_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 998097); assertEq(amountOut, 998097);
assertEq( assertEq(IERC20(USDC_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDC_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testUsdeUsdcPool() public { function testUsdeUsdcPool() public {
@@ -177,15 +171,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 100 * 10 ** 6; uint256 amountIn = 100 * 10 ** 6;
deal(USDC_ADDR, address(curveExecutorExposed), amountIn); deal(USDC_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(USDC_ADDR, USDE_ADDR, USDE_USDC_POOL, 1); bytes memory data =
_getData(USDC_ADDR, USDE_ADDR, USDE_USDC_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 100064812138999986170); assertEq(amountOut, 100064812138999986170);
assertEq( assertEq(IERC20(USDE_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDE_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testDolaFraxPyusdPool() public { function testDolaFraxPyusdPool() public {
@@ -194,32 +186,27 @@ contract CurveExecutorTest is Test, Constants {
deal(DOLA_ADDR, address(curveExecutorExposed), amountIn); deal(DOLA_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = bytes memory data =
_getData(DOLA_ADDR, FRAXPYUSD_POOL, DOLA_FRAXPYUSD_POOL, 1); _getData(DOLA_ADDR, FRAXPYUSD_POOL, DOLA_FRAXPYUSD_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 99688992); assertEq(amountOut, 99688992);
assertEq( assertEq(IERC20(FRAXPYUSD_POOL).balanceOf(ALICE), amountOut);
IERC20(FRAXPYUSD_POOL).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testCryptoPoolWithETH() public { function testCryptoPoolWithETH() public {
// Swapping XYO -> ETH on a CryptoPool, deployed by factory 0xF18056Bbd320E96A48e3Fbf8bC061322531aac99 // Swapping XYO -> ETH on a CryptoPool, deployed by factory 0xF18056Bbd320E96A48e3Fbf8bC061322531aac99
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
uint256 initialBalance = address(curveExecutorExposed).balance; // this address already has some ETH assigned to it uint256 initialBalance = address(ALICE).balance; // this address already has some ETH assigned to it
deal(XYO_ADDR, address(curveExecutorExposed), amountIn); deal(XYO_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = bytes memory data =
_getData(XYO_ADDR, ETH_ADDR_FOR_CURVE, ETH_XYO_POOL, 2); _getData(XYO_ADDR, ETH_ADDR_FOR_CURVE, ETH_XYO_POOL, 2, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 6081816039338); assertEq(amountOut, 6081816039338);
assertEq( assertEq(ALICE.balance, initialBalance + amountOut);
address(curveExecutorExposed).balance, initialBalance + amountOut
);
} }
function testCryptoPool() public { function testCryptoPool() public {
@@ -227,15 +214,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1000 ether; uint256 amountIn = 1000 ether;
deal(BSGG_ADDR, address(curveExecutorExposed), amountIn); deal(BSGG_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(BSGG_ADDR, USDT_ADDR, BSGG_USDT_POOL, 2); bytes memory data =
_getData(BSGG_ADDR, USDT_ADDR, BSGG_USDT_POOL, 2, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 23429); assertEq(amountOut, 23429);
assertEq( assertEq(IERC20(USDT_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDT_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testTricryptoPool() public { function testTricryptoPool() public {
@@ -243,15 +228,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
deal(WETH_ADDR, address(curveExecutorExposed), amountIn); deal(WETH_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(WETH_ADDR, USDC_ADDR, TRICRYPTO_POOL, 2); bytes memory data =
_getData(WETH_ADDR, USDC_ADDR, TRICRYPTO_POOL, 2, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 1861130974); assertEq(amountOut, 1861130974);
assertEq( assertEq(IERC20(USDC_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDC_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testTwoCryptoPool() public { function testTwoCryptoPool() public {
@@ -259,15 +242,13 @@ contract CurveExecutorTest is Test, Constants {
uint256 amountIn = 1 ether; uint256 amountIn = 1 ether;
deal(UWU_ADDR, address(curveExecutorExposed), amountIn); deal(UWU_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = _getData(UWU_ADDR, WETH_ADDR, UWU_WETH_POOL, 2); bytes memory data =
_getData(UWU_ADDR, WETH_ADDR, UWU_WETH_POOL, 2, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 2873786684675); assertEq(amountOut, 2873786684675);
assertEq( assertEq(IERC20(WETH_ADDR).balanceOf(ALICE), amountOut);
IERC20(WETH_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testStableSwapPool() public { function testStableSwapPool() public {
@@ -276,15 +257,12 @@ contract CurveExecutorTest is Test, Constants {
deal(CRVUSD_ADDR, address(curveExecutorExposed), amountIn); deal(CRVUSD_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = bytes memory data =
_getData(CRVUSD_ADDR, USDT_ADDR, CRVUSD_USDT_POOL, 1); _getData(CRVUSD_ADDR, USDT_ADDR, CRVUSD_USDT_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 999910); assertEq(amountOut, 999910);
assertEq( assertEq(IERC20(USDT_ADDR).balanceOf(ALICE), amountOut);
IERC20(USDT_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function testMetaPool() public { function testMetaPool() public {
@@ -293,22 +271,20 @@ contract CurveExecutorTest is Test, Constants {
deal(WTAO_ADDR, address(curveExecutorExposed), amountIn); deal(WTAO_ADDR, address(curveExecutorExposed), amountIn);
bytes memory data = bytes memory data =
_getData(WTAO_ADDR, WSTTAO_ADDR, WSTTAO_WTAO_POOL, 1); _getData(WTAO_ADDR, WSTTAO_ADDR, WSTTAO_WTAO_POOL, 1, ALICE);
uint256 amountOut = curveExecutorExposed.swap(amountIn, data); uint256 amountOut = curveExecutorExposed.swap(amountIn, data);
assertEq(amountOut, 32797923610); assertEq(amountOut, 32797923610);
assertEq( assertEq(IERC20(WSTTAO_ADDR).balanceOf(ALICE), amountOut);
IERC20(WSTTAO_ADDR).balanceOf(address(curveExecutorExposed)),
amountOut
);
} }
function _getData( function _getData(
address tokenIn, address tokenIn,
address tokenOut, address tokenOut,
address pool, address pool,
uint8 poolType uint8 poolType,
address receiver
) internal view returns (bytes memory data) { ) internal view returns (bytes memory data) {
(int128 i, int128 j) = _getIndexes(tokenIn, tokenOut, pool); (int128 i, int128 j) = _getIndexes(tokenIn, tokenOut, pool);
data = abi.encodePacked( data = abi.encodePacked(
@@ -319,7 +295,8 @@ contract CurveExecutorTest is Test, Constants {
uint8(uint256(uint128(i))), uint8(uint256(uint128(i))),
uint8(uint256(uint128(j))), uint8(uint256(uint128(j))),
true, true,
TokenTransfer.TransferType.NONE TokenTransfer.TransferType.NONE,
receiver
); );
} }

7
src/encoding/evm/swap_encoder/swap_encoders.rs
View File

@@ -548,6 +548,7 @@ impl SwapEncoder for CurveSwapEncoder {
j.to_be_bytes::<1>(), j.to_be_bytes::<1>(),
approval_needed, approval_needed,
(encoding_context.transfer_type as u8).to_be_bytes(), (encoding_context.transfer_type as u8).to_be_bytes(),
bytes_to_address(&encoding_context.receiver)?,
); );
Ok(args.abi_encode_packed()) Ok(args.abi_encode_packed())
@@ -1276,6 +1277,8 @@ mod tests {
"01", "01",
// transfer type // transfer type
"05", "05",
// receiver,
"1d96f2f6bef1202e4ce1ff6dad0c2cb002861d3e"
)) ))
); );
} }
@@ -1344,6 +1347,8 @@ mod tests {
"01", "01",
// transfer type // transfer type
"05", "05",
// receiver
"1d96f2f6bef1202e4ce1ff6dad0c2cb002861d3e"
)) ))
); );
} }
@@ -1422,6 +1427,8 @@ mod tests {
"01", "01",
// transfer type // transfer type
"05", "05",
// receiver
"1d96f2f6bef1202e4ce1ff6dad0c2cb002861d3e"
)) ))
); );
} }