Mina-poseidon: regression tests + top-level documentation #2927
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The interface to instantiate a sponge is not straightforward to use. This commit adds an example at the top-level of the library to guide the users.
It is not straightforward by reading the documentation that the method `challenge` outputs a 128 bits value for Pallas/Vesta. Therefore, adding a test to be sure this invariant is respected over time. This commit also adds a regression test when squeezing the empty state.
dannywillems
force-pushed
the
dw/mina-poseidon-doc-and-tests
branch
from
3dba477 to
9b5c406
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2927 +/- ##
==========================================
- Coverage 75.55% 75.55% -0.01%
==========================================
Files 255 255
Lines 60814 60814
==========================================
- Hits 45951 45948 -3
- Misses 14863 14866 +3 ☔ View full report in Codecov by Sentry. |
marcbeunardeau88
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See commit messages.
This work is part of the sponge management currently being implemented in Arrabbiata.