https://github.com/bitpay/bitcore-p2p

Interface to the bitcoin P2P network for bitcore
https://github.com/bitpay/bitcore-p2p

Last synced: about 2 months ago
JSON representation

Interface to the bitcoin P2P network for bitcore

• Host: GitHub
• URL: https://github.com/bitpay/bitcore-p2p
• Owner: bitpay
• License: mit
• Created: 2014-12-29T15:58:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-08T08:16:37.000Z (over 1 year ago)
• Last Synced: 2024-07-26T04:07:12.981Z (about 2 months ago)
• Language: JavaScript
• Size: 1.24 MB
• Stars: 79
• Watchers: 19
• Forks: 276
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cryptocoinjs - bitcoin - lib (List of content / P2P)

README

        


Bitcore P2P

=======

[![NPM Package](https://img.shields.io/npm/v/bitcore-p2p.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-p2p)

[![Build Status](https://img.shields.io/travis/bitpay/bitcore-p2p.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-p2p)

[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-p2p.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-p2p?branch=master)

`bitcore-p2p` adds [Bitcoin protocol](https://en.bitcoin.it/wiki/Protocol_documentation) support for Bitcore.

See [the main bitcore repo](https://github.com/bitpay/bitcore) for more information.

## Getting Started

```sh

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](/docs/pool.md) to discover peers using a DNS seed.

```javascript

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:

```javascript

// handle events

peer.on('inv', function(message) {

  // message.inventory[]

});

peer.on('tx', function(message) {

  // message.transaction

});

```

Take a look at the [bitcore guide](http://bitcore.io/guide/peer.html) on the usage of the `Peer` class.

## Contributing

See [CONTRIBUTING.md](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) on the main bitcore repo for information about how to contribute.

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.