Skip to content
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

feat: Add Mempool Specification to Zebra Book #9336

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

Conversation

crStiv
Copy link

@crStiv crStiv commented Mar 19, 2025

Motivation

  • Document the Zebra mempool architecture, behavior, and interfaces
  • Create a comprehensive specification for developers
  • Close issue Specify the Zebra mempool #9302: "Specify the Zebra mempool"

Solution

  • Added detailed mempool specification document in the Developer Documentation section of the Zebra book
  • Created a mermaid diagram illustrating the mempool architecture and transaction flow
  • Updated the book's SUMMARY.md to include links to new documentation

Tests

  • Verified that markdown formatting is correct
  • Checked that internal links are valid
  • Ensured the mermaid diagram syntax is correct and will render properly

Specifications & References

  • Based on current Zebra mempool implementation
  • Referenced ZIP-401 where appropriate

PR Checklist

  • The PR name is suitable for the release notes.
  • The solution is tested.
  • The documentation is up to date.
  • The PR has a priority label.
  • If the PR shouldn't be in the release notes, it has the C-exclude-from-changelog label.

@crStiv crStiv requested a review from a team as a code owner March 19, 2025 20:57
@crStiv crStiv requested review from conradoplg and removed request for a team March 19, 2025 20:57
@github-actions github-actions bot added the C-feature Category: New features label Mar 19, 2025
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

Hi, thank you for making this, i think is very useful.

In a high level overview i found a few things that we might want to fix.

This diagram illustrates the architecture of the Zebra mempool, showing its main components and the flow of transactions through the system.

```mermaid
graph TD
Copy link
Contributor

Choose a reason for hiding this comment

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

I am having some issues visualizing the flowchart:

mem

@crStiv
Copy link
Author

crStiv commented Mar 20, 2025

Hi, thank you for making this, i think is very useful.

In a high level overview i found a few things that we might want to fix.

@oxarbitrage made changes as you suggested, what are ur thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature Category: New features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants