bitcoin-explorer
bitcoin_explorer
is an efficient library for reading
bitcoin-core binary blockchain file as a database (utilising multi-threading).
Documentation
Go to Rust Documentation
Compatibility Note
This package deals with the binary file of another software Bitcoin Core
.
It might not be compatible with older Bitcoin Core versions.
Tested on
Bitcoin Core version v0.21.1.0-g194b9b8792d9b0798fdb570b79fa51f1d1f5ebaf Copyright (C) 2009-2020 The Bitcoin Core developers
.
Features
db.iter_connected_block()
uses in-memory UTXO cache by default,
which requires 32GB ore more memory, but is very fast.
It can be configured to use on-disk UTXO cache for tracking unspent transactions during iterations,
which usually requires less than 1GB memory.
By default, UTXO is stored on RAM, which requires 32GM memory
(it needs this much memory only for db.iter_connected_block()
)
[]
= "1.2"
Enable on-disk UTXO cache if your memory is limited:
[]
= "1.2"
= ["on-disk-utxo"]
Guide to Feature
When you have a large memory (>= 32 GB), do not use on-disk-utxo. In-memory UTXO cache provides blazing fast speed. Use on-disk-utxo only when your disk is limited.
Performance
SSD allows faster performance.
Iterating through all 700000 blocks (non-connected, in sequential order) takes about 10 minutes (Windows 10, CPU Core i7-9700, Block chain data on external SSD drive connected through USB 3.1).
With SSD, iterating through all 700000 blocks with input addresses connected takes about ? minutes.
Iterating through all 700000 blocks with input addresses connected takes about 30 minutes using in-memory UTXO cache (by default), which requires 32GB memory
If memory is limited, iterating through all blocks with input addresses connected takes about 10 hours
using on-disk UTXO cache (with features = ["on-disk-utxo"]
).
Examples
get a block (i.e., see doc for what is full/simple format)
use ;
use Path;
let path = new;
// launch without reading txindex
let db = new.unwrap;
// get block of height 600000 (in different formats)
let block: Block = db.get_block.unwrap;
let block: FBlock = db.get_block.unwrap;
let block: SBlock = db.get_block.unwrap;
get a particular transaction (in different formats)
use ;
use Path;
let path = new;
// !!must launch with txindex=true!!
let db = new.unwrap;
// get transaction
// e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468
let txid_str = "e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468";
let txid = from_hex.unwrap;
// get transactions in different formats
let tx: Transaction = db.get_transaction.unwrap;
let tx: FTransaction = db.get_transaction.unwrap;
let tx: STransaction = db.get_transaction.unwrap;
Iterate through blocks (in different formats)
Iterating to 700000 blocks requires about 2GB memory.
use ;
use Path;
let path = new;
// launch without reading txindex
let db = new.unwrap;
// iterate over block from 600000 to 700000
for block in db.
// iterate over block from 600000 to 700000
for block in db.
// iterate over block from 600000 to 700000
for block in db.
Iterate through blocks (in different format) with outpoints connected to outputs
Iterating to 700000 blocks with outpoints connected to outputs (with input addresses attached) requires a minimal amount of 32GB memory.
If memory is limited, use features = ["on-disk-utxo"]
in Cargo.toml to reduce memory use to
usually 1GB.
use ;
use Path;
let path = new;
// launch without reading txindex
let db = new.unwrap;
let end = db.get_max_height as u32;
// iterate over all blocks found (simple connected format)
for block in db.