# solyd-dht

> Sodium free portable DHT backing the Solyd stack

Latest version **0.0.6** (published 2018-12-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install solyd-dht
pnpm add solyd-dht
yarn add solyd-dht
bun add solyd-dht
```

Provides the command `solyd-dht`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2018-12-31 |
| First published | 2018-12-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mathias Buus |
| Maintainers | jollypk |

## Links

- npm: https://www.npmjs.com/package/solyd-dht
- Repository: https://github.com/jollysean/dht
- Issues: https://github.com/jollysean/dht/issues
- npm.io page: https://npm.io/package/solyd-dht

## Dependencies (4)

- [ipv4-peers](https://npm.io/package/ipv4-peers.md) ^1.1.1
- [record-cache](https://npm.io/package/record-cache.md) ^1.1.0
- [solyd-dht-rpc](https://npm.io/package/solyd-dht-rpc.md) 0.0.2
- [protocol-buffers-encodings](https://npm.io/package/protocol-buffers-encodings.md) ^1.1.0

## Recent versions

- 0.0.6 (latest) — 2018-12-31
- 0.0.5 — 2018-12-31
- 0.0.4 — 2018-12-31
- 0.0.3 — 2018-12-31
- 0.0.2 — 2018-12-31
- 0.0.1 — 2018-12-31

## README

# solyd-dht

Sodium free portable DHT backing the Solyd stack

```
npm install solyd-dht
```

## Usage

``` js
const dht = require('solyd-dht')
const crypto = require('crypto')

const node = dht({
  // just join as an ephemeral node
  // as we are shortlived
  ephemeral: true
})

const topic = crypto.randomBytes(32)

// announce a port
node.announce(topic, { port: 12345 }, function (err) {
  if (err) throw err

  // try and find it
  node.lookup(topic)
    .on('data', console.log)
    .on('end', function () {
      // unannounce it and shutdown
      node.unannounce(topic, { port: 12345 }, function () {
        node.destroy()
      })
    })
})
```

## API

#### `const node = dht([options])`

Create a new HyperSwarm DHT node.

Options include:

```js
{
  // Optionally overwrite the default bootstrap servers
  bootstrap: ['host:port'],
  // If you are a shortlived client or don't want to host
  // data join as an ephemeral node. (defaults to false)
  ephemeral: true
}
```

#### `node.holepunch(peer, [callback])`

UDP holepunch to another peer.

`peer` should be a `{ host, port, referrer: { host, port } }`,
where referrer should be the host and port of the DHT node who told you about this peer.

#### `const stream = node.lookup(topic, [options], [callback])`

Look for peers in the DHT on the given topic. Topic should be a 32 byte buffer (normally a hash of something).

Options include:

```js
{
  // Optionally set your public port. This will make
  // other peers no echo back yourself
  port: 12345,
  // Optionally look for LAN addresses as well by
  // passing in your own. Will also exclude yourself from
  // the results. Only LAN addresses announced on the
  // same public IP and sharing the first two parts (192.168)
  // will be included.
  localAddress: {
    host: '192.168.100.100',
    port: 20000
  }
}
```

The returned stream looks like this

```js
{
  // The DHT node that is returning this data
  node: { host, port },
  // List of peers
  peers: [ { host, port }, ... ],
  // List of LAN peers
  localPeers: [ { host, port }, ... ]
}
```

If you pass the callback the stream will be error handled and buffered.

#### `const stream = node.announce(topic, [options], [callback])`

Announce a port to the dht.

Options include:

```js
{
  // Explicitly set the port you want to announce.
  // Per default you UDP socket port is announced.
  port: 12345,
  // Optionally announce a LAN address as well.
  // Only people with the same public IP as you will
  // get these when doing a lookup
  localAddress: {
    host: '192.168.100.100',
    port: 20000
  }
}
```

An announce does a parallel lookup so the stream returned looks like the lookup stream.
If you pass a callback the stream will be error handled and buffered.

#### `node.unannounce(topic, [options], [callback])`

Unannounce a port. Takes the same options as announce.

#### `node.destroy()`

Fully destroy this DHT node.

#### `node.listen([port])`

Explicitly listen on a UDP port.
If you do not call this it will use a random free port.

#### `node.on('listening')`

Emitted when the node starts listening

#### `node.on('close')`

Emitted when the node is fully closed.

#### `node.on('announce', topic, peer)

Emitted when an announce is received.

#### `node.on('unannounce', topic, peer)`

Emitted when an unannounce is received.

#### `node.on('lookup', topic, peer)`

Emitted when a lookup is received.

## CLI

There is a CLI available as well.

```sh
npm install -g solyd-dht
solyd-dht # runs a DHT node
```

## License

ISC

---
_Source: https://npm.io/package/solyd-dht · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._