@axerunners/axecore-p2p/README.md

Interface to the axe P2P network for Axecore

AXEcore P2P
=======

[![NPM Package](https://img.shields.io/npm/v/@axerunners/axecore-p2p.svg?style=flat-square)](https://www.npmjs.org/package/@axerunners/axecore-p2p)
[![Build Status](https://img.shields.io/travis/com/AXErunners/axecore-p2p.svg?branch=master&style=flat-square)](https://travis-ci.com/AXErunners/axecore-p2p)

`axecore-p2p` adds Axe protocol support for Axecore.

See [the main axecore-lib repo](https://github.com/axerunners/axecore-lib) for more information.

## Getting Started

```sh
npm install @axerunners/axecore-p2p
```
In order to connect to the Axe 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('@axerunners/axecore-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

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/axerunners/axecore-p2p/blob/master/CONTRIBUTING.md) file.

## License

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

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