flocore-node/lib/services/p2p/index.js

'use strict';

var p2p = require('bitcore-p2p');
var LRU = require('lru-cache');
var util = require('util');
var _ = require('lodash');
var bitcore = require('bitcore-lib');
var index = require('../../');
var log = index.log;
var BaseService = require('../../service');
var constants = require('../../constants');

/*
  Purpose:
      1. join a P2P
      2. relay messages
      3. publish new transactions (pub/sub)
      4. publish new blocks (pub/sub)
      5. broadcast messages on behalf of subscribers (block headers, blocks, bloom filters)
*/
var P2P = function(options) {

  if (!(this instanceof P2P)) {
    return new P2P(options);
  }

  BaseService.call(this, options);
  this.options = options;
  this._maxPeers = this.options.maxPeers || 60;
  this._minPeers = this.options.minPeers || 1;
  this._configPeers = this.options.peers;
  this.subscriptions = {};
  this.subscriptions.block = [];
  this.subscriptions.transaction = [];
  this.messages = new p2p.Messages({ network: this.node.network });
  this._peerHeights = [];
  this._peers = [];
  this._peerIndex = 0;
  this._filters = [];
};

util.inherits(P2P, BaseService);

P2P.dependencies = [];

P2P.prototype.start = function(callback) {

  var self = this;
  self._initCache();
  self._initPool();
  this._setupListeners();
  callback();

};

P2P.prototype.stop = function(callback) {

  var self = this;
  self._pool.disconnect();
  callback();

};

P2P.prototype.subscribe = function(name, emitter) {
  this.subscriptions[name].push(emitter);
  log.info(emitter.remoteAddress, 'subscribe:', 'p2p/' + name, 'total:', this.subscriptions[name].length);
};

P2P.prototype.unsubscribe = function(name, emitter) {
  var index = this.subscriptions[name].indexOf(emitter);
  if (index > -1) {
    this.subscriptions[name].splice(index, 1);
  }
  log.info(emitter.remoteAddress, 'unsubscribe:', 'p2p/' + name, 'total:', this.subscriptions[name].length);
};

P2P.prototype._initCache = function() {
  this._inv = LRU(2000);
  this._cache = [];
};

P2P.prototype._initPool = function() {
  var opts = {};
  if (this._configPeers) {
    opts.addrs = this._configPeers;
    opts.dnsSeed = false;
  }
  opts.maxPeers = this._maxPeers;
  opts.network = this.node.getNetworkName();
  this._pool = new p2p.Pool(opts);
};

P2P.prototype._addPeer = function(peer) {
  this._peers.push(peer);
};

P2P.prototype._removePeer = function(peer) {
  this._peers.splice(this._peers.indexOf(peer), 1);
};

P2P.prototype._getPeer = function() {

  if (this._peers.length === 0) {
    return;
  }
  var index = this._peerIndex++ % this._peers.length;
  return this._peers[index];
};

P2P.prototype._getBestHeight = function(peer) {
  this._peerHeights.push(peer.bestHeight);
  if (this._peerHeights >= this._minPeers) {
    return Math.max(this._bestHeights);
  }
};


P2P.prototype._appendFilters = function(peer, filter) {
  var filterList = this._filters[peer];

  if (!filterList || filterList.length !== 0) {
    return;
  }
console.log('here', filter);
  if (filter.length >= 10) {
    this._filters[peer] = filter;
  }
};

