mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 01:42:58 +01:00

History

Gr0kchain 582e66b6e7 doc: Added regtest config for linearize script Updated the example-linearize.cfg file to include support for the regtest chain network config which is used by the ./linearize-data.py Problem: Without the regtest magic, genesis hash and path config, the `linearize-data.py` script cannot generate a bootstrap.dat file. Example of error: ./linearize-data.py ./linearize.cfg Read 102 hashes Genesis block not found in hashlist Solution: Added netmagic, genesis and input example parameters to file. Resolution 1. Starting bitcoind in regtest mode 2. bitcoin-cli generatetoaddress 101 $(bitcoin-cli getnewaddress) 3. ./linearize-hashes.py ./linearize.cfg > ./hashlist.txt 4. ./linearize-data.py ./linearize.cfg Example after fix: $ ./linearize-data.py ./linearize.cfg Read 102 hashes Input file /Users/gr0kchain/.bitcoin/regtest/blocks/blk00000.dat Output file /Users/gr0kchain/Downloads/bootstrap.dat Done (102 blocks written)		2019-11-07 08:07:10 +02:00
..
example-linearize.cfg	doc: Added regtest config for linearize script	2019-11-07 08:07:10 +02:00
linearize-data.py	Merge #16802 : scripts: In linearize, search for next position of magic bytes rather than fail	2019-10-08 10:42:04 +02:00
linearize-hashes.py	test/contrib: Fix invalid escapes in regex strings	2019-09-03 14:38:38 -04:00
README.md	build: Require python 3.5	2019-03-02 10:40:23 -05:00

README.md

Linearize

Construct a linear, no-fork, best version of the Bitcoin blockchain.

Step 1: Download hash list

$ ./linearize-hashes.py linearize.cfg > hashlist.txt

Required configuration file settings for linearize-hashes:

RPC: datadir (Required if rpcuser and rpcpassword are not specified)
RPC: rpcuser, rpcpassword (Required if datadir is not specified)

Optional config file setting for linearize-hashes:

RPC: host (Default: 127.0.0.1)
RPC: port (Default: 8332)
Blockchain: min_height, max_height
rev_hash_bytes: If true, the written block hash list will be byte-reversed. (In other words, the hash returned by getblockhash will have its bytes reversed.) False by default. Intended for generation of standalone hash lists but safe to use with linearize-data.py, which will output the same data no matter which byte format is chosen.

The linearize-hashes script requires a connection, local or remote, to a JSON-RPC server. Running bitcoind or bitcoin-qt -server will be sufficient.

Step 2: Copy local block data

$ ./linearize-data.py linearize.cfg

Required configuration file settings:

output_file: The file that will contain the final blockchain. or
output: Output directory for linearized blocks/blkNNNNN.dat output.

Optional config file setting for linearize-data:

debug_output: Some printouts may not always be desired. If true, such output will be printed.
file_timestamp: Set each file's last-accessed and last-modified times, respectively, to the current time and to the timestamp of the most recent block written to the script's blockchain.
genesis: The hash of the genesis block in the blockchain.
input: bitcoind blocks/ directory containing blkNNNNN.dat
hashlist: text file containing list of block hashes created by linearize-hashes.py.
max_out_sz: Maximum size for files created by the output_file option. (Default: 1000*1000*1000 bytes)
netmagic: Network magic number.
out_of_order_cache_sz: If out-of-order blocks are being read, the block can be written to a cache so that the blockchain doesn't have to be sought again. This option specifies the cache size. (Default: 100*1000*1000 bytes)
rev_hash_bytes: If true, the block hash list written by linearize-hashes.py will be byte-reversed when read by linearize-data.py. See the linearize-hashes entry for more information.
split_timestamp: Split blockchain files when a new month is first seen, in addition to reaching a maximum file size (max_out_sz).