8000 docs: add `MaxMessageDelay` and `MaxPrecision` to spec · Issue #4893 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: add MaxMessageDelay and MaxPrecision to spec #4893

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.

Sign up for GitHub

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

Jump to bottom
Closed
melekes opened this issue Jan 30, 2025 · 1 comment · Fixed by #5046
Closed

docs: add MaxMessageDelay and MaxPrecision to spec #4893

melekes opened this issue Jan 30, 2025 · 1 comment · Fixed by #5046
Labels
documentation Improvements or additions to documentation

Comments

@melekes
Copy link
Contributor
melekes commented Jan 30, 2025

Update:

to reflect the changes from #4816.

Originally posted by @cason in #4816 (comment)
@melekes melekes added the documentation Improvements or additions to documentation label Jan 30, 2025
@melekes melekes mentioned this issue Jan 30, 2025
Merged
@Himess Himess mentioned this issue Mar 26, 2025
Merged
3 tasks
@Himess
Copy link
Contributor
Himess commented Mar 26, 2025

Opened PR #5046 to resolve this.

github-merge-queue bot pushed a commit that referenced this issue Apr 20, 2025
@Himess
docs: document max values for PBTS Precision and MessageDelay (#5046)
d6c2501 
Closes #4893 
This PR updates the PBTS-related documentation to reflect the
implementation constraints introduced in #4816.

- In `proposer-based-timestamps.md`, added notes under `Precision` and
`MessageDelay` to document the hard-coded caps:
  - `Precision` ≤ 30s
  - `MessageDelay` ≤ 24h

- In `data_structures.md`, added a note below the SynchronyParams table
to mention these limits as implementation constraints.

- In `pbts-sysmodel.md`, included a note after [PBTS-MSG-DELAY.0]
explaining that although these parameters are bounded in the
implementation, it has no impact on the formal model.

These updates ensure that readers are aware of the practical limitations
applied in the implementation and help prevent misconfiguration or
misunderstanding.
#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: document max values for PBTS Precision and MessageDelay Himess/cometbft
2 participants
@melekes @Himess
0