5.0.0-beta.1 • Published 6 years ago

btxcore-p2p v5.0.0-beta.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

BTXCore P2P

NPM Package Build Status Coverage Status

btxcore-p2p adds Bitcoin protocol support for Btxcore.

See the main bitcore repo for more information.

Getting Started

npm install btxcore-p2p

In order to connect to the Bitcore network, you'll need to know the IP address of at least one node of the network, or use Pool to discover peers using a DNS seed.

var Peer = require('btxcore-p2p').Peer;

var peer = new Peer({host: '127.0.0.1'});

peer.on('ready', function() {
  // peer info
  console.log(peer.version, peer.subversion, peer.bestHeight);
});
peer.on('disconnect', function() {
  console.log('connection closed');
});
peer.connect();

Then, you can get information from other peers by using:

// handle events
peer.on('inv', function(message) {
  // message.inventory[]
});
peer.on('tx', function(message) {
  // message.transaction
});

Take a look at the bitcore guide on the usage of the Peer class.

Contributing

See CONTRIBUTING.md on the main bitcore repo for information about how to contribute.

License

Code released under the MIT license.

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. Copyright (c) 2018 The Bitcore BTX Core Developers