feat: Add events and methods for off-chain farming

pancakeswap · Apr 16, 2024 · 61a33d3 · 61a33d3
1 parent a3cf6ea
commit 61a33d3
Show file tree

Hide file tree

Showing 15 changed files with 34 additions and 13 deletions.
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-348804
+350133
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-59352
+60681
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-242397
+243726
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-42330
+43659
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-54822
+54779
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-102898
+102855
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-25042646
+25042603
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-36022
+35979
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-101660
+101617
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-41672
+41629
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-36025
+35982
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap
@@ -1 +1 @@
-21667
+21624
diff --git a/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap b/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap
@@ -1 +1 @@
-11352
+11397
diff --git a/src/pool-cl/CLPoolManager.sol b/src/pool-cl/CLPoolManager.sol
@@ -302,6 +302,14 @@ contract CLPoolManager is ICLPoolManager, Fees, Extsload {
         return pools[id].tickBitmap[word];
     }
 
+    function getPoolFeeGrowthInside(PoolId id, int24 tickLower, int24 tickUpper)
+        external
+        view
+        returns (uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128)
+    {
+        return pools[id].getFeeGrowthInside(tickLower, tickUpper);
+    }
+
     /// @inheritdoc ICLPoolManager
     function setMasterChef(address _masterChef) external override onlyOwner {
         masterChef = _masterChef;

diff --git a/src/pool-cl/libraries/CLPool.sol b/src/pool-cl/libraries/CLPool.sol
@@ -42,6 +42,9 @@ library CLPool {
     /// @notice Thrown by donate if there is currently 0 liquidity, since the fees will not go to any liquidity providers
     error NoLiquidityToReceiveFees();
 
+    /// @dev for off-chain farming
+    event SwapFees(uint256 feesOwed0, uint256 feesOwed1);
+
     struct Slot0 {
         // the current price
         uint160 sqrtPriceX96;
@@ -110,6 +113,8 @@ library CLPool {
         Tick.checkTicks(params.tickLower, params.tickUpper);
 
         (uint256 feesOwed0, uint256 feesOwed1) = _updatePosition(self, params, _slot0.tick);
+        // @dev track swap fees for off-chain farming
+        emit SwapFees(feesOwed0, feesOwed1);
 
         ///@dev calculate the tokens delta needed
         if (params.liquidityDelta != 0) {
@@ -490,4 +495,12 @@ library CLPool {
     function isNotInitialized(State storage self) internal view returns (bool) {
         return self.slot0.sqrtPriceX96 == 0;
     }
+
+    function getFeeGrowthInside(State storage self, int24 tickLower, int24 tickUpper)
+        internal
+        view
+        returns (uint256 feeGrowthInside0X128, uint256 feeGrowthInside1X128)
+    {
+        return self.ticks.getFeeGrowthInside(tickLower, tickUpper, self.slot0.tick, self.feeGrowthGlobal0X128, self.feeGrowthGlobal1X128);
+    }
 }