pcaversaccio · pcaversaccio · Jan 22, 2025 · Jan 21, 2025 · Jan 21, 2025 · Jan 21, 2025
diff --git a/.gas-snapshot b/.gas-snapshot
diff --git a/.gas-snapshot-venom b/.gas-snapshot-venom
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml
@@ -81,6 +81,7 @@ jobs:
         with:
           check_filenames: true
           skip: ./.git,pnpm-lock.yaml
+          ignore_words_list: pre-emptive
 
   validate-links:
     runs-on: ${{ matrix.os }}
@@ -89,7 +90,7 @@ jobs:
         os:
           - ubuntu-latest
         ruby_version:
-          - 3.3
+          - 3.4
 
     steps:
       - name: Checkout

diff --git a/.github/workflows/halmos-venom.yml b/.github/workflows/halmos-venom.yml
@@ -65,6 +65,7 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: halmos-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run Halmos ERC-20 symbolic tests
         run: halmos --contract ERC20TestHalmos ${{ matrix.halmos }}

diff --git a/.github/workflows/halmos.yml b/.github/workflows/halmos.yml
@@ -65,6 +65,7 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: halmos
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run Halmos ERC-20 symbolic tests
         run: halmos --contract ERC20TestHalmos ${{ matrix.halmos }}

diff --git a/.github/workflows/test-contracts-venom.yml b/.github/workflows/test-contracts-venom.yml
@@ -72,21 +72,25 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: ci-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Foundry tests
         run: forge test
         env:
           FOUNDRY_PROFILE: ci-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Show the Foundry default config
         run: forge config
         env:
           FOUNDRY_PROFILE: default-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run snapshot
         run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
         env:
           FOUNDRY_PROFILE: default-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Install Homebrew
         uses: Homebrew/actions/setup-homebrew@master
@@ -101,11 +105,13 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: echidna-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Compile the Echidna test contracts
         run: forge build --build-info
         env:
           FOUNDRY_PROFILE: echidna-venom
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run Echidna ERC-20 property tests
         run: echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness ${{ matrix.echidna }}

diff --git a/.github/workflows/test-contracts.yml b/.github/workflows/test-contracts.yml
@@ -83,21 +83,25 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: ci
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Foundry tests
         run: forge test
         env:
           FOUNDRY_PROFILE: ci
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Show the Foundry default config
         run: forge config
         env:
           FOUNDRY_PROFILE: default
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run snapshot
         run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
         env:
           FOUNDRY_PROFILE: default
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Install Homebrew
         uses: Homebrew/actions/setup-homebrew@master
@@ -112,11 +116,13 @@ jobs:
         run: forge config
         env:
           FOUNDRY_PROFILE: echidna
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Compile the Echidna test contracts
         run: forge build --build-info
         env:
           FOUNDRY_PROFILE: echidna
+          FOUNDRY_DISABLE_NIGHTLY_WARNING: "1"
 
       - name: Run Echidna ERC-20 property tests
         run: echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness ${{ matrix.echidna }}

diff --git a/CHANGELOG.md b/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**

diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ src
         ├── math — "Standard Mathematical Utility Functions"
         ├── merkle_proof_verification — "Merkle Tree Proof Verification Functions"
         ├── multicall — "Multicall Functions"
+        ├── pausable — "Pausable Functions"
         ├── interfaces
         │   ├── IERC1271 — "EIP-1271 Interface Definition"
         │   └── IERC5267 — "EIP-5267 Interface Definition"
@@ -98,7 +99,8 @@ src
             ├── eip712_domain_separator_mock — "`eip712_domain_separator` Module Reference Implementation"
             ├── math_mock — "`math` Module Reference Implementation"
             ├── merkle_proof_verification_mock — "`merkle_proof_verification` Module Reference Implementation"