P2P.prototype._setupListeners = function() {
  var self = this;

  self._pool.on('peerready', function(peer, addr) {

    log.info('Connected to peer: ' + addr.ip.v4 + ', network: ' +
    peer.network.alias + ', version: ' + peer.version + ', subversion: ' +
    peer.subversion + ', status: ' + peer.status + ', port: ' +
    peer.port + ', best height: ' + peer.bestHeight);

    self._addPeer(peer);
    var bestHeight = self._getBestHeight(peer);
    if (bestHeight >= 0) {
      self.emit('bestHeight', bestHeight);
    }
  });

  self._pool.on('peerdisconnect', function(peer, addr) {

    self._removePeer(peer);
    log.info('Disconnected from peer: ' + addr.ip.v4);

  });

  self._pool.on('peerinv', function(peer, message) {

    var newDataNeeded = [];

    // the bitcoin p2p network can send unsolicited inventory messages
    // because we've asked it to when connecting. We want to know about new
    // blocks and transactions asynchronoously. The problem is that when we
    // do ask for inventory synchronuously, we can't tell messages arriving
    // after we've asked if they are a response to our request or unsolicited.
    // There is no request id that we can match against the response.
    // The safest way to get around this is to disconnect the peer and reconnect
    // without relaying turned om, so the peer will not spontaneously send us inv
    // messages. This way we know for sure that the inv message is a response to
    // our request.

    // have we asked for inventory from a particular peer? Check our filters list
    // based on filters that may have been previously set by a request from this service,
    // we need to set the inventory list on the peer's filter so that when the inventory
    // is retrieved, it can be returned to the caller and not sent out on the main bux
    self._appendFilters(peer, message.inventory);

    message.inventory.forEach(function(inv) {

      if (!self._inv.get(inv.hash)) {

        self._inv.set(inv.hash, true);

        newDataNeeded.push(inv);

      }

    });

    if (newDataNeeded.length > 0) {
      peer.sendMessage(self.messages.GetData(newDataNeeded));
    }

  });

  self._pool.on('peertx', self._filterTx.bind(self));

  self._pool.on('peerblock', self._broadcastBlock.bind(self));

  self.node.on('ready', function() {
    self._pool.connect();
  });

};

P2P.prototype._processFilter = function(filter, message) {
  var existsInFilter = false;
  if (!filter) {
    return existsInFilter;
  }
  filter.forEach(function(inv, index) {
console.log(inv.hash.toString('hex'), message.transaction.hash);
    if (message.transaction.hash === inv.hash) {
      existsInFilter = true;
      filter.splice(index, 1);
    }
  });
  return existsInFilter;
};

P2P.prototype._filterTx = function(peer, message) {
  var self = this;

  // if this tx matches any of this peer's filters, then emit the tx internally only
  // and not to the external bus
  var existsInFilter = self._processFilter(self._filters[peer], message);

  if (!existsInFilter) {
    self._broadcastTx(peer, message);
    return;
  }

  self.emit('tx', message.transaction);

};

P2P.prototype._broadcastTx = function(peer, message) {
  for (var i = 0; i < this.subscriptions.transaction.length; i++) {
    this.subscriptions.transaction[i].emit('p2p/transaction', message.transaction);
  }
};

P2P.prototype._broadcastBlock = function(peer, message) {
  for (var i = 0; i < this.subscriptions.block.length; i++) {
    this.subscriptions.block[i].emit('p2p/block', message.block);
  }
};

P2P.prototype.getAPIMethods = function() {
  var methods = [
    ['createHeaderStream', this, this.getHeaders, 2],
    ['getMempool', this, this.getMempool, 1],
    ['createBlockStream', this, this.getBlocks, 2]
  ];
  return methods;
};

P2P.prototype.getPublishEvents = function() {
  return [
    {
      name: 'p2p/transaction',
      scope: this,
      subscribe: this.subscribe.bind(this, 'transaction'),
      unsubscribe: this.unsubscribe.bind(this, 'transaction')
    },
    {
      name: 'p2p/block',
      scope: this,
      subscribe: this.subscribe.bind(this, 'block'),
      unsubscribe: this.unsubscribe.bind(this, 'block')
    }
  ];
};


P2P.prototype.createHeaderStream = function(startBlockHash, endBlockHash) {

  var self = this;
  if (!endBlockHash) {
    endBlockHash = startBlockHash;
  }

  var message = self.messages.GetHeaders(startBlockHash, endBlockHash);
  var peer = self._getPeer();

  peer.on('peerheaders', function(peer, message) {
    self.emit('headers', message.headers);
  });

  peer.sendMessage(message);
  return self;

};

P2P.prototype.getMempool = function(callback) {

  var self = this;
  var peer = self._getPeer();

  if (!peer) {
    return callback(new Error('Could not get a peer to retrieve mempool.'));
  }

  self._filters[peer] = [];

  peer.sendMessage(self.messages.MemPool());
  var mempool = [];

  self.on('tx', function(tx) {
    mempool.push(tx);
  });

  self.on('end', function() {
    callback(null, mempool);
  });
};

P2P.prototype.createBlockStream = function(startBlockHash, endBlockHash) {

  if (!endBlockHash) {
    endBlockHash = startBlockHash;
  }

  var message = this.messages.GetBlocks(startBlockHash, endBlockHash);
  var peer = this._getPeer();
  peer.sendMessage(message);

};

module.exports = P2P;