https://github.com/prettymuchbryce/kademlia

Go implementation of a Kademlia distributed hash table
https://github.com/prettymuchbryce/kademlia

Last synced: 4 months ago
JSON representation

Go implementation of a Kademlia distributed hash table

• Host: GitHub
• URL: https://github.com/prettymuchbryce/kademlia
• Owner: prettymuchbryce
• License: mit
• Created: 2016-05-02T04:25:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-01-30T10:16:11.000Z (over 4 years ago)
• Last Synced: 2026-01-13T00:51:57.306Z (6 months ago)
• Language: Go
• Homepage:
• Size: 108 KB
• Stars: 160
• Watchers: 7
• Forks: 31
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kademlia

[![GoDoc](https://godoc.org/github.com/prettymuchbryce/kademlia?status.svg)](https://godoc.org/github.com/prettymuchbryce/kademlia)

[![Go Report Card](https://goreportcard.com/badge/github.com/prettymuchbryce/kademlia)](https://goreportcard.com/report/github.com/prettymuchbryce/kademlia)

[![Build Status](https://travis-ci.org/prettymuchbryce/kademlia.svg?branch=master)](https://travis-ci.org/prettymuchbryce/kademlia)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/prettymuchbryce/kademlia/master/LICENSE)

This is a Go implementation of a vanilla [Kademlia](https://en.wikipedia.org/wiki/Kademlia) DHT. The implementation is based off of a combination of the original [Kademlia whitepaper](https://pdos.csail.mit.edu/~petar/papers/maymounkov-kademlia-lncs.pdf) and the [xlattice design specification](http://xlattice.sourceforge.net/components/protocol/kademlia/specs.html). It does not attempt to conform to BEP-5, or any other BitTorrent-specific design.

_This project has not been heavily battle-tested, and I would not recommend using it in any production environment at this time._

## Implementation characteristics

-  uses uTP for all network communication

-  supports IPv4/IPv6

-  uses a well-defined Store interface for extensibility

-  supports [STUN](https://en.wikipedia.org/wiki/STUN) for public address discovery

## TODO

- [x] Implement STUN for public address discovery

- [ ] Load testing/Benchmarks

- [ ] More testing around message validation

- [ ] More testing of bad/malicious message handling

- [ ] Banning/throttling of malicious messages/nodes

- [ ] Implement UDP hole punching for NAT traversal

- [ ] Use loose parallelism for iterative lookups

- [ ] Consider breaking store into two messages and transfer bulk of data over TCP

- [ ] Implement republishing according to the xlattice design document

- [ ] Better cleanup of unanswered expected messages

- [ ] Logging support