/** * pool.js - peer management for bcoin * Copyright (c) 2014-2015, Fedor Indutny (MIT License) * https://github.com/indutny/bcoin */ var async = require('async'); var inherits = require('inherits'); var EventEmitter = require('events').EventEmitter; var bcoin = require('../bcoin'); var utils = bcoin.utils; var assert = utils.assert; var network = bcoin.protocol.network; /** * Pool */ function Pool(options) { var self = this; var Chain; if (!(this instanceof Pool)) return new Pool(options); EventEmitter.call(this); this.options = options || {}; if (this.options.network) network.set(this.options.network); this.options.fullNode = !!this.options.fullNode; this.options.relay = this.options.relay !== false; this.storage = this.options.storage; this.destroyed = false; this.size = options.size || 32; this.parallel = options.parallel || 2000; this.redundancy = options.redundancy || 2; this.backoff = { delta: options.backoffDelta || 500, max: options.backoffMax || 5000 }; this.load = { timeout: options.loadTimeout || 3000, interval: options.loadInterval || 5000, window: options.loadWindow || 250, lastRange: null, rangeWindow: options.rangeWindow || 1000, timer: null, lwm: options.lwm || this.parallel * 2, hwm: options.hwm || this.parallel * 8, hiReached: false }; if (this.options.fullNode) { if (!options.loadTimeout) this.load.timeout = 30000; if (!options.loadInterval) this.load.interval = 5000; } this.maxRetries = options.maxRetries || 42; this.requestTimeout = options.requestTimeout || 10000; Chain = this.options.fullNode ? bcoin.fullChain : bcoin.spvChain; this.chain = new Chain({ storage: this.storage }); this.watchMap = {}; this.bloom = new bcoin.bloom( 8 * 1024, 10, (Math.random() * 0xffffffff) | 0 ); this.peers = { // Peers that are loading blocks themselves block: [], // Peers that are still connecting pending: [], // Peers that are loading block ids load: null }; this.block = { lastHash: null, bestHeight: 0, bestHash: null }; this.request = { map: {}, active: 0, queue: [] }; this.validate = { // 5 days scan delta for obtaining TXs delta: 5 * 24 * 3600, // Minimum verification depth minDepth: options.minValidateDepth || 0, // getTX map map: {} }; // Currently broadcasted TXs this.tx = { list: [], timeout: options.txTimeout || 60000 }; // Added and watched wallets this.options.wallets = this.options.wallets || []; this.wallets = []; this.createSocket = options.createConnection || options.createSocket; assert(this.createSocket); this.chain.on('debug', function() { var args = Array.prototype.slice.call(arguments); self.emit.apply(self, ['debug'].concat(args)); }); if (!this.chain.loading) { this._init(); } else { this.chain.once('load', function() { self._init(); }); } } inherits(Pool, EventEmitter); Pool.prototype._init = function _init() { var self = this; var i; this._addLoader(); for (i = 0; i < this.size; i++) this._addPeer(0); this._load(); this.chain.on('missing', function(hash, preload, parent) { if (!self.options.fullNode) { self._request('filtered', hash, { force: true }); self._scheduleRequests(); self._loadRange(preload); } }); this.chain.on('fork', function(height, hash, checkpoint) { var peer = self.peers.load; if (!self.options.fullNode) return; if (!peer) return; peer.destroy(); }); this.options.wallets.forEach(function(w) { self.addWallet(w); }); }; Pool.prototype._addLoader = function _addLoader() { var self = this; var peer, interval, timer; if (this.destroyed) return; if (this.peers.load != null) return; peer = new bcoin.peer(this, this.createSocket, { backoff: 750 * Math.random(), startHeight: this.options.startHeight, relay: this.options.relay }); this.peers.load = peer; peer.on('error', function(err) { self.emit('error', err, peer); }); peer.once('close', onclose); function onclose() { clearTimeout(timer); clearInterval(interval); self._removePeer(peer); if (self.destroyed) return; self._addLoader(); } peer.once('ack', function() { peer.updateWatch(); if (!self._load()) clearTimeout(timer); }); peer.on('version', function(version) { if (version.height > self.block.bestHeight) self.block.bestHeight = version.height; self.emit('version', version, peer); }); function load() { self._load(); } interval = setInterval(load, this.load.interval); function destroy() { // Chain is full and up-to-date if (self.chain.isFull()) { clearTimeout(timer); self.emit('full'); self.block.lastHash = null; return; } peer.destroy(); } timer = setTimeout(destroy, this.load.timeout); peer.on('block', function(block) { self._handleBlock(block, peer); }); // Split blocks and request them using multiple peers peer.on('blocks', function(hashes) { var i, hash; self.emit('blocks', hashes); if (hashes.length === 0) { // Reset global load self.block.lastHash = null; return; } if (!self.options.fullNode) { // Request each block hashes.forEach(function(hash) { self._request('filtered', hash); }); self._scheduleRequests(); // The part of the response is in chain, no need to escalate requests async.every(hashes, function(hash, cb) { self.chain.has(utils.toHex(hash), function(res) { cb(!res); }); }, function(allNew) { if (!allNew) { self.block.lastHash = null; return; } // Store last hash to continue global load self.block.lastHash = hashes[hashes.length - 1]; clearTimeout(timer); // Reinstantiate timeout if (self._load()) timer = setTimeout(destroy, self.load.timeout); }); return; } for (i = 0; i < hashes.length; i++) { hash = hashes[i]; if (self.chain.hasOrphan(hash)) { peer.loadBlocks(self.chain.locatorHashes(), self.chain.getOrphanRoot(hash)); continue; } if (i === hashes.length - 1) peer.loadBlocks(self.chain.locatorHashes(), 0); if (!self.chain.hasBlock(hash)) self._request('block', hash); } self._scheduleRequests(); self.block.lastHash = hashes[hashes.length - 1]; clearInterval(interval); interval = setInterval(load, self.load.interval); clearTimeout(timer); timer = setTimeout(destroy, self.load.timeout); }); }; Pool.prototype._handleMerkle = function _handleMerkle(block, peer) { this._response(block); this.chain.add(block); this.emit('chain-progress', this.chain.fillPercent(), peer); this.emit('block', block, peer); }; Pool.prototype._handleBlock = function _handleBlock(block, peer) { var self = this; var hash, size, orphan, err; if (this.listeners('watched').length > 0) { utils.nextTick(function() { block.txs.forEach(function(tx) { if (self.isWatched(tx)) self.emit('watched', tx, peer); }); }); } backoff = 0; this._response(block); hash = block.hash('hex'); size = this.chain.size(); orphan = this.chain.hasOrphan(block); err = this.chain.add(block); if (err) this.emit('chain-error', err, peer); this.emit('_block', block, peer); if (this.chain.hasOrphan(block)) { peer.loadBlocks(this.chain.locatorHashes(), this.chain.getOrphanRoot(block)); if (!orphan) this.emit('orphan', block, peer); return; } if (this.chain.size() === size) return; this.emit('chain-progress', this.chain.fillPercent(), peer); this.emit('block', block, peer); }; Pool.prototype.isFull = function isFull() { return this.chain.isFull(); }; Pool.prototype._loadRange = function _loadRange(hashes, force) { var now = +new Date(); var last; if (this.options.fullNode) return; if (!hashes) return; if (hashes.length <= 1) return; // Limit number of requests if (!force && now - this.load.lastRange < this.load.rangeWindow) return; this.load.lastRange = now; if (!this.peers.load) this._addLoader(); last = hashes[hashes.length - 1]; hashes.slice(0, -1).forEach(function(hash) { this.peers.load.loadBlocks([ hash ], last); }, this); }; Pool.prototype._load = function _load() { var self = this; var next; if (this.request.queue.length >= this.load.hwm) { this.load.hiReached = true; return false; } this.load.hiReached = false; console.log( 'Requesting inv packet from %s with getblocks', this.peers.load.address); if (!this.options.fullNode) { next = function(hash) { if (!self.peers.load) self._addLoader(); else self.peers.load.loadBlocks([ hash ]); }; // Load more blocks, starting from last hash if (this.block.lastHash) next(this.block.lastHash); else this.chain.getLast(next); return true; } if (!this.peers.load) this._addLoader(); else this.peers.load.loadBlocks(this.chain.locatorHashes(), 0); return true; }; Pool.prototype._addPeer = function _addPeer(backoff) { var self = this; var peer; if (this.destroyed) return; if (this.peers.block.length + this.peers.pending.length >= this.size) return; peer = new bcoin.peer(this, this.createSocket, { backoff: backoff, startHeight: this.options.startHeight, relay: this.options.relay }); this.peers.pending.push(peer); peer._retry = 0; // Create new peer on failure peer.on('error', function(err) { self.emit('error', err, peer); }); peer.once('close', function() { self._removePeer(peer); if (self.destroyed) return; self._addPeer(Math.max(backoff + self.backoff.delta, self.backoff.max)); }); peer.once('ack', function() { var i; if (self.destroyed) return; i = self.peers.pending.indexOf(peer); if (i !== -1) { self.peers.pending.splice(i, 1); self.peers.block.push(peer); } peer.updateWatch(); self.tx.list.forEach(function(entry) { var result = peer.broadcast(entry.tx); if (!result) return; result[0].once('request', function() { entry.e.emit('ack', peer); }); }); self._scheduleRequests(); }); if (!this.options.fullNode) { peer.on('merkleblock', function(block) { // Reset backoff, peer seems to be responsive backoff = 0; self._handleMerkle(block, peer); }); } else { peer.on('block', function(block) { // Reset backoff, peer seems to be responsive backoff = 0; self._handleBlock(block, peer); }); } // Just FYI peer.on('reject', function(payload) { self.emit('reject', payload, peer); }); peer.on('notfound', function(items) { items.forEach(function(item) { var req = self.request.map[utils.toHex(item.hash)]; if (req) req.finish(null); }); }); peer.on('tx', function(tx) { self._response(tx); self.emit('tx', tx, peer); if (!self.options.fullNode) self.emit('watched', tx, peer); }); peer.on('addr', function(addr) { self.emit('addr', addr, peer); }); peer.on('blocks', function(blocks) { if (blocks.length === 1) self.block.bestHash = peer.bestBlock; self.emit('blocks', blocks, peer); }); peer.on('txs', function(txs) { self.emit('txs', txs, peer); }); peer.on('version', function(version) { if (version.height > self.block.bestHeight) self.block.bestHeight = version.height; self.emit('version', version, peer); }); utils.nextTick(function() { self.emit('peer', peer); }); }; Pool.prototype.bestPeer = function bestPeer() { return this.peers.block.reduce(function(best, peer) { if (!peer.version || !peer.socket) return; if (!best || peer.version.height > best.version.height) return peer; return best; }, null); }; Pool.prototype._removePeer = function _removePeer(peer) { var i = this.peers.pending.indexOf(peer); if (i !== -1) this.peers.pending.splice(i, 1); i = this.peers.block.indexOf(peer); if (i !== -1) this.peers.block.splice(i, 1); if (this.peers.load === peer) this.peers.load = null; }; Pool.prototype.watch = function watch(id) { var hid, i; if (id instanceof bcoin.wallet) { this.watchWallet(id); return; } if (id) { hid = utils.toHex(id); if (this.watchMap[hid]) this.watchMap[hid]++; else this.watchMap[hid] = 1; if (this.bloom.test(id, 'hex')) return; this.bloom.add(id, 'hex'); } if (this.peers.load) this.peers.load.updateWatch(); for (i = 0; i < this.peers.block.length; i++) this.peers.block[i].updateWatch(); }; Pool.prototype.unwatch = function unwatch(id) { var i; id = utils.toHex(id); if (!this.bloom.test(id, 'hex')) return; if (!this.watchMap[id] || --this.watchMap[id] !== 0) return; delete this.watchMap[id]; // Reset bloom filter this.bloom.reset(); Object.keys(this.watchMap).forEach(function(id) { this.bloom.add(id, 'hex'); }, this); // Resend it to peers if (this.peers.load) this.peers.load.updateWatch(); for (i = 0; i < this.peers.block.length; i++) this.peers.block[i].updateWatch(); }; // See "Filter matching algorithm": // https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki Pool.prototype.isWatched = function(tx, bloom) { var i, input, output, outHash; if (!bloom) bloom = this.bloom; function testScript(script) { return script.some(function(chunk) { if (!Array.isArray(chunk) || chunk.length === 0) return false; return bloom.test(chunk); }); } // 1. Test the tx hash if (bloom.test(tx.hash())) return true; // 2. Test data elements in output scripts // (may need to update filter on match) for (i = 0; i < tx.outputs.length; i++) { output = tx.outputs[i]; // Test the output script if (testScript(output.script)) return true; } // 3. Test prev_out structure // 4. Test data elements in input scripts for (i = 0; i < tx.inputs.length; i++) { input = tx.inputs[i]; outHash = input.out.hash; if (typeof outHash === 'string') outHash = utils.toArray(outHash, 'hex'); // Test the prev_out tx hash if (bloom.test(outHash)) return true; // Test the prev_out script if (input.out.tx) { output = input.out.tx.outputs[input.out.index]; if (testScript(output.script)) return true; } // Test the input script if (testScript(input.script)) return true; } // 5. No match return false; }; Pool.prototype.addWallet = function addWallet(w, defaultTs) { var self = this; var e; if (this.wallets.indexOf(w) !== -1) return false; this.watchWallet(w); this.wallets.push(w); e = new EventEmitter(); if (w.loaded) search(w.lastTs); else w.once('load', function() { search(w.lastTs) }); function search(ts) { // Relay pending TXs // NOTE: It is important to do it after search, because search could // add TS to pending TXs, thus making them confirmed w.pending().forEach(function(tx) { self.sendTX(tx); }); // Search for last week by default if (!ts) ts = defaultTs || ((+new Date / 1000) - 7 * 24 * 3600); if (self.options.fullNode) return; self.search(false, ts, e); } return e; }; Pool.prototype.removeWallet = function removeWallet(w) { var i = this.wallets.indexOf(w); if (i == -1) return; this.wallets.splice(i, 1); this.unwatchWallet(w); }; Pool.prototype.watchWallet = function watchWallet(w) { if (w.type === 'scripthash') { // For the redeem script hash in outputs: this.watch(w.getFullHash()); // For the redeem script in inputs: this.watch(w.getFullPublicKey()); } // For the pubkey hash in outputs: this.watch(w.getOwnHash()); // For the pubkey in inputs: this.watch(w.getOwnPublicKey()); }; Pool.prototype.unwatchWallet = function unwatchWallet(w) { if (w.type === 'scripthash') { // For the redeem script hash in p2sh outputs: this.unwatch(w.getFullHash()); // For the redeem script in p2sh inputs: this.unwatch(w.getFullPublicKey()); } // For the pubkey hash in p2pk/multisig outputs: this.unwatch(w.getOwnHash()); // For the pubkey in p2pkh inputs: this.unwatch(w.getOwnPublicKey()); }; Pool.prototype.search = function search(id, range, e) { var self = this; if (this.options.fullNode) return; e = e || new EventEmitter(); // Optional id argument if (id !== null && typeof id === 'object' && !Array.isArray(id) || typeof id === 'number') { range = id; id = null; } if (typeof id === 'string') id = utils.toArray(id, 'hex'); if (typeof range === 'number') range = { start: range, end: null }; else if (range) range = { start: range.start, end: range.end }; else range = { start: 0, end: 0 }; // Last 5 days by default, this covers 1000 blocks that we have in the // chain by default if (!range.end) range.end = +new Date() / 1000; if (!range.start) range.start = +new Date() / 1000 - 432000; this.chain.hashesInRange(range.start, range.end, function(hashes, count) { var waiting = count; if (id) self.watch(id); self._loadRange(hashes, true); // XXX // return; hashes = hashes.slice().reverse(); hashes.forEach(function(hash, i) { // Get the block that is in index self.chain.get(hash, true, function(block) { loadBlock(block, hashes[i + 1]); }); }); function loadBlock(block, stop) { // Stop block reached if (block.hash('hex') === stop) return; // Get block's prev and request it and all of it's parents up to // the next known block hash self.chain.get(block.prevBlock, block.prevBlock !== stop, function(prev) { done(); // First hash loaded if (!stop) return; // Continue loading blocks loadBlock(prev, stop); }); } function done() { waiting--; assert(waiting >= 0); e.emit('progress', count - waiting, count); if (waiting === 0) { if (id) self.unwatch(id); e.emit('end'); } } // Empty search if (hashes.length === 0) { bcoin.utils.nextTick(function() { e.emit('end', true); }); } }); return e; }; Pool.prototype._request = function _request(type, hash, options, cb) { var self = this; // Optional `force` if (typeof options === 'function') { cb = options; options = {}; } if (!options) options = {}; hash = utils.toHex(hash); if (this.request.map[hash]) return this.request.map[hash].addCallback(cb); function next(has) { if (has) return; if (self.destroyed) return; var req = new LoadRequest(self, type, hash, cb); req.add(options.noQueue); } // Block should be not in chain, or be requested if (!options.force && (type === 'block' || type === 'filtered')) return this.chain.has(hash, true, next); return next(false); }; Pool.prototype._response = function _response(entity) { var req = this.request.map[entity.hash('hex')]; if (!req) return false; req.finish(entity); return true; }; Pool.prototype._scheduleRequests = function _scheduleRequests() { var self = this; if (this.destroyed) return; if (this.request.active > this.parallel / 2) return; // No need to wait - already have enough data if (this.request.queue.length > this.parallel) { if (this.load.timer !== null) clearTimeout(this.load.timer); this.load.timer = null; return this._doRequests(); } // Already waiting if (this.load.timer !== null) return; this.load.timer = setTimeout(function() { self.load.timer = null; self._doRequests(); }, this.load.window); }; Pool.prototype._doRequests = function _doRequests() { var queue, above, items, below; var red, count, split, i, off, req, j; var mapReq; if (this.request.active >= this.parallel) return; // No peers so far if (this.peers.block.length === 0) return; queue = this.request.queue; above = queue.length >= this.load.lwm; items = queue.slice(0, this.parallel - this.request.active); this.request.queue = queue.slice(items.length); below = this.request.queue.length < this.load.lwm; // Watermark boundary crossed, load more blocks if (above && below && this.load.hiReached) this._load(); if (!this.options.fullNode) { mapReq = function(item) { return item.start(this.peers.block[i]); }; // Split list between peers red = this.redundancy; count = this.peers.block.length; split = Math.ceil(items.length * red / count); for (i = 0, off = 0; i < count; i += red, off += split) { req = items.slice(off, off + split).map(mapReq, this); for (j = 0; j < red && i + j < count; j++) this.peers.block[i + j].getData(req); } return; } req = items.map(function(item) { return item.start(this.peers.load); }, this); this.peers.load.getData(req); }; Pool.prototype.getTX = function getTX(hash, range, cb) { var self = this; var cbs, tx, finished, req, delta; hash = utils.toHex(hash); if (typeof range === 'function') { cb = range; range = null; } // Do not perform duplicate searches if (this.validate.map[hash]) return this.validate.map[hash].push(cb); cbs = [ cb ]; this.validate.map[hash] = cbs; // Add request without queueing it to get notification at the time of load tx = null; finished = false; req = this._request('tx', hash, { noQueue: true }, function(t) { finished = true; tx = t; }); // Do incremental search until the TX is found delta = this.validate.delta; // Start from the existing range if given if (range) range = { start: range.start, end: range.end }; else range = { start: (+new Date() / 1000) - delta, end: 0 }; function doSearch() { var e = self.search(hash, range); e.on('end', function(empty) { if (finished) { delete self.validate.map[hash]; cbs.forEach(function(cb) { cb(tx, range); }); return; } // Tried everything, but still no matches if (empty) return cb(null); // Not found yet, continue scanning range.end = range.start; range.start -= delta; if (range.start < 0) range.start = 0; doSearch(); }); } doSearch(); }; Pool.prototype.sendTX = function sendTX(tx) { var self = this; var e = new EventEmitter(); var entry = { tx: tx, e: e, timer: setTimeout(function() { var i = self.tx.list.indexOf(entry); if (i !== -1) self.tx.list.splice(i, 1); }, this.tx.timeout) }; this.tx.list.push(entry); this.peers.block.forEach(function(peer) { var result = peer.broadcast(tx); if (!result) return; result[0].once('request', function() { e.emit('ack', peer); }); }); return e; }; Pool.prototype.destroy = function destroy() { if (this.destroyed) return; this.destroyed = true; if (this.peers.load) this.peers.load.destroy(); this.request.queue.slice().forEach(function(item) { item.finish(null); }); this.tx.list.forEach(function(tx) { clearTimeout(tx.timer); tx.timer = null; }); this.peers.pending.slice().forEach(function(peer) { peer.destroy(); }); this.peers.block.slice().forEach(function(peer) { peer.destroy(); }); if (this.load.timer) clearTimeout(this.load.timer); this.load.timer = null; }; Pool.prototype.toJSON = function toJSON() { return { v: 1, type: 'pool', chain: this.chain.toJSON() }; }; Pool.prototype.fromJSON = function fromJSON(json) { assert.equal(json.v, 1); assert.equal(json.type, 'pool'); this.chain.fromJSON(json.chain); return this; }; function LoadRequest(pool, type, hash, cb) { var self = this; this.pool = pool; this.type = type; this.hash = hash; this.cbs = cb ? [ cb ] : []; this.timer = null; this.peer = null; this.ts = +new Date(); this.active = false; this.noQueue = false; this.onclose = function onclose() { if (self.pool.destroyed) self.clear(); else self.retry(); }; } LoadRequest.prototype.start = function start(peer) { var self = this; var reqType; assert(!this.active); this.active = true; this.pool.request.active++; assert(!this.timer); this.timer = setTimeout(function() { self.timer = null; self.retry(); }, this.pool.requestTimeout); assert(!this.peer); this.peer = peer; this.peer.once('close', this.onclose); return { type: this.type, hash: this.hash }; }; LoadRequest.compare = function compare(a, b) { return a.ts - b.ts; }; LoadRequest.prototype.add = function add(noQueue) { this.pool.request.map[this.hash] = this; if (!noQueue) this.pool.request.queue.push(this); else this.noQueue = true; }; LoadRequest.prototype.clear = function clear() { assert(this.active); this.pool.request.active--; this.active = false; this.peer.removeListener('close', this.onclose); this.peer = null; clearTimeout(this.timer); this.timer = null; }; LoadRequest.prototype.retry = function retry() { var peer = this.peer; // Put block into the queue, ensure that the queue is always sorted by ts utils.binaryInsert(this.pool.request.queue, this, LoadRequest.compare); this.clear(); // Kill peer, if it misbehaves if (++peer._retry > this.pool.maxRetries) peer.destroy(); // And schedule requesting blocks again this.pool._scheduleRequests(); }; LoadRequest.prototype.finish = function finish(entity) { var index; if (this.active) { this.clear(); } else { // It could be that request was never sent to the node, remove it from // queue and forget about it index = this.pool.request.queue.indexOf(this); assert(index !== -1 || this.noQueue); if (!this.noQueue) this.pool.request.queue.splice(index, 1); assert(!this.peer); assert(!this.timer); } delete this.pool.request.map[this.hash]; // We may have some free slots in queue now this.pool._scheduleRequests(); this.cbs.forEach(function(cb) { cb(entity); }); }; LoadRequest.prototype.addCallback = function addCallback(cb) { if (cb) this.cbs.push(cb); }; /** * Expose */ module.exports = Pool;