Merge branch 'webtorrent:master' into cjs

Author: canoziia

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
         os:
           - ubuntu-latest
         node:
-          - '14'
+          - '18'
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
       - name: Cache
         uses: actions/cache@v3
         with:

.github/workflows/stale.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
 
     steps:
-    - uses: actions/stale@v5
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
         stale-issue-message: 'Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?'

AUTHORS.md

@@ -61,5 +61,10 @@
 - Ryan Finnie ([email protected])
 - Lookis ([email protected])
 - Paul Sharypov ([email protected])
+- Cas ([email protected])
+- Tom Snelling ([email protected])
+- Cas_ ([email protected])
+- Arsène Fougerouse ([email protected])
+- Brad Marsden ([email protected])
 
 #### Generated by tools/update-authors.sh.

CHANGELOG.md

@@ -1,3 +1,140 @@
+## [11.0.2](https://github.com/webtorrent/bittorrent-tracker/compare/v11.0.1...v11.0.2) (2024-03-12)
+
+
+### Bug Fixes
+
+* **parse-http:** ignore announcements from peers with invalid announcement ports. ([#513](https://github.com/webtorrent/bittorrent-tracker/issues/513)) ([fe75272](https://github.com/webtorrent/bittorrent-tracker/commit/fe75272d51653e626583689081afb0b7aeadb84f))
+
+## [11.0.1](https://github.com/webtorrent/bittorrent-tracker/compare/v11.0.0...v11.0.1) (2024-01-16)
+
+
+### Bug Fixes
+
+* update build badge url ([#506](https://github.com/webtorrent/bittorrent-tracker/issues/506)) ([3f59b58](https://github.com/webtorrent/bittorrent-tracker/commit/3f59b58a020ea8c0926be135471a6666fe8e8b21))
+
+# [11.0.0](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.12...v11.0.0) (2023-10-31)
+
+
+### Features
+
+* **major:** drop simple-get ([#443](https://github.com/webtorrent/bittorrent-tracker/issues/443)) ([bce64e1](https://github.com/webtorrent/bittorrent-tracker/commit/bce64e155df6ff9fa605898cbf7498bf76188d8b))
+
+
+### BREAKING CHANGES
+
+* **major:** drop simple-get
+
+* perf: drop simple-get
+
+* feat: undici agent and socks
+
+* fix: undici as dev dependency
+
+* feat: require user passed proxy objects for http and ws
+
+* chore: include undici for tests
+
+## [10.0.12](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.11...v10.0.12) (2023-08-09)
+
+
+### Bug Fixes
+
+* **deps:** update dependency bencode to v4 ([#487](https://github.com/webtorrent/bittorrent-tracker/issues/487)) ([aeccf9c](https://github.com/webtorrent/bittorrent-tracker/commit/aeccf9c1c4b9115fd23b4fe1a0ab990b5add0f17))
+
+## [10.0.11](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.10...v10.0.11) (2023-08-01)
+
+
+### Bug Fixes
+
+* mangled scrape infohashes ([#486](https://github.com/webtorrent/bittorrent-tracker/issues/486)) ([11cce83](https://github.com/webtorrent/bittorrent-tracker/commit/11cce83ddd858813f5684da8a116de4bee6e518b))
+
+## [10.0.10](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.9...v10.0.10) (2023-06-16)
+
+
+### Performance Improvements
+
+* use simple-peer/lite ([#475](https://github.com/webtorrent/bittorrent-tracker/issues/475)) ([5b8db06](https://github.com/webtorrent/bittorrent-tracker/commit/5b8db067e48cc81796728ff538d7ff6efafc59b8))
+
+## [10.0.9](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.8...v10.0.9) (2023-06-16)
+
+
+### Performance Improvements
+
+* use peer/lite ([#474](https://github.com/webtorrent/bittorrent-tracker/issues/474)) ([7c845f0](https://github.com/webtorrent/bittorrent-tracker/commit/7c845f030d07b1bf7060ab880b790ee85a8c7ac0))
+
+## [10.0.8](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.7...v10.0.8) (2023-06-07)
+
+
+### Bug Fixes
+
+* bigInt ([#472](https://github.com/webtorrent/bittorrent-tracker/issues/472)) ([d7061f7](https://github.com/webtorrent/bittorrent-tracker/commit/d7061f73b2ebff072e064971a5960749a7335bae))
+
+## [10.0.7](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.6...v10.0.7) (2023-06-05)
+
+
+### Bug Fixes
+
+* imports ([#471](https://github.com/webtorrent/bittorrent-tracker/issues/471)) ([a12022a](https://github.com/webtorrent/bittorrent-tracker/commit/a12022ac2c81d7fa3ecb81163852161e64199cf4))
+
+## [10.0.6](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.5...v10.0.6) (2023-05-27)
+
+
+### Bug Fixes
+
+* replace simple-peer with maintained one ([#466](https://github.com/webtorrent/bittorrent-tracker/issues/466)) ([3b2dedb](https://github.com/webtorrent/bittorrent-tracker/commit/3b2dedb4151615831ca12d3d0a830354b1c04e68))
+
+## [10.0.5](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.4...v10.0.5) (2023-05-27)
+
+
+### Bug Fixes
+
+* only stringify views ([#467](https://github.com/webtorrent/bittorrent-tracker/issues/467)) ([52f5502](https://github.com/webtorrent/bittorrent-tracker/commit/52f55020f38894e4d45e12c87184540d8b0acad3))
+
+## [10.0.4](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.3...v10.0.4) (2023-05-26)
+
+
+### Bug Fixes
+
+* drop buffer ([#465](https://github.com/webtorrent/bittorrent-tracker/issues/465)) ([c99eb89](https://github.com/webtorrent/bittorrent-tracker/commit/c99eb892088ef3c67ea5bf014dfdd86799251a7e))
+
+## [10.0.3](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.2...v10.0.3) (2023-05-25)
+
+
+### Performance Improvements
+
+* replace simple websocket with maintained one ([#464](https://github.com/webtorrent/bittorrent-tracker/issues/464)) ([3f01c29](https://github.com/webtorrent/bittorrent-tracker/commit/3f01c29122efd726d805673da82f43ce5592b793))
+
+## [10.0.2](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.1...v10.0.2) (2023-02-01)
+
+
+### Bug Fixes
+
+* **deps:** update dependency ws to v8 ([#448](https://github.com/webtorrent/bittorrent-tracker/issues/448)) ([2209d4f](https://github.com/webtorrent/bittorrent-tracker/commit/2209d4f21bdee10e575c1728c3accf7bd34380c9)), closes [#449](https://github.com/webtorrent/bittorrent-tracker/issues/449)
+
+## [10.0.1](https://github.com/webtorrent/bittorrent-tracker/compare/v10.0.0...v10.0.1) (2022-12-07)
+
+
+### Bug Fixes
+
+* **deps:** update dependency bencode to v3 ([#434](https://github.com/webtorrent/bittorrent-tracker/issues/434)) [skip ci] ([926ceee](https://github.com/webtorrent/bittorrent-tracker/commit/926ceee0bac6dfe49877566aaa3cf645689492d1))
+* **deps:** update dependency string2compact to v2 ([#437](https://github.com/webtorrent/bittorrent-tracker/issues/437)) ([9be843c](https://github.com/webtorrent/bittorrent-tracker/commit/9be843c5e46ac2ab518187bf0d348e1e69e8633d))
+
+# [10.0.0](https://github.com/webtorrent/bittorrent-tracker/compare/v9.19.0...v10.0.0) (2022-12-05)
+
+
+### Features
+
+* esm ([#431](https://github.com/webtorrent/bittorrent-tracker/issues/431)) ([e6d3189](https://github.com/webtorrent/bittorrent-tracker/commit/e6d3189edf1a170197a799b97d84c632692b394f))
+
+
+### BREAKING CHANGES
+
+* ESM only
+
+* feat: esm
+
+* fix: linter oops
+
 # [9.19.0](https://github.com/webtorrent/bittorrent-tracker/compare/v9.18.6...v9.19.0) (2022-06-01)
 
 

README.md

@@ -1,6 +1,6 @@
 # bittorrent-tracker [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
 
-[ci-image]: https://img.shields.io/github/workflow/status/webtorrent/bittorrent-tracker/ci/master
+[ci-image]: https://img.shields.io/github/actions/workflow/status/webtorrent/bittorrent-tracker/ci.yml
 [ci-url]: https://github.com/webtorrent/bittorrent-tracker/actions
 [npm-image]: https://img.shields.io/npm/v/bittorrent-tracker.svg
 [npm-url]: https://npmjs.org/package/bittorrent-tracker
@@ -55,16 +55,16 @@ npm install bittorrent-tracker
 To connect to a tracker, just do this:
 
 ```js
-var Client = require('bittorrent-tracker')
+import Client from 'bittorrent-tracker'
 
-var requiredOpts = {
+const 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)
 }
 
-var optionalOpts = {
+const optionalOpts = {
   // RTCPeerConnection config object (only used in browser)
   rtcConfig: {},
   // User-Agent header for http requests
@@ -81,47 +81,24 @@ var optionalOpts = {
       customParam: 'blah' // custom parameters supported
     }
   },
-  // Proxy config object
+  // Proxy options (used to proxy requests in node)
   proxyOpts: {
-      // Socks proxy options (used to proxy requests in node)
-      socksProxy: {
-          // Configuration from socks module (https://github.com/JoshGlazebrook/socks)
-          proxy: {
-              // IP Address of Proxy (Required)
-              ipaddress: "1.2.3.4",
-              // TCP Port of Proxy (Required)
-              port: 1080,
-              // Proxy Type [4, 5] (Required)
-              // Note: 4 works for both 4 and 4a.
-              // Type 4 does not support UDP association relay 
-              type: 5,
-              
-              // SOCKS 4 Specific:
-              
-              // UserId used when making a SOCKS 4/4a request. (Optional)
-              userid: "someuserid",
-
-              // SOCKS 5 Specific:
-      
-              // Authentication used for SOCKS 5 (when it's required) (Optional)
-              authentication: {
-                  username: "Josh",
-                  password: "somepassword"
-              }
-          },
-          
-          // Amount of time to wait for a connection to be established. (Optional)
-          // - defaults to 10000ms (10 seconds)
-          timeout: 10000
-      },
-      // NodeJS HTTP agents (used to proxy HTTP and Websocket requests in node)
-      // Populated with Socks.Agent if socksProxy is provided
-      httpAgent: {},
-      httpsAgent: {}
+      // For WSS trackers this is always a http.Agent
+      // For UDP trackers this is an object of options for the Socks Connection
+      // For HTTP trackers this is either an undici Agent if using Node16 or later, or http.Agent if using versions prior to Node 16, ex:
+      // import Socks from 'socks'
+      // proxyOpts.socksProxy = new Socks.Agent(optionsObject, isHttps)
+      // or if using Node 16 or later
+      // import { socksDispatcher } from 'fetch-socks'
+      // proxyOpts.socksProxy = socksDispatcher(optionsObject)
+      socksProxy: new SocksProxy(socksOptionsObject),
+      // Populated with socksProxy if it's provided
+      httpAgent: new http.Agent(agentOptionsObject),
+      httpsAgent: new https.Agent(agentOptionsObject)
   },
 }
 
-var client = new Client(requiredOpts)
+const client = new Client(requiredOpts)
 
 client.on('error', function (err) {
   // fatal client error!
@@ -182,7 +159,7 @@ client.on('scrape', function (data) {
 To start a BitTorrent tracker server to track swarms of peers:
 
 ```js
-const Server = require('bittorrent-tracker').Server
+import { Server } from 'bittorrent-tracker'
 
 const server = new Server({
   udp: true, // enable udp server? [default=true]
@@ -289,7 +266,7 @@ The http server will handle requests for the following paths: `/announce`, `/scr
 Scraping multiple torrent info is possible with a static `Client.scrape` method:
 
 ```js
-var Client = require('bittorrent-tracker')
+import Client from 'bittorrent-tracker'
 Client.scrape({ announce: announceUrl, infoHash: [ infoHash1, infoHash2 ]}, function (err, results) {
   results[infoHash1].announce
   results[infoHash1].infoHash

bin/cmd.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const minimist = require('minimist')
-const Server = require('../').Server
+import minimist from 'minimist'
+import { Server } from '../index.js'
 
 const argv = minimist(process.argv.slice(2), {
   alias: {

client.js

@@ -1,23 +1,26 @@
-const debug = require('debug')('bittorrent-tracker:client')
-const EventEmitter = require('events')
-const once = require('once')
-const parallel = require('run-parallel')
-const Peer = require('simple-peer')
-const queueMicrotask = require('queue-microtask')
-
-const common = require('./lib/common')
-const HTTPTracker = require('./lib/client/http-tracker') // empty object in browser
-const UDPTracker = require('./lib/client/udp-tracker') // empty object in browser
-const WebSocketTracker = require('./lib/client/websocket-tracker')
+import Debug from 'debug'
+import EventEmitter from 'events'
+import once from 'once'
+import parallel from 'run-parallel'
+import Peer from '@thaunknown/simple-peer/lite.js'
+import queueMicrotask from 'queue-microtask'
+import { hex2arr, hex2bin, text2arr, arr2hex, arr2text } from 'uint8-util'
+
+import common from './lib/common.js'
+import HTTPTracker from './lib/client/http-tracker.js' // empty object in browser
+import UDPTracker from './lib/client/udp-tracker.js' // empty object in browser
+import WebSocketTracker from './lib/client/websocket-tracker.js'
+
+const debug = Debug('bittorrent-tracker:client')
 
 /**
  * BitTorrent tracker client.
  *
  * Find torrent peers, to help a torrent client participate in a torrent swarm.
  *
  * @param {Object} opts                          options object
- * @param {string|Buffer} opts.infoHash          torrent info hash
- * @param {string|Buffer} opts.peerId            peer id
+ * @param {string|Uint8Array} opts.infoHash          torrent info hash
+ * @param {string|Uint8Array} 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
@@ -37,15 +40,15 @@ class Client extends EventEmitter {
 
     this.peerId = typeof opts.peerId === 'string'
       ? opts.peerId
-      : opts.peerId.toString('hex')
-    this._peerIdBuffer = Buffer.from(this.peerId, 'hex')
-    this._peerIdBinary = this._peerIdBuffer.toString('binary')
+      : arr2hex(opts.peerId)
+    this._peerIdBuffer = hex2arr(this.peerId)
+    this._peerIdBinary = hex2bin(this.peerId)
 
     this.infoHash = typeof opts.infoHash === 'string'
       ? opts.infoHash.toLowerCase()
-      : opts.infoHash.toString('hex')
-    this._infoHashBuffer = Buffer.from(this.infoHash, 'hex')
-    this._infoHashBinary = this._infoHashBuffer.toString('binary')
+      : arr2hex(opts.infoHash)
+    this._infoHashBuffer = hex2arr(this.infoHash)
+    this._infoHashBinary = hex2bin(this.infoHash)
 
     debug('new client %s', this.infoHash)
 
@@ -67,7 +70,7 @@ class Client extends EventEmitter {
 
     // Remove trailing slash from trackers to catch duplicates
     announce = announce.map(announceUrl => {
-      announceUrl = announceUrl.toString()
+      if (ArrayBuffer.isView(announceUrl)) announceUrl = arr2text(announceUrl)
       if (announceUrl[announceUrl.length - 1] === '/') {
         announceUrl = announceUrl.substring(0, announceUrl.length - 1)
       }
@@ -258,7 +261,7 @@ Client.scrape = (opts, cb) => {
 
   const clientOpts = Object.assign({}, opts, {
     infoHash: Array.isArray(opts.infoHash) ? opts.infoHash[0] : opts.infoHash,
-    peerId: Buffer.from('01234567890123456789'), // dummy value
+    peerId: text2arr('01234567890123456789'), // dummy value
     port: 6881 // dummy value
   })
 
@@ -282,11 +285,8 @@ Client.scrape = (opts, cb) => {
     }
   })
 
-  opts.infoHash = Array.isArray(opts.infoHash)
-    ? opts.infoHash.map(infoHash => Buffer.from(infoHash, 'hex'))
-    : Buffer.from(opts.infoHash, 'hex')
   client.scrape({ infoHash: opts.infoHash })
   return client
 }
 
-module.exports = Client
+export default Client

examples/express-embed/server.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const Server = require('../..').Server
-const express = require('express')
+import { Server } from '../../index.js'
+import express from 'express'
 const app = express()
 
 // https://wiki.theory.org/BitTorrentSpecification#peer_id