Skip to content

Commit fa07ee1

Browse files
author
MacroFake
committed
Merge bitcoin#25339: RPC/blockchain: Elaborate on scantxoutset documentation
7862c4a RPC/blockchain: Reorder result documentation for scantxoutset (Luke Dashjr) 98718d0 scripted-diff: RPC/blockchain: Lowercase "when" in scantxoutset documentation (Luke Dashjr) b283e4d RPC/blockchain: Elaborate on scantxoutset documentation (Luke Dashjr) Pull request description: Minor doc improvements ACKs for top commit: achow101: ACK 7862c4a Tree-SHA512: a8b16a9b77c3ca216ce2556c26d6a049b12f73500bdb35c172432409b3b9321cc24a08daca1210926e0f75674b2e680e850637700c516c195fb75ce6555c17c4
2 parents 4c0d1fe + 7862c4a commit fa07ee1

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/rpc/blockchain.cpp

+7-7
Original file line numberDiff line numberDiff line change
@@ -2040,13 +2040,7 @@ static RPCHelpMan scantxoutset()
20402040
"[scanobjects,...]"},
20412041
},
20422042
{
2043-
RPCResult{"When action=='abort'", RPCResult::Type::BOOL, "", ""},
2044-
RPCResult{"When action=='status' and no scan is in progress", RPCResult::Type::NONE, "", ""},
2045-
RPCResult{"When action=='status' and scan is in progress", RPCResult::Type::OBJ, "", "",
2046-
{
2047-
{RPCResult::Type::NUM, "progress", "The scan progress"},
2048-
}},
2049-
RPCResult{"When action=='start'", RPCResult::Type::OBJ, "", "", {
2043+
RPCResult{"when action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", {
20502044
{RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
20512045
{RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
20522046
{RPCResult::Type::NUM, "height", "The current block height (index)"},
@@ -2065,6 +2059,12 @@ static RPCHelpMan scantxoutset()
20652059
}},
20662060
{RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of all found unspent outputs in " + CURRENCY_UNIT},
20672061
}},
2062+
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"},
2063+
RPCResult{"when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
2064+
{
2065+
{RPCResult::Type::NUM, "progress", "Approximate percent complete"},
2066+
}},
2067+
RPCResult{"when action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""},
20682068
},
20692069
RPCExamples{
20702070
HelpExampleCli("scantxoutset", "start \'[\"" + EXAMPLE_DESCRIPTOR_RAW + "\"]\'") +

0 commit comments

Comments
 (0)