From c38c09596d3d9cdce557c7d014147caed0fe6387 Mon Sep 17 00:00:00 2001 From: Taylor Hornby Date: Tue, 5 May 2020 16:56:14 -0600 Subject: [PATCH] Add directory structure information to the README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 8e9df7d..1c84c18 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # darksidewalletd-test-data Test files (sample blocks and transactions) for full-suite integration zcash/lightwalletd-wallet tests + +## Directory Structure + +The block sets contained in this repository are organized as follows: + +- Related block sets should live in the same directory. The directory name + should indicate the type of testing that the block sets are useful for, e.g. + `basic-reorg` for basic reorg testing. +- Inside the directory, there should be one or more `.txt` files containing the + block sets. There will usually be multiple block sets for reorg tests (before + the reorg, after the reorg). The filenames should indicate what the blocks are + useful for. +- If the block sets were generated using the `genblocks` tool in `lightwalletd`, + then there should be a `generate.sh` script for re-recreating the input to + `genblocks`. This will save everyone time if the block sets need to be + regenerated or modified.