From 481ba5c6fe290c042c1f4ae554c1855dc1c589a2 Mon Sep 17 00:00:00 2001 From: Duke Leto Date: Mon, 6 Jun 2022 15:56:52 +0000 Subject: [PATCH] Add 'doc/config.md' --- doc/config.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 doc/config.md diff --git a/doc/config.md b/doc/config.md new file mode 100644 index 000000000..530407c73 --- /dev/null +++ b/doc/config.md @@ -0,0 +1,20 @@ +# HUSH3.conf config options + +This document explains all options that can be used in HUSH3.conf + +# Basics + +Options can either be put in HUSH3.conf or given on the `hushd` commandline when starting. If you think you will want to continually use a feature, it's better to put it in HUSH3.conf. If you don't, and start `hushd` without an option on accident, it cause a downtime from a long rescan, that you didn't want to do anyway. + + +# rescan=1 + +Defaults to 0. Performs a full rescan of all of chain history. Can take a very long time. Speed this up with `rescanheight=123` to only rescan from a certain block height. Also speed this up with `keepnotewitnesscache=1` to not rebuild the zaddr witness cache. + +# txindex=1 + +Defaults to 1. This is a default option that should not be changed or things will not work correctly. + +# zindex=1 + +Defaults to 0. This option enables the "shielded index" which also calculates the "anonset" (anonymity set) also known as the "shielded pool". This data is avaailable in the getchaintxstats RPC, if zindex is enabled. \ No newline at end of file