Currently peers are added to a pool when a peer will disconnect, however in the event that all peers are disconnected, an event would need to be emitted to attempt to connect to the list of known addrs. The situation that this might happen is during network interruption.

Peer.prototype._readMessage may be discarding messages from this.dataBuffer:
https://github.com/bitpay/bitcore-p2p/blob/master/lib/peer.js#L180o

Why can't I send messages?

peer.on('ready', function() {
  var message = new Messages({GetBlocks:'GetBlocks'});
  peer.sendMessage(message);
});

/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:194
this.socket.write(message.toBuffer());
^

TypeError: message.toBuffer is not a function
at Peer.sendMessage (/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:194:29)
at Peer. (/var/sentora/hostdata/zadmin/private_js/node.js:23:8)
at emitNone (events.js:67:13)
at Peer.emit (events.js:166:7)
at Peer. (/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:85:10)
at emitOne (events.js:77:13)
at Peer.emit (events.js:169:7)
at Peer._readMessage (/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:221:10)
at Peer._readMessage (/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:222:10)
at Socket. (/var/sentora/hostdata/zadmin/node_modules/bitcore-p2p/lib/peer.js:167:10)

When calling pool.connect() there should be an event other than 'peerready' that is emitted, when all connections are filled (as 'ready' can happen before the peer is added to the _connectedPeers object in tests).

var pool = Pool();
pool.on('connected', function() {
  // send message to peers
});
pool.connect();

Hello ,

When I tried to send message to a testnet node, an event “disconnect” will be always emitted. But when I tried with mainnet, this issues does not appear.
Is there any additional condition for testnet?

