refactor: remove hookdata from initialize hook for both pool types

pancakeswap · Oct 10, 2024 · f9cacd0 · f9cacd0
1 parent 4fe568f
commit f9cacd0
Show file tree

Hide file tree

Showing 73 changed files with 339 additions and 405 deletions.
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-178321
+178189
diff --git a/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap
@@ -1 +1 @@
-188513
+188425
diff --git a/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap
@@ -1 +1 @@
-249529
+184774
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-311511
+311515
diff --git a/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap
@@ -1 +1 @@
-189812
+189692
diff --git a/.forge-snapshots/BinPoolManagerBytecodeSize.snap b/.forge-snapshots/BinPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-24232
+24173
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-133846
+133833
diff --git a/.forge-snapshots/BinPoolManagerTest#testExtLoadPoolActiveId.snap b/.forge-snapshots/BinPoolManagerTest#testExtLoadPoolActiveId.snap
@@ -1 +1 @@
-1870
+1877
diff --git a/.forge-snapshots/BinPoolManagerTest#testFuzzUpdateDynamicLPFee.snap b/.forge-snapshots/BinPoolManagerTest#testFuzzUpdateDynamicLPFee.snap
@@ -1 +1 @@
-32540
+32518
diff --git a/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap b/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap
@@ -1 +1 @@
-34988
+34966
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-142646
+142629
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-289677
+289662
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-127019
+127005
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-118785
+118763
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasGetBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasGetBin.snap
@@ -1 +1 @@
-4105
+4083
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-970507
+970510
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-329818
+329822
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-337827
+337829
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-140377
+140380
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-173336
+173317
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-179365
+179345
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-133367
+133348
diff --git a/.forge-snapshots/BinPoolManagerTest#testInitialize_gasCheck_withoutHooks.snap b/.forge-snapshots/BinPoolManagerTest#testInitialize_gasCheck_withoutHooks.snap
@@ -1 +1 @@
-163762
+163446
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-304784
+304787
diff --git a/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap b/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap
@@ -1 +1 @@
-34507
+34485
diff --git a/.forge-snapshots/CLPoolManagerBytecodeSize.snap b/.forge-snapshots/CLPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-21220
+21216
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-347599
+347609
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-238356
+238365
diff --git a/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap b/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap
@@ -1 +1 @@
-150645
+150173
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-131089
+131090
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-143342
+143343
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-87973
+87879
diff --git a/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap b/.forge-snapshots/CLPoolManagerTest#testFuzzUpdateDynamicLPFee.snap
@@ -1 +1 @@
-31961
+31971
diff --git a/src/pool-bin/BinPoolManager.sol b/src/pool-bin/BinPoolManager.sol
@@ -96,7 +96,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
     }
 
     /// @inheritdoc IBinPoolManager
-    function initialize(PoolKey memory key, uint24 activeId, bytes calldata hookData)
+    function initialize(PoolKey memory key, uint24 activeId)
         external
         override
         poolManagerMatch(address(key.poolManager))
@@ -121,7 +121,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
         uint24 lpFee = key.fee.getInitialLPFee();
         lpFee.validate(LPFeeLibrary.TEN_PERCENT_FEE);
 
-        BinHooks.beforeInitialize(key, activeId, hookData);
+        BinHooks.beforeInitialize(key, activeId);
 
         PoolId id = key.toId();
 
@@ -133,7 +133,7 @@ contract BinPoolManager is IBinPoolManager, ProtocolFees, Extsload {
         /// @notice Make sure the first event is noted, so that later events from afterHook won't get mixed up with this one
         emit Initialize(id, key.currency0, key.currency1, key.hooks, key.fee, key.parameters, activeId);
 
-        BinHooks.afterInitialize(key, activeId, hookData);
+        BinHooks.afterInitialize(key, activeId);
     }
 
     /// @inheritdoc IBinPoolManager

