# corestore-swarm-networking

> A corestore networker based on hyperswarm

Latest version **5.5.1** (published 2020-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install corestore-swarm-networking
pnpm add corestore-swarm-networking
yarn add corestore-swarm-networking
bun add corestore-swarm-networking
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.5.1 |
| Published | 2020-06-04 |
| First published | 2019-07-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 18.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Andrew Osheroff |
| Maintainers | andrewosh |
| Keywords | corestore, hyperswarm |

## Links

- npm: https://www.npmjs.com/package/corestore-swarm-networking
- Repository: https://github.com/andrewosh/corestore-swarm-networking
- Homepage: https://github.com/andrewosh/corestore-swarm-networking#readme
- Issues: https://github.com/andrewosh/corestore-swarm-networking/issues
- npm.io page: https://npm.io/package/corestore-swarm-networking

## Dependencies (6)

- [pump](https://npm.io/package/pump.md) ^3.0.0
- [debug](https://npm.io/package/debug.md) ^4.1.1
- [hyperswarm](https://npm.io/package/hyperswarm.md) ^2.10.0
- [dat-encoding](https://npm.io/package/dat-encoding.md) ^5.0.1
- [end-of-stream](https://npm.io/package/end-of-stream.md) ^1.4.4
- [hypercore-protocol](https://npm.io/package/hypercore-protocol.md) ^8.0.0

## Recent versions

- 5.5.1 (latest) — 2020-06-04
- 5.5.0 — 2020-06-02
- 5.4.5 — 2020-05-27
- 5.4.3 — 2020-05-25
- 5.4.2 — 2020-05-14
- 5.4.1 — 2020-05-13
- 5.4.0 — 2020-05-13
- 5.3.0 — 2020-05-11
- 5.2.0 — 2020-05-02
- 5.1.0 — 2020-04-09
- 5.0.9 — 2020-04-05
- 5.0.8 — 2020-04-04
- 5.0.7 — 2020-04-03
- 5.0.6 — 2020-04-03
- 5.0.5 — 2020-04-01
- … 14 more at https://npm.io/package/corestore-swarm-networking/versions

## README

# corestore-swarm-networking
[![Build Status](https://travis-ci.com/andrewosh/corestore-swarm-networking.svg?branch=master)](https://travis-ci.com/andrewosh/corestore-swarm-networking)

A corestore networking module that uses [hyperswarm](https://github.com/hyperswarm/network) to discovery peers. This module powers the networking portion of the [Hyperdrive daemon](https://github.com/andrewosh/hyperdrive-daemon).

Calls to `seed` or `unseed` will not be persisted across restarts, so you'll need to use a separate database that maps discovery keys to network configurations. The Hyperdrive daemon uses [Level](https://github.com/level/level) for this.

Since corestore has an all-to-all replication model (any shared cores between two peers will be automatically replicated), only one connection needs to be maintained per peer. If multiple connections are opened to a single peer as a result of that peer announcing many keys, then these connections will be automatically deduplicated by comparing NOISE keypairs.

### Installation
```
npm i corestore-swarm-networking -g
```

### Usage
```js
const SwarmNetworker = require('corestore-swarm-networking')
const Corestore = require('corestore')
const ram = require('random-access-memory')

const store = new Corestore(ram)
await store.ready()

const networker = new SwarmNetworker(store)

// Start announcing or lookup up a discovery key on the DHT.
await networker.join(discoveryKey, { announce: true, lookup: true })

// Stop announcing or looking up a discovery key.
networker.leave(discoveryKey)

// Shut down the swarm (and unnanounce all keys)
await networker.close()
```

### API

#### `const networker = new SwarmNetworker(corestore, networkingOptions = {})`
Creates a new SwarmNetworker that will open replication streams on the `corestore` instance argument.

`networkOpts` is an options map that can include all [hyperswarm](https://github.com/hyperswarm/hyperswarm) options (which will be passed to the internal swarm instance) as well as:
```js
{
  id: crypto.randomBytes(32), // A randomly-generated peer ID,
  keyPair: HypercoreProtocol.keyPair(), // A NOISE keypair that's used across all connections.
}
```

#### `await networker.join(discoveryKey, opts = {})`
Join the swarm with the `discoveryKey` argument as the topic.

If this is the first time a `join` or `leave` has been called, the swarm instance will be created automatically.

Waits for the topic to be fully joined before resolving.

`opts` is an options map of network configuration options that can include:
```js
  announce: true, // Announce the discovery key on the swarm
  lookup: true  // Look up the discovery key on the swarm
```

### `networker.joined(discoveryKey)`
Returns `true` if that discovery key is being swarmed.

### `networker.flushed(discoveryKey)`
Returns true if the swarm has discovered and attempted to connect to all peers announcing `discoveryKey`.

#### `await networker.leave(discoveryKey)`
Stop announcing or looking up the discovery key topic.

Waits for the key to be fully unannounced before resolving.

#### `await networker.close()`
Shut down the swarm networker.

This will close all replication streams and then destroy the swarm instance. It will wait for all topics to be unannounced, so it might take some time.

### License
MIT

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