Skip to content

Commit

Permalink
Typo fixed in: Update README.md
Browse files Browse the repository at this point in the history
Hi,

I suggest two grammatical changes for this text:

First one: "it's" vs. "its":

"Each peer/node on the network is identified via it's ENR..."
→ "Each peer/node on the network is identified via its ENR..."
Explanation: "It's" is a contraction of "it is," whereas "its" is the possessive form.

Second one: "PING/PONG's":

"through regular PING/PONG's with discovered nodes."
→ "through regular PING/PONGs with discovered nodes."
Explanation: "PING/PONGs" should not have an apostrophe since it refers to a plural form, not possession.

Thanks and a happy new year.
  • Loading branch information
Akare123 authored Jan 5, 2025
1 parent 40d4355 commit 6f580b4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions version-meld/discv5/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ This is a rust implementation of the [Discovery v5](https://github.com/ethereum/
peer discovery protocol.

Discovery v5 is a protocol designed for encrypted peer discovery and topic advertisement. Each peer/node
on the network is identified via it's `ENR` ([Ethereum Node
on the network is identified via its `ENR` ([Ethereum Node
Record](https://eips.ethereum.org/EIPS/eip-778)), which is essentially a signed key-value store
containing the node's public key and optionally IP address and port.

Discv5 employs a kademlia-like routing table to store and manage discovered peers and topics. The
protocol allows for external IP discovery in NAT environments through regular PING/PONG's with
protocol allows for external IP discovery in NAT environments through regular PING/PONGs with
discovered nodes. Nodes return the external IP address that they have received and a simple
majority is chosen as our external IP address. If an external IP address is updated, this is
produced as an event to notify the swarm (if one is used for this behaviour).
Expand Down

0 comments on commit 6f580b4

Please sign in to comment.