Skip to main content

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

NameTypeDescription
messageSenderaddressThe address performing the pause.
pauseTypeenum IPauseManager.PauseTypeThe indexed pause type that was paused.

UnPaused

event UnPaused(address messageSender, enum IPauseManager.PauseType pauseType)

Emitted when a pause type is unpaused.

Parameters

NameTypeDescription
messageSenderaddressThe address performing the unpause.
pauseTypeenum IPauseManager.PauseTypeThe 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

NameTypeDescription
pauseTypeenum IPauseManager.PauseTypeThe indexed type of pause.
rolebytes32The 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

NameTypeDescription
unPauseTypeenum IPauseManager.PauseTypeThe indexed type of unpause.
rolebytes32The 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

NameTypeDescription
_pauseTypeenum IPauseManager.PauseTypeThe 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

NameTypeDescription
_pauseTypeenum IPauseManager.PauseTypeThe pause type value.

isPaused

function isPaused(enum IPauseManager.PauseType _pauseType) external view returns (bool pauseTypeIsPaused)

Check if a pause type is enabled.

Parameters

NameTypeDescription
_pauseTypeenum IPauseManager.PauseTypeThe pause type value.

Return Values

NameTypeDescription
pauseTypeIsPausedboolReturns true if the pause type if paused, false otherwise.