feat: add pausable (#10)

ChefMist · web-flow · commit 02e4b3049896 · 2024-04-08T16:24:51.000+08:00
* feat: add pausable

* refactor: Remove unused imports in IPausableRole

* refactor: Tweak to !hasPausableRole[msg.sender]
diff --git a/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testBurnSucceedsWithHook.snap
@@ -1 +1 @@
-143677
+143699
diff --git a/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testDonateSucceedsWithHook.snap
@@ -1 +1 @@
-134868
+134890
diff --git a/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testInitializeSucceedsWithHook.snap
@@ -1 +1 @@
-109021
+109043
diff --git a/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testMintSucceedsWithHook.snap
@@ -1 +1 @@
-298905
+298927
diff --git a/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap b/.forge-snapshots/BinHookTest#testSwapSucceedsWithHook.snap
@@ -1 +1 @@
-141089
+141133
diff --git a/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testBurnNativeCurrency.snap
@@ -1 +1 @@
-92245
+92267
diff --git a/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap b/.forge-snapshots/BinPoolManagerTest#testFuzz_SetMaxBinStep.snap
@@ -1 +1 @@
-9201
+9179
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnHalfBin.snap
@@ -1 +1 @@
-67437
+67459
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnNineBins.snap
@@ -1 +1 @@
-150992
+151014
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasBurnOneBin.snap
@@ -1 +1 @@
-68616
+68638
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap b/.forge-snapshots/BinPoolManagerTest#testGasDonate.snap
@@ -1 +1 @@
-53952
+53974
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-1.snap
@@ -1 +1 @@
-968047
+968069
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintNneBins-2.snap
@@ -1 +1 @@
-121561
+121583
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-1.snap
@@ -1 +1 @@
-337237
+337259
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap b/.forge-snapshots/BinPoolManagerTest#testGasMintOneBin-2.snap
@@ -1 +1 @@
-56298
+56320
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapMultipleBins.snap
@@ -1 +1 @@
-93040
+93084
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapOverBigBinIdGate.snap
@@ -1 +1 @@
-95025
+95069
diff --git a/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap b/.forge-snapshots/BinPoolManagerTest#testGasSwapSingleBin.snap
@@ -1 +1 @@
-74469
+74513
diff --git a/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap b/.forge-snapshots/BinPoolManagerTest#testMintNativeCurrency.snap
@@ -1 +1 @@
-318945
+318967
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Burn.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Burn.snap
@@ -1 +1 @@
-41876
+41898
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Donate.snap
@@ -1 +1 @@
-19493
+19515
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Initialize.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Initialize.snap
@@ -1 +1 @@
-37221
+37243
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Mint.snap
@@ -1 +1 @@
-37345
+37367
diff --git a/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap b/.forge-snapshots/BinPoolManagerTest#testNoOpGas_Swap.snap
@@ -1 +1 @@
-22699
+22743
diff --git a/.forge-snapshots/BinPoolManagerTest#testSetMasterChef.snap b/.forge-snapshots/BinPoolManagerTest#testSetMasterChef.snap
@@ -1 +1 @@
-24243
+24265
diff --git a/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap b/.forge-snapshots/BinPoolManagerTest#testSetProtocolFee.snap
@@ -1 +1 @@
-8126
+8148
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromEmpty.snap
@@ -1 +1 @@
-348452
+350592
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_fromNonEmpty.snap
@@ -1 +1 @@
-61000
+61140
diff --git a/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap b/.forge-snapshots/CLPoolManagerTest#addLiquidity_nativeToken.snap
@@ -1 +1 @@
-241390
+243530
diff --git a/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap b/.forge-snapshots/CLPoolManagerTest#donateBothTokens.snap
@@ -1 +1 @@
-84138
+84302
diff --git a/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap b/.forge-snapshots/CLPoolManagerTest#gasDonateOneToken.snap
@@ -1 +1 @@
-53445
+53609
diff --git a/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap b/.forge-snapshots/CLPoolManagerTest#initializeWithoutHooks.snap
@@ -1 +1 @@
-36477
+36544
diff --git a/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap b/.forge-snapshots/CLPoolManagerTest#removeLiquidity_toNonEmpty.snap
@@ -1 +1 @@
-43322
+43462
diff --git a/.forge-snapshots/CLPoolManagerTest#setLmPool.snap b/.forge-snapshots/CLPoolManagerTest#setLmPool.snap
@@ -1 +1 @@
-26294
+26272
diff --git a/.forge-snapshots/CLPoolManagerTest#setMasterChef.snap b/.forge-snapshots/CLPoolManagerTest#setMasterChef.snap
@@ -1 +1 @@
-30760
+30715
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_againstLiquidity.snap
@@ -1 +1 @@
-56445
+56609
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap b/.forge-snapshots/CLPoolManagerTest#swap_leaveSurplusTokenInVault.snap
@@ -1 +1 @@
-104543
+104707
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap b/.forge-snapshots/CLPoolManagerTest#swap_runOutOfLiquidity.snap
@@ -1 +1 @@
-25044269
+25044433
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_simple.snap b/.forge-snapshots/CLPoolManagerTest#swap_simple.snap
@@ -1 +1 @@
-36336
+36500
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap b/.forge-snapshots/CLPoolManagerTest#swap_useSurplusTokenAsInput.snap
@@ -1 +1 @@
-103041
+103205
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap b/.forge-snapshots/CLPoolManagerTest#swap_withHooks.snap
@@ -1 +1 @@
-41986
+42150
diff --git a/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap b/.forge-snapshots/CLPoolManagerTest#swap_withNative.snap
@@ -1 +1 @@
-36339
+36503
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Donate.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Donate.snap
@@ -1 +1 @@
-19448
+19612
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Initialize.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Initialize.snap
@@ -1 +1 @@
-37427
+37494
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_ModifyPosition.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_ModifyPosition.snap
@@ -1 +1 @@
-27615
+29755
diff --git a/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap b/.forge-snapshots/CLPoolManagerTest#testNoOp_gas_Swap.snap
@@ -1 +1 @@
-21897
+22061
diff --git a/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap b/.forge-snapshots/ExtsloadTest#extsloadInBatch.snap
@@ -1 +1 @@
-11418
+11352
diff --git a/src/Fees.sol b/src/Fees.sol
@@ -2,15 +2,14 @@
 // Copyright (C) 2024 PancakeSwap
 pragma solidity ^0.8.24;
 
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-
+import {PausableRole} from "./PausableRole.sol";
 import {Currency} from "./types/Currency.sol";
 import {IProtocolFeeController} from "./interfaces/IProtocolFeeController.sol";
 import {IFees} from "./interfaces/IFees.sol";
 import {PoolKey} from "./types/PoolKey.sol";
 import {IVault} from "./interfaces/IVault.sol";
 
-abstract contract Fees is IFees, Ownable {
+abstract contract Fees is IFees, PausableRole {
     uint8 public constant MIN_PROTOCOL_FEE_DENOMINATOR = 4;
 
     mapping(Currency currency => uint256) public protocolFeesAccrued;
diff --git a/src/PausableRole.sol b/src/PausableRole.sol
@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+// Copyright (C) 2024 PancakeSwap
+pragma solidity ^0.8.24;
+
+import {IPausableRole} from "./interfaces/IPausableRole.sol";
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {Pausable} from "@openzeppelin/contracts/security/Pausable.sol";
+
+/// @notice Allow owner and multiple accounts to pause but only owner can unpause
+/// @dev Potentially allow security partners to programatically pause()
+abstract contract PausableRole is IPausableRole, Ownable, Pausable {
+    mapping(address => bool) public hasPausableRole;
+
+    modifier onlyPausableRoleOrOwner() {
+        if (msg.sender != owner() && !hasPausableRole[msg.sender]) revert NoPausableRole();
+        _;
+    }
+
+    function pause() public override onlyPausableRoleOrOwner {
+        _pause();
+    }
+
+    function unpause() public override onlyOwner {
+        _unpause();
+    }
+
+    function grantPausableRole(address account) public override onlyOwner {
+        hasPausableRole[account] = true;
+        emit PausableRoleGranted(account);
+    }
+
+    function revokePausableRole(address account) public override onlyOwner {
+        hasPausableRole[account] = false;
+        emit PausableRoleRevoked(account);
+    }
+}
diff --git a/src/interfaces/IPausableRole.sol b/src/interfaces/IPausableRole.sol
@@ -0,0 +1,22 @@
+//SPDX-License-Identifier: MIT
+pragma solidity ^0.8.24;
+
+interface IPausableRole {
+    /// @notice Thrown when the caller does not have the pausable role or is not owner
+    error NoPausableRole();
+
+    event PausableRoleGranted(address indexed account);
+    event PausableRoleRevoked(address indexed account);
+
+    /// @notice Pause the contract, called by the owner or an account with the pausable role
+    function pause() external;
+
+    /// @notice Unpause the contract, called by the owner
+    function unpause() external;
+
+    /// @notice Grant the pausable role to an account, called by the owner
+    function grantPausableRole(address account) external;
+
+    /// @notice Revoke the pausable role to an account, called by the owner
+    function revokePausableRole(address account) external;
+}
diff --git a/src/pool-cl/CLPoolManager.sol b/src/pool-cl/CLPoolManager.sol
@@ -137,6 +137,9 @@ contract CLPoolManager is ICLPoolManager, Fees, Extsload {
         ICLPoolManager.ModifyLiquidityParams memory params,
         bytes calldata hookData
     ) external override poolManagerMatch(address(key.poolManager)) returns (BalanceDelta delta) {
+        // Do not allow add liquidity when paused()
+        if (paused() && params.liquidityDelta > 0) revert PoolPaused();
+
         PoolId id = key.toId();
         _checkPoolInitialized(id);
 
@@ -196,6 +199,7 @@ contract CLPoolManager is ICLPoolManager, Fees, Extsload {
         external
         override
         poolManagerMatch(address(key.poolManager))
+        whenNotPaused
         returns (BalanceDelta delta)
     {
         PoolId id = key.toId();
@@ -258,6 +262,7 @@ contract CLPoolManager is ICLPoolManager, Fees, Extsload {
         external
         override
         poolManagerMatch(address(key.poolManager))
+        whenNotPaused
         returns (BalanceDelta delta)
     {
         PoolId id = key.toId();
diff --git a/src/pool-cl/interfaces/ICLPoolManager.sol b/src/pool-cl/interfaces/ICLPoolManager.sol
@@ -21,6 +21,8 @@ interface ICLPoolManager is IFees, IPoolManager, IExtsload {
     error TickSpacingTooSmall();
     /// @notice Error thrown when Unauthorized caller
     error UnauthorizedCaller();
+    /// @notice Error thrown when add liquidity is called when paused()
+    error PoolPaused();
 
     /// @notice Emitted when a new pool is initialized
     /// @param id The abi encoded hash of the pool key struct for the new pool
diff --git a/test/Extsload.t.sol b/test/Extsload.t.sol
@@ -11,10 +11,11 @@ import {IProtocolFeeController} from "../src/interfaces/IProtocolFeeController.s
 
 contract ExtsloadTest is Test, GasSnapshot {
     // Slot
-    // 0	 	PoolManager#Ownable#_owner
-    // 1	 	PooAlManager#Fees#protocolFeesAccrued
-    // 2		PooAlManager#Fees#protocolFeeController
-    // 3 		PooAlManager#pools
+    // 0	 	PoolManager#PausableRole#Pausable#_paused and PooAlManager#PausableRole#Ownable#_owner
+    // 1	 	PoolManager#PausableRole#hasPausableRole
+    // 2	 	PooAlManager#Fees#protocolFeesAccrued
+    // 3		PooAlManager#Fees#protocolFeeController
+    // 4 		PooAlManager#pools
     ICLPoolManager poolManager;
 
     function setUp() public {
@@ -25,19 +26,21 @@ contract ExtsloadTest is Test, GasSnapshot {
     }
 
     function testExtsload() public {
+        // as contract is not paused, slot0 is 0x0...0_owner_address,
+        // if paused, slot0 is 0x0...1_owner_address
         snapStart("ExtsloadTest#extsload");
         bytes32 slot0 = poolManager.extsload(0x00);
         snapEnd();
         assertEq(abi.encode(slot0), abi.encode(address(this)));
 
-        bytes32 slot2 = poolManager.extsload(bytes32(uint256(0x02)));
-        assertEq(abi.encode(slot2), abi.encode(address(0xabcd)));
+        bytes32 slot3 = poolManager.extsload(bytes32(uint256(0x03)));
+        assertEq(abi.encode(slot3), abi.encode(address(0xabcd)));
     }
 
     function testExtsloadInBatch() public {
         bytes32[] memory slots = new bytes32[](2);
         slots[0] = 0x00;
-        slots[1] = bytes32(uint256(0x02));
+        slots[1] = bytes32(uint256(0x03));
         snapStart("ExtsloadTest#extsloadInBatch");
         slots = poolManager.extsload(slots);
         snapEnd();
diff --git a/test/PausableRole.t.sol b/test/PausableRole.t.sol
diff --git a/test/pool-bin/BinPoolManager.t.sol b/test/pool-bin/BinPoolManager.t.sol
diff --git a/test/pool-cl/CLPoolManager.t.sol b/test/pool-cl/CLPoolManager.t.sol
