Skip to content

⛓ Interface to the Umbru P2P network for Umbrucore

License

Notifications You must be signed in to change notification settings

umbru/umbrucore-p2p

Repository files navigation

Umbrucore P2P

NPM Package Build Status

umbrucore-p2p adds Umbru protocol support for Umbrucore.

See the main umbrucore-lib repo for more information.

Getting Started

npm install umbrucore-p2p

In order to connect to the Umbru 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('umbrucore-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

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 file.

License

Code released under the MIT license.

Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
Copyright 2016-2017 The Umbru Foundation, Inc.
Copyright 2017-2018 Umbru Core Group, Inc.

About

⛓ Interface to the Umbru P2P network for Umbrucore

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published