Skip to content

Commit

Permalink
tests: Make and use a common SWAP_PARAMS in Deployers.sol
Browse files Browse the repository at this point in the history 
Resolves Issue Uniswap#390
  • Loading branch information
@prosperring
prosperring committed May 20, 2024
1 parent 2df9bb3 commit 6580bad
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 91 deletions.
24 changes: 6 additions & 18 deletions test/DynamicFees.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,29 +113,25 @@ contract TestDynamicFees is Test, Deployers, GasSnapshot {

dynamicFeesHooks.setFee(1000001);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectRevert(LPFeeLibrary.FeeTooLarge.selector);
swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
}

function test_updateDynamicLPFee_beforeSwap_succeeds_gas() public {
assertEq(_fetchPoolLPFee(key), 0);

dynamicFeesHooks.setFee(123);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 98, 79228162514264329749955861424, 1e18, -1, 123);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
snapLastCall("update dynamic fee in before swap");

assertEq(_fetchPoolLPFee(key), 123);
Expand All @@ -146,15 +142,13 @@ contract TestDynamicFees is Test, Deployers, GasSnapshot {

dynamicFeesHooks.setFee(1000000);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 0, SQRT_PRICE_1_1, 1e18, -1, 1000000);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

assertEq(_fetchPoolLPFee(key), 1000000);
}
Expand All @@ -164,15 +158,13 @@ contract TestDynamicFees is Test, Deployers, GasSnapshot {

dynamicFeesHooks.setFee(500000);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 49, 79228162514264333632135824623, 1e18, -1, 500000);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

assertEq(_fetchPoolLPFee(key), 500000);
}
Expand Down Expand Up @@ -264,15 +256,13 @@ contract TestDynamicFees is Test, Deployers, GasSnapshot {
vm.prank(address(feeController));
manager.setProtocolFee(key, 1000);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 98, 79228162514264329749955861424, 1e18, -1, 1122);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

assertEq(_fetchPoolLPFee(key), 123);
}
Expand Down Expand Up @@ -316,15 +306,13 @@ contract TestDynamicFees is Test, Deployers, GasSnapshot {
dynamicFeesNoHooks.forcePoolFeeUpdate(key, 123);
assertEq(_fetchPoolLPFee(key), 123);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 98, 79228162514264329749955861424, 1e18, -1, 123);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
snapLastCall("swap with dynamic fee");
}

Expand Down
4 changes: 1 addition & 3 deletions test/DynamicReturnFees.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,13 @@ contract TestDynamicReturnFees is Test, Deployers, GasSnapshot {

dynamicReturnFeesHook.setFee(123);

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});
PoolSwapTest.TestSettings memory testSettings =
PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

vm.expectEmit(true, true, true, true, address(manager));
emit Swap(key.toId(), address(swapRouter), -100, 98, 79228162514264329749955861424, 1e18, -1, 123);

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
snapLastCall("swap with return dynamic fee");

assertEq(_fetchPoolSwapFee(key), 0);
Expand Down
80 changes: 22 additions & 58 deletions test/PoolManager.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -547,9 +547,6 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
}

function test_swap_succeedsIfInitialized() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

Expand All @@ -558,21 +555,15 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
key.toId(), address(swapRouter), int128(-100), int128(98), 79228162514264329749955861424, 1e18, -1, 3000
);

swapRouter.swap(key, swapParams, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
}

function test_swap_failsIfLocked() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

vm.expectRevert(IPoolManager.ManagerLocked.selector);
manager.swap(key, swapParams, ZERO_BYTES);
manager.swap(key, SWAP_PARAMS, ZERO_BYTES);
}

function test_swap_succeedsWithNativeTokensIfInitialized() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

Expand All @@ -588,7 +579,7 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
3000
);

swapRouter.swap{value: 100}(nativeKey, swapParams, testSettings, ZERO_BYTES);
swapRouter.swap{value: 100}(nativeKey, SWAP_PARAMS, testSettings, ZERO_BYTES);
}

