feat: example of option 1

pancakeswap · Nov 11, 2024 · a761527 · a761527
1 parent 15b5220
commit a761527
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 10 deletions.
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-178130
+178365
diff --git a/.forge-snapshots/BinMintBurnFeeHookTest#test_Burn.snap b/.forge-snapshots/BinMintBurnFeeHookTest#test_Burn.snap
@@ -1 +1 @@
-170145
+170380
diff --git a/.forge-snapshots/BinPoolManagerBytecodeSize.snap b/.forge-snapshots/BinPoolManagerBytecodeSize.snap
@@ -1 +1 @@
-23287
+23381
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-133892
+134080
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-142717
+142975
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-289683
+291375
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-127065
+127253
diff --git a/.forge-snapshots/CLCustomCurveHookTest#test_Swap_CustomCurve.snap b/.forge-snapshots/CLCustomCurveHookTest#test_Swap_CustomCurve.snap
@@ -1 +1 @@
-149710
+149698
diff --git a/src/pool-bin/libraries/BinPool.sol b/src/pool-bin/libraries/BinPool.sol
@@ -48,6 +48,7 @@ library BinPool {
     error BinPool__NoLiquidityToReceiveFees();
     /// @dev if swap exactIn, x for y, unspecifiedToken = token y. if swap x for exact out y, unspecified token is x
     error BinPool__InsufficientAmountUnSpecified();
+    error BinPool__BelowMinimumShareInBurn(uint256 balanceShare);
 
     /// @dev The state of a pool
     struct State {
@@ -66,6 +67,9 @@ library BinPool {
         mapping(bytes32 => bytes32) level2;
     }
 
+    /// @dev when liquidity is removed, ensure there is either greater than min_share or 0 liquidity left
+    uint256 constant MINIMUM_SHARE = 1e3;
+
     function initialize(State storage self, uint24 activeId, uint24 protocolFee, uint24 lpFee) internal {
         /// An initialized pool will not have activeId: 0
         if (self.slot0.activeId() != 0) revert PoolAlreadyInitialized();
@@ -464,6 +468,11 @@ library BinPool {
     function _subShare(State storage self, address owner, uint24 binId, bytes32 salt, uint256 shares) internal {
         self.positions.get(owner, binId, salt).subShare(shares);
         self.shareOfBin[binId] -= shares;
+
+        uint256 balanceShare = self.shareOfBin[binId];
+        if (balanceShare > 0 && balanceShare < MINIMUM_SHARE) {
+            revert BinPool__BelowMinimumShareInBurn(balanceShare);
+        }
     }
 
     /// @notice Add share to user's position and update total share supply of bin

diff --git a/test/pool-bin/libraries/BinPoolDonate.t.sol b/test/pool-bin/libraries/BinPoolDonate.t.sol
@@ -61,8 +61,9 @@ contract BinPoolDonateTest is BinTestHelper {
         poolManager.initialize(key, activeId);
         addLiquidityToBin(key, poolManager, alice, activeId, 1e18, 1e18, 1e18, 1e18, "");
 
-        // Remove all share leaving less than MIN_LIQUIDITY_BEFORE_DONATE shares
-        remainingShare = bound(remainingShare, 1, poolManager.minBinShareForDonate() - 1);
+        /// @dev Remove all share leaving between 1e3 and minShareForDinate
+        /// if its less than 1e3, it will throw BinPool__BelowMinimumShareInBurn error
+        remainingShare = bound(remainingShare, 1e3, poolManager.minBinShareForDonate() - 1);
         uint256 aliceShare = poolManager.getPosition(poolId, alice, activeId, 0).share;
         removeLiquidityFromBin(key, poolManager, alice, activeId, aliceShare - remainingShare, "");