-
Notifications
You must be signed in to change notification settings - Fork 554
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: improve documentation of BlockParams.MaxBytes #1405
Conversation
Co-authored-by: Sergio Mena <sergio@informal.systems>
Co-authored-by: Sergio Mena <sergio@informal.systems>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏
Co-authored-by: glnro <8335464+glnro@users.noreply.github.com>
@@ -615,6 +622,13 @@ If the Application sets value -1, consensus will: | |||
|
|||
Must have `MaxBytes == -1` OR `0 < MaxBytes <= 100 MB`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I remember correctly this -1 was introduced by @sergio-mena to allow for arbitrary block size or is there some other reason? I know that in 0.34.x it is not allowed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this is probably only on main
. 34 and 37 not for sure, v0.38 I'll have to double check when backporting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIRC, this is on main
, v0.38.x
, and v0.37x
(as it tackles a corner case on PrepareProposal
), but I might be mistaken
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In v0.37.x it is not implemented at consensus level, from this extract:
https://github.com/cometbft/cometbft/blob/v0.37.x/consensus/state.go#L1937
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In v0.38.x it is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So my memories weren't accurate
Additions to the description of the
BlockParams.MaxBytes
consensus parameter on the ABCI documentation.Rendered: https://github.com/cometbft/cometbft/blob/cason/doc-maxbytes-param/spec/abci/abci%2B%2B_app_requirements.md
PR checklist
.changelog
(we use unclog to manage our changelog)docs/
orspec/
) and code comments