My snippet likes below.

    var bitcore = require(‘bitcore-lib’);
    var Peer = require(‘bitcore-p2p’).Peer;
    var Networks = bitcore.Networks;
    var p2p = require(‘bitcore-p2p’)
    var Messages = p2p.Messages;

    var peer = new Peer({host: ‘104.237.131.138’, port: 18333, network: Networks.testnet})

    peer.on(‘ready’, function() {
    // peer info
    console.log(peer.version, peer.subversion, peer.bestHeight);
    var messages = new Messages();
    var message = messages.Ping();
    // var message = messages.GetAddr()
    peer.sendMessage(message);
    });

    peer.on(‘connect’, function() {
    // peer info
    console.log(“Node is connecting”);
    });

    peer.on(‘connected’, function() {
    // peer info
    console.log(“Node is connected”);
    });

    peer.on(‘disconnect’, function() {
    console.log(‘connection closed’);
    });

    peer.on(‘addr’, function(message) {
    // message.addresses[]
    message.addresses.forEach(function(address) {
    // do something
    console.log('Address is ’ + JSON.stringify(address))
    });
    });

    peer.connect();

Hi,
I can't get transaction's information. In this code, the tx event is never emitted. Connected, ready and inv events are emitted but not tx.

var bitcore = require('bitcore-p2p');
var Peer = bitcore.Peer;

var peer = new Peer({host: '127.0.0.1', port: 8333});

peer.on('disconnect', function () {
  console.log('connection closed');
});

peer.on('connect', function () {
    console.log('connected');
});

peer.on('inv', function (msg) {
  console.log('inv');
});

peer.on('ready', function() {
  console.log('ready');
});

peer.on('tx', function(message) {
  // message.transaction 
  console.log(message);
});

peer.connect();

In this file:
https://github.com/bitpay/bitcore-p2p/blob/master/lib/peer.js#L218
I have edited the _readMessage function to debug it:

Peer.prototype._readMessage = function() {
  var message = this.messages.parseBuffer(this.dataBuffer);
  if(message == undefined) console.log(message);
  else console.log(message.command);
  if (message) {
    this.emit(message.command, message);
    this._readMessage();
  }
};

output:

inv
undefined
inv
undefined
inv
undefined

Hi,
I'm trying to run a simple script, like this:

var bitcore = require('bitcore-lib')
var p2p = require('bitcore-p2p')
var Peer = p2p.Peer;

var peer = new Peer({host: 'localhost', port: 3001})
peer.on('connect', function () { console.log('connect'); })
peer.on('ready', function(){  console.log('connected'); });
peer.on('disconnect', function() {  console.log('connection closed'); });
peer.connect()

However, the connection seems to be never established...
I only get the 'connect' and the 'connection closed' output.

What am I doing wrong?

I use this simple code:

var newPool = new Pool({
    network: "testnet",
    maxSize: 100
});

newPool.connect();

However, after a minute or two, I get the following exception and the script crashes:

      throw new Error('Data still available after parsing');
            ^
Error: Data still available after parsing
    at Object.checkFinished (D:\btc-relay\node_modules\bitcore-p2p\lib\messages\utils.js:20:13)
    at AddrMessage.setPayload (D:\btc-relay\node_modules\bitcore-p2p\lib\messages\commands\addr.js:48:9)
    at Function.exported.add.exported.commands.(anonymous function).fromBuffer (D:\btc-relay\node_modules\bitcore-p2p\lib\messages\builder.js:75:15)
    at Messages._buildFromBuffer (D:\btc-relay\node_modules\bitcore-p2p\lib\messages\index.js:103:41)
    at Messages.parseBuffer (D:\btc-relay\node_modules\bitcore-p2p\lib\messages\index.js:74:15)
    at Peer._readMessage (D:\btc-relay\node_modules\bitcore-p2p\lib\peer.js:219:31)
    at Socket.<anonymous> (D:\btc-relay\node_modules\bitcore-p2p\lib\peer.js:167:10)
    at Socket.emit (events.js:107:17)
    at readableAddChunk (_stream_readable.js:163:16)
    at Socket.Readable.push (_stream_readable.js:126:10)
Press any key to continue...

How to handle the error and carry on?

A block serialization bug was fixed in bitpay/bitcore#938 and the tests here need to be updated also, this is needed before upgrading to the latest version of bitcore.

Currently when an "addr" message is broadcast in the p2p network, a connected instance of Pool will add these to the end of the '_addrs' array, so that if another peer disconnect, the pool can attempt to connect to one of these addresses. However after running a p2p node for over ten days, it's possible that the number of "_addrs" will grow beyond 21,000 known peers. This is valuable information in being able to maintain connections, however currently it's all stored in memory. Having an option to save these between restarts would be useful, in addition, a way to rate the peers based on latency, geographic location, bitcoin version, and message reliability woulld be excellent. However in the short term, it's theoretical that this number could grow and consume lots of memory. So it could be useful to provide a configuration option to limit the length of the "_addrs" array in pool, and possibly provide some convience methods to save/read these from disk.

spawned from bitpay/bitcore#711

not sure if I agree, but I open this issue to discuss

Connect to the Bitcoin network via WebSocket proxies (would need to be implemented in parallel).

Timestamps are only available in versions >= 31402: https://en.bitcoin.it/wiki/Protocol_documentation#addr

I'm trying to find a P2P library that allows me to easily do peer discovery without having to worry about things like NAT traversal. I've recently started developing an interest for blockchain technology so I need this P2P network to test my own blockchain implementation on. I'm relatively new to networking so things like NAT traversal are mechanisms I'd prefer not to put a lot of effort into, so I was hoping bitcore-p2p could provide the functionality I need.

Basically I need functionality like this:

// Create a node on the users' local machine.
const socket = new Peer("127.0.0.1", 3000);

// Listen for events.

// emitted when peer connects to this node.
socket.on('peer_connected', (peer) => {
    // send data to this peer.
    peer.write('some data');
    
    //relay the peer_connected events to other peers.
    socket.peers.emit('peer_connected', peer);
});

// emitted when peer disconnects from this node.
socket.on('peer_disconnected', (peer) => {
    //relay the peer_disconnected events to other peers.
    socket.peers.emit('peer_disconnected', peer);
});

// emitted when data is received from another peer.
socket.on('data', (data, peer) => {

});

I was wondering if bitcore-p2p is solely usable for the bitcoin network or is it possible to create my own network as well?

There are cases in which only trusted peers may want to be connected to, it's currently possible to do this using Pool.prototype._addAddr, however it would be great to add Pool.prototype.addTrustedPeers([peer1, peer2, peer3]) that would either prioritize these peers, or only connect to them by not adding peers announced via "addr" messages via a configuration option: #26

https://github.com/wrkmnsr/wrkmnsr/actions/runs/6860287976

Moved to: bitpay/bitcore#1260

In situations it may be helpful to log activity of ongoing connections, adding configurable logging similar to: https://github.com/bitpay/bitcoind-rpc/blob/master/lib/index.js#L16 could be helpful.

Tor addresses (*.onion) can be mapped into IPv6 addresses (see bitcoin/bitcoin#1174 and https://github.com/bitcoin/bitcoin/blob/master/src/netbase.h#L60) in addr messages to advertise available peers in the network, these messages wouldn't currently be parsed correctly using: https://github.com/bitpay/bitcore-p2p/blob/master/lib/messages/utils.js#L71

[email protected] install /block/bitcore/node_modules/bitcore-p2p/node_modules/secp256k1
prebuild-install || node-gyp rebuild || echo "Secp256k1 bindings compilation fail. Pure JS implementation will be used."

prebuild-install info begin Prebuild-install version 2.3.0
prebuild-install info looking for local prebuild @ prebuilds/secp256k1-v3.2.5-node-v57-linux-x64.tar.gz
prebuild-install info looking for cached prebuild @ /home/rabit/.npm/_prebuilds/https-github.com-cryptocoinjs-secp256k1-node-releases-download-v3.2.5-secp256k1-v3.2.5-node-v57-linux-x64.tar.gz
prebuild-install http request GET https://github.com/cryptocoinjs/secp256k1-node/releases/download/v3.2.5/secp256k1-v3.2.5-node-v57-linux-x64.tar.gz
prebuild-install http 404 https://github.com/cryptocoinjs/secp256k1-node/releases/download/v3.2.5/secp256k1-v3.2.5-node-v57-linux-x64.tar.gz
prebuild-install WARN install No prebuilt binaries found (target=8.7.0 runtime=node arch=x64 platform=linux)

Inventory messages contain a property called .inventory which is an array of Invectory instances. This is a bit confusing and unusual as array properties are typically pluralised. One solutions would be to rename the .inventory property to .invs. Alternatively, Invectory could be renamed to InvVector to reflect the common usage (https://en.bitcoin.it/wiki/Protocol_documentation#Inventory_Vectors).

Add integrated support for TCP sockets available in FirefoxOS and ChromeOS:

• https://developer.mozilla.org/en-US/docs/Web/API/TCP_Socket_API
• https://developer.chrome.com/apps/sockets_tcp

Currently possible using "webpack" and "chrome-net" as demonstrated by @throughnothing: #21 (comment)

As part of handling different sockets in #36 (FirefoxOS and ChromeOS) it may be possible to additionally connect through a Foxtrot socket. The only issue is that addr messages only include v4 and v6 IP addresses and not a publickey as an address.

In Peer constructor port, network and relay is optional arguments. When port is Object and network isn't undefined arguments will be overloaded, but only port and network, not relay.

i.e. instead

// overloading stuff
if (port instanceof Object && !network) {
  network = port;
  port = undefined;
}

should be something like this

var test = Function.prototype.call.bind(Object.prototype.toString)

---
if (test(network) === '[object Boolean]' && !relay) {
  relay = network
  network = undefined
  if (test(port) === '[object Object]') {
    network = port
    port = undefined
  }
}
if (test(port) === '[object Object]' && !network && !relay) {
  network = port
  port = relay = undefined
}
if (test(port) === '[object Boolean]' && !network && !relay) {
  relay = network
  port = network = undefined
}

I'm right?
Of course it's not simple overloading, so it may be better to use opts as in Pool?

Also @param missing for relay.

(bitcore-p2p in new monorepo)

If connecting only to trusted peers in a pool, it should be possible to ignore "addr" messages. Currently the default is to add all annoucements to the list of known peers.

https://github.com/wrkmnsr/wrkmnsr/blob/main/.github/workflows/CryptoWalletSample-master.gitignore

bitcoin.conf configuration file.

Generated by contrib/devtools/gen-bitcoin-conf.sh.

Lines beginning with # are comments.

All possible configuration options are provided. To use, copy this file

to your data directory (default or specified by -datadir), uncomment

options you would like to change, and save the file.

Options

Execute command when an alert is raised (%s in cmd is replaced by

message)

#alertnotify=

If this block is in the chain assume that it and its ancestors are valid

and potentially skip their script verification (0 to verify all,

default:

000000000000000000035c3f0d31e71a5ee24c5aaf3354689f65bd7b07dee632,

testnet:

0000000000000021bc50a89cde4870d4a81ffe0153b3c8de77b435a2fd3f6761,

signet:

0000004429ef154f7e00b4f6b46bfbe2d2678ecd351d95bbfca437ab9a5b84ec)

#assumevalid=

Maintain an index of compact filters by block (default: 0, values:

basic). If is not supplied or if = 1, indexes for

all known types are enabled.

#blockfilterindex=

Execute command when the best block changes (%s in cmd is replaced by

block hash)

#blocknotify=

Extra transactions to keep in memory for compact block reconstructions

(default: 100)

#blockreconstructionextratxn=

Specify directory to hold blocks subdirectory for *.dat files (default:

)

#blocksdir=

Whether to reject transactions from network peers. Automatic broadcast

and rebroadcast of any transactions from inbound peers is

disabled, unless the peer has the 'forcerelay' permission. RPC

transactions are not affected. (default: 0)

#blocksonly=1

Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0)

#coinstatsindex=1

Specify path to read-only configuration file. Relative paths will be

prefixed by datadir location (only useable from command line, not

configuration file) (default: bitcoin.conf)

#conf=

Run in the background as a daemon and accept commands (default: 0)

#daemon=1

Wait for initialization to be finished before exiting. This implies

-daemon (default: 0)

#daemonwait=1

Specify data directory

#datadir=

Maximum database cache size MiB (4 to 16384, default: 450). In

addition, unused mempool memory is shared for this cache (see

-maxmempool).

#dbcache=

Specify location of debug log file (default: debug.log). Relative paths

will be prefixed by a net-specific datadir location. Pass

-nodebuglogfile to disable writing the log to a file.

#debuglogfile=

Specify additional configuration file, relative to the -datadir path

(only useable from configuration file, not command line)

#includeconf=

Imports blocks from external file on startup

#loadblock=

Keep the transaction memory pool below megabytes (default: 300)

#maxmempool=

Keep at most unconnectable transactions in memory (default: 100)

#maxorphantx=

Do not keep transactions in the mempool longer than hours (default:

336)

#mempoolexpiry=

Set the number of script verification threads (-10 to 15, 0 = auto, <0 =

leave that many cores free, default: 0)

#par=

Whether to save the mempool on shutdown and load on restart (default: 1)

#persistmempool=1

Specify pid file. Relative paths will be prefixed by a net-specific

datadir location. (default: bitcoind.pid)

#pid=

Reduce storage requirements by enabling pruning (deleting) of old

blocks. This allows the pruneblockchain RPC to be called to

delete specific blocks and enables automatic pruning of old

blocks if a target size in MiB is provided. This mode is

incompatible with -txindex. Warning: Reverting this setting

requires re-downloading the entire blockchain. (default: 0 =

disable pruning blocks, 1 = allow manual pruning via RPC, >=550 =

automatically prune block files to stay under the specified

target size in MiB)

#prune=

Rebuild chain state and block index from the blk*.dat files on disk.

This will also rebuild active optional indexes.

#reindex=1

Rebuild chain state from the currently indexed blocks. When in pruning

mode or if blocks on disk might be corrupted, use full -reindex

instead. Deactivate all optional indexes before running this.

#reindex-chainstate=1

Use the experimental syscall sandbox in the specified mode

(-sandbox=log-and-abort or -sandbox=abort). Allow only expected

syscalls to be used by bitcoind. Note that this is an

experimental new feature that may cause bitcoind to exit or crash

unexpectedly: use with caution. In the "log-and-abort" mode the

invocation of an unexpected syscall results in a debug handler

being invoked which will log the incident and terminate the

program (without executing the unexpected syscall). In the

"abort" mode the invocation of an unexpected syscall results in

the entire process being killed immediately by the kernel without

executing the unexpected syscall.

#sandbox=

Specify path to dynamic settings data file. Can be disabled with

-nosettings. File is written at runtime and not meant to be

edited by users (use bitcoin.conf instead for custom settings).

Relative paths will be prefixed by datadir location. (default:

settings.json)

#settings=

Execute command immediately before beginning shutdown. The need for

shutdown may be urgent, so be careful not to delay it long (if

the command doesn't require interaction with the server, consider

having it fork into the background).

#shutdownnotify=

Execute command on startup.

#startupnotify=

Maintain a full transaction index, used by the getrawtransaction rpc

call (default: 0)

#txindex=1

Print version and exit

#version=1

Connection options

Add a node to connect to and attempt to keep the connection open (see

the addnode RPC help for more info). This option can be specified

multiple times to add multiple nodes; connections are limited to

8 at a time and are counted separately from the -maxconnections

limit.

#addnode=

Specify asn mapping used for bucketing of the peers (default:

ip_asn.map). Relative paths will be prefixed by the net-specific

datadir location.

#asmap=

Default duration (in seconds) of manually configured bans (default:

86400)

#bantime=

Bind to given address and always listen on it (default: 0.0.0.0). Use

[host]:port notation for IPv6. Append =onion to tag any incoming

connections to that address and port as incoming Tor connections

(default: 127.0.0.1:8334=onion, testnet: 127.0.0.1:18334=onion,

signet: 127.0.0.1:38334=onion, regtest: 127.0.0.1:18445=onion)

#bind=[:][=onion]

If set, then this host is configured for CJDNS (connecting to fc00::/8

addresses would lead us to the CJDNS network, see doc/cjdns.md)

(default: 0)

#cjdnsreachable=1

Connect only to the specified node; -noconnect disables automatic

connections (the rules for this peer are the same as for

-addnode). This option can be specified multiple times to connect

to multiple nodes.

#connect=

Discover own IP addresses (default: 1 when listening and no -externalip

or -proxy)

#discover=1

Allow DNS lookups for -addnode, -seednode and -connect (default: 1)

#dns=1

Query for peer addresses via DNS lookup, if low on addresses (default: 1

unless -connect used or -maxconnections=0)

#dnsseed=1

Specify your own public address

#externalip=

Allow fixed seeds if DNS seeds don't provide peers (default: 1)

#fixedseeds=1

Always query for peer addresses via DNS lookup (default: 0)

#forcednsseed=1

Whether to accept inbound I2P connections (default: 1). Ignored if

-i2psam is not set. Listening for inbound I2P connections is done

through the SAM proxy, not by binding to a local address and

port.

#i2pacceptincoming=1

I2P SAM proxy to reach I2P peers and accept I2P connections (default:

none)

#i2psam=ip:port

Accept connections from outside (default: 1 if no -proxy, -connect or

-maxconnections=0)

#listen=1

Automatically create Tor onion service (default: 1)

#listenonion=1

Maintain at most connections to peers (default: 125). This limit

does not apply to connections manually added via -addnode or the

addnode RPC, which have a separate limit of 8.

#maxconnections=

Maximum per-connection receive buffer, *1000 bytes (default: 5000)

#maxreceivebuffer=

Maximum per-connection send buffer, *1000 bytes (default: 1000)

#maxsendbuffer=

Maximum allowed median peer time offset adjustment. Local perspective of

time may be influenced by outbound peers forward or backward by

this amount (default: 4200 seconds).

#maxtimeadjustment=1

Tries to keep outbound traffic under the given target per 24h. Limit

does not apply to peers with 'download' permission or blocks

created within past week. 0 = no limit (default: 0M). Optional

suffix units [k|K|m|M|g|G|t|T] (default: M). Lowercase is 1000

base while uppercase is 1024 base

#maxuploadtarget=

Use NAT-PMP to map the listening port (default: 0)

#natpmp=1

Enable all P2P network activity (default: 1). Can be changed by the

setnetworkactive RPC command

#networkactive=1

Use separate SOCKS5 proxy to reach peers via Tor onion services, set

-noonion to disable (default: -proxy)

#onion=ip:port

Make automatic outbound connections only to network (ipv4, ipv6,

onion, i2p, cjdns). Inbound and manual connections are not

affected by this option. It can be specified multiple times to

allow multiple networks.

#onlynet=

Serve compact block filters to peers per BIP 157 (default: 0)

#peerblockfilters=1

Support filtering of blocks and transaction with bloom filters (default:

0)

#peerbloomfilters=1

Listen for connections on . Nodes not using the default ports

(default: 8333, testnet: 18333, signet: 38333, regtest: 18444)

are unlikely to get incoming connections. Not relevant for I2P

(see doc/i2p.md).

#port=

Connect through SOCKS5 proxy, set -noproxy to disable (default:

disabled)

#proxy=ip:port

Randomize credentials for every proxy connection. This enables Tor

stream isolation (default: 1)

#proxyrandomize=1

Connect to a node to retrieve peer addresses, and disconnect. This

option can be specified multiple times to connect to multiple

nodes.

#seednode=

Specify socket connection timeout in milliseconds. If an initial attempt

to connect is unsuccessful after this amount of time, drop it

(minimum: 1, default: 5000)

#timeout=

Tor control port to use if onion listening enabled (default:

127.0.0.1:9051)

#torcontrol=:

Tor control port password (default: empty)

#torpassword=

Use UPnP to map the listening port (default: 1 when listening and no

-proxy)

#upnp=1

Bind to the given address and add permission flags to the peers

connecting to it. Use [host]:port notation for IPv6. Allowed

permissions: bloomfilter (allow requesting BIP37 filtered blocks

and transactions), noban (do not ban for misbehavior; implies

download), forcerelay (relay transactions that are already in the

mempool; implies relay), relay (relay even in -blocksonly mode,

and unlimited transaction announcements), mempool (allow

requesting BIP35 mempool contents), download (allow getheaders

during IBD, no disconnect after maxuploadtarget limit), addr

(responses to GETADDR avoid hitting the cache and contain random

records with the most up-to-date info). Specify multiple

permissions separated by commas (default:

download,noban,mempool,relay). Can be specified multiple times.

#whitebind=<[permissions@]addr>

Add permission flags to the peers connecting from the given IP address

(e.g. 1.2.3.4) or CIDR-notated network (e.g. 1.2.3.0/24). Uses

the same permissions as -whitebind. Can be specified multiple

times.

#whitelist=<[permissions@]IP address or network>

Wallet options

What type of addresses to use ("legacy", "p2sh-segwit", "bech32", or

"bech32m", default: "bech32")

#addresstype=1

Group outputs by address, selecting many (possibly all) or none, instead

of selecting on a per-output basis. Privacy is improved as

addresses are mostly swept with fewer transactions and outputs

are aggregated in clean change addresses. It may result in higher

fees due to less optimal coin selection caused by this added

limitation and possibly a larger-than-necessary number of inputs

being used. Always enabled for wallets with "avoid_reuse"

enabled, otherwise default: 0.

#avoidpartialspends=1

What type of change to use ("legacy", "p2sh-segwit", "bech32", or

"bech32m"). Default is "legacy" when -addresstype=legacy, else it

is an implementation detail.

#changetype=1

The maximum feerate (in BTC/kvB) at which transaction building may use

more inputs than strictly necessary so that the wallet's UTXO

pool can be reduced (default: 0.0001).

#consolidatefeerate=

Do not load the wallet and disable wallet RPC calls

#disablewallet=1

The fee rate (in BTC/kvB) that indicates your tolerance for discarding

change by adding it to the fee (default: 0.0001). Note: An output

is discarded if it is dust at this rate, but we will always

discard up to the dust relay fee and a discard fee above that is

limited by the fee estimate for the longest target

#discardfee=

A fee rate (in BTC/kvB) that will be used when fee estimation has

insufficient data. 0 to entirely disable the fallbackfee feature.

(default: 0.00)

#fallbackfee=

Set key pool size to (default: 1000). Warning: Smaller sizes may

increase the risk of losing funds when restoring from an old

backup, if none of the addresses in the original keypool have

been used.

#keypool=

Spend up to this amount in additional (absolute) fees (in BTC) if it

allows the use of partial spend avoidance (default: 0.00)

#maxapsfee=

Fee rates (in BTC/kvB) smaller than this are considered zero fee for

transaction creation (default: 0.00001)

#mintxfee=

Fee rate (in BTC/kvB) to add to transactions you send (default: 0.00)

#paytxfee=

External signing tool, see doc/external-signer.md

#signer=

Spend unconfirmed change when sending transactions (default: 1)

#spendzeroconfchange=1

If paytxfee is not set, include enough fee so transactions begin

confirmation on average within n blocks (default: 6)

#txconfirmtarget=

Specify wallet path to load at startup. Can be used multiple times to

load multiple wallets. Path is to a directory containing wallet

data and log files. If the path is not absolute, it is

interpreted relative to . This only loads existing

wallets and does not create new ones. For backwards compatibility

this also accepts names of existing top-level data files in

.

#wallet=

Make the wallet broadcast transactions (default: 1)

#walletbroadcast=1

Specify directory to hold wallets (default: /wallets if it

exists, otherwise )

#walletdir=

Execute command when a wallet transaction changes. %s in cmd is replaced

by TxID, %w is replaced by wallet name, %b is replaced by the

hash of the block including the transaction (set to 'unconfirmed'

if the transaction is not included) and %h is replaced by the

block height (-1 if not included). %w is not currently

implemented on windows. On systems where %w is supported, it

should NOT be quoted because this would break shell escaping used

to invoke the command.

#walletnotify=

Send transactions with full-RBF opt-in enabled (RPC only, default: 1)

#walletrbf=1

ZeroMQ notification options

Enable publish hash block in

#zmqpubhashblock=

Set publish hash block outbound message high water mark (default: 1000)

#zmqpubhashblockhwm=

Enable publish hash transaction in

#zmqpubhashtx=

Set publish hash transaction outbound message high water mark (default:

1000)

#zmqpubhashtxhwm=

Enable publish raw block in

#zmqpubrawblock=

Set publish raw block outbound message high water mark (default: 1000)

#zmqpubrawblockhwm=

Enable publish raw transaction in

#zmqpubrawtx=

Set publish raw transaction outbound message high water mark (default:

1000)

#zmqpubrawtxhwm=

Enable publish hash block and tx sequence in

#zmqpubsequence=

Set publish hash sequence message high water mark (default: 1000)

#zmqpubsequencehwm=

Debugging/Testing options

Output debug and trace logging (default: -nodebug, supplying

is optional). If is not supplied or if = 1,

output all debug and trace logging. can be: addrman,

bench, blockstorage, cmpctblock, coindb, estimatefee, http, i2p,

ipc, leveldb, libevent, mempool, mempoolrej, net, proxy, prune,

qt, rand, reindex, rpc, scan, selectcoins, tor, txreconciliation,

util, validation, walletdb, zmq. This option can be specified

multiple times to output multiple categories.

#debug=

Exclude debug and trace logging for a category. Can be used in

conjunction with -debug=1 to output debug and trace logging for

all categories except the specified category. This option can be

specified multiple times to exclude multiple categories.

#debugexclude=

Print help message with debugging options and exit

#help-debug=1

Include IP addresses in debug output (default: 0)

#logips=1

Prepend debug output with name of the originating source location

(source file, line number and function name) (default: 0)

#logsourcelocations=1

Prepend debug output with name of the originating thread (only available

on platforms supporting thread_local) (default: 0)

#logthreadnames=1

Prepend debug output with timestamp (default: 1)

#logtimestamps=1

Maximum total fees (in BTC) to use in a single wallet transaction;

setting this too low may abort large transactions (default: 0.10)

#maxtxfee=

Send trace/debug info to console (default: 1 when no -daemon. To disable

logging to file, set -nodebuglogfile)

#printtoconsole=1

Shrink debug.log file on client startup (default: 1 when no -debug)

#shrinkdebugfile=1

Append comment to the user agent string

#uacomment=

Chain selection options

Use the chain (default: main). Allowed values: main, test,

signet, regtest

#chain=

Use the signet chain. Equivalent to -chain=signet. Note that the network

is defined by the -signetchallenge parameter

#signet=1

Blocks must satisfy the given script to be considered valid (only for

signet networks; defaults to the global default signet test

network challenge)

#signetchallenge=1

Specify a seed node for the signet network, in the hostname[:port]

format, e.g. sig.net:1234 (may be used multiple times to specify

multiple seed nodes; defaults to the global default signet test

network seed node(s))

#signetseednode=1

Use the test chain. Equivalent to -chain=test.

#testnet=1

Node relay options

Equivalent bytes per sigop in transactions for relay and mining

(default: 20)

#bytespersigop=1

Relay and mine data carrier transactions (default: 1)

#datacarrier=1

Maximum size of data in data carrier transactions we relay and mine

(default: 83)

#datacarriersize=1

Accept transaction replace-by-fee without requiring replaceability

signaling (default: 0)

#mempoolfullrbf=1

Fees (in BTC/kvB) smaller than this are considered zero fee for

relaying, mining and transaction creation (default: 0.00001)

#minrelaytxfee=

Relay non-P2SH multisig (default: 1)

#permitbaremultisig=1

Add 'forcerelay' permission to whitelisted inbound peers with default

permissions. This will relay transactions even if the

transactions were already in the mempool. (default: 0)

#whitelistforcerelay=1

Add 'relay' permission to whitelisted inbound peers with default

permissions. This will accept relayed transactions even when not

relaying transactions (default: 1)

#whitelistrelay=1

Block creation options

Set maximum BIP141 block weight (default: 3996000)

#blockmaxweight=

Set lowest fee rate (in BTC/kvB) for transactions to be included in

block creation. (default: 0.00001)

#blockmintxfee=

RPC server options

Accept public REST requests (default: 0)

#rest=1

Allow JSON-RPC connections from specified source. Valid for are a

single IP (e.g. 1.2.3.4), a network/netmask (e.g.

1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24). This

option can be specified multiple times

#rpcallowip=

Username and HMAC-SHA-256 hashed password for JSON-RPC connections. The

field comes in the format: :$. A

canonical python script is included in share/rpcauth. The client

then connects normally using the

rpcuser=/rpcpassword= pair of arguments. This

option can be specified multiple times

#rpcauth=

Bind to given address to listen for JSON-RPC connections. Do not expose

the RPC server to untrusted networks such as the public internet!

This option is ignored unless -rpcallowip is also passed. Port is

optional and overrides -rpcport. Use [host]:port notation for

IPv6. This option can be specified multiple times (default:

127.0.0.1 and ::1 i.e., localhost)

#rpcbind=[:port]

Location of the auth cookie. Relative paths will be prefixed by a

net-specific datadir location. (default: data dir)

#rpccookiefile=

Password for JSON-RPC connections

#rpcpassword=

Listen for JSON-RPC connections on (default: 8332, testnet:

18332, signet: 38332, regtest: 18443)

#rpcport=

Sets the serialization of raw transaction or block hex returned in

non-verbose mode, non-segwit(0) or segwit(1) (default: 1)

#rpcserialversion=1

Set the number of threads to service RPC calls (default: 4)

#rpcthreads=

Username for JSON-RPC connections

#rpcuser=

Set a whitelist to filter incoming RPC calls for a specific user. The

field comes in the format: :<rpc 1>,<rpc

2>,...,. If multiple whitelists are set for a given user,

they are set-intersected. See -rpcwhitelistdefault documentation

for information on default whitelist behavior.

#rpcwhitelist=

Sets default behavior for rpc whitelisting. Unless rpcwhitelistdefault

is set to 0, if any -rpcwhitelist is set, the rpc server acts as

if all rpc users are subject to empty-unless-otherwise-specified

whitelists. If rpcwhitelistdefault is set to 1 and no

-rpcwhitelist is set, rpc server acts as if all rpc users are

subject to empty whitelists.

#rpcwhitelistdefault=1

Accept command line and JSON-RPC commands

#server=1

[Sections]

Most options will apply to all networks. To confine an option to a specific

network, add it under the relevant section below.

Note: If not specified under a network section, the options addnode, connect,

port, bind, rpcport, rpcbind, and wallet will only apply to mainnet.

Options for mainnet

[main]

Options for testnet

[test]

Options for signet

[signet]

Options for regtest

[regtest]

So I've found out there is partial support for socks proxy, to be more specific, there is a setProxy method for Peer but not for Pool.

On a different note, it seems a priori Socks5Client isn't working well with tor, could this be?

I have a set of patches to solve this issue but I'd like to know what are the plans for implementing good socks proxy support.

Original discussion here: bitpay/bitcore#115

• filterload,
• filteradd,
• filterclear,
• merkleblock

Hi,
we're using your bitcore-p2p module, to get INV messages.

Our p2p pool is getting INV messages fine, but after some time stops getting them without any error.
We have tried to save connection of our pool and bitcoin network using ping and pong messages, but it haven't take any effect.

Code example:

var pool = new Pool({
    network: Networks.livenet,
    maxSize: 150,
    dnsSeed: false,
    addrs: hosts
});


pool.connect();

pool.on('peerinv', function (peer, message) {

                   var Invs = message.inventory;
                    async.eachLimit(Invs, 20, function (inv, cb) {
                        var invHash = lib.util.buffer.bufferToHex(lib.util.buffer.reverse(inv.hash));
                        //console.log(invHash);
                        cb();
                    }, function (err) {
                        assert.equal(null, err); 
                    })

                    peer.sendMessage(messages.Ping());
                    peer.on('ping', function (message) {
                        console.log(message.nonce);
                        peer._sendPong(message.nonce);
                    });

                    peer.on('ready', function() {
                        console.log("ready",pool.inspect());
                        peer.sendMessage(messages.GetAddresses());
                    });

                    peer.on('addr', function(message) {
                        message.addresses.forEach(function(addr) {
                            console.log(addr);
                            pool._connectPeer(addr);
                            console.log(pool.inspect());
                        });
                    });
})

Check connection status before write? https://github.com/bitpay/bitcore-p2p/blob/master/lib/peer.js#L194

var bitcore = require('bitcore')
var Peer = require('bitcore-p2p').Peer
var peer = new Peer({host: 'localhost', port: 18333, network: bitcore.Networks.testnet})
peer.on('connect', function () { peer.disconnect() })
peer.connect()

Result:

events.js:72
        throw er; // Unhandled 'error' event
              ^
Error: This socket is closed.
    at Socket._write (net.js:638:19)
    at doWrite (_stream_writable.js:226:10)
    at writeOrBuffer (_stream_writable.js:216:5)
    at Socket.Writable.write (_stream_writable.js:183:11)
    at Socket.write (net.js:616:40)
    at Peer.sendMessage (/home/kirill/.../node_modules/bitcore-p2p/lib/peer.js:194:15)
    at Peer._sendVersion (/home/kirill/.../node_modules/bitcore-p2p/lib/peer.js:204:8)
    at Socket.<anonymous> (/home/kirill/.../node_modules/bitcore-p2p/lib/peer.js:146:10)
    at Socket.emit (events.js:117:20)
    at Object.afterConnect [as oncomplete] (net.js:887:10)

When parsing the buffer, the message itself may be malformed and unable to parse correctly, which will typically throw an error (as so it's clear why it's failing).

A try/catch around https://github.com/bitpay/bitcore-p2p/blob/master/lib/messages/index.js#L103 and sending back a reject message (https://en.bitcoin.it/wiki/Protocol_documentation#reject) to the peer with REJECT_MALFORMED, could be the best way to handle this case.

Related: #85

HI does any one know how to get Bitcore p2p to work with Bitcoin Cash

Example usage:

var p2p = require('bitcore-p2p');
var Message = p2p.Message;
function CustomMessage(arg, options) {
  Message.call(this, options);
  ...
}
inherits(CustomMessage, Message);

var messages = new Messages();
messages.extend('command', 'MessageName', CustomMessage);

With the filter messages now included, we need docs on how to create a bloom filter, and send a filterload message and receive messages (such as an initial relay boolean).

The Pool.PeerEvents should get list of events from registered message commands, now that new commands can be added using messages.add().

Hello,

I got error "connect ETIMEDOUT 5.9.85.34:8333" during running the following snippet with NodeJS

var Peer = require('bitcore-p2p').Peer;

var peer = new Peer({host: '5.9.85.34'});

peer.on('ready', function() {
  // peer info
  console.log(peer.version, peer.subversion, peer.bestHeight);
});

peer.on('disconnect', function() {
  console.log('connection closed');
});

peer.connect();

My steps:

1. Copy the above snippet to MyTest.js
2. Run node myTest.js
3. Console prompt return "connect ETIMEDOUT 5.9.85.34:8333"

Could you please show me how make my snippet working? I don't run any Bitcoin full node on my local PC.

Thank you.