mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-30 17:40:00 -07:00
28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
# Indexer
|
|
|
|
A [Bitcoin Core](https://bitcoincore.org/en/about/) node indexer which iterates over the chain (via `../iterator`) and creates a database of the vecs (`../storable_vec`) and key/value stores ([`fjall`](https://crates.io/crates/fjall)) that can be used in your Rust code.
|
|
|
|
The crate only stores the bare minimum to be self sufficient and not have to use an RPC client (except for scripts which are not stored). If you need more data, checkout `../computer` which uses the outputs from the indexer to compute a whole range of datasets.
|
|
|
|
Vecs are used sparingly instead of stores for multiple reasons:
|
|
|
|
- Only stores the relevant data since the key is an index
|
|
- Saved as uncompressed bytes and thus can be parsed manually (with any programming language) without relying on a server or library
|
|
- Easy to work with and predictable
|
|
|
|
## Usage
|
|
|
|
Peaks at 11-12 GB of RAM
|
|
|
|
## Outputs
|
|
|
|
Vecs: `src/storage/storable_vecs/mod.rs`
|
|
|
|
Stores: `src/storage/fjalls/mod.rs`
|
|
|
|
## Examples
|
|
|
|
Rust: `src/main.rs`
|
|
|
|
Python: `../python/parse.py`
|