phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-26 19:23:26 -03:00
Code Issues Projects Releases Packages Wiki Activity Actions

rpc: Properly document gettxout return value

Browse source 
Can be reviewed with --ignore-all-space
This commit is contained in:
MarcoFalke 2020-11-23 11:21:55 +01:00
parent 56f06a9863
commit faa2059547
No known key found for this signature in database
GPG key ID: CE2B75697E69A548
1 changed files with 23 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
src/rpc/blockchain.cpp
View file

@ -1100,30 +1100,29 @@ static RPCHelpMan gettxoutsetinfo()
static RPCHelpMan gettxout() static RPCHelpMan gettxout()
{ {
return RPCHelpMan{"gettxout", return RPCHelpMan{"gettxout",
"\nReturns details about an unspent transaction output.\n", "\nReturns details about an unspent transaction output.\n",
{ {
{"txid", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction id"}, {"txid", RPCArg::Type::STR, RPCArg::Optional::NO, "The transaction id"},
{"n", RPCArg::Type::NUM, RPCArg::Optional::NO, "vout number"}, {"n", RPCArg::Type::NUM, RPCArg::Optional::NO, "vout number"},
{"include_mempool", RPCArg::Type::BOOL, /* default */ "true", "Whether to include the mempool. Note that an unspent output that is spent in the mempool won't appear."}, {"include_mempool", RPCArg::Type::BOOL, /* default */ "true", "Whether to include the mempool. Note that an unspent output that is spent in the mempool won't appear."},
}, },
RPCResult{ {
RPCResult::Type::OBJ, "", "", RPCResult{"If the UTXO was not found", RPCResult::Type::NONE, "", ""},
{ RPCResult{"Otherwise", RPCResult::Type::OBJ, "", "", {
{RPCResult::Type::STR_HEX, "bestblock", "The hash of the block at the tip of the chain"}, {RPCResult::Type::STR_HEX, "bestblock", "The hash of the block at the tip of the chain"},
{RPCResult::Type::NUM, "confirmations", "The number of confirmations"}, {RPCResult::Type::NUM, "confirmations", "The number of confirmations"},
{RPCResult::Type::STR_AMOUNT, "value", "The transaction value in " + CURRENCY_UNIT}, {RPCResult::Type::STR_AMOUNT, "value", "The transaction value in " + CURRENCY_UNIT},
{RPCResult::Type::OBJ, "scriptPubKey", "", {RPCResult::Type::OBJ, "scriptPubKey", "", {
{ {RPCResult::Type::STR_HEX, "asm", ""},
{RPCResult::Type::STR_HEX, "asm", ""}, {RPCResult::Type::STR_HEX, "hex", ""},
{RPCResult::Type::STR_HEX, "hex", ""}, {RPCResult::Type::NUM, "reqSigs", "Number of required signatures"},
{RPCResult::Type::NUM, "reqSigs", "Number of required signatures"}, {RPCResult::Type::STR_HEX, "type", "The type, eg pubkeyhash"},
{RPCResult::Type::STR_HEX, "type", "The type, eg pubkeyhash"}, {RPCResult::Type::ARR, "addresses", "array of bitcoin addresses", {{RPCResult::Type::STR, "address", "bitcoin address"}}},
{RPCResult::Type::ARR, "addresses", "array of bitcoin addresses", }},
{{RPCResult::Type::STR, "address", "bitcoin address"}}}, {RPCResult::Type::BOOL, "coinbase", "Coinbase or not"},
}}, }},
{RPCResult::Type::BOOL, "coinbase", "Coinbase or not"}, },
}}, RPCExamples{
RPCExamples{
"\nGet unspent transactions\n" "\nGet unspent transactions\n"
+ HelpExampleCli("listunspent", "") + + HelpExampleCli("listunspent", "") +
"\nView the details\n" "\nView the details\n"