1 个稳定版本
1.2.19 | 2023 年 3 月 20 日 |
---|
#35 in #explorer
98KB
2K SLoC
bitcoin-explorer
bitcoin_explorer
是一个高效库,用于从比特币区块链解码交易信息。
支持比特币主网,可能在未来支持其他网络。
功能
1. 区块 & 脚本解码
- 根据区块高度或区块哈希查询区块。
- 支持
tx_index=1
。 - 使用 UTXO 缓存(
iter_connected_block()
)查找输入地址。
2. 并发 + 迭代器 + 顺序输出
- 快速并发反序列化但产生顺序输出。
- 原生迭代器接口(支持
for in
语法)。
3. 小内存占用(< 4 GB RAM)
- 使用快速磁盘 UTXO 存储(RocksDB)。
4. 为 Rust + Python 构建并发布(跨平台 PyPI 轮子)
- 构建并发布了适用于
python 3.6-3.10
的 PyPI 轮子,适用于Windows x86/x64
、MacOS x86_64/arm64
和Linux x86_64
。 - Rust 库在 crates.io 上称为 bitcoin-explorer。
文档
请参阅 Rust 文档
示例
获取磁盘上可用的总区块数和交易数
use bitcoin_explorer::{BitcoinDB, FConnectedBlock, SConnectedBlock};
use std::path::Path;
fn main() {
let path = Path::new("/Users/me/bitcoin");
let db = BitcoinDB::new(path, false).unwrap();
let block_count = db.get_block_count();
let total_number_of_transactions = (0..block_count)
.map(|i| db.get_header(i).unwrap().n_tx)
.sum::<u32>();
}
获取一个区块(即,请参阅文档了解完整/简单格式(FBlock/SBlock
)
SBlock
)use bitcoin_explorer::{BitcoinDB, FBlock, SBlock, Block};
use std::path::Path;
fn main() {
let path = Path::new("/Users/me/bitcoin");
// launch without reading txindex
let db = BitcoinDB::new(path, false).unwrap();
// get block of height 600000 (in different formats)
let block: Block = db.get_block(600000).unwrap();
let block: FBlock = db.get_block(600000).unwrap();
let block: SBlock = db.get_block(600000).unwrap();
}
获取一个交易(不同格式)
注意:这需要使用 Bitcoin Core 使用 --txindex=1
标志构建交易索引。
use bitcoin_explorer::{BitcoinDB, Transaction, FTransaction, STransaction, Txid, FromHex};
use std::path::Path;
fn main() {
let path = Path::new("/Users/me/bitcoin");
// !!must launch with txindex=true!!
let db = BitcoinDB::new(path, true).unwrap();
// get transaction
// e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468
let txid_str = "e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468";
let txid = Txid::from_hex(txid_str).unwrap();
// get transactions in different formats
let tx: Transaction = db.get_transaction(&txid).unwrap();
let tx: FTransaction = db.get_transaction(&txid).unwrap();
let tx: STransaction = db.get_transaction(&txid).unwrap();
}
遍历所有区块(不同格式)
use bitcoin_explorer::{BitcoinDB, Block, SBlock, FBlock};
use std::path::Path;
fn main() {
let path = Path::new("/Users/me/bitcoin");
// launch without reading txindex
let db = BitcoinDB::new(path, false).unwrap();
// iterate over block from 0 to 1000
for block in db.iter_block::<Block>(0, 1000) {
for tx in block.txdata {
println!("do something for this transaction");
}
}
// iterate over block from 1000 to end
for block in db.iter_block::<FBlock>(1000, db.get_block_count()) {
for tx in block.txdata {
println!("do something for this transaction");
}
}
// iterate over block from 0 to end
for block in db.iter_block::<SBlock>(0, db.get_block_count()) {
for tx in block.txdata {
println!("do something for this transaction");
}
}
}
遍历所有找到输入地址的区块(ConnectedBlock
)
use bitcoin_explorer::{BitcoinDB, FConnectedBlock, SConnectedBlock};
use std::path::Path;
fn main() {
let path = Path::new("/Users/me/bitcoin");
// launch without reading txindex
let db = BitcoinDB::new(path, false).unwrap();
let end = db.get_block_count();
// iterate over all blocks found (simple connected format)
for block in db.iter_connected_block::<SConnectedBlock>(end) {
for tx in block.txdata {
println!("do something for this transaction");
}
}
}
硬件要求
内存要求
内存要求:8 GB 物理内存。
磁盘要求
SSD 以获得更好的性能。
基准测试
- 操作系统:
x86_64
Windows 10 - CPU:Intel i7-9700 @ 3.00GHZ(4 核心线程,8 线程)
- 内存:16 GB 2667 MHz
- 硬盘:WDC SN730 512GB(固态硬盘)
遍历所有块(0 - 700000)
db.iter_block::<SBlock>(0, 700000)
- 时间:约10分钟
- 峰值内存:<= 500 MB
带有输入地址遍历所有块(0 - 700000)
db.iter_connected_block::<SConnectedBlock>(700000)
使用默认配置
使用默认功能编译(Cargo.toml)
bitcoin-explorer = "^1.2"
- 时间:约2.5小时
- 峰值内存:4 GB
使用非默认配置(大量RAM以获得良好性能)
使用非默认功能编译(Cargo.toml)
bitcoin-explorer = { version = "^1.2", default-features = false }
- 时间:约30分钟
- 峰值内存:32 GB
备注
兼容性
此软件包处理另一个软件的二进制文件,即Bitcoin Core
。它可能与较老的Bitcoin Core版本不兼容。
在Bitcoin Core版本v0.21.1.0-g194b9b8792d9b0798fdb570b79fa51f1d1f5ebaf 版权 (C) 2009-2020 The Bitcoin Core developers
上进行测试。
非默认功能(内存中UTXO缓存)
如果您有超过32 GB的内存,您可能可以尝试设置default-features = false
以在db.iter_connected_block()
上获得更快的性能
bitcoin-explorer = { version = "^1.2", default-features = false }
依赖项
~10–15MB
~232K SLoC