diff options
| author | Luke Dashjr <luke-jr+git@utopios.org> | 2022-06-11 15:27:13 +0000 |
|---|---|---|
| committer | Luke Dashjr <luke-jr+git@utopios.org> | 2022-06-13 14:05:06 +0000 |
| commit | b283e4d823cc29c0151f02c43203d3a0253e383c (patch) | |
| tree | 73c015ba262be0e47d39e1788057d280198bce9f /src | |
| parent | 42af9596ce85a541988abee54eed8a9b271a46a1 (diff) | |
| download | bitcoin-b283e4d823cc29c0151f02c43203d3a0253e383c.tar.xz | |
RPC/blockchain: Elaborate on scantxoutset documentation
Diffstat (limited to 'src')
| -rw-r--r-- | src/rpc/blockchain.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp index c4a89c9772..14454c7542 100644 --- a/src/rpc/blockchain.cpp +++ b/src/rpc/blockchain.cpp @@ -2305,13 +2305,13 @@ static RPCHelpMan scantxoutset() "[scanobjects,...]"}, }, { - RPCResult{"When action=='abort'", RPCResult::Type::BOOL, "", ""}, - RPCResult{"When action=='status' and no scan is in progress", RPCResult::Type::NONE, "", ""}, - RPCResult{"When action=='status' and scan is in progress", RPCResult::Type::OBJ, "", "", + RPCResult{"When action=='abort'", RPCResult::Type::BOOL, "success", "True if scan will be aborted (not necessarily before this RPC returns), or false if there is no scan to abort"}, + RPCResult{"When action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""}, + RPCResult{"When action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "", { - {RPCResult::Type::NUM, "progress", "The scan progress"}, + {RPCResult::Type::NUM, "progress", "Approximate percent complete"}, }}, - RPCResult{"When action=='start'", RPCResult::Type::OBJ, "", "", { + RPCResult{"When action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", { {RPCResult::Type::BOOL, "success", "Whether the scan was completed"}, {RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"}, {RPCResult::Type::NUM, "height", "The current block height (index)"}, |