Skip to content

Commit b283e4d

Browse files
committed
RPC/blockchain: Elaborate on scantxoutset documentation
1 parent 42af959 commit b283e4d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/rpc/blockchain.cpp

+5-5
Original file line numberDiff line numberDiff line change
@@ -2305,13 +2305,13 @@ static RPCHelpMan scantxoutset()
23052305
"[scanobjects,...]"},
23062306
},
23072307
{
2308-
RPCResult{"When action=='abort'", RPCResult::Type::BOOL, "", ""},
2309-
RPCResult{"When action=='status' and no scan is in progress", RPCResult::Type::NONE, "", ""},
2310-
RPCResult{"When action=='status' and scan is in progress", RPCResult::Type::OBJ, "", "",
2308+
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"},
2309+
RPCResult{"When action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""},
2310+
RPCResult{"When action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
23112311
{
2312-
{RPCResult::Type::NUM, "progress", "The scan progress"},
2312+
{RPCResult::Type::NUM, "progress", "Approximate percent complete"},
23132313
}},
2314-
RPCResult{"When action=='start'", RPCResult::Type::OBJ, "", "", {
2314+
RPCResult{"When action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", {
23152315
{RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
23162316
{RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
23172317
{RPCResult::Type::NUM, "height", "The current block height (index)"},

0 commit comments

Comments
 (0)