chore[ux]: compute natspec as part of standard pipeline #3946
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
prior to this commit, natspec had to be explicitly requested by the user (`-f userdoc`, `-f devdoc` or `-f combined_json`). this would lead to discrepancies between development time and verification time, where a contract could compile locally (because no natspec was requested), but not on the verifier's pipeline (because the verifier would request the natspec via one of the above methods). this commit computes the natspec as part of the dependencies of IR generation, so there is no way to produce bytecode for a contract without validating natspec.
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #3946 +/- ##
=======================================
Coverage 90.84% 90.85%
=======================================
Files 95 95
Lines 14436 14449 +13
Branches 3201 3204 +3
=======================================
+ Hits 13114 13127 +13
Misses 914 914
Partials 408 408 ☔ View full report in Codecov by Sentry. |
presumably, a consumer requesting annotated ast would want natspec as well
fubuloubu
approved these changes
Apr 14, 2024
pcaversaccio
added a commit
to pcaversaccio/snekmate
that referenced
this pull request
Apr 15, 2024
…devdoc` Sanity Check (#235) ### 🕓 Changelog This PR refactors the existing module-friendly contracts to use the new dunder method `__interface__` (see vyperlang/vyper#3919), which allows you to export all functions of a module without specifying the individual functions. We apply the following rules: - Library modules keep the individual list `exports` syntax due to explicitness (application developers can thus identify faster what is exported within a library module), - Mocks might use it if more than one `external` function is exported. We do not use it in mock contracts if critical code comments for exported functions would be lost. Furthermore, we remove the `userdoc` and `devdoc` compilation script & CI pipeline since it's now computed as part of the standard compilation pipeline (vyperlang/vyper#3946). --------- Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch> Co-authored-by: sudo rm -rf --no-preserve-root / <pcaversaccio@users.noreply.github.com> Co-authored-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
electriclilies
pushed a commit
to electriclilies/vyper
that referenced
this pull request
Apr 27, 2024
prior to this commit, natspec had to be explicitly requested by the user (`-f userdoc`, `-f devdoc` or `-f combined_json`). this would lead to discrepancies between development time and verification time, where a contract could compile locally (because no natspec was requested), but not on the verifier's pipeline (because the verifier would request the natspec via one of the above methods). this commit computes the natspec as part of the dependencies of the analysed AST (the reasoning being that, a consumer might expect semantic analysis to include natspec validation). so, there is no way to produce bytecode for a contract without validating natspec.
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.
Commit message
Description for the changelog
Cute Animal Picture