Crate mainline

Mainline

Simple, robust, BitTorrent’s Mainline DHT implementation.

This library is focused on being the best and simplest Rust client for Mainline, especially focused on reliable and fast time-to-first-response.

It should work as a routing / storing node as well, and has been running in production for many months without an issue. However if you are running your separate (read: small) DHT, or otherwise facing unusual DoS attack, you should consider implementing rate limiting.

API Docs

Get started

Check the Examples.

Features

Client

Running as a client, means you can store and query for values on the DHT, but not accept any incoming requests.

use mainline::Dht;

let dht = Dht::client(); // or `Dht::default();`

Supported BEPs:

• BEP0005 DHT Protocol
• BEP0042 DHT Security extension
• BEP0043 Read-only DHT Nodes
• BEP0044 Storing arbitrary data in the DHT

Server

Running as a server is the same as a client, but you also respond to incoming requests and serve as a routing and storing node, supporting the general routing of the DHT, and contributing to the storage capacity of the DHT.

use mainline::Dht;

let dht = Dht::server(); // or `Dht::builder::server().build();` for more control.

Supported BEPs:

• BEP0005 DHT Protocol
• BEP0042 DHT Security extension
• BEP0043 Read-only DHT Nodes
• BEP0044 Storing arbitrary data in the DHT

Rate limiting

The default server implementation has no rate-limiting, you can run your own custom server and apply your custom rate-limiting. However, that limit/block will only apply after parsing incoming messages, and it won’t affect handling incoming responses.

Acknowledgment

This implementation was possible thanks to Webtorrent’s Bittorrent-dht as a reference, and Rustydht-lib that saved me a lot of time, especially at the serialization and deserialization of Bencode messages.

Re-exports

• pub use dht::Dht;
• pub use dht::Testnet;

Modules

• async_dht
  AsyncDht node.
• dht
  Dht node.
• rpc
  K-RPC implementatioStoreQueryMetdatan
• server
  Modules needed only for nodes running in server mode (not read-only).

Structs

• Bytes
  A cheaply cloneable and sliceable chunk of contiguous memory.
• Id
  Kademlia node Id or a lookup target
• MutableItem
  Bep_0044’s Mutable item.
• SigningKey
  ed25519 signing key which can be used to produce signatures.

Enums

• Error
  Mainline crate error enum.

Type Aliases

• Result