#zmq #bitcoin #bitcoin-core

bitcoincore-zmq

Bitcoin Core ZMQ subscriber with minimal dependencies

16 stable releases

1.5.2 Aug 6, 2024
1.5.1 Jul 10, 2024
1.5.0 May 17, 2024
1.4.0 Jan 23, 2024
1.2.0 Jul 28, 2023

#4 in #bitcoin-core

Download history 2/week @ 2024-06-28 86/week @ 2024-07-05 33/week @ 2024-07-12 19/week @ 2024-07-19 13/week @ 2024-07-26 124/week @ 2024-08-02 22/week @ 2024-08-09 2/week @ 2024-08-16 8/week @ 2024-08-23 11/week @ 2024-08-30 17/week @ 2024-09-06 25/week @ 2024-09-13 118/week @ 2024-09-20 90/week @ 2024-09-27 101/week @ 2024-10-04 43/week @ 2024-10-11

361 downloads per month

MIT license

57KB
1.5K SLoC

Build and test Integration tests crates.io docs.rs

Rust Bitcoin Core ZMQ Subscriber

Usage example

fn main() {
    for msg in bitcoincore_zmq::subscribe_receiver(&["tcp://127.0.0.1:28359"]).unwrap() {
        match msg {
            Ok(msg) => println!("Received message: {msg}"),
            Err(err) => println!("Error receiving message: {err}"),
        }
    }
}

For more examples, have a look in the examples directory.

Features

  • Minimal dependencies: the 2 crates bitcoin and zmq, optionally 2 additional crates are needed for the async subscriber, async_zmq and futures-util.
  • Handles all message types from Bitcoin Core: hashblock, hashtx, block, tx and sequence.
  • Flexible: choose between blocking functions with a callback, reading from a Receiver or reading from an asynchronous Stream without locking to a specific async runtime.

Testing

Tests run on every push and pull request. Integration tests use the latest version of the 5 most recent major Bitcoin Core versions, see integration_tests.yml.

Useful resources


TODO:

  • This README
  • SequenceMessage itest
  • Easy addEventListener like functionality with help of the getzmqnotifications rpc
  • raw messages
  • zmq publisher
  • include source in message

Dependencies

~9.5MB
~123K SLoC