-
Notifications
You must be signed in to change notification settings - Fork 1
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
feat/code review #141
Open
davibauer
wants to merge
10
commits into
main
Choose a base branch
from
feat/code-review
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat/code review #141
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
Contributor
davibauer
commented
Feb 5, 2024
•
edited
Loading
edited
- The usage of several formal verification annotations is noted, but nothing is checked against.
- The Interface (gas-payer-v1) and Verifier (groth16-verifier) have no comments please add. Additionally, the test suite requires more explanatory comments.
- The MerkleTree contract has no comments, and it’s difficult to ascertain the origins and meanings of various hashes and values, such as those in poseidon-zeros and blake-zeros. The tests focus solely on successful scenarios (using ‘except’) and neglect failure cases (which would use ‘expect-failure’).
- The repository’s contracts directory includes redundant or outdated files, like the poseidon directory.
- The contract ‘opact’ has no explanatory comments, requires a description. The tests in ‘transact-tests.repl’ feature numerous commented-out lines, and there requires more test cases.
- The test cases could benefit from being more comprehensive.
- The reliance on JavaScript for generating contracts and files may not be the best approach. While it can be utilized for initial generation, the final versions should be committed to the repository.
- The project structure, as outlined in the Readme.md, seems incomplete. It fails to mention certain aspects like ‘transact’, for example.
…ain the origins and meanings of various hashes and values, such as those in poseidon-zeros and blake-zeros. The tests focus solely on successful scenarios (using ‘except’) and neglect failure cases (which would use ‘expect-failure’)
…iles, like the poseidon directory
…iles, like the poseidon directory
…. It fails to mention certain aspects like ‘transact’, for example
… be the best approach. While it can be utilized for initial generation, the final versions should be committed to the repository
…ption. The tests in ‘transact-tests.repl’ feature numerous commented-out lines, and there requires more test cases. Overall, there is an almost complete absence of code comments. - The usage of several formal verification annotations is noted, but nothing is checked against. - The test cases could benefit from being more comprehensive.
…comments please add. Additionally, the test suite requires more explanatory comments
…ain the origins and meanings of various hashes and values, such as those in poseidon-zeros and blake-zeros. The tests focus solely on successful scenarios (using ‘except’) and neglect failure cases (which would use ‘expect-failure’)
…ion. The tests in ‘transact-tests.repl’ feature numerous commented-out lines, and there requires more test cases. Overall, there is an almost complete absence of code comments
…ion. The tests in ‘transact-tests.repl’ feature numerous commented-out lines, and there requires more test cases. Overall, there is an almost complete absence of code comments
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.