rpc: Properly document scantxoutset return value
Can be reviewed with --ignore-all-space
This commit is contained in:
1 file changed
+9
-4
@@ -2162,14 +2162,18 @@ static RPCHelpMan scantxoutset()
|
|||||||
{
|
{
|
||||||
{"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
|
{"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "An output descriptor"},
|
||||||
{"range", RPCArg::Type::RANGE, /* default */ "1000", "The range of HD chain indexes to explore (either end or [begin,end])"},
|
{"range", RPCArg::Type::RANGE, /* default */ "1000", "The range of HD chain indexes to explore (either end or [begin,end])"},
|
||||||
},
|
}},
|
||||||
},
|
|
||||||
},
|
},
|
||||||
"[scanobjects,...]"},
|
"[scanobjects,...]"},
|
||||||
},
|
},
|
||||||
RPCResult{
|
|
||||||
RPCResult::Type::OBJ, "", "",
|
|
||||||
{
|
{
|
||||||
|
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::Type::NUM, "progress", "The scan progress"},
|
||||||
|
}},
|
||||||
|
RPCResult{"When action=='start'", RPCResult::Type::OBJ, "", "", {
|
||||||
{RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
|
{RPCResult::Type::BOOL, "success", "Whether the scan was completed"},
|
||||||
{RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
|
{RPCResult::Type::NUM, "txouts", "The number of unspent transaction outputs scanned"},
|
||||||
{RPCResult::Type::NUM, "height", "The current block height (index)"},
|
{RPCResult::Type::NUM, "height", "The current block height (index)"},
|
||||||
@@ -2188,6 +2192,7 @@ static RPCHelpMan scantxoutset()
|
|||||||
}},
|
}},
|
||||||
{RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of all found unspent outputs in " + CURRENCY_UNIT},
|
{RPCResult::Type::STR_AMOUNT, "total_amount", "The total amount of all found unspent outputs in " + CURRENCY_UNIT},
|
||||||
}},
|
}},
|
||||||
|
},
|
||||||
RPCExamples{""},
|
RPCExamples{""},
|
||||||
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
|
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in new issue
Block a user