@owstack/btc-p2p

Btc P2P

Adds Bitcoin protocol support for Btc-node.

See the main btc repo for more information.

Getting Started

npm install btc-p2p

In order to connect to the Bitcoin 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('@owstack/btc-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 btc guide on the usage of the Peer class.

Contributing

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

License

Code released under the MIT license.

Copyright 2017 Open Wallet Stack.