18 #include <boost/test/unit_test.hpp> 60 return transformed_params;
66 std::string strMethod = vArgs[0];
67 vArgs.erase(vArgs.begin());
87 const std::vector<std::pair<std::string, bool>> arg_names{{
"arg1",
false}, {
"arg2",
false}, {
"arg3",
false}, {
"arg4",
false}, {
"arg5",
false}};
90 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"({"arg2": 2, "arg4": 4})"), arg_names).write(), "[null,2,null,4]");
93 BOOST_CHECK_EXCEPTION(TransformParams(
JSON(R
"({"arg2": 2, "arg2": 4})"), arg_names), UniValue, 94 HasJSON(R"({"code":-8,"message":"Parameter arg2 specified multiple times"})")); 97 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"({"arg5": 5, "args": [1, 2], "arg4": 4})"), arg_names).write(), "[1,2,null,4,5]");
100 BOOST_CHECK_EXCEPTION(TransformParams(
JSON(R
"({"arg2": 2, "unknown": 6})"), arg_names), UniValue, 101 HasJSON(R"({"code":-8,"message":"Unknown named parameter unknown"})")); 104 BOOST_CHECK_EXCEPTION(TransformParams(
JSON(R
"({"args": [1,2,3], "arg4": 4, "arg2": 2})"), arg_names), UniValue, 105 HasJSON(R"({"code":-8,"message":"Parameter arg2 specified twice both as positional and named argument"})")); 108 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"({"args": [1,2,3,4,5,6,7,8,9,10]})"), arg_names).write(), "[1,2,3,4,5,6,7,8,9,10]");
109 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"([1,2,3,4,5,6,7,8,9,10])"), arg_names).write(), "[1,2,3,4,5,6,7,8,9,10]");
114 const std::vector<std::pair<std::string, bool>> arg_names{{
"arg1",
false}, {
"arg2",
false}, {
"opt1",
true}, {
"opt2",
true}, {
"options",
false}};
120 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"({"arg1": 1, "arg2": 2, "opt1": 10, "opt2": 20})"), arg_names).write(), R"([1,2,{"opt1":10,"opt2":20}])"); 123 BOOST_CHECK_EQUAL(TransformParams(
JSON(R
"({"arg1": 1, "arg2": 2, "options":{"opt1": 10, "opt2": 20}})"), arg_names).write(), R"([1,2,{"opt1":10,"opt2":20}])"); 126 BOOST_CHECK_EXCEPTION(TransformParams(
JSON(R
"({"arg1": 1, "arg2": 2, "opt1": 10, "options":{"opt1": 10}})"), arg_names), UniValue, 127 HasJSON(R"({"code":-8,"message":"Parameter options conflicts with parameter opt1"})")); 130 BOOST_CHECK_EXCEPTION(TransformParams(
JSON(R
"({"args": [1, 2, {"opt1": 10}], "opt2": 20})"), arg_names), UniValue, 131 HasJSON(R"({"code":-8,"message":"Parameter options specified twice both as positional and named argument"})")); 141 BOOST_CHECK_THROW(
CallRPC(
"getrawtransaction a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed not_int"), std::runtime_error);
153 std::string rawtx =
"0100000001a15d57094aa7a21a28cb20b59aab8fc7d1149a3bdbcddba9c622e4f5f6a99ece010000006c493046022100f93bb0e7d8db7bd46e40132d1f8242026e045f03a0efe71bbb8e3f475e970d790221009337cd7f1f929f00cc6ff01f03729b069a7c21b59b1736ddfee5db5946c5da8c0121033b9b137ee87d5a812d6f506efdd37f0affa7ffc310711c06c7f3e097c9447c52ffffffff0100e1f505000000001976a9140389035a9225b3839e2bbf32d826a1e222031fd888ac00000000";
195 std::string prevout =
196 "[{\"txid\":\"b4cc287e58f87cdae59417329f710f3ecd75a4ee1d2872b7248f50977c8493f3\"," 197 "\"vout\":1,\"scriptPubKey\":\"a914b10c9df5f7edf436c697f02f1efdba4cf399615187\"," 198 "\"redeemScript\":\"512103debedc17b3df2badbcdd86d5feb4562b86fe182e5998abd8bcd4f122c6155b1b21027e940bb73ab8732bfdf7f9216ecefca5b94d6df834e77e108f68e66f126044c052ae\"}]";
199 r =
CallRPC(std::string(
"createrawtransaction ")+prevout+
" "+
200 "{\"3HqAe9LtNBjnsfM4CyYaWTnvCaUYT7v4oZ\":11}");
201 std::string notsigned = r.
get_str();
202 std::string privkey1 =
"\"KzsXybp9jX64P5ekX1KUxRQ79Jht9uzW7LorgwE65i5rWACL6LQe\"";
203 std::string privkey2 =
"\"Kyhdf5LuKTRx4ge69ybABsiUAWjVRK4XGxAKk2FQLp2HjGMy87Z4\"";
204 r =
CallRPC(std::string(
"signrawtransactionwithkey ")+notsigned+
" [] "+prevout);
206 r =
CallRPC(std::string(
"signrawtransactionwithkey ")+notsigned+
" ["+privkey1+
","+privkey2+
"] "+prevout);
207 BOOST_CHECK(r.get_obj().find_value(
"complete").get_bool() ==
true);
212 BOOST_CHECK_NO_THROW(
CallRPC(
"createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"68656c6c6f776f726c64\"}"));
215 BOOST_CHECK_THROW(
CallRPC(
"createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"somedata\":\"68656c6c6f776f726c64\"}"), std::runtime_error);
218 BOOST_CHECK_THROW(
CallRPC(
"createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"12345\"}"), std::runtime_error);
219 BOOST_CHECK_THROW(
CallRPC(
"createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"12345g\"}"), std::runtime_error);
222 BOOST_CHECK_NO_THROW(
CallRPC(
"createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"010203040506070809101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081\"}"));
341 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/24 add 200"))); 342 SetMockTime(now += 2s); 343 const int64_t time_remaining_expected{198}; 344 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 346 o1 = ar[0].get_obj(); 347 adr = o1.find_value("address"); 348 banned_until = o1.find_value("banned_until").getInt<int64_t>(); 349 const int64_t ban_created{o1.find_value("ban_created").getInt<int64_t>()}; 350 const int64_t ban_duration{o1.find_value("ban_duration").getInt<int64_t>()}; 351 const int64_t time_remaining{o1.find_value("time_remaining").getInt<int64_t>()}; 352 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/24"); 353 BOOST_CHECK_EQUAL(banned_until, time_remaining_expected + now.count()); 354 BOOST_CHECK_EQUAL(ban_duration, banned_until - ban_created); 355 BOOST_CHECK_EQUAL(time_remaining, time_remaining_expected); 357 // must throw an exception because 127.0.0.1 is in already banned subnet range 358 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.0.1 add")), std::runtime_error); 360 BOOST_CHECK_NO_THROW(CallRPC(std::string("setban 127.0.0.0/24 remove"))); 361 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 363 BOOST_CHECK_EQUAL(ar.size(), 0U); 365 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/255.255.0.0 add"))); 366 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.1.1 add")), std::runtime_error); 368 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 369 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 371 BOOST_CHECK_EQUAL(ar.size(), 0U); 374 BOOST_CHECK_THROW(r = CallRPC(std::string("setban test add")), std::runtime_error); //invalid IP 377 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban FE80:0000:0000:0000:0202:B3FF:FE1E:8329 add"))); 378 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 380 o1 = ar[0].get_obj(); 381 adr = o1.find_value("address"); 382 BOOST_CHECK_EQUAL(adr.get_str(), "fe80::202:b3ff:fe1e:8329/128"); 384 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 385 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:db8::/ffff:fffc:0:0:0:0:0:0 add"))); 386 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 388 o1 = ar[0].get_obj(); 389 adr = o1.find_value("address"); 390 BOOST_CHECK_EQUAL(adr.get_str(), "2001:db8::/30"); 392 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 393 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128 add"))); 394 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 396 o1 = ar[0].get_obj(); 397 adr = o1.find_value("address"); 398 BOOST_CHECK_EQUAL(adr.get_str(), "2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128"); 401 BOOST_AUTO_TEST_CASE(rpc_convert_values_generatetoaddress) 405 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"})); 406 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101); 407 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"); 409 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"})); 410 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101); 411 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"); 413 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a", "9"})); 414 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1); 415 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"); 416 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9); 418 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU", "9"})); 419 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1); 420 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"); 421 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9); 424 BOOST_AUTO_TEST_CASE(rpc_getblockstats_calculate_percentiles_by_weight) 426 int64_t total_weight = 200; 427 std::vector<std::pair<CAmount, int64_t>> feerates; 428 CAmount result[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 430 for (int64_t i = 0; i < 100; i++) { 431 feerates.emplace_back(1 ,1); 434 for (int64_t i = 0; i < 100; i++) { 435 feerates.emplace_back(2 ,1); 438 CalculatePercentilesByWeight(result, feerates, total_weight); 439 BOOST_CHECK_EQUAL(result[0], 1); 440 BOOST_CHECK_EQUAL(result[1], 1); 441 BOOST_CHECK_EQUAL(result[2], 1); 442 BOOST_CHECK_EQUAL(result[3], 2); 443 BOOST_CHECK_EQUAL(result[4], 2); 445 // Test with more pairs, and two pairs overlapping 2 percentiles. 447 CAmount result2[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 450 feerates.emplace_back(1, 9); 451 feerates.emplace_back(2 , 16); //10th + 25th percentile 452 feerates.emplace_back(4 ,50); //50th + 75th percentile 453 feerates.emplace_back(5 ,10); 454 feerates.emplace_back(9 ,15); // 90th percentile 456 CalculatePercentilesByWeight(result2, feerates, total_weight); 458 BOOST_CHECK_EQUAL(result2[0], 2); 459 BOOST_CHECK_EQUAL(result2[1], 2); 460 BOOST_CHECK_EQUAL(result2[2], 4); 461 BOOST_CHECK_EQUAL(result2[3], 4); 462 BOOST_CHECK_EQUAL(result2[4], 9); 464 // Same test as above, but one of the percentile-overlapping pairs is split in 2. 466 CAmount result3[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 469 feerates.emplace_back(1, 9); 470 feerates.emplace_back(2 , 11); // 10th percentile 471 feerates.emplace_back(2 , 5); // 25th percentile 472 feerates.emplace_back(4 ,50); //50th + 75th percentile 473 feerates.emplace_back(5 ,10); 474 feerates.emplace_back(9 ,15); // 90th percentile 476 CalculatePercentilesByWeight(result3, feerates, total_weight); 478 BOOST_CHECK_EQUAL(result3[0], 2); 479 BOOST_CHECK_EQUAL(result3[1], 2); 480 BOOST_CHECK_EQUAL(result3[2], 4); 481 BOOST_CHECK_EQUAL(result3[3], 4); 482 BOOST_CHECK_EQUAL(result3[4], 9); 484 // Test with one transaction spanning all percentiles. 486 CAmount result4[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 489 feerates.emplace_back(1, 100); 490 feerates.emplace_back(2, 1); 491 feerates.emplace_back(3, 1); 492 feerates.emplace_back(3, 1); 493 feerates.emplace_back(999999, 1); 495 CalculatePercentilesByWeight(result4, feerates, total_weight); 497 for (int64_t i = 0; i < NUM_GETBLOCKSTATS_PERCENTILES; i++) { 498 BOOST_CHECK_EQUAL(result4[i], 1); 502 // Make sure errors are triggered appropriately if parameters have the same names. 503 BOOST_AUTO_TEST_CASE(check_dup_param_names) 505 enum ParamType { POSITIONAL, NAMED, NAMED_ONLY }; 506 auto make_rpc = [](std::vector<std::tuple<std::string, ParamType>> param_names) { 507 std::vector<RPCArg> params; 508 std::vector<RPCArg> options; 509 auto push_options = [&] { if (!options.empty()) params.emplace_back(strprintf("options%i", params.size()), RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "", std::move(options)); }; 510 for (auto& [param_name, param_type] : param_names) { 511 if (param_type == POSITIONAL) { 513 params.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description"); 515 options.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description", RPCArgOptions{.also_positional = param_type == NAMED}); 519 return RPCHelpMan{"method_name", "description", params, RPCResults{}, RPCExamples{""}}; 522 // No errors if parameter names are unique. 523 make_rpc({{"p1", POSITIONAL}, {"p2", POSITIONAL}}); 524 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED}}); 525 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED_ONLY}}); 526 make_rpc({{"p1", NAMED}, {"p2", POSITIONAL}}); 527 make_rpc({{"p1", NAMED}, {"p2", NAMED}}); 528 make_rpc({{"p1", NAMED}, {"p2", NAMED_ONLY}}); 529 make_rpc({{"p1", NAMED_ONLY}, {"p2", POSITIONAL}}); 530 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED}}); 531 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED_ONLY}}); 533 // Error if parameters names are duplicates, unless one parameter is 534 // positional and the other is named and .also_positional is true. 535 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", POSITIONAL}}), NonFatalCheckError); 536 make_rpc({{"p1", POSITIONAL}, {"p1", NAMED}}); 537 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 538 make_rpc({{"p1", NAMED}, {"p1", POSITIONAL}}); 539 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED}}), NonFatalCheckError); 540 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 541 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", POSITIONAL}}), NonFatalCheckError); 542 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED}}), NonFatalCheckError); 543 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 545 // Make sure duplicate aliases are detected too. 546 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p2|p1", NAMED_ONLY}}), NonFatalCheckError); 549 BOOST_AUTO_TEST_CASE(help_example) 551 // test different argument types 552 const RPCArgList& args = {{"foo", "bar"}, {"b", true}, {"n", 1}}; 553 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", args), "> bitcoin-cli -named test foo=bar b=true n=1\n"); 554 BOOST_CHECK_EQUAL(HelpExampleRpcNamed("test", args), "> curl --user myusername --data-binary '{\
"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"foo\":\"bar\",\"b\":true,\"n\":1}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n");
563 obj_value.
pushKV(
"foo",
"bar");
564 obj_value.
pushKV(
"b",
false);
567 BOOST_CHECK_EQUAL(
HelpExampleRpcNamed(
"test", {{
"name", obj_value}}),
"> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"name\":{\"foo\":\"bar\",\"b\":false,\"n\":1}}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n");
575 BOOST_CHECK_EQUAL(
HelpExampleRpcNamed(
"test", {{
"name", arr_value}}),
"> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"name\":[\"bar\",false,1]}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n");
char const * json() noexcept
Template to generate JSON data.
UniValue CallRPC(std::string args)
void push_back(UniValue val)
std::string HelpExampleRpcNamed(const std::string &methodname, const RPCArgList &args)
#define BOOST_CHECK_THROW(stmt, excMatch)
static UniValue ValueFromString(const std::string &str) noexcept
void appendCommand(const std::string &name, const CRPCCommand *pcmd)
Appends a CRPCCommand to the dispatch table.
bool read(std::string_view raw)
UniValue TransformParams(const UniValue ¶ms, std::vector< std::pair< std::string, bool >> arg_names) const
const std::string & get_str() const
const UniValue & get_array() const
std::vector< std::string > SplitString(std::string_view str, char sep)
bool operator()(const UniValue &value) const
HasJSON(std::string json)
UniValue RPCConvertValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert positional arguments to command-specific RPC representation.
UniValue execute(const JSONRPCRequest &request) const
Execute a method.
const UniValue & find_value(std::string_view key) const
void SetRPCWarmupFinished()
static CAmount AmountFromValue(const UniValue &value)
static UniValue CallRPC(BaseRequestHandler *rh, const std::string &strMethod, const std::vector< std::string > &args, const std::optional< std::string > &rpcwallet={})
BOOST_AUTO_TEST_SUITE_END()
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
std::string HelpExampleCliNamed(const std::string &methodname, const RPCArgList &args)
static UniValue JSON(std::string_view json)
void setNumStr(std::string str)
#define BOOST_CHECK_EQUAL(v1, v2)
void pushKV(std::string key, UniValue val)
const UniValue & get_obj() const
BOOST_AUTO_TEST_CASE(rpc_namedparams)
UniValue ValueFromAmount(const CAmount amount)
bool RPCIsInWarmup(std::string *outStatus)
#define BOOST_CHECK_NO_THROW(stmt)
Testing setup that configures a complete environment.
#define BOOST_CHECK(expr)
static constexpr CAmount COIN
The amount of satoshis in one BTC.