# @geut/discovery-swarm-webrtc > discovery-swarm for WebRTC. Latest version **4.3.1** (published 2021-07-12) · MIT license · 0 weekly downloads ## Install ```sh npm install @geut/discovery-swarm-webrtc pnpm add @geut/discovery-swarm-webrtc yarn add @geut/discovery-swarm-webrtc bun add @geut/discovery-swarm-webrtc ``` Provides the command `discovery-swarm-webrtc`. ## 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 | 4.3.1 | | Published | 2021-07-12 | | First published | 2018-10-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 24.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 96 | | Author | GEUT | | Maintainers | geutuser, elmasse, the-real-dk, tinchoz49, estebanprimost | | Keywords | swarm, webrtc, geut | ## Links - npm: https://www.npmjs.com/package/@geut/discovery-swarm-webrtc - Repository: https://github.com/geut/discovery-swarm-webrtc - Homepage: https://github.com/geut/discovery-swarm-webrtc#readme - Issues: https://github.com/geut/discovery-swarm-webrtc/issues - npm.io page: https://npm.io/package/@geut/discovery-swarm-webrtc ## Dependencies (8) - [pump](https://npm.io/package/pump.md) ^3.0.0 - [debug](https://npm.io/package/debug.md) ^4.1.1 - [minimist](https://npm.io/package/minimist.md) ^1.2.0 - [nanoerror](https://npm.io/package/nanoerror.md) ^1.1.0 - [end-of-stream](https://npm.io/package/end-of-stream.md) ^1.4.4 - [nanocustomassert](https://npm.io/package/nanocustomassert.md) ^1.0.0 - [socket-signal-websocket](https://npm.io/package/socket-signal-websocket.md) ^9.1.0 - [mostly-minimal-spanning-tree](https://npm.io/package/mostly-minimal-spanning-tree.md) ^1.0.2 ## Recent versions - 4.3.1 (latest) — 2021-07-12 - 3.0.0-beta.3 (beta) — 2020-04-22 - 2.0.0-alpha.19 (alpha) — 2019-06-11 - 4.3.0 — 2021-04-22 - 4.2.2 — 2021-02-25 - 4.2.1 — 2021-02-10 - 4.2.0 — 2021-02-04 - 4.1.3 — 2021-01-29 - 4.1.2 — 2021-01-29 - 4.1.1 — 2021-01-27 - 4.1.0 — 2021-01-21 - 4.0.2 — 2020-10-08 - 4.0.1 — 2020-09-03 - 4.0.0 — 2020-08-21 - 3.0.1 — 2020-08-21 - … 37 more at https://npm.io/package/@geut/discovery-swarm-webrtc/versions ## README # discovery-swarm-webrtc [![Build Status](https://travis-ci.com/geut/discovery-swarm-webrtc.svg?branch=master)](https://travis-ci.com/geut/discovery-swarm-webrtc) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) > discovery-swarm for webrtc

force-graph

This module provides a "similar" API to discovery-swarm but for WebRTC connections. It has a few differences to discovery-swarm: - It needs a signaling server. We give you [one](#server). - It uses [mmst](https://github.com/RangerMauve/mostly-minimal-spanning-tree) to minimize the connections. Check the example. - `join` and `leave` only accepts Buffers. - `leave` and `close` accepts a callback argument or returns a Promise. ## Install ``` $ npm install @geut/discovery-swarm-webrtc ``` ## Usage ### Server You can run your own signal server by running: ``` $ discovery-swarm-webrtc --port=4000 ``` #### Public Servers - wss://geut-webrtc-signal-v3.glitch.me - wss://geut-webrtc-signal-v3.herokuapp.com #### Deploy to Heroku [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/geut/discovery-swarm-webrtc/tree/master) ### Client ```javascript const crypto = require('crypto') const swarm = require('@geut/discovery-swarm-webrtc') const sw = swarm({ bootstrap: ['ws://localhost:4000'] }) const topic = crypto.createHash('sha256') .update('my-discovery-swarm-topic') .digest() sw.join(topic) sw.on('connection', peer => { // connected }) ``` ## API #### `const sw = swarm(opts)` Creates a new Swarm. `opts` include: ```javascript { id: crypto.randomBytes(32), // peer-id for user bootstrap: [string], // urls to your websocket endpoints stream: (info) => stream, // stream to replicate across peers simplePeer: {}, // options for the simplePeer instances, maxPeers: 5, // max connections by peer timeout: 15 * 1000, // defines the time to wait to establish a connection } ``` #### `sw.join(Buffer)` Join a specific channel. We use behind it `simple-signal` + `simple-peer`. #### `const promise = sw.leave(Buffer)` Leave from specific channel. Destroy all the connections and leave the channel. #### `const promise = sw.close([callback])` Close the entire swarm. Destroy all the connections and disconnect from the signal. #### `const arrayOfPeers = sw.getPeers([channel])` Returns the list of connected peers for a specific channel. Channel is `optional`, if you don't pass it you get the entire list of peers. #### `sw.connect(channel: Buffer, peerId: Buffer) -> Promise` Connect directly to a specific peer. ### Events #### `sw.on('handshaking', function(connection, info) { ... })` Emitted when you've connected to a peer and are now initializing the connection's session. Info is an object that contains information about the connection. `info` include: ``` js { id: Buffer // the remote peer's peer-id. channel: Buffer // the channel this connection was initiated on. initiator: Boolean // whether we initiated the connection or someone else did } ``` #### `sw.on('connection', function(connection, info) { ... })` Emitted when you have fully connected to another peer. Info is an object that contains info about the connection. #### `sw.on('connection-closed', function(connection, info) { ... })` Emitted when you've disconnected from a peer. Info is an object that contains info about the connection. #### `sw.on('leave', function(channel) { ... })` Emitted when you left a channel. #### `sw.on('close', function() { ... })` Emitted when the swarm was closed. #### `sw.on('candidates-updated', function(channel, candidates) { ... })` Emitted when the candidates peer for a specific channel was updated. `candidates` is an array of Buffer id. ## Issues :bug: If you found an issue we encourage you to report it on [github](https://github.com/geut/discovery-swarm-webrtc/issues). Please specify your OS and the actions to reproduce it. ## Contributing :busts_in_silhouette: Ideas and contributions to the project are welcome. You must follow this [guideline](https://github.com/geut/discovery-swarm-webrtc/blob/master/CONTRIBUTING.md). ## Sponsored By [ DXOS ](https://dxos.org/) ## License MIT © A [**GEUT**](http://geutstudio.com/) project --- _Source: https://npm.io/package/@geut/discovery-swarm-webrtc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._