8000 docs: document max values for PBTS Precision and MessageDelay by Himess · Pull Request #5046 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: document max values for PBTS Precision and MessageDelay #5046

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
Merged
merged 3 commits into from
Apr 20, 2025
Merged

docs: document max values for PBTS Precision and MessageDelay #5046

merged 3 commits into from
Apr 20, 2025

Conversation

Himess
Copy link
Contributor
@Himess Himess commented Mar 26, 2025

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 to manage our changelog)
  • Updated relevant documentation (docs/ or spec/) and code comments

@Himess Himess requested review from a team as code owners March 26, 2025 12:52
@Himess Himess mentioned this pull request Mar 26, 2025
Closed
@Himess
Copy link
Contributor Author
Himess commented Mar 29, 2025

Hi @melekes , Could you check this ?

@github-actions GitHub Actions
Copy link
github-actions bot commented Apr 9, 2025

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale For use by stalebot label Apr 9, 2025
@Himess
Copy link
Contributor Author
Himess commented Apr 9, 2025

@melekes

@zrbecker zrbecker closed this Apr 9, 2025
@melekes melekes reopened this Apr 18, 2025
@ironbird-prod Ironbird (prod)
Copy link
ironbird-prod bot commented Apr 18, 2025
Ironbird - launch a network To use Ironbird, you can use the following commands:
  • /ironbird start OR /ironbird start --load-test-config= - Launch a testnet with the specified chain and load test configuration.
  • /ironbird chains - List of chain images that ironbird can use to spin-up testnet
  • /ironbird loadtests - List of load test modes that ironbird can run against testnet
Custom Load Test Configuration You can provide a custom load test configuration using the `--load-test-config=` flag: 
/ironbird start cosmos --load-test-config={
  "block_gas_limit_target": 0.75,
  "num_of_blocks": 50,
  "msgs": [
    {"weight": 0.3, "type": "MsgSend"},
    {"weight": 0.3, "type": "MsgMultiSend"},
	{"weight": 0.4, "type": "MsgArr", "ContainedType": "MsgSend", "NumMsgs": 3300}
  ]
}

Use /ironbird loadtests to see more examples.

melekes
melekes approved these changes Apr 18, 2025
View reviewed changes
Copy link
Contributor
@melekes melekes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@melekes
Copy link
Contributor
melekes commented Apr 18, 2025

I think this is worth adding.

@melekes melekes removed the stale For use by stalebot label Apr 18, 2025
@Himess
Copy link
Contributor Author
Himess commented Apr 18, 2025

/ironbird start

@ironbird-prod Ironbird (prod)
Copy link
ironbird-prod bot commented Apr 18, 2025

Ironbird failed to run command /ironbird start:

user Himess is not a member of the organization

@zrbecker zrbecker added this pull request to the merge queue Apr 20, 2025
Merged via the queue into cometbft:main with commit d6c2501 Apr 20, 2025
31 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@melekes melekes melekes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add MaxMessageDelay and MaxPrecision to spec
3 participants
@Himess @melekes @zrbecker
0