Crate libp2p_kad

Implementation of the libp2p-specific Kademlia protocol.

Important Discrepancies

• Peer Discovery with Identify In other libp2p implementations, the Identify protocol might be seen as a core protocol. Rust-libp2p tries to stay as generic as possible, and does not make this assumption. This means that the Identify protocol must be manually hooked up to Kademlia through calls to Kademlia::add_address. If you choose not to use the Identify protocol, and do not provide an alternative peer discovery mechanism, a Kademlia node will not discover nodes beyond the network’s boot nodes. Without the Identify protocol, existing nodes in the kademlia network cannot obtain the listen addresses of nodes querying them, and thus will not be able to add them to their routing table.

Re-exports

• pub use protocol::KadConnectionType;
• pub use record::store;
• pub use record::ProviderRecord;
• pub use record::Record;

Modules

• handler
• kbucket
  Implementation of a Kademlia routing table as used by a single peer participating in a Kademlia DHT.
• protocol
  The Kademlia connection protocol upgrade and associated message types.
• record
  Records and record storage abstraction of the libp2p Kademlia DHT.

Structs

• AddProviderOk
  The successful result of publishing a provider record.
• Addresses
  A non-empty list of (unique) addresses of a peer in the routing table.
• BootstrapOk
  The successful result of Kademlia::bootstrap.
• GetClosestPeersOk
  The successful result of Kademlia::get_closest_peers.
• Kademlia
  Kademlia is a NetworkBehaviour that implements the libp2p Kademlia protocol.
• KademliaConfig
  The configuration for the Kademlia behaviour.
• NoKnownPeers
  An operation failed to due no known peers in the routing table.
• PeerRecord
  A record either received by the given peer or retrieved from the local record store.
• ProgressStep
  Information about progress events.
• PutRecordOk
  The successful result of Kademlia::put_record.
• QueryId
  Unique identifier for an active query.
• QueryMut
  A mutable reference to a running query.
• QueryRef
  An immutable reference to a running query.
• QueryStats
  Execution statistics of a query.

Enums

• AddProviderContext
  The context of a QueryInfo::AddProvider query.
• AddProviderError
  The possible errors when publishing a provider record.
• AddProviderPhase
  The phases of a QueryInfo::AddProvider query.
• BootstrapError
  The error result of Kademlia::bootstrap.
• GetClosestPeersError
  The error result of Kademlia::get_closest_peers.
• GetProvidersError
  The error result of Kademlia::get_providers.
• GetProvidersOk
  The successful result of Kademlia::get_providers.
• GetRecordError
  The error result of Kademlia::get_record.
• GetRecordOk
  The successful result of Kademlia::get_record.
• InboundRequest
  Information about a received and handled inbound request.
• KademliaBucketInserts
  The configurable strategies for the insertion of peers and their addresses into the k-buckets of the Kademlia routing table.
• KademliaCaching
  The configuration for Kademlia “write-back” caching after successful lookups via Kademlia::get_record.
• KademliaEvent
  The events produced by the Kademlia behaviour.
• KademliaStoreInserts
  The configurable filtering strategies for the acceptance of incoming records.
• PutRecordContext
  The context of a QueryInfo::PutRecord query.
• PutRecordError
  The error result of Kademlia::put_record.
• PutRecordPhase
  The phases of a QueryInfo::PutRecord query.
• QueryInfo
  Information about a running query.
• QueryResult
  The results of Kademlia queries.
• Quorum
  A quorum w.r.t. the configured replication factor specifies the minimum number of distinct nodes that must be successfully contacted in order for a query to succeed.

Constants

• ALPHA_VALUE
  The α parameter of the Kademlia specification.
• K_VALUE
  The k parameter of the Kademlia specification.

Type Definitions

• AddProviderResult
  The result of publishing a provider record.
• BootstrapResult
  The result of Kademlia::bootstrap.
• GetClosestPeersResult
  The result of Kademlia::get_closest_peers.
• GetProvidersResult
  The result of Kademlia::get_providers.
• GetRecordResult
  The result of Kademlia::get_record.
• PutRecordResult
  The result of Kademlia::put_record.