💥 Add a pausable Contract Module

Signed-off-by: Pascal Marco Caversaccio <[email protected]>

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [`0.1.1`](https://github.com/pcaversaccio/snekmate/releases/tag/v0.1.1) (Unreleased)
 
+### 💥 New Features
+
+- **Utility Functions**
+  - [`pausable`](https://github.com/pcaversaccio/snekmate/blob/v0.1.1/src/snekmate/utils/pausable.vy): Add a `pausable` contract module. ([#297](https://github.com/pcaversaccio/snekmate/pull/297))
+
 ### ♻️ Refactoring
 
 - **Authentication**

README.md

@@ -191,6 +191,7 @@ This repository contains [Foundry](https://github.com/foundry-rs/foundry)-based
 | `math`                      |       ✅       |            ✅            |         ❌          |
 | `merkle_proof_verification` |       ✅       |            ✅            |         ❌          |
 | `multicall`                 |       ✅       |            ❌            |         ❌          |
+| `pausable`                  |       ✅       |            ✅            |         ✅          |
 
 ✅ Test Type Implemented   ❌ Test Type Not Implemented
 

src/snekmate/auth/access_control.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Multi-Role-Based Access Control Functions
 @custom:contract-name access_control

src/snekmate/auth/interfaces/IAccessControl.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `access_control` Interface Definition
 @custom:contract-name IAccessControl

src/snekmate/auth/mocks/access_control_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `access_control` Module Reference Implementation
 @custom:contract-name access_control_mock

src/snekmate/auth/mocks/ownable_2step_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `ownable_2step` Module Reference Implementation
 @custom:contract-name ownable_2step_mock

src/snekmate/auth/mocks/ownable_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `ownable` Module Reference Implementation
 @custom:contract-name ownable_mock

src/snekmate/auth/ownable.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Owner-Based Access Control Functions
 @custom:contract-name ownable

src/snekmate/auth/ownable_2step.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title 2-Step Ownership Transfer Functions
 @custom:contract-name ownable_2step

src/snekmate/extensions/erc2981.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title ERC-721 and ERC-1155 Compatible ERC-2981 Reference Implementation
 @custom:contract-name erc2981

src/snekmate/extensions/erc4626.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Modern and Gas-Efficient ERC-4626 Tokenised Vault Implementation
 @custom:contract-name erc4626

src/snekmate/extensions/interfaces/IERC2981.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-2981 Interface Definition
 @custom:contract-name IERC2981

src/snekmate/extensions/mocks/erc2981_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `erc2981` Module Reference Implementation
 @custom:contract-name erc2981_mock

src/snekmate/extensions/mocks/erc4626_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `erc4626` Module Reference Implementation
 @custom:contract-name erc4626_mock

src/snekmate/governance/mocks/timelock_controller_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `timelock_controller` Module Reference Implementation
 @custom:contract-name timelock_controller_mock

src/snekmate/governance/timelock_controller.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Multi-Role-Based Timelock Controller Reference Implementation
 @custom:contract-name timelock_controller

src/snekmate/tokens/erc1155.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Modern and Gas-Efficient ERC-1155 Implementation
 @custom:contract-name erc1155

src/snekmate/tokens/erc20.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Modern and Gas-Efficient ERC-20 + EIP-2612 Implementation
 @custom:contract-name erc20

src/snekmate/tokens/erc721.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Modern and Gas-Efficient ERC-721 + EIP-4494 Implementation
 @custom:contract-name erc721

src/snekmate/tokens/interfaces/IERC1155.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-1155 Interface Definition
 @custom:contract-name IERC1155

src/snekmate/tokens/interfaces/IERC1155MetadataURI.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-1155 Optional Metadata Interface Definition
 @custom:contract-name IERC1155MetadataURI

src/snekmate/tokens/interfaces/IERC1155Receiver.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-1155 Token Receiver Interface Definition
 @custom:contract-name IERC1155Receiver

src/snekmate/tokens/interfaces/IERC20Permit.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-2612 Interface Definition
 @custom:contract-name IERC20Permit

src/snekmate/tokens/interfaces/IERC4906.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-4906 Interface Definition
 @custom:contract-name IERC4906

src/snekmate/tokens/interfaces/IERC721Enumerable.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-721 Optional Enumeration Interface Definition
 @custom:contract-name IERC721Enumerable

src/snekmate/tokens/interfaces/IERC721Metadata.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-721 Optional Metadata Interface Definition
 @custom:contract-name IERC721Metadata

src/snekmate/tokens/interfaces/IERC721Permit.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-4494 Interface Definition
 @custom:contract-name IERC721Permit

src/snekmate/tokens/interfaces/IERC721Receiver.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-721 Token Receiver Interface Definition
 @custom:contract-name IERC721Receiver

src/snekmate/tokens/mocks/erc1155_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `erc1155` Module Reference Implementation
 @custom:contract-name erc1155_mock

src/snekmate/tokens/mocks/erc20_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `erc20` Module Reference Implementation
 @custom:contract-name erc20_mock

src/snekmate/tokens/mocks/erc721_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `erc721` Module Reference Implementation
 @custom:contract-name erc721_mock

src/snekmate/utils/base64.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Base64 Encoding and Decoding Functions
 @custom:contract-name base64

src/snekmate/utils/batch_distributor.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Batch Sending Both Native and ERC-20 Tokens
 @custom:contract-name batch_distributor

src/snekmate/utils/create2_address.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `CREATE2` EVM Opcode Utility Functions for Address Calculations
 @custom:contract-name create2_address

src/snekmate/utils/create_address.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `CREATE` EVM Opcode Utility Functions for Address Calculations
 @custom:contract-name create_address

src/snekmate/utils/ecdsa.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Elliptic Curve Digital Signature Algorithm (ECDSA) Secp256k1-Based Functions
 @custom:contract-name ecdsa

src/snekmate/utils/eip712_domain_separator.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-712 Domain Separator
 @custom:contract-name eip712_domain_separator

src/snekmate/utils/interfaces/IERC1271.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-1271 Interface Definition
 @custom:contract-name IERC1271

src/snekmate/utils/interfaces/IERC5267.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title EIP-5267 Interface Definition
 @custom:contract-name IERC5267

src/snekmate/utils/math.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Standard Mathematical Utility Functions
 @custom:contract-name math

src/snekmate/utils/merkle_proof_verification.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Merkle Tree Proof Verification Functions
 @custom:contract-name merkle_proof_verification

src/snekmate/utils/message_hash_utils.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title Signature Message Hash Utility Functions
 @custom:contract-name message_hash_utils

src/snekmate/utils/mocks/base64_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `base64` Module Reference Implementation
 @custom:contract-name base64_mock

src/snekmate/utils/mocks/batch_distributor_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `batch_distributor` Module Reference Implementation
 @custom:contract-name batch_distributor_mock

src/snekmate/utils/mocks/create2_address_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `create2_address` Module Reference Implementation
 @custom:contract-name create2_address_mock

src/snekmate/utils/mocks/create_address_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `create_address` Module Reference Implementation
 @custom:contract-name create_address_mock

src/snekmate/utils/mocks/ecdsa_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `ecdsa` Module Reference Implementation
 @custom:contract-name ecdsa_mock

src/snekmate/utils/mocks/eip712_domain_separator_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `eip712_domain_separator` Module Reference Implementation
 @custom:contract-name eip712_domain_separator_mock

src/snekmate/utils/mocks/math_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `math` Module Reference Implementation
 @custom:contract-name math_mock

src/snekmate/utils/mocks/merkle_proof_verification_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `merkle_proof_verification` Module Reference Implementation
 @custom:contract-name merkle_proof_verification_mock

src/snekmate/utils/mocks/message_hash_utils_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `message_hash_utils` Module Reference Implementation
 @custom:contract-name message_hash_utils_mock

src/snekmate/utils/mocks/multicall_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `multicall` Module Reference Implementation
 @custom:contract-name multicall_mock

src/snekmate/utils/mocks/p256_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `p256` Module Reference Implementation
 @custom:contract-name p256_mock

src/snekmate/utils/mocks/pausable_mock.vy

@@ -0,0 +1,63 @@
+# pragma version ~=0.4.1rc2
+"""
+@title `pausable` Module Reference Implementation
+@custom:contract-name pausable_mock
+@license GNU Affero General Public License v3.0 only
+@author pcaversaccio
+"""
+
+
+# @dev We import and initialise the `pausable` module.
+from .. import pausable as ps
+initializes: ps
+
+
+# @dev We export (i.e. the runtime bytecode exposes these
+# functions externally, allowing them to be called using
+# the ABI encoding specification) all `external` functions
+# from the `pausable` module. The built-in dunder method
+# `__interface__` allows you to export all functions of a
+# module without specifying the individual functions (see
+# https://github.com/vyperlang/vyper/pull/3919). Please take
+# note that if you do not know the full interface of a module
+# contract, you can get the `.vyi` interface in Vyper by using
+# `vyper -f interface your_filename.vy` or the external interface
+# by using `vyper -f external_interface your_filename.vy`.
+# @notice Please note that you must always also export (if
+# required by the contract logic) `public` declared `constant`,
+# `immutable`, and state variables, for which Vyper automatically
+# generates an `external` getter function for the variable.
+exports: ps.__interface__
+
+
+@deploy
+@payable
+def __init__():
+    """
+    @dev To omit the opcodes for checking the `msg.value`
+         in the creation-time EVM bytecode, the constructor
+         is declared as `payable`.
+    """
+    ps.__init__()
+
+
+@external
+def pause():
+    """
+    @dev Triggers the pause state. Note that the contract
+         must not be paused.
+    @notice This is an `external` function without access
+            restriction.
+    """
+    ps._pause()
+
+
+@external
+def unpause():
+    """
+    @dev Lifts the pause state. Note that the contract
+         must be paused.
+    @notice This is an `external` function without access
+            restriction.
+    """
+    ps._unpause()

src/snekmate/utils/mocks/signature_checker_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.1b5
+# pragma version ~=0.4.1rc2
 """
 @title `signature_checker` Module Reference Implementation
 @custom:contract-name signature_checker_mock