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.

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 echidna-Based Property Tests #239

Merged
merged 32 commits into from Apr 25, 2024
Merged

💥 Add echidna-Based Property Tests #239

merged 32 commits into from Apr 25, 2024

Conversation

pcaversaccio
Copy link
Owner

@pcaversaccio pcaversaccio commented Apr 22, 2024

🕓 Changelog

This PR adds the echidna-based property tests for the ERC20 and ERC721 contracts (closes #184). The ERC4626 properties are not integrated as they are already covered by erc4626-tests. Please note that hevm doesn't strip whitespace characters (!) and since Foundry doesn't easily allow for piping of commands, I wrote a Python scripts compile.py that strips away all whitespace characters.

Debugging this shit took me a fucking day. I hate software.

Please note that the echidna output AssertionFailed(..): passing is due to the fact that echidna supports a special event called AssertionFailed with any number of parameters to inform echidna about a failed assertion without using assert (see here):

image

If it's passing, no such event has been emitted.

🐶 Cute Animal Picture

image

Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
@pcaversaccio pcaversaccio added feature 💥 New feature or request dependencies 🔁 Pull requests that update a dependency file ci/cd 👷‍♂️ CI/CD configurations labels Apr 22, 2024
@pcaversaccio pcaversaccio added this to the 0.1.0 milestone Apr 22, 2024
@pcaversaccio pcaversaccio self-assigned this Apr 22, 2024
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
@pcaversaccio pcaversaccio changed the title 💥 Add echidna Property Tests 💥 Add echidna-Based Property Tests Apr 22, 2024
@pcaversaccio pcaversaccio linked an issue Apr 22, 2024 that may be closed by this pull request
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
@pcaversaccio pcaversaccio marked this pull request as ready for review April 23, 2024 10:12
@pcaversaccio pcaversaccio added the refactor/cleanup ♻️ Code refactorings and cleanups label Apr 23, 2024
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
@pcaversaccio pcaversaccio added the documentation 📖 Improvements or additions to documentation label Apr 24, 2024
@pcaversaccio pcaversaccio marked this pull request as draft April 24, 2024 13:37
@pcaversaccio pcaversaccio marked this pull request as ready for review April 24, 2024 13:37
pcaversaccio and others added 2 commits April 24, 2024 15:38
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
@pcaversaccio
Copy link
Owner Author

I would like to thank @engn33r for reviewing this PR & @elopez for helping debug an annoying worker crash issue 😄.

@pcaversaccio pcaversaccio merged commit afcf7cc into modules Apr 25, 2024
13 checks passed
@pcaversaccio pcaversaccio deleted the feat/echidna branch April 25, 2024 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/cd 👷‍♂️ CI/CD configurations dependencies 🔁 Pull requests that update a dependency file documentation 📖 Improvements or additions to documentation feature 💥 New feature or request refactor/cleanup ♻️ Code refactorings and cleanups
Projects
None yet
Development

Successfully merging this pull request may close these issues.

💥 Amend stateful (a.k.a. invariant) Tests
1 participant