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