README
¶
go-kademlia
A Generic Go Kademlia Implementation
Generic Kademlia implementation in Go that can be used to build DHT Protocols. This repository is NOT meant to be the home of the Go IPFS DHT implementation, it is meant to provide generic Kademlia building blocks that could be used in multiple Kademlia implementations and simulations. This Kademlia implementation was built to be reproducible: most of the modules are single threaded, allowing sequential execution. This repository enables deterministic testing, and stable simulations.
Documentation
TBD
Design
Lead Maintainer
Contributing
Contributions are welcome! This repository is part of the IPFS project and therefore governed by our contributing guidelines.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package event provides an abstraction for single worker multi threaded applications.
|
Package event provides an abstraction for single worker multi threaded applications. |
|
examples
|
|
|
internal
|
|
|
Package kad provides interfaces defining core Kademlia types
|
Package kad provides interfaces defining core Kademlia types |
|
Package key provides implementations of Kademlia keys and common functions that operate on key.
|
Package key provides implementations of Kademlia keys and common functions that operate on key. |
|
trie
Package trie provides an implementation of a XOR Trie.
|
Package trie provides an implementation of a XOR Trie. |
|
network
|
|
|
triert
Package triert provides a routing table implemented using a XOR trie.
|
Package triert provides a routing table implemented using a XOR trie. |
|
Package sim provides simple implementations of the principal Kademlia interfaces that allow the construction of simulations and test scenarios.
|
Package sim provides simple implementations of the principal Kademlia interfaces that allow the construction of simulations and test scenarios. |
Click to show internal directories.
Click to hide internal directories.