Docs: Fixes devP2P page#365
Conversation
|
hey @taxmeifyoucan @marioevz @joshdavislight @raxhvl |
|
Hey @RazorClient I will review it this weekend. I glanced through it and you're off to a good start. |
There was a problem hiding this comment.
Thanks for putting this together @RazorClient @raa-dev. I have left some comments, looking good!
I would say, let's merge this stub and we can improve it later.
|
@raxhvl @taxmeifyoucan |
Sounds good. |
taxmeifyoucan
left a comment
There was a problem hiding this comment.
Thanks for the PR!
It's a good start but I believe it needs refining. The page seems to just recap some devp2p spec without much context and explanation. It should guide the reader through various parts of the communication stack, not only copy the content in many nested headers..
I would suggest waiting for next weeks talk, lecture 18 will be by Felix focused on devp2p! You can use his materials to refine this further
| > :warning: This article is a [stub](https://en.wikipedia.org/wiki/Wikipedia:Stub), help the wiki by [contributing](/contributing.md) and expanding it. | ||
|
|
||
| The execution layer implements [devp2p](https://github.com/ethereum/devp2p) as its communication protocol with nodes in the network. It includes various subprotocols and features: eth, snap, les, pip, wit. | ||
| ## Peer To Peer(P2P) Communication |
There was a problem hiding this comment.
Starting to read, this intro section sounds LLM generated. Please don't use LLM content in the wiki.
It's unnecessary long and generic. The intro could be just a short paragraph with links to more information about p2p networking/mesh networks, etc.
|
|
||
| P2P communication is the foundation of many distributed applications, enabling efficient data sharing, real-time coordination, and resilient connectivity in decentralized systems. | ||
|
|
||
| ## Importance of P2P in Ethereum |
There was a problem hiding this comment.
For the context you can add there is different p2p network in CL but then just focus it specifically on devp2p. Its importance is self explanatory..
docs/wiki/EL/devp2p.md
Outdated
| - **RLPx supports multiple application-level subprotocols** that enable specialized communication between Ethereum nodes. | ||
| - These subprotocols are **built on top of the RLPx transport layer** and are used for data exchange, state synchronization, and light client support. | ||
|
|
||
| #### Common Ethereum Subprotocols |
There was a problem hiding this comment.
I think subprotocols should be in the first part of the section to provide an overview of what functions are there in the first place
| | **Ethereum Snapshot Protocol (`snap`)** | Used for **state synchronization**, allowing nodes to download portions of the state trie. | | ||
| | **Light Ethereum Subprotocol (`les`)** | Supports **light clients**, enabling them to request data from full nodes without storing the full state. | | ||
| | **Portal Network (`portal`)** | A decentralized **state, block, and transaction retrieval network** for lightweight clients. | | ||
|
|
There was a problem hiding this comment.
Sources and extra resources are missing. Is this information based on devp2p spec or other document? List any relevant materials, devcon talks, etc
|
Hey @taxmeifyoucan added the requested changes and left a few questions |
|
I noticed this still without being merge. Here's my proposal, I can cherry-pick relevant commits from the current branch into the one I worked, so we can proceed with a last review before merging. The 148-devp2p branch (#255) has lots of references and I made some diagrams too. |
|
works |
|
That would be great @raa-dev. I think it needs to be more concise and provide context for specs |
i'd really appreciate it, gonna work on this tonight. @RazorClient |
|
Just for the record: |
Wiki PR Checklist
Closes #148
Thank you for contributing to the Protocol Wiki! Before you open a PR, make sure to read information for contributors and take a look at following checklist:
This Pr reworks the el networking(devp2p) page and add info about various sub protocols