-            └── multicall_mock — "`multicall` Module Reference Implementation"
+            ├── multicall_mock — "`multicall` Module Reference Implementation"
+            └── pausable_mock — "`pausable` Module Reference Implementation"
 ```
 
 ## 🎛 Installation
@@ -191,6 +193,7 @@ This repository contains [Foundry](https://github.com/foundry-rs/foundry)-based
 | `math`                      |       ✅       |            ✅            |         ❌          |
 | `merkle_proof_verification` |       ✅       |            ✅            |         ❌          |
 | `multicall`                 |       ✅       |            ❌            |         ❌          |
+| `pausable`                  |       ✅       |            ✅            |         ✅          |
 
 ✅ Test Type Implemented &emsp; ❌ Test Type Not Implemented
 

diff --git a/lib/create-util b/lib/create-util
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
diff --git a/lib/solady b/lib/solady
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/generate_gas_snapshot.sh b/scripts/generate_gas_snapshot.sh
@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+# Enable strict error handling:
+# -E: Inherit `ERR` traps in functions and subshells.
+# -e: Exit immediately if a command exits with a non-zero status.
+# -u: Treat unset variables as an error and exit.
+# -o pipefail: Return the exit status of the first failed command in a pipeline.
+set -Eeuo pipefail
+
+# Enable debug mode if the environment variable `DEBUG` is set to `true`.
+if [[ "${DEBUG:-false}" == "true" ]]; then
+  # Print each command before executing it.
+  set -x
+fi
+
 # Set the default values.
 OUTPUT_FILE=".gas-snapshot"
 FOUNDRY_PROFILE="default"
@@ -16,6 +29,16 @@ prepend_to_output() {
   echo "$1" >> "$TEMP_FILE"
 }
 
+# Utility function to parse the output of `forge --version` and transform it.
+forge_version=$(forge --version | awk '
+  /^forge Version:/ { version = $3 }
+  /Commit SHA:/ { sha = substr($3, 1, 7) }
+  /Build Timestamp:/ { timestamp = $3 }
+  END {
+    print "forge", version, "(" sha, timestamp ")"
+  }
+')
+
 # Parse the command line arguments.
 while [[ "$#" -gt 0 ]]; do
   case $1 in
@@ -44,7 +67,7 @@ forge snapshot --snap "$OUTPUT_FILE"
 
 # Prepare the content to be prepended.
 prepend_to_output "Vyper version: $(vyper --version)"
-prepend_to_output "Forge version: $(forge --version)"
+prepend_to_output "Forge version: $forge_version"
 prepend_to_output "Vyper config:"
 forge config --json | jq -r ".vyper" >> "$TEMP_FILE"
 prepend_to_output "=========================================="

diff --git a/src/snekmate/auth/access_control.vy b/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

diff --git a/src/snekmate/auth/interfaces/IAccessControl.vyi b/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

diff --git a/src/snekmate/auth/mocks/access_control_mock.vy b/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

diff --git a/src/snekmate/auth/mocks/ownable_2step_mock.vy b/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

diff --git a/src/snekmate/auth/mocks/ownable_mock.vy b/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

diff --git a/src/snekmate/auth/ownable.vy b/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

diff --git a/src/snekmate/auth/ownable_2step.vy b/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

diff --git a/src/snekmate/extensions/erc2981.vy b/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

diff --git a/src/snekmate/extensions/erc4626.vy b/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

diff --git a/src/snekmate/extensions/interfaces/IERC2981.vyi b/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

diff --git a/src/snekmate/extensions/mocks/erc2981_mock.vy b/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

diff --git a/src/snekmate/extensions/mocks/erc4626_mock.vy b/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

diff --git a/src/snekmate/governance/mocks/timelock_controller_mock.vy b/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

diff --git a/src/snekmate/governance/timelock_controller.vy b/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

diff --git a/src/snekmate/tokens/erc1155.vy b/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

diff --git a/src/snekmate/tokens/erc20.vy b/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

diff --git a/src/snekmate/tokens/erc721.vy b/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

diff --git a/src/snekmate/tokens/interfaces/IERC1155.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC1155MetadataURI.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC1155Receiver.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC20Permit.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC4906.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC721Enumerable.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC721Metadata.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC721Permit.vyi b/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

diff --git a/src/snekmate/tokens/interfaces/IERC721Receiver.vyi b/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

diff --git a/src/snekmate/tokens/mocks/erc1155_mock.vy b/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
+2 −0		foundry.toml
+24 −0		src/StdChains.sol
+3 −3		test/StdChains.t.sol
+2 −2		docs/tokens/erc20votes.md
+5 −8		docs/utils/libsort.md
+2 −2		src/tokens/ERC20Votes.sol
+22 −24		src/utils/LibSort.sol
+18 −0		test/LibSort.t.sol