BREAKING: Client() takes single opts object now

To use the client, you used to pass in four arguments:

`new Client(peerId, port, parsedTorrent, opts)`

Now, passing in the torrent is no longer required, just the `announce`
and `infoHash` properties. This decouples this package from
`parse-torrent`.

All options get passed in together now:

new Client({
infoHash: '', // hex string or Buffer
peerId: '', // hex string or Buffer
announce: [], // list of tracker server urls
port: 6881 // torrent client port, (in browser, optional)
})

All the normal optional arguments (rtcConfig, wrtc, etc.) can still be
passed in with the rest of these options.

Fixes webtorrent#118. Fixes webtorrent#115.

Added ws tests for scrape.

Author: feross

README.md

@@ -50,17 +50,15 @@ To connect to a tracker, just do this:
 
 ```js
 var Client = require('bittorrent-tracker')
-var parseTorrent = require('parse-torrent')
-var fs = require('fs')
 
-var torrent = fs.readFileSync(__dirname + '/torrents/name.torrent')
-var parsedTorrent = parseTorrent(torrent) // { infoHash: 'xxx', length: xx, announce: ['xx', 'xx'] }
-
-var peerId = new Buffer('01234567890123456789')
-var port = 6881
+var requiredOpts = {
+  infoHash: new Buffer('012345678901234567890'), // hex string or Buffer
+  peerId: new Buffer('01234567890123456789'), // hex string or Buffer
+  announce: [], // list of tracker server urls
+  port: 6881 // torrent client port, (in browser, optional)
+}
 
-// optional options dictionary
-var opts = {
+var optionalOpts = {
   // RTCPeerConnection config object (only used in browser)
   rtcConfig: {},
   // custom webrtc impl, useful in node to specify [wrtc](https://npmjs.com/package/wrtc)
@@ -77,7 +75,7 @@ var opts = {
   }
 }
 
-var client = new Client(peerId, port, parsedTorrent)
+var client = new Client(requiredOpts)
 
 client.on('error', function (err) {
   // fatal client error!

client.js

@@ -21,37 +21,42 @@ inherits(Client, EventEmitter)
  *
  * Find torrent peers, to help a torrent client participate in a torrent swarm.
  *
- * @param {string|Buffer} peerId           peer id
- * @param {Number} port                    torrent client listening port
- * @param {Object} torrent                 parsed torrent
- * @param {Object} opts                    options object
- * @param {Number} opts.rtcConfig          RTCPeerConnection configuration object
- * @param {Number} opts.wrtc               custom webrtc impl (useful in node.js)
- * @param {function} opts.getAnnounceOpts  callback to provide data to tracker
+ * @param {Object} opts                          options object
+ * @param {string|Buffer} opts.infoHash          torrent info hash
+ * @param {string|Buffer} opts.peerId            peer id
+ * @param {string|Array.<string>} opts.announce  announce
+ * @param {number} opts.port                     torrent client listening port
+ * @param {function} opts.getAnnounceOpts        callback to provide data to tracker
+ * @param {number} opts.rtcConfig                RTCPeerConnection configuration object
+ * @param {number} opts.wrtc                     custom webrtc impl (useful in node.js)
  */
-function Client (peerId, port, torrent, opts) {
+function Client (opts) {
   var self = this
-  if (!(self instanceof Client)) return new Client(peerId, port, torrent, opts)
+  if (!(self instanceof Client)) return new Client(opts)
   EventEmitter.call(self)
   if (!opts) opts = {}
 
+  if (!opts.peerId) throw new Error('Option `peerId` is required')
+  if (!opts.infoHash) throw new Error('Option `infoHash` is required')
+  if (!opts.announce) throw new Error('Option `announce` is required')
+  if (!process.browser && !opts.port) throw new Error('Option `port` is required')
+
   // required
-  self.peerId = typeof peerId === 'string'
-    ? peerId
-    : peerId.toString('hex')
-  self.peerIdBuffer = new Buffer(self.peerId, 'hex')
-  self._peerIdBinary = self.peerIdBuffer.toString('binary')
-
-  self.infoHash = typeof torrent.infoHash === 'string'
-    ? torrent.infoHash
-    : torrent.infoHash.toString('hex')
-  self.infoHashBuffer = new Buffer(self.infoHash, 'hex')
-  self._infoHashBinary = self.infoHashBuffer.toString('binary')
-
-  self.torrentLength = torrent.length
-  self.destroyed = false
+  self.peerId = typeof opts.peerId === 'string'
+    ? opts.peerId
+    : opts.peerId.toString('hex')
+  self._peerIdBuffer = new Buffer(self.peerId, 'hex')
+  self._peerIdBinary = self._peerIdBuffer.toString('binary')
+
+  self.infoHash = typeof opts.infoHash === 'string'
+    ? opts.infoHash
+    : opts.infoHash.toString('hex')
+  self._infoHashBuffer = new Buffer(self.infoHash, 'hex')
+  self._infoHashBinary = self._infoHashBuffer.toString('binary')
 
-  self._port = port
+  self._port = opts.port
+
+  self.destroyed = false
 
   self._rtcConfig = opts.rtcConfig
   self._wrtc = opts.wrtc
@@ -61,11 +66,11 @@ function Client (peerId, port, torrent, opts) {
 
   var webrtcSupport = !!self._wrtc || typeof window !== 'undefined'
 
-  var announce = (typeof torrent.announce === 'string')
-    ? [ torrent.announce ]
-    : torrent.announce == null
+  var announce = (typeof opts.announce === 'string')
+    ? [ opts.announce ]
+    : opts.announce == null
       ? []
-      : torrent.announce
+      : opts.announce
 
   announce = announce.map(function (announceUrl) {
     announceUrl = announceUrl.toString()
@@ -112,23 +117,27 @@ function Client (peerId, port, torrent, opts) {
  * Simple convenience function to scrape a tracker for an info hash without needing to
  * create a Client, pass it a parsed torrent, etc. Support scraping a tracker for multiple
  * torrents at the same time.
- * @param  {string} announceUrl
- * @param  {string|Array.<string>} infoHash
+ * @params {Object} opts
+ * @param  {string|Array.<string>} opts.infoHash
+ * @param  {string} opts.announce
  * @param  {function} cb
  */
-Client.scrape = function (announceUrl, infoHash, cb) {
+Client.scrape = function (opts, cb) {
   cb = once(cb)
 
-  var peerId = new Buffer('01234567890123456789') // dummy value
-  var port = 6881 // dummy value
-  var torrent = {
-    infoHash: Array.isArray(infoHash) ? infoHash[0] : infoHash,
-    announce: [ announceUrl ]
-  }
-  var client = new Client(peerId, port, torrent)
+  if (!opts.infoHash) throw new Error('Option `infoHash` is required')
+  if (!opts.announce) throw new Error('Option `announce` is required')
+
+  var clientOpts = extend(opts, {
+    infoHash: Array.isArray(opts.infoHash) ? opts.infoHash[0] : opts.infoHash,
+    peerId: new Buffer('01234567890123456789'), // dummy value
+    port: 6881 // dummy value
+  })
+
+  var client = new Client(clientOpts)
   client.once('error', cb)
 
-  var len = Array.isArray(infoHash) ? infoHash.length : 1
+  var len = Array.isArray(opts.infoHash) ? opts.infoHash.length : 1
   var results = {}
   client.on('scrape', function (data) {
     len -= 1
@@ -144,10 +153,11 @@ Client.scrape = function (announceUrl, infoHash, cb) {
     }
   })
 
-  infoHash = Array.isArray(infoHash)
-    ? infoHash.map(function (infoHash) { return new Buffer(infoHash, 'hex') })
-    : new Buffer(infoHash, 'hex')
-  client.scrape({ infoHash: infoHash })
+  opts.infoHash = Array.isArray(opts.infoHash)
+    ? opts.infoHash.map(function (infoHash) { return new Buffer(infoHash, 'hex') })
+    : new Buffer(opts.infoHash, 'hex')
+  client.scrape({ infoHash: opts.infoHash })
+  return client
 }
 
 /**
@@ -198,9 +208,6 @@ Client.prototype.complete = function (opts) {
   var self = this
   debug('send `complete`')
   if (!opts) opts = {}
-  if (opts.downloaded == null && self.torrentLength != null) {
-    opts.downloaded = self.torrentLength
-  }
   opts = self._defaultAnnounceOpts(opts)
   opts.event = 'completed'
   self._announce(opts)
@@ -277,10 +284,6 @@ Client.prototype._defaultAnnounceOpts = function (opts) {
   if (opts.uploaded == null) opts.uploaded = 0
   if (opts.downloaded == null) opts.downloaded = 0
 
-  if (opts.left == null && self.torrentLength != null) {
-    opts.left = self.torrentLength - opts.downloaded
-  }
-
   if (self._getAnnounceOpts) opts = extend(opts, self._getAnnounceOpts())
   return opts
 }

lib/client/udp-tracker.js

@@ -193,8 +193,8 @@ UDPTracker.prototype._request = function (opts) {
       connectionId,
       common.toUInt32(common.ACTIONS.ANNOUNCE),
       transactionId,
-      self.client.infoHashBuffer,
-      self.client.peerIdBuffer,
+      self.client._infoHashBuffer,
+      self.client._peerIdBuffer,
       toUInt64(opts.downloaded),
       opts.left != null ? toUInt64(opts.left) : new Buffer('FFFFFFFFFFFFFFFF', 'hex'),
       toUInt64(opts.uploaded),
@@ -211,7 +211,7 @@ UDPTracker.prototype._request = function (opts) {
 
     var infoHash = (Array.isArray(opts.infoHash) && opts.infoHash.length > 0)
       ? Buffer.concat(opts.infoHash)
-      : (opts.infoHash || self.client.infoHashBuffer)
+      : (opts.infoHash || self.client._infoHashBuffer)
 
     send(Buffer.concat([
       connectionId,

test/client-large-torrent.js

@@ -1,6 +1,5 @@
 var Client = require('../')
 var common = require('./common')
-var extend = require('xtend')
 var fixtures = require('webtorrent-fixtures')
 var test = require('tape')
 
@@ -9,11 +8,14 @@ var peerId = new Buffer('01234567890123456789')
 function testLargeTorrent (t, serverType) {
   t.plan(9)
 
-  var parsedTorrent = extend(fixtures.sintel.parsedTorrent)
-
   common.createServer(t, serverType, function (server, announceUrl) {
-    parsedTorrent.announce = [ announceUrl ]
-    var client = new Client(peerId, 6881, parsedTorrent, { wrtc: {} })
+    var client = new Client({
+      infoHash: fixtures.sintel.parsedTorrent.infoHash,
+      peerId: peerId,
+      port: 6881,
+      announce: announceUrl,
+      wrtc: {}
+    })
 
     if (serverType === 'ws') common.mockWebsocketTracker(client)
     client.on('error', function (err) { t.error(err) })

test/client-magnet.js

@@ -12,9 +12,13 @@ function testMagnet (t, serverType) {
   var parsedTorrent = magnet(fixtures.leaves.magnetURI)
 
   common.createServer(t, serverType, function (server, announceUrl) {
-    parsedTorrent.announce = [ announceUrl ]
-
-    var client = new Client(peerId, 6881, parsedTorrent, { wrtc: {} })
+    var client = new Client({
+      infoHash: parsedTorrent.infoHash,
+      announce: announceUrl,
+      peerId: peerId,
+      port: 6881,
+      wrtc: {}
+    })
 
     if (serverType === 'ws') common.mockWebsocketTracker(client)
     client.on('error', function (err) { t.error(err) })