MLDHT - Mainline Distributed Hash Table

A Distributed Hash Table (DHT) is a storage and lookup system that is based on a peer-to-peer (P2P) system. The file sharing protocol BitTorrent makes use of a DHT to find new peers without using a central tracker. There are three popular DHT-based protocols: KAD, Vuze DHT and Mainline DHT. All protocols are based on Kademlia but are not compatible with each other. The mainline DHT is by far the biggest overlay network with around 15-27 million users per day.

MLDHT, in particular, is an elixir package that provides a mainline DHT implementation according to BEP 05. It is build on three applications:

DHTServer - main interface, receives all incoming messages;
KRPCProtocol - contains modules to encode and decode KRPC messages;
RoutingTable - maintains contact information of close nodes;

Architecture

Getting Started

Learn how to add MLDHT to your Elixir project and start using it.

Adding MLDHT To Your Project

To use MLDHT with your projects, edit your mix.exs file and add it as a dependency:

defp application do
  [applications: [:dht_server]]
end

defp deps do
  [{:mldht, github: "cit/MLDHT"}]
end

Basic Usage

If the application is loaded it automatically bootstraps itself into the overlay network. It does this by starting a find_node search for a node that belongs to the same bucket as our own node id. In mix.exs you will find the boostrapping nodes that will be used for that first search. By doing this, we will quickly collect nodes that are close to us.

If you are curious and would like to see the content of the RoutingTable you can use the following command:

iex> RoutingTable.Worker.print

To find nodes for a specific infohash, you can use the following function.

iex> infohash = "3F19B149F53A50E14FC0B79926A391896EABAB6F" |> Base.decode16! ## Ubuntu 15.04
iex> DHTServer.search(infohash, fn(node) -> IO.puts "#{inspect node}" end)

If you would like to search and announce yourself to the DHT network use the following function:

iex> infohash = "3F19B149F53A50E14FC0B79926A391896EABAB6F" |> Base.decode16! ## Ubuntu 15.04
iex> DHTServer.search_announce(infohash, 6881, fn(node) -> IO.puts "#{inspect node}" end)

License

MLDHT source code is released under MIT License. Check LICENSE file for more information.

dejanstrbac / MLDHT