Interface to the bitcoin P2P network for bitcore

Go to file

Manuel Araoz af6c2e8779 docs improved		2015-01-22 16:06:04 -03:00
docs	docs improved	2015-01-22 16:06:04 -03:00
lib	Add @desc tag to avoid warning	2015-01-20 13:01:29 -03:00
test	Fixed issue with block message test	2015-01-21 10:42:32 -05: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
bower.json	Add bower.json	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	Bump package version to 0.9.1	2015-01-22 16:02:22 -03:00
README.md	docs improved	2015-01-22 16:06:04 -03:00

README.md

P2P Networking capabilities for bitcore

bitcore-p2p adds support for connecting to the bitcoin p2p network on node.

See the main bitcore repo for more information.

Getting Started

npm install bitcore-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. You can do that by using the known DNS servers. Then, you can connect to it:

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

var peer = new Peer('0.0.0.0');

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.