From 0acc3d511b197bc5875da33e4faf563f423fe963 Mon Sep 17 00:00:00 2001 From: nym21 Date: Tue, 15 Apr 2025 11:27:48 +0200 Subject: [PATCH] parser: readme --- crates/brk_parser/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/brk_parser/README.md b/crates/brk_parser/README.md index cdef6be44..95d852fe2 100644 --- a/crates/brk_parser/README.md +++ b/crates/brk_parser/README.md @@ -41,15 +41,19 @@ The element returned by the iterator is a tuple which includes the: - Block: `Block` (from `bitcoin-rust`) - Block's Hash: `BlockHash` (also from `bitcoin-rust`) +Tested with Bitcoin Core `v25.0..=v28.1` + ## Requirements -Even though it reads *blkXXXXX.dat* files, it **needs** `bitcoind` to run with the RPC server to filter out block forks. +Even though it reads *blkXXXXX.dat* files, it **needs** `bitcoind` (with no particular parameters) to run with the RPC server to filter out forks. Peak memory should be around 500MB. +XOR-ed blocks are supported. + ## Disclaimer -A state is saved in `{bitcoindir}/blocks/blk_index_to_blk_recap.json` to allow for faster starts (see benchmark below) but doesn't yet support locking. Thus it is recommended to run one instance of `brk_parser` at a time. +A state of the local chain is saved in `{bitcoindir}/blocks/blk_index_to_blk_recap.json` to allow for faster starts (see benchmark below) but doesn't yet support locking. Thus, it is highly recommended to run one instance of `brk_parser` at a time. ## Comparaison