This document defines the Pause Module for the CMTA Token specification.
[TOC]
The issuer must be able to “pause” the smart contract, to prevent execution of transactions on the distributed ledger until the issuer puts an end to the pause. This function can be used to block transactions in case of a “hard fork” of the distributed ledger, pending a decision of the issuer as to which version of the distributed ledger it will support.
| File Name | SHA-1 Hash |
|---|---|
| ./modules/wrapper/mandatory/PauseModule.sol | 0350e2f17f517c70804304a8cf24d3337f951f59 |
| Contract | Type | Bases | ||
|---|---|---|---|---|
| └ | Function Name | Visibility | Mutability | Modifiers |
| PauseModule | Implementation | PausableUpgradeable, AuthorizationModule | ||
| └ | __PauseModule_init | Internal 🔒 | 🛑 | onlyInitializing |
| └ | __PauseModule_init_unchained | Internal 🔒 | 🛑 | onlyInitializing |
| └ | pause | Public ❗️ | 🛑 | onlyRole |
| └ | unpause | Public ❗️ | 🛑 | onlyRole |
| Symbol | Meaning |
|---|---|
| 🛑 | Function can modify state |
| 💵 | Function is payable |
This section describes the Ethereum API of the Pause Module.
function pause()
public onlyRole(PAUSER_ROLE)Pause all the token transfers. This function doesn't affect issuance, redemption, and approves. Only authorized users are allowed to call this function.
function unpause()
public onlyRole(PAUSER_ROLE)Unpause token transfers. Only authorized users are allowed to call this function.
Origin: OpenZeppelin (PausableUpgradeable)
event Paused(address account)Emitted when token transfers were paused.
event Unpaused(address account)Emitted when token transfers were unpaused.