Bitcoin Blockchain Parser written in Rust language
rusty-blockparser is a Bitcoin Blockchain Parser written in Rust language.
It allows extraction of various data types (blocks, transactions, scripts, public keys/hashes, balances, ...) and UTXDO dumps from Bitcoin based blockchains.
It assumes a local copy of the blockchain with intact block index, downloaded with Bitcoin Core 0.15.1+. If you are not sure whether your local copy is valid you can apply
--verifyto validate the chain and block merkle trees. If something doesn't match the parser exits.
Callbacks are built on top of the core parser. They can be implemented to extract specific types of information.
balances: dumps all addresses with a non-zero balance. The csv file is in the following format:
balances.csv address ; balance
unspentcsvdump: dumps all UTXOs along with the address balance. The csv file is in the following format:
unspent.csv txid ; indexOut ; height ; value ; addressNOTE: The total size of the csv dump is at least 8 GiB (height 635000).
csvdump: dumps all parsed data as CSV files into the specified
folder. See Usage for an example. I chose CSV dumps instead of an active db-connection because
LOAD DATA INFILEis the most performant way for bulk inserts. The files are in the following format:
blocks.csv block_hash ; height ; version ; blocksize ; hashPrev ; hashMerkleRoot ; nTime ; nBits ; nNonce
transactions.csv txid ; hashBlock ; version ; lockTime
tx_in.csv txid ; hashPrevOut ; indexPrevOut ; scriptSig ; sequence
tx_out.csv txid ; indexOut ; height ; value ; scriptPubKey ; addressIf you want to insert the files into MySql see sql/schema.sql. It contains all table structures and SQL statements for bulk inserting. Also see sql/views.sql for some query examples. NOTE: The total size of the csv dump is at least to 731 GiB (height 635000).
simplestats: prints some blockchain statistics like block count, transaction count, avg transactions per block, largest transaction, transaction types etc.
You can also define custom callbacks. A callback gets called at startup, on each block and at the end. See src/callbacks/mod.rs for more information.
Low memory usage
The required memory usage depends on the used callback:
* simplestats: ~100MB * csvdump: ~100M * unspentcsvdump: ~18GB * balances: ~18GB
NOTE: Those values are taken from parsing to block height 639631 (17.07.2020).
--endcan be passed to resume a scan. However this makes no sense for
This tool runs on Windows, OS X and Linux. All you need is
You can download the latest release from crates.io:
bash cargo install rusty-blockparser
git clone https://github.com/gcarq/rusty-blockparser.git cd rusty-blockparser cargo build --release cargo test --release ./target/release/rusty-blockparser --help
It is important to build with
--release, otherwise you will get a horrible performance!
*Tested on Gentoo Linux with rust-stable 1.44.1
USAGE: rusty-blockparser [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS: -h, --help Prints help information -V, --version Prints version information -v Increases verbosity level. Info=0, Debug=1, Trace=2 (default: 0) --verify Verifies the leveldb index integrity and verifies merkle roots
OPTIONS: -d, --blockchain-dir Sets blockchain directory which contains blk.dat files (default: ~/.bitcoin/blocks) -c, --coin Specify blockchain coin (default: bitcoin) [possible values: bitcoin, testnet3, namecoin, litecoin, dogecoin, myriadcoin, unobtanium] -e, --end Specify last block for parsing (inclusive) (default: all known blocks) -s, --start Specify starting block for parsing (inclusive)
SUBCOMMANDS: balances Dumps all addresses with non-zero balance to CSV file csvdump Dumps the whole blockchain into CSV files help Prints this message or the help of the given subcommand(s) simplestats Shows various Blockchain stats unspentcsvdump Dumps the unspent outputs to CSV file
To make a
unspentcsvdumpof the Bitcoin blockchain your command would look like this: ```
[6:02:53] INFO - main: Starting rusty-blockparser v0.7.0 ... [6:02:53] INFO - index: Reading index from ~/.bitcoin/blocks/index ... [6:02:54] INFO - index: Got longest chain with 639626 blocks ... [6:02:54] INFO - blkfile: Reading files from ~/.bitcoin/blocks ... [6:02:54] INFO - parser: Parsing Bitcoin blockchain (range=0..) ... [6:02:54] INFO - callback: Using
unspentcsvdumpwith dump folder: /path/to/dump ... [6:03:04] INFO - parser: Status: 130885 Blocks processed. (left: 508741, avg: 13088 blocks/sec) ... [10:28:47] INFO - parser: Status: 639163 Blocks processed. (left: 463, avg: 40 blocks/sec) [10:28:57] INFO - parser: Status: 639311 Blocks processed. (left: 315, avg: 40 blocks/sec) [10:29:07] INFO - parser: Status: 639452 Blocks processed. (left: 174, avg: 40 blocks/sec) [10:29:17] INFO - parser: Status: 639596 Blocks processed. (left: 30, avg: 40 blocks/sec) [10:29:19] INFO - parser: Done. Processed 639626 blocks in 266.43 minutes. (avg: 40 blocks/sec) [10:32:01] INFO - callback: Done. Dumped all 639626 blocks: -> transactions: 549390991 -> inputs: 1347165535 -> outputs: 1359449320 [10:32:01] INFO - main: Fin. ```
Use the issue tracker to report problems, suggestions and questions. You may also contribute by submitting pull requests.
If you find this project helpful, please consider making a donation: