Interface to the bitcoin P2P network for bitcore
Go to file
2015-03-17 15:11:16 -04:00
docs improved peer jsdoc, fixed docs for messages, and switched to use svg for readme icon 2015-03-16 15:44:50 -04:00
integration updated bitconid integration test to use exposed message constructors 2015-03-13 12:06:07 -04:00
lib added unit tests for buffers.skip 2015-03-17 15:11:16 -04:00
test added unit tests for buffers.skip 2015-03-17 15:11:16 -04:00
.coveralls.yml Add coveralls.io support 2015-01-15 18:30:06 -05:00
.gitignore Drop unused gitignores 2015-01-20 11:19:59 -03:00
.jsdoc.conf Initial commit for bitcore-p2p 2015-01-15 18:30:06 -05:00
.jshintrc Initial commit for bitcore-p2p 2015-01-15 18:30:06 -05:00
.travis.yml Fix travis 2015-01-15 18:30:06 -05:00
CONTRIBUTING.md Initial commit for bitcore-p2p 2015-01-15 18:30:06 -05:00
gulpfile.js Update devDependencies to fix the build. 2015-01-19 11:26:49 -05:00
index.js Change from bitcore-base to bitcore 2015-01-15 18:31:42 -05:00
karma.conf.js Move to gulp-bitcore 2015-01-15 18:30:06 -05:00
LICENSE Initial commit for bitcore-p2p 2015-01-15 18:30:06 -05:00
package.json upgrade bloom-filter to 0.2.0 2015-03-16 17:38:58 -04:00
README.md improved peer jsdoc, fixed docs for messages, and switched to use svg for readme icon 2015-03-16 15:44:50 -04:00

bitcore payment protocol Bitcore P2P =======

NPM Package Build Status Coverage Status

bitcore-p2p adds Bitcoin protocol support for Bitcore.

See the main bitcore repo for more information.

Getting Started

npm install bitcore-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('bitcore-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.