🔁 Upgrade EVM Version to cancun (#245)

### 🕓 Changelog

All 🐍 snekmate contracts now target the new Vyper default EVM version
`cancun` (see vyperlang/vyper#4029). I also bump
the Vyper version to the latest release candidate
[`v0.4.0rc5`](https://github.com/vyperlang/vyper/releases/tag/v0.4.0rc5).

---------

Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>

.github/workflows/checks.yml

@@ -110,4 +110,4 @@ jobs:
           awesome_bot ./*.md src/snekmate/**/*.vy src/snekmate/**/mocks/*.vy src/snekmate/**/interfaces/*.vyi \
           test/**/*.sol test/**/interfaces/*.sol test/**/mocks/*.sol test/**/scripts/*.js lib/utils/*.py \
           --allow-dupe --allow-redirect --request-delay 0.4 \
-          --white-list https://www.wagmi.xyz,https://github.com/pcaversaccio/snekmate.git@,https://github.com/pcaversaccio/snekmate/releases/tag/v0.1.0,https://github.com/pcaversaccio/snekmate/blob/v0.1.0,https://github.com/pcaversaccio/snekmate/compare/v0.0.5...v0.1.0
+          --white-list https://www.wagmi.xyz,https://github.com/pcaversaccio/snekmate.git@,https://github.com/pcaversaccio/snekmate/releases/tag/v0.1.0,https://github.com/pcaversaccio/snekmate/blob/v0.1.0,https://github.com/pcaversaccio/snekmate/compare/v0.0.5...v0.1.0,https://github.com/vyperlang/vyper/releases/tag/v0.4.0

.github/workflows/test-contracts.yml

@@ -94,7 +94,7 @@ jobs:
           FOUNDRY_PROFILE: default
 
       - name: Run snapshot
-        run: NO_COLOR=1 forge snapshot --build-info >> $GITHUB_STEP_SUMMARY
+        run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
         env:
           FOUNDRY_PROFILE: default
 
@@ -107,10 +107,24 @@ jobs:
       - name: Show the Echidna version
         run: echidna --version
 
+      - name: Show the Foundry Echidna config
+        run: forge config
+        env:
+          FOUNDRY_PROFILE: echidna
+
+      - name: Compile the Echidna test contracts
+        run: forge build --build-info
+        env:
+          FOUNDRY_PROFILE: echidna
+
       - name: Run Echidna ERC-20 property tests
         run: |
-          echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness --config test/tokens/echidna/echidna-config.yaml --crytic-args --ignore-compile
+          echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness --config test/tokens/echidna/echidna-config.yaml
+        env:
+          FOUNDRY_PROFILE: echidna
 
       - name: Run Echidna ERC-721 property tests
         run: |
-          echidna test/tokens/echidna/ERC721Properties.sol --contract CryticERC721ExternalHarness --config test/tokens/echidna/echidna-config.yaml --crytic-args --ignore-compile
+          echidna test/tokens/echidna/ERC721Properties.sol --contract CryticERC721ExternalHarness --config test/tokens/echidna/echidna-config.yaml
+        env:
+          FOUNDRY_PROFILE: echidna

CHANGELOG.md

@@ -43,6 +43,14 @@
 
 - The file names of 🐍 snekmate module and mock contracts use the _snake case_ notation (e.g. `my_module.vy` or `my_module_mock.vy`), whilst the Vyper interface files `.vyi` use the _Pascal case_ notation prefixed with `I` (e.g. `IMyInterface.vyi`). ([#242](https://github.com/pcaversaccio/snekmate/pull/242))
 - The mathematical utility functions `_log_2`, `_log_10`, and `_log_256` are renamed to `_log2`, `_log10`, and `_log256`. ([#242](https://github.com/pcaversaccio/snekmate/pull/242))
+- All 🐍 snekmate contracts now target the new Vyper [default EVM version](https://github.com/vyperlang/vyper/pull/4029) `cancun` ([#245](https://github.com/pcaversaccio/snekmate/pull/245)). If you intend to deploy on an EVM chain with no `cancun` support, you must compile — using the `shanghai` EVM version as an example — the main contract that uses the 🐍 snekmate module contracts with the `--evm-version shanghai` option; e.g. `vyper --evm-version shanghai src/snekmate/tokens/mocks/erc20_mock.vy`, or add the `# pragma evm-version shanghai` directive to the main contract that uses the 🐍 snekmate module contracts:
+
+```vyper
+# pragma version ~=0.4.0
+# pragma evm-version shanghai
+
+...
+```
 
 ### 👀 Full Changelog
 

README.md

@@ -104,7 +104,7 @@ forge install pcaversaccio/snekmate
 ```
 
 > [!NOTE]
-> If you want to leverage 🐍 snekmate's [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract for your own testing, ensure that you compile the Vyper contracts with the same EVM version as configured in your `foundry.toml` file. The [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract offers two overloaded `deployContract` functions that allow the configuration of the target EVM version. Please note that since Vyper version [`0.3.8`](https://github.com/vyperlang/vyper/releases/tag/v0.3.8) the default EVM version is set to `shanghai`. Furthermore, the [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract relies on the Python script [`compile.py`](./lib/utils/compile.py) for successful compilation and deployment. Always use the [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract alongside with the aforementioned script.
+> If you want to leverage 🐍 snekmate's [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract for your own testing, ensure that you compile the Vyper contracts with the same EVM version as configured in your `foundry.toml` file. The [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract offers two overloaded `deployContract` functions that allow the configuration of the target EVM version. Please note that since Vyper version [`0.4.0`](https://github.com/vyperlang/vyper/releases/tag/v0.4.0) the default EVM version is set to `cancun`. Furthermore, the [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract relies on the Python script [`compile.py`](./lib/utils/compile.py) for successful compilation and deployment. Always use the [`VyperDeployer`](./lib/utils/VyperDeployer.sol) contract alongside with the aforementioned script.
 
 ### 2️⃣ PyPI
 
@@ -176,10 +176,10 @@ Furthermore, the [`echidna`](https://github.com/crytic/echidna)-based [property]
 
 ```console
 # Run Echidna ERC-20 property tests.
-~$ echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness --config test/tokens/echidna/echidna-config.yaml --crytic-args --ignore-compile
+~$ FOUNDRY_PROFILE=echidna echidna test/tokens/echidna/ERC20Properties.sol --contract CryticERC20ExternalHarness --config test/tokens/echidna/echidna-config.yaml
 
 # Run Echidna ERC-721 property tests.
-~$ echidna test/tokens/echidna/ERC721Properties.sol --contract CryticERC721ExternalHarness --config test/tokens/echidna/echidna-config.yaml --crytic-args --ignore-compile
+~$ FOUNDRY_PROFILE=echidna echidna test/tokens/echidna/ERC721Properties.sol --contract CryticERC721ExternalHarness --config test/tokens/echidna/echidna-config.yaml
 ```
 
 > [!TIP]

ape-config.yaml

@@ -4,4 +4,4 @@ default_ecosystem: ethereum
 plugins:
   - name: vyper
 vyper:
-  evm_version: shanghai
+  evm_version: cancun

foundry.toml

@@ -13,7 +13,7 @@ ffi = true                                                  # whether to enable
 verbosity = 3                                               # the verbosity of tests
 fs_permissions = [{ access = "read-write", path = "./"}]    # set read-write access to project root
 solc_version = '0.8.25'                                     # override for the solc version
-evm_version = 'shanghai'                                    # set the EVM target version
+evm_version = 'cancun'                                      # set the EVM target version
 no_match_path = 'test/tokens/echidna/**/*'                  # only run tests in test directory that do not match the specified glob pattern
 
 ## default overrides for the CI runs
@@ -22,3 +22,8 @@ force = true                                                # always perform a c
 fuzz = { runs = 10_000, max_test_rejects = 350_000 }        # increase the number of fuzz runs and maximum number of combined inputs that may be rejected for the tests
 invariant = { runs = 5_000 }                                # increase the number of runs that must execute for each invariant test group
 verbosity = 4                                               # increase the verbosity of tests
+
+## default overrides for the Echidna tests
+[profile.echidna]
+force = true                                                # always perform a clean build
+evm_version = 'shanghai'                                    # set the EVM target version to `shanghai`

lib/utils/VyperDeployer.sol

@@ -175,7 +175,7 @@ contract VyperDeployer is Create {
      * @param fileName The file name of the Vyper contract.
      * For example, the file name for "ECDSA.vy" is "ECDSA".
      * @param evmVersion The EVM version used for compilation.
-     * For example, the EVM version for the Paris hard fork is "paris".
+     * For example, the EVM version for the Cancun-Deneb hard fork is "cancun".
      * You can retrieve all available Vyper EVM versions by invoking `vyper -h`.
      * @return deployedAddress The address that the contract was deployed to.
      */
@@ -240,7 +240,7 @@ contract VyperDeployer is Create {
      * For example, the file name for "ECDSA.vy" is "ECDSA".
      * @param args The ABI-encoded constructor arguments.
      * @param evmVersion The EVM version used for compilation.
-     * For example, the EVM version for the Paris hard fork is "paris".
+     * For example, the EVM version for the Cancun-Deneb hard fork is "cancun".
      * You can retrieve all available Vyper EVM versions by invoking `vyper -h`.
      * @return deployedAddress The address that the contract was deployed to.
      */

src/snekmate/auth/access_control.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title `ownable` Module Reference Implementation
 @custom:contract-name ownable_mock

src/snekmate/auth/ownable.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title Owner-Based Access Control Functions
 @custom:contract-name ownable

src/snekmate/auth/ownable_2step.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title 2-Step Ownership Transfer Functions
 @custom:contract-name ownable_2step

src/snekmate/extensions/erc2981.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-2981 Interface Definition
 @custom:contract-name IERC2981

src/snekmate/extensions/mocks/erc2981_mock.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title Multi-Role-Based Timelock Controller Reference Implementation
 @custom:contract-name timelock_controller
@@ -153,7 +153,7 @@ _DYNARRAY_BOUND: constant(uint8) = max_value(uint8)
 # `uint8`) in the form `2**n`, where `n` is the index of
 # the member in the range `0 <= n <= 255` (i.e. the first
 # index value is `1`). For further insights also, see
-# the following Twitter thread:
+# the following X thread:
 # https://x.com/pcaversaccio/status/1626514029094047747.
 flag OperationState:
     UNSET

src/snekmate/tokens/erc1155.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-1155 Interface Definition
 @custom:contract-name IERC1155

src/snekmate/tokens/interfaces/IERC1155MetadataURI.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-2612 Interface Definition
 @custom:contract-name IERC20Permit

src/snekmate/tokens/interfaces/IERC4906.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-4906 Interface Definition
 @custom:contract-name IERC4906

src/snekmate/tokens/interfaces/IERC721Enumerable.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-4494 Interface Definition
 @custom:contract-name IERC721Permit

src/snekmate/tokens/interfaces/IERC721Receiver.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title `erc721` Module Reference Implementation
 @custom:contract-name erc721_mock

src/snekmate/utils/base64.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title Base64 Encoding and Decoding Functions
 @custom:contract-name base64

src/snekmate/utils/batch_distributor.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-1271 Interface Definition
 @custom:contract-name IERC1271

src/snekmate/utils/interfaces/IERC5267.vyi

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title EIP-5267 Interface Definition
 @custom:contract-name IERC5267

src/snekmate/utils/math.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title Standard Mathematical Utility Functions
 @custom:contract-name math

src/snekmate/utils/merkle_proof_verification.vy

@@ -1,4 +1,4 @@
-# pragma version ~=0.4.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @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.0rc4
+# pragma version ~=0.4.0rc5
 """
 @title `ecdsa` Module Reference Implementation
 @custom:contract-name ecdsa_mock