Add transport/peermanager class
This commit is contained in:
parent
4faa1a4a46
commit
a1e8f3c596
1
index.js
1
index.js
|
@ -28,6 +28,7 @@ bitcore.util.js = require('./lib/util/js');
|
|||
bitcore.transport = {};
|
||||
bitcore.transport.Connection = require('./lib/transport/connection');
|
||||
bitcore.transport.Peer = require('./lib/transport/peer');
|
||||
bitcore.transport.PeerManager = require('./lib/transport/peermanager');
|
||||
|
||||
// errors thrown by the library
|
||||
bitcore.errors = require('./lib/errors');
|
||||
|
|
|
@ -21,7 +21,16 @@ _.extend(livenet, {
|
|||
privatekey: 0x80,
|
||||
scripthash: 0x05,
|
||||
xpubkey: 0x0488b21e,
|
||||
xprivkey: 0x0488ade4
|
||||
xprivkey: 0x0488ade4,
|
||||
port: 8333,
|
||||
dnsSeeds: [
|
||||
'seed.bitcoin.sipa.be',
|
||||
'dnsseed.bluematt.me',
|
||||
'dnsseed.bitcoin.dashjr.org',
|
||||
'seed.bitcoinstats.com',
|
||||
'seed.bitnodes.io',
|
||||
'bitseed.xf2.org'
|
||||
]
|
||||
});
|
||||
|
||||
/**
|
||||
|
@ -36,15 +45,22 @@ _.extend(testnet, {
|
|||
privatekey: 0xef,
|
||||
scripthash: 0xc4,
|
||||
xpubkey: 0x043587cf,
|
||||
xprivkey: 0x04358394
|
||||
xprivkey: 0x04358394,
|
||||
port: 18333,
|
||||
dnsSeeds: [
|
||||
'testnet-seed.bitcoin.petertodd.org',
|
||||
'testnet-seed.bluematt.me'
|
||||
],
|
||||
});
|
||||
|
||||
var networkMaps = {};
|
||||
|
||||
_.each(_.values(livenet), function(value) {
|
||||
if (_.isArray(value)) return;
|
||||
networkMaps[value] = livenet;
|
||||
});
|
||||
_.each(_.values(testnet), function(value) {
|
||||
if (_.isArray(value)) return;
|
||||
networkMaps[value] = testnet;
|
||||
});
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
var MAX_RECEIVE_BUFFER = 10000000;
|
||||
var PROTOCOL_VERSION = 70000;
|
||||
|
||||
var Util = require('util');
|
||||
var util = require('util');
|
||||
var Put = require('bufferput');
|
||||
var Buffers = require('buffers');
|
||||
var buffertools = require('buffertools');
|
||||
|
@ -30,9 +30,10 @@ var BufferUtil = require('../util/buffer');
|
|||
var BufferReader = require('../encoding/bufferreader');
|
||||
var Hash = require('../crypto/hash');
|
||||
var Random = require('../crypto/random');
|
||||
var nonce = Random.getPseudoRandomBuffer(8);
|
||||
var EventEmitter = require('events').EventEmitter;
|
||||
|
||||
var nonce = Random.getPseudoRandomBuffer(8);
|
||||
|
||||
var BIP0031_VERSION = 60000;
|
||||
|
||||
function Connection(socket, peer, opts) {
|
||||
|
@ -73,7 +74,7 @@ function Connection(socket, peer, opts) {
|
|||
|
||||
this.setupHandlers();
|
||||
}
|
||||
Util.inherits(Connection, EventEmitter);
|
||||
util.inherits(Connection, EventEmitter);
|
||||
|
||||
Connection.prototype.open = function(callback) {
|
||||
if (typeof callback === 'function') this.once('connect', callback);
|
||||
|
|
|
@ -0,0 +1,313 @@
|
|||
'use strict';
|
||||
|
||||
var dns = require('dns');
|
||||
var util = require('util');
|
||||
var async = require('async');
|
||||
|
||||
var Connection = require('./connection');
|
||||
var Peer = require('./peer');
|
||||
var networks = require('../networks');
|
||||
|
||||
var GetAdjustedTime = function() {
|
||||
// TODO: Implement actual adjustment
|
||||
return Math.floor(new Date().getTime() / 1000);
|
||||
};
|
||||
|
||||
function PeerManager(config) {
|
||||
// extend defaults with config
|
||||
this.config = config || {};
|
||||
this.config.network = this.config.network || networks.livenet;
|
||||
|
||||
this.active = false;
|
||||
this.timer = null;
|
||||
|
||||
this.peers = [];
|
||||
this.pool = [];
|
||||
this.connections = [];
|
||||
this.isConnected = false;
|
||||
this.peerDiscovery = false;
|
||||
|
||||
// Move these to the Node's settings object
|
||||
this.interval = 5000;
|
||||
this.minConnections = 8;
|
||||
this.minKnownPeers = 10;
|
||||
|
||||
// keep track of tried seeds and results
|
||||
this.seeds = {
|
||||
resolved: [],
|
||||
failed: []
|
||||
};
|
||||
}
|
||||
|
||||
var EventEmitter = require('events').EventEmitter;
|
||||
util.inherits(PeerManager, EventEmitter);
|
||||
PeerManager.Connection = Connection;
|
||||
|
||||
PeerManager.prototype.start = function() {
|
||||
this.active = true;
|
||||
if (!this.timer) {
|
||||
this.timer = setInterval(this.checkStatus.bind(this), this.interval);
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.stop = function() {
|
||||
this.active = false;
|
||||
if (this.timer) {
|
||||
clearInterval(this.timer);
|
||||
this.timer = null;
|
||||
}
|
||||
for (var i = 0; i < this.connections.length; i++) {
|
||||
this.connections[i].socket.end();
|
||||
};
|
||||
};
|
||||
|
||||
PeerManager.prototype.addPeer = function(peer, port) {
|
||||
if (peer instanceof Peer) {
|
||||
this.peers.push(peer);
|
||||
} else if ("string" == typeof peer) {
|
||||
this.addPeer(new Peer(peer, port));
|
||||
} else {
|
||||
console.error('Node.addPeer(): Invalid value provided for peer', {
|
||||
val: peer
|
||||
});
|
||||
throw 'Node.addPeer(): Invalid value provided for peer.';
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.removePeer = function(peer) {
|
||||
var index = this.peers.indexOf(peer);
|
||||
var exists = !!~index;
|
||||
if (exists) this.peers.splice(index, 1);
|
||||
return exists;
|
||||
};
|
||||
|
||||
PeerManager.prototype.checkStatus = function checkStatus() {
|
||||
// Make sure we are connected to all forcePeers
|
||||
if (this.peers.length) {
|
||||
var peerIndex = {};
|
||||
this.peers.forEach(function(peer) {
|
||||
peerIndex[peer.toString()] = peer;
|
||||
});
|
||||
|
||||
// Ignore the ones we're already connected to
|
||||
this.connections.forEach(function(conn) {
|
||||
var peerName = conn.peer.toString();
|
||||
if ("undefined" !== peerIndex[peerName]) {
|
||||
delete peerIndex[peerName];
|
||||
}
|
||||
});
|
||||
|
||||
// for debug purposes, print how many of our peers are actually connected
|
||||
var connected = 0
|
||||
this.peers.forEach(function(p) {
|
||||
if (p.connection && !p.connection._connecting) connected++
|
||||
});
|
||||
console.debug(connected + ' of ' + this.peers.length + ' peers connected');
|
||||
|
||||
Object.keys(peerIndex).forEach(function(i) {
|
||||
this.connectTo(peerIndex[i]);
|
||||
}.bind(this));
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.connectTo = function(peer) {
|
||||
console.info('connecting to ' + peer);
|
||||
try {
|
||||
return this.addConnection(peer.createConnection(), peer);
|
||||
} catch (e) {
|
||||
console.error('creating connection', e);
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.addConnection = function(socketConn, peer) {
|
||||
var conn = new Connection(socketConn, peer, this.config);
|
||||
this.connections.push(conn);
|
||||
this.emit('connection', conn);
|
||||
|
||||
conn.addListener('version', this.handleVersion.bind(this));
|
||||
conn.addListener('verack', this.handleReady.bind(this));
|
||||
conn.addListener('addr', this.handleAddr.bind(this));
|
||||
conn.addListener('getaddr', this.handleGetAddr.bind(this));
|
||||
conn.addListener('error', this.handleError.bind(this));
|
||||
conn.addListener('disconnect', this.handleDisconnect.bind(this));
|
||||
|
||||
return conn;
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleVersion = function(e) {
|
||||
e.peer.version = e.message.version;
|
||||
e.peer.start_height = e.message.start_height;
|
||||
|
||||
if (!e.conn.inbound) {
|
||||
// TODO: Advertise our address (if listening)
|
||||
}
|
||||
// Get recent addresses
|
||||
if (this.peerDiscovery &&
|
||||
(e.message.version >= 31402 || this.peers.length < 1000)) {
|
||||
e.conn.sendGetAddr();
|
||||
e.conn.getaddr = true;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleReady = function(e) {
|
||||
console.info('connected to ' + e.conn.peer.host + ':' + e.conn.peer.port);
|
||||
this.emit('connect', {
|
||||
pm: this,
|
||||
conn: e.conn,
|
||||
socket: e.socket,
|
||||
peer: e.peer
|
||||
});
|
||||
|
||||
if (this.isConnected == false) {
|
||||
this.emit('netConnected', e);
|
||||
this.isConnected = true;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleAddr = function(e) {
|
||||
if (!this.peerDiscovery) return;
|
||||
|
||||
var now = GetAdjustedTime();
|
||||
e.message.addrs.forEach(function(addr) {
|
||||
try {
|
||||
// In case of an invalid time, assume "5 days ago"
|
||||
if (addr.time <= 100000000 || addr.time > (now + 10 * 60)) {
|
||||
addr.time = now - 5 * 24 * 60 * 60;
|
||||
}
|
||||
var peer = new Peer(addr.ip, addr.port, addr.services);
|
||||
peer.lastSeen = addr.time;
|
||||
|
||||
// TODO: Handle duplicate peers
|
||||
this.peers.push(peer);
|
||||
|
||||
// TODO: Handle addr relay
|
||||
} catch (e) {
|
||||
console.warn("Invalid addr received: " + e.message);
|
||||
}
|
||||
}.bind(this));
|
||||
if (e.message.addrs.length < 1000) {
|
||||
e.conn.getaddr = false;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleGetAddr = function(e) {
|
||||
// TODO: Reply with addr message.
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleError = function(e) {
|
||||
console.error('unkown error with peer ' + e.peer + ' (disconnecting): ' + e.err);
|
||||
this.handleDisconnect.apply(this, [].slice.call(arguments));
|
||||
};
|
||||
|
||||
PeerManager.prototype.handleDisconnect = function(e) {
|
||||
console.info('disconnected from peer ' + e.peer);
|
||||
var i = this.connections.indexOf(e.conn);
|
||||
if (i != -1) this.connections.splice(i, 1);
|
||||
|
||||
this.removePeer(e.peer);
|
||||
if (this.pool.length) {
|
||||
console.info('replacing peer using the pool of ' + this.pool.length + ' seeds');
|
||||
this.addPeer(this.pool.pop());
|
||||
}
|
||||
|
||||
if (!this.connections.length) {
|
||||
this.emit('netDisconnected');
|
||||
this.isConnected = false;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.getActiveConnection = function() {
|
||||
var activeConnections = this.connections.filter(function(conn) {
|
||||
return conn.active;
|
||||
});
|
||||
|
||||
if (activeConnections.length) {
|
||||
var randomIndex = Math.floor(Math.random() * activeConnections.length);
|
||||
var candidate = activeConnections[randomIndex];
|
||||
if (candidate.socket.writable) {
|
||||
return candidate;
|
||||
} else {
|
||||
// Socket is not writable, remove it from active connections
|
||||
activeConnections.splice(randomIndex, 1);
|
||||
|
||||
// Then try again
|
||||
// TODO: This causes an infinite recursion when all connections are dead,
|
||||
// although it shouldn't.
|
||||
return this.getActiveConnection();
|
||||
}
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
||||
PeerManager.prototype.getActiveConnections = function() {
|
||||
return this.connections.slice(0);
|
||||
};
|
||||
|
||||
PeerManager.prototype.discover = function(options, callback) {
|
||||
var self = this;
|
||||
var seeds = this.config.network.dnsSeeds;
|
||||
|
||||
self.limit = options.limit || 12;
|
||||
|
||||
var dnsExecutor = seeds.map(function(seed) {
|
||||
return function(done) {
|
||||
// have we already resolved this seed?
|
||||
if (~self.seeds.resolved.indexOf(seed)) {
|
||||
// if so, just pass back cached peer list
|
||||
return done(null, self.seeds.results[seed]);
|
||||
}
|
||||
|
||||
// has this seed failed to resolve?
|
||||
if (~self.seeds.failed.indexOf(seed)) {
|
||||
// if so, pass back empty results
|
||||
return done(null, []);
|
||||
}
|
||||
|
||||
console.info('resolving dns seed ' + seed);
|
||||
|
||||
dns.resolve(seed, function(err, peers) {
|
||||
if (err) {
|
||||
console.error('failed to resolve dns seed ' + seed, err);
|
||||
self.seeds.failed.push(seed);
|
||||
return done(null, []);
|
||||
}
|
||||
|
||||
console.info('found ' + peers.length + ' peers from ' + seed);
|
||||
self.seeds.resolved.push(seed);
|
||||
|
||||
// transform that list into a list of Peer instances
|
||||
peers = peers.map(function(ip) {
|
||||
return new Peer(ip, self.config.network.port);
|
||||
});
|
||||
|
||||
peers.forEach(function(p) {
|
||||
if (self.peers.length < self.limit) self.addPeer(p);
|
||||
else self.pool.push(p);
|
||||
});
|
||||
|
||||
self.emit('peers', peers);
|
||||
|
||||
return done(null, peers);
|
||||
});
|
||||
|
||||
};
|
||||
});
|
||||
|
||||
// try resolving all seeds
|
||||
async.parallel(dnsExecutor, function(err, results) {
|
||||
var peers = [];
|
||||
|
||||
// consolidate all resolved peers into one list
|
||||
results.forEach(function(peerlist) {
|
||||
peers = peers.concat(peerlist);
|
||||
});
|
||||
|
||||
if (typeof callback === 'function') callback(null, peers);
|
||||
});
|
||||
|
||||
return self;
|
||||
};
|
||||
|
||||
module.exports = PeerManager;
|
|
@ -0,0 +1,42 @@
|
|||
'use strict';
|
||||
|
||||
var chai = require('chai');
|
||||
var bitcore = require('../..');
|
||||
|
||||
var should = chai.should();
|
||||
|
||||
var PeerManager = bitcore.transport.PeerManager;
|
||||
|
||||
describe('PeerManager', function() {
|
||||
it('should be able to create class', function() {
|
||||
should.exist(PeerManager);
|
||||
});
|
||||
|
||||
it('should be able to create instance', function() {
|
||||
var pm = new PeerManager();
|
||||
should.exist(pm);
|
||||
});
|
||||
|
||||
it('should be able to start instance', function() {
|
||||
var pm = new PeerManager();
|
||||
pm.start.bind(pm).should.not.throw();
|
||||
});
|
||||
|
||||
it('should be able to stop instance', function() {
|
||||
var pm = new PeerManager();
|
||||
pm.start();
|
||||
pm.stop.bind(pm).should.not.throw();
|
||||
});
|
||||
|
||||
it('should extend default config with passed config', function() {
|
||||
var pm = new PeerManager({
|
||||
proxy: {
|
||||
host: 'localhost',
|
||||
port: 9050
|
||||
}
|
||||
});
|
||||
|
||||
should.exist(pm.config.network);
|
||||
should.exist(pm.config.proxy);
|
||||
});
|
||||
});
|
Loading…
Reference in New Issue