bencode

Bencode de/encoder

npm install bencode
2 downloads in the last day
94 downloads in the last week
205 downloads in the last month

node-bencode build status NPM version

A node library for encoding and decoding bencoded data, according to the BitTorrent specification.

Index

About BEncoding

from Wikipedia:

Bencode (pronounced like B encode) is the encoding used by the peer-to-peer file sharing system BitTorrent for storing and transmitting loosely structured data.

It supports four different types of values:

  • byte strings
  • integers
  • lists
  • dictionaries

Bencoding is most commonly used in torrent files. These metadata files are simply bencoded dictionaries.

Install with npm

npm install bencode

Performance

encode

  11,883 op/s ⨠ bencode
   5,457 op/s ⨠ bencoding
   6,550 op/s ⨠ dht_bencode
   5,405 op/s ⨠ bncode
  10,978 op/s ⨠ dht

decode

  30,240 op/s ⨠ bencode
  25,293 op/s ⨠ bencoding
  26,220 op/s ⨠ dht_bencode
     824 op/s ⨠ bncode
  19,824 op/s ⨠ dht

Benchmarks run on an Intel Core2 CPU T9550 @ 2.66GHz with node v0.10.5

To run the benchmarks simply use

npm run-script bench

Usage

var bencode = require( 'bencode' )

Encoding


var data = {
  string: 'Hello World',
  integer: 12345,
  dict: {
    key: 'This is a string within a dictionary'
  },
  list: [ 1, 2, 3, 4, 'string', 5, {} ]
}

var result = bencode.encode( data )

Output

d4:dictd3:key36:This is a string within a dictionarye7:integeri12345e4:listli1ei2ei3ei4e6:stringi5edee6:string11:Hello Worlde

Decoding

var data   = new Buffer( 'd6:string11:Hello World7:integeri12345e4:dictd3:key36:This is a string within a dictionarye4:litli1ei2ei3ei4e6:stringi5edeee' )
var result = bencode.decode( data )

Output

{
  string: <Buffer 48 65 6c 6c 6f 20 57 6f 72 6c 64>,
  integer: 12345,
  dict: {
    key: <Buffer 54 68 69 73 20 69 73 20 61 20 73 74 72 69 6e 67 20 77 69 74 68 69 6e 20 61 20 64 69 63 74 69 6f 6e 61 72 79>
  },
  list: [ 1, 2, 3, 4, <Buffer 73 74 72 69 6e 67>, 5, {} ]
}

Automagically convert bytestrings to strings:

var result = bencode.decode( data, 'utf8' )

Output

{
  string: 'Hello World',
  integer: 12345,
  dict: {
    key: 'This is a string within a dictionary'
  },
  list: [ 1, 2, 3, 4, 'string', 5, {} ]
}

API

bencode.encode( data )

Buffer | Array | String | Object | Number data

Returns Buffer

bencode.decode( data, encoding )

Buffer data String encoding

If encoding is set, bytestrings are automatically converted to strings.

Returns Object | Array | Buffer | String | Number

npm loves you