Skip to content

docs(mempool): fix example in priority_nonce_spec #24971

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

thomas-nguy
Copy link

@thomas-nguy thomas-nguy commented Jul 23, 2025

Description

Closes: #XXXX

Fixing a small typo which may lead to confusion when reading the spec

Summary by CodeRabbit

  • Documentation
    • Updated the example table in the priority nonce specification to reflect a new priority value for a transaction, clarifying transaction ordering behavior.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2025

📝 Walkthrough

Walkthrough

The priority value for a transaction in an example table within the mempool priority nonce specification documentation was updated from 7 to 90. No other content, diagrams, or descriptions were changed.

Changes

File Change Summary
types/mempool/priority_nonce_spec.md Updated transaction priority value in example table.

Estimated code review effort

1 (~2 minutes)

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
types/mempool/priority_nonce_spec.md (1)

146-146: Typo: “priroity” → “priority”
Tiny spelling fix for clarity.

-...nonce/priroity ordering scheme...
+...nonce/priority ordering scheme...
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between c586ff2 and d216a07.

📒 Files selected for processing (1)
  • types/mempool/priority_nonce_spec.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Summary
🔇 Additional comments (1)
types/mempool/priority_nonce_spec.md (1)

118-120: Change looks correct and keeps narrative consistent
The updated priority 90 now matches the text in the explanation paragraph and the mempool-order list below. No further issues spotted.

@aljo242
Copy link
Contributor

aljo242 commented Jul 23, 2025

@thomas-nguy can you provide some more context on the issue here?

@thomas-nguy
Copy link
Author

thomas-nguy commented Jul 24, 2025

Hi @aljo242 ,

The spec seems to provide a wrong example

If you look at the Case 4

The priority table show Priority 7 For User C transaction nonce 3


Sender | Nonce | Priority
-- | -- | --
C | 3 | 7
-- | -- | --

but it should be 90 according to the diagram and result order.

https://github.com/cosmos/cosmos-sdk/blob/main/types/mempool/priority_nonce_spec.md

I think the whole point of this example is to show that even though User C transaction nonce 3 has the highest priority (90), it is still ordered last due to the graph constraints

@thomas-nguy thomas-nguy changed the title chore(mempool): fix typo in priority_nonce_spec.md docs(mempool): fix example in priority_nonce_spec Jul 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants