dht-universal

dht-universal

Universal wrapper for @hyperswarm/dht and @hyperswarm/dht-relay working in Node.js and the Browser

Installation

npm install dht-universal

Usage

In browser, it will use the @hyperswarm/dht-relay with a WebSocket transport, so you need to pass a relay URL to the constructor, and wait for it to be ready to confirm the websocket is open.

Custom relays

import { DHT } from 'dht-universal';

const node = new DHT({ relay: 'wss://dht-relay.example.com/' });

await node.ready();

API

Should be the same as @hyperswarm/dht.

Covered by tests and type definitions:

• Tested in normal DHT

  • DHT.keyPair([seed])
  • Instantiation
  • node.defaultKeyPair
  • node.destroyed
  • node.ready()
  • node.createServer()
  • node.createServer() with firewall
  • node.destroy([opts])
  • server.publicKey
  • server.address()
  • server.listen()
  • server.close()
  • server.on('listening')
  • server.on('connection')
  • server.on('close')
  • node.connect({keyPair}) without optional nodes
  • encryptedConnection.on('open')
  • encryptedConnection.remotePublicKey
  • encryptedConnection.publicKey
  • node.lookup(topic) without options
  • node.announce(topic,keyPair) without relayAddresses or options
  • node.unannounce
  • node.immutablePut(value)
  • node.immutableGet(value)
  • node.mutablePut(value)
  • node.mutableGet(value)

• Passing in Relay

  • throw error on invalid relay
  • DHT.keyPair([seed])
  • DHT.create()
  • node.defaultKeyPair
  • node.createServer()
  • node.createServer() with firewall
  • node.destroy([opts])
  • server.publicKey
  • server.address()
  • server.listen()
  • server.close()
  • server.on('listening')
  • server.on('connection')
  • server.on('close')
  • node.connect() without options
  • encryptedConnection.on('open')
  • encryptedConnection.remotePublicKey
  • encryptedConnection.publicKey
  • node.lookup(topic) without options
  • node.announce(topic,keyPair) without relayAddresses or options
  • node.unannounce
  • node.immutablePut(value)
  • node.immutableGet(value)
  • node.mutablePut(value)
  • node.mutableGet(value)