feat: Add pause to BinPoolManager

pancakeswap · Apr 8, 2024 · 84de2e2 · 84de2e2
1 parent 09f70b7
commit 84de2e2
Show file tree

Hide file tree

Showing 17 changed files with 101 additions and 15 deletions.
diff --git a/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap
@@ -1 +1 @@
-134890
+135032
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-298927
+301069
diff --git a/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap
@@ -1 +1 @@
-141133
+141275
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-53974
+54221
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-968069
+970211
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-121583
+121725
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-337259
+339401
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-56320
+56462
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-93084
+93238
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-95069
+95223
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-74513
+74667
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-318967
+321109
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap
@@ -1 +1 @@
-19515
+19774
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap
@@ -1 +1 @@
-37367
+39509
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap
@@ -1 +1 @@
-22743
+22897
diff --git a/src/pool-bin/BinPoolManager.sol b/src/pool-bin/BinPoolManager.sol
@@ -140,6 +140,7 @@ contract BinPoolManager is IBinPoolManager, Fees, Extsload {
         external
         override
         poolManagerMatch(address(key.poolManager))
+        whenNotPaused
         returns (BalanceDelta delta)
     {
         PoolId id = key.toId();
@@ -241,6 +242,7 @@ contract BinPoolManager is IBinPoolManager, Fees, Extsload {
         external
         override
         poolManagerMatch(address(key.poolManager))
+        whenNotPaused
         returns (BalanceDelta delta, BinPool.MintArrays memory mintArray)
     {
         PoolId id = key.toId();
@@ -329,6 +331,7 @@ contract BinPoolManager is IBinPoolManager, Fees, Extsload {
         external
         override
         poolManagerMatch(address(key.poolManager))
+        whenNotPaused
         returns (BalanceDelta delta, uint24 binId)
     {
         PoolId id = key.toId();

diff --git a/test/pool-bin/BinPoolManager.t.sol b/test/pool-bin/BinPoolManager.t.sol
@@ -821,6 +821,89 @@ contract BinPoolManagerTest is Test, GasSnapshot, BinTestHelper {
         vm.stopPrank();
     }
 
+    function testSwap_WhenPaused() public {
+        BinSwapHelper.TestSettings memory testSettings;
+
+        // initialize the pool
+        poolManager.initialize(key, activeId, new bytes(0));
+
+        // mint
+        token0.mint(address(this), 10 ether);
+        token1.mint(address(this), 10 ether);
+        IBinPoolManager.MintParams memory mintParams = _getSingleBinMintParams(activeId, 10 ether, 10 ether);
+        binLiquidityHelper.mint(key, mintParams, "");
+
+        // pause
+        poolManager.pause();
+
+        // attempt swap
+        token0.mint(address(this), 1 ether);
+        vm.expectRevert("Pausable: paused");
+        testSettings = BinSwapHelper.TestSettings({withdrawTokens: false, settleUsingTransfer: true});
+        binSwapHelper.swap(key, true, 1 ether, testSettings, "");
+    }
+
+    function testMint_WhenPaused() public {
+        token0.mint(address(this), 1 ether);
+        token1.mint(address(this), 1 ether);
+
+        poolManager.initialize(key, activeId, new bytes(0));
+        IBinPoolManager.MintParams memory mintParams;
+
+        // add 1 eth of tokenX and 1 eth of tokenY liquidity at activeId
+        mintParams = _getSingleBinMintParams(activeId, 1 ether, 1 ether);
+
+        // pause
+        poolManager.pause();
+
+        vm.expectRevert("Pausable: paused");
+        binLiquidityHelper.mint(key, mintParams, "");
+    }
+
+    // verify remove liquidity is fine when paused
+    function testBurn_WhenPaused() public {
+        // initialize
+        poolManager.initialize(key, activeId, new bytes(0));
+
+        // mint
+        token0.mint(address(this), 2 ether);
+        token1.mint(address(this), 2 ether);
+        IBinPoolManager.MintParams memory mintParams = _getSingleBinMintParams(activeId, 1 ether, 1 ether);
+        binLiquidityHelper.mint(key, mintParams, "");
+
+        // pause
+        poolManager.pause();
+
+        // burn
+        IBinPoolManager.BurnParams memory burnParams =
+            _getSingleBinBurnLiquidityParams(key, poolManager, activeId, address(binLiquidityHelper), 100);
+
+        uint256[] memory ids = new uint256[](1);
+        bytes32[] memory amounts = new bytes32[](1);
+        ids[0] = activeId;
+        amounts[0] = uint128(1e18).encode(uint128(1e18));
+
+        // verify no issue even when pause
+        binLiquidityHelper.burn(key, burnParams, "");
+    }
+
+    function testDonate_WhenPaused() public {
+        poolManager.initialize(key, activeId, new bytes(0));
+
+        token0.mint(address(this), 11 ether);
+        token1.mint(address(this), 11 ether);
+
+        // add 1 eth of tokenX and 1 eth of tokenY liquidity at activeId
+        IBinPoolManager.MintParams memory mintParams = _getSingleBinMintParams(activeId, 1 ether, 1 ether);
+        binLiquidityHelper.mint(key, mintParams, "");
+
+        // pause
+        poolManager.pause();
+
+        vm.expectRevert("Pausable: paused");
+        binDonateHelper.donate(key, 10 ether, 10 ether, "");
+    }
+
     receive() external payable {}
 
     function supportsInterface(bytes4) external pure returns (bool) {