Add some docs for getchaintxstats new features

This commit is contained in:
Duke Leto
2019-09-05 08:56:47 -04:00
parent 9de6e8a404
commit 799f6d757b

View File

@@ -1946,15 +1946,18 @@ UniValue getchaintxstats(const UniValue& params, bool fHelp)
throw runtime_error(
"getchaintxstats\n"
"\nCompute statistics about the total number and rate of transactions in the chain.\n"
"\nThis RPC will return extra data about shielded transactions, payments and notarizations if the zindex is enabled .\n"
"\nArguments:\n"
"1. nblocks (numeric, optional) Number of blocks in averaging window.\n"
"2. blockhash (string, optional) The hash of the block which ends the window.\n"
"\nResult:\n"
"{\n"
" \"time\": xxxxx, (numeric) The timestamp for the final block in the window in UNIX format.\n"
" \"notarizations\": xxxxx, (optional, numeric) The number of notarizations in the chain.\n"
" \"txcount\": xxxxx, (numeric) The total number of transactions in the chain up to that point.\n"
" \"window_final_block_hash\": \"...\", (string) The hash of the final block in the window.\n"
" \"window_block_count\": xxxxx, (numeric) Size of the window in number of blocks.\n"
" \"window_notarizations\": xxxxx, (optional, numeric) Number of notarization transactions in window.\n"
" \"window_tx_count\": xxxxx, (numeric) The number of transactions in the window. Only returned if \"window_block_count\" is > 0.\n"
" \"window_interval\": xxxxx, (numeric) The elapsed time in the window in seconds. Only returned if \"window_block_count\" is > 0.\n"
" \"txrate\": x.xx, (numeric) The average rate of transactions per second in the window. Only returned if \"window_interval\" is > 0.\n"