rpc_tests.cpp raw
1 // Copyright (c) 2012-2022 The Limenka 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()};
36 BOOST_CHECK_EQUAL(json, m_json);
37 return json == m_json;
38 };
39
40 private:
41 const std::string m_json;
42 };
43
44 class RPCTestingSetup : public TestingSetup
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
65 UniValue RPCTestingSetup::CallRPC(std::string args)
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":"Cannot specify both 'options' and named parameter opt2"})"));
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
193 BOOST_AUTO_TEST_CASE(rpc_rawsign)
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<int64_t>::max()).write(), "92233720368.54775807");
262 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::max() - 1).write(), "92233720368.54775806");
263 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::max() - 2).write(), "92233720368.54775805");
264 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::max() - 3).write(), "92233720368.54775804");
265 // ...
266 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::min() + 3).write(), "-92233720368.54775805");
267 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::min() + 2).write(), "-92233720368.54775806");
268 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::min() + 1).write(), "-92233720368.54775807");
269 BOOST_CHECK_EQUAL(ValueFromAmount(std::numeric_limits<int64_t>::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 {
281 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("-0.00000001")), UniValue);
282 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0")), 0LL);
283 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000000")), 0LL);
284 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.00000001")), 1LL);
285 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.17622195")), 17622195LL);
286 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("0.5")), 50000000LL);
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
293 BOOST_CHECK_EQUAL(AmountFromValue(ValueFromString("1e-8")), COIN/100000000);
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
301 BOOST_CHECK_THROW(AmountFromValue(ValueFromString("1e-9")), UniValue); //should fail
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
314 BOOST_AUTO_TEST_CASE(rpc_parse_fee_rate_values)
315 {
316 // Test ValueFromFeeRate() and CFeeRate()
317 // ...using default CFeeRate constructor
318 BOOST_CHECK_EQUAL(ValueFromFeeRate(CFeeRate(AmountFromValue(0.00001234))).get_real(), 1.234);
319 BOOST_CHECK_EQUAL(ValueFromFeeRate(CFeeRate(AmountFromValue(0.1234))).get_real(), 12340.000);
320 BOOST_CHECK_EQUAL(ValueFromFeeRate(CFeeRate(AmountFromValue(1234))).get_real(), 123400000.000);
321 // ...using CFeeRate constructor with bytes 1000
322 BOOST_CHECK_EQUAL(ValueFromFeeRate(CFeeRate(AmountFromValue(0.00001234), 1000)).get_real(), 1.234);
323 }
324
325 BOOST_AUTO_TEST_CASE(rpc_ban)
326 {
327 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned")));
328
329 UniValue r;
330 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0 add")));
331 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.0.0:8334")), std::runtime_error); //portnumber for setban not allowed
332 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
333 UniValue ar = r.get_array();
334 UniValue o1 = ar[0].get_obj();
335 UniValue adr = o1.find_value("address");
336 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/32");
337 BOOST_CHECK_NO_THROW(CallRPC(std::string("setban 127.0.0.0 remove")));
338 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
339 ar = r.get_array();
340 BOOST_CHECK_EQUAL(ar.size(), 0U);
341
342 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/24 add 9907731200 true")));
343 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
344 ar = r.get_array();
345 o1 = ar[0].get_obj();
346 adr = o1.find_value("address");
347 int64_t banned_until{o1.find_value("banned_until").getInt<int64_t>()};
348 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/24");
349 BOOST_CHECK_EQUAL(banned_until, 9907731200); // absolute time check
350
351 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned")));
352
353 auto now = 10'000s;
354 SetMockTime(now);
355 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/24 add 200")));
356 SetMockTime(now += 2s);
357 const int64_t time_remaining_expected{198};
358 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
359 ar = r.get_array();
360 o1 = ar[0].get_obj();
361 adr = o1.find_value("address");
362 banned_until = o1.find_value("banned_until").getInt<int64_t>();
363 const int64_t ban_created{o1.find_value("ban_created").getInt<int64_t>()};
364 const int64_t ban_duration{o1.find_value("ban_duration").getInt<int64_t>()};
365 const int64_t time_remaining{o1.find_value("time_remaining").getInt<int64_t>()};
366 BOOST_CHECK_EQUAL(adr.get_str(), "127.0.0.0/24");
367 BOOST_CHECK_EQUAL(banned_until, time_remaining_expected + now.count());
368 BOOST_CHECK_EQUAL(ban_duration, banned_until - ban_created);
369 BOOST_CHECK_EQUAL(time_remaining, time_remaining_expected);
370
371 // must throw an exception because 127.0.0.1 is in already banned subnet range
372 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.0.1 add")), std::runtime_error);
373
374 BOOST_CHECK_NO_THROW(CallRPC(std::string("setban 127.0.0.0/24 remove")));
375 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
376 ar = r.get_array();
377 BOOST_CHECK_EQUAL(ar.size(), 0U);
378
379 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 127.0.0.0/255.255.0.0 add")));
380 BOOST_CHECK_THROW(r = CallRPC(std::string("setban 127.0.1.1 add")), std::runtime_error);
381
382 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned")));
383 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
384 ar = r.get_array();
385 BOOST_CHECK_EQUAL(ar.size(), 0U);
386
387
388 BOOST_CHECK_THROW(r = CallRPC(std::string("setban test add")), std::runtime_error); //invalid IP
389
390 //IPv6 tests
391 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban FE80:0000:0000:0000:0202:B3FF:FE1E:8329 add")));
392 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
393 ar = r.get_array();
394 o1 = ar[0].get_obj();
395 adr = o1.find_value("address");
396 BOOST_CHECK_EQUAL(adr.get_str(), "fe80::202:b3ff:fe1e:8329/128");
397
398 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned")));
399 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:db8::/ffff:fffc:0:0:0:0:0:0 add")));
400 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
401 ar = r.get_array();
402 o1 = ar[0].get_obj();
403 adr = o1.find_value("address");
404 BOOST_CHECK_EQUAL(adr.get_str(), "2001:db8::/30");
405
406 BOOST_CHECK_NO_THROW(CallRPC(std::string("clearbanned")));
407 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("setban 2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128 add")));
408 BOOST_CHECK_NO_THROW(r = CallRPC(std::string("listbanned")));
409 ar = r.get_array();
410 o1 = ar[0].get_obj();
411 adr = o1.find_value("address");
412 BOOST_CHECK_EQUAL(adr.get_str(), "2001:4d48:ac57:400:cacf:e9ff:fe1d:9c63/128");
413 }
414
415 BOOST_AUTO_TEST_CASE(rpc_convert_values_generatetoaddress)
416 {
417 UniValue result;
418
419 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a"}));
420 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101);
421 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a");
422
423 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"101", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU"}));
424 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 101);
425 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU");
426
427 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a", "9"}));
428 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1);
429 BOOST_CHECK_EQUAL(result[1].get_str(), "mkESjLZW66TmHhiFX8MCaBjrhZ543PPh9a");
430 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9);
431
432 BOOST_CHECK_NO_THROW(result = RPCConvertValues("generatetoaddress", {"1", "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU", "9"}));
433 BOOST_CHECK_EQUAL(result[0].getInt<int>(), 1);
434 BOOST_CHECK_EQUAL(result[1].get_str(), "mhMbmE2tE9xzJYCV9aNC8jKWN31vtGrguU");
435 BOOST_CHECK_EQUAL(result[2].getInt<int>(), 9);
436 }
437
438 BOOST_AUTO_TEST_CASE(rpc_getblockstats_calculate_percentiles_by_weight)
439 {
440 int64_t total_weight = 200;
441 std::vector<std::pair<CAmount, int64_t>> feerates;
442 feerates.reserve(200);
443 CAmount result[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 };
444
445 for (int64_t i = 0; i < 100; i++) {
446 feerates.emplace_back(1 ,1);
447 }
448
449 for (int64_t i = 0; i < 100; i++) {
450 feerates.emplace_back(2 ,1);
451 }
452
453 CalculatePercentilesByWeight(result, feerates, total_weight);
454 BOOST_CHECK_EQUAL(result[0], 1);
455 BOOST_CHECK_EQUAL(result[1], 1);
456 BOOST_CHECK_EQUAL(result[2], 1);
457 BOOST_CHECK_EQUAL(result[3], 2);
458 BOOST_CHECK_EQUAL(result[4], 2);
459
460 // Test with more pairs, and two pairs overlapping 2 percentiles.
461 total_weight = 100;
462 CAmount result2[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 };
463 feerates.clear();
464
465 feerates.emplace_back(1, 9);
466 feerates.emplace_back(2 , 16); //10th + 25th percentile
467 feerates.emplace_back(4 ,50); //50th + 75th percentile
468 feerates.emplace_back(5 ,10);
469 feerates.emplace_back(9 ,15); // 90th percentile
470
471 CalculatePercentilesByWeight(result2, feerates, total_weight);
472
473 BOOST_CHECK_EQUAL(result2[0], 2);
474 BOOST_CHECK_EQUAL(result2[1], 2);
475 BOOST_CHECK_EQUAL(result2[2], 4);
476 BOOST_CHECK_EQUAL(result2[3], 4);
477 BOOST_CHECK_EQUAL(result2[4], 9);
478
479 // Same test as above, but one of the percentile-overlapping pairs is split in 2.
480 total_weight = 100;
481 CAmount result3[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 };
482 feerates.clear();
483
484 feerates.emplace_back(1, 9);
485 feerates.emplace_back(2 , 11); // 10th percentile
486 feerates.emplace_back(2 , 5); // 25th percentile
487 feerates.emplace_back(4 ,50); //50th + 75th percentile
488 feerates.emplace_back(5 ,10);
489 feerates.emplace_back(9 ,15); // 90th percentile
490
491 CalculatePercentilesByWeight(result3, feerates, total_weight);
492
493 BOOST_CHECK_EQUAL(result3[0], 2);
494 BOOST_CHECK_EQUAL(result3[1], 2);
495 BOOST_CHECK_EQUAL(result3[2], 4);
496 BOOST_CHECK_EQUAL(result3[3], 4);
497 BOOST_CHECK_EQUAL(result3[4], 9);
498
499 // Test with one transaction spanning all percentiles.
500 total_weight = 104;
501 CAmount result4[NUM_GETBLOCKSTATS_PERCENTILES] = { 0 };
502 feerates.clear();
503
504 feerates.emplace_back(1, 100);
505 feerates.emplace_back(2, 1);
506 feerates.emplace_back(3, 1);
507 feerates.emplace_back(3, 1);
508 feerates.emplace_back(999999, 1);
509
510 CalculatePercentilesByWeight(result4, feerates, total_weight);
511
512 for (int64_t i = 0; i < NUM_GETBLOCKSTATS_PERCENTILES; i++) {
513 BOOST_CHECK_EQUAL(result4[i], 1);
514 }
515 }
516
517 // Make sure errors are triggered appropriately if parameters have the same names.
518 BOOST_AUTO_TEST_CASE(check_dup_param_names)
519 {
520 enum ParamType { POSITIONAL, NAMED, NAMED_ONLY };
521 auto make_rpc = [](std::vector<std::tuple<std::string, ParamType>> param_names) {
522 std::vector<RPCArg> params;
523 std::vector<RPCArg> options;
524 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)); };
525 for (auto& [param_name, param_type] : param_names) {
526 if (param_type == POSITIONAL) {
527 push_options();
528 params.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description");
529 } else {
530 options.emplace_back(std::move(param_name), RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "description", RPCArgOptions{.also_positional = param_type == NAMED});
531 }
532 }
533 push_options();
534 return RPCHelpMan{"method_name", "description", params, RPCResults{}, RPCExamples{""}};
535 };
536
537 // No errors if parameter names are unique.
538 make_rpc({{"p1", POSITIONAL}, {"p2", POSITIONAL}});
539 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED}});
540 make_rpc({{"p1", POSITIONAL}, {"p2", NAMED_ONLY}});
541 make_rpc({{"p1", NAMED}, {"p2", POSITIONAL}});
542 make_rpc({{"p1", NAMED}, {"p2", NAMED}});
543 make_rpc({{"p1", NAMED}, {"p2", NAMED_ONLY}});
544 make_rpc({{"p1", NAMED_ONLY}, {"p2", POSITIONAL}});
545 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED}});
546 make_rpc({{"p1", NAMED_ONLY}, {"p2", NAMED_ONLY}});
547
548 // Error if parameters names are duplicates, unless one parameter is
549 // positional and the other is named and .also_positional is true.
550 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", POSITIONAL}}), NonFatalCheckError);
551 make_rpc({{"p1", POSITIONAL}, {"p1", NAMED}});
552 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p1", NAMED_ONLY}}), NonFatalCheckError);
553 make_rpc({{"p1", NAMED}, {"p1", POSITIONAL}});
554 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED}}), NonFatalCheckError);
555 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED}, {"p1", NAMED_ONLY}}), NonFatalCheckError);
556 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", POSITIONAL}}), NonFatalCheckError);
557 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED}}), NonFatalCheckError);
558 BOOST_CHECK_THROW(make_rpc({{"p1", NAMED_ONLY}, {"p1", NAMED_ONLY}}), NonFatalCheckError);
559
560 // Make sure duplicate aliases are detected too.
561 BOOST_CHECK_THROW(make_rpc({{"p1", POSITIONAL}, {"p2|p1", NAMED_ONLY}}), NonFatalCheckError);
562 }
563
564 BOOST_AUTO_TEST_CASE(help_example)
565 {
566 // test different argument types
567 const RPCArgList& args = {{"foo", "bar"}, {"b", true}, {"n", 1}};
568 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", args), "> limenka-cli -named test foo=bar b=true n=1\n");
569 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");
570
571 // test shell escape
572 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b'ar"}}), "> limenka-cli -named test foo='b'''ar'\n");
573 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b\"ar"}}), "> limenka-cli -named test foo='b\"ar'\n");
574 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"foo", "b ar"}}), "> limenka-cli -named test foo='b ar'\n");
575
576 // test object params
577 UniValue obj_value(UniValue::VOBJ);
578 obj_value.pushKV("foo", "bar");
579 obj_value.pushKV("b", false);
580 obj_value.pushKV("n", 1);
581 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"name", obj_value}}), "> limenka-cli -named test name='{\"foo\":\"bar\",\"b\":false,\"n\":1}'\n");
582 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");
583
584 // test array params
585 UniValue arr_value(UniValue::VARR);
586 arr_value.push_back("bar");
587 arr_value.push_back(false);
588 arr_value.push_back(1);
589 BOOST_CHECK_EQUAL(HelpExampleCliNamed("test", {{"name", arr_value}}), "> limenka-cli -named test name='[\"bar\",false,1]'\n");
590 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");
591
592 // test types don't matter for shell
593 BOOST_CHECK_EQUAL(HelpExampleCliNamed("foo", {{"arg", true}}), HelpExampleCliNamed("foo", {{"arg", "true"}}));
594
595 // test types matter for Rpc
596 BOOST_CHECK_NE(HelpExampleRpcNamed("foo", {{"arg", true}}), HelpExampleRpcNamed("foo", {{"arg", "true"}}));
597 }
598
599 static void CheckRpc(const std::vector<RPCArg>& params, const UniValue& args, RPCHelpMan::RPCMethodImpl test_impl)
600 {
601 auto null_result{RPCResult{RPCResult::Type::NONE, "", "None"}};
602 const RPCHelpMan rpc{"dummy", "dummy description", params, null_result, RPCExamples{""}, test_impl};
603 JSONRPCRequest req;
604 req.params = args;
605
606 rpc.HandleRequest(req);
607 }
608
609 BOOST_AUTO_TEST_CASE(rpc_arg_helper)
610 {
611 constexpr bool DEFAULT_BOOL = true;
612 constexpr auto DEFAULT_STRING = "default";
613 constexpr uint64_t DEFAULT_UINT64_T = 3;
614
615 //! Parameters with which the RPCHelpMan is instantiated
616 const std::vector<RPCArg> params{
617 // Required arg
618 {"req_int", RPCArg::Type::NUM, RPCArg::Optional::NO, ""},
619 {"req_str", RPCArg::Type::STR, RPCArg::Optional::NO, ""},
620 // Default arg
621 {"def_uint64_t", RPCArg::Type::NUM, RPCArg::Default{DEFAULT_UINT64_T}, ""},
622 {"def_string", RPCArg::Type::STR, RPCArg::Default{DEFAULT_STRING}, ""},
623 {"def_bool", RPCArg::Type::BOOL, RPCArg::Default{DEFAULT_BOOL}, ""},
624 // Optional arg without default
625 {"opt_double", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, ""},
626 {"opt_string", RPCArg::Type::STR, RPCArg::Optional::OMITTED, ""}
627 };
628
629 //! Check that `self.Arg` returns the same value as the `request.params` accessors
630 RPCHelpMan::RPCMethodImpl check_positional = [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
631 BOOST_CHECK_EQUAL(self.Arg<int>("req_int"), request.params[0].getInt<int>());
632 BOOST_CHECK_EQUAL(self.Arg<std::string>("req_str"), request.params[1].get_str());
633 BOOST_CHECK_EQUAL(self.Arg<uint64_t>("def_uint64_t"), request.params[2].isNull() ? DEFAULT_UINT64_T : request.params[2].getInt<uint64_t>());
634 BOOST_CHECK_EQUAL(self.Arg<std::string>("def_string"), request.params[3].isNull() ? DEFAULT_STRING : request.params[3].get_str());
635 BOOST_CHECK_EQUAL(self.Arg<bool>("def_bool"), request.params[4].isNull() ? DEFAULT_BOOL : request.params[4].get_bool());
636 if (!request.params[5].isNull()) {
637 BOOST_CHECK_EQUAL(self.MaybeArg<double>("opt_double").value(), request.params[5].get_real());
638 } else {
639 BOOST_CHECK(!self.MaybeArg<double>("opt_double"));
640 }
641 if (!request.params[6].isNull()) {
642 BOOST_CHECK(self.MaybeArg<std::string>("opt_string"));
643 BOOST_CHECK_EQUAL(*self.MaybeArg<std::string>("opt_string"), request.params[6].get_str());
644 } else {
645 BOOST_CHECK(!self.MaybeArg<std::string>("opt_string"));
646 }
647 return UniValue{};
648 };
649 CheckRpc(params, UniValue{JSON(R"([5, "hello", null, null, null, null, null])")}, check_positional);
650 CheckRpc(params, UniValue{JSON(R"([5, "hello", 4, "test", true, 1.23, "world"])")}, check_positional);
651 }
652
653 BOOST_AUTO_TEST_SUITE_END()
654