General gas tweaks (#63)

* feat: gas tweak on tickMath * feat: gas tweak on sqrtPriceMath * feat: gas tweak tickmath getTickAtSqrtRatio * test: fix test warning and added more test to TickMath * test: add more test on TickMath * feat: optimise tickbitMap flipTick * feat: gas optimise tickbvitMap compressed and position * feat: protocol fee lib tweaks
pancakeswap · Jun 3, 2024 · 03ebac9 · 03ebac9
1 parent f2abcc4
commit 03ebac9
Show file tree

Hide file tree

Showing 58 changed files with 353 additions and 107 deletions.
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-180732
+180720
diff --git a/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap
@@ -1 +1 @@
-137531
+137534
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-331216
+331204
diff --git a/.forge-snapshots/BinPoolManagerTest#testExtLoadPoolActiveId.snap b/.forge-snapshots/BinPoolManagerTest#testExtLoadPoolActiveId.snap
@@ -1 +1 @@
-1824
+1818
diff --git a/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap b/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap
@@ -1 +1 @@
-30405
+30417
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-119509
+119497
diff --git a/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap b/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap
@@ -1 +1 @@
-34487
+34340
diff --git a/.forge-snapshots/BitMathTest#leastSignificantBitMaxUint128.snap b/.forge-snapshots/BitMathTest#leastSignificantBitMaxUint128.snap
@@ -1 +1 @@
-455
+456
diff --git a/.forge-snapshots/BitMathTest#leastSignificantBitMaxUint256.snap b/.forge-snapshots/BitMathTest#leastSignificantBitMaxUint256.snap
@@ -1 +1 @@
-457
+458
diff --git a/.forge-snapshots/BitMathTest#leastSignificantBitSmallNumber.snap b/.forge-snapshots/BitMathTest#leastSignificantBitSmallNumber.snap
@@ -1 +1 @@
-453
+454
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-360023
+358846
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-175191
+174344
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-245111
+244098
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-112417
+112420
diff --git a/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap b/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap
@@ -1 +1 @@
-59963
+59775
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-121271
+120646
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-137753
+137041
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-170905
+169737
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-157667
+156973
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-76212
+75510
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-149916
+149059
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-93104
+92402
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-76215
+75513
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap
@@ -1 +1 @@
-520
+369
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap
@@ -1 +1 @@
-648
+370
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap
@@ -1 +1 @@
-1942
+1673
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap
@@ -1 +1 @@
-2697
+2147
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap
@@ -1 +1 @@
-1692
+1423
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap
@@ -1 +1 @@
-2697
+2147
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap
@@ -1 +1 @@
-1911
+1769
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap
@@ -1 +1 @@
-2831
+2689
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap
@@ -1 +1 @@
-1661
+1519
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap
@@ -1 +1 @@
-2831
+2689
diff --git a/.forge-snapshots/TickTest#checkTicks.snap b/.forge-snapshots/TickTest#checkTicks.snap
@@ -1 +1 @@
-350
+186
diff --git a/.forge-snapshots/TickTest#tickSpacingToMaxLiquidityPerTick.snap b/.forge-snapshots/TickTest#tickSpacingToMaxLiquidityPerTick.snap
@@ -1 +1 @@
-1159
+1072
diff --git a/.forge-snapshots/TickTest#update.snap b/.forge-snapshots/TickTest#update.snap
@@ -1 +1 @@
-134827
+134740
diff --git a/.forge-snapshots/VaultTest#collectFee.snap b/.forge-snapshots/VaultTest#collectFee.snap
@@ -1 +1 @@
-25138
+25135
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap b/.forge-snapshots/VaultTest#lockSettledWhenAddLiquidity.snap
@@ -1 +1 @@
-81463
+81494
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap b/.forge-snapshots/VaultTest#lockSettledWhenFlashloan.snap
@@ -1 +1 @@
-121269
+121363
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenMultiHopSwap.snap
@@ -1 +1 @@
-45005
+45036
diff --git a/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap b/.forge-snapshots/VaultTest#lockSettledWhenSwap.snap
@@ -1 +1 @@
-45004
+45032
diff --git a/.forge-snapshots/VaultTest#registerPoolManager.snap b/.forge-snapshots/VaultTest#registerPoolManager.snap
@@ -1 +1 @@
-47916
+47913
diff --git a/.forge-snapshots/flipTick_gasCostOfFlippingATickThatResultsInDeletingAWord.snap b/.forge-snapshots/flipTick_gasCostOfFlippingATickThatResultsInDeletingAWord.snap
@@ -1 +1 @@
-5409
+5244
diff --git a/.forge-snapshots/flipTick_gasCostOfFlippingFirstTickInWordToInitialized.snap b/.forge-snapshots/flipTick_gasCostOfFlippingFirstTickInWordToInitialized.snap
@@ -1 +1 @@
-22506
+22341
diff --git a/.forge-snapshots/flipTick_gasCostOfFlippingSecondTickInWordToInitialized.snap b/.forge-snapshots/flipTick_gasCostOfFlippingSecondTickInWordToInitialized.snap
@@ -1 +1 @@
-5515
+5350
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostForEntireWord.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostForEntireWord.snap
@@ -1 +1 @@
-2592
+2488
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostJustBelowBoundary.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostJustBelowBoundary.snap
@@ -1 +1 @@
-2592
+2488
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostOnBoundary.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteFalse_gasCostOnBoundary.snap
@@ -1 +1 @@
-2592
+2488
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostForEntireWord.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostForEntireWord.snap
@@ -1 +1 @@
-2591
+2475
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostJustBelowBoundary.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostJustBelowBoundary.snap
@@ -1 +1 @@
-2900
+2784
diff --git a/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostOnBoundary.snap b/.forge-snapshots/nextInitializedTickWithinOneWord_lteTrue_gasCostOnBoundary.snap
@@ -1 +1 @@
-2591
+2475
diff --git a/src/libraries/ProtocolFeeLibrary.sol b/src/libraries/ProtocolFeeLibrary.sol
@@ -8,36 +8,38 @@ library ProtocolFeeLibrary {
     // Max protocol fee is 0.1% (1000 pips)
     uint16 public constant MAX_PROTOCOL_FEE = 1000;
 
+    // Thresholds used for optimized bounds checks on protocol fees
+    uint24 internal constant FEE_0_THRESHOLD = 1001;
+    uint24 internal constant FEE_1_THRESHOLD = 1001 << 12;
+
     // the protocol fee is represented in hundredths of a bip
     uint256 internal constant PIPS_DENOMINATOR = 1_000_000;
 
     function getZeroForOneFee(uint24 self) internal pure returns (uint16) {
-        return uint16(self & (4096 - 1));
+        return uint16(self & 0xfff);
     }
 
     function getOneForZeroFee(uint24 self) internal pure returns (uint16) {
         return uint16(self >> 12);
     }
 
-    function validate(uint24 self) internal pure returns (bool) {
-        if (self != 0) {
-            uint16 fee0 = getZeroForOneFee(self);
-            uint16 fee1 = getOneForZeroFee(self);
-            // The fee is represented in pips and it cannot be greater than the MAX_PROTOCOL_FEE.
-            if ((fee0 > MAX_PROTOCOL_FEE) || (fee1 > MAX_PROTOCOL_FEE)) {
-                return false;
-            }
+    function validate(uint24 self) internal pure returns (bool valid) {
+        // Equivalent to: getZeroForOneFee(self) <= MAX_PROTOCOL_FEE && getOneForZeroFee(self) <= MAX_PROTOCOL_FEE
+        assembly {
+            let isZeroForOneFeeOk := lt(and(self, 0xfff), FEE_0_THRESHOLD)
+            let isOneForZeroFeeOk := lt(self, FEE_1_THRESHOLD)
+            valid := and(isZeroForOneFeeOk, isOneForZeroFeeOk)
         }
-        return true;
     }
 
     // The protocol fee is taken from the input amount first and then the LP fee is taken from the remaining
     // The swap fee is capped at 100%
     // equivalent to protocolFee + lpFee(1_000_000 - protocolFee) / 1_000_000
-    function calculateSwapFee(uint24 self, uint24 lpFee) internal pure returns (uint24) {
-        unchecked {
-            uint256 numerator = uint256(self) * uint256(lpFee);
-            return uint24(uint256(self) + lpFee - UnsafeMath.divRoundingUp(numerator, PIPS_DENOMINATOR));
+    function calculateSwapFee(uint24 self, uint24 lpFee) internal pure returns (uint24 swapFee) {
+        assembly {
+            let numerator := mul(self, lpFee)
+            let divRoundingUp := add(div(numerator, PIPS_DENOMINATOR), gt(mod(numerator, PIPS_DENOMINATOR), 0))
+            swapFee := sub(add(self, lpFee), divRoundingUp)
         }
     }
 }
diff --git a/src/pool-cl/libraries/SqrtPriceMath.sol b/src/pool-cl/libraries/SqrtPriceMath.sol
@@ -200,6 +200,19 @@ library SqrtPriceMath {
         }
     }
 
+    /// @notice Equivalent to: `a >= b ? a - b : b - a`
+    function absDiff(uint160 a, uint160 b) internal pure returns (uint256 res) {
+        assembly {
+            let diff := sub(a, b)
+            // mask = 0 if a >= b else -1 (all 1s)
+            let mask := sar(255, diff)
+            // if a >= b, res = a - b = 0 ^ (a - b)
+            // if a < b, res = b - a = ~~(b - a) = ~(-(b - a) - 1) = ~(a - b - 1) = (-1) ^ (a - b - 1)
+            // either way, res = mask ^ (a - b + mask)
+            res := xor(mask, add(mask, diff))
+        }
+    }
+
     /// @notice Gets the amount1 delta between two prices
     /// @dev Calculates liquidity * (sqrt(upper) - sqrt(lower))
     /// @param sqrtRatioAX96 A sqrt price
@@ -212,11 +225,24 @@ library SqrtPriceMath {
         pure
         returns (uint256 amount1)
     {
-        if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
-
-        return roundUp
-            ? FullMath.mulDivRoundingUp(liquidity, sqrtRatioBX96 - sqrtRatioAX96, FixedPoint96.Q96)
-            : FullMath.mulDiv(liquidity, sqrtRatioBX96 - sqrtRatioAX96, FixedPoint96.Q96);
+        uint256 numerator = absDiff(sqrtRatioAX96, sqrtRatioBX96);
+        uint256 denominator = FixedPoint96.Q96;
+        uint256 _liquidity;
+        assembly {
+            // avoid implicit upcasting
+            _liquidity := liquidity
+        }
+        /**
+         * Equivalent to:
+         *   amount1 = roundUp
+         *       ? FullMath.mulDivRoundingUp(liquidity, sqrtRatioBX96 - sqrtRatioAX96, FixedPoint96.Q96)
+         *       : FullMath.mulDiv(liquidity, sqrtRatioBX96 - sqrtRatioAX96, FixedPoint96.Q96);
+         * Cannot overflow because `type(uint128).max * type(uint160).max >> 96 < (1 << 192)`.
+         */
+        amount1 = FullMath.mulDiv(_liquidity, numerator, denominator);
+        assembly {
+            amount1 := add(amount1, and(gt(mulmod(_liquidity, numerator, denominator), 0), roundUp))
+        }
     }
 
     /// @notice Helper that gets signed currency0 delta