This module bundles bittorrent-dht and bittorrent-tracker clients and exposes a single API for discovering BitTorrent peers via both discovery methods.
- 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.
npm install torrent-discovery
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`)
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.
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.
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)
Destroy and cleanup the DHT and tracker instances.
Emitted whenever a new peer is discovered.
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.
Emitted whenever an announce
message has been sent to the DHT.
Emitted when there is a non-fatal DHT or tracker error, like an inaccessible tracker server. Useful for logging. This is non-fatal.
Emitted when there is a fatal, unrecoverable DHT or tracker error.
MIT. Copyright (c) Feross Aboukhadijeh.