brk 0.12.2

The Bitcoin Research Kit is a suite of tools designed to extract, compute and display data stored on a Bitcoin Core node
Documentation

brk

Umbrella crate for the Bitcoin Research Kit.

crates.io | docs.rs

Usage

Single dependency for BRK's reusable Bitcoin primitives. Enable only what you need through feature flags.

[dependencies]
brk = { version = "0.11", features = ["reader", "types"] }
use brk::reader::Reader;
use brk::types::Height;

Feature flags match crate names without the brk_ prefix. Use full to enable all:

[dependencies]
brk = { version = "0.11", features = ["full"] }

Crates

Bitcoin data

Crate Description
brk_reader Read blocks from blk*.dat with parallel parsing and XOR decoding
brk_mempool Monitor mempool, estimate fees, project upcoming blocks
brk_oracle Pure on-chain BTC/USD price oracle
brk_rpc Bitcoin Core RPC client

Data & Storage

Crate Description
brk_types Domain types: Height, Sats, Txid, addresses, etc.
brk_store Key-value storage (fjall wrapper)
brk_fetcher Fetch price data from exchanges
brk_iterator Unified block iteration with automatic source selection
brk_error Shared error types
brk_logger Logging infrastructure

Indexing, computation, querying, clients, and serving belong to Bitview. The complete self-hosted platform and executable are provided by bitviewd; see its installation guide for the optimized build command.