Branch data Line data Source code
1 : : // Copyright (c) 2017-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 <chain.h>
6 : : #include <common/args.h>
7 : : #include <common/messages.h>
8 : : #include <common/types.h>
9 : : #include <consensus/amount.h>
10 : : #include <core_io.h>
11 : : #include <key_io.h>
12 : : #include <node/types.h>
13 : : #include <outputtype.h>
14 : : #include <pow.h>
15 : : #include <rpc/util.h>
16 : : #include <script/descriptor.h>
17 : : #include <script/interpreter.h>
18 : : #include <script/signingprovider.h>
19 : : #include <script/solver.h>
20 : : #include <tinyformat.h>
21 : : #include <uint256.h>
22 : : #include <univalue.h>
23 : : #include <util/check.h>
24 : : #include <util/result.h>
25 : : #include <util/strencodings.h>
26 : : #include <util/string.h>
27 : : #include <util/translation.h>
28 : :
29 : : #include <algorithm>
30 : : #include <iterator>
31 : : #include <string_view>
32 : : #include <tuple>
33 : : #include <utility>
34 : :
35 : : using common::PSBTError;
36 : : using common::PSBTErrorString;
37 : : using common::TransactionErrorString;
38 : : using node::TransactionError;
39 : : using util::Join;
40 : : using util::SplitString;
41 : : using util::TrimString;
42 : :
43 : : const std::string UNIX_EPOCH_TIME = "UNIX epoch time";
44 : : const std::string EXAMPLE_ADDRESS[2] = {"bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", "bc1q02ad21edsxd23d32dfgqqsz4vv4nmtfzuklhy3"};
45 : :
46 : 72737 : std::string GetAllOutputTypes()
47 : : {
48 : 72737 : std::vector<std::string> ret;
49 : 72737 : using U = std::underlying_type_t<TxoutType>;
50 [ + + ]: 872844 : for (U i = (U)TxoutType::NONSTANDARD; i <= (U)TxoutType::WITNESS_UNKNOWN; ++i) {
51 [ + - + - ]: 1600214 : ret.emplace_back(GetTxnOutputType(static_cast<TxoutType>(i)));
52 : : }
53 [ + - ]: 145474 : return Join(ret, ", ");
54 : 72737 : }
55 : :
56 : 1978 : void RPCTypeCheckObj(const UniValue& o,
57 : : const std::map<std::string, UniValueType>& typesExpected,
58 : : bool fAllowNull,
59 : : bool fStrict)
60 : : {
61 [ + + ]: 23113 : for (const auto& t : typesExpected) {
62 [ - + ]: 21171 : const UniValue& v = o.find_value(t.first);
63 [ + + + + ]: 21171 : if (!fAllowNull && v.isNull())
64 [ + - + - ]: 22 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Missing %s", t.first));
65 : :
66 [ + + + + : 21160 : if (!(t.second.typeAny || v.type() == t.second.type || (fAllowNull && v.isNull())))
+ + + + ]
67 [ + - + - : 50 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("JSON value of type %s for field %s is not of expected type %s", uvTypeName(v.type()), t.first, uvTypeName(t.second.type)));
+ - + - ]
68 : : }
69 : :
70 [ + + ]: 1942 : if (fStrict)
71 : : {
72 [ + + ]: 3135 : for (const std::string& k : o.getKeys())
73 : : {
74 [ + + ]: 2126 : if (!typesExpected.contains(k))
75 : : {
76 : 4 : std::string err = strprintf("Unexpected key %s", k);
77 [ + - ]: 4 : throw JSONRPCError(RPC_TYPE_ERROR, err);
78 : 4 : }
79 : : }
80 : : }
81 : 1938 : }
82 : :
83 : 12610 : int ParseVerbosity(const UniValue& arg, int default_verbosity, bool allow_bool)
84 : : {
85 [ + + ]: 12610 : if (!arg.isNull()) {
86 [ + + ]: 10616 : if (arg.isBool()) {
87 [ + + ]: 3878 : if (!allow_bool) {
88 [ + - + - ]: 4 : throw JSONRPCError(RPC_TYPE_ERROR, "Verbosity was boolean but only integer allowed");
89 : : }
90 : 3876 : return arg.get_bool(); // true = 1
91 : : } else {
92 : 6738 : return arg.getInt<int>();
93 : : }
94 : : }
95 : : return default_verbosity;
96 : : }
97 : :
98 : 50143 : CAmount AmountFromValue(const UniValue& value, int decimals)
99 : : {
100 [ + + + + ]: 50143 : if (!value.isNum() && !value.isStr())
101 [ + - + - ]: 24 : throw JSONRPCError(RPC_TYPE_ERROR, "Amount is not a number or string");
102 : 50131 : int64_t amount;
103 [ - + + + ]: 50131 : if (!ParseFixedPoint(value.getValStr(), decimals, &amount))
104 [ + - + - ]: 166 : throw JSONRPCError(RPC_TYPE_ERROR, "Invalid amount");
105 [ + + ]: 50048 : if (!MoneyRange(amount))
106 [ + - + - ]: 24 : throw JSONRPCError(RPC_TYPE_ERROR, "Amount out of range");
107 : 50036 : return amount;
108 : : }
109 : :
110 : 33716 : CFeeRate ParseFeeRate(const UniValue& json)
111 : : {
112 : 33716 : CAmount val{AmountFromValue(json)};
113 [ + + + - : 33716 : if (val >= COIN) throw JSONRPCError(RPC_INVALID_PARAMETER, "Fee rates larger than or equal to 1BTC/kvB are not accepted");
+ - ]
114 : 33714 : return CFeeRate{val};
115 : : }
116 : :
117 : 36504 : uint256 ParseHashV(const UniValue& v, std::string_view name)
118 : : {
119 : 36504 : const std::string& strHex(v.get_str());
120 [ - + + + ]: 36503 : if (auto rv{uint256::FromHex(strHex)}) return *rv;
121 [ - + + + ]: 28 : if (auto expected_len{uint256::size() * 2}; strHex.length() != expected_len) {
122 [ - + + - : 32 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be of length %d (not %d, for '%s')", name, expected_len, strHex.length(), strHex));
+ - ]
123 : : }
124 [ + - + - ]: 24 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be hexadecimal string (not '%s')", name, strHex));
125 : : }
126 : 6530 : uint256 ParseHashO(const UniValue& o, std::string_view strKey)
127 : : {
128 : 6530 : return ParseHashV(o.find_value(strKey), strKey);
129 : : }
130 : 926 : std::vector<unsigned char> ParseHexV(const UniValue& v, std::string_view name)
131 : : {
132 [ + - ]: 926 : std::string strHex;
133 [ + - ]: 926 : if (v.isStr())
134 [ + - + - ]: 926 : strHex = v.get_str();
135 [ - + + - : 926 : if (!IsHex(strHex))
+ + ]
136 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be hexadecimal string (not '%s')", name, strHex));
137 [ - + + - ]: 922 : return ParseHex(strHex);
138 : 922 : }
139 : 600 : std::vector<unsigned char> ParseHexO(const UniValue& o, std::string_view strKey)
140 : : {
141 : 600 : return ParseHexV(o.find_value(strKey), strKey);
142 : : }
143 : :
144 : : namespace {
145 : :
146 : : /**
147 : : * Quote an argument for shell.
148 : : *
149 : : * @note This is intended for help, not for security-sensitive purposes.
150 : : */
151 : 3445 : std::string ShellQuote(const std::string& s)
152 : : {
153 [ - + ]: 3445 : std::string result;
154 [ - + + - ]: 3445 : result.reserve(s.size() * 2);
155 [ - + + + ]: 248782 : for (const char ch: s) {
156 [ + + ]: 245337 : if (ch == '\'') {
157 [ + - ]: 1 : result += "'\''";
158 : : } else {
159 [ + - ]: 490673 : result += ch;
160 : : }
161 : : }
162 [ + - ]: 6890 : return "'" + result + "'";
163 : 3445 : }
164 : :
165 : : /**
166 : : * Shell-quotes the argument if it needs quoting, else returns it literally, to save typing.
167 : : *
168 : : * @note This is intended for help, not for security-sensitive purposes.
169 : : */
170 : 14004 : std::string ShellQuoteIfNeeded(const std::string& s)
171 : : {
172 [ - + + + ]: 101914 : for (const char ch: s) {
173 [ + + + + ]: 91355 : if (ch == ' ' || ch == '\'' || ch == '"') {
174 : 3445 : return ShellQuote(s);
175 : : }
176 : : }
177 : :
178 [ - + ]: 10559 : return s;
179 : : }
180 : :
181 : : }
182 : :
183 : 770606 : std::string HelpExampleCli(const std::string& methodname, const std::string& args)
184 : : {
185 [ + - + - ]: 2311818 : return "> bitcoin-cli " + methodname + " " + args + "\n";
186 : : }
187 : :
188 : 5818 : std::string HelpExampleCliNamed(const std::string& methodname, const RPCArgList& args)
189 : : {
190 : 5818 : std::string result = "> bitcoin-cli -named " + methodname;
191 [ + + ]: 19822 : for (const auto& argpair: args) {
192 [ + + ]: 14004 : const auto& value = argpair.second.isStr()
193 [ + + + - : 14004 : ? argpair.second.get_str()
- + ]
194 [ + - ]: 6419 : : argpair.second.write();
195 [ + - + - : 42012 : result += " " + argpair.first + "=" + ShellQuoteIfNeeded(value);
+ - ]
196 : 14004 : }
197 [ + - ]: 5818 : result += "\n";
198 : 5818 : return result;
199 : 0 : }
200 : :
201 : 519490 : std::string HelpExampleRpc(const std::string& methodname, const std::string& args)
202 : : {
203 : 519490 : return "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", "
204 [ + - + - ]: 1558470 : "\"method\": \"" + methodname + "\", \"params\": [" + args + "]}' -H 'content-type: application/json' http://127.0.0.1:8332/\n";
205 : : }
206 : :
207 : 3262 : std::string HelpExampleRpcNamed(const std::string& methodname, const RPCArgList& args)
208 : : {
209 : 3262 : UniValue params(UniValue::VOBJ);
210 [ + + ]: 12157 : for (const auto& param: args) {
211 [ + - - + : 26685 : params.pushKV(param.first, param.second);
+ - ]
212 : : }
213 : :
214 : 3262 : return "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", "
215 [ + - + - : 13048 : "\"method\": \"" + methodname + "\", \"params\": " + params.write() + "}' -H 'content-type: application/json' http://127.0.0.1:8332/\n";
+ - ]
216 : 3262 : }
217 : :
218 : : // Converts a hex string to a public key if possible
219 : 568 : CPubKey HexToPubKey(const std::string& hex_in)
220 : : {
221 [ - + + + ]: 568 : if (!IsHex(hex_in)) {
222 [ + - + - ]: 3 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must be a hex string");
223 : : }
224 [ - + + + : 567 : if (hex_in.length() != 66 && hex_in.length() != 130) {
+ + ]
225 [ + - + - ]: 3 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must have a length of either 33 or 65 bytes");
226 : : }
227 [ - + ]: 566 : CPubKey vchPubKey(ParseHex(hex_in));
228 [ - + ]: 566 : if (!vchPubKey.IsFullyValid()) {
229 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must be cryptographically valid.");
230 : : }
231 : 566 : return vchPubKey;
232 : : }
233 : :
234 : : // Creates a multisig address from a given list of public keys, number of signatures required, and the address type
235 : 83 : CTxDestination AddAndGetMultisigDestination(const int required, const std::vector<CPubKey>& pubkeys, OutputType type, FlatSigningProvider& keystore, CScript& script_out)
236 : : {
237 : : // Gather public keys
238 [ - + ]: 83 : if (required < 1) {
239 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "a multisignature address must require at least one key to redeem");
240 : : }
241 [ - + - + ]: 83 : if ((int)pubkeys.size() < required) {
242 [ # # # # : 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("not enough keys supplied (got %u keys, but need at least %d to redeem)", pubkeys.size(), required));
# # ]
243 : : }
244 [ + + ]: 83 : if (pubkeys.size() > MAX_PUBKEYS_PER_MULTISIG) {
245 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Number of keys involved in the multisignature address creation > %d\nReduce the number", MAX_PUBKEYS_PER_MULTISIG));
246 : : }
247 : :
248 : 81 : script_out = GetScriptForMultisig(required, pubkeys);
249 : :
250 : : // Check if any keys are uncompressed. If so, the type is legacy
251 [ + + ]: 543 : for (const CPubKey& pk : pubkeys) {
252 [ + + ]: 480 : if (!pk.IsCompressed()) {
253 : : type = OutputType::LEGACY;
254 : : break;
255 : : }
256 : : }
257 : :
258 [ + + + - : 81 : if (type == OutputType::LEGACY && script_out.size() > MAX_SCRIPT_ELEMENT_SIZE) {
+ + ]
259 [ + - + - : 3 : throw JSONRPCError(RPC_INVALID_PARAMETER, (strprintf("redeemScript exceeds size limit: %d > %d", script_out.size(), MAX_SCRIPT_ELEMENT_SIZE)));
+ - ]
260 : : }
261 : :
262 : : // Make the address
263 : 80 : CTxDestination dest = AddAndGetDestinationForScript(keystore, script_out, type);
264 : :
265 : 80 : return dest;
266 : : }
267 : :
268 : : class DescribeAddressVisitor
269 : : {
270 : : public:
271 : : explicit DescribeAddressVisitor() = default;
272 : :
273 : 0 : UniValue operator()(const CNoDestination& dest) const
274 : : {
275 : 0 : return UniValue(UniValue::VOBJ);
276 : : }
277 : :
278 : 0 : UniValue operator()(const PubKeyDestination& dest) const
279 : : {
280 : 0 : return UniValue(UniValue::VOBJ);
281 : : }
282 : :
283 : 101 : UniValue operator()(const PKHash& keyID) const
284 : : {
285 : 101 : UniValue obj(UniValue::VOBJ);
286 [ + - + - : 202 : obj.pushKV("isscript", false);
+ - ]
287 [ + - + - : 202 : obj.pushKV("iswitness", false);
+ - ]
288 : 101 : return obj;
289 : 0 : }
290 : :
291 : 130 : UniValue operator()(const ScriptHash& scriptID) const
292 : : {
293 : 130 : UniValue obj(UniValue::VOBJ);
294 [ + - + - : 260 : obj.pushKV("isscript", true);
+ - ]
295 [ + - + - : 260 : obj.pushKV("iswitness", false);
+ - ]
296 : 130 : return obj;
297 : 0 : }
298 : :
299 : 494 : UniValue operator()(const WitnessV0KeyHash& id) const
300 : : {
301 : 494 : UniValue obj(UniValue::VOBJ);
302 [ + - + - : 988 : obj.pushKV("isscript", false);
+ - ]
303 [ + - + - : 988 : obj.pushKV("iswitness", true);
+ - ]
304 [ + - + - : 988 : obj.pushKV("witness_version", 0);
+ - ]
305 [ + - + - : 988 : obj.pushKV("witness_program", HexStr(id));
+ - + - ]
306 : 494 : return obj;
307 : 0 : }
308 : :
309 : 43 : UniValue operator()(const WitnessV0ScriptHash& id) const
310 : : {
311 : 43 : UniValue obj(UniValue::VOBJ);
312 [ + - + - : 86 : obj.pushKV("isscript", true);
+ - ]
313 [ + - + - : 86 : obj.pushKV("iswitness", true);
+ - ]
314 [ + - + - : 86 : obj.pushKV("witness_version", 0);
+ - ]
315 [ + - + - : 86 : obj.pushKV("witness_program", HexStr(id));
+ - + - ]
316 : 43 : return obj;
317 : 0 : }
318 : :
319 : 127 : UniValue operator()(const WitnessV1Taproot& tap) const
320 : : {
321 : 127 : UniValue obj(UniValue::VOBJ);
322 [ + - + - : 254 : obj.pushKV("isscript", true);
+ - ]
323 [ + - + - : 254 : obj.pushKV("iswitness", true);
+ - ]
324 [ + - + - : 254 : obj.pushKV("witness_version", 1);
+ - ]
325 [ + - + - : 254 : obj.pushKV("witness_program", HexStr(tap));
+ - + - ]
326 : 127 : return obj;
327 : 0 : }
328 : :
329 : 1 : UniValue operator()(const PayToAnchor& anchor) const
330 : : {
331 : 1 : UniValue obj(UniValue::VOBJ);
332 [ + - + - : 2 : obj.pushKV("isscript", true);
+ - ]
333 [ + - + - : 2 : obj.pushKV("iswitness", true);
+ - ]
334 : 1 : return obj;
335 : 0 : }
336 : :
337 : 5 : UniValue operator()(const WitnessUnknown& id) const
338 : : {
339 : 5 : UniValue obj(UniValue::VOBJ);
340 [ + - + - : 10 : obj.pushKV("iswitness", true);
+ - ]
341 [ + - + - : 10 : obj.pushKV("witness_version", id.GetWitnessVersion());
+ - ]
342 [ - + + - : 10 : obj.pushKV("witness_program", HexStr(id.GetWitnessProgram()));
+ - + - +
- ]
343 : 5 : return obj;
344 : 0 : }
345 : : };
346 : :
347 : 901 : UniValue DescribeAddress(const CTxDestination& dest)
348 : : {
349 : 901 : return std::visit(DescribeAddressVisitor(), dest);
350 : : }
351 : :
352 : : /**
353 : : * Returns a sighash value corresponding to the passed in argument.
354 : : *
355 : : * @pre The sighash argument should be string or null.
356 : : */
357 : 1056 : std::optional<int> ParseSighashString(const UniValue& sighash)
358 : : {
359 [ + + ]: 1056 : if (sighash.isNull()) {
360 : 971 : return std::nullopt;
361 : : }
362 : 85 : const auto result{SighashFromStr(sighash.get_str())};
363 [ + + ]: 85 : if (!result) {
364 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, util::ErrorString(result).original);
365 : : }
366 : 81 : return result.value();
367 : 81 : }
368 : :
369 : 333 : unsigned int ParseConfirmTarget(const UniValue& value, unsigned int max_target)
370 : : {
371 : 333 : const int target{value.getInt<int>()};
372 : 333 : const unsigned int unsigned_target{static_cast<unsigned int>(target)};
373 [ + + + + ]: 333 : if (target < 1 || unsigned_target > max_target) {
374 [ + - + - ]: 62 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid conf_target, must be between %u and %u", 1, max_target));
375 : : }
376 : 302 : return unsigned_target;
377 : : }
378 : :
379 : 15 : RPCErrorCode RPCErrorFromPSBTError(PSBTError err)
380 : : {
381 [ + + - ]: 15 : switch (err) {
382 : : case PSBTError::UNSUPPORTED:
383 : : return RPC_INVALID_PARAMETER;
384 : 14 : case PSBTError::SIGHASH_MISMATCH:
385 : 14 : return RPC_DESERIALIZATION_ERROR;
386 : 1 : default: break;
387 : : }
388 : 1 : return RPC_TRANSACTION_ERROR;
389 : : }
390 : :
391 : 4314 : RPCErrorCode RPCErrorFromTransactionError(TransactionError terr)
392 : : {
393 [ + + + + ]: 4314 : switch (terr) {
394 : : case TransactionError::MEMPOOL_REJECTED:
395 : : return RPC_TRANSACTION_REJECTED;
396 : 3 : case TransactionError::ALREADY_IN_UTXO_SET:
397 : 3 : return RPC_VERIFY_ALREADY_IN_UTXO_SET;
398 : 5 : case TransactionError::PRIVATE_BROADCAST_FULL:
399 : 5 : return RPC_LIMIT_EXCEEDED;
400 : 12 : default: break;
401 : : }
402 : 12 : return RPC_TRANSACTION_ERROR;
403 : : }
404 : :
405 : 15 : UniValue JSONRPCPSBTError(PSBTError err)
406 : : {
407 [ + - + - ]: 30 : return JSONRPCError(RPCErrorFromPSBTError(err), PSBTErrorString(err).original);
408 : : }
409 : :
410 : 4314 : UniValue JSONRPCTransactionError(TransactionError terr, const std::string& err_string)
411 : : {
412 [ - + + + ]: 4314 : if (err_string.length() > 0) {
413 : 4299 : return JSONRPCError(RPCErrorFromTransactionError(terr), err_string);
414 : : } else {
415 [ + - + - ]: 30 : return JSONRPCError(RPCErrorFromTransactionError(terr), TransactionErrorString(terr).original);
416 : : }
417 : : }
418 : :
419 : : /**
420 : : * A pair of strings that can be aligned (through padding) with other Sections
421 : : * later on
422 : : */
423 : 65102 : struct Section {
424 : 20634 : Section(const std::string& left, const std::string& right)
425 [ - + - + ]: 61902 : : m_left{left}, m_right{right} {}
426 : : std::string m_left;
427 : : const std::string m_right;
428 : : };
429 : :
430 : : /**
431 : : * Keeps track of RPCArgs by transforming them into sections for the purpose
432 : : * of serializing everything to a single string
433 : : */
434 : 0 : struct Sections {
435 : : std::vector<Section> m_sections;
436 : : size_t m_max_pad{0};
437 : :
438 : 18707 : void PushSection(const Section& s)
439 : : {
440 [ - + + + ]: 18707 : m_max_pad = std::max(m_max_pad, s.m_left.size());
441 : 18707 : m_sections.push_back(s);
442 : 18707 : }
443 : :
444 : : /**
445 : : * Recursive helper to translate an RPCArg into sections
446 : : */
447 : : // NOLINTNEXTLINE(misc-no-recursion)
448 : 3191 : void Push(const RPCArg& arg, const size_t current_indent = 5, const OuterType outer_type = OuterType::NONE)
449 : : {
450 [ + - ]: 3191 : const auto indent = std::string(current_indent, ' ');
451 [ + - + + : 3191 : const auto indent_next = std::string(current_indent + 2, ' ');
+ - ]
452 : 3191 : const bool push_name{outer_type == OuterType::OBJ}; // Dictionary keys must have a name
453 : 3191 : const bool is_top_level_arg{outer_type == OuterType::NONE}; // True on the first recursion
454 : :
455 [ + + + - ]: 3191 : switch (arg.m_type) {
456 : 2655 : case RPCArg::Type::STR_HEX:
457 : 2655 : case RPCArg::Type::STR:
458 : 2655 : case RPCArg::Type::NUM:
459 : 2655 : case RPCArg::Type::AMOUNT:
460 : 2655 : case RPCArg::Type::RANGE:
461 : 2655 : case RPCArg::Type::BOOL:
462 : 2655 : case RPCArg::Type::OBJ_NAMED_PARAMS: {
463 [ + + ]: 2655 : if (is_top_level_arg) return; // Nothing more to do for non-recursive types on first recursion
464 [ - + ]: 679 : auto left = indent;
465 [ - + + + : 679 : if (arg.m_opts.type_str.size() != 0 && push_name) {
+ - ]
466 [ + - + - : 9 : left += "\"" + arg.GetName() + "\": " + arg.m_opts.type_str.at(0);
+ - + - ]
467 : : } else {
468 [ + + + - : 1352 : left += push_name ? arg.ToStringObj(/*oneline=*/false) : arg.ToString(/*oneline=*/false);
+ - ]
469 : : }
470 [ + - ]: 679 : left += ",";
471 [ + - + - : 1358 : PushSection({left, arg.ToDescriptionString(/*is_named_arg=*/push_name)});
+ - ]
472 : 679 : break;
473 : 679 : }
474 : 204 : case RPCArg::Type::OBJ:
475 : 204 : case RPCArg::Type::OBJ_USER_KEYS: {
476 [ + + + - : 204 : const auto right = is_top_level_arg ? "" : arg.ToDescriptionString(/*is_named_arg=*/push_name);
+ - ]
477 [ - + - - : 612 : PushSection({indent + (push_name ? "\"" + arg.GetName() + "\": " : "") + "{", right});
- - - - +
- + - + -
+ - - + -
+ - - -
- ]
478 [ + + ]: 680 : for (const auto& arg_inner : arg.m_inner) {
479 [ + - ]: 476 : Push(arg_inner, current_indent + 2, OuterType::OBJ);
480 : : }
481 [ + + ]: 204 : if (arg.m_type != RPCArg::Type::OBJ) {
482 [ + - + - : 80 : PushSection({indent_next + "...", ""});
+ - + - ]
483 : : }
484 [ + + + - : 792 : PushSection({indent + "}" + (is_top_level_arg ? "" : ","), ""});
+ - + - +
- ]
485 : 204 : break;
486 : 204 : }
487 : 332 : case RPCArg::Type::ARR: {
488 [ - + ]: 332 : auto left = indent;
489 [ + + + - : 772 : left += push_name ? "\"" + arg.GetName() + "\": " : "";
+ - + - +
- + + + +
- - - - ]
490 [ + - ]: 332 : left += "[";
491 [ + + + - : 332 : const auto right = is_top_level_arg ? "" : arg.ToDescriptionString(/*is_named_arg=*/push_name);
+ - ]
492 [ + - + - ]: 332 : PushSection({left, right});
493 [ + + ]: 769 : for (const auto& arg_inner : arg.m_inner) {
494 [ + - ]: 437 : Push(arg_inner, current_indent + 2, OuterType::ARR);
495 : : }
496 [ + - + - : 664 : PushSection({indent_next + "...", ""});
+ - + - ]
497 [ + + + - : 1050 : PushSection({indent + "]" + (is_top_level_arg ? "" : ","), ""});
+ - + - +
- ]
498 : 332 : break;
499 : 332 : }
500 : : } // no default case, so the compiler can warn about missing cases
501 : 3191 : }
502 : :
503 : : /**
504 : : * Concatenate all sections with proper padding
505 : : */
506 : 3557 : std::string ToString() const
507 : : {
508 : 3557 : std::string ret;
509 : 3557 : const size_t pad = m_max_pad + 4;
510 [ + + ]: 24191 : for (const auto& s : m_sections) {
511 : : // The left part of a section is assumed to be a single line, usually it is the name of the JSON struct or a
512 : : // brace like {, }, [, or ]
513 [ + - ]: 20634 : CHECK_NONFATAL(s.m_left.find('\n') == std::string::npos);
514 [ + + ]: 20634 : if (s.m_right.empty()) {
515 [ - + ]: 5487 : ret += s.m_left;
516 [ + - ]: 5487 : ret += "\n";
517 : 5487 : continue;
518 : : }
519 : :
520 [ - + ]: 15147 : std::string left = s.m_left;
521 [ + - ]: 15147 : left.resize(pad, ' ');
522 [ - + ]: 15147 : ret += left;
523 : :
524 : : // Properly pad after newlines
525 : 15147 : std::string right;
526 : 15147 : size_t begin = 0;
527 : 15147 : size_t new_line_pos = s.m_right.find_first_of('\n');
528 : 19133 : while (true) {
529 [ + - ]: 34280 : right += s.m_right.substr(begin, new_line_pos - begin);
530 [ + + ]: 17140 : if (new_line_pos == std::string::npos) {
531 : : break; //No new line
532 : : }
533 [ + - + - ]: 4302 : right += "\n" + std::string(pad, ' ');
534 : 2151 : begin = s.m_right.find_first_not_of(' ', new_line_pos + 1);
535 [ + + ]: 2151 : if (begin == std::string::npos) {
536 : : break; // Empty line
537 : : }
538 : 1993 : new_line_pos = s.m_right.find_first_of('\n', begin + 1);
539 : : }
540 [ - + ]: 15147 : ret += right;
541 [ + - ]: 15147 : ret += "\n";
542 : 15147 : }
543 : 3557 : return ret;
544 : 0 : }
545 : : };
546 : :
547 : 19 : RPCMethod::RPCMethod(std::string name, std::string description, std::vector<RPCArg> args, RPCResults results, RPCExamples examples)
548 [ + - - + : 81 : : RPCMethod{std::move(name), std::move(description), std::move(args), std::move(results), std::move(examples), nullptr} {}
+ + ]
549 : :
550 : 568681 : RPCMethod::RPCMethod(std::string name, std::string description, std::vector<RPCArg> args, RPCResults results, RPCExamples examples, RPCMethodImpl fun)
551 : 568689 : : m_name{std::move(name)},
552 : 568689 : m_fun{std::move(fun)},
553 : 568689 : m_description{std::move(description)},
554 [ + - ]: 568681 : m_args{std::move(args)},
555 [ + - ]: 568689 : m_results{std::move(results)},
556 [ - + ]: 568689 : m_examples{std::move(examples)}
557 : : {
558 : : // Map of parameter names and types just used to check whether the names are
559 : : // unique. Parameter names always need to be unique, with the exception that
560 : : // there can be pairs of POSITIONAL and NAMED parameters with the same name.
561 : 568681 : enum ParamType { POSITIONAL = 1, NAMED = 2, NAMED_ONLY = 4 };
562 : 568681 : std::map<std::string, int> param_names;
563 : :
564 [ + + ]: 1618864 : for (const auto& arg : m_args) {
565 [ - + + - ]: 1050191 : std::vector<std::string> names = SplitString(arg.m_names, '|');
566 : : // Should have unique named arguments
567 [ + + ]: 2117693 : for (const std::string& name : names) {
568 [ + - ]: 1067504 : auto& param_type = param_names[name];
569 [ + + ]: 1067504 : CHECK_NONFATAL(!(param_type & POSITIONAL));
570 [ + + ]: 1067503 : CHECK_NONFATAL(!(param_type & NAMED_ONLY));
571 : 1067502 : param_type |= POSITIONAL;
572 : : }
573 [ + + ]: 1050189 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
574 [ + + ]: 136944 : for (const auto& inner : arg.m_inner) {
575 [ - + + - ]: 116977 : std::vector<std::string> inner_names = SplitString(inner.m_names, '|');
576 [ + + ]: 233949 : for (const std::string& inner_name : inner_names) {
577 [ + - ]: 116978 : auto& param_type = param_names[inner_name];
578 [ + + + + : 116980 : CHECK_NONFATAL(!(param_type & POSITIONAL) || inner.m_opts.also_positional);
+ + ]
579 [ + + ]: 116976 : CHECK_NONFATAL(!(param_type & NAMED));
580 [ + + ]: 116974 : CHECK_NONFATAL(!(param_type & NAMED_ONLY));
581 [ + + ]: 223373 : param_type |= inner.m_opts.also_positional ? NAMED : NAMED_ONLY;
582 : : }
583 : 116977 : }
584 : : }
585 : : // Default value type should match argument type only when defined
586 [ + + ]: 1050183 : if (arg.m_fallback.index() == 2) {
587 : 355633 : const RPCArg::Type type = arg.m_type;
588 : 711266 : [&]() {
589 [ - + - + : 355633 : switch (std::get<RPCArg::Default>(arg.m_fallback).getType()) {
+ + + -
- ]
590 : 0 : case UniValue::VOBJ:
591 : 0 : CHECK_NONFATAL(type == RPCArg::Type::OBJ);
592 : 0 : return;
593 : 2161 : case UniValue::VARR:
594 : 2161 : CHECK_NONFATAL(type == RPCArg::Type::ARR);
595 : 2161 : return;
596 : 124240 : case UniValue::VSTR:
597 [ + + - + ]: 124240 : CHECK_NONFATAL(type == RPCArg::Type::STR || type == RPCArg::Type::STR_HEX || type == RPCArg::Type::AMOUNT);
598 : 124240 : return;
599 : 81662 : case UniValue::VNUM:
600 [ - + - - ]: 81662 : CHECK_NONFATAL(type == RPCArg::Type::NUM || type == RPCArg::Type::AMOUNT || type == RPCArg::Type::RANGE);
601 : 81662 : return;
602 : 147570 : case UniValue::VBOOL:
603 : 147570 : CHECK_NONFATAL(type == RPCArg::Type::BOOL);
604 : 147570 : return;
605 : : case UniValue::VNULL:
606 : : // Null values are accepted in all arguments
607 : : return;
608 : : } // no default case, so the compiler can warn about missing cases
609 [ # # ]: 0 : NONFATAL_UNREACHABLE();
610 [ + - ]: 355633 : }();
611 : : }
612 : 1050191 : }
613 : 568713 : }
614 : :
615 : 1116 : std::string RPCResults::ToDescriptionString() const
616 : : {
617 : 1116 : std::string result;
618 [ + + ]: 2451 : for (const auto& r : m_results) {
619 [ + + ]: 1335 : if (r.m_type == RPCResult::Type::ANY) continue; // for testing only
620 [ + + ]: 1325 : if (r.m_cond.empty()) {
621 [ + - ]: 988 : result += "\nResult:\n";
622 : : } else {
623 [ + - - + ]: 1011 : result += "\nResult (" + r.m_cond + "):\n";
624 : : }
625 : 1325 : Sections sections;
626 [ + - ]: 1325 : r.ToSections(sections);
627 [ + - ]: 2650 : result += sections.ToString();
628 : 1325 : }
629 : 1116 : return result;
630 : 0 : }
631 : :
632 : 1116 : std::string RPCExamples::ToDescriptionString() const
633 : : {
634 [ + + - + ]: 1116 : return m_examples.empty() ? m_examples : "\nExamples:\n" + m_examples;
635 : : }
636 : :
637 : 230759 : UniValue RPCMethod::HandleRequest(const JSONRPCRequest& request) const
638 : : {
639 [ + + ]: 230759 : if (request.mode == JSONRPCRequest::GET_ARGS) {
640 : 350 : return GetArgMap();
641 : : }
642 : : /*
643 : : * Check if the given request is valid according to this command or if
644 : : * the user is asking for help information, and throw help when appropriate.
645 : : */
646 [ + + - + : 230409 : if (request.mode == JSONRPCRequest::GET_HELP || !IsValidNumArgs(request.params.size())) {
+ + ]
647 [ + - ]: 2226 : throw HelpResult{ToString()};
648 : : }
649 : 229296 : UniValue arg_mismatch{UniValue::VOBJ};
650 [ - + + + ]: 667344 : for (size_t i{0}; i < m_args.size(); ++i) {
651 [ + - ]: 438048 : const auto& arg{m_args.at(i)};
652 [ + - + - ]: 438048 : UniValue match{arg.MatchesType(request.params[i])};
653 [ + + ]: 438048 : if (!match.isTrue()) {
654 [ + - + - ]: 60 : arg_mismatch.pushKV(strprintf("Position %s (%s)", i + 1, arg.m_names), std::move(match));
655 : : }
656 : 438048 : }
657 [ - + + + ]: 229296 : if (!arg_mismatch.empty()) {
658 [ + - + - : 56 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Wrong type passed:\n%s", arg_mismatch.write(4)));
+ - ]
659 : : }
660 [ + - ]: 229268 : CHECK_NONFATAL(m_req == nullptr);
661 : 229268 : m_req = &request;
662 [ + + ]: 229268 : UniValue ret = m_fun(*this, request);
663 : 223521 : m_req = nullptr;
664 [ + - + - : 223521 : if (gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
+ + ]
665 : 223483 : UniValue mismatch{UniValue::VARR};
666 [ + - ]: 243623 : for (const auto& res : m_results.m_results) {
667 [ + - ]: 243623 : UniValue match{res.MatchesType(ret)};
668 [ + + ]: 243623 : if (match.isTrue()) {
669 [ + - ]: 223483 : mismatch.setNull();
670 : 223483 : break;
671 : : }
672 [ + - ]: 20140 : mismatch.push_back(std::move(match));
673 : 243623 : }
674 [ - + ]: 223483 : if (!mismatch.isNull()) {
675 [ # # ]: 0 : std::string explain{
676 [ # # ]: 0 : mismatch.empty() ? "no possible results defined" :
677 [ # # # # ]: 0 : mismatch.size() == 1 ? mismatch[0].write(4) :
678 [ # # # # : 0 : mismatch.write(4)};
# # ]
679 : 0 : throw std::runtime_error{
680 [ # # # # ]: 0 : STR_INTERNAL_BUG(strprintf("RPC call \"%s\" returned incorrect type:\n%s", m_name, explain)),
681 [ # # ]: 0 : };
682 : 0 : }
683 : 223483 : }
684 : 223521 : return ret;
685 : 229296 : }
686 : :
687 : : using CheckFn = void(const RPCArg&);
688 : 44904 : static const UniValue* DetailMaybeArg(CheckFn* check, const std::vector<RPCArg>& params, const JSONRPCRequest* req, size_t i)
689 : : {
690 [ - + ]: 44904 : CHECK_NONFATAL(i < params.size());
691 : 44904 : const UniValue& arg{CHECK_NONFATAL(req)->params[i]};
692 : 44904 : const RPCArg& param{params.at(i)};
693 [ + + ]: 44904 : if (check) check(param);
694 : :
695 [ + + ]: 44904 : if (!arg.isNull()) return &arg;
696 [ + + ]: 20353 : if (!std::holds_alternative<RPCArg::Default>(param.m_fallback)) return nullptr;
697 : 17988 : return &std::get<RPCArg::Default>(param.m_fallback);
698 : : }
699 : :
700 : 41974 : static void CheckRequiredOrDefault(const RPCArg& param)
701 : : {
702 : : // Must use `Arg<Type>(key)` to get the argument or its default value.
703 : 41974 : const bool required{
704 [ + + - + ]: 41974 : std::holds_alternative<RPCArg::Optional>(param.m_fallback) && RPCArg::Optional::NO == std::get<RPCArg::Optional>(param.m_fallback),
705 : 41974 : };
706 [ + + + - ]: 79163 : CHECK_NONFATAL(required || std::holds_alternative<RPCArg::Default>(param.m_fallback));
707 : 41974 : }
708 : :
709 : : #define TMPL_INST(check_param, ret_type, return_code) \
710 : : template <> \
711 : : ret_type RPCMethod::ArgValue<ret_type>(size_t i) const \
712 : : { \
713 : : const UniValue* maybe_arg{ \
714 : : DetailMaybeArg(check_param, m_args, m_req, i), \
715 : : }; \
716 : : return return_code \
717 : : } \
718 : : void force_semicolon(ret_type)
719 : :
720 : : // Optional arg (without default). Can also be called on required args, if needed.
721 : 0 : TMPL_INST(nullptr, const UniValue*, maybe_arg;);
722 [ + + ]: 723 : TMPL_INST(nullptr, std::optional<double>, maybe_arg ? std::optional{maybe_arg->get_real()} : std::nullopt;);
723 [ + + ]: 806 : TMPL_INST(nullptr, std::optional<bool>, maybe_arg ? std::optional{maybe_arg->get_bool()} : std::nullopt;);
724 [ + + ]: 134 : TMPL_INST(nullptr, std::optional<int64_t>, maybe_arg ? std::optional{maybe_arg->getInt<int64_t>()} : std::nullopt;);
725 [ + + ]: 1267 : TMPL_INST(nullptr, std::optional<std::string_view>, maybe_arg ? std::optional<std::string_view>{maybe_arg->get_str()} : std::nullopt;);
726 : :
727 : : // Required arg or optional arg with default value.
728 : 33719 : TMPL_INST(CheckRequiredOrDefault, const UniValue&, *CHECK_NONFATAL(maybe_arg););
729 : 848 : TMPL_INST(CheckRequiredOrDefault, bool, CHECK_NONFATAL(maybe_arg)->get_bool(););
730 : 1413 : TMPL_INST(CheckRequiredOrDefault, int, CHECK_NONFATAL(maybe_arg)->getInt<int>(););
731 : 827 : TMPL_INST(CheckRequiredOrDefault, uint64_t, CHECK_NONFATAL(maybe_arg)->getInt<uint64_t>(););
732 : 970 : TMPL_INST(CheckRequiredOrDefault, uint32_t, CHECK_NONFATAL(maybe_arg)->getInt<uint32_t>(););
733 [ - + ]: 4197 : TMPL_INST(CheckRequiredOrDefault, std::string_view, CHECK_NONFATAL(maybe_arg)->get_str(););
734 : :
735 : 229339 : bool RPCMethod::IsValidNumArgs(size_t num_args) const
736 : : {
737 : 229339 : size_t num_required_args = 0;
738 [ - + + + ]: 468543 : for (size_t n = m_args.size(); n > 0; --n) {
739 [ + + ]: 396933 : if (!m_args.at(n - 1).IsOptional()) {
740 : : num_required_args = n;
741 : : break;
742 : : }
743 : : }
744 [ + + - + : 229339 : return num_required_args <= num_args && num_args <= m_args.size();
+ + ]
745 : : }
746 : :
747 : 168792 : std::vector<std::pair<std::string, bool>> RPCMethod::GetArgNames() const
748 : : {
749 : 168792 : std::vector<std::pair<std::string, bool>> ret;
750 [ - + + - ]: 168792 : ret.reserve(m_args.size());
751 [ + + ]: 473286 : for (const auto& arg : m_args) {
752 [ + + ]: 304494 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
753 [ + + ]: 57845 : for (const auto& inner : arg.m_inner) {
754 [ + - ]: 48759 : ret.emplace_back(inner.m_names, /*named_only=*/true);
755 : : }
756 : : }
757 [ + - ]: 304494 : ret.emplace_back(arg.m_names, /*named_only=*/false);
758 : : }
759 : 168792 : return ret;
760 : 0 : }
761 : :
762 : 44904 : size_t RPCMethod::GetParamIndex(std::string_view key) const
763 : : {
764 : 44904 : auto it{std::find_if(
765 [ - + ]: 93034 : m_args.begin(), m_args.end(), [&key](const auto& arg) { return arg.GetName() == key;}
766 : : )};
767 : :
768 : 44904 : CHECK_NONFATAL(it != m_args.end()); // TODO: ideally this is checked at compile time
769 : 44904 : return std::distance(m_args.begin(), it);
770 : : }
771 : :
772 : 1116 : std::string RPCMethod::ToString() const
773 : : {
774 [ - + ]: 1116 : std::string ret;
775 : :
776 : : // Oneline summary
777 [ - + ]: 1116 : ret += m_name;
778 : 1116 : bool was_optional{false};
779 [ + + ]: 3043 : for (const auto& arg : m_args) {
780 [ + + ]: 1936 : if (arg.m_opts.hidden) break; // Any arg that follows is also hidden
781 [ + - ]: 1927 : const bool optional = arg.IsOptional();
782 [ + - ]: 1927 : ret += " ";
783 [ + + ]: 1927 : if (optional) {
784 [ + + + - ]: 1081 : if (!was_optional) ret += "( ";
785 : : was_optional = true;
786 : : } else {
787 [ + + + - ]: 846 : if (was_optional) ret += ") ";
788 : : was_optional = false;
789 : : }
790 [ + - ]: 3854 : ret += arg.ToString(/*oneline=*/true);
791 : : }
792 [ + + + - ]: 1116 : if (was_optional) ret += " )";
793 : :
794 : : // Description
795 [ - + + - ]: 2232 : CHECK_NONFATAL(!m_description.starts_with('\n')); // Historically \n was required, but reject it for new code.
796 [ - + + - : 3348 : ret += "\n\n" + TrimString(m_description) + "\n";
+ - - + ]
797 : :
798 : : // Arguments
799 : 1116 : Sections sections;
800 : 1116 : Sections named_only_sections;
801 [ - + + + ]: 3043 : for (size_t i{0}; i < m_args.size(); ++i) {
802 [ + - ]: 1936 : const auto& arg = m_args.at(i);
803 [ + + ]: 1936 : if (arg.m_opts.hidden) break; // Any arg that follows is also hidden
804 : :
805 : : // Push named argument name and description
806 [ + - + - : 5781 : sections.m_sections.emplace_back(util::ToString(i + 1) + ". " + arg.GetFirstName(), arg.ToDescriptionString(/*is_named_arg=*/true));
+ - + - +
- ]
807 [ - + + + ]: 1927 : sections.m_max_pad = std::max(sections.m_max_pad, sections.m_sections.back().m_left.size());
808 : :
809 : : // Recursively push nested args
810 [ + - ]: 1927 : sections.Push(arg);
811 : :
812 : : // Push named-only argument sections
813 [ + + ]: 1927 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
814 [ + + ]: 417 : for (const auto& arg_inner : arg.m_inner) {
815 [ + - + - : 702 : named_only_sections.PushSection({arg_inner.GetFirstName(), arg_inner.ToDescriptionString(/*is_named_arg=*/true)});
+ - + - ]
816 [ + - ]: 351 : named_only_sections.Push(arg_inner);
817 : : }
818 : : }
819 : : }
820 : :
821 [ + + + - ]: 1116 : if (!sections.m_sections.empty()) ret += "\nArguments:\n";
822 [ + - ]: 2232 : ret += sections.ToString();
823 [ + + + - ]: 1116 : if (!named_only_sections.m_sections.empty()) ret += "\nNamed Arguments:\n";
824 [ + - ]: 2232 : ret += named_only_sections.ToString();
825 : :
826 : : // Result
827 [ + - ]: 2232 : ret += m_results.ToDescriptionString();
828 : :
829 : : // Examples
830 [ + - ]: 2232 : ret += m_examples.ToDescriptionString();
831 : :
832 : 1116 : return ret;
833 : 1116 : }
834 : :
835 : 350 : UniValue RPCMethod::GetArgMap() const
836 : : {
837 : 350 : UniValue arr{UniValue::VARR};
838 : :
839 : 1246 : auto push_back_arg_info = [&arr](const std::string& rpc_name, int pos, const std::string& arg_name, const RPCArg::Type& type) {
840 : 896 : UniValue map{UniValue::VARR};
841 [ + - + - ]: 896 : map.push_back(rpc_name);
842 [ + - + - ]: 896 : map.push_back(pos);
843 [ + - + - ]: 896 : map.push_back(arg_name);
844 [ + - + - ]: 896 : map.push_back(type == RPCArg::Type::STR ||
845 : : type == RPCArg::Type::STR_HEX);
846 [ + - ]: 896 : arr.push_back(std::move(map));
847 : 896 : };
848 : :
849 [ - + + + ]: 1040 : for (int i{0}; i < int(m_args.size()); ++i) {
850 [ + - ]: 690 : const auto& arg = m_args.at(i);
851 [ - + + - ]: 690 : std::vector<std::string> arg_names = SplitString(arg.m_names, '|');
852 [ + + ]: 1384 : for (const auto& arg_name : arg_names) {
853 [ + - ]: 694 : push_back_arg_info(m_name, i, arg_name, arg.m_type);
854 [ + + ]: 694 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
855 [ + + ]: 230 : for (const auto& inner : arg.m_inner) {
856 [ - + + - ]: 202 : std::vector<std::string> inner_names = SplitString(inner.m_names, '|');
857 [ + + ]: 404 : for (const std::string& inner_name : inner_names) {
858 [ + - ]: 202 : push_back_arg_info(m_name, i, inner_name, inner.m_type);
859 : : }
860 : 202 : }
861 : : }
862 : : }
863 : 690 : }
864 : 350 : return arr;
865 : 0 : }
866 : :
867 : 232111 : static std::optional<UniValue::VType> ExpectedType(RPCArg::Type type)
868 : : {
869 : 232111 : using Type = RPCArg::Type;
870 [ + + + + : 232111 : switch (type) {
+ + + - ]
871 : 146299 : case Type::STR_HEX:
872 : 146299 : case Type::STR: {
873 : 146299 : return UniValue::VSTR;
874 : : }
875 : 52864 : case Type::NUM: {
876 : 52864 : return UniValue::VNUM;
877 : : }
878 : 20496 : case Type::AMOUNT: {
879 : : // VNUM or VSTR, checked inside AmountFromValue()
880 : 20496 : return std::nullopt;
881 : : }
882 : 80 : case Type::RANGE: {
883 : : // VNUM or VARR, checked inside ParseRange()
884 : 80 : return std::nullopt;
885 : : }
886 : 3587 : case Type::BOOL: {
887 : 3587 : return UniValue::VBOOL;
888 : : }
889 : 3146 : case Type::OBJ:
890 : 3146 : case Type::OBJ_NAMED_PARAMS:
891 : 3146 : case Type::OBJ_USER_KEYS: {
892 : 3146 : return UniValue::VOBJ;
893 : : }
894 : 5639 : case Type::ARR: {
895 : 5639 : return UniValue::VARR;
896 : : }
897 : : } // no default case, so the compiler can warn about missing cases
898 [ # # ]: 0 : NONFATAL_UNREACHABLE();
899 : : }
900 : :
901 : 438048 : UniValue RPCArg::MatchesType(const UniValue& request) const
902 : : {
903 [ + + ]: 438048 : if (m_opts.skip_type_check) return true;
904 [ + + + + ]: 423863 : if (IsOptional() && request.isNull()) return true;
905 : 232111 : const auto exp_type{ExpectedType(m_type)};
906 [ + + ]: 232111 : if (!exp_type) return true; // nothing to check
907 : :
908 [ + + ]: 211535 : if (*exp_type != request.getType()) {
909 [ + - ]: 60 : return strprintf("JSON value of type %s is not of expected type %s", uvTypeName(request.getType()), uvTypeName(*exp_type));
910 : : }
911 : 211505 : return true;
912 : : }
913 : :
914 : 5732 : std::string RPCArg::GetFirstName() const
915 : : {
916 : 5732 : return m_names.substr(0, m_names.find('|'));
917 : : }
918 : :
919 : 93091 : std::string RPCArg::GetName() const
920 : : {
921 : 93091 : CHECK_NONFATAL(std::string::npos == m_names.find('|'));
922 [ - + ]: 93091 : return m_names;
923 : : }
924 : :
925 : 823336 : bool RPCArg::IsOptional() const
926 : : {
927 [ + + ]: 823336 : if (m_fallback.index() != 0) {
928 : : return true;
929 : : } else {
930 : 384638 : return RPCArg::Optional::NO != std::get<RPCArg::Optional>(m_fallback);
931 : : }
932 : : }
933 : :
934 : 3191 : std::string RPCArg::ToDescriptionString(bool is_named_arg) const
935 : : {
936 [ + - ]: 3191 : std::string ret;
937 [ + - ]: 3191 : ret += "(";
938 [ - + + + ]: 3191 : if (m_opts.type_str.size() != 0) {
939 [ + - - + ]: 32 : ret += m_opts.type_str.at(1);
940 : : } else {
941 [ + + + + : 3159 : switch (m_type) {
+ + + - ]
942 : 1313 : case Type::STR_HEX:
943 : 1313 : case Type::STR: {
944 [ + - ]: 1313 : ret += "string";
945 : : break;
946 : : }
947 : 559 : case Type::NUM: {
948 [ + - ]: 559 : ret += "numeric";
949 : : break;
950 : : }
951 : 147 : case Type::AMOUNT: {
952 [ + - ]: 147 : ret += "numeric or string";
953 : : break;
954 : : }
955 : 60 : case Type::RANGE: {
956 [ + - ]: 60 : ret += "numeric or array";
957 : : break;
958 : : }
959 : 478 : case Type::BOOL: {
960 [ + - ]: 478 : ret += "boolean";
961 : : break;
962 : : }
963 : 270 : case Type::OBJ:
964 : 270 : case Type::OBJ_NAMED_PARAMS:
965 : 270 : case Type::OBJ_USER_KEYS: {
966 [ + - ]: 270 : ret += "json object";
967 : : break;
968 : : }
969 : 332 : case Type::ARR: {
970 [ + - + + ]: 3191 : ret += "json array";
971 : : break;
972 : : }
973 : : } // no default case, so the compiler can warn about missing cases
974 : : }
975 [ + + ]: 3191 : if (m_fallback.index() == 1) {
976 [ + - ]: 766 : ret += ", optional, default=" + std::get<RPCArg::DefaultHint>(m_fallback);
977 [ + + ]: 2808 : } else if (m_fallback.index() == 2) {
978 [ + - + - ]: 1796 : ret += ", optional, default=" + std::get<RPCArg::Default>(m_fallback).write();
979 : : } else {
980 [ - + + + : 1910 : switch (std::get<RPCArg::Optional>(m_fallback)) {
- ]
981 : 775 : case RPCArg::Optional::OMITTED: {
982 [ + + + - ]: 775 : if (is_named_arg) ret += ", optional"; // Default value is "null" in dicts. Otherwise,
983 : : // nothing to do. Element is treated as if not present and has no default value
984 : : break;
985 : : }
986 : 1135 : case RPCArg::Optional::NO: {
987 [ + - ]: 1135 : ret += ", required";
988 : : break;
989 : : }
990 : : } // no default case, so the compiler can warn about missing cases
991 : : }
992 [ + - ]: 3191 : ret += ")";
993 [ + + + - ]: 3191 : if (m_type == Type::OBJ_NAMED_PARAMS) ret += " Options object that can be used to pass named arguments, listed below.";
994 [ + + + - : 6382 : ret += m_description.empty() ? "" : " " + m_description;
+ - ]
995 : 3191 : return ret;
996 : 0 : }
997 : :
998 : : // NOLINTNEXTLINE(misc-no-recursion)
999 : 12959 : void RPCResult::ToSections(Sections& sections, const OuterType outer_type, const int current_indent) const
1000 : : {
1001 : : // Indentation
1002 [ + - ]: 12959 : const std::string indent(current_indent, ' ');
1003 [ + - + + ]: 12959 : const std::string indent_next(current_indent + 2, ' ');
1004 : :
1005 : : // Elements in a JSON structure (dictionary or array) are separated by a comma
1006 [ + + + - ]: 14284 : const std::string maybe_separator{outer_type != OuterType::NONE ? "," : ""};
1007 : :
1008 : : // The key name if recursed into a dictionary
1009 : 12959 : const std::string maybe_key{
1010 [ + + ]: 12959 : outer_type == OuterType::OBJ ?
1011 [ + - - - ]: 10447 : "\"" + this->m_key_name + "\" : " :
1012 [ + - + - ]: 23406 : ""};
1013 : :
1014 : : // Format description with type
1015 : 24829 : const auto Description = [&](const std::string& type) {
1016 [ + + + - : 44923 : return "(" + type + (this->m_optional ? ", optional" : "") + ")" +
+ - ]
1017 [ + + + - ]: 35610 : (this->m_description.empty() ? "" : " " + this->m_description);
1018 : 12959 : };
1019 : :
1020 : : // Ensure at least one visible field exists when elision is used
1021 : 15922 : const auto elision_has_description{[](const std::vector<RPCResult>& inner) {
1022 : 5989 : return std::ranges::any_of(inner, [](const auto& res) {
1023 [ + + ]: 3026 : return !std::holds_alternative<HelpElisionSkip>(res.m_opts.print_elision);
1024 : : });
1025 : : }};
1026 : :
1027 : 12959 : if (const auto* text = std::get_if<std::string>(&m_opts.print_elision)) {
1028 [ + - + - : 190 : sections.PushSection({indent + "..." + maybe_separator, *text});
+ - + - ]
1029 : 95 : return;
1030 : : }
1031 [ + + ]: 12864 : if (std::holds_alternative<HelpElisionSkip>(m_opts.print_elision)) {
1032 : : return;
1033 : : }
1034 : :
1035 [ + + + + : 11870 : switch (m_type) {
+ + + + +
+ - ]
1036 : 36 : case Type::ANY: {
1037 [ + - + - : 108 : sections.PushSection({indent + maybe_key + "xxx" + maybe_separator, Description("any")});
+ - + - +
- + - ]
1038 : 36 : return;
1039 : : }
1040 : 139 : case Type::NONE: {
1041 [ + - + - : 278 : sections.PushSection({indent + "null" + maybe_separator, Description("json null")});
+ - + - +
- + - ]
1042 : 139 : return;
1043 : : }
1044 : 2092 : case Type::STR: {
1045 [ + - + - : 6276 : sections.PushSection({indent + maybe_key + "\"str\"" + maybe_separator, Description("string")});
+ - + - +
- + - ]
1046 : 2092 : return;
1047 : : }
1048 : 547 : case Type::STR_AMOUNT: {
1049 [ + - + - : 1641 : sections.PushSection({indent + maybe_key + "n" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1050 : 547 : return;
1051 : : }
1052 : 1916 : case Type::STR_HEX: {
1053 [ + - + - : 5748 : sections.PushSection({indent + maybe_key + "\"hex\"" + maybe_separator, Description("string")});
+ - + - +
- + - ]
1054 : 1916 : return;
1055 : : }
1056 : 3074 : case Type::NUM: {
1057 [ + - + - : 9222 : sections.PushSection({indent + maybe_key + "n" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1058 : 3074 : return;
1059 : : }
1060 : 357 : case Type::NUM_TIME: {
1061 [ + - + - : 1071 : sections.PushSection({indent + maybe_key + "xxx" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1062 : 357 : return;
1063 : : }
1064 : 728 : case Type::BOOL: {
1065 [ + - + - : 2184 : sections.PushSection({indent + maybe_key + "true|false" + maybe_separator, Description("boolean")});
+ - + - +
- + - ]
1066 : 728 : return;
1067 : : }
1068 : 1123 : case Type::ARR_FIXED:
1069 : 1123 : case Type::ARR: {
1070 [ + - + - : 3369 : sections.PushSection({indent + maybe_key + "[", Description("json array")});
+ - + - +
- ]
1071 [ + + ]: 2310 : for (const auto& i : m_inner) {
1072 [ + - ]: 1187 : i.ToSections(sections, OuterType::ARR, current_indent + 2);
1073 : : }
1074 [ + - ]: 1123 : CHECK_NONFATAL(!m_inner.empty());
1075 [ + - ]: 1123 : CHECK_NONFATAL(elision_has_description(m_inner));
1076 [ + + + + ]: 1123 : if (m_type == Type::ARR && !std::holds_alternative<std::string>(m_inner.back().m_opts.print_elision)) {
1077 [ + - + - : 2206 : sections.PushSection({indent_next + "...", ""});
+ - + - ]
1078 : : } else {
1079 : : // Remove final comma, which would be invalid JSON
1080 : 20 : sections.m_sections.back().m_left.pop_back();
1081 : : }
1082 [ + - + - : 2246 : sections.PushSection({indent + "]" + maybe_separator, ""});
+ - + - +
- ]
1083 : 1123 : return;
1084 : : }
1085 : 1858 : case Type::OBJ_DYN:
1086 : 1858 : case Type::OBJ: {
1087 [ + + ]: 1858 : if (m_inner.empty()) {
1088 [ + - + - : 54 : sections.PushSection({indent + maybe_key + "{}", Description("empty JSON object")});
+ - + - +
- ]
1089 : 18 : return;
1090 : : }
1091 [ + - ]: 1840 : CHECK_NONFATAL(elision_has_description(m_inner));
1092 [ + - + - : 5520 : sections.PushSection({indent + maybe_key + "{", Description("json object")});
+ - + - +
- ]
1093 [ + + ]: 12287 : for (const auto& i : m_inner) {
1094 [ + - ]: 10447 : i.ToSections(sections, OuterType::OBJ, current_indent + 2);
1095 : : }
1096 [ + + ]: 1840 : if (m_type == Type::OBJ_DYN) {
1097 : : // If the dictionary keys are dynamic, use three dots for continuation
1098 [ + - + - : 404 : sections.PushSection({indent_next + "...", ""});
+ - + - ]
1099 : : } else {
1100 : : // Remove final comma, which would be invalid JSON
1101 : 1638 : sections.m_sections.back().m_left.pop_back();
1102 : : }
1103 [ + - + - : 3680 : sections.PushSection({indent + "}" + maybe_separator, ""});
+ - + - +
- ]
1104 : 1840 : return;
1105 : : }
1106 : : } // no default case, so the compiler can warn about missing cases
1107 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1108 : 12959 : }
1109 : :
1110 : 5303160 : static std::optional<UniValue::VType> ExpectedType(RPCResult::Type type)
1111 : : {
1112 : 5303160 : using Type = RPCResult::Type;
1113 [ + + + + : 5303160 : switch (type) {
+ + + - ]
1114 : 17 : case Type::ANY: {
1115 : 17 : return std::nullopt;
1116 : : }
1117 : 38276 : case Type::NONE: {
1118 : 38276 : return UniValue::VNULL;
1119 : : }
1120 : 2130988 : case Type::STR:
1121 : 2130988 : case Type::STR_HEX: {
1122 : 2130988 : return UniValue::VSTR;
1123 : : }
1124 : 1979943 : case Type::NUM:
1125 : 1979943 : case Type::STR_AMOUNT:
1126 : 1979943 : case Type::NUM_TIME: {
1127 : 1979943 : return UniValue::VNUM;
1128 : : }
1129 : 378273 : case Type::BOOL: {
1130 : 378273 : return UniValue::VBOOL;
1131 : : }
1132 : 258754 : case Type::ARR_FIXED:
1133 : 258754 : case Type::ARR: {
1134 : 258754 : return UniValue::VARR;
1135 : : }
1136 : 516909 : case Type::OBJ_DYN:
1137 : 516909 : case Type::OBJ: {
1138 : 516909 : return UniValue::VOBJ;
1139 : : }
1140 : : } // no default case, so the compiler can warn about missing cases
1141 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1142 : : }
1143 : :
1144 : : // NOLINTNEXTLINE(misc-no-recursion)
1145 : 5303601 : UniValue RPCResult::MatchesType(const UniValue& result) const
1146 : : {
1147 [ + + ]: 5303601 : if (m_opts.skip_type_check) {
1148 : 441 : return true;
1149 : : }
1150 : :
1151 : 5303160 : const auto exp_type = ExpectedType(m_type);
1152 [ + + ]: 5303160 : if (!exp_type) return true; // can be any type, so nothing to check
1153 : :
1154 [ + + ]: 5303143 : if (*exp_type != result.getType()) {
1155 [ + - ]: 40382 : return strprintf("returned type is %s, but declared as %s in doc", uvTypeName(result.getType()), uvTypeName(*exp_type));
1156 : : }
1157 : :
1158 [ + + ]: 5282952 : if (UniValue::VARR == result.getType()) {
1159 : 257538 : UniValue errors(UniValue::VOBJ);
1160 [ + - - + : 1252078 : for (size_t i{0}; i < result.get_array().size(); ++i) {
+ + ]
1161 : : // If there are more results than documented, reuse the last doc_inner.
1162 [ - + + + : 1987575 : const RPCResult& doc_inner{m_inner.at(std::min(m_inner.size() - 1, i))};
+ - ]
1163 [ + - + - : 994540 : UniValue match{doc_inner.MatchesType(result.get_array()[i])};
+ - ]
1164 [ + + + - : 995007 : if (!match.isTrue()) errors.pushKV(strprintf("%d", i), std::move(match));
+ - ]
1165 : 994540 : }
1166 [ - + + + : 257538 : if (errors.empty()) return true; // empty result array is valid
+ - ]
1167 : 411 : return errors;
1168 : 257538 : }
1169 : :
1170 [ + + ]: 5025414 : if (UniValue::VOBJ == result.getType()) {
1171 : 516420 : UniValue errors(UniValue::VOBJ);
1172 [ + + ]: 516420 : if (m_type == Type::OBJ_DYN) {
1173 [ + - ]: 33855 : const RPCResult& doc_inner{m_inner.at(0)}; // Assume all types are the same, randomly pick the first
1174 [ + - - + : 325047 : for (size_t i{0}; i < result.get_obj().size(); ++i) {
+ + ]
1175 [ + - + - : 291192 : UniValue match{doc_inner.MatchesType(result.get_obj()[i])};
+ - ]
1176 [ + + + - : 291272 : if (!match.isTrue()) errors.pushKV(result.getKeys()[i], std::move(match));
- + + - ]
1177 : 291192 : }
1178 [ - + + + : 33855 : if (errors.empty()) return true; // empty result obj is valid
+ - ]
1179 : 20 : return errors;
1180 : : }
1181 : 482565 : std::set<std::string> doc_keys;
1182 [ + + ]: 4567422 : for (const auto& doc_entry : m_inner) {
1183 [ + - ]: 4084857 : doc_keys.insert(doc_entry.m_key_name);
1184 : : }
1185 [ + - ]: 482565 : std::map<std::string, UniValue> result_obj;
1186 [ + - ]: 482565 : result.getObjMap(result_obj);
1187 [ + + ]: 4256841 : for (const auto& result_entry : result_obj) {
1188 [ + + ]: 3774276 : if (!doc_keys.contains(result_entry.first)) {
1189 [ + - - + : 90 : errors.pushKV(result_entry.first, "key returned that was not in doc");
+ - ]
1190 : : }
1191 : : }
1192 : :
1193 [ + + ]: 4567422 : for (const auto& doc_entry : m_inner) {
1194 : 4084857 : const auto result_it{result_obj.find(doc_entry.m_key_name)};
1195 [ + + ]: 4084857 : if (result_it == result_obj.end()) {
1196 [ - + ]: 310611 : if (!doc_entry.m_optional) {
1197 [ # # # # : 0 : errors.pushKV(doc_entry.m_key_name, "key missing, despite not being optional in doc");
# # ]
1198 : : }
1199 : 310611 : continue;
1200 : : }
1201 [ + - ]: 3774246 : UniValue match{doc_entry.MatchesType(result_it->second)};
1202 [ + + - + : 3774988 : if (!match.isTrue()) errors.pushKV(doc_entry.m_key_name, std::move(match));
+ - ]
1203 : 3774246 : }
1204 [ - + + + : 482565 : if (errors.empty()) return true;
+ - ]
1205 : 396 : return errors;
1206 : 516420 : }
1207 : :
1208 : 4508994 : return true;
1209 : : }
1210 : :
1211 : 7492178 : void RPCResult::CheckInnerDoc() const
1212 : : {
1213 [ + + ]: 7492178 : if (m_type == Type::OBJ) {
1214 : : // May or may not be empty
1215 : : return;
1216 : : }
1217 : : // Everything else must either be empty or not
1218 [ + + + + ]: 6600828 : const bool inner_needed{m_type == Type::ARR || m_type == Type::ARR_FIXED || m_type == Type::OBJ_DYN};
1219 : 6600828 : CHECK_NONFATAL(inner_needed != m_inner.empty());
1220 : : }
1221 : :
1222 : : // NOLINTNEXTLINE(misc-no-recursion)
1223 : 787 : std::string RPCArg::ToStringObj(const bool oneline) const
1224 : : {
1225 [ + - ]: 787 : std::string res;
1226 [ + - ]: 787 : res += "\"";
1227 [ + - ]: 1574 : res += GetFirstName();
1228 [ + + ]: 787 : if (oneline) {
1229 [ + - ]: 368 : res += "\":";
1230 : : } else {
1231 [ + - ]: 419 : res += "\": ";
1232 : : }
1233 [ + + + + : 787 : switch (m_type) {
+ + + -
- ]
1234 : 111 : case Type::STR:
1235 [ + - ]: 111 : return res + "\"str\"";
1236 : 259 : case Type::STR_HEX:
1237 [ + - ]: 259 : return res + "\"hex\"";
1238 : 187 : case Type::NUM:
1239 [ + - ]: 187 : return res + "n";
1240 : 69 : case Type::RANGE:
1241 [ + - ]: 69 : return res + "n or [n,n]";
1242 : 98 : case Type::AMOUNT:
1243 [ + - ]: 98 : return res + "amount";
1244 : 45 : case Type::BOOL:
1245 [ + - ]: 45 : return res + "bool";
1246 : 18 : case Type::ARR:
1247 [ + - ]: 18 : res += "[";
1248 [ + + ]: 45 : for (const auto& i : m_inner) {
1249 [ + - - + ]: 81 : res += i.ToString(oneline) + ",";
1250 : : }
1251 [ + - ]: 18 : return res + "...]";
1252 : 0 : case Type::OBJ:
1253 : 0 : case Type::OBJ_NAMED_PARAMS:
1254 : 0 : case Type::OBJ_USER_KEYS:
1255 : : // Currently unused, so avoid writing dead code
1256 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1257 : : } // no default case, so the compiler can warn about missing cases
1258 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1259 : 787 : }
1260 : :
1261 : : // NOLINTNEXTLINE(misc-no-recursion)
1262 : 2470 : std::string RPCArg::ToString(const bool oneline) const
1263 : : {
1264 [ + + + + ]: 2470 : if (oneline && !m_opts.oneline_description.empty()) {
1265 [ + + + - : 86 : if (m_opts.oneline_description[0] == '\"' && m_type != Type::STR_HEX && m_type != Type::STR && gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
- + - - -
- - + ]
1266 : 0 : throw std::runtime_error{
1267 [ # # # # ]: 0 : STR_INTERNAL_BUG(strprintf("non-string RPC arg \"%s\" quotes oneline_description:\n%s",
1268 : : m_names, m_opts.oneline_description)
1269 [ # # ]: 0 : )};
1270 : : }
1271 [ - + ]: 86 : return m_opts.oneline_description;
1272 : : }
1273 : :
1274 [ + + + + : 2384 : switch (m_type) {
- ]
1275 : 1222 : case Type::STR_HEX:
1276 : 1222 : case Type::STR: {
1277 [ + - ]: 2444 : return "\"" + GetFirstName() + "\"";
1278 : : }
1279 : 787 : case Type::NUM:
1280 : 787 : case Type::RANGE:
1281 : 787 : case Type::AMOUNT:
1282 : 787 : case Type::BOOL: {
1283 : 787 : return GetFirstName();
1284 : : }
1285 : 165 : case Type::OBJ:
1286 : 165 : case Type::OBJ_NAMED_PARAMS:
1287 : 165 : case Type::OBJ_USER_KEYS: {
1288 : : // NOLINTNEXTLINE(misc-no-recursion)
1289 [ + - ]: 533 : const std::string res = Join(m_inner, ",", [&](const RPCArg& i) { return i.ToStringObj(oneline); });
1290 [ + + ]: 165 : if (m_type == Type::OBJ) {
1291 [ + - ]: 208 : return "{" + res + "}";
1292 : : } else {
1293 [ + - ]: 122 : return "{" + res + ",...}";
1294 : : }
1295 : 165 : }
1296 : 210 : case Type::ARR: {
1297 : 210 : std::string res;
1298 [ + + ]: 469 : for (const auto& i : m_inner) {
1299 [ + - - + ]: 777 : res += i.ToString(oneline) + ",";
1300 : : }
1301 [ + - ]: 420 : return "[" + res + "...]";
1302 : 210 : }
1303 : : } // no default case, so the compiler can warn about missing cases
1304 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1305 : : }
1306 : :
1307 : 296 : static std::pair<int64_t, int64_t> ParseRange(const UniValue& value)
1308 : : {
1309 [ + + ]: 296 : if (value.isNum()) {
1310 : 86 : return {0, value.getInt<int64_t>()};
1311 : : }
1312 [ + - + - : 420 : if (value.isArray() && value.size() == 2 && value[0].isNum() && value[1].isNum()) {
+ - + - ]
1313 : 210 : int64_t low = value[0].getInt<int64_t>();
1314 : 210 : int64_t high = value[1].getInt<int64_t>();
1315 [ + + + - : 214 : if (low > high) throw JSONRPCError(RPC_INVALID_PARAMETER, "Range specified as [begin,end] must not have begin after end");
+ - ]
1316 : 206 : return {low, high};
1317 : : }
1318 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range must be specified as end or as [begin,end]");
1319 : : }
1320 : :
1321 : 296 : std::pair<int64_t, int64_t> ParseDescriptorRange(const UniValue& value)
1322 : : {
1323 : 296 : int64_t low, high;
1324 [ + + ]: 296 : std::tie(low, high) = ParseRange(value);
1325 [ + + ]: 292 : if (low < 0) {
1326 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should be greater or equal than 0");
1327 : : }
1328 [ + + ]: 288 : if ((high >> 31) != 0) {
1329 [ + - + - ]: 12 : throw JSONRPCError(RPC_INVALID_PARAMETER, "End of range is too high");
1330 : : }
1331 [ + + ]: 282 : if (high >= low + 1000000) {
1332 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range is too large");
1333 : : }
1334 : 278 : return {low, high};
1335 : : }
1336 : :
1337 : 1633 : std::vector<CScript> EvalDescriptorStringOrObject(const UniValue& scanobject, FlatSigningProvider& provider, const bool expand_priv)
1338 : : {
1339 [ + + ]: 1633 : std::string desc_str;
1340 : 1633 : std::pair<int64_t, int64_t> range = {0, 1000};
1341 [ + + ]: 1633 : if (scanobject.isStr()) {
1342 [ + - + - ]: 1525 : desc_str = scanobject.get_str();
1343 [ + - ]: 108 : } else if (scanobject.isObject()) {
1344 [ + - ]: 108 : const UniValue& desc_uni{scanobject.find_value("desc")};
1345 [ - + - - : 108 : if (desc_uni.isNull()) throw JSONRPCError(RPC_INVALID_PARAMETER, "Descriptor needs to be provided in scan object");
- - ]
1346 [ + - + - ]: 108 : desc_str = desc_uni.get_str();
1347 [ + - ]: 108 : const UniValue& range_uni{scanobject.find_value("range")};
1348 [ + + ]: 108 : if (!range_uni.isNull()) {
1349 [ + + ]: 99 : range = ParseDescriptorRange(range_uni);
1350 : : }
1351 : : } else {
1352 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Scan object needs to be either a string or an object");
1353 : : }
1354 : :
1355 [ - + ]: 1628 : std::string error;
1356 [ - + + - ]: 1628 : auto descs = Parse(desc_str, provider, error);
1357 [ + + ]: 1628 : if (descs.empty()) {
1358 [ + - ]: 1 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
1359 : : }
1360 [ + - + - : 1627 : if (!descs.at(0)->IsRange()) {
+ + ]
1361 : 1533 : range.first = 0;
1362 : 1533 : range.second = 0;
1363 : : }
1364 : 1627 : std::vector<CScript> ret;
1365 [ + + ]: 21372 : for (int i = range.first; i <= range.second; ++i) {
1366 [ + + ]: 39491 : for (const auto& desc : descs) {
1367 : 19746 : std::vector<CScript> scripts;
1368 [ + - - + ]: 19746 : if (!desc->Expand(i, provider, scripts, provider)) {
1369 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Cannot derive script without private keys: '%s'", desc_str));
1370 : : }
1371 [ + + ]: 19746 : if (expand_priv) {
1372 [ + - ]: 110 : desc->ExpandPrivate(/*pos=*/i, provider, /*out=*/provider);
1373 : : }
1374 [ + - ]: 19746 : std::move(scripts.begin(), scripts.end(), std::back_inserter(ret));
1375 : 19746 : }
1376 : : }
1377 : 3254 : return ret;
1378 : 1629 : }
1379 : :
1380 : : /** Convert a vector of bilingual strings to a UniValue::VARR containing their original untranslated values. */
1381 : 11 : [[nodiscard]] static UniValue BilingualStringsToUniValue(const std::vector<bilingual_str>& bilingual_strings)
1382 : : {
1383 : 11 : CHECK_NONFATAL(!bilingual_strings.empty());
1384 : 11 : UniValue result{UniValue::VARR};
1385 [ + + ]: 22 : for (const auto& s : bilingual_strings) {
1386 [ + - + - ]: 11 : result.push_back(s.original);
1387 : : }
1388 : 11 : return result;
1389 : 0 : }
1390 : :
1391 : 831 : void PushWarnings(const UniValue& warnings, UniValue& obj)
1392 : : {
1393 [ - + + + ]: 831 : if (warnings.empty()) return;
1394 [ + - + - ]: 766 : obj.pushKV("warnings", warnings);
1395 : : }
1396 : :
1397 : 1075 : void PushWarnings(const std::vector<bilingual_str>& warnings, UniValue& obj)
1398 : : {
1399 [ + + ]: 1075 : if (warnings.empty()) return;
1400 [ + - + - ]: 22 : obj.pushKV("warnings", BilingualStringsToUniValue(warnings));
1401 : : }
1402 : :
1403 : 70244 : std::vector<RPCResult> ScriptPubKeyDoc() {
1404 : 70244 : return
1405 : : {
1406 [ + - + - ]: 140488 : {RPCResult::Type::STR, "asm", "Disassembly of the output script"},
1407 [ + - + - ]: 140488 : {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},
1408 [ + - + - ]: 140488 : {RPCResult::Type::STR_HEX, "hex", "The raw output script bytes, hex-encoded"},
1409 [ + - + - ]: 140488 : {RPCResult::Type::STR, "address", /*optional=*/true, "The Bitcoin address (only if a well-defined address exists)"},
1410 [ + - + - : 140488 : {RPCResult::Type::STR, "type", "The type (one of: " + GetAllOutputTypes() + ")"},
+ - ]
1411 [ + - + + : 913172 : };
- - ]
1412 [ + - + - : 702440 : }
+ - + - +
- - - ]
1413 : :
1414 : 21487 : uint256 GetTarget(const CBlockIndex& blockindex, const uint256 pow_limit)
1415 : : {
1416 : 21487 : arith_uint256 target{*CHECK_NONFATAL(DeriveTarget(blockindex.nBits, pow_limit))};
1417 : 21487 : return ArithToUint256(target);
1418 : : }
1419 : :
1420 : 39297 : std::vector<RPCResult> ElideGroup(std::vector<RPCResult> fields, std::string summary)
1421 : : {
1422 [ - + ]: 39297 : if (fields.empty()) return fields;
1423 : 39297 : std::vector<RPCResult> result;
1424 [ - + + - ]: 39297 : result.reserve(fields.size());
1425 [ - + + + ]: 308314 : for (size_t i = 0; i < fields.size(); ++i) {
1426 [ + - ]: 269017 : RPCResultOptions opts = fields[i].m_opts;
1427 [ + + ]: 269017 : if (i == 0) {
1428 [ + - ]: 39297 : opts.print_elision = summary;
1429 : : } else {
1430 : 229720 : opts.print_elision = HelpElisionSkip{};
1431 : : }
1432 [ + - ]: 269017 : result.emplace_back(fields[i], std::move(opts));
1433 : 269017 : }
1434 : 39297 : return result;
1435 : 39297 : }
|