function test_swap_succeedsWithHooksIfInitialized() public {
Expand All @@ -603,19 +594,16 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {

(key,) = initPoolAndAddLiquidity(currency0, currency1, IHooks(mockAddr), 3000, SQRT_PRICE_1_1, ZERO_BYTES);

IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

BalanceDelta balanceDelta = swapRouter.swap(key, swapParams, testSettings, ZERO_BYTES);
BalanceDelta balanceDelta = swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

bytes32 beforeSelector = MockHooks.beforeSwap.selector;
bytes memory beforeParams = abi.encode(address(swapRouter), key, swapParams, ZERO_BYTES);
bytes memory beforeParams = abi.encode(address(swapRouter), key, SWAP_PARAMS, ZERO_BYTES);

bytes32 afterSelector = MockHooks.afterSwap.selector;
bytes memory afterParams = abi.encode(address(swapRouter), key, swapParams, balanceDelta, ZERO_BYTES);
bytes memory afterParams = abi.encode(address(swapRouter), key, SWAP_PARAMS, balanceDelta, ZERO_BYTES);

assertEq(MockContract(mockAddr).timesCalledSelector(beforeSelector), 1);
assertTrue(MockContract(mockAddr).calledWithSelector(beforeSelector, beforeParams));
Expand Down Expand Up @@ -676,38 +664,26 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
}

function test_swap_succeeds() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

swapRouter.swap(key, swapParams, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
}

function test_swap_gas() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

swapRouterNoChecks.swap(key, swapParams);
swapRouterNoChecks.swap(key, SWAP_PARAMS);
snapLastCall("simple swap");
}

function test_swap_withNative_succeeds() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

swapRouter.swap{value: 100}(nativeKey, swapParams, testSettings, ZERO_BYTES);
swapRouter.swap{value: 100}(nativeKey, SWAP_PARAMS, testSettings, ZERO_BYTES);
}

function test_swap_withNative_gas() public {
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

swapRouterNoChecks.swap{value: 100}(nativeKey, swapParams);
swapRouterNoChecks.swap{value: 100}(nativeKey, SWAP_PARAMS);
snapLastCall("simple swap with native");
}

Expand All @@ -720,15 +696,12 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {

(key,) = initPoolAndAddLiquidity(currency0, currency1, mockHooks, 3000, SQRT_PRICE_1_1, ZERO_BYTES);

IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

swapRouter.swap(key, swapParams, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

swapParams =
IPoolManager.SwapParams memory swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_4});
testSettings = PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: false});

Expand All @@ -737,15 +710,12 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
}

function test_swap_mint6909IfOutputNotTaken_gas() public {
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

vm.expectEmit();
emit Transfer(address(swapRouter), address(0), address(this), CurrencyLibrary.toId(currency1), 98);
swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);
snapLastCall("swap mint output as 6909");

uint256 erc6909Balance = manager.balanceOf(address(this), CurrencyLibrary.toId(currency1));
Expand All @@ -769,15 +739,12 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
}

function test_swap_burn6909AsInput_gas() public {
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

vm.expectEmit();
emit Transfer(address(swapRouter), address(0), address(this), CurrencyLibrary.toId(currency1), 98);
swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

uint256 erc6909Balance = manager.balanceOf(address(this), uint256(uint160(Currency.unwrap(currency1))));
assertEq(erc6909Balance, 98);
Expand All @@ -786,7 +753,8 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
manager.setOperator(address(swapRouter), true);

// swap from currency1 to currency0 again, using 6909s as input tokens
params = IPoolManager.SwapParams({zeroForOne: false, amountSpecified: 25, sqrtPriceLimitX96: SQRT_PRICE_4_1});
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: false, amountSpecified: 25, sqrtPriceLimitX96: SQRT_PRICE_4_1});
testSettings = PoolSwapTest.TestSettings({takeClaims: false, settleUsingBurn: true});

vm.expectEmit();
Expand Down Expand Up @@ -830,30 +798,26 @@ contract PoolManagerTest is Test, Deployers, GasSnapshot {
}

function test_swap_againstLiquidity_gas() public {
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
swapRouter.swap(key, SWAP_PARAMS, testSettings, ZERO_BYTES);

params = IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_4});
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_4});

swapRouter.swap(key, params, testSettings, ZERO_BYTES);
snapLastCall("swap against liquidity");
}

function test_swap_againstLiqWithNative_gas() public {
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

swapRouter.swap{value: 1 ether}(nativeKey, params, testSettings, ZERO_BYTES);
swapRouter.swap{value: 1 ether}(nativeKey, SWAP_PARAMS, testSettings, ZERO_BYTES);

params = IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_4});
IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_4});

