🔁 Upgrade to Vyper Version 0.4.0 and Make All 🐍 snekmate Contracts Module-Friendly

.github/workflows/checks.yml

@@ -3,7 +3,7 @@ name: 👮‍♂️ Sanity checks
 on: [push, pull_request, workflow_dispatch]
 
 concurrency:
- group: ${{github.workflow}}-${{github.ref}}
+ group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
 jobs:
@@ -13,10 +13,10 @@ jobs:
  matrix:
  os:
  - ubuntu-latest
+ python_version:
+ - 3.12
  architecture:
  - x64
- python_version:
- - 3.11
  node_version:
  - 20
 
@@ -64,7 +64,7 @@ jobs:
  uses: psf/black@stable
  with:
  options: "--check --verbose"
- src: "./scripts"
+ src: "./lib/utils"
 
  codespell:
  runs-on: ${{ matrix.os }}
@@ -107,8 +107,7 @@ jobs:
 
  - name: Validate URLs
  run: |
- awesome_bot ./*.md src/snekmate/**/*.vy src/snekmate/**/interfaces/*.vy \
- test/**/*.sol test/**/interfaces/*.sol test/**/mocks/*.sol \
- test/**/scripts/*.js scripts/*.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
+ 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/*.sol 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,https://github.com/vyperlang/vyper/releases/tag/v0.4.0

.github/workflows/codeql.yml

@@ -3,7 +3,7 @@ name: 🔍️ CodeQL
 on: [push, pull_request, workflow_dispatch]
 
 concurrency:
- group: ${{github.workflow}}-${{github.ref}}
+ group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
 jobs:
@@ -35,4 +35,4 @@ jobs:
  - name: Perform CodeQL analysis
  uses: github/codeql-action/analyze@v3
  with:
- category: "/language:${{matrix.language}}"
+ category: "/language:${{ matrix.language }}"

.github/workflows/halmos.yml

@@ -0,0 +1,88 @@
+name: 👁️ Halmos symbolic tests
+
+on:
+ schedule:
+ # Run every day at 03:30 UTC.
+ - cron: "30 3 * * *"
+ workflow_dispatch:
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ halmos:
+ runs-on: ${{ matrix.os }}
+ strategy:
+ matrix:
+ os:
+ - ubuntu-latest
+ python_version:
+ - 3.12
+ architecture:
+ - x64
+ halmos:
+ - "--config test/halmos.toml"
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ with:
+ submodules: recursive
+
+ - name: Setup Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python_version }}
+ architecture: ${{ matrix.architecture }}
+
+ - name: Install Vyper
+ run: pip install git+https://github.com/vyperlang/vyper.git@master
+
+ - name: Show the Vyper version
+ run: vyper --version
+
+ - name: Install Foundry
+ uses: foundry-rs/foundry-toolchain@v1
+ with:
+ version: nightly
+
+ - name: Install `setuptools`
+ run: pip install setuptools
+
+ - name: Install Halmos
+ run: pip install git+https://github.com/a16z/halmos.git@main
+
+ - name: Show the Halmos version
+ run: halmos --version
+
+ - name: Install Yices 2 SMT solver
+ run: |
+ sudo add-apt-repository ppa:sri-csl/formal-methods
+ sudo apt-get update
+ sudo apt-get install yices2
+
+ - name: Show the Foundry Halmos config
+ run: forge config
+ env:
+ FOUNDRY_PROFILE: halmos
+
+ - name: Run Halmos ERC-20 symbolic tests
+ run: halmos --contract ERC20TestHalmos ${{ matrix.halmos }}
+ env:
+ FOUNDRY_PROFILE: halmos
+
+ - name: Run Halmos ERC-721 symbolic tests
+ run: halmos --contract ERC721TestHalmos ${{ matrix.halmos }}
+ env:
+ FOUNDRY_PROFILE: halmos
+
+ - name: Run Halmos ERC-1155 symbolic tests
+ run: halmos --contract ERC1155TestHalmos ${{ matrix.halmos }}
+ env:
+ FOUNDRY_PROFILE: halmos
+
+ - name: Run Halmos math symbolic tests
+ run: halmos --contract MathTestHalmos ${{ matrix.halmos }}
+ env:
+ FOUNDRY_PROFILE: halmos

.github/workflows/publish-pypi.yml

@@ -17,10 +17,10 @@ jobs:
  matrix:
  os:
  - ubuntu-latest
+ python_version:
+ - 3.12
  architecture:
  - x64
- python_version:
- - 3.11
 
  steps:
  - name: Checkout

.github/workflows/publish-test-pypi.yml

@@ -14,10 +14,10 @@ jobs:
  matrix:
  os:
  - ubuntu-latest
+ python_version:
+ - 3.12
  architecture:
  - x64
- python_version:
- - 3.11
 
  steps:
  - name: Checkout

.github/workflows/test-contracts.yml

@@ -3,7 +3,7 @@ name: 🕵️‍♂️ Test smart contracts
 on: [push, pull_request, workflow_dispatch]
 
 concurrency:
- group: ${{github.workflow}}-${{github.ref}}
+ group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
 jobs:
@@ -13,12 +13,14 @@ jobs:
  matrix:
  os:
  - ubuntu-latest
+ python_version:
+ - 3.12
  architecture:
  - x64
- python_version:
- - 3.11
  node_version:
  - 20
+ echidna:
+ - "--config test/echidna.yaml"
 
  steps:
  - name: Checkout
@@ -33,18 +35,18 @@ jobs:
  architecture: ${{ matrix.architecture }}
 
  - name: Install Vyper
- run: pip install vyper
+ run: pip install git+https://github.com/vyperlang/vyper.git@master
 
- - name: Check userdoc and devdoc compilation
- run: python scripts/compile.py
+ - name: Show the Vyper version
+ run: vyper --version
 
- - name: Setup Ape
- uses: ApeWorX/github-action@v2
- with:
- python-version: ${{ matrix.python_version }}
+ # - name: Setup Ape
+ #  uses: ApeWorX/github-action@v2
+ #  with:
+ #  python-version: ${{ matrix.python_version }}
 
- - name: Check Ape compilation
- run: ape compile
+ # - name: Check Ape compilation
+ #  run: ape compile
 
  - name: Install pnpm
  uses: pnpm/action-setup@v3
@@ -97,3 +99,32 @@ jobs:
  run: NO_COLOR=1 forge snapshot >> $GITHUB_STEP_SUMMARY
  env:
  FOUNDRY_PROFILE: default
+
+ - name: Install Homebrew
+ uses: Homebrew/actions/setup-homebrew@master
+
+ - name: Install Echidna
+ run: brew install echidna
+
+ - 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 ${{ matrix.echidna }}
+ env:
+ FOUNDRY_PROFILE: echidna
+
+ - name: Run Echidna ERC-721 property tests
+ run: echidna test/tokens/echidna/ERC721Properties.sol --contract CryticERC721ExternalHarness ${{ matrix.echidna }}
+ env:
+ FOUNDRY_PROFILE: echidna

.gitignore

@@ -60,3 +60,7 @@ dist
 
 # Ape build files
 .build
+
+# Echidna files
+echidna-corpus
+crytic-export

.gitmodules

@@ -13,12 +13,21 @@
 [submodule "lib/forge-std"]
  path = lib/forge-std
  url = https://github.com/foundry-rs/forge-std.git
+[submodule "lib/properties"]
+ path = lib/properties
+ url = https://github.com/crytic/properties.git
 [submodule "lib/create-util"]
  path = lib/create-util
  url = https://github.com/pcaversaccio/create-util.git
 [submodule "lib/erc4626-tests"]
  path = lib/erc4626-tests
  url = https://github.com/a16z/erc4626-tests.git
+[submodule "lib/FreshCryptoLib"]
+ path = lib/FreshCryptoLib
+ url = https://github.com/rdubois-crypto/FreshCryptoLib.git
+[submodule "lib/halmos-cheatcodes"]
+ path = lib/halmos-cheatcodes
+ url = https://github.com/a16z/halmos-cheatcodes.git
 [submodule "lib/solidity-bytes-utils"]
  path = lib/solidity-bytes-utils
  url = https://github.com/GNSPS/solidity-bytes-utils.git

.prettierignore

@@ -4,10 +4,15 @@ lib/solady
 lib/solmate
 lib/prb-test
 lib/forge-std
+lib/properties
 lib/create-util
 lib/erc4626-tests
+lib/FreshCryptoLib
+lib/halmos-cheatcodes
 lib/solidity-bytes-utils
 lib/openzeppelin-contracts
+echidna-corpus
+crytic-export
 cache
 out
 dist

.solhintignore

@@ -4,10 +4,15 @@ lib/solady
 lib/solmate
 lib/prb-test
 lib/forge-std
+lib/properties
 lib/create-util
 lib/erc4626-tests
+lib/FreshCryptoLib
+lib/halmos-cheatcodes
 lib/solidity-bytes-utils
 lib/openzeppelin-contracts
+echidna-corpus
+crytic-export
 cache
 out
 dist