📁 Archived - this module has been merged into js-libp2p

@libp2p/kad-dht

JavaScript implementation of the Kad-DHT for libp2p

Table of contents

• Install
  • Browser <script> tag
  • Use in Node.js
• API
  • Custom secondary DHT in libp2p
  • Peer Routing
  • Content Routing
  • Peer Discovery
• Spec
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/kad-dht

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pKadDht in the global namespace.

<script src="https://unpkg.com/@libp2p/kad-dht/dist/index.min.js"></script>

> npm i @libp2p/kad-dht

Use in Node.js

import { create } from '@libp2p/kad-dht'

API

See https://libp2p.github.io/js-libp2p-kad-dht for the auto generated docs.

The libp2p-kad-dht module offers 3 APIs: Peer Routing, Content Routing and Peer Discovery.

Custom secondary DHT in libp2p

import { createLibp2pNode } from 'libp2p'
import { kadDHT } from '@libp2p/kad-dht'

const node = await createLibp2pNode({
  dht: kadDHT()
  //... other config
})
await node.start()

for await (const event of node.dht.findPeer(node.peerId)) {
  console.info(event)
}

Note that you may want to supply your own peer discovery function and datastore

Peer Routing

Content Routing

Peer Discovery

Spec

js-libp2p-kad-dht follows the libp2p/kad-dht spec and implements the algorithms described in the IPFS DHT documentation.

API Docs

• https://libp2p.github.io/js-libp2p-kad-dht

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.