README update & Solidity NatSpec comments #44
Conversation
- Repository structure - Overview of the different feature branches
- Fix NatSpec comment order over Pallas.sol and Vesta.sol - Added Solidity comments over PoseidonNeptuneU24Optimized.sol and Sponge.sol - Added README in poseidon folder
- Solidity doc for all cryptographic blocks file - README in src/blocks to explain each file and their content - Fixed typo in library name
storojs72
force-pushed
the
cleanup-main
branch
from
603e9e8
to
135c917
Compare
storojs72
force-pushed
the
cleanup-main
branch
from
eb74e10
to
52b17a3
Compare
There was a problem hiding this comment.
Thanks for such a diligent work, @tchataigner!
I haven't yet finished reviewing all NatSpec comments - but so far I have two common remarks (not directly related to the work itself):
- For future PRs I would recommend to setup GPG commits signing
- Your target branch is
cleanup-main, which means it also picks some commits from there. I expect some more commits added from @samuelburnham (ci: Fail e2e tests when PR base ismain#45), so eventually we will need to specifying the proper order of PRs to be merged
Yes! I guess the way to go would be merge @samuelburnham PR in #42 , i'll merge the commit in mine, there should be no conflict. And if we plan to merge #42 in |
There was a problem hiding this comment.
I finished reviewing NatSpec. Thanks again for this work!
One thing, that I actually missed in #42 is moving Sponge library that supports optimised Poseidon. While reviewing this PR it has been discovered and the 512e8b5 has been added. So, it makes sense to probably add NatSpec to NovaSpongeLib library.
- NatSpec for implementation of Sponge over the Optimized Poseidon library.
Goal of this PR
The main goal of this PR was for me to dive in cryptographic block used in our Nova Verifier ported in Solidity.
To do so, I've refactored the
READMEand tried to produce NAtSpec documentation for our Solidity files.Changelog
EqPolynomial.sol: EqPolinomialLib -> EqPolynomialLib*.solfiles insrcREADME.mdto present repository structure, along with description and state of feature branchesREADMEinsrc/blocks,src/blocks/grumpkin,src/blocks/pastaandsrc/blocks/poseidonto describe their content.Related issue
N/A