BTCPrivate
/
BitcoinPrivate-legacy
mirror of https://github.com/BTCPrivate/BitcoinPrivate-legacy.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Bitcoin -> Zcash in ZMQ docs

This commit is contained in:
Jack Grigg 2017-01-31 14:48:34 +01:00
parent 5dfea488e4
commit 4fbc46c2ff
No known key found for this signature in database
GPG Key ID: 6A6914DAFBEA00DA
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/zmq.md
View File

@ -5,8 +5,8 @@ connections, inter-process communication, and shared-memory,
providing various message-oriented semantics such as publish/subcribe, providing various message-oriented semantics such as publish/subcribe,
request/reply, and push/pull. request/reply, and push/pull.
The Bitcoin Core daemon can be configured to act as a trusted "border The Zcash daemon can be configured to act as a trusted "border
router", implementing the bitcoin wire protocol and relay, making router", implementing the zcash wire protocol and relay, making
consensus decisions, maintaining the local blockchain database, consensus decisions, maintaining the local blockchain database,
broadcasting locally generated transactions into the network, and broadcasting locally generated transactions into the network, and
providing a queryable RPC interface to interact on a polled basis for providing a queryable RPC interface to interact on a polled basis for
@ -33,7 +33,7 @@ buffering or reassembly.
## Prerequisites ## Prerequisites
The ZeroMQ feature in Bitcoin Core requires ZeroMQ API version 4.x or The ZeroMQ feature in Zcash requires ZeroMQ API version 4.x or
newer. Typically, it is packaged by distributions as something like newer. Typically, it is packaged by distributions as something like
*libzmq3-dev*. The C++ wrapper for ZeroMQ is *not* needed. *libzmq3-dev*. The C++ wrapper for ZeroMQ is *not* needed.
@ -45,7 +45,7 @@ operation.
By default, the ZeroMQ feature is automatically compiled in if the By default, the ZeroMQ feature is automatically compiled in if the
necessary prerequisites are found. To disable, use --disable-zmq necessary prerequisites are found. To disable, use --disable-zmq
during the *configure* step of building bitcoind: during the *configure* step of building zcashd:
$ ./configure --disable-zmq (other options) $ ./configure --disable-zmq (other options)
@ -66,8 +66,8 @@ address. The same address can be used in more than one notification.
For instance: For instance:
$ bitcoind -zmqpubhashtx=tcp://127.0.0.1:28332 \ $ zcashd -zmqpubhashtx=tcp://127.0.0.1:28332 \
-zmqpubrawtx=ipc:///tmp/bitcoind.tx.raw -zmqpubrawtx=ipc:///tmp/zcashd.tx.raw
Each PUB notification has a topic and body, where the header Each PUB notification has a topic and body, where the header
corresponds to the notification type. For instance, for the corresponds to the notification type. For instance, for the
@ -75,7 +75,7 @@ notification `-zmqpubhashtx` the topic is `hashtx` (no null
terminator) and the body is the hexadecimal transaction hash (32 terminator) and the body is the hexadecimal transaction hash (32
bytes). bytes).
These options can also be provided in bitcoin.conf. These options can also be provided in zcash.conf.
ZeroMQ endpoint specifiers for TCP (and others) are documented in the ZeroMQ endpoint specifiers for TCP (and others) are documented in the
[ZeroMQ API](http://api.zeromq.org/4-0:_start). [ZeroMQ API](http://api.zeromq.org/4-0:_start).
@ -87,9 +87,9 @@ arriving. Please see `contrib/zmq/zmq_sub.py` for a working example.
## Remarks ## Remarks
From the perspective of bitcoind, the ZeroMQ socket is write-only; PUB From the perspective of zcashd, the ZeroMQ socket is write-only; PUB
sockets don't even have a read function. Thus, there is no state sockets don't even have a read function. Thus, there is no state
introduced into bitcoind directly. Furthermore, no information is introduced into zcashd directly. Furthermore, no information is
broadcast that wasn't already received from the public P2P network. broadcast that wasn't already received from the public P2P network.
No authentication or authorization is done on connecting clients; it No authentication or authorization is done on connecting clients; it
@ -102,5 +102,5 @@ retrieve the chain from the last known block to the new tip.
There are several possibilities that ZMQ notification can get lost There are several possibilities that ZMQ notification can get lost
during transmission depending on the communication type your are during transmission depending on the communication type your are
using. Bitcoind appends an up-counting sequence number to each using. Zcashd appends an up-counting sequence number to each
notification which allows listeners to detect lost notifications. notification which allows listeners to detect lost notifications.