Skip to content

Commit 2948146

Browse files
author
Emilia Hane
authored
Remove topics (#186)
1 parent 715fc82 commit 2948146

File tree

4 files changed

+9
-330
lines changed

4 files changed

+9
-330
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Status]][Crates Link]
1919
This is a rust implementation of the [Discovery v5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)
2020
peer discovery protocol.
2121

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

src/lib.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
//! Record](https://eips.ethereum.org/EIPS/eip-778)), which is essentially a signed key-value store
1212
//! containing the node's public key and optionally IP address and port.
1313
//!
14-
//! Discv5 employs a kademlia-like routing table to store and manage discovered peers and topics. The
14+
//! Discv5 employs a kademlia-like routing table to store and manage discovered peers (and topics tba). The
1515
//! protocol allows for external IP discovery in NAT environments through regular PING/PONG's with
1616
//! discovered nodes. Nodes return the external IP address that they have received and a simple
1717
//! majority is chosen as our external IP address. If an external IP address is updated, this is
@@ -27,11 +27,12 @@
2727
//! * Handler - The protocol's communication is encrypted with `AES_GCM`. All node communication
2828
//! undergoes a handshake, which results in a [`Session`]. [`Session`]'s are established when
2929
//! needed and get dropped after a timeout. This section manages the creation and maintenance of
30-
//! sessions between nodes and the encryption/decryption of packets from the socket. It is realised by the [`handler::Handler`] struct and it runs in its own task.
30+
//! sessions between nodes and the encryption/decryption of packets from the socket. It is
31+
//! realised by the [`handler::Handler`] struct and it runs in its own task.
3132
//! * Service - This section contains the protocol-level logic. In particular it manages the
32-
//! routing table of known ENR's, topic registration/advertisement and performs various queries
33-
//! such as peer discovery. This section is realised by the [`Service`] struct. This also runs in
34-
//! it's own thread.
33+
//! routing table of known ENR's, (and topic registration/advertisement tba) and performs
34+
//! parallel queries for peer discovery. This section is realised by the [`Service`] struct. This
35+
//! also runs in it's own thread.
3536
//! * Application - This section is the user-facing API which can start/stop the underlying
3637
//! tasks, initiate queries and obtain metrics about the underlying server.
3738
//!

0 commit comments

Comments
 (0)