29 releases
Uses new Rust 2024
new 0.0.30 | Apr 22, 2025 |
---|---|
0.0.29 | Apr 22, 2025 |
0.0.11 | Mar 31, 2025 |
0.0.2 | Feb 27, 2025 |
#299 in Magic Beans
2,362 downloads per month
610KB
15K
SLoC
Bitcoin Research Kit
WARNING
This project is still a work in progress and while it's much better in many ways than its previous version (kibo v0.5), it doesn't yet include all of those datasets. If you're interested in having everything right now, please use the latter until feature parity is achieved.
The explorer part (mempool.space/electrs) is also not viable just yet.
Stay tuned and please be patient, it's a lot of work !
The Bitcoin Research Kit is a high-performance toolchain designed to parse, index, compute, serve and visualize data from a Bitcoin Core node, enabling users to gain deeper insights into the Bitcoin network.
In other words it's an alternative to Glassnode, mempool.space and electrs all in one package with a particular focus on simplicity and the self-hosting experience.
The toolkit can be used in various ways to accommodate as many needs as possible:
- Website
Everyone is welcome to visit kibo.money which is the official showcase of the suite's capabilities and served by default when running BRK.
Researchers and developers are free to use the API which endpoints documentation can be found here.
As a token of gratitude to the community and to stimulate curiosity, both the website and the API are entirely free, allowing anyone to use them. - CLI
Node runners are strongly encouraged to try out and self-host their own instance.
A lot of effort has gone into making this as easy as possible.
For more information visit:brk_cli
- 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 otherbrk-*
cratesbrk_cli
: A standalone command line interface to interact with the Bitcoin Research Kitbrk_computer
: A Bitcoin dataset computer, built on top of brk_indexerbrk_core
: The Core (Structs and Errors) of the Bitcoin Research Kitbrk_exit
: An exit blocker built on top of ctrlcbrk_fetcher
: A Bitcoin price fetcherbrk_indexer
: A Bitcoin Core indexer built on top of brk_parserbrk_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-rustbrk_query
: A library that finds requested datasets.brk_server
: A server that serves Bitcoin data and swappable front-ends, built on top ofbrk_indexer
,brk_fetcher
andbrk_computer
brk_vec
: A push-only, truncable, compressable, saveable Vec
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.
Hosting as a service
Soon™
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.9% SLA
- Direct communication for feature requests and support
- Updates delivered at your convenience
- 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
Donate
Dependencies
~62MB
~1M SLoC