135 releases
Uses new Rust 2024
| 0.3.0-beta.9 | May 8, 2026 |
|---|---|
| 0.3.0-beta.7 | Apr 27, 2026 |
| 0.2.5 | Mar 29, 2026 |
| 0.1.0-alpha.1 | Dec 21, 2025 |
| 0.0.11 | Mar 31, 2025 |
#393 in Magic Beans
1.5MB
22K
SLoC
brk
Umbrella crate for the Bitcoin Research Kit.
Usage
Single dependency to access any BRK component. Enable only what you need via feature flags.
[dependencies]
brk = { version = "0.1", features = ["query", "types"] }
use brk::query::Query;
use brk::types::Height;
Feature flags match crate names without the brk_ prefix. Use full to enable all:
[dependencies]
brk = { version = "0.1", features = ["full"] }
Crates
Core Pipeline
| Crate | Description |
|---|---|
| brk_reader | Read blocks from blk*.dat with parallel parsing and XOR decoding |
| brk_indexer | Index transactions, addresses, and UTXOs |
| brk_computer | Compute derived metrics (realized cap, MVRV, SOPR, cohorts, etc.) |
| brk_mempool | Monitor mempool, estimate fees, project upcoming blocks |
| brk_oracle | Pure on-chain BTC/USD price oracle |
| brk_query | Query interface for indexed and computed data |
| brk_server | REST API with OpenAPI docs |
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_rpc | Bitcoin Core RPC client |
| brk_iterator | Unified block iteration with automatic source selection |
| brk_cohort | UTXO and address cohort filtering |
| brk_traversable | Navigate hierarchical data structures |
Clients & Integration
| Crate | Description |
|---|---|
| brk_client | Generated Rust API client |
| brk_bindgen | Generate typed clients (Rust, JavaScript, Python) |
Internal
| Crate | Description |
|---|---|
| brk_cli | CLI binary (cargo install --locked brk_cli) |
| brk_error | Error types |
| brk_logger | Logging infrastructure |
| brk_bencher | Benchmarking utilities |
Dependencies
~0–23MB
~311K SLoC