https://github.com/antonilol/rust-bitcoincore-zmq

Bitcoin Core ZMQ subscriber with minimal dependencies
https://github.com/antonilol/rust-bitcoincore-zmq

bitcoin bitcoin-core zmq zmq-subscriber

Last synced: 2 days ago
JSON representation

Bitcoin Core ZMQ subscriber with minimal dependencies

• Host: GitHub
• URL: https://github.com/antonilol/rust-bitcoincore-zmq
• Owner: antonilol
• License: mit
• Created: 2023-04-17T15:25:13.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-05T23:02:54.000Z (11 days ago)
• Last Synced: 2024-11-06T00:17:31.548Z (11 days ago)
• Topics: bitcoin, bitcoin-core, zmq, zmq-subscriber
• Language: Rust
• Homepage:
• Size: 186 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build and test](https://github.com/antonilol/rust-bitcoincore-zmq/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/antonilol/rust-bitcoincore-zmq/actions/workflows/build_and_test.yml)

[![Integration tests](https://github.com/antonilol/rust-bitcoincore-zmq/actions/workflows/integration_tests.yml/badge.svg)](https://github.com/antonilol/rust-bitcoincore-zmq/actions/workflows/integration_tests.yml)

[![crates.io](https://img.shields.io/crates/v/bitcoincore-zmq.svg)](https://crates.io/crates/bitcoincore-zmq)

[![docs.rs](https://docs.rs/bitcoincore-zmq/badge.svg)](https://docs.rs/bitcoincore-zmq)

# Rust Bitcoin Core ZMQ Subscriber

### Usage example

```rust

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](examples).

### 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](https://doc.rust-lang.org/std/sync/mpsc/struct.Receiver.html) or reading from an asynchronous [Stream](https://docs.rs/futures-core/latest/futures_core/stream/trait.Stream.html) without locking to a specific async runtime.

### Testing

Tests run on every push and pull request.

Integration tests use the latest minor version of the 5 most recent major Bitcoin Core versions, see [integration_tests.yml](.github/workflows/integration_tests.yml#L19-L23) for the version numbers.

### Useful resources

- [Bitcoin Core ZMQ documentation](https://github.com/bitcoin/bitcoin/blob/master/doc/zmq.md)

---

TODO:

- This README

- SequenceMessage itest

- Easy addEventListener like functionality with help of the `getzmqnotifications` rpc

- raw messages

- zmq publisher

- include source in message