Skip to content

Commit 7862c4a

Browse files
committed
RPC/blockchain: Reorder result documentation for scantxoutset
start, abort, status (with result), and status (no result) makes more logical sense
1 parent 98718d0 commit 7862c4a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/rpc/blockchain.cpp

+6-6
Original file line numberDiff line numberDiff line change
@@ -2305,12 +2305,6 @@ static RPCHelpMan scantxoutset()
23052305
"[scanobjects,...]"},
23062306
},
23072307
{
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, "", "",
2311-
{
2312-
{RPCResult::Type::NUM, "progress", "Approximate percent complete"},
2313-
}},
23142308
RPCResult{"when action=='start'; only returns after scan completes", RPCResult::Type::OBJ, "", "", {
23152309
{RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
23162310
{RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
@@ -2330,6 +2324,12 @@ static RPCHelpMan scantxoutset()
23302324
}},
23312325
{RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of all found unspent outputs in " + CURRENCY_UNIT},
23322326
}},
2327+
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"},
2328+
RPCResult{"when action=='status' and a scan is currently in progress", RPCResult::Type::OBJ, "", "",
2329+
{
2330+
{RPCResult::Type::NUM, "progress", "Approximate percent complete"},
2331+
}},
2332+
RPCResult{"when action=='status' and no scan is in progress - possibly already completed", RPCResult::Type::NONE, "", ""},
23332333
},
23342334
RPCExamples{""},
23352335
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue

0 commit comments

Comments
 (0)