Improve MessageCallGas documentation
#904
Open
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
SamWilsn
reviewed
Apr 3, 2024
| The portion of gas available to sub-calls that is refundable | ||
| if not consumed | ||
| if not consumed. | ||
| """ | ||
|
|
||
| cost: Uint |
There was a problem hiding this comment.
Would it make sense to also rename cost to total or something similar? Looks like it excludes the memory expansion cost though, and that might be a tad misleading.
There was a problem hiding this comment.
- Added in a comment that it excludes memory expansion to be explicit.
- Keeping
costin the variable name is good imo since it is added to some othercostafterwards, maybetotal_costwould work?
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.
What was wrong?
MessageCallGas.cost's documentation stated that it was "The non-refundable portion of gas reserved for executing the call opcode.". However,MessageCallGas.costincludes the gas to be passed to the sub-call (excluding the2300gas stipend) and hence, it is not true that it is non-refundable since some of the gas passed might be refunded upon returning from the sub-call.The name
MessageCallGas.stipendcan be misleading as "stipend" is also often used to refer to the2300gas stipend appended to calls with a non-null value.How was it fixed?
MessageCallGas.costto remove the "non-refundable" mention.MessageCallGas.stipendtoMessageCallGas.sub_call.Cute Animal Picture