docs: clarify the imprecise "meant for peer discovery only" wording f…#501
Merged
Conversation
…or discv5 and add its three core functions
Contributor
taxmeifyoucan
left a comment
taxmeifyoucan
left a comment
There was a problem hiding this comment.
Thanks for the PR, it's very simplified that the current text says it's peer discovery only. It's still a bit ambivalent and could be more specific about the protocol (Kademlia routing table + lookup) and features you are listing
| Discovery Version 5 [(discv5)][discv5] (Protocol version v5.1) runs on UDP and meant for peer discovery only. It enables nodes to exchange and update ENRs dynamically, ensuring up-to-date peer discovery. It runs in parallel with libp2p. | ||
| Discovery Version 5 [(discv5)][discv5] (Protocol version v5.1) is a | ||
| UDP-based node discovery protocol. It is used to discover peers and retrieve | ||
| the latest Ethereum Node Records (ENRs). Its three core functions are: |
Contributor
There was a problem hiding this comment.
new line in middle of sentence, not only here
Contributor
Author
Okay, I'll continue improving on this branch. |
…on, and handshake flow
Contributor
|
Thanks for the updates! |
taxmeifyoucan
merged commit 3bee04b
into
eth-protocol-fellows:main
1 of 2 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR clarifies the discv5 section in the CL networking documentation. The previous wording, especially "meant for peer discovery only", was overly narrow and did not fully reflect the official devp2p discv5 specification. This update revises the description to better capture discv5 as a UDP-based node discovery protocol and adds its three core functions: sampling live participants, searching for participants providing a certain service, and retrieving the latest node record for a known node ID. It also keeps the relationship between discv5 and libp2p clear in the consensus-layer context.