protocols/: Add documentation on peer discovery (#2465)

Co-authored-by: Max Inden <mail@max-inden.de>
This commit is contained in:
Frederik-Baetens
2022-02-09 15:54:07 +01:00
committed by GitHub
parent 0bb8ee98d5
commit 5a95a46cd3
3 changed files with 34 additions and 0 deletions

View File

@ -51,6 +51,18 @@
//! integers. They are chosen at random in this implementation of gossipsub, but are sequential in
//! the current go implementation.
//!
//! # Peer Discovery
//!
//! Gossipsub does not provide peer discovery by itself. Peer discovery is the process by which
//! peers in a p2p network exchange information about each other among other reasons to become resistant
//! against the failure or replacement of the
//! [boot nodes](https://docs.libp2p.io/reference/glossary/#boot-node) of the network.
//!
//! Peer
//! discovery can e.g. be implemented with the help of the [Kademlia](https://github.com/libp2p/specs/blob/master/kad-dht/README.md) protocol
//! in combination with the [Identify](https://github.com/libp2p/specs/tree/master/identify) protocol. See the
//! Kademlia implementation documentation for more information.
//!
//! # Using Gossipsub
//!
//! ## GossipsubConfig