pr commmeeennnnttsss

Uniswap · Aug 29, 2024 · 21ae901 · 21ae901
1 parent ec14729
commit 21ae901
Show file tree

Hide file tree

Showing 29 changed files with 40 additions and 38 deletions.
diff --git a/.forge-snapshots/PositionManager_burn_empty.snap b/.forge-snapshots/PositionManager_burn_empty.snap
@@ -1 +1 @@
-49954
+49976
diff --git a/.forge-snapshots/PositionManager_burn_empty_native.snap b/.forge-snapshots/PositionManager_burn_empty_native.snap
@@ -1 +1 @@
-49954
+49976
diff --git a/.forge-snapshots/PositionManager_burn_nonEmpty_native_withClose.snap b/.forge-snapshots/PositionManager_burn_nonEmpty_native_withClose.snap
@@ -1 +1 @@
-126207
+126229
diff --git a/.forge-snapshots/PositionManager_burn_nonEmpty_native_withTakePair.snap b/.forge-snapshots/PositionManager_burn_nonEmpty_native_withTakePair.snap
@@ -1 +1 @@
-125704
+125727
diff --git a/.forge-snapshots/PositionManager_burn_nonEmpty_withClose.snap b/.forge-snapshots/PositionManager_burn_nonEmpty_withClose.snap
@@ -1 +1 @@
-133103
+133125
diff --git a/.forge-snapshots/PositionManager_burn_nonEmpty_withTakePair.snap b/.forge-snapshots/PositionManager_burn_nonEmpty_withTakePair.snap
@@ -1 +1 @@
-132600
+132623
diff --git a/.forge-snapshots/PositionManager_collect_native.snap b/.forge-snapshots/PositionManager_collect_native.snap
@@ -1 +1 @@
-146341
+146373
diff --git a/.forge-snapshots/PositionManager_collect_sameRange.snap b/.forge-snapshots/PositionManager_collect_sameRange.snap
@@ -1 +1 @@
-154961
+154993
diff --git a/.forge-snapshots/PositionManager_collect_withClose.snap b/.forge-snapshots/PositionManager_collect_withClose.snap
@@ -1 +1 @@
-154961
+154993
diff --git a/.forge-snapshots/PositionManager_collect_withTakePair.snap b/.forge-snapshots/PositionManager_collect_withTakePair.snap
@@ -1 +1 @@
-154345
+154377
diff --git a/.forge-snapshots/PositionManager_decreaseLiquidity_native.snap b/.forge-snapshots/PositionManager_decreaseLiquidity_native.snap
@@ -1 +1 @@
-112548
+112573
diff --git a/.forge-snapshots/PositionManager_decreaseLiquidity_withClose.snap b/.forge-snapshots/PositionManager_decreaseLiquidity_withClose.snap
@@ -1 +1 @@
-120504
+120536
diff --git a/.forge-snapshots/PositionManager_decreaseLiquidity_withTakePair.snap b/.forge-snapshots/PositionManager_decreaseLiquidity_withTakePair.snap
@@ -1 +1 @@
-119888
+119920
diff --git a/.forge-snapshots/PositionManager_decrease_burnEmpty.snap b/.forge-snapshots/PositionManager_decrease_burnEmpty.snap
@@ -1 +1 @@
-135944
+135992
diff --git a/.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap b/.forge-snapshots/PositionManager_decrease_burnEmpty_native.snap
@@ -1 +1 @@
-129048
+129096
diff --git a/.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap b/.forge-snapshots/PositionManager_decrease_sameRange_allLiquidity.snap
@@ -1 +1 @@
-133220
+133252
diff --git a/.forge-snapshots/PositionManager_decrease_take_take.snap b/.forge-snapshots/PositionManager_decrease_take_take.snap
@@ -1 +1 @@
-121037
+121069
diff --git a/.forge-snapshots/PositionManager_increaseLiquidity_erc20_withClose.snap b/.forge-snapshots/PositionManager_increaseLiquidity_erc20_withClose.snap
@@ -1 +1 @@
-159211
+159243
diff --git a/.forge-snapshots/PositionManager_increaseLiquidity_erc20_withSettlePair.snap b/.forge-snapshots/PositionManager_increaseLiquidity_erc20_withSettlePair.snap
@@ -1 +1 @@
-158237
+158269
diff --git a/.forge-snapshots/PositionManager_increaseLiquidity_native.snap b/.forge-snapshots/PositionManager_increaseLiquidity_native.snap
@@ -1 +1 @@
-141239
+141271
diff --git a/.forge-snapshots/PositionManager_increase_autocompoundExactUnclaimedFees.snap b/.forge-snapshots/PositionManager_increase_autocompoundExactUnclaimedFees.snap
@@ -1 +1 @@
-137356
+137388
diff --git a/.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap b/.forge-snapshots/PositionManager_increase_autocompoundExcessFeesCredit.snap
@@ -1 +1 @@
-178272
+178304
diff --git a/.forge-snapshots/PositionManager_increase_autocompound_clearExcess.snap b/.forge-snapshots/PositionManager_increase_autocompound_clearExcess.snap
@@ -1 +1 @@
-148228
+148260
diff --git a/src/PositionManager.sol b/src/PositionManager.sol
@@ -232,7 +232,7 @@ contract PositionManager is
         uint128 amount1Max,
         bytes calldata hookData
     ) internal onlyIfApproved(msgSender(), tokenId) {
-        (PositionInfo info, PoolKey memory poolKey) = getPoolAndPositionInfo(tokenId);
+        (PoolKey memory poolKey, PositionInfo info) = getPoolAndPositionInfo(tokenId);
 
         // Note: The tokenId is used as the salt for this position, so every minted position has unique storage in the pool manager.
         (BalanceDelta liquidityDelta, BalanceDelta feesAccrued) =
@@ -249,7 +249,7 @@ contract PositionManager is
         uint128 amount1Min,
         bytes calldata hookData
     ) internal onlyIfApproved(msgSender(), tokenId) {
-        (PositionInfo info, PoolKey memory poolKey) = getPoolAndPositionInfo(tokenId);
+        (PoolKey memory poolKey, PositionInfo info) = getPoolAndPositionInfo(tokenId);
 
         // Note: the tokenId is used as the salt.
         (BalanceDelta liquidityDelta, BalanceDelta feesAccrued) =
@@ -298,7 +298,7 @@ contract PositionManager is
         internal
         onlyIfApproved(msgSender(), tokenId)
     {
-        (PositionInfo info, PoolKey memory poolKey) = getPoolAndPositionInfo(tokenId);
+        (PoolKey memory poolKey, PositionInfo info) = getPoolAndPositionInfo(tokenId);
 
         uint256 liquidity = uint256(_getLiquidity(tokenId, poolKey, info.tickLower(), info.tickUpper()));
 
@@ -396,12 +396,12 @@ contract PositionManager is
     }
 
     /// @notice an internal helper used by Notifier
-    function _setSubscribe(uint256 tokenId) internal override {
+    function _setSubscribed(uint256 tokenId) internal override {
         positionInfo[tokenId] = positionInfo[tokenId].setSubscribe();
     }
 
     /// @notice an internal helper used by Notifier
-    function _setUnsubscribe(uint256 tokenId) internal override {
+    function _setUnsubscribed(uint256 tokenId) internal override {
         positionInfo[tokenId] = positionInfo[tokenId].setUnsubscribe();
     }
 
@@ -412,14 +412,14 @@ contract PositionManager is
     }
 
     /// @inheritdoc IPositionManager
-    function getPoolAndPositionInfo(uint256 tokenId) public view returns (PositionInfo info, PoolKey memory poolKey) {
+    function getPoolAndPositionInfo(uint256 tokenId) public view returns (PoolKey memory poolKey, PositionInfo info) {
         info = positionInfo[tokenId];
         poolKey = poolKeys[info.poolId()];
     }
 
     /// @inheritdoc IPositionManager
     function getPositionLiquidity(uint256 tokenId) external view returns (uint128 liquidity) {
-        (PositionInfo info, PoolKey memory poolKey) = getPoolAndPositionInfo(tokenId);
+        (PoolKey memory poolKey, PositionInfo info) = getPoolAndPositionInfo(tokenId);
         liquidity = _getLiquidity(tokenId, poolKey, info.tickLower(), info.tickUpper());
     }
 

diff --git a/src/base/Notifier.sol b/src/base/Notifier.sol
@@ -31,9 +31,9 @@ abstract contract Notifier is INotifier {
 
     modifier onlyIfApproved(address caller, uint256 tokenId) virtual;
 
-    function _setUnsubscribe(uint256 tokenId) internal virtual;
+    function _setUnsubscribed(uint256 tokenId) internal virtual;
 
-    function _setSubscribe(uint256 tokenId) internal virtual;
+    function _setSubscribed(uint256 tokenId) internal virtual;
 
     /// @inheritdoc INotifier
     function subscribe(uint256 tokenId, address newSubscriber, bytes calldata data)
@@ -45,7 +45,7 @@ abstract contract Notifier is INotifier {
 
         if (_subscriber != NO_SUBSCRIBER) revert AlreadySubscribed(address(_subscriber));
 
-        _setSubscribe(tokenId);
+        _setSubscribed(tokenId);
         subscriber[tokenId] = ISubscriber(newSubscriber);
 
         bool success = _call(address(newSubscriber), abi.encodeCall(ISubscriber.notifySubscribe, (tokenId, data)));
@@ -62,7 +62,7 @@ abstract contract Notifier is INotifier {
         ISubscriber _subscriber = subscriber[tokenId];
 
         if (_subscriber == NO_SUBSCRIBER) revert AlreadyUnsubscribed();
-        _setUnsubscribe(tokenId);
+        _setUnsubscribed(tokenId);
 
         delete subscriber[tokenId];
 

diff --git a/src/interfaces/IPositionManager.sol b/src/interfaces/IPositionManager.sol
@@ -34,5 +34,5 @@ interface IPositionManager is INotifier {
     /// @param tokenId the ERC721 tokenId
     /// @return PositionInfo a uint256 packed value holding information about the position including the range (tickLower, tickUpper)
     /// @return poolKey the pool key of the position
-    function getPoolAndPositionInfo(uint256 tokenId) external view returns (PositionInfo, PoolKey memory);
+    function getPoolAndPositionInfo(uint256 tokenId) external view returns (PoolKey memory, PositionInfo);
 }
diff --git a/src/libraries/PositionInfoLibrary.sol b/src/libraries/PositionInfoLibrary.sol
@@ -43,6 +43,7 @@ library PositionInfoLibrary {
     uint8 internal constant TICK_LOWER_OFFSET = 8;
     uint8 internal constant TICK_UPPER_OFFSET = 32;
 
+    /// @dev This poolId is NOT compatible with the poolId used in UniswapV4 core. It is truncated to 25 bytes, and just used to lookup PoolKey in the poolKeys mapping.
     function poolId(PositionInfo info) internal pure returns (bytes25 _poolId) {
         assembly ("memory-safe") {
             _poolId := and(MASK_UPPER_200_BITS, info)

diff --git a/test/libraries/PositionInfoLibrary.t.sol b/test/libraries/PositionInfoLibrary.t.sol
@@ -21,7 +21,7 @@ contract PositionInfoLibraryTest is Test {
         assertEq(info.hasSubscriber(), false);
     }
 
-    function test_fuzz_initialize_setSubscribe(PoolKey memory poolKey, int24 tickLower, int24 tickUpper) public pure {
+    function test_fuzz_initialize_setSubscribed(PoolKey memory poolKey, int24 tickLower, int24 tickUpper) public pure {
         PositionInfo info = PositionInfoLibrary.initialize(poolKey, tickLower, tickUpper);
         assertEq(info.hasSubscriber(), false);
         info = info.setSubscribe();
@@ -31,7 +31,7 @@ contract PositionInfoLibraryTest is Test {
         assertEq(info.poolId(), bytes25(PoolId.unwrap(poolKey.toId())));
     }
 
-    function test_fuzz_initialize_setUnsubscribe(PoolKey memory poolKey, int24 tickLower, int24 tickUpper)
+    function test_fuzz_initialize_setUnsubscribed(PoolKey memory poolKey, int24 tickLower, int24 tickUpper)
         public
         pure
     {

diff --git a/test/mocks/MockCalldataDecoder.sol b/test/mocks/MockCalldataDecoder.sol
@@ -9,7 +9,8 @@ import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
 // we need to use a mock contract to make the calls happen in calldata not memory
 contract MockCalldataDecoder {
     using CalldataDecoder for bytes;
-
+
+    // This is used to avoid compiling with via-ir.
     struct MintParams {
         PoolKey poolKey;
         int24 tickLower;