Merge branch 'main' into optimization/BalanceDelta

pancakeswap · May 30, 2024 · 4dd78da · 4dd78da
2 parents 615c996 + 2099560
commit 4dd78da
Show file tree

Hide file tree

Showing 64 changed files with 156 additions and 82 deletions.
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-181588
+180685
diff --git a/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap
@@ -1 +1 @@
-185653
+184784
diff --git a/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap
@@ -1 +1 @@
-137576
+137347
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-331429
+331202
diff --git a/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap
@@ -1 +1 @@
-193689
+192796
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-138220
+136931
diff --git a/.forge-snapshots/BinPoolManagerTest#testFuzzUpdateDynamicLPFee.snap b/.forge-snapshots/BinPoolManagerTest#testFuzzUpdateDynamicLPFee.snap
@@ -1 +1 @@
-32575
+32533
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-148243
+146635
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-296172
+294227
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-131429
+130141
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-120460
+119261
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-977463
+975902
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-339653
+338092
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-343130
+341673
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-146073
+144616
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-180414
+179041
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-186397
+185024
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-138837
+137479
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-309646
+308185
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-362836
+360013
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-178004
+175181
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-248032
+245159
diff --git a/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap b/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap
@@ -1 +1 @@
-170799
+168435
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-114635
+112267
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-124115
+121284
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-141394
+138632
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-174910
+172143
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-161272
+158546
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-79336
+76575
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-153550
+150789
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-96143
+93467
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-79339
+76578
diff --git a/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap b/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap
@@ -1 +1 @@
-32291
+32316
diff --git a/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap b/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap
@@ -1 +1 @@
-11374
+11394
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap
@@ -1 +1 @@
-525
+520
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap
@@ -1 +1 @@
-653
+648
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap
@@ -1 +1 @@
-2239
+2234
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap
@@ -1 +1 @@
-3029
+3019
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap
@@ -1 +1 @@
-1981
+1976
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap
@@ -1 +1 @@
-3029
+3019
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap
@@ -1 +1 @@
-2229
+2224
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap
@@ -1 +1 @@
-3182
+3177
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap
@@ -1 +1 @@
-1971
+1966
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap
@@ -1 +1 @@
-3182
+3177
diff --git a/.forge-snapshots/TickTest#tickSpacingToMaxLiquidityPerTick.snap b/.forge-snapshots/TickTest#tickSpacingToMaxLiquidityPerTick.snap
@@ -1 +1 @@
-1151
+1159
diff --git a/.forge-snapshots/TickTest#update.snap b/.forge-snapshots/TickTest#update.snap
@@ -1 +1 @@
-134819
+134827
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap b/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap
@@ -1 +1 @@
-81647
+81469
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap b/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap
@@ -1 +1 @@
-121653
+121465
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap
@@ -1 +1 @@
-45235
+45057
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap
@@ -1 +1 @@
-45234
+45056
diff --git a/.forge-snapshots/VaultTest#testLock_NoOp.snap b/.forge-snapshots/VaultTest#testLock_NoOp.snap
@@ -1 +1 @@
-33260
+33072
diff --git a/foundry.toml b/foundry.toml
@@ -1,14 +1,14 @@
 [profile.default]
 src = 'src'
 out = 'foundry-out'
-solc_version = '0.8.24'
+solc_version = '0.8.26'
 optimizer_runs = 800
 via_ir = false
 ffi = true
 fs_permissions = [
     { access = "read-write", path = ".forge-snapshots/" },
     { access = "read", path = "./foundry-out" },
-    { access = "read", path = "./script/config"},
+    { access = "read", path = "./script/config" },
 ]
 evm_version = 'cancun'
 
@@ -21,7 +21,7 @@ runs = 1000
 runs = 10000
 
 [profile.ci.invariant]
-runs = 1000           # The number of calls to make in the invariant tests
+runs = 1000            # The number of calls to make in the invariant tests
 call_override = false  # Override calls
 fail_on_revert = false # Fail the test if the contract reverts
 