diff --git a/src/pool-bin/interfaces/IBinHooks.sol b/src/pool-bin/interfaces/IBinHooks.sol
@@ -31,21 +31,15 @@ interface IBinHooks is IHooks {
     /// @param sender The initial msg.sender for the initialize call
     /// @param key The key for the pool being initialized
     /// @param activeId The binId of the pool, when the value is 2 ** 23, token price is 1:1
-    /// @param hookData Arbitrary data handed into the PoolManager by the initializer to be be passed on to the hook
     /// @return bytes4 The function selector for the hook
-    function beforeInitialize(address sender, PoolKey calldata key, uint24 activeId, bytes calldata hookData)
-        external
-        returns (bytes4);
+    function beforeInitialize(address sender, PoolKey calldata key, uint24 activeId) external returns (bytes4);
 
     /// @notice The hook called after the state of a pool is initialized
     /// @param sender The initial msg.sender for the initialize call
     /// @param key The key for the pool being initialized
     /// @param activeId The binId of the pool, when the value is 2 ** 23, token price is 1:1
-    /// @param hookData Arbitrary data handed into the PoolManager by the initializer to be be passed on to the hook
     /// @return bytes4 The function selector for the hook
-    function afterInitialize(address sender, PoolKey calldata key, uint24 activeId, bytes calldata hookData)
-        external
-        returns (bytes4);
+    function afterInitialize(address sender, PoolKey calldata key, uint24 activeId) external returns (bytes4);
 
     /// @notice The hook called before adding liquidity
     /// @param sender The initial msg.sender for the modify position call

diff --git a/src/pool-bin/interfaces/IBinPoolManager.sol b/src/pool-bin/interfaces/IBinPoolManager.sol
@@ -167,7 +167,7 @@ interface IBinPoolManager is IProtocolFees, IPoolManager, IExtsload {
     function getNextNonEmptyBin(PoolId id, bool swapForY, uint24 binId) external view returns (uint24 nextId);
 
     /// @notice Initialize a new pool
-    function initialize(PoolKey memory key, uint24 activeId, bytes calldata hookData) external;
+    function initialize(PoolKey memory key, uint24 activeId) external;
 
     /// @notice Add liquidity to a pool
     /// @return delta BalanceDelta, will be negative indicating how much total amt0 and amt1 liquidity added

diff --git a/src/pool-bin/libraries/BinHooks.sol b/src/pool-bin/libraries/BinHooks.sol
@@ -51,19 +51,19 @@ library BinHooks {
         }
     }
 
-    function beforeInitialize(PoolKey memory key, uint24 activeId, bytes calldata hookData) internal {
+    function beforeInitialize(PoolKey memory key, uint24 activeId) internal {
         IBinHooks hooks = IBinHooks(address(key.hooks));
 
         if (key.parameters.shouldCall(HOOKS_BEFORE_INITIALIZE_OFFSET, hooks)) {
-            Hooks.callHook(hooks, abi.encodeCall(IBinHooks.beforeInitialize, (msg.sender, key, activeId, hookData)));
+            Hooks.callHook(hooks, abi.encodeCall(IBinHooks.beforeInitialize, (msg.sender, key, activeId)));
         }
     }
 
-    function afterInitialize(PoolKey memory key, uint24 activeId, bytes calldata hookData) internal {
+    function afterInitialize(PoolKey memory key, uint24 activeId) internal {
         IBinHooks hooks = IBinHooks(address(key.hooks));
 
         if (key.parameters.shouldCall(HOOKS_AFTER_INITIALIZE_OFFSET, hooks)) {
-            Hooks.callHook(hooks, abi.encodeCall(IBinHooks.afterInitialize, (msg.sender, key, activeId, hookData)));
+            Hooks.callHook(hooks, abi.encodeCall(IBinHooks.afterInitialize, (msg.sender, key, activeId)));
         }
     }
 

diff --git a/src/pool-cl/CLPoolManager.sol b/src/pool-cl/CLPoolManager.sol
@@ -83,7 +83,7 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
     }
 
     /// @inheritdoc ICLPoolManager
-    function initialize(PoolKey memory key, uint160 sqrtPriceX96, bytes calldata hookData)
+    function initialize(PoolKey memory key, uint160 sqrtPriceX96)
         external
         override
         poolManagerMatch(address(key.poolManager))
@@ -106,7 +106,7 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
         uint24 lpFee = key.fee.getInitialLPFee();
         lpFee.validate(LPFeeLibrary.ONE_HUNDRED_PERCENT_FEE);
 
-        CLHooks.beforeInitialize(key, sqrtPriceX96, hookData);
+        CLHooks.beforeInitialize(key, sqrtPriceX96);
 
         PoolId id = key.toId();
         uint24 protocolFee = _fetchProtocolFee(key);
@@ -117,7 +117,7 @@ contract CLPoolManager is ICLPoolManager, ProtocolFees, Extsload {
         /// @notice Make sure the first event is noted, so that later events from afterHook won't get mixed up with this one
         emit Initialize(id, key.currency0, key.currency1, key.hooks, key.fee, key.parameters, sqrtPriceX96, tick);
 
-        CLHooks.afterInitialize(key, sqrtPriceX96, tick, hookData);
+        CLHooks.afterInitialize(key, sqrtPriceX96, tick);
     }
 
     /// @inheritdoc ICLPoolManager

diff --git a/src/pool-cl/interfaces/ICLHooks.sol b/src/pool-cl/interfaces/ICLHooks.sol
@@ -32,27 +32,18 @@ interface ICLHooks is IHooks {
     /// @param sender The initial msg.sender for the initialize call
     /// @param key The key for the pool being initialized
     /// @param sqrtPriceX96 The sqrt(price) of the pool as a Q64.96
-    /// @param hookData Arbitrary data handed into the PoolManager by the initializer to be be passed on to the hook
     /// @return bytes4 The function selector for the hook
-
-    function beforeInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96, bytes calldata hookData)
-        external
-        returns (bytes4);
+    function beforeInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96) external returns (bytes4);
 
     /// @notice The hook called after the state of a pool is initialized
     /// @param sender The initial msg.sender for the initialize call
     /// @param key The key for the pool being initialized
     /// @param sqrtPriceX96 The sqrt(price) of the pool as a Q64.96
     /// @param tick The current tick after the state of a pool is initialized
-    /// @param hookData Arbitrary data handed into the PoolManager by the initializer to be be passed on to the hook
     /// @return bytes4 The function selector for the hook
-    function afterInitialize(
-        address sender,
-        PoolKey calldata key,
-        uint160 sqrtPriceX96,
-        int24 tick,
-        bytes calldata hookData
-    ) external returns (bytes4);
+    function afterInitialize(address sender, PoolKey calldata key, uint160 sqrtPriceX96, int24 tick)
+        external
+        returns (bytes4);
 
     /// @notice The hook called before liquidity is added
     /// @param sender The initial msg.sender for the add liquidity call

diff --git a/src/pool-cl/interfaces/ICLPoolManager.sol b/src/pool-cl/interfaces/ICLPoolManager.sol
@@ -120,9 +120,7 @@ interface ICLPoolManager is IProtocolFees, IPoolManager, IExtsload {
         returns (CLPosition.Info memory position);
 
     /// @notice Initialize the state for a given pool ID
-    function initialize(PoolKey memory key, uint160 sqrtPriceX96, bytes calldata hookData)
-        external
-        returns (int24 tick);
+    function initialize(PoolKey memory key, uint160 sqrtPriceX96) external returns (int24 tick);
 
     struct ModifyLiquidityParams {
         // the lower and upper tick of the position

diff --git a/src/pool-cl/libraries/CLHooks.sol b/src/pool-cl/libraries/CLHooks.sol
@@ -50,21 +50,19 @@ library CLHooks {
         }
     }
 
-    function beforeInitialize(PoolKey memory key, uint160 sqrtPriceX96, bytes calldata hookData) internal {
+    function beforeInitialize(PoolKey memory key, uint160 sqrtPriceX96) internal {
         ICLHooks hooks = ICLHooks(address(key.hooks));
 
         if (key.parameters.shouldCall(HOOKS_BEFORE_INITIALIZE_OFFSET, hooks)) {
-            Hooks.callHook(hooks, abi.encodeCall(ICLHooks.beforeInitialize, (msg.sender, key, sqrtPriceX96, hookData)));
+            Hooks.callHook(hooks, abi.encodeCall(ICLHooks.beforeInitialize, (msg.sender, key, sqrtPriceX96)));
         }
     }
 
-    function afterInitialize(PoolKey memory key, uint160 sqrtPriceX96, int24 tick, bytes calldata hookData) internal {
+    function afterInitialize(PoolKey memory key, uint160 sqrtPriceX96, int24 tick) internal {
         ICLHooks hooks = ICLHooks(address(key.hooks));
 
         if (key.parameters.shouldCall(HOOKS_AFTER_INITIALIZE_OFFSET, hooks)) {
-            Hooks.callHook(
-                hooks, abi.encodeCall(ICLHooks.afterInitialize, (msg.sender, key, sqrtPriceX96, tick, hookData))
-            );
+            Hooks.callHook(hooks, abi.encodeCall(ICLHooks.afterInitialize, (msg.sender, key, sqrtPriceX96, tick)));
         }
     }
 

diff --git a/src/test/MockFeePoolManager.sol b/src/test/MockFeePoolManager.sol
@@ -25,7 +25,7 @@ contract MockFeePoolManager is ProtocolFees {
 
     constructor(IVault vault, uint256 controllerGasLimit) ProtocolFees(vault) {}
 
-    function initialize(PoolKey memory key, bytes calldata) external {
+    function initialize(PoolKey memory key) external {
         PoolId id = key.toId();
 
         uint24 protocolFee = _fetchProtocolFee(key);

diff --git a/src/test/fee/MockFeeManagerHook.sol b/src/test/fee/MockFeeManagerHook.sol
@@ -29,7 +29,7 @@ contract MockFeeManagerHook is IHooks {
     }
 
     // swap fee for dynamic fee pool is 0 by default, so we need to update it after pool initialization
-    function afterInitialize(address, PoolKey calldata key, uint24, bytes calldata) external returns (bytes4) {
+    function afterInitialize(address, PoolKey calldata key, uint24) external returns (bytes4) {
         IBinPoolManager(msg.sender).updateDynamicLPFee(key, swapfee);
         return MockFeeManagerHook.afterInitialize.selector;
     }

diff --git a/src/test/pool-bin/MockBinHooks.sol b/src/test/pool-bin/MockBinHooks.sol
@@ -12,8 +12,6 @@ import {PoolId} from "../../types/PoolId.sol";
 contract MockBinHooks is IBinHooks {
     using Hooks for IBinHooks;
 
-    bytes public beforeInitializeData;
-    bytes public afterInitializeData;
     bytes public beforeMintData;
     bytes public afterMintData;
     bytes public beforeSwapData;
@@ -35,18 +33,12 @@ contract MockBinHooks is IBinHooks {
         return bitmap;
     }
 
-    function beforeInitialize(address, PoolKey calldata, uint24, bytes calldata hookData) external returns (bytes4) {
-        beforeInitializeData = hookData;
+    function beforeInitialize(address, PoolKey calldata, uint24) external returns (bytes4) {
         bytes4 selector = MockBinHooks.beforeInitialize.selector;
         return returnValues[selector] == bytes4(0) ? selector : returnValues[selector];
     }
 
-    function afterInitialize(address, PoolKey calldata, uint24, bytes calldata hookData)
-        external
-        override
-        returns (bytes4)
-    {
-        afterInitializeData = hookData;
+    function afterInitialize(address, PoolKey calldata, uint24) external override returns (bytes4) {
         bytes4 selector = MockBinHooks.afterInitialize.selector;
         return returnValues[selector] == bytes4(0) ? selector : returnValues[selector];
     }