feat[docs]: add docs for @raw_return decorator#4699
Merged
charles-cooper merged 7 commits intovyperlang:masterfrom Jun 17, 2025
Merged
feat[docs]: add docs for @raw_return decorator#4699charles-cooper merged 7 commits intovyperlang:masterfrom
@raw_return decorator#4699charles-cooper merged 7 commits intovyperlang:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4699 +/- ##
=======================================
Coverage 92.94% 92.94%
=======================================
Files 131 131
Lines 19037 19037
Branches 3309 3309
=======================================
Hits 17694 17694
Misses 905 905
Partials 438 438 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pcaversaccio
approved these changes
Jun 16, 2025
docs/control-structures.rst
Outdated
| ``@view`` Function does not alter contract state | ||
| ``@payable`` Function is able to receive Ether | ||
| ``@nonreentrant`` Function cannot be called back into during an external call | ||
| ``@raw_return`` Function returns raw bytes without ABI-encoding (external functions only) |
Collaborator
There was a problem hiding this comment.
Suggested change
| ``@raw_return`` Function returns raw bytes without ABI-encoding (external functions only) | |
| ``@raw_return`` Function returns raw bytes without ABI-encoding (``@external`` functions only) |
docs/control-structures.rst
Outdated
| * It can only be used on ``@external`` functions | ||
| * The function must have a ``Bytes[N]`` return type | ||
| * It cannot be used on ``@deploy`` (constructor) functions | ||
| * It cannot be used on internal functions |
Collaborator
There was a problem hiding this comment.
Suggested change
| * It cannot be used on internal functions | |
| * It cannot be used on ``@internal`` functions |
docs/control-structures.rst
Outdated
| @raw_return | ||
| def forward_call(target: address) -> Bytes[1024]: | ||
| # Returns the raw bytes from the external call without ABI-encoding | ||
| return raw_call(target, msg.data, max_outsize=1024, is_delegate_call=True) |
Collaborator
There was a problem hiding this comment.
to make the example more generic, let's add @payable and also msg.value to raw_call
docs/control-structures.rst
Outdated
|
|
||
| * It can only be used on ``@external`` functions | ||
| * The function must have a ``Bytes[N]`` return type | ||
| * It cannot be used on ``@deploy`` (constructor) functions |
Collaborator
There was a problem hiding this comment.
Suggested change
| * It cannot be used on ``@deploy`` (constructor) functions | |
| * It cannot be used on ``@deploy`` (constructor) functions (you can however use it in the `__default__()` function) |
Collaborator
|
maybe let's add a note that calling such function via interface is impossible and that |
Collaborator
|
also maybe mention the potential pitfall of having multiple return statements one of which doesn't expect the data to not be abi encoded |
cyberthirst
approved these changes
Jun 17, 2025
cyberthirst
approved these changes
Jun 17, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What I did
How I did it
How to verify it
Commit message
Commit message for the final, squashed PR. (Optional, but reviewers will appreciate it! Please see our commit message style guide for what we would ideally like to see in a commit message.)
Description for the changelog
Cute Animal Picture