Technology moves fast! ⚡ Don't get left behind.🚶 Subscribe to our mailing list to keep up with latest and greatest in open source projects! 🏆


Subscribe to our mailing list

torrent-discovery

Discover BitTorrent and WebTorrent peers

Subscribe to updates I use torrent-discovery


Statistics on torrent-discovery

Number of watchers on Github 96
Number of open issues 1
Average time to close an issue about 2 months
Main language JavaScript
Average time to merge a PR about 9 hours
Open pull requests 5+
Closed pull requests 5+
Last commit over 1 year ago
Repo Created almost 5 years ago
Repo Last Updated over 1 year ago
Size 94 KB
Homepage https://webtorren...
Organization / Authorwebtorrent
Contributors4
Page Updated
Do you use torrent-discovery? Leave a review!
View torrent-discovery activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating torrent-discovery for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

torrent-discovery travis npm downloads javascript style guide

Discover BitTorrent and WebTorrent peers

This module bundles bittorrent-dht and bittorrent-tracker clients and exposes a single API for discovering BitTorrent peers via both discovery methods.

features

  • simple API
  • find peers from trackers and the DHT
  • automatically announces, so other peers can discover us
  • can start finding peers with just an info hash, before full metadata is available

This module also works in the browser with browserify. In that context, it discovers WebTorrent (WebRTC) peers.

install

npm install torrent-discovery

api

discovery = new Discovery(opts)

Create a new peer discovery instance. Required options are:

{
  infoHash: '', // as hex string or Buffer
  peerId: '',   // as hex string or Buffer
  port: 0       // torrent client port (only required in node)
}

Optional options are:

{
  announce: [],  // force list of announce urls to use (from magnet uri)
  dht: true,     // use dht? optionally, this can be an `opts` object, or a DHT instance to use (can be reused for multiple torrents)
  dhtPort: 0,    // custom listen port for the DHT instance (not used if DHT instance is given via `opts.dht`)
  userAgent: '', // User-Agent header for http requests
  tracker: true, // use trackers? optionally, this can be an `opts` object
}

See the documentation for bittorrent-dht and bittorrent-tracker for information on what options are available via the opts object.

This module automatically handles announcing on intervals, for maximum peer discovery.

discovery.updatePort(port)

When the port that the torrent client is listening on changes, call this method to reannounce to the tracker and DHT with the new port.

discovery.complete([opts])

Announce that download has completed (and the client is now a seeder). This is only used by trackers, for statistical purposes. If trackers are not in use, then this method is a no-op.

Optional opts object with the following options:

{number=} opts.uploaded
{number=} opts.downloaded
{number=} opts.numwant
{number=} opts.left (if not set, calculated automatically)

discovery.destroy()

Destroy and cleanup the DHT and tracker instances.

events

discovery.on('peer', function (peer, source) {})

Emitted whenever a new peer is discovered. Source is either 'tracker' or 'dht' based on peer source.

In node, peer is a string in the form 12:34:56:78:4000.

In the browser, peer is an instance of simple-peer, a small wrapper around a WebRTC peer connection.

discovery.on('dhtAnnounce', function () {})

Emitted whenever an announce message has been sent to the DHT.

discovery.on('warning', function (err) {})

Emitted when there is a non-fatal DHT or tracker error, like an inaccessible tracker server. Useful for logging. This is non-fatal.

discovery.on('error', function (err) {})

Emitted when there is a fatal, unrecoverable DHT or tracker error.

license

MIT. Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC.

torrent-discovery open pull requests (View All Pulls)
  • schedule dht reannounce once previous called back
  • Provide a way to give extra data on announce to the tracker
  • Add IPv6 DHT support
  • add 'UserAgent' option
  • Added peer source to provide as much information as available
torrent-discovery list of languages used
Other projects in JavaScript