Work on integration with python counterpart
This commit is contained in:
@@ -15,7 +15,7 @@ import "interfaces/IPairFunctionsTypes.sol";
|
|||||||
/// @dev Last but not least, the price function is the derivative of the swap
|
/// @dev Last but not least, the price function is the derivative of the swap
|
||||||
/// @dev function. It represents the best possible price a user can get from a
|
/// @dev function. It represents the best possible price a user can get from a
|
||||||
/// @dev pair after swapping x of the specified token.
|
/// @dev pair after swapping x of the specified token.
|
||||||
/// @dev During calls to price, swap and getLimits, the caller can be assumed to
|
/// @dev During calls to swap and getLimits, the caller can be assumed to
|
||||||
/// @dev have the required sell or buy token balance as well as unlimited approvals
|
/// @dev have the required sell or buy token balance as well as unlimited approvals
|
||||||
/// @dev to this contract.
|
/// @dev to this contract.
|
||||||
interface IPairFunctions is IPairFunctionTypes {
|
interface IPairFunctions is IPairFunctionTypes {
|
||||||
@@ -46,7 +46,11 @@ interface IPairFunctions is IPairFunctionTypes {
|
|||||||
/// @dev the swap and change the state of the evm accordingly.
|
/// @dev the swap and change the state of the evm accordingly.
|
||||||
/// @dev Please include a gas usage estimate for each amount. This can be achieved
|
/// @dev Please include a gas usage estimate for each amount. This can be achieved
|
||||||
/// @dev e.g. by using the `gasleft()` function.
|
/// @dev e.g. by using the `gasleft()` function.
|
||||||
/// @dev
|
/// @dev The return type trade, has a price attribute which should contain the
|
||||||
|
/// value of `price(specifiedAmount)`. As this is optional, defined via
|
||||||
|
/// `Capability.PriceFunction`, it is valid to return a zero value for this
|
||||||
|
/// price in that case it will be estimated numerically. To return zero use
|
||||||
|
/// Fraction(0, 1).
|
||||||
/// @param pairId The ID of the trading pair.
|
/// @param pairId The ID of the trading pair.
|
||||||
/// @param sellToken The token being sold.
|
/// @param sellToken The token being sold.
|
||||||
/// @param buyToken The token being bought.
|
/// @param buyToken The token being bought.
|
||||||
@@ -79,10 +83,6 @@ interface IPairFunctions is IPairFunctionTypes {
|
|||||||
external
|
external
|
||||||
returns (Capabilities[] memory);
|
returns (Capabilities[] memory);
|
||||||
|
|
||||||
/// @notice Minimum gas usage of exchange logic excluding transfers.
|
|
||||||
/// @return gasUsage the amount of gas used by the exchange logic
|
|
||||||
function minGasUsage() external view returns (uint256);
|
|
||||||
|
|
||||||
/// @notice Retrieves the tokens in the selected pair.
|
/// @notice Retrieves the tokens in the selected pair.
|
||||||
/// @dev Mainly used for testing as this is redundant with the required substreams
|
/// @dev Mainly used for testing as this is redundant with the required substreams
|
||||||
/// @dev implementation.
|
/// @dev implementation.
|
||||||
|
|||||||
@@ -12,9 +12,9 @@ interface IPairFunctionTypes {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// @dev The Capabilities enum represents possible features of a trading pair.
|
/// @dev The Capabilities enum represents possible features of a trading pair.
|
||||||
enum Capabilities
|
enum Capabilities {
|
||||||
// Support SwapSide.Sell values (required)
|
Unset,
|
||||||
{
|
// Support SwapSide.Sell values (required)
|
||||||
SellSide,
|
SellSide,
|
||||||
// Support SwapSide.Buy values (optional)
|
// Support SwapSide.Buy values (optional)
|
||||||
BuySide,
|
BuySide,
|
||||||
|
|||||||
@@ -36,9 +36,6 @@ contract UniswapV2PairFunctions is IPairFunctions {
|
|||||||
pure
|
pure
|
||||||
returns (Fraction memory)
|
returns (Fraction memory)
|
||||||
{
|
{
|
||||||
if (amountIn == 0) {
|
|
||||||
return Fraction(0, 0);
|
|
||||||
}
|
|
||||||
if (reserveIn == 0 || reserveOut == 0) {
|
if (reserveIn == 0 || reserveOut == 0) {
|
||||||
revert Unavailable("At least one reserve is zero!");
|
revert Unavailable("At least one reserve is zero!");
|
||||||
}
|
}
|
||||||
@@ -186,7 +183,7 @@ contract UniswapV2PairFunctions is IPairFunctions {
|
|||||||
override
|
override
|
||||||
returns (Capabilities[] memory capabilities)
|
returns (Capabilities[] memory capabilities)
|
||||||
{
|
{
|
||||||
capabilities = new Capabilities[](10);
|
capabilities = new Capabilities[](3);
|
||||||
capabilities[0] = Capabilities.SellSide;
|
capabilities[0] = Capabilities.SellSide;
|
||||||
capabilities[1] = Capabilities.BuySide;
|
capabilities[1] = Capabilities.BuySide;
|
||||||
capabilities[2] = Capabilities.PriceFunction;
|
capabilities[2] = Capabilities.PriceFunction;
|
||||||
@@ -219,10 +216,6 @@ contract UniswapV2PairFunctions is IPairFunctions {
|
|||||||
ids[i] = bytes20(factory.allPairs(offset + i));
|
ids[i] = bytes20(factory.allPairs(offset + i));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function minGasUsage() external view returns (uint256) {
|
|
||||||
return 30000;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
interface IUniswapV2Pair {
|
interface IUniswapV2Pair {
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
|
|||||||
UniswapV2PairFunctions(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
|
UniswapV2PairFunctions(0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f);
|
||||||
}
|
}
|
||||||
|
|
||||||
function testPriceFuzz(uint256 amount0, uint256 amount1) public view {
|
function testPriceFuzz(uint256 amount0, uint256 amount1) public {
|
||||||
bytes32 pair = bytes32(bytes20(USDC_WETH_PAIR));
|
bytes32 pair = bytes32(bytes20(USDC_WETH_PAIR));
|
||||||
uint256[] memory limits = pairFunctions.getLimits(pair, SwapSide.Sell);
|
uint256[] memory limits = pairFunctions.getLimits(pair, SwapSide.Sell);
|
||||||
vm.assume(amount0 < limits[0]);
|
vm.assume(amount0 < limits[0]);
|
||||||
@@ -29,7 +29,13 @@ contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
|
|||||||
amounts[0] = amount0;
|
amounts[0] = amount0;
|
||||||
amounts[1] = amount1;
|
amounts[1] = amount1;
|
||||||
|
|
||||||
pairFunctions.price(pair, WETH, USDC, amounts);
|
Fraction[] memory prices =
|
||||||
|
pairFunctions.price(pair, WETH, USDC, amounts);
|
||||||
|
|
||||||
|
for (uint256 i = 0; i < prices.length; i++) {
|
||||||
|
assertGt(prices[i].nominator, 0);
|
||||||
|
assertGt(prices[i].denominator, 0);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function testPriceDecreasing() public {
|
function testPriceDecreasing() public {
|
||||||
@@ -43,8 +49,10 @@ contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
|
|||||||
Fraction[] memory prices =
|
Fraction[] memory prices =
|
||||||
pairFunctions.price(pair, WETH, USDC, amounts);
|
pairFunctions.price(pair, WETH, USDC, amounts);
|
||||||
|
|
||||||
for (uint256 i = 1; i < 99; i++) {
|
for (uint256 i = 0; i < 99; i++) {
|
||||||
assertEq(compareFractions(prices[i], prices[i + 1]), 1);
|
assertEq(compareFractions(prices[i], prices[i + 1]), 1);
|
||||||
|
assertGt(prices[i].denominator, 0);
|
||||||
|
assertGt(prices[i + 1].denominator, 0);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -109,4 +117,16 @@ contract UniswapV2PairFunctionTest is Test, IPairFunctionTypes {
|
|||||||
function testSwapBuyIncreasing() public {
|
function testSwapBuyIncreasing() public {
|
||||||
executeIncreasingSwaps(SwapSide.Buy);
|
executeIncreasingSwaps(SwapSide.Buy);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function testGetCapabilities(bytes32 pair, address t0, address t1) public {
|
||||||
|
Capabilities[] memory res =
|
||||||
|
pairFunctions.getCapabilities(pair, IERC20(t0), IERC20(t1));
|
||||||
|
|
||||||
|
assertEq(res.length, 3);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testGetLimits() public {
|
||||||
|
bytes32 pair = bytes32(bytes20(USDC_WETH_PAIR));
|
||||||
|
pairFunctions.getLimits(pair, SwapSide.Sell);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user