Properly document target_confirmations in listsinceblock
This commit is contained in:
parent
1caafa6cde
commit
9f8a46f077
1 changed files with 2 additions and 2 deletions
|
@ -1761,7 +1761,7 @@ UniValue listsinceblock(const JSONRPCRequest& request)
|
||||||
"Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the \"removed\" array.\n"
|
"Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the \"removed\" array.\n"
|
||||||
"\nArguments:\n"
|
"\nArguments:\n"
|
||||||
"1. \"blockhash\" (string, optional) The block hash to list transactions since\n"
|
"1. \"blockhash\" (string, optional) The block hash to list transactions since\n"
|
||||||
"2. target_confirmations: (numeric, optional, default=1) The confirmations required, must be 1 or more\n"
|
"2. target_confirmations: (numeric, optional, default=1) Return the nth block hash from the main chain. e.g. 1 would mean the best block hash. Note: this is not used as a filter, but only affects [lastblock] in the return value\n"
|
||||||
"3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress')\n"
|
"3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress')\n"
|
||||||
"4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the \"removed\" array\n"
|
"4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the \"removed\" array\n"
|
||||||
" (not guaranteed to work on pruned nodes)\n"
|
" (not guaranteed to work on pruned nodes)\n"
|
||||||
|
@ -1794,7 +1794,7 @@ UniValue listsinceblock(const JSONRPCRequest& request)
|
||||||
" <structure is the same as \"transactions\" above, only present if include_removed=true>\n"
|
" <structure is the same as \"transactions\" above, only present if include_removed=true>\n"
|
||||||
" Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count.\n"
|
" Note: transactions that were readded in the active chain will appear as-is in this array, and may thus have a positive confirmation count.\n"
|
||||||
" ],\n"
|
" ],\n"
|
||||||
" \"lastblock\": \"lastblockhash\" (string) The hash of the last block\n"
|
" \"lastblock\": \"lastblockhash\" (string) The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they've reached 6 confirmations plus any new ones\n"
|
||||||
"}\n"
|
"}\n"
|
||||||
"\nExamples:\n"
|
"\nExamples:\n"
|
||||||
+ HelpExampleCli("listsinceblock", "")
|
+ HelpExampleCli("listsinceblock", "")
|
||||||
|
|
Loading…
Reference in a new issue