vacp2p/linea-monorepo
1
0
Fork 0
mirror of https://github.com/vacp2p/linea-monorepo.git synced 2026-01-09 20:27:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

did natspec for TokenBridgePauseManager (#379)

Browse Source
This commit is contained in:
kyzooghost
2024-12-04 19:58:49 +11:00
committed by GitHub
parent 5fa9eb9bc4
commit 7778380871
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
contracts/contracts/lib/TokenBridgePauseManager.sol
View File

@@ -9,8 +9,15 @@ import { PauseManager } from "./PauseManager.sol";
* @custom:security-contact security-report@linea.build
*/
abstract contract TokenBridgePauseManager is PauseManager {
/// @notice This is used to pause token bridging initiation.
bytes32 public constant PAUSE_INITIATE_TOKEN_BRIDGING_ROLE = keccak256("PAUSE_INITIATE_TOKEN_BRIDGING_ROLE");
/// @notice This is used to unpause token bridging initiation.
bytes32 public constant UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE = keccak256("UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE");
/// @notice This is used to pause token bridging completion.
bytes32 public constant PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE = keccak256("PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE");
/// @notice This is used to unpause token bridging completion.
bytes32 public constant UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE = keccak256("UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE");
}

8
contracts/docs/api/lib/TokenBridgePauseManager.md
View File

@@ -8,21 +8,29 @@
bytes32 PAUSE_INITIATE_TOKEN_BRIDGING_ROLE
```
This is used to pause token bridging initiation.
### UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE
```solidity
bytes32 UNPAUSE_INITIATE_TOKEN_BRIDGING_ROLE
```
This is used to unpause token bridging initiation.
### PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
```solidity
bytes32 PAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
```
This is used to pause token bridging completion.
### UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
```solidity
bytes32 UNPAUSE_COMPLETE_TOKEN_BRIDGING_ROLE
```
This is used to unpause token bridging completion.