internal-s30 use notifyBurn (#60)

* internal-s30 use notifyBurn * clean up console2
pancakeswap · Dec 3, 2024 · 297be6f · 297be6f
1 parent 05b4574
commit 297be6f
Show file tree

Hide file tree

Showing 55 changed files with 161 additions and 55 deletions.
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2IncludingInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2IncludingInit.snap
@@ -1 +1 @@
-794890
+794997
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutInit.snap
@@ -1 +1 @@
-660315
+660422
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromPancakeswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap
@@ -1 +1 @@
-730597
+730704
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3IncludingInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3IncludingInit.snap
@@ -1 +1 @@
-844797
+844904
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutInit.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutInit.snap
@@ -1 +1 @@
-712751
+712858
diff --git a/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromPancakeswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap
@@ -1 +1 @@
-753592
+753699
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2IncludingInit.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2IncludingInit.snap
@@ -1 +1 @@
-794890
+794997
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutInit.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutInit.snap
@@ -1 +1 @@
-660315
+660422
diff --git a/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromUniswapV2Test#testCLMigrateFromV2WithoutNativeToken.snap
@@ -1 +1 @@
-730597
+730704
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3IncludingInit.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3IncludingInit.snap
@@ -1 +1 @@
-842779
+842886
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutInit.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutInit.snap
@@ -1 +1 @@
-710733
+710840
diff --git a/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap b/.forge-snapshots/CLMigratorFromUniswapV3Test#testCLMigrateFromV3WithoutNativeToken.snap
@@ -1 +1 @@
-751574
+751681
diff --git a/.forge-snapshots/CLPositionManager_burn_empty.snap b/.forge-snapshots/CLPositionManager_burn_empty.snap
@@ -1 +1 @@
-60328
+60603
diff --git a/.forge-snapshots/CLPositionManager_burn_empty_native.snap b/.forge-snapshots/CLPositionManager_burn_empty_native.snap
@@ -1 +1 @@
-60328
+60603
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withClose.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withClose.snap
@@ -1 +1 @@
-173976
+174388
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withTakePair.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_native_withTakePair.snap
@@ -1 +1 @@
-173294
+173706
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_withClose.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_withClose.snap
@@ -1 +1 @@
-182555
+182967
diff --git a/.forge-snapshots/CLPositionManager_burn_nonEmpty_withTakePair.snap b/.forge-snapshots/CLPositionManager_burn_nonEmpty_withTakePair.snap
@@ -1 +1 @@
-181873
+182285
diff --git a/.forge-snapshots/CLPositionManager_collect_native.snap b/.forge-snapshots/CLPositionManager_collect_native.snap
@@ -1 +1 @@
-205506
+205613
diff --git a/.forge-snapshots/CLPositionManager_collect_sameRange.snap b/.forge-snapshots/CLPositionManager_collect_sameRange.snap
@@ -1 +1 @@
-214085
+214192
diff --git a/.forge-snapshots/CLPositionManager_collect_withClose.snap b/.forge-snapshots/CLPositionManager_collect_withClose.snap
@@ -1 +1 @@
-214085
+214192
diff --git a/.forge-snapshots/CLPositionManager_collect_withTakePair.snap b/.forge-snapshots/CLPositionManager_collect_withTakePair.snap
@@ -1 +1 @@
-213415
+213522
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_native.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_native.snap
@@ -1 +1 @@
-170799
+170906
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_withClose.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_withClose.snap
@@ -1 +1 @@
-179378
+179485
diff --git a/.forge-snapshots/CLPositionManager_decreaseLiquidity_withTakePair.snap b/.forge-snapshots/CLPositionManager_decreaseLiquidity_withTakePair.snap
@@ -1 +1 @@
-178708
+178815
diff --git a/.forge-snapshots/CLPositionManager_decrease_burnEmpty.snap b/.forge-snapshots/CLPositionManager_decrease_burnEmpty.snap
@@ -1 +1 @@
-186260
+186642
diff --git a/.forge-snapshots/CLPositionManager_decrease_burnEmpty_native.snap b/.forge-snapshots/CLPositionManager_decrease_burnEmpty_native.snap
@@ -1 +1 @@
-177681
+178063
diff --git a/.forge-snapshots/CLPositionManager_decrease_sameRange_allLiquidity.snap b/.forge-snapshots/CLPositionManager_decrease_sameRange_allLiquidity.snap
@@ -1 +1 @@
-192003
+192110
diff --git a/.forge-snapshots/CLPositionManager_decrease_take_take.snap b/.forge-snapshots/CLPositionManager_decrease_take_take.snap
@@ -1 +1 @@
-180045
+180152
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withClose.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withClose.snap
@@ -1 +1 @@
-220737
+220844
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withSettlePair.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_erc20_withSettlePair.snap
@@ -1 +1 @@
-219660
+219767
diff --git a/.forge-snapshots/CLPositionManager_increaseLiquidity_native.snap b/.forge-snapshots/CLPositionManager_increaseLiquidity_native.snap
@@ -1 +1 @@
-204085
+204192
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompoundExactUnclaimedFees.snap b/.forge-snapshots/CLPositionManager_increase_autocompoundExactUnclaimedFees.snap
@@ -1 +1 @@
-165603
+165710
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompoundExcessFeesCredit.snap b/.forge-snapshots/CLPositionManager_increase_autocompoundExcessFeesCredit.snap
@@ -1 +1 @@
-239098
+239205
diff --git a/.forge-snapshots/CLPositionManager_increase_autocompound_clearExcess.snap b/.forge-snapshots/CLPositionManager_increase_autocompound_clearExcess.snap
@@ -1 +1 @@
-209968
+210075
diff --git a/.forge-snapshots/CLPositionManager_mint_native.snap b/.forge-snapshots/CLPositionManager_mint_native.snap
@@ -1 +1 @@
-540268
+540375
diff --git a/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withClose.snap b/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withClose.snap
@@ -1 +1 @@
-548858
+548965
diff --git a/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withSettlePair.snap b/.forge-snapshots/CLPositionManager_mint_nativeWithSweep_withSettlePair.snap
@@ -1 +1 @@
-548065
+548172
diff --git a/.forge-snapshots/CLPositionManager_mint_onSameTickLower.snap b/.forge-snapshots/CLPositionManager_mint_onSameTickLower.snap
@@ -1 +1 @@
-393704
+393811
diff --git a/.forge-snapshots/CLPositionManager_mint_onSameTickUpper.snap b/.forge-snapshots/CLPositionManager_mint_onSameTickUpper.snap
@@ -1 +1 @@
-394141
+394248
diff --git a/.forge-snapshots/CLPositionManager_mint_sameRange.snap b/.forge-snapshots/CLPositionManager_mint_sameRange.snap
@@ -1 +1 @@
-302929
+303036
diff --git a/.forge-snapshots/CLPositionManager_mint_settleWithBalance_sweep.snap b/.forge-snapshots/CLPositionManager_mint_settleWithBalance_sweep.snap
@@ -1 +1 @@
-593126
+593233
diff --git a/.forge-snapshots/CLPositionManager_mint_warmedPool_differentRange.snap b/.forge-snapshots/CLPositionManager_mint_warmedPool_differentRange.snap
@@ -1 +1 @@
-399416
+399523
diff --git a/.forge-snapshots/CLPositionManager_mint_withClose.snap b/.forge-snapshots/CLPositionManager_mint_withClose.snap
@@ -1 +1 @@
-594160
+594267
diff --git a/.forge-snapshots/CLPositionManager_mint_withSettlePair.snap b/.forge-snapshots/CLPositionManager_mint_withSettlePair.snap
@@ -1 +1 @@
-593225
+593332
diff --git a/.forge-snapshots/CLPositionManager_multicall_initialize_mint.snap b/.forge-snapshots/CLPositionManager_multicall_initialize_mint.snap
@@ -1 +1 @@
-652143
+652250
diff --git a/.forge-snapshots/CLPositionManager_subscribe.snap b/.forge-snapshots/CLPositionManager_subscribe.snap
@@ -1 +1 @@
-87830
+87852
diff --git a/.forge-snapshots/CLPositionManager_unsubscribe.snap b/.forge-snapshots/CLPositionManager_unsubscribe.snap
@@ -1 +1 @@
-62678
+62765
diff --git a/src/pool-cl/CLPositionManager.sol b/src/pool-cl/CLPositionManager.sol
@@ -299,20 +299,34 @@ contract CLPositionManager is
 
         uint256 liquidity = uint256(_getLiquidity(tokenId, poolKey, info.tickLower(), info.tickUpper()));
 
+        address owner = ownerOf(tokenId);
+
         // Clear the position info.
         positionInfo[tokenId] = CLPositionInfoLibrary.EMPTY_POSITION_INFO;
         // Burn the token.
         _burn(tokenId);
 
         // Can only call modify if there is non zero liquidity.
+        BalanceDelta feesAccrued;
+        BalanceDelta liquidityDelta;
         if (liquidity > 0) {
-            (BalanceDelta liquidityDelta, BalanceDelta feesAccrued) =
-                _modifyLiquidity(info, poolKey, -(liquidity.toInt256()), bytes32(tokenId), hookData);
+            (liquidityDelta, feesAccrued) = clPoolManager.modifyLiquidity(
+                poolKey,
+                ICLPoolManager.ModifyLiquidityParams({
+                    tickLower: info.tickLower(),
+                    tickUpper: info.tickUpper(),
+                    liquidityDelta: -(liquidity.toInt256()),
+                    salt: bytes32(tokenId)
+                }),
+                hookData
+            );
             // Slippage checks should be done on the principal liquidityDelta which is the liquidityDelta - feesAccrued
             (liquidityDelta - feesAccrued).validateMinOut(amount0Min, amount1Min);
+
+            emit ModifyLiquidity(tokenId, -(liquidity.toInt256()), feesAccrued);
         }
 
-        if (info.hasSubscriber()) _unsubscribe(tokenId);
+        if (info.hasSubscriber()) _removeSubscriberAndNotifyBurn(tokenId, owner, info, liquidity, feesAccrued);
     }
 
     function _settlePair(Currency currency0, Currency currency1) internal {
@@ -360,6 +374,7 @@ contract CLPositionManager is
         if (balance > 0) currency.transfer(to, balance);
     }
 
