docs: clarify tx-wide default max units explainer #24955
Merged
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
|
I updated docs in the backports while fixing the merge errors but this looks great too! |
jackcmay
approved these changes
May 3, 2022
jstarry
approved these changes
May 4, 2022
jstarry
reviewed
May 4, 2022
| exceed that value. The default number of maximum units allowed matches existing | ||
| values to avoid breaking existing client behavior. | ||
| transaction-wide default maximum number of units will be calculated as the product | ||
| of the instruction count and the existing per-instruction maximum units. This means |
There was a problem hiding this comment.
Can you also mention that the calculated max is clamped at 1.4M compute units?
There was a problem hiding this comment.
Considered referencing the current constant values, but decided I didn't want to be responsible for keeping them up to date
There was a problem hiding this comment.
Can we say something like "at the time of writing, this caps at 1.4M but it's subject to change" as a cop out? I think it's useful
There was a problem hiding this comment.
I see no precedent for citing other constant values in this file. Feel free to add them if you feel strongly!
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.
Problem
unclear description of how tx-wide compute budget will calculate the default maximum units
Summary of Changes
attempt to clarify it