Skip to content

bitcoinresearchkit/brk

Repository files navigation

Bitcoin Research Kit

GitHub Repo stars License Version Documentation Size Dependency status Discord Nostr Bluesky X

The Bitcoin Research Kit is a high-performance toolchain designed to parse, index, compute, serve and visualize data from a Bitcoin node, enabling users to gain deeper insights into the Bitcoin network.

In other words it's an alternative to Glassnode, mempool.space (soon) and electrs (soon) all in one package with a particular focus on simplicity and ease of use.

The toolkit can be used in various ways to accommodate as many needs as possible:

  • Website
    Everyone is welcome to visit the official instance and showcase of the suite's capabilities.
    It has a wide range of functionalities including charts, tables and simulations which you can visit for free and without the need for an account.
    Also available at: kibo.money // satonomics.xyz
  • API
    Researchers and developers are free to use BRK's public API with Datasets variant count dataset variants at your disposal.
    Just like the website, it's entirely free, with no authentication or rate-limiting.
  • CLI
    Node runners are strongly encouraged to try out and self-host their own instance using BRK's command line interface.
    The CLI has multiple cogs available for users to tweak to adapt to all situations with even the possibility for web developers to create their own custom website which could later on be added as an alternative front-end.
  • Crates
    Rust developers have access to a wide range crates, each built upon one another with its own specific purpose, enabling independent use and offering great flexibility. PRs are welcome, especially if their goal is to introduce additional datasets.

The primary goal of this project is to be fully-featured and accessible for everyone, regardless of their background or financial situation - whether that person is an enthusiast, researcher, miner, analyst, or simply curious.

In contrast, existing alternatives tend to be either very costly or missing essential features, with the vast majority being closed-source and unverifiable, which fundamentally undermines the principles of Bitcoin.

Crates

  • brk: Wrapper around all other brk-* crates
  • brk_cli: A standalone command line interface to interact with the Bitcoin Research Kit
  • brk_computer: A Bitcoin dataset computer, built on top of brk_indexer
  • brk_core: The Core (Structs and Errors) of the Bitcoin Research Kit
  • brk_exit: An exit blocker built on top of ctrlc
  • brk_fetcher: A Bitcoin price fetcher
  • brk_indexer: A Bitcoin Core indexer built on top of brk_parser
  • brk_logger: A clean logger used in the Bitcoin Research Kit.
  • brk_parser: A very fast Bitcoin Core block parser and iterator built on top of bitcoin-rust
  • brk_query: A library that finds requested datasets.
  • brk_server: A server that serves Bitcoin data and swappable front-ends, built on top of brk_indexer, brk_fetcher and brk_computer
  • brk_state: Various states used mainly by the computer
  • brk_store: A thin wrapper around fjall
  • brk_vec: A push-only, truncable, compressable, saveable Vec
  • brk_bundler: A thin wrapper around rolldown

Hosting as a service

If you'd like to have your own instance hosted for you please contact hosting@bitcoinresearchkit.org.

  • 2 separate dedicated servers (1 GB/s each) with different ISPs and Cloudflare integration for enhanced performance and optimal availability
  • 99.99% SLA
  • Configured for speed
  • Updates delivered at your convenience
  • Direct communication for feature requests and support
  • Bitcoin Core or Knots with desired version
  • Optional subdomains: *.bitcoinresearchkit.org, *.kibo.money and *.satonomics.xyz
  • Logo featured in the Readme if desired

Pricing: 0.01 BTC / month or 0.1 BTC / year

Acknowledgments

Deepest gratitude to the Open Sats public charity. Their grant — from December 2024 to the present — has been critical in sustaining this project.

Heartfelt thanks go out to every donor on Nostr and Geyser.fund whose support has ensured the availability of the kibo.money public instance.

Donate

bc1q09 8zsm89 m7kgyz e338vf ejhpdt 92ua9p 3peuve

lnurl1dp68gurn8ghj7ampd3kx2ar0veekzar0wd5xjtnrdakj7tnhv4kxctttdehhwm30d3h82unvwqhkxmmww3jkuar8d35kgetj8yuq363hv4

Geyser Fund