+    /// @dev if there is a subscriber attached to the position, this function will notify the subscriber
     function _modifyLiquidity(
         CLPositionInfo info,
         PoolKey memory poolKey,

diff --git a/src/pool-cl/base/CLNotifier.sol b/src/pool-cl/base/CLNotifier.sol
@@ -82,6 +82,31 @@ abstract contract CLNotifier is ICLNotifier {
         emit Unsubscription(tokenId, address(_subscriber));
     }
 
+    /// @dev note this function also deletes the subscriber address from the mapping
+    function _removeSubscriberAndNotifyBurn(
+        uint256 tokenId,
+        address owner,
+        CLPositionInfo info,
+        uint256 liquidity,
+        BalanceDelta feesAccrued
+    ) internal {
+        ICLSubscriber _subscriber = subscriber[tokenId];
+
+        // remove the subscriber
+        delete subscriber[tokenId];
+
+        bool success = _call(
+            address(_subscriber),
+            abi.encodeCall(ICLSubscriber.notifyBurn, (tokenId, owner, info, liquidity, feesAccrued))
+        );
+
+        if (!success) {
+            address(_subscriber).bubbleUpAndRevertWith(
+                ICLSubscriber.notifyBurn.selector, BurnNotificationReverted.selector
+            );
+        }
+    }
+
     function _notifyModifyLiquidity(uint256 tokenId, int256 liquidityChange, BalanceDelta feesAccrued) internal {
         ICLSubscriber _subscriber = subscriber[tokenId];
 

diff --git a/src/pool-cl/interfaces/ICLNotifier.sol b/src/pool-cl/interfaces/ICLNotifier.sol
@@ -16,6 +16,8 @@ interface ICLNotifier {
     error SubscriptionReverted(address subscriber, bytes reason);
     /// @notice Wraps the revert message of the subscriber contract on a reverting modify liquidity notification
     error ModifyLiquidityNotificationReverted(address subscriber, bytes reason);
+    /// @notice Wraps the revert message of the subscriber contract on a reverting burn notification
+    error BurnNotificationReverted(address subscriber, bytes reason);
     /// @notice Wraps the revert message of the subscriber contract on a reverting transfer notification
     error TransferNotificationReverted(address subscriber, bytes reason);
     /// @notice Thrown when a tokenId already has a subscriber

diff --git a/src/pool-cl/interfaces/ICLSubscriber.sol b/src/pool-cl/interfaces/ICLSubscriber.sol
@@ -2,6 +2,7 @@
 pragma solidity ^0.8.0;
 
 import {BalanceDelta} from "pancake-v4-core/src/types/BalanceDelta.sol";
+import {CLPositionInfo} from "../libraries/CLPositionInfoLibrary.sol";
 
 /// @notice Interface that a Subscriber contract should implement to receive updates from the v4 cl pool position manager
 interface ICLSubscriber {
@@ -13,6 +14,19 @@ interface ICLSubscriber {
     /// @dev Because of EIP-150, solidity may only allocate 63/64 of gasleft()
     /// @param tokenId the token ID of the position
     function notifyUnsubscribe(uint256 tokenId) external;
+    /// @notice Called when a position is burned
+    /// @param tokenId the token ID of the position
+    /// @param owner the current owner of the tokenId
+    /// @param info information about the position
+    /// @param liquidity the amount of liquidity decreased in the position, may be 0
+    /// @param feesAccrued the fees accrued by the position if liquidity was decreased
+    function notifyBurn(
+        uint256 tokenId,
+        address owner,
+        CLPositionInfo info,
+        uint256 liquidity,
+        BalanceDelta feesAccrued
+    ) external;
     /// @param tokenId the token ID of the position
     /// @param liquidityChange the change in liquidity on the underlying position
     /// @param feesAccrued the fees to be collected from the position as a result of the modifyLiquidity call

diff --git a/test/pool-cl/mocks/MockCLBadSubscribers.sol b/test/pool-cl/mocks/MockCLBadSubscribers.sol
@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {ICLSubscriber} from "../../../src/pool-cl/interfaces/ICLSubscriber.sol";
 import {CLPositionManager} from "../../../src/pool-cl/CLPositionManager.sol";
 import {BalanceDelta} from "pancake-v4-core/src/types/BalanceDelta.sol";
+import {CLPositionInfo} from "../../../src/pool-cl/libraries/CLPositionInfoLibrary.sol";
 
 /// @notice A subscriber contract that returns values from the subscriber entrypoints
 contract MockCLReturnDataSubscriber is ICLSubscriber {
@@ -13,6 +14,7 @@ contract MockCLReturnDataSubscriber is ICLSubscriber {
     uint256 public notifyUnsubscribeCount;
     uint256 public notifyModifyLiquidityCount;
     uint256 public notifyTransferCount;
+    uint256 public notifyBurnCount;
 
     error NotAuthorizedNotifer(address sender);
 
@@ -52,6 +54,10 @@ contract MockCLReturnDataSubscriber is ICLSubscriber {
         notifyTransferCount++;
     }
 
+    function notifyBurn(uint256, address, CLPositionInfo, uint256, BalanceDelta) external {
+        notifyBurnCount++;
+    }
+
     function setReturnDataSize(uint256 _value) external {
         memPtr = _value;
     }
@@ -86,6 +92,10 @@ contract MockCLRevertSubscriber is ICLSubscriber {
         revert TestRevert("notifyUnsubscribe");
     }
 
+    function notifyBurn(uint256, address, CLPositionInfo, uint256, BalanceDelta) external {
+        revert TestRevert("notifyBurn");
+    }
+
     function notifyModifyLiquidity(uint256, int256, BalanceDelta) external view onlyByPosm {
         revert TestRevert("notifyModifyLiquidity");
     }