webtorrent/bittorrent-lsd

Local Service Discovery (BEP14) implementation

bittorrent-lsd

Local Service Discovery (BEP14) implementation.

Local Service Discovery (LSD) provides a SSDP-like (http over udp-multicast) mechanism to announce the presence in specific swarms to local neighbors.

This module is used by WebTorrent.

install

npm install bittorrent-lsd

example

const opts = {
  peerId: new Buffer('01234567890123456789'), // hex string or Buffer
  infoHash: new Buffer('01234567890123456789'), // hex string or Buffer
  port: common.randomPort() // torrent client port
}

const lsd = new LSD(opts)

// start getting peers from local network
lsd.start()

lsd.on('peer', (peerAddress, infoHash) => {
  console.log('found a peer: ' + peerAddress)
})

lsd.destroy()

api

lsd = new LSD([opts])

Create a new lsd instance.

lsd.start()

Start listening and sending (every 5 minutes) for local network announces.

lsd.destroy([callback])

Destroy the LSD. Closes the socket and cleans up resources.

events

lsd.on('peer', (peerAddress, infoHash) => { ... })

Emitted when a potential peer is found. peerAddress is of the form host:port. infoHash is the torrent info hash.

lsd.on('warning', (err) => { ... })

Emitted when the LSD gets an unexpected message.

lsd.on('error', (err) => { ... })

Emitted when the LSD has a fatal error.

license

MIT. Copyright (c) Julen Garcia Leunda and WebTorrent, LLC.

bittorrent-lsd's Issues

GitHub tag v1.0.0 and npm version is 1.0.0 but `package.json` is 0.1.0

I noticed that there is a GitHub tag for v1.0.0 and the npm version is 1.0.0 but package.json is 0.1.0.

@hicom150 Curious how this happened. Should we just bump package.json to 1.0.0 to match what is already on npm? Then the next version can be 1.0.1, etc.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/cache action to v4
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency semantic-release to v24
• chore(deps): update dependency sinon to v18
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v3
• actions/setup-node v3

.github/workflows/release.yml

• actions/checkout v3
• actions/setup-node v3
• actions/cache v3

npm

package.json

• chrome-dgram ^3.0.6
• debug ^4.2.0
• @webtorrent/semantic-release-config 1.0.10
• semantic-release 20.1.3
• sinon 15.2.0
• standard *
• tape 5.8.1

---

• Check this box to trigger a request for Renovate to run again on this repository

Add `bittorrent-lsd` to the `webtorrent` npm organization

Can you add bittorrent-lsd to the webtorrent npm organization? I think you can click "Add Package" on this page to do it: https://www.npmjs.com/settings/webtorrent/packages

Originally posted by @feross in webtorrent/torrent-discovery#48 (comment)