Skip to content

Commit 9f8a46f

Browse files
committed
Properly document target_confirmations in listsinceblock
1 parent 1caafa6 commit 9f8a46f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/wallet/rpcwallet.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1761,7 +1761,7 @@ UniValue listsinceblock(const JSONRPCRequest& request)
17611761
"Additionally, if include_removed is set, transactions affecting the wallet which were removed are returned in the \"removed\" array.\n"
17621762
"\nArguments:\n"
17631763
"1. \"blockhash\" (string, optional) The block hash to list transactions since\n"
1764-
"2. target_confirmations: (numeric, optional, default=1) The confirmations required, must be 1 or more\n"
1764+
"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"
17651765
"3. include_watchonly: (bool, optional, default=false) Include transactions to watch-only addresses (see 'importaddress')\n"
17661766
"4. include_removed: (bool, optional, default=true) Show transactions that were removed due to a reorg in the \"removed\" array\n"
17671767
" (not guaranteed to work on pruned nodes)\n"
@@ -1794,7 +1794,7 @@ UniValue listsinceblock(const JSONRPCRequest& request)
17941794
" <structure is the same as \"transactions\" above, only present if include_removed=true>\n"
17951795
" 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"
17961796
" ],\n"
1797-
" \"lastblock\": \"lastblockhash\" (string) The hash of the last block\n"
1797+
" \"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"
17981798
"}\n"
17991799
"\nExamples:\n"
18001800
+ HelpExampleCli("listsinceblock", "")

0 commit comments

Comments
 (0)