From bd41b3c848ccff98cbd81c2c518efc4a051954d2 Mon Sep 17 00:00:00 2001 From: Duke Leto Date: Mon, 6 Jun 2022 15:53:05 +0000 Subject: [PATCH] Update 'doc/config.md' --- doc/config.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/config.md b/doc/config.md index 85edc3d0e..b6b041a7e 100644 --- a/doc/config.md +++ b/doc/config.md @@ -1,3 +1,15 @@ # HUSH3.conf config options -This document explains all options that can be used in HUSH3.conf \ No newline at end of file +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. + +# txindex=1 + +This is a default option that should not be changed or things will not work correctly. + +# zindex=1 + +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