Transpile e541d4a

OpenZeppelin · Jan 31, 2023 · cb0c144 · cb0c144
1 parent c10536c
commit cb0c144
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/.changeset/new-ways-own.md b/.changeset/new-ways-own.md
@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': patch
+---
+
+`ERC20Pausable`, `ERC721Pausable`, `ERC1155Pausable`: Add note regarding missing public pausing functionality
diff --git a/contracts/token/ERC1155/extensions/ERC1155PausableUpgradeable.sol b/contracts/token/ERC1155/extensions/ERC1155PausableUpgradeable.sol
@@ -14,6 +14,12 @@ import "../../../proxy/utils/Initializable.sol";
  * period, or having an emergency switch for freezing all token transfers in the
  * event of a large bug.
  *
+ * IMPORTANT: This contract does not include public pause and unpause functions. In
+ * addition to inheriting this contract, you must define both functions, invoking the
+ * {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
+ * access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
+ * make the contract unpausable.
+ *
  * _Available since v3.1._
  */
 abstract contract ERC1155PausableUpgradeable is Initializable, ERC1155Upgradeable, PausableUpgradeable {

diff --git a/contracts/token/ERC20/extensions/ERC20PausableUpgradeable.sol b/contracts/token/ERC20/extensions/ERC20PausableUpgradeable.sol
@@ -13,6 +13,12 @@ import "../../../proxy/utils/Initializable.sol";
  * Useful for scenarios such as preventing trades until the end of an evaluation
  * period, or having an emergency switch for freezing all token transfers in the
  * event of a large bug.
+ *
+ * IMPORTANT: This contract does not include public pause and unpause functions. In
+ * addition to inheriting this contract, you must define both functions, invoking the
+ * {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
+ * access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
+ * make the contract unpausable.
  */
 abstract contract ERC20PausableUpgradeable is Initializable, ERC20Upgradeable, PausableUpgradeable {
     function __ERC20Pausable_init() internal onlyInitializing {

diff --git a/contracts/token/ERC721/extensions/ERC721PausableUpgradeable.sol b/contracts/token/ERC721/extensions/ERC721PausableUpgradeable.sol
@@ -13,6 +13,12 @@ import "../../../proxy/utils/Initializable.sol";
  * Useful for scenarios such as preventing trades until the end of an evaluation
  * period, or having an emergency switch for freezing all token transfers in the
  * event of a large bug.
+ *
+ * IMPORTANT: This contract does not include public pause and unpause functions. In
+ * addition to inheriting this contract, you must define both functions, invoking the
+ * {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
+ * access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
+ * make the contract unpausable.
  */
 abstract contract ERC721PausableUpgradeable is Initializable, ERC721Upgradeable, PausableUpgradeable {
     function __ERC721Pausable_init() internal onlyInitializing {

diff --git a/docs/modules/ROOT/pages/extending-contracts.adoc b/docs/modules/ROOT/pages/extending-contracts.adoc
@@ -66,8 +66,6 @@ contract ModifiedAccessControl is AccessControl {
 
 The `super.revokeRole` statement at the end will invoke ``AccessControl``'s original version of `revokeRole`, the same code that would've run if there were no overrides in place.
 
-NOTE: As of v3.0.0, `view` functions are not `virtual` in OpenZeppelin, and therefore cannot be overridden. We're considering https://github.com/OpenZeppelin/openzeppelin-contracts/issues/2154[lifting this restriction] in an upcoming release. Let us know if this is something you care about!
-
 [[using-hooks]]
 == Using Hooks