RanchiMall/flocore-p2p
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated namespaces for module documentation.

Browse Source
This commit is contained in:
Braydon Fuller 2015-01-20 16:04:34 -05:00
parent 769e482744
commit 8c8d0e1979
2 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/peer.md
View File

@ -12,8 +12,7 @@ Represents a node from the p2p bitcoin network. The Peer class supports connecti
The code to create a new peer looks like this: The code to create a new peer looks like this:
```javascript ```javascript
var bitcore = require('bitcore'); var Peer = require('bitcore-p2p').Peer;
var Peer = bitcore.transport.Peer;
// default port // default port
var livenetPeer = new Peer('5.9.85.34'); var livenetPeer = new Peer('5.9.85.34');
@ -39,8 +38,7 @@ A peer instance is always in one of the following states:
You can subscribe to the change of those states as follows: You can subscribe to the change of those states as follows:
```javascript ```javascript
var bitcore = require('bitcore'); var Peer = require('bitcore-p2p').Peer;
var Peer = bitcore.transport.Peer;
var peer = new Peer('5.9.85.34'); var peer = new Peer('5.9.85.34');
@ -61,8 +59,8 @@ peer.connect();
Once connected, a peer instance can send and receive messages. Every time a message arrives it's emitted as a new event. Let's see an example of this: Once connected, a peer instance can send and receive messages. Every time a message arrives it's emitted as a new event. Let's see an example of this:
```javascript ```javascript
var bitcore = require('bitcore'); var Peer = require('bitcore-p2p').Peer;
var peer = new bitcore.transport.Peer('5.9.85.34'); var peer = new Peer('5.9.85.34');
// handle events // handle events
peer.on('inv', function(message) { peer.on('inv', function(message) {
@ -82,16 +80,18 @@ peer.connect();
## Sending messages ## Sending messages
In order to send messages the Peer class offers the `sendMessage(message)` method, which receives an instance of a message. All supported messages can be found on the `bitcore.transport.Messages` module. For more information about messages refer to the [protocol specification](https://en.bitcoin.it/wiki/Protocol_specification). In order to send messages the Peer class offers the `sendMessage(message)` method, which receives an instance of a message. All supported messages can be found in the `Messages` module. For more information about messages refer to the [protocol specification](https://en.bitcoin.it/wiki/Protocol_specification).
An example for requesting other connected nodes to a peers looks like this: An example for requesting other connected nodes to a peers looks like this:
```javascript ```javascript
var bitcore = require('bitcore'); var p2p = require('bitcore-p2p')
var peer = new bitcore.transport.Peer('5.9.85.34'); var Peer = p2p.Peer;
var Messages = p2p.Messages;
var peer = new Peer('5.9.85.34');
peer.on('ready', function() { peer.on('ready', function() {
var message = new bitcore.transport.Messages.GetAddresses(); var message = new Messages.GetAddresses();
peer.sendMessage(message); peer.sendMessage(message);
}); });

5
docs/pool.md
View File

@ -9,9 +9,8 @@ The quickest way to get connected is to run the following:
```javascript ```javascript
var bitcore = require('bitcore'); var Pool = require('bitcore-p2p').Pool;
var Pool = bitcore.transport.Pool; var Networks = require('bitcore').Networks;
var Networks = bitcore.Networks;
var pool = new Pool(Networks.livenet); var pool = new Pool(Networks.livenet);