Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ERC*Pausable warning for public pausing mechanism #4007

Merged
merged 10 commits into from
Jan 28, 2023
Merged

Add ERC*Pausable warning for public pausing mechanism #4007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
71197e7
Add ERC20Pausable `_pause()` and `_unpause()` interfaces warning
ernestognw Jan 27, 2023
17cfabb
Improve wording
ernestognw Jan 27, 2023
c87fea5
Add changesets
ernestognw Jan 27, 2023
5637ec8
Fix changeset
ernestognw Jan 27, 2023
f1626de
Run linter
ernestognw Jan 27, 2023
3ec0716
Merge branch 'master' into add-erc20-pausable-warning
ernestognw Jan 28, 2023
dd9108a
Update contracts/token/ERC20/extensions/ERC20Pausable.sol
ernestognw Jan 28, 2023
3391767
Added comments to other ERCs
ernestognw Jan 28, 2023
907ad5b
Lint
ernestognw Jan 28, 2023
2a86021
Update .changeset/new-ways-own.md
ernestognw Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/new-ways-own.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'openzeppelin-solidity': patch
---

`ERC20Pausable`, `ERC721Pausable`, `ERC1155Pausable`: Add note regarding missing public pausing functionality
6 changes: 6 additions & 0 deletions contracts/token/ERC1155/extensions/ERC1155Pausable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ import "../../../security/Pausable.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 ERC1155Pausable is ERC1155, Pausable {
Expand Down
6 changes: 6 additions & 0 deletions contracts/token/ERC20/extensions/ERC20Pausable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import "../../../security/Pausable.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 ERC20Pausable is ERC20, Pausable {
/**
Expand Down
6 changes: 6 additions & 0 deletions contracts/token/ERC721/extensions/ERC721Pausable.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import "../../../security/Pausable.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 ERC721Pausable is ERC721, Pausable {
/**
Expand Down