Crate mainline

source
Expand description

§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:

§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:

§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§

Modules§

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

Structs§

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

Enums§

  • Mainline crate error enum.

Type Aliases§