swapRouter.swap{value: 1 ether}(nativeKey, params, testSettings, ZERO_BYTES);
snapLastCall("swap against liquidity with native token");
Expand Down
13 changes: 5 additions & 8 deletions test/SkipCallsTestHook.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@ import {SkipCallsTestHook} from "../src/test/SkipCallsTestHook.sol";
contract SkipCallsTest is Test, Deployers, GasSnapshot {
using PoolIdLibrary for PoolKey;

IPoolManager.SwapParams swapParams =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

function deploy(SkipCallsTestHook skipCallsTestHook) private {
Expand Down Expand Up @@ -144,10 +141,10 @@ contract SkipCallsTest is Test, Deployers, GasSnapshot {
assertEq(skipCallsTestHook.counter(), 0);

// swaps and increments counter
swapRouter.swap(key, swapParams, testSettings, abi.encode(address(this)));
swapRouter.swap(key, SWAP_PARAMS, testSettings, abi.encode(address(this)));
assertEq(skipCallsTestHook.counter(), 1);
// swaps again and increments counter
swapRouter.swap(key, swapParams, testSettings, abi.encode(address(this)));
swapRouter.swap(key, SWAP_PARAMS, testSettings, abi.encode(address(this)));
assertEq(skipCallsTestHook.counter(), 2);
}

Expand All @@ -161,7 +158,7 @@ contract SkipCallsTest is Test, Deployers, GasSnapshot {
assertEq(skipCallsTestHook.counter(), 0);

// swaps and increments counter
swapRouter.swap(key, swapParams, testSettings, abi.encode(address(this)));
swapRouter.swap(key, SWAP_PARAMS, testSettings, abi.encode(address(this)));
snapLastCall("swap skips hook call if hook is caller");
assertEq(skipCallsTestHook.counter(), 1);
}
Expand All @@ -176,10 +173,10 @@ contract SkipCallsTest is Test, Deployers, GasSnapshot {
assertEq(skipCallsTestHook.counter(), 0);

// swaps and increments counter
swapRouter.swap(key, swapParams, testSettings, abi.encode(address(this)));
swapRouter.swap(key, SWAP_PARAMS, testSettings, abi.encode(address(this)));
assertEq(skipCallsTestHook.counter(), 1);
// swaps again and increments counter
swapRouter.swap(key, swapParams, testSettings, abi.encode(address(this)));
swapRouter.swap(key, SWAP_PARAMS, testSettings, abi.encode(address(this)));
assertEq(skipCallsTestHook.counter(), 2);
}

Expand Down
5 changes: 1 addition & 4 deletions test/Sync.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,13 @@ contract SyncTest is Test, Deployers, GasSnapshot {
function test_settle_withStartingBalance() public noIsolate {
assertGt(currency0.balanceOf(address(manager)), uint256(0));

IPoolManager.SwapParams memory params =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

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

// Sync has not been called.
assertEq(manager.getReserves(currency0), 0);

swapRouter.swap(key, params, testSettings, new bytes(0));
swapRouter.swap(key, SWAP_PARAMS, testSettings, new bytes(0));
(uint256 balanceCurrency0) = currency0.balanceOf(address(manager));
assertEq(manager.getReserves(currency0), balanceCurrency0); // Reserves are up to date since settle was called.
}
Expand Down
2 changes: 2 additions & 0 deletions test/utils/Deployers.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ contract Deployers {
IPoolManager.ModifyLiquidityParams({tickLower: -120, tickUpper: 120, liquidityDelta: 1e18, salt: 0});
IPoolManager.ModifyLiquidityParams public REMOVE_LIQUIDITY_PARAMS =
IPoolManager.ModifyLiquidityParams({tickLower: -120, tickUpper: 120, liquidityDelta: -1e18, salt: 0});
IPoolManager.SwapParams public SWAP_PARAMS =
IPoolManager.SwapParams({zeroForOne: true, amountSpecified: -100, sqrtPriceLimitX96: SQRT_PRICE_1_2});

// Global variables
Currency internal currency0;
Expand Down

0 comments on commit 6580bad

Please sign in to comment.