diff --git a/src/libraries/LPFeeLibrary.sol b/src/libraries/LPFeeLibrary.sol
@@ -13,10 +13,9 @@ library LPFeeLibrary {
     error FeeTooLarge();
 
     /// @dev the flag and mask
-    uint24 public constant FEE_MASK = 0x7FFFFF;
     uint24 public constant OVERRIDE_MASK = 0xBFFFFF;
 
-    // the top bit of the fee in a PoolKey is used to signal if a Pool's LP fee is dynamic
+    // a dynamic fee pool must have exactly same value for fee field
     uint24 public constant DYNAMIC_FEE_FLAG = 0x800000;
 
     // the second bit of the fee returned by beforeSwap is used to signal if the stored LP fee should be overridden in this swap
@@ -29,7 +28,7 @@ library LPFeeLibrary {
     uint24 public constant TEN_PERCENT_FEE = 100_000;
 
     function isDynamicLPFee(uint24 self) internal pure returns (bool) {
-        return self & DYNAMIC_FEE_FLAG != 0;
+        return self == DYNAMIC_FEE_FLAG;
     }
 
     function validate(uint24 self, uint24 maxFee) internal pure {
@@ -40,7 +39,7 @@ library LPFeeLibrary {
     function getInitialLPFee(uint24 self) internal pure returns (uint24 lpFee) {
         // the initial fee for a dynamic fee pool is 0
         if (self.isDynamicLPFee()) return 0;
-        lpFee = self & FEE_MASK;
+        lpFee = self;
     }
 
     /// @notice returns true if the fee has the override flag set (top bit of the uint24)

diff --git a/src/pool-bin/BinPoolManager.sol b/src/pool-bin/BinPoolManager.sol
@@ -196,7 +196,6 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
                 msg.sender, key, swapForY, 0, amountOut
             );
         } else {
-            // clear the top 4 bits since they may be flagged
             lpFee = key.fee.getInitialLPFee();
         }
         lpFee.validate(LPFeeLibrary.TEN_PERCENT_FEE);

diff --git a/src/types/BalanceDelta.sol b/src/types/BalanceDelta.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {SafeCast} from "../libraries/SafeCast.sol";
 

diff --git a/src/types/PoolKey.sol b/src/types/PoolKey.sol
@@ -15,7 +15,7 @@ struct PoolKey {
     IHooks hooks;
     /// @notice The pool manager of the pool
     IPoolManager poolManager;
-    /// @notice The pool lp fee, capped at 1_000_000. The upper 4 bits determine if the hook sets any fees.
+    /// @notice The pool lp fee, capped at 1_000_000. If the pool has a dynamic fee then it must be exactly equal to 0x800000
     uint24 fee;
     /// @notice Hooks callback and pool specific parameters, i.e. tickSpacing for CL, binStep for bin
     bytes32 parameters;

diff --git a/test/VaultToken.t.sol b/test/VaultToken.t.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.24;
+pragma solidity ^0.8.24;
 
 import {Test} from "forge-std/Test.sol";
 import {VaultToken} from "../src/VaultToken.sol";

diff --git a/test/libraries/BalanceDelta.t.sol b/test/libraries/BalanceDelta.t.sol
@@ -131,7 +131,7 @@ contract TestBalanceDelta is Test {
         else assertFalse(isEqual);
     }
 
-    function test_fuzz_neq(int128 a, int128 b, int128 c, int128 d) public pure {
+    function test_fuzz_neq(int128 a, int128 b, int128 c, int128 d) public {
         bool isNotEqual = (toBalanceDelta(a, b) != toBalanceDelta(c, d));
         if (a != c || b != d) assertTrue(isNotEqual);
         else assertFalse(isNotEqual);

diff --git a/test/libraries/LPFeeLibrary.t.sol b/test/libraries/LPFeeLibrary.t.sol
@@ -22,12 +22,20 @@ contract LPFeeLibraryTest is Test {
         assertEq(LPFeeLibrary.isDynamicLPFee(0x100000), false);
 
         // 1111 1111 1111 1111 1111 1111
-        assertEq(LPFeeLibrary.isDynamicLPFee(0xFFFFFF), true);
+        assertEq(LPFeeLibrary.isDynamicLPFee(0xFFFFFF), false);
 
         // 0111 1111 1111 1111 1111 1111
         assertEq(LPFeeLibrary.isDynamicLPFee(0x7FFFFF), false);
     }
 
+    function testIsDynamicLPFeeFuzz(uint24 fee) public {
+        if (fee != 0x800000) {
+            assertEq(LPFeeLibrary.isDynamicLPFee(fee), false);
+        } else {
+            assertEq(LPFeeLibrary.isDynamicLPFee(fee), true);
+        }
+    }
+
     function testGetInitialLPFee() public {
         // static
         assertEq(LPFeeLibrary.getInitialLPFee(0x000001), 0x000001);
@@ -36,12 +44,16 @@ contract LPFeeLibraryTest is Test {
         assertEq(LPFeeLibrary.getInitialLPFee(0x001004), 0x001004);
         assertEq(LPFeeLibrary.getInitialLPFee(0x111020), 0x111020);
         assertEq(LPFeeLibrary.getInitialLPFee(0x511020), 0x511020);
-
+        assertEq(LPFeeLibrary.getInitialLPFee(0xF00F05), 0xF00F05);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x800310), 0x800310);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x901020), 0x901020);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x800001), 0x800001);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x800010), 0x800010);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x800100), 0x800100);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x801000), 0x801000);
+        assertEq(LPFeeLibrary.getInitialLPFee(0x810000), 0x810000);
         // dynamic
-        assertEq(LPFeeLibrary.getInitialLPFee(0xF00F05), 0);
-        assertEq(LPFeeLibrary.getInitialLPFee(0x800310), 0);
         assertEq(LPFeeLibrary.getInitialLPFee(0x800000), 0);
-        assertEq(LPFeeLibrary.getInitialLPFee(0x901020), 0);
     }
 
     function testFuzzValidate(uint24 self, uint24 maxFee) public {