bitcoin-block-parser 0.3.4

Fast optimized parser for the bitcoin `blocks` data with UTXO tracking.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# Bitcoin Block Parser

[![Crates.io][crates-badge]][crates-url]
[![Docs][docs-badge]][docs-url]
[![MIT licensed][mit-badge]][mit-url]

[crates-badge]: https://img.shields.io/crates/v/bitcoin-block-parser.svg
[crates-url]: https://crates.io/crates/bitcoin-block-parser
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/sumopool/bitcoin-block-parser/blob/master/LICENSE
[docs-badge]: https://img.shields.io/docsrs/bitcoin-block-parser
[docs-url]: https://docs.rs/bitcoin-block-parser

Fast optimized parser for the bitcoin `blocks` data with UTXO tracking.

⚠️ The API is still evolving and should not be considered stable until release `1.0.0`

## Features
- Parses blocks into the Rust bitcoin [`Block`](bitcoin::Block) format for easier manipulation
- Can track whether any `TxOut` in a `Transaction` is spent or unspent
- Can track the `Amount` of every `TxIn` for calculating metrics such as fee rates
- Or implement your own custom multithreaded [`BlockParser`](crate::BlockParser)
- Uses many optimizations to provide the best block parsing performance

## Requirements / Benchmarks
- You must be running a [non-pruning](https://bitcoin.org/en/full-node#reduce-storage) bitcoin node (this is the default configuration)
- You should look at the table below to understand how much RAM you need (tunable through `Options`)
- We recommend using fast storage and a multithreaded CPU for best performance

Our benchmarks were run on NVMe storage with a 32-thread processor on **850,000** blocks:

| Function      | Time   | Memory  |
|---------------|--------|---------|
| DefaultParser | 5 min  | 3.5 GB  | 
| InOrderParser | 6 min  | 3.4 GB  | 
| FilterParser  | 17 min | 9.3 GB  |
| UtxoParser    | 39 min | 17.5 GB |

## Quick Usage
- To parse blocks pass in the `blocks` directory of your bitcoin node and call [`DefaultParser::parse_dir`](blocks::DefaultParser::parse_dir)
- If your algorithm requires the blocks to be processed in-order use [`InOrderParser::parse_dir`](blocks::InOrderParser::parse_dir)
- For advanced usage and implementing your own block parser see the [`blocks`](crate::blocks) module docs
- To track amounts through the transaction graph see the [`utxos`](crate::utxos) module docs

```rust
use bitcoin_block_parser::*;

// Initialize a logger (if you want to monitor parsing progress)
env_logger::builder().filter_level(log::LevelFilter::Info).init();

// Iterates over all the blocks in the directory in parallel
// Use InOrderParser if your algorithm requires the blocks to be processed in-order
for block in DefaultParser.parse_dir("/home/user/.bitcoin/blocks").unwrap() {
  // Do whatever you want with the parsed block here
  block.unwrap().check_witness_commitment();
}
```