aboutsummaryrefslogtreecommitdiff
path: root/contrib/linearize/README.md
diff options
context:
space:
mode:
authorJeff Garzik <jgarzik@bitpay.com>2014-08-23 21:46:12 -0400
committerJeff Garzik <jgarzik@bitpay.com>2014-08-23 21:46:12 -0400
commit476eb7eb53f680494952865a823e5cf9459da2b9 (patch)
tree685aff1a7a7b18237343de12fd539e877a594bd6 /contrib/linearize/README.md
parent57fe1eaadc7c404b199239351e7bd80f48f3bcba (diff)
Update linearize scripts.
Break into two steps: * Generate hash list * Build data file(s) from local bitcoind blocks/ directory. This supports building one large bootstrap.dat, or multiple smaller blocks/blkNNNNN.dat files.
Diffstat (limited to 'contrib/linearize/README.md')
-rw-r--r--contrib/linearize/README.md31
1 files changed, 29 insertions, 2 deletions
diff --git a/contrib/linearize/README.md b/contrib/linearize/README.md
index 70b9f034cd..8d06d53b10 100644
--- a/contrib/linearize/README.md
+++ b/contrib/linearize/README.md
@@ -1,2 +1,29 @@
-### Linearize ###
-Construct a linear, no-fork, best version of the blockchain. \ No newline at end of file
+# Linearize
+Construct a linear, no-fork, best version of the blockchain.
+
+## Step 1: Download hash list
+
+ $ ./linearize-hashes.py linearize.cfg > hashlist.txt
+
+Required configuration file settings for linearize-hashes:
+* RPC: rpcuser, rpcpassword
+
+Optional config file setting for linearize-hashes:
+* RPC: host, port
+* Block chain: min_height, max_height
+
+## Step 2: Copy local block data
+
+ $ ./linearize-data.py linearize.cfg
+
+Required configuration file settings:
+* "input": bitcoind blocks/ directory containing blkNNNNN.dat
+* "hashlist": text file containing list of block hashes, linearized-hashes.py
+output.
+* "output_file": bootstrap.dat
+ or
+* "output": output directory for linearized blocks/blkNNNNN.dat output
+
+Optional config file setting for linearize-data:
+* "netmagic": network magic number
+