Add tool to validate the correctness of the Solidity code snippets #68
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
ferranbt
changed the title
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.
This PR adds a new tool that can validate if a Solidity code snippet (that uses suave-std) is valid or not. It is intended to be used to verify that the examples in the README.md file are up to date with the implementation.
The tool reads the input file (in this case only the README.md) in Markdown, gets all the Solidity code blocks which do not have the
[skip-check]tag (none so far though). It puts the contracts in an ad-hoc repo undertools/stdcheckerand compiles it with forge. It uses remappings to map thesuave-stdlibraries to the top of the repository.It also includes a CI check to validate that
REAMDE.mdis correct.