feat: fix all existing test cases with min share burned

pancakeswap · Nov 12, 2024 · a12fab0 · a12fab0
1 parent 0c924e1
commit a12fab0
Show file tree

Hide file tree

Showing 8 changed files with 479 additions and 442 deletions.
diff --git a/.forge-snapshots/BinCustomCurveHookTest#test_Swap_CustomCurve.snap b/.forge-snapshots/BinCustomCurveHookTest#test_Swap_CustomCurve.snap
@@ -1 +1 @@
-142478
+142466
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasGetBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasGetBin.snap
@@ -1 +1 @@
-3978
+4061
diff --git a/src/pool-bin/libraries/BinPool.sol b/src/pool-bin/libraries/BinPool.sol
@@ -471,6 +471,8 @@ library BinPool {
     }
 
     /// @notice Add share to user's position and update total share supply of bin
+    /// @dev if bin is empty, deduct MINIMUM_SHARE from shares
+    /// @return userShareAdded The amount of share added to user's position
     function _addShare(State storage self, address owner, uint24 binId, bytes32 salt, uint256 shares)
         internal
         returns (uint256 userShareAdded)

diff --git a/test/pool-bin/BinHookReturnsDelta.t.sol b/test/pool-bin/BinHookReturnsDelta.t.sol
@@ -127,7 +127,7 @@ contract BinHookReturnsDelta is Test, GasSnapshot, BinTestHelper {
         binLiquidityHelper.burn(key, burnParams, "");
 
         (uint128 reserveXAfter, uint128 reserveYAfter,,) = poolManager.getBin(key.toId(), activeId);
-        // reserve non zero due to min liquidity locked up in the bin
+        // reserve non zero due to min liquidity (1e3) locked up in the bin
         assertEq(reserveXAfter, 1);
         assertEq(reserveYAfter, 1);
         assertEq(token0.balanceOf(address(binReturnsDeltaHook)), 0.1 ether - 1);

diff --git a/test/pool-bin/BinMintBurnFeeHook.t.sol b/test/pool-bin/BinMintBurnFeeHook.t.sol
@@ -120,14 +120,16 @@ contract BinMintBurnFeeHookTest is Test, GasSnapshot, BinTestHelper {
         binLiquidityHelper.burn(key, burnParams, "");
         snapEnd();
 
-        // the +3/-4 is just from min_liquidity amount
-        // +1 from remove liqudiity, -4 from hook fee
+        // +1 eth from remove liqudiity, -4 eth from hook fee
+        // +3 from min_liquidity amount as -1 (min_liquidity) + 1 * 4 (fee)
         assertEq(token0.balanceOf(address(this)), 7 ether + 1 ether - 4 ether + 3);
         assertEq(token1.balanceOf(address(this)), 7 ether + 1 ether - 4 ether + 3);
 
-        // -1 from remove liquidity, +4 from hook calling vault.mint
+        // -1 eth from remove liquidity, +4 eth from hook calling vault.mint
         assertEq(token0.balanceOf(address(vault)), 3 ether - 1 ether + 4 ether - 3);
         assertEq(token1.balanceOf(address(vault)), 3 ether - 1 ether + 4 ether - 3);
+
+        // -4 as due to min_liquidity = 1, hook took 4 token less fee
         assertEq(vault.balanceOf(address(binMintBurnFeeHook), key.currency0), 2 ether + 4 ether - 4);
         assertEq(vault.balanceOf(address(binMintBurnFeeHook), key.currency1), 2 ether + 4 ether - 4);
     }

diff --git a/test/pool-bin/BinPoolManager.t.sol b/test/pool-bin/BinPoolManager.t.sol