[Docs] Small updates to getrawtransaction description

pull/15332/head
Amiti Uttarwar 6 years ago
parent a47319dada
commit 47012391ec

@ -254,11 +254,11 @@ in the Low-level Changes section below.
- See the [Mining](#mining) section for changes to `getblocktemplate`. - See the [Mining](#mining) section for changes to `getblocktemplate`.
- The `getrawtransaction` RPC no longer checks the unspent UTXO set for - The `getrawtransaction` RPC & REST endpoints no longer check the
a transaction. The remaining behaviors are as follows: 1. If a unspent UTXO set for a transaction. The remaining behaviors are as
blockhash is provided, check the corresponding block. 2. If no follows: 1. If a blockhash is provided, check the corresponding block.
blockhash is provided, check the mempool. 3. If no blockhash is 2. If no blockhash is provided, check the mempool. 3. If no blockhash
provided but txindex is enabled, also check txindex. is provided but txindex is enabled, also check txindex.
Graphical User Interface (GUI) Graphical User Interface (GUI)
------------------------------ ------------------------------

@ -1,5 +1,5 @@
// Copyright (c) 2010 Satoshi Nakamoto // Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2009-2018 The Bitcoin Core developers // Copyright (c) 2009-2019 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying // Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php. // file COPYING or http://www.opensource.org/licenses/mit-license.php.
@ -66,17 +66,21 @@ static UniValue getrawtransaction(const JSONRPCRequest& request)
{ {
if (request.fHelp || request.params.size() < 1 || request.params.size() > 3) if (request.fHelp || request.params.size() < 1 || request.params.size() > 3)
throw std::runtime_error( throw std::runtime_error(
RPCHelpMan{"getrawtransaction", RPCHelpMan{
"getrawtransaction",
"\nReturn the raw transaction data.\n"
"\nBy default this function only works for mempool transactions. When called with a blockhash\n" "\nBy default this function only works for mempool transactions. When called with a blockhash\n"
"argument, getrawtransaction will return the transaction if the specified block is available and\n" "argument, getrawtransaction will return the transaction if the specified block is available and\n"
"the transaction is found in that block. When called without a blockhash argument, getrawtransaction\n" "the transaction is found in that block. When called without a blockhash argument, getrawtransaction\n"
"will return the transaction if it is in the mempool, or if -txindex is enabled and the transaction\n" "will return the transaction if it is in the mempool, or if -txindex is enabled and the transaction\n"
"is in a block in the blockchain.\n" "is in a block in the blockchain.\n"
"\nReturn the raw transaction data.\n" "\nHint: use getmempoolentry to fetch a specific transaction from the mempool.\n"
"\nIf verbose is 'true', returns an Object with information about 'txid'.\n" "Or use gettransaction for wallet transactions.\n"
"If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.\n"
, "\nIf verbose is 'true', returns an Object with information about 'txid'.\n"
"If verbose is 'false' or omitted, returns a string that is serialized, hex-encoded data for 'txid'.\n",
{ {
{"txid", RPCArg::Type::STR_HEX, /* opt */ false, /* default_val */ "", "The transaction id"}, {"txid", RPCArg::Type::STR_HEX, /* opt */ false, /* default_val */ "", "The transaction id"},
{"verbose", RPCArg::Type::BOOL, /* opt */ true, /* default_val */ "false", "If false, return a string, otherwise return a json object"}, {"verbose", RPCArg::Type::BOOL, /* opt */ true, /* default_val */ "false", "If false, return a string, otherwise return a json object"},

Loading…
Cancel
Save