8000 Consolidate existing mempool specs and documentation · Issue #1076 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Consolidate existing mempool specs and documentation #1076

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
cason opened this issue Jul 3, 2023 · 4 comments
Closed

Consolidate existing mempool specs and documentation #1076

cason opened this issue Jul 3, 2023 · 4 comments
Labels
mempool P:bandwidth-optimization Priority: Optimize bandwidth usage spec Specification-related

Comments

@cason
Copy link
Contributor
cason commented Jul 3, 2023

At its current state, the repository does not really contain specific documentation about the mempool.

In the specification, the item mempool on spec/README.md points to spec/p2p/legacy-docs/messages/mempool.md, which documents the channel and the message used by the mempool reactor.

In the documentation, the docs/core/mempool.md entry is not very helpful as well in terms of documentation. While the mempool is mentioned in other locations, this is the only document that specifically refers to the mempool.

The goal of this issue are therefore two:

  1. Enumerate the existing content regarding the mempool (list of pending transactions) and the mempool protocol (that exchanges transactions between nodes)
  2. Create a location in the repository collecting the summary of the existing documentation, with pointers to the content enumerated in 1.

This issue should be seen as a (weak) dependency for the refactor/improvements proposed in #1048

Definition of Done

  • We have a spec/mempool directory in the repository with some basic content about this component/protocol of CometBFT
  • We populate this directory with the existing content, or links to the existing content, regarding the mempool, including recent specification/documentation efforts hosted elsewhere
@cason cason added mempool spec Specification-related meta Meta-level issues/discussions, e.g. relating to process or policy labels Jul 3, 2023
@cason cason self-assigned this Jul 3, 2023
@hvanz
Copy link
Member
hvanz commented Jul 3, 2023

Some scattered documents related to the mempool:

@cason cason removed the meta Meta-level issues/discussions, e.g. relating to process or policy label Jul 3, 2023
@hvanz
Copy link
Member
hvanz commented Jul 4, 2023 •
edited
Loading

Some info on the field ids: mempoolIDs in the mempool reactor: #1043 (comment)

@hvanz hvanz mentioned this issue Jul 5, 2023
Closed
@cason cason added this to the 2023-Q3 milestone Jul 5, 2023
@hvanz hvanz mentioned this issue Jul 5, 2023
Closed
3 tasks
@hvanz hvanz changed the title Consolidate the existing specs and documentation of the mempool mempool: Consolidate existing specs and documentation Jul 5, 2023
@lasarojc lasarojc added the P:bandwidth-optimization Priority: Optimize bandwidth usage label Jul 5, 2023
@lasarojc lasarojc changed the title mempool: Consolidate existing specs and documentation Consolidate existing mempool specs and documentation Jul 5, 2023
@thanethomson thanethomson modified the milestones: 2023-Q3, 2023-Q4 Oct 10, 2023
@adizere adizere modified the milestones: 2023-Q4, 2024-Q1 Jan 10, 2024
@cason cason removed their assignment Feb 21, 2024
@cason
Copy link
Contributor Author
cason commented Feb 21, 2024

@hvanz, can we solve this issue? Like moving the stable content to this repository? Do you mind take it over?

@adizere adizere removed this from the 2024-Q1 milestone Apr 1, 2024
@hvanz
Copy link
Member
hvanz commented Dec 20, 2024

Closing as spec/mempool now contains specs of all the mempool components (recently #4318 has added specs for the gossip protocols).

@hvanz hvanz closed this as completed Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
mempool P:bandwidth-optimization Priority 4F92 : Optimize bandwidth usage spec Specification-related
Projects
No open projects
CometBFT 2023
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
5 participants
@thanethomson @cason @adizere @lasarojc @hvanz
0