Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add swap to price tests #904

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions test/PoolManager.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -808,6 +808,99 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
assertEq(manager.protocolFeesAccrued(currency1), expectedProtocolFee);
}

function test_swap_toLiquidity_fromMinPrice() public {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe worth naming this one withLiquidity and the other one withoutLiquidity?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think toLiquidity is accurate because this test traverses the swap until reaching nonzero liquidity. The relevant limit is the output amount, whereas in the other test the relevant limit is the price.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(can still include withoutLiquidity in the other test name)

PoolKey memory _key = PoolKey(currency0, currency1, 500, 10, IHooks(address(0)));
manager.initialize(_key, TickMath.MIN_SQRT_PRICE);

IPoolManager.ModifyLiquidityParams memory params =
IPoolManager.ModifyLiquidityParams({tickLower: -10, tickUpper: 10, liquidityDelta: 100e18, salt: 0});
modifyLiquidityRouter.modifyLiquidity(_key, params, ZERO_BYTES);

// zeroForOne=false to swap higher
IPoolManager.SwapParams memory swapParams = IPoolManager.SwapParams(false, -1, TickMath.MAX_SQRT_PRICE - 1);
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

(uint160 sqrtPriceX96,,,) = manager.getSlot0(_key.toId());

swapRouter.swap(_key, swapParams, testSettings, ZERO_BYTES);

(sqrtPriceX96,,,) = manager.getSlot0(_key.toId());

// The swap pushes the price to the start of liquidity.
assertEq(sqrtPriceX96, TickMath.getSqrtPriceAtTick(-10));
}

function test_fuzz_swap_toLiquidity(uint160 sqrtPriceX96) public {
PoolKey memory _key = PoolKey(currency0, currency1, 500, 10, IHooks(address(0)));
sqrtPriceX96 = uint160(bound(sqrtPriceX96, TickMath.MIN_SQRT_PRICE, TickMath.MAX_SQRT_PRICE - 1));
vm.assume(sqrtPriceX96 != 0);
manager.initialize(_key, sqrtPriceX96);

int24 tick = TickMath.getTickAtSqrtPrice(sqrtPriceX96);

bool zeroForOne;
uint160 sqrtPriceX96Limit;
int24 tickBoundary;
if (tick <= -10) {
// zeroForOne=false to swap higher
zeroForOne = false;
sqrtPriceX96Limit = TickMath.MAX_SQRT_PRICE - 1;
tickBoundary = -10;
} else if (tick > 10) {
// zeroForOne=true to swap lower
zeroForOne = true;
sqrtPriceX96Limit = TickMath.MIN_SQRT_PRICE + 1;
tickBoundary = 9;
} else {
// the price is between the position, so let's just swap down
zeroForOne = true;
sqrtPriceX96Limit = TickMath.MIN_SQRT_PRICE + 1;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the case that's failing the fuzz test

// the tick will just stay the same, we're only swapping 1 wei
tickBoundary = TickMath.getTickAtSqrtPrice(sqrtPriceX96);
}

// deeeeeep liquidity so that swapping 1 wei doesn't change the price too much if the price is within the tick range
IPoolManager.ModifyLiquidityParams memory params = IPoolManager.ModifyLiquidityParams({
tickLower: -10,
tickUpper: 10,
liquidityDelta: 100000000000e18,
salt: 0
});

modifyLiquidityRouter.modifyLiquidity(_key, params, ZERO_BYTES);

IPoolManager.SwapParams memory swapParams = IPoolManager.SwapParams(zeroForOne, 1, sqrtPriceX96Limit);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The failure happens because the price does move slightly. It's not ideal for the test to fail probabilistically. It fails because the getTickAtSqrtPrice flips from 0 to -1.

I think that case would pass if this amountSpecified was -1, because that amount would become fee and not move the price.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I meant to change to -1 thanks!

PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

swapRouter.swap(_key, swapParams, testSettings, ZERO_BYTES);

int24 _tick;
(sqrtPriceX96, _tick,,) = manager.getSlot0(_key.toId());

// The swap pushes the price to one of the tick boundaries.
assertEq(TickMath.getTickAtSqrtPrice(sqrtPriceX96), tickBoundary);
}

function test_swap_toPrice_fromMaxPrice_withoutLiquidity() public {
PoolKey memory _key = PoolKey(currency0, currency1, 500, 10, IHooks(address(0)));
manager.initialize(_key, TickMath.MAX_SQRT_PRICE - 1);

// zeroForOne=true to swap lower
IPoolManager.SwapParams memory swapParams = IPoolManager.SwapParams(true, -1, SQRT_PRICE_1_4);
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

(uint160 sqrtPriceX96,,,) = manager.getSlot0(_key.toId());
swapRouter.swap(_key, swapParams, testSettings, ZERO_BYTES);

(sqrtPriceX96,,,) = manager.getSlot0(_key.toId());

// The swap pushes the price to the sqrtPriceLimit.
assertEq(SQRT_PRICE_1_4, sqrtPriceX96);
}

function test_donate_failsIfNotInitialized() public {
vm.expectRevert(Pool.PoolNotInitialized.selector);
donateRouter.donate(uninitializedKey, 100, 100, ZERO_BYTES);
Expand Down
Loading