Skip to content

Files

Latest commit

b3564df · Feb 23, 2023

History

History
This branch is 6 commits ahead of, 1130 commits behind bitpay/bitcore:master.

bitcore-p2p

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 30, 2023
Jan 30, 2023
Jan 30, 2023
Jan 30, 2023
Apr 5, 2018
Apr 5, 2018
Mar 27, 2019
Apr 5, 2018
Apr 5, 2018
Mar 27, 2019
Apr 5, 2018
Apr 5, 2018
Mar 27, 2019
Dec 31, 2018
Apr 5, 2018
Apr 5, 2018
Feb 23, 2023
Feb 23, 2023

Bitcore P2P

NPM Package Build Status Coverage Status

The peer-to-peer networking protocol for BTC.

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 this 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-2019 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.