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

rpc: disallow boolean verbosity in getorphantxs

Browse source 
Updates ParseVerbosity() to support disallowing
boolean verbosity.  Removes boolean verbosity
for getorphantxs to encourage integer verbosity
usage
This commit is contained in:
tdb3 2024-10-25 12:01:44 -04:00
parent 63f5e6ec79
commit 698f302df8
No known key found for this signature in database
6 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/rpc/blockchain.cpp
View file

@ -766,7 +766,7 @@ static RPCHelpMan getblock()
{
uint256 hash(ParseHashV(request.params[0], "blockhash"));
int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/1)};
int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/1, /*allow_bool=*/true)};
const CBlockIndex* pblockindex;
const CBlockIndex* tip;

1
src/rpc/client.cpp
View file

@ -255,7 +255,6 @@ static const CRPCConvertParam vRPCConvertParams[] =
{ "getrawmempool", 0, "verbose" },
{ "getrawmempool", 1, "mempool_sequence" },
{ "getorphantxs", 0, "verbosity" },
{ "getorphantxs", 0, "verbose" },
{ "estimatesmartfee", 0, "conf_target" },
{ "estimaterawfee", 0, "conf_target" },
{ "estimaterawfee", 1, "threshold" },

4
src/rpc/mempool.cpp
View file

@ -854,7 +854,7 @@ static RPCHelpMan getorphantxs()
"\nShows transactions in the tx orphanage.\n"
"\nEXPERIMENTAL warning: this call may be changed in future releases.\n",
{
{"verbosity|verbose", RPCArg::Type::NUM, RPCArg::Default{0}, "0 for an array of txids (may contain duplicates), 1 for an array of objects with tx details, and 2 for details from (1) and tx hex",
{"verbosity", RPCArg::Type::NUM, RPCArg::Default{0}, "0 for an array of txids (may contain duplicates), 1 for an array of objects with tx details, and 2 for details from (1) and tx hex",
RPCArgOptions{.skip_type_check = true}},
},
{
@ -889,7 +889,7 @@ static RPCHelpMan getorphantxs()
PeerManager& peerman = EnsurePeerman(node);
std::vector<TxOrphanage::OrphanTxBase> orphanage = peerman.GetOrphanTransactions();
int verbosity{ParseVerbosity(request.params[0], /*default_verbosity=*/0)};
int verbosity{ParseVerbosity(request.params[0], /*default_verbosity=*/0, /*allow_bool*/false)};
UniValue ret(UniValue::VARR);

2
src/rpc/rawtransaction.cpp
View file

@ -338,7 +338,7 @@ static RPCHelpMan getrawtransaction()
throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "The genesis block coinbase is not considered an ordinary transaction and cannot be retrieved");
}
int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/0)};
int verbosity{ParseVerbosity(request.params[1], /*default_verbosity=*/0, /*allow_bool=*/true)};
if (!request.params[2].isNull()) {
LOCK(cs_main);

5
src/rpc/util.cpp
View file

@ -81,10 +81,13 @@ void RPCTypeCheckObj(const UniValue& o,
}
}
int ParseVerbosity(const UniValue& arg, int default_verbosity)
int ParseVerbosity(const UniValue& arg, int default_verbosity, bool allow_bool)
{
if (!arg.isNull()) {
if (arg.isBool()) {
if (!allow_bool) {
throw JSONRPCError(RPC_TYPE_ERROR, "Verbosity was boolean but only integer allowed");
}
return arg.get_bool(); // true = 1
} else {
return arg.getInt<int>();

6
src/rpc/util.h
View file

@ -103,11 +103,13 @@ std::vector<unsigned char> ParseHexO(const UniValue& o, std::string_view strKey)
/**
* Parses verbosity from provided UniValue.
*
* @param[in] arg The verbosity argument as a bool (true) or int (0, 1, 2,...)
* @param[in] arg The verbosity argument as an int (0, 1, 2,...) or bool if allow_bool is set to true
* @param[in] default_verbosity The value to return if verbosity argument is null
* @param[in] allow_bool If true, allows arg to be a bool and parses it
* @returns An integer describing the verbosity level (e.g. 0, 1, 2, etc.)
* @throws JSONRPCError if allow_bool is false but arg provided is boolean
*/
int ParseVerbosity(const UniValue& arg, int default_verbosity);
int ParseVerbosity(const UniValue& arg, int default_verbosity, bool allow_bool);
/**
* Validate and return a CAmount from a UniValue number or string.