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

Merge pull request #24 from propeller-heads/mp/use-safe-erc20

Browse Source 
Remove IERC20 from ISwapAdapter and use SafeERC20 for IERC20
This commit is contained in:
pistomat
2024-04-13 10:11:46 +00:00
committed by GitHub
parent 6133e950ca dfa731a93d
commit fbc2b004e5
9 changed files with 173 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
evm/src/balancer-v2/BalancerV2SwapAdapter.sol
View File

@@ -1,7 +1,11 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20, ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {
IERC20,
SafeERC20
} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
// Maximum Swap In/Out Ratio - 0.3
// https://balancer.gitbook.io/balancer/core-concepts/protocol/limitations#v2-limits
@@ -9,6 +13,8 @@ uint256 constant RESERVE_LIMIT_FACTOR = 4;
uint256 constant SWAP_DEADLINE_SEC = 1000;
contract BalancerV2SwapAdapter is ISwapAdapter {
using SafeERC20 for IERC20;
IVault immutable vault;
constructor(address payable vault_) {
@@ -27,8 +33,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
/// as a Fraction struct.
function priceSingle(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
uint256 sellAmount
) public returns (Fraction memory calculatedPrice) {
IVault.BatchSwapStep[] memory swapSteps = new IVault.BatchSwapStep[](1);
@@ -40,8 +46,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
userData: ""
});
address[] memory assets = new address[](2);
assets[0] = address(sellToken);
assets[1] = address(buyToken);
assets[0] = sellToken;
assets[1] = buyToken;
IVault.FundManagement memory funds = IVault.FundManagement({
sender: msg.sender,
fromInternalBalance: false,
@@ -63,8 +69,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
function getSellAmount(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
uint256 buyAmount
) public returns (uint256 sellAmount) {
IVault.BatchSwapStep[] memory swapSteps = new IVault.BatchSwapStep[](1);
@@ -76,8 +82,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
userData: ""
});
address[] memory assets = new address[](2);
assets[0] = address(sellToken);
assets[1] = address(buyToken);
assets[0] = sellToken;
assets[1] = buyToken;
IVault.FundManagement memory funds = IVault.FundManagement({
sender: msg.sender,
fromInternalBalance: false,
@@ -96,8 +102,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
function priceBatch(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
uint256[] memory specifiedAmounts
) external returns (Fraction[] memory calculatedPrices) {
for (uint256 i = 0; i < specifiedAmounts.length; i++) {
@@ -106,7 +112,7 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
}
}
function price(bytes32, IERC20, IERC20, uint256[] memory)
function price(bytes32, address, address, uint256[] memory)
external
pure
override
@@ -117,8 +123,8 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
function swap(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
OrderSide side,
uint256 specifiedAmount
) external override returns (Trade memory trade) {
@@ -136,16 +142,18 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
limit = type(uint256).max;
}
sellToken.transferFrom(msg.sender, address(this), sellAmount);
sellToken.approve(address(vault), sellAmount);
IERC20(sellToken).safeTransferFrom(
msg.sender, address(this), sellAmount
);
IERC20(sellToken).safeIncreaseAllowance(address(vault), sellAmount);
uint256 gasBefore = gasleft();
trade.calculatedAmount = vault.swap(
IVault.SingleSwap({
poolId: poolId,
kind: kind,
assetIn: address(sellToken),
assetOut: address(buyToken),
assetIn: sellToken,
assetOut: buyToken,
amount: specifiedAmount,
userData: ""
}),
@@ -162,14 +170,14 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
trade.price = priceSingle(poolId, sellToken, buyToken, specifiedAmount);
}
function getLimits(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
function getLimits(bytes32 poolId, address sellToken, address buyToken)
external
view
override
returns (uint256[] memory limits)
{
limits = new uint256[](2);
(IERC20[] memory tokens, uint256[] memory balances,) =
(address[] memory tokens, uint256[] memory balances,) =
vault.getPoolTokens(poolId);
for (uint256 i = 0; i < tokens.length; i++) {
@@ -182,7 +190,7 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
}
}
function getCapabilities(bytes32, IERC20, IERC20)
function getCapabilities(bytes32, address, address)
external
pure
override
@@ -197,7 +205,7 @@ contract BalancerV2SwapAdapter is ISwapAdapter {
external
view
override
returns (IERC20[] memory tokens)
returns (address[] memory tokens)
{
(tokens,,) = vault.getPoolTokens(poolId);
}
@@ -472,7 +480,7 @@ interface IVault {
external
view
returns (
IERC20[] memory tokens,
address[] memory tokens,
uint256[] memory balances,
uint256 lastChangeBlock
);

79
evm/src/integral/IntegralSwapAdapter.sol
View File

@@ -1,10 +1,13 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20, ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {ERC20} from "openzeppelin-contracts/contracts/token/ERC20/ERC20.sol";
import {SafeERC20} from
"openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import {ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {IERC20Metadata} from
"openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {
IERC20,
SafeERC20
} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
/// @dev Integral submitted deadline of 3600 seconds (1 hour) to Paraswap, but
/// it is not strictly necessary to be this long
@@ -38,24 +41,23 @@ contract IntegralSwapAdapter is ISwapAdapter {
/// values to make sure the return value is the expected from caller.
function price(
bytes32,
IERC20 _sellToken,
IERC20 _buyToken,
address _sellToken,
address _buyToken,
uint256[] memory _specifiedAmounts
) external view override returns (Fraction[] memory _prices) {
_prices = new Fraction[](_specifiedAmounts.length);
Fraction memory price =
getPriceAt(address(_sellToken), address(_buyToken));
Fraction memory uniformPrice = getPriceAt(_sellToken, _buyToken);
for (uint256 i = 0; i < _specifiedAmounts.length; i++) {
_prices[i] = price;
_prices[i] = uniformPrice;
}
}
/// @inheritdoc ISwapAdapter
function swap(
bytes32,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
OrderSide side,
uint256 specifiedAmount
) external override returns (Trade memory trade) {
@@ -72,18 +74,18 @@ contract IntegralSwapAdapter is ISwapAdapter {
trade.calculatedAmount = buy(sellToken, buyToken, specifiedAmount);
}
trade.gasUsed = gasBefore - gasleft();
trade.price = getPriceAt(address(sellToken), address(buyToken));
trade.price = getPriceAt(sellToken, buyToken);
}
/// @inheritdoc ISwapAdapter
function getLimits(bytes32, IERC20 sellToken, IERC20 buyToken)
function getLimits(bytes32, address sellToken, address buyToken)
external
view
override
returns (uint256[] memory limits)
{
(,,, uint256 limitMax0,, uint256 limitMax1) =
relayer.getPoolState(address(sellToken), address(buyToken));
relayer.getPoolState(sellToken, buyToken);
limits = new uint256[](2);
limits[0] = limitMax0;
@@ -98,7 +100,7 @@ contract IntegralSwapAdapter is ISwapAdapter {
}
/// @inheritdoc ISwapAdapter
function getCapabilities(bytes32, IERC20, IERC20)
function getCapabilities(bytes32, address, address)
external
pure
override
@@ -116,12 +118,12 @@ contract IntegralSwapAdapter is ISwapAdapter {
external
view
override
returns (IERC20[] memory tokens)
returns (address[] memory tokens)
{
tokens = new IERC20[](2);
tokens = new address[](2);
ITwapPair pair = ITwapPair(address(bytes20(poolId)));
tokens[0] = IERC20(pair.token0());
tokens[1] = IERC20(pair.token1());
tokens[0] = pair.token0();
tokens[1] = pair.token1();
}
/// @inheritdoc ISwapAdapter
@@ -147,23 +149,22 @@ contract IntegralSwapAdapter is ISwapAdapter {
/// @param buyToken The address of the token being bought.
/// @param amount The amount to be traded.
/// @return uint256 The amount of tokens received.
function sell(IERC20 sellToken, IERC20 buyToken, uint256 amount)
function sell(address sellToken, address buyToken, uint256 amount)
internal
returns (uint256)
{
uint256 amountOut =
relayer.quoteSell(address(sellToken), address(buyToken), amount);
uint256 amountOut = relayer.quoteSell(sellToken, buyToken, amount);
if (amountOut == 0) {
revert Unavailable("AmountOut is zero!");
}
sellToken.safeTransferFrom(msg.sender, address(this), amount);
sellToken.safeIncreaseAllowance(address(relayer), amount);
IERC20(sellToken).safeTransferFrom(msg.sender, address(this), amount);
IERC20(sellToken).safeIncreaseAllowance(address(relayer), amount);
relayer.sell(
ITwapRelayer.SellParams({
tokenIn: address(sellToken),
tokenOut: address(buyToken),
tokenIn: sellToken,
tokenOut: buyToken,
wrapUnwrap: false,
to: msg.sender,
submitDeadline: uint32(block.timestamp + SWAP_DEADLINE_SEC),
@@ -180,24 +181,22 @@ contract IntegralSwapAdapter is ISwapAdapter {
/// @param buyToken The address of the token being bought.
/// @param amountBought The amount of buyToken tokens to buy.
/// @return uint256 The amount of tokens received.
function buy(IERC20 sellToken, IERC20 buyToken, uint256 amountBought)
function buy(address sellToken, address buyToken, uint256 amountBought)
internal
returns (uint256)
{
uint256 amountIn = relayer.quoteBuy(
address(sellToken), address(buyToken), amountBought
);
uint256 amountIn = relayer.quoteBuy(sellToken, buyToken, amountBought);
if (amountIn == 0) {
revert Unavailable("AmountIn is zero!");
}
sellToken.safeTransferFrom(msg.sender, address(this), amountIn);
sellToken.safeIncreaseAllowance(address(relayer), amountIn);
IERC20(sellToken).safeTransferFrom(msg.sender, address(this), amountIn);
IERC20(sellToken).safeIncreaseAllowance(address(relayer), amountIn);
relayer.buy(
ITwapRelayer.BuyParams({
tokenIn: address(sellToken),
tokenOut: address(buyToken),
tokenIn: sellToken,
tokenOut: buyToken,
wrapUnwrap: false,
to: msg.sender,
submitDeadline: uint32(block.timestamp + SWAP_DEADLINE_SEC),
@@ -217,20 +216,18 @@ contract IntegralSwapAdapter is ISwapAdapter {
view
returns (Fraction memory)
{
uint256 priceWithoutFee = relayer.getPriceByTokenAddresses(
address(sellToken), address(buyToken)
);
uint256 priceWithoutFee =
relayer.getPriceByTokenAddresses(sellToken, buyToken);
ITwapFactory factory = ITwapFactory(relayer.factory());
address pairAddress =
factory.getPair(address(sellToken), address(buyToken));
address pairAddress = factory.getPair(sellToken, buyToken);
// get swapFee formatted; swapFee is a constant
uint256 swapFeeFormatted =
(STANDARD_TOKEN_DECIMALS - relayer.swapFee(pairAddress));
// get token decimals
uint256 sellTokenDecimals = 10 ** ERC20(sellToken).decimals();
uint256 buyTokenDecimals = 10 ** ERC20(buyToken).decimals();
uint256 sellTokenDecimals = 10 ** IERC20Metadata(sellToken).decimals();
uint256 buyTokenDecimals = 10 ** IERC20Metadata(buyToken).decimals();
/**
* @dev

23
evm/src/interfaces/ISwapAdapter.sol
View File

@@ -1,7 +1,6 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20} from "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
import {ISwapAdapterTypes} from "src/interfaces/ISwapAdapterTypes.sol";
/// @title ISwapAdapter
@@ -35,8 +34,8 @@ interface ISwapAdapter is ISwapAdapterTypes {
/// provided amounts.
function price(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
uint256[] memory specifiedAmounts
) external view returns (Fraction[] memory prices);
@@ -59,8 +58,8 @@ interface ISwapAdapter is ISwapAdapterTypes {
*/
function swap(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
OrderSide side,
uint256 specifiedAmount
) external returns (Trade memory trade);
@@ -76,25 +75,27 @@ interface ISwapAdapter is ISwapAdapterTypes {
/// @param sellToken The token being sold.
/// @param buyToken The token being bought.
/// @return limits An array of limits.
function getLimits(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
function getLimits(bytes32 poolId, address sellToken, address buyToken)
external
returns (uint256[] memory limits);
/// @notice Retrieves the capabilities of the selected pool.
/// @param poolId The ID of the trading pool.
/// @return capabilities An array of Capability.
function getCapabilities(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
external
returns (Capability[] memory capabilities);
function getCapabilities(
bytes32 poolId,
address sellToken,
address buyToken
) external returns (Capability[] memory capabilities);
/// @notice Retrieves the tokens in the selected pool.
/// @dev Mainly used for testing as this is redundant with the required
/// substreams implementation.
/// @param poolId The ID of the trading pool.
/// @return tokens An array of IERC20 contracts.
/// @return tokens An array of address contracts.
function getTokens(bytes32 poolId)
external
returns (IERC20[] memory tokens);
returns (address[] memory tokens);
/// @notice Retrieves a range of pool IDs.
/// @dev Mainly used for testing. It is alright to not return all available

2
evm/src/interfaces/ISwapAdapterTypes.sol
View File

@@ -1,8 +1,6 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20} from "openzeppelin-contracts/contracts/interfaces/IERC20.sol";
interface ISwapAdapterTypes {
/// @dev The OrderSide enum represents possible sides of a trade: Sell or
/// Buy. E.g. if OrderSide is Sell, the sell amount is interpreted to be

23
evm/src/template/TemplateSwapAdapter.sol
View File

@@ -1,7 +1,7 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20, ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
/// @title TemplateSwapAdapter
/// @dev This is a template for a swap adapter.
@@ -10,8 +10,8 @@ import {IERC20, ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
contract TemplateSwapAdapter is ISwapAdapter {
function price(
bytes32 _poolId,
IERC20 _sellToken,
IERC20 _buyToken,
address _sellToken,
address _buyToken,
uint256[] memory _specifiedAmounts
) external view override returns (Fraction[] memory _prices) {
revert NotImplemented("TemplateSwapAdapter.price");
@@ -19,31 +19,32 @@ contract TemplateSwapAdapter is ISwapAdapter {
function swap(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
OrderSide side,
uint256 specifiedAmount
) external returns (Trade memory trade) {
revert NotImplemented("TemplateSwapAdapter.swap");
}
function getLimits(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
function getLimits(bytes32 poolId, address sellToken, address buyToken)
external
returns (uint256[] memory limits)
{
revert NotImplemented("TemplateSwapAdapter.getLimits");
}
function getCapabilities(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
external
returns (Capability[] memory capabilities)
{
function getCapabilities(
bytes32 poolId,
address sellToken,
address buyToken
) external returns (Capability[] memory capabilities) {
revert NotImplemented("TemplateSwapAdapter.getCapabilities");
}
function getTokens(bytes32 poolId)
external
returns (IERC20[] memory tokens)
returns (address[] memory tokens)
{
revert NotImplemented("TemplateSwapAdapter.getTokens");
}

39
evm/src/uniswap-v2/UniswapV2SwapAdapter.sol
View File

@@ -1,12 +1,18 @@
// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity ^0.8.13;
import {IERC20, ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {ISwapAdapter} from "src/interfaces/ISwapAdapter.sol";
import {
IERC20,
SafeERC20
} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
// Uniswap handles arbirary amounts, but we limit the amount to 10x just in case
uint256 constant RESERVE_LIMIT_FACTOR = 10;
contract UniswapV2SwapAdapter is ISwapAdapter {
using SafeERC20 for IERC20;
IUniswapV2Factory immutable factory;
constructor(address factory_) {
@@ -16,8 +22,8 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
/// @inheritdoc ISwapAdapter
function price(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
uint256[] memory specifiedAmounts
) external view override returns (Fraction[] memory prices) {
prices = new Fraction[](specifiedAmounts.length);
@@ -60,8 +66,8 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
/// @inheritdoc ISwapAdapter
function swap(
bytes32 poolId,
IERC20 sellToken,
IERC20 buyToken,
address sellToken,
address buyToken,
OrderSide side,
uint256 specifiedAmount
) external override returns (Trade memory trade) {
@@ -104,7 +110,7 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
/// @return calculatedAmount The amount of tokens received.
function sell(
IUniswapV2Pair pair,
IERC20 sellToken,
address sellToken,
bool zero2one,
uint112 reserveIn,
uint112 reserveOut,
@@ -113,8 +119,7 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
address swapper = msg.sender;
uint256 amountOut = getAmountOut(amount, reserveIn, reserveOut);
// TODO: use safeTransferFrom
sellToken.transferFrom(swapper, address(pair), amount);
IERC20(sellToken).safeTransferFrom(swapper, address(pair), amount);
if (zero2one) {
pair.swap(0, amountOut, swapper, "");
} else {
@@ -156,7 +161,7 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
/// @return calculatedAmount The amount of tokens sold.
function buy(
IUniswapV2Pair pair,
IERC20 sellToken,
address sellToken,
bool zero2one,
uint112 reserveIn,
uint112 reserveOut,
@@ -168,8 +173,8 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
if (amount == 0) {
return 0;
}
// TODO: use safeTransferFrom
sellToken.transferFrom(swapper, address(pair), amount);
IERC20(sellToken).safeTransferFrom(swapper, address(pair), amount);
if (zero2one) {
pair.swap(0, amountOut, swapper, "");
} else {
@@ -203,7 +208,7 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
}
/// @inheritdoc ISwapAdapter
function getLimits(bytes32 poolId, IERC20 sellToken, IERC20 buyToken)
function getLimits(bytes32 poolId, address sellToken, address buyToken)
external
view
override
@@ -222,7 +227,7 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
}
/// @inheritdoc ISwapAdapter
function getCapabilities(bytes32, IERC20, IERC20)
function getCapabilities(bytes32, address, address)
external
pure
override
@@ -239,12 +244,12 @@ contract UniswapV2SwapAdapter is ISwapAdapter {
external
view
override
returns (IERC20[] memory tokens)
returns (address[] memory tokens)
{
tokens = new IERC20[](2);
tokens = new address[](2);
IUniswapV2Pair pair = IUniswapV2Pair(address(bytes20(poolId)));
tokens[0] = IERC20(pair.token0());
tokens[1] = IERC20(pair.token1());
tokens[0] = address(pair.token0());
tokens[1] = address(pair.token1());
}
/// @inheritdoc ISwapAdapter