Skip to content

Map a BitTorrent peer ID to a human-readable client name and version

License

Notifications You must be signed in to change notification settings

webtorrent/bittorrent-peerid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 17, 2024
dcb13b3 · Sep 17, 2024
Jul 23, 2023
Dec 4, 2022
Dec 4, 2022
Jul 23, 2021
Jul 23, 2021
Dec 5, 2022
Apr 22, 2017
Dec 4, 2022
May 28, 2023
Sep 17, 2024

Repository files navigation

bittorrent-peerid ci npm downloads javascript style guide

Map a BitTorrent peer ID to a human-readable client name and version

Also works in the browser with browserify!

This module is used by WebTorrent.

install

npm install bittorrent-peerid

usage

import peerid from 'bittorrent-peerid'
const parsed = peerid('-AZ2200-6wfG2wk6wWLc')

console.log(parsed.client, parsed.version)

The parsed peerid object looks like this:

{
  client: 'Vuze',
  version: '2.2.0.0'
}

bittorrent-peerid can parse peer ids encoded in the following formats:

  • a 20-byte Buffer
  • a 40-character hex string
  • an arbitrarily-sized human-readable utf8 string (must decode to a 20-byte Buffer)

If an unknown peer id is passed in, the returned client will be unknown.

todo

  • Support known Azureus-style clients.
  • Support known Shadow-style clients.
  • Support known Mainline-style clients.
  • Support known Custom-style clients.
  • Recognize BitComet/Lord/Spirit spoofing.
  • Full support for client version parsing.
  • Full support for customized client version schemes.
  • Support unknown clients that conform to either the Azureus or Shadow-style conventions.

credit

This module is based heavily on the BTPeerIDByteDecoderDefinitions class from Azureus (Vuze). Related resources include:

license

MIT. Copyright (c) Travis Fischer and WebTorrent, LLC.