bittorrent-wire v0.9.3
bittorrent-wire
A stream ready wire for the Bittorrent Protocol
One of the fastest, lightest, and smartest bittorrent wires yet.
streams | protocol |
---|---|
Bittorrent Protocol
Streams
Extension Protocol
Topic | Source |
---|---|
Extension | BEP_0010 |
UT_PEX | BEP_0011 |
UT_METADATA | BEP_0009 |
module | tests | version | description |
---|---|---|---|
ut-extensions | Extensions for The Bittorent Protocol |
Install
npm install bittorrent-wire
Usage
Basic
import Wire from "bittorrent-wire"
let wire = new Wire("INFO_HASH_GOES_HERE", "PEER_ID_GOES_HERE");
wire.pipe(wire);
Online
import * as net from 'net';
import Wire from "bittorrent-wire"
let socket = net.connect(1337, 'localhost');
socket.once('connect', () => {
let wire = new Wire("e940a7a57294e4c98f62514b32611e38181b6cae", "-EM0022-PEANUTS4AITH");
socket.pipe(wire).pipe(socket);
wire.on("handshake", (infoHash, peerID) => {
// ...
});
});
Function-Event Pair
Outbound Handshake
wire.sendHandshake();
Inbound Handshake
wire.on("handshake", function (infoHash: Buffer, peerId: Buffer) {
// infoHash -> 20 bit hex buffer
// peerId -> 20 bit utf-8 buffer
});
Outbound Not Interested
wire.sendHandshake();
wire.sendNotInterested();
Inbound Not Interested
wire.on("close", () => {
// wire.isActive -> false
});
Outbound Interested
wire.sendHandshake();
wire.sendInterested();
Inbound Interested
wire.on("interested", () => {
// wire.choked -> false
});
Outbound Have
wire.sendHandshake();
wire.sendHave(1); //Index number
Inbound Have
wire.on("have", (index: number) => {
// index -> 1
});
Outbound Bitfield
let buffer = Buffer.from("40", "hex");
wire.sendHandshake();
wire.sendBitfield(buffer); // Hex Buffer
Inbound Bitfield
wire.on("bitfield", (bits) => {
// bits.toString("hex") -> 40
});
Outbound Request
const TPH = require("torrent-piece-handler");
const files = [ { path: "Downloads/lol1/1.png",
name: "1.png",
length: 255622,
offset: 0 },
{ path: "Downloads/lol2/2.png",
name: "2.png",
length: 1115627,
offset: 255622 } ];
// ...
wire.sendHandshake();
wire.sendInterested();
// Prepare a request for the pieces
let tph = new TPH.default(files, 962416635, 1048576, 918, 872443);
tph.prepareRequest(0, (buf, count) => {
// Send to wire.
wire.sendRequest(buf, count);
});
Inbound Request
wire.on("request", () => {
// wire.inRequests[2].index -> 0
// wire.inRequests[2].begin -> 16384 * 2
// wire.inRequests[2].length -> 16384
});
Outbound Cancel
wire.sendHandshake();
wire.sendInterested();
wire.sendCancel(0, 16384 * 2, 16384); //Index number
Inbound Cancel
wire.on("cancel", (index, begin, length) => {
// index -> 0
// begin -> 16384 * 2
// length -> 16384
});
API
Class: Wire
new Wire(infoHash: string | Buffer, myID: string | Buffer, options?: Options)
- infoHash: the torrent info_hash
- 20 byte hex Buffer or 20 character string
- ex:
"e940a7a57294e4c98f62514b32611e38181b6cae"
- myID: the ID of the user.
- 20 byte hex Buffer or 20 character string
- ex:
"-EM0022-PEANUTS4AITH"
- Options:
interface Options {
"metadata_handshake": MetadataHandshake;
}
interface MetadataHandshake {
"ipv4": Buffer;
"ipv6": Buffer;
"m": Extension;
"metadata_size": number;
"p": number;
"reqq": number;
"v": Buffer;
"yourip": Buffer;
}
interface Extension {
"ut_pex": number;
"ut_metadata": number;
}
Wire: Outbound
Wire.sendHandshake() <pstrlen><pstr><reserved><info_hash><peer_id>
The first step in starting a channel with another peer
Wire.sendInterested() <len=0001><id=2>
This will request unchoking the connection
Wire.sendNotInterested() <len=0001><id=3>
If the peer does not have data we need
Wire.sendHave(index: number) <len=0005><id=4><piece index>
index
the block in question e.g. 0, 1, 2, 3, ...- Send peers that you have a new piece in your bitfield
Wire.sendBitfield(bitfield: string) <len=0001+X><id=5><bitfield>
bitfield
string representing a hex bitfield e.g. "f8"- Send peer your current downloaded bitfield
Wire.sendRequest(payload: Buffer, count: number) <len=0013><id=6><index><begin><length>
payload
wrap the index, begin, and length all into one buffercount
number of pieces you are requesting e.g. 0, 1, 2, 3, ...- Send a request for either a piece or block. Payload allows for multiple requests
Wire.sendPiece(piece: Buffer) <len=0009+X><id=7><index><begin><block>
piece
wrap the index, begin, and length all into one buffer- Given a request, this is how you respond
Wire.sendCancel(index: number, begin: number, length: number) <len=0013><id=8><index><begin><length>
index
index of the block e.g. 0, 1, 2, 3, ...begin
number inside the block e.g. 0 16384, 1 16384, 2 * 16384, ...- length: length (always 16384 unless last piece)
- Canceling a download with the peer
Wire.sendPort(port: number) <len=0003><id=9><listen-port>
port
number of the UDP port the DHT is listening on- send peer your KPRC protocol UDP port
Wire: Extensions
Wire.sendMetaHandshake()
- if "metadata_handshake" options are set, this will send your options specified, otherwise the defaults are:
ut_metadata
2ut_pex
1
Wire.createExtensions(metadataSize: number, torrentInfo: Info)
this.createUTmetadata(metadataSize, torrentInfo)
this.createUTpex()
Wire.createUTmetadata(metadataSize: number, torrentInfo: Info)
this.ext[UT_METADATA] = new UTmetadata(metadataSize, this.infoHash, torrentInfo)
Wire.createUTpex()
this.ext[UT_PEX] = new UTpex()
Wire.prototype.sendPexPeers (addPeers: Array, addPeers6: Array, dropPeers: Array, dropPeers6: Array)
addPeers
ipv4 peers that you know are goodaddPeers6
ipv6 peers that you know are gooddropPeers
ipv4 peers that you know are baddropPeers6
ipv6 peers that you know are bad
Wire: High Level Calls
Wire.isChoked(): Boolean
return this.choked
Wire.isBusy(): Boolean
return this.busy
Wire.setBusy()
this.busy = true
Wire.unsetBusy()
this.busy = false
Wire.closeConnection()
this.isActive = false
this.emit("close")
Wire.removeMeta()
this.meta = false
delete this.ext[ UT_METADATA ]
Wire.removePex()
delete this.ext[ UT_PEX ]
Debug
DEBUG="bittorrent-wire" ts-node bittorrent-wire.ts
ISC License (Open Source Initiative)
ISC License (ISC) Copyright 2017 Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC") Copyright (c) 1995-2003 by Internet Software Consortium
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.