PauseFacet
Asset Tokenization Studio Team
PauseFacet
Diamond facet that exposes pause management operations — pause, unpause, and pause state query — as selectable proxy functions.
Inherits Pause for the business logic and implements IStaticFunctionSelectors for the Diamond resolver pattern. The resolver key RESOLVER_KEY_PAUSE identifies this facet within the diamond proxy.
Methods
getStaticFunctionSelectors
function getStaticFunctionSelectors() external pure returns (bytes4[])
Gets all function selectors of a facet
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes4[] | Face functions selectors |
getStaticInterfaceIds
function getStaticInterfaceIds() external pure returns (bytes4[])
Gets all interfaces ids of a facet.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes4[] | Face interface ids |
getStaticResolverKey
function getStaticResolverKey() external pure returns (bytes32 staticResolverKey_)
Gets the static resolver key
Returns
| Name | Type | Description |
|---|---|---|
| staticResolverKey_ | bytes32 | Static resolver key |
initializePause
function initializePause() external nonpayable
Initialises the pause capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
pause
function pause() external nonpayable returns (bool success_)
Sets the token's internal pause flag, blocking all guarded operations.
Requires ROLE_PAUSER and the token to be currently unpaused. Reverts with IsPaused if the token is already paused. Emits Paused.
Returns
| Name | Type | Description |
|---|---|---|
| success_ | bool | True if the token was successfully paused. |
paused
function paused() external view returns (bool)
Checks whether the token is currently paused.
Returns true if the token's own pause flag is set, or if any registered external pause contract returns true from its isPaused() call (OR semantics). created to be compatible with ERC3643
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | True if the token is paused by any source, false otherwise. |
unpause
function unpause() external nonpayable returns (bool success_)
Clears the token's internal pause flag, restoring guarded operations.
Requires ROLE_PAUSER and the token's internal flag to be set. Reverts with IsUnpaused if the internal flag is already cleared. Emits Unpaused. Note: if any external pause contract remains paused, isPaused will still return true after this call.
Returns
| Name | Type | Description |
|---|---|---|
| success_ | bool | True if the internal pause flag was successfully cleared. |
Events
PauseInitialized
event PauseInitialized()
Emitted once when the pause capability is initialised on a token.
Fires exclusively from initializePause.
Paused
event Paused(address indexed operator)
Emitted when the token's internal pause flag is set to true.
Parameters
| Name | Type | Description |
|---|---|---|
operator indexed | address | Address of the caller who triggered the pause. |
Unpaused
event Unpaused(address indexed operator)
Emitted when the token's internal pause flag is cleared to false.
Parameters
| Name | Type | Description |
|---|---|---|
operator indexed | address | Address of the caller who triggered the unpause. |
Errors
AccountHasNoRole
error AccountHasNoRole(address account, bytes32 role)
Thrown when an account does not hold a required role.
Parameters
| Name | Type | Description |
|---|---|---|
| account | address | The account that lacks the role. |
| role | bytes32 | The role that is not held. |
AssetNotOperational
error AssetNotOperational(bytes32 configId, uint256 versionId)
Raised by InitializerStorageWrapper.checkOperational (and the related isConfigVersionOperational helper) when an operation is attempted on a configuration version that has not yet been marked operational.
Parameters
| Name | Type | Description |
|---|---|---|
| configId | bytes32 | Resolver-proxy configuration whose operational status was checked. |
| versionId | uint256 | Configuration version whose operational status was checked. |
Deactivated
error Deactivated()
Thrown when an operation guarded by onlyActivated is attempted on a token whose deactivation flag has already been set.
FacetAlreadyRegistered
error FacetAlreadyRegistered(bytes32 facetId, uint256 lastVersion)
Raised when an initialiser tries to register a facet that already has a non-zero last registered version (i.e. the facet is being re-initialised on a fresh install).
Parameters
| Name | Type | Description |
|---|---|---|
| facetId | bytes32 | Identifier of the offending facet. |
| lastVersion | uint256 | Last version recorded for that facet at the time of the check. |
IsPaused
error IsPaused()
Thrown when an operation that requires the token to be unpaused is attempted while the token is paused (own flag or any external pause contract).
IsUnpaused
error IsUnpaused()
Thrown when unpause is called while the token's internal pause flag is already cleared.
UnrecognizedResolverProxyVersion
error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)
Thrown when the provided proxy version does not match any BLR compatible standard.
Parameters
| Name | Type | Description |
|---|---|---|
| _resolverProxyVersion | bytes8 | proxy version that is not compatible with the BLR. |
WalletRecovered
error WalletRecovered()
Thrown when attempting to recover a wallet that has already been recovered.