jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: cleanup discv4 docs (#13884)

Browse Source
This commit is contained in:
Matthias Seitz
2025-01-21 13:53:03 +01:00
committed by GitHub
parent c4b147c031
commit 3317ea1f2c
3 changed files with 16 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
crates/net/discv4/src/lib.rs
View File

@ -157,9 +157,10 @@ pub(crate) type IngressReceiver = mpsc::Receiver<IngressEvent>;
type NodeRecordSender = OneshotSender<Vec<NodeRecord>>;
/// The Discv4 frontend
/// The Discv4 frontend.
///
/// This communicates with the [`Discv4Service`] by sending commands over a channel.
/// This is a cloneable type that communicates with the [`Discv4Service`] by sending commands over a
/// shared channel.
///
/// See also [`Discv4::spawn`]
#[derive(Debug, Clone)]
@ -174,11 +175,10 @@ pub struct Discv4 {
node_record: Arc<Mutex<NodeRecord>>,
}
// === impl Discv4 ===
impl Discv4 {
/// Same as [`Self::bind`] but also spawns the service onto a new task,
/// [`Discv4Service::spawn()`]
/// Same as [`Self::bind`] but also spawns the service onto a new task.
///
/// See also: [`Discv4Service::spawn()`]
pub async fn spawn(
local_address: SocketAddr,
local_enr: NodeRecord,
@ -421,6 +421,15 @@ impl Discv4 {
///
/// This is a [Stream] to handles incoming and outgoing discv4 messages and emits updates via:
/// [`Discv4Service::update_stream`].
///
/// This type maintains the discv Kademlia routing table and is responsible for performing lookups.
///
/// ## Lookups
///
/// See also [Recursive Lookups](https://github.com/ethereum/devp2p/blob/master/discv4.md#recursive-lookup).
/// Lookups are either triggered periodically or performaned on demand: [`Discv4::lookup`]
/// Newly discovered nodes are emitted as [`DiscoveryUpdate::Added`] event to all subscribers:
/// [`Discv4Service::update_stream`].
#[must_use = "Stream does nothing unless polled"]
pub struct Discv4Service {
/// Local address of the UDP socket.
@ -694,7 +703,7 @@ impl Discv4Service {
/// Spawns this services onto a new task
///
/// Note: requires a running runtime
/// Note: requires a running tokio runtime
pub fn spawn(mut self) -> JoinHandle<()> {
tokio::task::spawn(async move {
self.bootstrap();