mirror of
https://github.com/vacp2p/linea-monorepo.git
synced 2026-01-09 20:27:58 -05:00
adb097aff4
* export contract ABI and use solidity-docgen export * add docgen dependency * lint fixing
3.4 KiB
3.4 KiB
Solidity API
IPauseManager
PauseTypeRole
struct PauseTypeRole {
enum IPauseManager.PauseType pauseType;
bytes32 role;
}
PauseType
enum PauseType {
UNUSED,
GENERAL,
L1_L2,
L2_L1,
BLOB_SUBMISSION,
CALLDATA_SUBMISSION,
FINALIZATION,
INITIATE_TOKEN_BRIDGING,
COMPLETE_TOKEN_BRIDGING
}
Paused
event Paused(address messageSender, enum IPauseManager.PauseType pauseType)
Emitted when a pause type is paused.
Parameters
| Name | Type | Description |
|---|---|---|
| messageSender | address | The address performing the pause. |
| pauseType | enum IPauseManager.PauseType | The indexed pause type that was paused. |
UnPaused
event UnPaused(address messageSender, enum IPauseManager.PauseType pauseType)
Emitted when a pause type is unpaused.
Parameters
| Name | Type | Description |
|---|---|---|
| messageSender | address | The address performing the unpause. |
| pauseType | enum IPauseManager.PauseType | The indexed pause type that was unpaused. |
PauseTypeRoleSet
event PauseTypeRoleSet(enum IPauseManager.PauseType pauseType, bytes32 role)
Emitted when a pause type and its associated role are set in the _pauseTypeRoles mapping.
Parameters
| Name | Type | Description |
|---|---|---|
| pauseType | enum IPauseManager.PauseType | The indexed type of pause. |
| role | bytes32 | The indexed role associated with the pause type. |
UnPauseTypeRoleSet
event UnPauseTypeRoleSet(enum IPauseManager.PauseType unPauseType, bytes32 role)
Emitted when an unpause type and its associated role are set in the _unPauseTypeRoles mapping.
Parameters
| Name | Type | Description |
|---|---|---|
| unPauseType | enum IPauseManager.PauseType | The indexed type of unpause. |
| role | bytes32 | The indexed role associated with the unpause type. |
IsPaused
error IsPaused(enum IPauseManager.PauseType pauseType)
Thrown when a specific pause type is paused.
IsNotPaused
error IsNotPaused(enum IPauseManager.PauseType pauseType)
Thrown when a specific pause type is not paused and expected to be.
pauseByType
function pauseByType(enum IPauseManager.PauseType _pauseType) external
Pauses functionality by specific type.
Requires the role mapped in pauseTypeRoles for the pauseType.
Parameters
| Name | Type | Description |
|---|---|---|
| _pauseType | enum IPauseManager.PauseType | The pause type value. |
unPauseByType
function unPauseByType(enum IPauseManager.PauseType _pauseType) external
Unpauses functionality by specific type.
Requires the role mapped in unPauseTypeRoles for the pauseType.
Parameters
| Name | Type | Description |
|---|---|---|
| _pauseType | enum IPauseManager.PauseType | The pause type value. |
isPaused
function isPaused(enum IPauseManager.PauseType _pauseType) external view returns (bool pauseTypeIsPaused)
Check if a pause type is enabled.
Parameters
| Name | Type | Description |
|---|---|---|
| _pauseType | enum IPauseManager.PauseType | The pause type value. |
Return Values
| Name | Type | Description |
|---|---|---|
| pauseTypeIsPaused | bool | Returns true if the pause type if paused, false otherwise. |