feat: [internal-r6] clear unused bits (#157)

pancakeswap · Sep 2, 2024 · cf59155 · cf59155
1 parent 9166870
commit cf59155
Show file tree

Hide file tree

Showing 49 changed files with 77 additions and 55 deletions.
diff --git a/.forge-snapshots/BinPoolManagerBytecodeSize.snap b/.forge-snapshots/BinPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-24261
+24266
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-119419
+119431
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-971597
+971609
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-330908
+330920
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-338509
+338521
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-141059
+141071
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-173967
+173973
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-179996
+180002
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-133998
+134004
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-305471
+305477
diff --git a/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap b/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap
@@ -1 +1 @@
-34501
+34507
diff --git a/.forge-snapshots/CLPoolManagerBytecodeSize.snap b/.forge-snapshots/CLPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-21295
+21262
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-348065
+348304
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-163580
+163775
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-238829
+239056
diff --git a/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap b/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap
@@ -1 +1 @@
-164012
+164024
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-108961
+108967
diff --git a/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap b/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap
@@ -1 +1 @@
-150637
+150645
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-115371
+115519
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-131655
+131787
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-164122
+164357
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-149672
+149804
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-72285
+72396
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-143936
+144042
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-88571
+88682
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-72288
+72399
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap
@@ -1 +1 @@
-198
+233
diff --git a/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap b/.forge-snapshots/SqrtPriceMathTest#getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap
@@ -1 +1 @@
-198
+268
diff --git a/.forge-snapshots/SqrtPriceMathTest#getNextSqrtPriceFromOutput_zeroForOneEqualsFalse.snap b/.forge-snapshots/SqrtPriceMathTest#getNextSqrtPriceFromOutput_zeroForOneEqualsFalse.snap
@@ -1 +1 @@
-542
+548
diff --git a/.forge-snapshots/SqrtPriceMathTest#getNextSqrtPriceFromOutput_zeroForOneEqualsTrue.snap b/.forge-snapshots/SqrtPriceMathTest#getNextSqrtPriceFromOutput_zeroForOneEqualsTrue.snap
@@ -1 +1 @@
-209
+218
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInCapped.snap
@@ -1 +1 @@
-1202
+1256
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactInPartial.snap
@@ -1 +1 @@
-1553
+1679
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutCapped.snap
@@ -1 +1 @@
-1041
+1098
diff --git a/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapOneForZeroExactOutPartial.snap
@@ -1 +1 @@
-1553
+1679
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInCapped.snap
@@ -1 +1 @@
-1213
+1233
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactInPartial.snap
@@ -1 +1 @@
-1968
+2000
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutCapped.snap
@@ -1 +1 @@
-1044
+1062
diff --git a/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap b/.forge-snapshots/SwapMathTest#SwapZeroForOneExactOutPartial.snap
@@ -1 +1 @@
-1968
+2000
diff --git a/.forge-snapshots/VaultBytecodeSize.snap b/.forge-snapshots/VaultBytecodeSize.snap
@@ -1 +1 @@
-7766
+7769
diff --git a/.forge-snapshots/flipTick_gasCostOfFlippingSecondTickInWordToInitialized.snap b/.forge-snapshots/flipTick_gasCostOfFlippingSecondTickInWordToInitialized.snap
@@ -1 +1 @@
-5174
+5182
diff --git a/src/libraries/ProtocolFeeLibrary.sol b/src/libraries/ProtocolFeeLibrary.sol
@@ -37,7 +37,7 @@ library ProtocolFeeLibrary {
         // Equivalent to: getZeroForOneFee(self) <= MAX_PROTOCOL_FEE && getOneForZeroFee(self) <= MAX_PROTOCOL_FEE
         assembly ("memory-safe") {
             let isZeroForOneFeeOk := lt(and(self, 0xfff), FEE_0_THRESHOLD)
-            let isOneForZeroFeeOk := lt(self, FEE_1_THRESHOLD)
+            let isOneForZeroFeeOk := lt(and(self, 0xfff000), FEE_1_THRESHOLD)
             valid := and(isZeroForOneFeeOk, isOneForZeroFeeOk)
         }
     }

diff --git a/src/libraries/SettlementGuard.sol b/src/libraries/SettlementGuard.sol
@@ -29,7 +29,7 @@ library SettlementGuard {
         if (currentLocker != address(0) && newLocker != address(0)) revert IVault.LockerAlreadySet(currentLocker);
 
         assembly ("memory-safe") {
-            tstore(LOCKER_SLOT, newLocker)
+            tstore(LOCKER_SLOT, and(newLocker, 0xffffffffffffffffffffffffffffffffffffffff))
         }
     }
 

diff --git a/src/libraries/VaultReserve.sol b/src/libraries/VaultReserve.sol
@@ -32,7 +32,7 @@ library VaultReserve {
     function setVaultReserve(Currency currency, uint256 amount) internal {
         assembly ("memory-safe") {
             // record <currency, amount> in transient storage
-            tstore(RESERVE_TYPE_SLOT, currency)
+            tstore(RESERVE_TYPE_SLOT, and(currency, 0xffffffffffffffffffffffffffffffffffffffff))
             tstore(RESERVE_AMOUNT_SLOT, amount)
         }
     }

diff --git a/src/pool-cl/libraries/LiquidityMath.sol b/src/pool-cl/libraries/LiquidityMath.sol
@@ -10,7 +10,7 @@ library LiquidityMath {
     /// @return z The liquidity delta
     function addDelta(uint128 x, int128 y) internal pure returns (uint128 z) {
         assembly ("memory-safe") {
-            z := add(x, y)
+            z := add(and(x, 0xffffffffffffffffffffffffffffffff), signextend(15, y))
 
             if shr(128, z) {
                 // store 0x93dafdf1, error SafeCastOverflow at memory 0 address and revert from pointer 28, to byte 32

diff --git a/src/pool-cl/libraries/SqrtPriceMath.sol b/src/pool-cl/libraries/SqrtPriceMath.sol
@@ -58,7 +58,12 @@ library SqrtPriceMath {
                 // in addition, we must check that the denominator does not underflow
                 // equivalent: if (product / amount != sqrtPX96 || numerator1 <= product) revert PriceOverflow();
                 assembly ("memory-safe") {
-                    if iszero(and(eq(div(product, amount), sqrtPX96), gt(numerator1, product))) {
+                    if iszero(
+                        and(
+                            eq(div(product, amount), and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
+                            gt(numerator1, product)
+                        )
+                    ) {
                         mstore(0, 0xf5c787f1) // selector for PriceOverflow()
                         revert(0x1c, 0x04)
                     }
@@ -103,7 +108,7 @@ library SqrtPriceMath {
 
             // equivalent: if (sqrtPX96 <= quotient) revert NotEnoughLiquidity();
             assembly ("memory-safe") {
-                if iszero(gt(sqrtPX96, quotient)) {
+                if iszero(gt(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff), quotient)) {
                     mstore(0, 0x4323a555) // selector for NotEnoughLiquidity()
                     revert(0x1c, 0x04)
                 }
@@ -129,7 +134,10 @@ library SqrtPriceMath {
     {
         // equivalent: if (sqrtPX96 == 0 || liquidity == 0) revert InvalidPriceOrLiquidity();
         assembly ("memory-safe") {
-            if or(iszero(sqrtPX96), iszero(liquidity)) {
+            if or(
+                iszero(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
+                iszero(and(liquidity, 0xffffffffffffffffffffffffffffffff))
+            ) {
                 mstore(0, 0x4f2461b8) // selector for InvalidPriceOrLiquidity()
                 revert(0x1c, 0x04)
             }
@@ -155,7 +163,10 @@ library SqrtPriceMath {
     {
         // equivalent: if (sqrtPX96 == 0 || liquidity == 0) revert InvalidPriceOrLiquidity();
         assembly ("memory-safe") {
-            if or(iszero(sqrtPX96), iszero(liquidity)) {
+            if or(
+                iszero(and(sqrtPX96, 0xffffffffffffffffffffffffffffffffffffffff)),
+                iszero(and(liquidity, 0xffffffffffffffffffffffffffffffff))
+            ) {
                 mstore(0, 0x4f2461b8) // selector for InvalidPriceOrLiquidity()
                 revert(0x1c, 0x04)
             }
@@ -185,7 +196,7 @@ library SqrtPriceMath {
 
             // equivalent: if (sqrtRatioAX96 == 0) revert InvalidPrice();
             assembly ("memory-safe") {
-                if iszero(sqrtRatioAX96) {
+                if iszero(and(sqrtRatioAX96, 0xffffffffffffffffffffffffffffffffffffffff)) {
                     mstore(0, 0x00bfc921) // selector for InvalidPrice()
                     revert(0x1c, 0x04)
                 }
@@ -203,7 +214,8 @@ library SqrtPriceMath {
     /// @notice Equivalent to: `a >= b ? a - b : b - a`
     function absDiff(uint160 a, uint160 b) internal pure returns (uint256 res) {
         assembly ("memory-safe") {
-            let diff := sub(a, b)
+            let diff :=
+                sub(and(a, 0xffffffffffffffffffffffffffffffffffffffff), and(b, 0xffffffffffffffffffffffffffffffffffffffff))
             // mask = 0 if a >= b else -1 (all 1s)
             let mask := sar(255, diff)
             // if a >= b, res = a - b = 0 ^ (a - b)
@@ -230,7 +242,7 @@ library SqrtPriceMath {
         uint256 _liquidity;
         assembly ("memory-safe") {
             // avoid implicit upcasting
-            _liquidity := liquidity
+            _liquidity := and(liquidity, 0xffffffffffffffffffffffffffffffff)
         }
         /**
          * Equivalent to:
@@ -241,7 +253,7 @@ library SqrtPriceMath {
          */
         amount1 = FullMath.mulDiv(_liquidity, numerator, denominator);
         assembly ("memory-safe") {
-            amount1 := add(amount1, and(gt(mulmod(_liquidity, numerator, denominator), 0), roundUp))
+            amount1 := add(amount1, and(gt(mulmod(_liquidity, numerator, denominator), 0), and(roundUp, 0x1)))
         }
     }
 

diff --git a/src/pool-cl/libraries/SwapMath.sol b/src/pool-cl/libraries/SwapMath.sol
@@ -28,7 +28,9 @@ library SwapMath {
             // sqrtPriceTargetX96 = max(sqrtPriceNextX96, sqrtPriceLimitX96)
             // when zeroForOne == false, nextOrLimit reduces to sqrtPriceNextX96 < sqrtPriceLimitX96
             // sqrtPriceTargetX96 = min(sqrtPriceNextX96, sqrtPriceLimitX96)
-            let nextOrLimit := xor(lt(sqrtPriceNextX96, sqrtPriceLimitX96), zeroForOne)
+            sqrtPriceNextX96 := and(sqrtPriceNextX96, 0xffffffffffffffffffffffffffffffffffffffff)
+            sqrtPriceLimitX96 := and(sqrtPriceLimitX96, 0xffffffffffffffffffffffffffffffffffffffff)
+            let nextOrLimit := xor(lt(sqrtPriceNextX96, sqrtPriceLimitX96), and(zeroForOne, 0x1))
             let symDiff := xor(sqrtPriceNextX96, sqrtPriceLimitX96)
             sqrtPriceTargetX96 := xor(sqrtPriceLimitX96, mul(symDiff, nextOrLimit))
         }

diff --git a/src/pool-cl/libraries/Tick.sol b/src/pool-cl/libraries/Tick.sol
@@ -61,6 +61,7 @@ library Tick {
         int24 MIN_TICK = TickMath.MIN_TICK;
         // tick spacing will never be 0 since TickMath.MIN_TICK_SPACING is 1
         assembly ("memory-safe") {
+            tickSpacing := signextend(2, tickSpacing)
             let minTick := sdiv(MIN_TICK, tickSpacing)
             let maxTick := sdiv(MAX_TICK, tickSpacing)
             let numTicks := add(sub(maxTick, minTick), 1)
@@ -166,7 +167,9 @@ library Tick {
 
         // update two members in one go
         assembly ("memory-safe") {
-            sstore(info.slot, or(liquidityGrossAfter, shl(128, liquidityNetAfter)))
+            sstore(
+                info.slot, or(and(liquidityGrossAfter, 0xffffffffffffffffffffffffffffffff), shl(128, liquidityNetAfter))
+            )
         }
     }
 

diff --git a/src/pool-cl/libraries/TickBitmap.sol b/src/pool-cl/libraries/TickBitmap.sol
@@ -19,6 +19,8 @@ library TickBitmap {
         //   compressed = tick / tickSpacing;
         //   if (tick < 0 && tick % tickSpacing != 0) compressed--;
         assembly ("memory-safe") {
+            tick := signextend(2, tick)
+            tickSpacing := signextend(2, tickSpacing)
             compressed :=
                 sub(
                     sdiv(tick, tickSpacing),
@@ -35,7 +37,7 @@ library TickBitmap {
     function position(int24 tick) internal pure returns (int16 wordPos, uint8 bitPos) {
         assembly ("memory-safe") {
             // signed arithmetic shift right
-            wordPos := sar(8, tick) //
+            wordPos := sar(8, signextend(2, tick)) //
             bitPos := and(tick, 0xff)
         }
     }
@@ -51,6 +53,8 @@ library TickBitmap {
         //   uint256 mask = 1 << bitPos;
         //   self[wordPos] ^= mask;
         assembly ("memory-safe") {
+            tick := signextend(2, tick)
+            tickSpacing := signextend(2, tickSpacing)
             // ensure that the tick is spaced
             if smod(tick, tickSpacing) {
                 let fmp := mload(0x40)

diff --git a/src/pool-cl/libraries/TickMath.sol b/src/pool-cl/libraries/TickMath.sol
@@ -53,6 +53,7 @@ library TickMath {
             // Equivalent: uint256 absTick = tick < 0 ? uint256(-int256(tick)) : uint256(int256(tick));
             uint256 absTick;
             assembly ("memory-safe") {
+                tick := signextend(2, tick)
                 // mask = 0 if tick >= 0 else -1 (all 1s)
                 let mask := sar(255, tick)
                 absTick := xor(mask, add(mask, tick))