rpc_tests.cpp
1 // Copyright (c) 2012-present The Bitcoin Core developers 2 // Distributed under the MIT software license, see the accompanying 3 // file COPYING or http://www.opensource.org/licenses/mit-license.php. 4 5 #include <core_io.h> 6 #include <interfaces/chain.h> 7 #include <node/context.h> 8 #include <rpc/blockchain.h> 9 #include <rpc/client.h> 10 #include <rpc/server.h> 11 #include <rpc/util.h> 12 #include <test/util/common.h> 13 #include <test/util/setup_common.h> 14 #include <univalue.h> 15 #include <util/time.h> 16 17 #include <any> 18 #include <string_view> 19 20 #include <boost/test/unit_test.hpp> 21 22 using util::SplitString; 23 24 static UniValue JSON(std::string_view json) 25 { 26 UniValue value; 27 BOOST_CHECK(value.read(json)); 28 return value; 29 } 30 31 class HasJSON 32 { 33 public: 34 explicit HasJSON(std::string json) : m_json(std::move(json)) {} 35 bool operator()(const UniValue& value) const 36 { 37 std::string json{value.write()}; 38 BOOST_CHECK_EQUAL(json, m_json); 39 return json == m_json; 40 }; 41 42 private: 43 const std::string m_json; 44 }; 45 46 class RPCTestingSetup : public TestingSetup 47 { 48 public: 49 UniValue TransformParams(const UniValue& params, std::vector<std::pair<std::string, bool>> arg_names) const; 50 UniValue CallRPC(std::string args); 51 }; 52 53 UniValue RPCTestingSetup::TransformParams(const UniValue& params, std::vector<std::pair<std::string, bool>> arg_names) const 54 { 55 UniValue transformed_params; 56 CRPCTable table; 57 CRPCCommand command{"category", "method", [&](const JSONRPCRequest& request, UniValue&, bool) -> bool { transformed_params = request.params; return true; }, arg_names, /*unique_id=*/0}; 58 table.appendCommand("method", &command); 59 JSONRPCRequest request; 60 request.strMethod = "method"; 61 request.params = params; 62 if (RPCIsInWarmup(nullptr)) SetRPCWarmupFinished(); 63 table.execute(request); 64 return transformed_params; 65 } 66 67 UniValue RPCTestingSetup::CallRPC(std::string args) 68 { 69 std::vector<std::string> vArgs{SplitString(args, ' ')}; 70 std::string strMethod = vArgs[0]; 71 vArgs.erase(vArgs.begin()); 72 JSONRPCRequest request; 73 request.context = &m_node; 74 request.strMethod = strMethod; 75 request.params = RPCConvertValues(strMethod, vArgs); 76 if (RPCIsInWarmup(nullptr)) SetRPCWarmupFinished(); 77 try { 78 UniValue result = tableRPC.execute(request); 79 return result; 80 } 81 catch (const UniValue& objError) { 82 throw std::runtime_error(objError.find_value("message").get_str()); 83 } 84 } 85 86 87 BOOST_FIXTURE_TEST_SUITE(rpc_tests, RPCTestingSetup) 88 89 BOOST_AUTO_TEST_CASE(rpc_namedparams) 90 { 91 const std::vector<std::pair<std::string, bool>> arg_names{{"arg1", false}, {"arg2", false}, {"arg3", false}, {"arg4", false}, {"arg5", false}}; 92 93 // Make sure named arguments are transformed into positional arguments in correct places separated by nulls 94 BOOST_CHECK_EQUAL(TransformParams(JSON(R"({"arg2": 2, "arg4": 4})"), arg_names).write(), "[null,2,null,4]"); 95 96 // Make sure named argument specified multiple times raises an exception 97 BOOST_CHECK_EXCEPTION(TransformParams(JSON(R"({"arg2": 2, "arg2": 4})"), arg_names), UniValue, 98 HasJSON(R"({"code":-8,"message":"Parameter arg2 specified multiple times"})")); 99 100 // Make sure named and positional arguments can be combined. 101 BOOST_CHECK_EQUAL(TransformParams(JSON(R"({"arg5": 5, "args": [1, 2], "arg4": 4})"), arg_names).write(), "[1,2,null,4,5]"); 102 103 // Make sure a unknown named argument raises an exception 104 BOOST_CHECK_EXCEPTION(TransformParams(JSON(R"({"arg2": 2, "unknown": 6})"), arg_names), UniValue, 105 HasJSON(R"({"code":-8,"message":"Unknown named parameter unknown"})")); 106 107 // Make sure an overlap between a named argument and positional argument raises an exception 108 BOOST_CHECK_EXCEPTION(TransformParams(JSON(R"({"args": [1,2,3], "arg4": 4, "arg2": 2})"), arg_names), UniValue, 109 HasJSON(R"({"code":-8,"message":"Parameter arg2 specified twice both as positional and named argument"})")); 110 111 // Make sure extra positional arguments can be passed through to the method implementation, as long as they don't overlap with named arguments. 112 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]"); 113 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 } 115 116 BOOST_AUTO_TEST_CASE(rpc_namedonlyparams) 117 { 118 const std::vector<std::pair<std::string, bool>> arg_names{{"arg1", false}, {"arg2", false}, {"opt1", true}, {"opt2", true}, {"options", false}}; 119 120 // Make sure optional parameters are really optional. 121 BOOST_CHECK_EQUAL(TransformParams(JSON(R"({"arg1": 1, "arg2": 2})"), arg_names).write(), "[1,2]"); 122 123 // Make sure named-only parameters are passed as options. 124 BOOST_CHECK_EQUAL(TransformParams(JSON(R"({"arg1": 1, "arg2": 2, "opt1": 10, "opt2": 20})"), arg_names).write(), R"([1,2,{"opt1":10,"opt2":20}])"); 125 126 // Make sure options can be passed directly. 127 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}])"); 128 129 // Make sure options and named parameters conflict. 130 BOOST_CHECK_EXCEPTION(TransformParams(JSON(R"({"arg1": 1, "arg2": 2, "opt1": 10, "options":{"opt1": 10}})"), arg_names), UniValue, 131 HasJSON(R"({"code":-8,"message":"Parameter options conflicts with parameter opt1"})")); 132 133 // Make sure options object specified through args array conflicts. 134 BOOST_CHECK_EXCEPTION(TransformParams(JSON(R"({"args": [1, 2, {"opt1": 10}], "opt2": 20})"), arg_names), UniValue, 135 HasJSON(R"({"code":-8,"message":"Parameter options specified twice both as positional and named argument"})")); 136 } 137 138 BOOST_AUTO_TEST_CASE(rpc_rawparams) 139 { 140 // Test raw transaction API argument handling 141 UniValue r; 142 143 BOOST_CHECK_THROW(CallRPC("getrawtransaction"), std::runtime_error); 144 BOOST_CHECK_THROW(CallRPC("getrawtransaction not_hex"), std::runtime_error); 145 BOOST_CHECK_THROW(CallRPC("getrawtransaction a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed not_int"), std::runtime_error); 146 147 BOOST_CHECK_THROW(CallRPC("createrawtransaction"), std::runtime_error); 148 BOOST_CHECK_THROW(CallRPC("createrawtransaction null null"), std::runtime_error); 149 BOOST_CHECK_THROW(CallRPC("createrawtransaction not_array"), std::runtime_error); 150 BOOST_CHECK_THROW(CallRPC("createrawtransaction {} {}"), std::runtime_error); 151 BOOST_CHECK_NO_THROW(CallRPC("createrawtransaction [] {}")); 152 BOOST_CHECK_THROW(CallRPC("createrawtransaction [] {} extra"), std::runtime_error); 153 154 BOOST_CHECK_THROW(CallRPC("decoderawtransaction"), std::runtime_error); 155 BOOST_CHECK_THROW(CallRPC("decoderawtransaction null"), std::runtime_error); 156 BOOST_CHECK_THROW(CallRPC("decoderawtransaction DEADBEEF"), std::runtime_error); 157 std::string rawtx = "0100000001a15d57094aa7a21a28cb20b59aab8fc7d1149a3bdbcddba9c622e4f5f6a99ece010000006c493046022100f93bb0e7d8db7bd46e40132d1f8242026e045f03a0efe71bbb8e3f475e970d790221009337cd7f1f929f00cc6ff01f03729b069a7c21b59b1736ddfee5db5946c5da8c0121033b9b137ee87d5a812d6f506efdd37f0affa7ffc310711c06c7f3e097c9447c52ffffffff0100e1f505000000001976a9140389035a9225b3839e2bbf32d826a1e222031fd888ac00000000"; 158 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("decoderawtransaction ")+rawtx)); 159 BOOST_CHECK_EQUAL(r.get_obj().find_value("size").getInt<int>(), 193); 160 BOOST_CHECK_EQUAL(r.get_obj().find_value("version").getInt<int>(), 1); 161 BOOST_CHECK_EQUAL(r.get_obj().find_value("locktime").getInt<int>(), 0); 162 BOOST_CHECK_THROW(CallRPC(std::string("decoderawtransaction ")+rawtx+" extra"), std::runtime_error); 163 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("decoderawtransaction ")+rawtx+" false")); 164 BOOST_CHECK_THROW(r = CallRPC(std::string("decoderawtransaction ")+rawtx+" false extra"), std::runtime_error); 165 166 // Only check failure cases for sendrawtransaction, there's no network to send to... 167 BOOST_CHECK_THROW(CallRPC("sendrawtransaction"), std::runtime_error); 168 BOOST_CHECK_THROW(CallRPC("sendrawtransaction null"), std::runtime_error); 169 BOOST_CHECK_THROW(CallRPC("sendrawtransaction DEADBEEF"), std::runtime_error); 170 BOOST_CHECK_THROW(CallRPC(std::string("sendrawtransaction ")+rawtx+" extra"), std::runtime_error); 171 } 172 173 BOOST_AUTO_TEST_CASE(rpc_togglenetwork) 174 { 175 UniValue r; 176 177 r = CallRPC("getnetworkinfo"); 178 bool netState = r.get_obj().find_value("networkactive").get_bool(); 179 BOOST_CHECK_EQUAL(netState, true); 180 181 BOOST_CHECK_NO_THROW(CallRPC("setnetworkactive false")); 182 r = CallRPC("getnetworkinfo"); 183 int numConnection = r.get_obj().find_value("connections").getInt<int>(); 184 BOOST_CHECK_EQUAL(numConnection, 0); 185 186 netState = r.get_obj().find_value("networkactive").get_bool(); 187 BOOST_CHECK_EQUAL(netState, false); 188 189 BOOST_CHECK_NO_THROW(CallRPC("setnetworkactive true")); 190 r = CallRPC("getnetworkinfo"); 191 netState = r.get_obj().find_value("networkactive").get_bool(); 192 BOOST_CHECK_EQUAL(netState, true); 193 } 194 195 BOOST_AUTO_TEST_CASE(rpc_rawsign) 196 { 197 UniValue r; 198 // input is a 1-of-2 multisig (so is output): 199 std::string prevout = 200 "[{\"txid\":\"b4cc287e58f87cdae59417329f710f3ecd75a4ee1d2872b7248f50977c8493f3\"," 201 "\"vout\":1,\"scriptPubKey\":\"a914b10c9df5f7edf436c697f02f1efdba4cf399615187\"," 202 "\"redeemScript\":\"512103debedc17b3df2badbcdd86d5feb4562b86fe182e5998abd8bcd4f122c6155b1b21027e940bb73ab8732bfdf7f9216ecefca5b94d6df834e77e108f68e66f126044c052ae\"}]"; 203 r = CallRPC(std::string("createrawtransaction ")+prevout+" "+ 204 "{\"3HqAe9LtNBjnsfM4CyYaWTnvCaUYT7v4oZ\":11}"); 205 std::string notsigned = r.get_str(); 206 std::string privkey1 = "\"KzsXybp9jX64P5ekX1KUxRQ79Jht9uzW7LorgwE65i5rWACL6LQe\""; 207 std::string privkey2 = "\"Kyhdf5LuKTRx4ge69ybABsiUAWjVRK4XGxAKk2FQLp2HjGMy87Z4\""; 208 r = CallRPC(std::string("signrawtransactionwithkey ")+notsigned+" [] "+prevout); 209 BOOST_CHECK(r.get_obj().find_value("complete").get_bool() == false); 210 r = CallRPC(std::string("signrawtransactionwithkey ")+notsigned+" ["+privkey1+","+privkey2+"] "+prevout); 211 BOOST_CHECK(r.get_obj().find_value("complete").get_bool() == true); 212 } 213 214 BOOST_AUTO_TEST_CASE(rpc_createraw_op_return) 215 { 216 BOOST_CHECK_NO_THROW(CallRPC("createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"68656c6c6f776f726c64\"}")); 217 218 // Key not "data" (bad address) 219 BOOST_CHECK_THROW(CallRPC("createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"somedata\":\"68656c6c6f776f726c64\"}"), std::runtime_error); 220 221 // Bad hex encoding of data output 222 BOOST_CHECK_THROW(CallRPC("createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"12345\"}"), std::runtime_error); 223 BOOST_CHECK_THROW(CallRPC("createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"12345g\"}"), std::runtime_error); 224 225 // Data 81 bytes long 226 BOOST_CHECK_NO_THROW(CallRPC("createrawtransaction [{\"txid\":\"a3b807410df0b60fcb9736768df5823938b2f838694939ba45f3c0a1bff150ed\",\"vout\":0}] {\"data\":\"010203040506070809101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081\"}")); 227 } 228 229 BOOST_AUTO_TEST_CASE(rpc_format_monetary_values) 230 { 231 BOOST_CHECK(ValueFromAmount(0LL).write() == "0.00000000"); 232 BOOST_CHECK(ValueFromAmount(1LL).write() == "0.00000001"); 233 BOOST_CHECK(ValueFromAmount(17622195LL).write() == "0.17622195"); 234 BOOST_CHECK(ValueFromAmount(50000000LL).write() == "0.50000000"); 235 BOOST_CHECK(ValueFromAmount(89898989LL).write() == "0.89898989"); 236 BOOST_CHECK(ValueFromAmount(100000000LL).write() == "1.00000000"); 237 BOOST_CHECK(ValueFromAmount(2099999999999990LL).write() == "20999999.99999990"); 238 BOOST_CHECK(ValueFromAmount(2099999999999999LL).write() == "20999999.99999999"); 239 240 BOOST_CHECK_EQUAL(ValueFromAmount(0).write(), "0.00000000"); 241 BOOST_CHECK_EQUAL(ValueFromAmount((COIN/10000)*123456789).write(), "12345.67890000"); 242 BOOST_CHECK_EQUAL(ValueFromAmount(-COIN).write(), "-1.00000000"); 243 BOOST_CHECK_EQUAL(ValueFromAmount(-COIN/10).write(), "-0.10000000"); 244 245 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*100000000).write(), "100000000.00000000"); 246 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*10000000).write(), "10000000.00000000"); 247 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*1000000).write(), "1000000.00000000"); 248 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*100000).write(), "100000.00000000"); 249 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*10000).write(), "10000.00000000"); 250 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*1000).write(), "1000.00000000"); 251 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*100).write(), "100.00000000"); 252 BOOST_CHECK_EQUAL(ValueFromAmount(COIN*10).write(), "10.00000000"); 253 BOOST_CHECK_EQUAL(ValueFromAmount(COIN).write(), "1.00000000"); 254 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/10).write(), "0.10000000"); 255 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/100).write(), "0.01000000"); 256 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/1000).write(), "0.00100000"); 257 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/10000).write(), "0.00010000"); 258 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/100000).write(), "0.00001000"); 259 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/1000000).write(), "0.00000100"); 260 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/10000000).write(), "0.00000010"); 261 BOOST_CHECK_EQUAL(ValueFromAmount(COIN/100000000).write(), "0.00000001"); 262 263 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::max()).write(), "92233720368.54775807"); 264 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::max() - 1).write(), "92233720368.54775806"); 265 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::max() - 2).write(), "92233720368.54775805"); 266 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::max() - 3).write(), "92233720368.54775804"); 267 // ... 268 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::min() + 3).write(), "-92233720368.54775805"); 269 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::min() + 2).write(), "-92233720368.54775806"); 270 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::min() + 1).write(), "-92233720368.54775807"); 271 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<CAmount>::min()).write(), "-92233720368.54775808"); 272 } 273 274 static UniValue ValueFromString(const std::string& str) noexcept 275 { 276 UniValue value; 277 value.setNumStr(str); 278 return value; 279 } 280 281 BOOST_AUTO_TEST_CASE(rpc_parse_monetary_values) 282 { 283 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("-0.00000001")), UniValue); 284 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0")), 0LL); 285 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000000")), 0LL); 286 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000001")), 1LL); 287 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.17622195")), 17622195LL); 288 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.5")), 50000000LL); 289 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.50000000")), 50000000LL); 290 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.89898989")), 89898989LL); 291 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("1.00000000")), 100000000LL); 292 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("20999999.9999999")), 2099999999999990LL); 293 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("20999999.99999999")), 2099999999999999LL); 294 295 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("1e-8")), COIN/100000000); 296 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.1e-7")), COIN/100000000); 297 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.01e-6")), COIN/100000000); 298 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000000000000000000000000000000000001e+30")), 1); 299 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.0000000000000000000000000000000000000000000000000000000000000000000000000001e+68")), COIN/100000000); 300 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("10000000000000000000000000000000000000000000000000000000000000000e-64")), COIN); 301 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000e64")), COIN); 302 303 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("1e-9")), UniValue); //should fail 304 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("0.000000019")), UniValue); //should fail 305 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000001000000")), 1LL); //should pass, cut trailing 0 306 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("19e-9")), UniValue); //should fail 307 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.19e-6")), 19); //should pass, leading 0 is present 308 BOOST_CHECK_EXCEPTION(AmountFromValue(".19e-6"), UniValue, HasJSON(R"({"code":-3,"message":"Invalid amount"})")); //should fail, no leading 0 309 310 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("92233720368.54775808")), UniValue); //overflow error 311 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("1e+11")), UniValue); //overflow error 312 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("1e11")), UniValue); //overflow error signless 313 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("93e+9")), UniValue); //overflow error 314 } 315 316 BOOST_AUTO_TEST_CASE(rpc_ban) 317 { 318 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 319 320 UniValue r; 321 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0 add"))); 322 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.0.0:8334")), std::runtime_error); //portnumber for setban not allowed 323 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 324 UniValue ar = r.get_array(); 325 UniValue o1 = ar[0].get_obj(); 326 UniValue adr = o1.find_value("address"); 327 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/32"); 328 BOOST_CHECK_NO_THROW(CallRPC(std::string("setban 127.0.0.0 remove"))); 329 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 330 ar = r.get_array(); 331 BOOST_CHECK_EQUAL(ar.size(), 0U); 332 333 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/24 add 9907731200 true"))); 334 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 335 ar = r.get_array(); 336 o1 = ar[0].get_obj(); 337 adr = o1.find_value("address"); 338 int64_t banned_until{o1.find_value("banned_until").getInt<int64_t>()}; 339 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/24"); 340 BOOST_CHECK_EQUAL(banned_until, 9907731200); // absolute time check 341 342 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 343 344 auto now = 10'000s; 345 SetMockTime(now); 346 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/24 add 200"))); 347 SetMockTime(now += 2s); 348 const int64_t time_remaining_expected{198}; 349 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 350 ar = r.get_array(); 351 o1 = ar[0].get_obj(); 352 adr = o1.find_value("address"); 353 banned_until = o1.find_value("banned_until").getInt<int64_t>(); 354 const int64_t ban_created{o1.find_value("ban_created").getInt<int64_t>()}; 355 const int64_t ban_duration{o1.find_value("ban_duration").getInt<int64_t>()}; 356 const int64_t time_remaining{o1.find_value("time_remaining").getInt<int64_t>()}; 357 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/24"); 358 BOOST_CHECK_EQUAL(banned_until, time_remaining_expected + now.count()); 359 BOOST_CHECK_EQUAL(ban_duration, banned_until - ban_created); 360 BOOST_CHECK_EQUAL(time_remaining, time_remaining_expected); 361 362 // must throw an exception because 127.0.0.1 is in already banned subnet range 363 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.0.1 add")), std::runtime_error); 364 365 BOOST_CHECK_NO_THROW(CallRPC(std::string("setban 127.0.0.0/24 remove"))); 366 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 367 ar = r.get_array(); 368 BOOST_CHECK_EQUAL(ar.size(), 0U); 369 370 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/255.255.0.0 add"))); 371 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.1.1 add")), std::runtime_error); 372 373 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 374 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 375 ar = r.get_array(); 376 BOOST_CHECK_EQUAL(ar.size(), 0U); 377 378 379 BOOST_CHECK_THROW(r = CallRPC(std::string("setban test add")), std::runtime_error); //invalid IP 380 381 //IPv6 tests 382 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban FE80:0000:0000:0000:0202:B3FF:FE1E:8329 add"))); 383 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 384 ar = r.get_array(); 385 o1 = ar[0].get_obj(); 386 adr = o1.find_value("address"); 387 BOOST_CHECK_EQUAL(adr.get_str(), "fe80::202:b3ff:fe1e:8329/128"); 388 389 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 390 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:db8::/ffff:fffc:0:0:0:0:0:0 add"))); 391 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 392 ar = r.get_array(); 393 o1 = ar[0].get_obj(); 394 adr = o1.find_value("address"); 395 BOOST_CHECK_EQUAL(adr.get_str(), "2001:db8::/30"); 396 397 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned"))); 398 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128 add"))); 399 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned"))); 400 ar = r.get_array(); 401 o1 = ar[0].get_obj(); 402 adr = o1.find_value("address"); 403 BOOST_CHECK_EQUAL(adr.get_str(), "2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128"); 404 } 405 406 BOOST_AUTO_TEST_CASE(rpc_convert_values_generatetoaddress) 407 { 408 UniValue result; 409 410 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"})); 411 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101); 412 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"); 413 414 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"})); 415 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101); 416 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"); 417 418 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a", "9"})); 419 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1); 420 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"); 421 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9); 422 423 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU", "9"})); 424 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1); 425 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"); 426 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9); 427 } 428 429 BOOST_AUTO_TEST_CASE(rpc_getblockstats_calculate_percentiles_by_weight) 430 { 431 int64_t total_weight = 200; 432 std::vector<std::pair<CAmount, int64_t>> feerates; 433 feerates.reserve(200); 434 CAmount result[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 435 436 for (int64_t i = 0; i < 100; i++) { 437 feerates.emplace_back(1 ,1); 438 } 439 440 for (int64_t i = 0; i < 100; i++) { 441 feerates.emplace_back(2 ,1); 442 } 443 444 CalculatePercentilesByWeight(result, feerates, total_weight); 445 BOOST_CHECK_EQUAL(result[0], 1); 446 BOOST_CHECK_EQUAL(result[1], 1); 447 BOOST_CHECK_EQUAL(result[2], 1); 448 BOOST_CHECK_EQUAL(result[3], 2); 449 BOOST_CHECK_EQUAL(result[4], 2); 450 451 // Test with more pairs, and two pairs overlapping 2 percentiles. 452 total_weight = 100; 453 CAmount result2[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 454 feerates.clear(); 455 456 feerates.emplace_back(1, 9); 457 feerates.emplace_back(2 , 16); //10th + 25th percentile 458 feerates.emplace_back(4 ,50); //50th + 75th percentile 459 feerates.emplace_back(5 ,10); 460 feerates.emplace_back(9 ,15); // 90th percentile 461 462 CalculatePercentilesByWeight(result2, feerates, total_weight); 463 464 BOOST_CHECK_EQUAL(result2[0], 2); 465 BOOST_CHECK_EQUAL(result2[1], 2); 466 BOOST_CHECK_EQUAL(result2[2], 4); 467 BOOST_CHECK_EQUAL(result2[3], 4); 468 BOOST_CHECK_EQUAL(result2[4], 9); 469 470 // Same test as above, but one of the percentile-overlapping pairs is split in 2. 471 total_weight = 100; 472 CAmount result3[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 473 feerates.clear(); 474 475 feerates.emplace_back(1, 9); 476 feerates.emplace_back(2 , 11); // 10th percentile 477 feerates.emplace_back(2 , 5); // 25th percentile 478 feerates.emplace_back(4 ,50); //50th + 75th percentile 479 feerates.emplace_back(5 ,10); 480 feerates.emplace_back(9 ,15); // 90th percentile 481 482 CalculatePercentilesByWeight(result3, feerates, total_weight); 483 484 BOOST_CHECK_EQUAL(result3[0], 2); 485 BOOST_CHECK_EQUAL(result3[1], 2); 486 BOOST_CHECK_EQUAL(result3[2], 4); 487 BOOST_CHECK_EQUAL(result3[3], 4); 488 BOOST_CHECK_EQUAL(result3[4], 9); 489 490 // Test with one transaction spanning all percentiles. 491 total_weight = 104; 492 CAmount result4[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 }; 493 feerates.clear(); 494 495 feerates.emplace_back(1, 100); 496 feerates.emplace_back(2, 1); 497 feerates.emplace_back(3, 1); 498 feerates.emplace_back(3, 1); 499 feerates.emplace_back(999999, 1); 500 501 CalculatePercentilesByWeight(result4, feerates, total_weight); 502 503 for (int64_t i = 0; i < NUM_GETBLOCKSTATS_PERCENTILES; i++) { 504 BOOST_CHECK_EQUAL(result4[i], 1); 505 } 506 } 507 508 // Make sure errors are triggered appropriately if parameters have the same names. 509 BOOST_AUTO_TEST_CASE(check_dup_param_names) 510 { 511 enum ParamType { POSITIONAL, NAMED, NAMED_ONLY }; 512 auto make_rpc = [](std::vector<std::tuple<std::string, ParamType>> param_names) { 513 std::vector<RPCArg> params; 514 std::vector<RPCArg> options; 515 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)); }; 516 for (auto& [param_name, param_type] : param_names) { 517 if (param_type == POSITIONAL) { 518 push_options(); 519 params.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description"); 520 } else { 521 options.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description", RPCArgOptions{.also_positional = param_type == NAMED}); 522 } 523 } 524 push_options(); 525 return RPCMethod{"method_name", "description", params, RPCResults{}, RPCExamples{""}}; 526 }; 527 528 // No errors if parameter names are unique. 529 make_rpc({{"p1", POSITIONAL}, {"p2", POSITIONAL}}); 530 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED}}); 531 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED_ONLY}}); 532 make_rpc({{"p1", NAMED}, {"p2", POSITIONAL}}); 533 make_rpc({{"p1", NAMED}, {"p2", NAMED}}); 534 make_rpc({{"p1", NAMED}, {"p2", NAMED_ONLY}}); 535 make_rpc({{"p1", NAMED_ONLY}, {"p2", POSITIONAL}}); 536 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED}}); 537 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED_ONLY}}); 538 539 { 540 test_only_CheckFailuresAreExceptionsNotAborts mock_checks{}; 541 // Error if parameter names are duplicates, unless one parameter is 542 // positional and the other is named and .also_positional is true. 543 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", POSITIONAL}}), NonFatalCheckError); 544 make_rpc({{"p1", POSITIONAL}, {"p1", NAMED}}); 545 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 546 make_rpc({{"p1", NAMED}, {"p1", POSITIONAL}}); 547 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED}}), NonFatalCheckError); 548 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 549 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", POSITIONAL}}), NonFatalCheckError); 550 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED}}), NonFatalCheckError); 551 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED_ONLY}}), NonFatalCheckError); 552 553 // Make sure duplicate aliases are detected too. 554 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p2|p1", NAMED_ONLY}}), NonFatalCheckError); 555 } 556 } 557 558 BOOST_AUTO_TEST_CASE(help_example) 559 { 560 // test different argument types 561 const RPCArgList& args = {{"foo", "bar"}, {"b", true}, {"n", 1}}; 562 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", args), "> bitcoin-cli -named test foo=bar b=true n=1\n"); 563 BOOST_CHECK_EQUAL(HelpExampleRpcNamed("test", args), "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"foo\":\"bar\",\"b\":true,\"n\":1}}' -H 'content-type: application/json' http://127.0.0.1:8332/\n"); 564 565 // test shell escape 566 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b'ar"}}), "> bitcoin-cli -named test foo='b'''ar'\n"); 567 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b\"ar"}}), "> bitcoin-cli -named test foo='b\"ar'\n"); 568 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b ar"}}), "> bitcoin-cli -named test foo='b ar'\n"); 569 570 // test object params 571 UniValue obj_value(UniValue::VOBJ); 572 obj_value.pushKV("foo", "bar"); 573 obj_value.pushKV("b", false); 574 obj_value.pushKV("n", 1); 575 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"name", obj_value}}), "> bitcoin-cli -named test name='{\"foo\":\"bar\",\"b\":false,\"n\":1}'\n"); 576 BOOST_CHECK_EQUAL(HelpExampleRpcNamed("test", {{"name", obj_value}}), "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"name\":{\"foo\":\"bar\",\"b\":false,\"n\":1}}}' -H 'content-type: application/json' http://127.0.0.1:8332/\n"); 577 578 // test array params 579 UniValue arr_value(UniValue::VARR); 580 arr_value.push_back("bar"); 581 arr_value.push_back(false); 582 arr_value.push_back(1); 583 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"name", arr_value}}), "> bitcoin-cli -named test name='[\"bar\",false,1]'\n"); 584 BOOST_CHECK_EQUAL(HelpExampleRpcNamed("test", {{"name", arr_value}}), "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", \"method\": \"test\", \"params\": {\"name\":[\"bar\",false,1]}}' -H 'content-type: application/json' http://127.0.0.1:8332/\n"); 585 586 // test types don't matter for shell 587 BOOST_CHECK_EQUAL(HelpExampleCliNamed("foo", {{"arg", true}}), HelpExampleCliNamed("foo", {{"arg", "true"}})); 588 589 // test types matter for Rpc 590 BOOST_CHECK_NE(HelpExampleRpcNamed("foo", {{"arg", true}}), HelpExampleRpcNamed("foo", {{"arg", "true"}})); 591 } 592 593 static void CheckRpc(const std::vector<RPCArg>& params, const UniValue& args, RPCMethod::RPCMethodImpl test_impl) 594 { 595 auto null_result{RPCResult{RPCResult::Type::NONE, "", "None"}}; 596 const RPCMethod rpc{"dummy", "dummy description", params, null_result, RPCExamples{""}, test_impl}; 597 JSONRPCRequest req; 598 req.params = args; 599 600 rpc.HandleRequest(req); 601 } 602 603 BOOST_AUTO_TEST_CASE(rpc_arg_helper) 604 { 605 constexpr bool DEFAULT_BOOL = true; 606 constexpr auto DEFAULT_STRING = "default"; 607 constexpr uint64_t DEFAULT_UINT64_T = 3; 608 609 //! Parameters with which the RPCMethod is instantiated 610 const std::vector<RPCArg> params{ 611 // Required arg 612 {"req_int", RPCArg::Type::NUM, RPCArg::Optional::NO, ""}, 613 {"req_str", RPCArg::Type::STR, RPCArg::Optional::NO, ""}, 614 // Default arg 615 {"def_uint64_t", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_UINT64_T}, ""}, 616 {"def_string", RPCArg::Type::STR, RPCArg::Default{DEFAULT_STRING}, ""}, 617 {"def_bool", RPCArg::Type::BOOL, RPCArg::Default{DEFAULT_BOOL}, ""}, 618 // Optional arg without default 619 {"opt_double", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, ""}, 620 {"opt_string", RPCArg::Type::STR, RPCArg::Optional::OMITTED, ""} 621 }; 622 623 //! Check that `self.Arg` returns the same value as the `request.params` accessors 624 RPCMethod::RPCMethodImpl check_positional = [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue { 625 BOOST_CHECK_EQUAL(self.Arg<int>("req_int"), request.params[0].getInt<int>()); 626 BOOST_CHECK_EQUAL(self.Arg<std::string_view>("req_str"), request.params[1].get_str()); 627 BOOST_CHECK_EQUAL(self.Arg<uint64_t>("def_uint64_t"), request.params[2].isNull() ? DEFAULT_UINT64_T : request.params[2].getInt<uint64_t>()); 628 BOOST_CHECK_EQUAL(self.Arg<std::string_view>("def_string"), request.params[3].isNull() ? DEFAULT_STRING : request.params[3].get_str()); 629 BOOST_CHECK_EQUAL(self.Arg<bool>("def_bool"), request.params[4].isNull() ? DEFAULT_BOOL : request.params[4].get_bool()); 630 if (!request.params[5].isNull()) { 631 BOOST_CHECK_EQUAL(self.MaybeArg<double>("opt_double").value(), request.params[5].get_real()); 632 } else { 633 BOOST_CHECK(!self.MaybeArg<double>("opt_double")); 634 } 635 if (!request.params[6].isNull()) { 636 BOOST_CHECK_EQUAL(self.MaybeArg<std::string_view>("opt_string"), request.params[6].get_str()); 637 } else { 638 BOOST_CHECK(!self.MaybeArg<std::string_view>("opt_string")); 639 } 640 return UniValue{}; 641 }; 642 CheckRpc(params, UniValue{JSON(R"([5, "hello", null, null, null, null, null])")}, check_positional); 643 CheckRpc(params, UniValue{JSON(R"([5, "hello", 4, "test", true, 1.23, "world"])")}, check_positional); 644 } 645 646 BOOST_AUTO_TEST_SUITE_END()