Branch data Line data Source code
1 : : // Copyright (c) 2017-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
6 : :
7 : : #include <clientversion.h>
8 : : #include <common/args.h>
9 : : #include <common/messages.h>
10 : : #include <common/types.h>
11 : : #include <consensus/amount.h>
12 : : #include <core_io.h>
13 : : #include <key_io.h>
14 : : #include <node/types.h>
15 : : #include <outputtype.h>
16 : : #include <rpc/util.h>
17 : : #include <script/descriptor.h>
18 : : #include <script/interpreter.h>
19 : : #include <script/signingprovider.h>
20 : : #include <script/solver.h>
21 : : #include <tinyformat.h>
22 : : #include <uint256.h>
23 : : #include <univalue.h>
24 : : #include <util/check.h>
25 : : #include <util/result.h>
26 : : #include <util/strencodings.h>
27 : : #include <util/string.h>
28 : : #include <util/translation.h>
29 : :
30 : : #include <algorithm>
31 : : #include <iterator>
32 : : #include <string_view>
33 : : #include <tuple>
34 : : #include <utility>
35 : :
36 : : using common::PSBTError;
37 : : using common::PSBTErrorString;
38 : : using common::TransactionErrorString;
39 : : using node::TransactionError;
40 : : using util::Join;
41 : : using util::SplitString;
42 : : using util::TrimString;
43 : :
44 : : const std::string UNIX_EPOCH_TIME = "UNIX epoch time";
45 : : const std::string EXAMPLE_ADDRESS[2] = {"bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl", "bc1q02ad21edsxd23d32dfgqqsz4vv4nmtfzuklhy3"};
46 : :
47 : 19020 : std::string GetAllOutputTypes()
48 : : {
49 : 19020 : std::vector<std::string> ret;
50 : 19020 : using U = std::underlying_type<TxoutType>::type;
51 [ + + ]: 228240 : for (U i = (U)TxoutType::NONSTANDARD; i <= (U)TxoutType::WITNESS_UNKNOWN; ++i) {
52 [ + - + - ]: 418440 : ret.emplace_back(GetTxnOutputType(static_cast<TxoutType>(i)));
53 : : }
54 [ + - ]: 38040 : return Join(ret, ", ");
55 : 19020 : }
56 : :
57 : 1184 : void RPCTypeCheckObj(const UniValue& o,
58 : : const std::map<std::string, UniValueType>& typesExpected,
59 : : bool fAllowNull,
60 : : bool fStrict)
61 : : {
62 [ + + ]: 16954 : for (const auto& t : typesExpected) {
63 : 15806 : const UniValue& v = o.find_value(t.first);
64 [ + + + + ]: 15806 : if (!fAllowNull && v.isNull())
65 [ + - + - ]: 22 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Missing %s", t.first));
66 : :
67 [ + + + + : 28307 : if (!(t.second.typeAny || v.type() == t.second.type || (fAllowNull && v.isNull())))
+ + ]
68 [ + - + - : 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)));
+ - + - ]
69 : : }
70 : :
71 [ + + ]: 1148 : if (fStrict)
72 : : {
73 [ + + ]: 2491 : for (const std::string& k : o.getKeys())
74 : : {
75 [ + + ]: 1767 : if (typesExpected.count(k) == 0)
76 : : {
77 : 4 : std::string err = strprintf("Unexpected key %s", k);
78 [ + - ]: 4 : throw JSONRPCError(RPC_TYPE_ERROR, err);
79 : 4 : }
80 : : }
81 : : }
82 : 1144 : }
83 : :
84 : 6508 : int ParseVerbosity(const UniValue& arg, int default_verbosity, bool allow_bool)
85 : : {
86 [ + + ]: 6508 : if (!arg.isNull()) {
87 [ + + ]: 4515 : if (arg.isBool()) {
88 [ + + ]: 3033 : if (!allow_bool) {
89 [ + - + - ]: 4 : throw JSONRPCError(RPC_TYPE_ERROR, "Verbosity was boolean but only integer allowed");
90 : : }
91 : 3031 : return arg.get_bool(); // true = 1
92 : : } else {
93 : 1482 : return arg.getInt<int>();
94 : : }
95 : : }
96 : : return default_verbosity;
97 : : }
98 : :
99 : 37272 : CAmount AmountFromValue(const UniValue& value, int decimals)
100 : : {
101 [ + + + + ]: 37272 : if (!value.isNum() && !value.isStr())
102 [ + - + - ]: 24 : throw JSONRPCError(RPC_TYPE_ERROR, "Amount is not a number or string");
103 : 37260 : CAmount amount;
104 [ + + ]: 37260 : if (!ParseFixedPoint(value.getValStr(), decimals, &amount))
105 [ + - + - ]: 166 : throw JSONRPCError(RPC_TYPE_ERROR, "Invalid amount");
106 [ + + ]: 37177 : if (!MoneyRange(amount))
107 [ + - + - ]: 24 : throw JSONRPCError(RPC_TYPE_ERROR, "Amount out of range");
108 : 37165 : return amount;
109 : : }
110 : :
111 : 22135 : CFeeRate ParseFeeRate(const UniValue& json)
112 : : {
113 : 22135 : CAmount val{AmountFromValue(json)};
114 [ + + + - : 22135 : if (val >= COIN) throw JSONRPCError(RPC_INVALID_PARAMETER, "Fee rates larger than or equal to 1BTC/kvB are not accepted");
+ - ]
115 : 22133 : return CFeeRate{val};
116 : : }
117 : :
118 : 18079 : uint256 ParseHashV(const UniValue& v, std::string_view name)
119 : : {
120 : 18079 : const std::string& strHex(v.get_str());
121 [ + + ]: 18078 : if (auto rv{uint256::FromHex(strHex)}) return *rv;
122 [ + + ]: 28 : if (auto expected_len{uint256::size() * 2}; strHex.length() != expected_len) {
123 [ + - + - ]: 32 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be of length %d (not %d, for '%s')", name, expected_len, strHex.length(), strHex));
124 : : }
125 [ + - + - ]: 24 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be hexadecimal string (not '%s')", name, strHex));
126 : : }
127 : 5967 : uint256 ParseHashO(const UniValue& o, std::string_view strKey)
128 : : {
129 : 5967 : return ParseHashV(o.find_value(strKey), strKey);
130 : : }
131 : 420 : std::vector<unsigned char> ParseHexV(const UniValue& v, std::string_view name)
132 : : {
133 [ + - ]: 420 : std::string strHex;
134 [ + - ]: 420 : if (v.isStr())
135 [ + - + - ]: 420 : strHex = v.get_str();
136 [ + - + + ]: 420 : if (!IsHex(strHex))
137 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s must be hexadecimal string (not '%s')", name, strHex));
138 [ + - ]: 416 : return ParseHex(strHex);
139 : 416 : }
140 : 181 : std::vector<unsigned char> ParseHexO(const UniValue& o, std::string_view strKey)
141 : : {
142 : 181 : return ParseHexV(o.find_value(strKey), strKey);
143 : : }
144 : :
145 : : namespace {
146 : :
147 : : /**
148 : : * Quote an argument for shell.
149 : : *
150 : : * @note This is intended for help, not for security-sensitive purposes.
151 : : */
152 : 794 : std::string ShellQuote(const std::string& s)
153 : : {
154 [ + - ]: 794 : std::string result;
155 [ + - ]: 794 : result.reserve(s.size() * 2);
156 [ + + ]: 23731 : for (const char ch: s) {
157 [ + + ]: 22937 : if (ch == '\'') {
158 [ + - ]: 1 : result += "'\''";
159 : : } else {
160 [ + - ]: 45873 : result += ch;
161 : : }
162 : : }
163 [ + - ]: 1588 : return "'" + result + "'";
164 : 794 : }
165 : :
166 : : /**
167 : : * Shell-quotes the argument if it needs quoting, else returns it literally, to save typing.
168 : : *
169 : : * @note This is intended for help, not for security-sensitive purposes.
170 : : */
171 : 9007 : std::string ShellQuoteIfNeeded(const std::string& s)
172 : : {
173 [ + + ]: 77492 : for (const char ch: s) {
174 [ + + ]: 69279 : if (ch == ' ' || ch == '\'' || ch == '"') {
175 : 794 : return ShellQuote(s);
176 : : }
177 : : }
178 : :
179 : 8213 : return s;
180 : : }
181 : :
182 : : }
183 : :
184 : 617239 : std::string HelpExampleCli(const std::string& methodname, const std::string& args)
185 : : {
186 [ + - + - ]: 1851717 : return "> bitcoin-cli " + methodname + " " + args + "\n";
187 : : }
188 : :
189 : 2854 : std::string HelpExampleCliNamed(const std::string& methodname, const RPCArgList& args)
190 : : {
191 : 2854 : std::string result = "> bitcoin-cli -named " + methodname;
192 [ + + ]: 11861 : for (const auto& argpair: args) {
193 [ + + ]: 9007 : const auto& value = argpair.second.isStr()
194 [ + + + - ]: 9007 : ? argpair.second.get_str()
195 [ + - + - ]: 9007 : : argpair.second.write();
196 [ + - + - : 27021 : result += " " + argpair.first + "=" + ShellQuoteIfNeeded(value);
+ - ]
197 : 9007 : }
198 [ + - ]: 2854 : result += "\n";
199 : 2854 : return result;
200 : 0 : }
201 : :
202 : 412413 : std::string HelpExampleRpc(const std::string& methodname, const std::string& args)
203 : : {
204 : 412413 : return "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", "
205 [ + - + - ]: 1237239 : "\"method\": \"" + methodname + "\", \"params\": [" + args + "]}' -H 'content-type: application/json' http://127.0.0.1:8332/\n";
206 : : }
207 : :
208 : 2851 : std::string HelpExampleRpcNamed(const std::string& methodname, const RPCArgList& args)
209 : : {
210 : 2851 : UniValue params(UniValue::VOBJ);
211 [ + + ]: 11855 : for (const auto& param: args) {
212 [ + - + - : 18008 : params.pushKV(param.first, param.second);
+ - ]
213 : : }
214 : :
215 : 2851 : return "> curl --user myusername --data-binary '{\"jsonrpc\": \"2.0\", \"id\": \"curltest\", "
216 [ + - + - : 11404 : "\"method\": \"" + methodname + "\", \"params\": " + params.write() + "}' -H 'content-type: application/json' http://127.0.0.1:8332/\n";
+ - ]
217 : 2851 : }
218 : :
219 : : // Converts a hex string to a public key if possible
220 : 758 : CPubKey HexToPubKey(const std::string& hex_in)
221 : : {
222 [ + + ]: 758 : if (!IsHex(hex_in)) {
223 [ + - + - ]: 3 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must be a hex string");
224 : : }
225 [ + + + + ]: 757 : if (hex_in.length() != 66 && hex_in.length() != 130) {
226 [ + - + - ]: 3 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must have a length of either 33 or 65 bytes");
227 : : }
228 : 756 : CPubKey vchPubKey(ParseHex(hex_in));
229 [ - + ]: 756 : if (!vchPubKey.IsFullyValid()) {
230 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Pubkey \"" + hex_in + "\" must be cryptographically valid.");
231 : : }
232 : 756 : return vchPubKey;
233 : : }
234 : :
235 : : // Retrieves a public key for an address from the given FillableSigningProvider
236 : 0 : CPubKey AddrToPubKey(const FillableSigningProvider& keystore, const std::string& addr_in)
237 : : {
238 : 0 : CTxDestination dest = DecodeDestination(addr_in);
239 [ # # # # ]: 0 : if (!IsValidDestination(dest)) {
240 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid address: " + addr_in);
241 : : }
242 [ # # ]: 0 : CKeyID key = GetKeyForDestination(keystore, dest);
243 [ # # ]: 0 : if (key.IsNull()) {
244 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("'%s' does not refer to a key", addr_in));
245 : : }
246 [ # # ]: 0 : CPubKey vchPubKey;
247 [ # # # # ]: 0 : if (!keystore.GetPubKey(key, vchPubKey)) {
248 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("no full public key for address %s", addr_in));
249 : : }
250 [ # # # # ]: 0 : if (!vchPubKey.IsFullyValid()) {
251 [ # # # # ]: 0 : throw JSONRPCError(RPC_INTERNAL_ERROR, "Wallet contains an invalid public key");
252 : : }
253 : 0 : return vchPubKey;
254 : 0 : }
255 : :
256 : : // Creates a multisig address from a given list of public keys, number of signatures required, and the address type
257 : 119 : CTxDestination AddAndGetMultisigDestination(const int required, const std::vector<CPubKey>& pubkeys, OutputType type, FlatSigningProvider& keystore, CScript& script_out)
258 : : {
259 : : // Gather public keys
260 [ - + ]: 119 : if (required < 1) {
261 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "a multisignature address must require at least one key to redeem");
262 : : }
263 [ - + ]: 119 : if ((int)pubkeys.size() < required) {
264 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("not enough keys supplied (got %u keys, but need at least %d to redeem)", pubkeys.size(), required));
265 : : }
266 [ + + ]: 119 : if (pubkeys.size() > MAX_PUBKEYS_PER_MULTISIG) {
267 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Number of keys involved in the multisignature address creation > %d\nReduce the number", MAX_PUBKEYS_PER_MULTISIG));
268 : : }
269 : :
270 : 117 : script_out = GetScriptForMultisig(required, pubkeys);
271 : :
272 : : // Check if any keys are uncompressed. If so, the type is legacy
273 [ + + ]: 733 : for (const CPubKey& pk : pubkeys) {
274 [ + + ]: 652 : if (!pk.IsCompressed()) {
275 : : type = OutputType::LEGACY;
276 : : break;
277 : : }
278 : : }
279 : :
280 [ + + + - : 117 : if (type == OutputType::LEGACY && script_out.size() > MAX_SCRIPT_ELEMENT_SIZE) {
+ + ]
281 [ + - + - : 3 : throw JSONRPCError(RPC_INVALID_PARAMETER, (strprintf("redeemScript exceeds size limit: %d > %d", script_out.size(), MAX_SCRIPT_ELEMENT_SIZE)));
+ - ]
282 : : }
283 : :
284 : : // Make the address
285 : 116 : CTxDestination dest = AddAndGetDestinationForScript(keystore, script_out, type);
286 : :
287 : 116 : return dest;
288 : : }
289 : :
290 : : class DescribeAddressVisitor
291 : : {
292 : : public:
293 : : explicit DescribeAddressVisitor() = default;
294 : :
295 : 0 : UniValue operator()(const CNoDestination& dest) const
296 : : {
297 : 0 : return UniValue(UniValue::VOBJ);
298 : : }
299 : :
300 : 0 : UniValue operator()(const PubKeyDestination& dest) const
301 : : {
302 : 0 : return UniValue(UniValue::VOBJ);
303 : : }
304 : :
305 : 114 : UniValue operator()(const PKHash& keyID) const
306 : : {
307 : 114 : UniValue obj(UniValue::VOBJ);
308 [ + - + - : 228 : obj.pushKV("isscript", false);
+ - ]
309 [ + - + - : 228 : obj.pushKV("iswitness", false);
+ - ]
310 : 114 : return obj;
311 : 0 : }
312 : :
313 : 148 : UniValue operator()(const ScriptHash& scriptID) const
314 : : {
315 : 148 : UniValue obj(UniValue::VOBJ);
316 [ + - + - : 296 : obj.pushKV("isscript", true);
+ - ]
317 [ + - + - : 296 : obj.pushKV("iswitness", false);
+ - ]
318 : 148 : return obj;
319 : 0 : }
320 : :
321 : 489 : UniValue operator()(const WitnessV0KeyHash& id) const
322 : : {
323 : 489 : UniValue obj(UniValue::VOBJ);
324 [ + - + - : 978 : obj.pushKV("isscript", false);
+ - ]
325 [ + - + - : 978 : obj.pushKV("iswitness", true);
+ - ]
326 [ + - + - : 978 : obj.pushKV("witness_version", 0);
+ - ]
327 [ + - + - : 978 : obj.pushKV("witness_program", HexStr(id));
+ - + - ]
328 : 489 : return obj;
329 : 0 : }
330 : :
331 : 13 : UniValue operator()(const WitnessV0ScriptHash& id) const
332 : : {
333 : 13 : UniValue obj(UniValue::VOBJ);
334 [ + - + - : 26 : obj.pushKV("isscript", true);
+ - ]
335 [ + - + - : 26 : obj.pushKV("iswitness", true);
+ - ]
336 [ + - + - : 26 : obj.pushKV("witness_version", 0);
+ - ]
337 [ + - + - : 26 : obj.pushKV("witness_program", HexStr(id));
+ - + - ]
338 : 13 : return obj;
339 : 0 : }
340 : :
341 : 105 : UniValue operator()(const WitnessV1Taproot& tap) const
342 : : {
343 : 105 : UniValue obj(UniValue::VOBJ);
344 [ + - + - : 210 : obj.pushKV("isscript", true);
+ - ]
345 [ + - + - : 210 : obj.pushKV("iswitness", true);
+ - ]
346 [ + - + - : 210 : obj.pushKV("witness_version", 1);
+ - ]
347 [ + - + - : 210 : obj.pushKV("witness_program", HexStr(tap));
+ - + - ]
348 : 105 : return obj;
349 : 0 : }
350 : :
351 : 1 : UniValue operator()(const PayToAnchor& anchor) const
352 : : {
353 : 1 : UniValue obj(UniValue::VOBJ);
354 [ + - + - : 2 : obj.pushKV("isscript", true);
+ - ]
355 [ + - + - : 2 : obj.pushKV("iswitness", true);
+ - ]
356 : 1 : return obj;
357 : 0 : }
358 : :
359 : 5 : UniValue operator()(const WitnessUnknown& id) const
360 : : {
361 : 5 : UniValue obj(UniValue::VOBJ);
362 [ + - + - : 10 : obj.pushKV("iswitness", true);
+ - ]
363 [ + - + - : 10 : obj.pushKV("witness_version", id.GetWitnessVersion());
+ - ]
364 [ + - + - : 10 : obj.pushKV("witness_program", HexStr(id.GetWitnessProgram()));
+ - + - ]
365 : 5 : return obj;
366 : 0 : }
367 : : };
368 : :
369 : 875 : UniValue DescribeAddress(const CTxDestination& dest)
370 : : {
371 : 875 : return std::visit(DescribeAddressVisitor(), dest);
372 : : }
373 : :
374 : : /**
375 : : * Returns a sighash value corresponding to the passed in argument.
376 : : *
377 : : * @pre The sighash argument should be string or null.
378 : : */
379 : 716 : int ParseSighashString(const UniValue& sighash)
380 : : {
381 [ + + ]: 716 : if (sighash.isNull()) {
382 : : return SIGHASH_DEFAULT;
383 : : }
384 : 56 : const auto result{SighashFromStr(sighash.get_str())};
385 [ + + ]: 56 : if (!result) {
386 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, util::ErrorString(result).original);
387 : : }
388 : 52 : return result.value();
389 : 52 : }
390 : :
391 : 356 : unsigned int ParseConfirmTarget(const UniValue& value, unsigned int max_target)
392 : : {
393 : 356 : const int target{value.getInt<int>()};
394 : 356 : const unsigned int unsigned_target{static_cast<unsigned int>(target)};
395 [ + + + + ]: 356 : if (target < 1 || unsigned_target > max_target) {
396 [ + - + - ]: 62 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Invalid conf_target, must be between %u and %u", 1, max_target));
397 : : }
398 : 325 : return unsigned_target;
399 : : }
400 : :
401 : 0 : RPCErrorCode RPCErrorFromPSBTError(PSBTError err)
402 : : {
403 [ # # # ]: 0 : switch (err) {
404 : : case PSBTError::UNSUPPORTED:
405 : : return RPC_INVALID_PARAMETER;
406 : 0 : case PSBTError::SIGHASH_MISMATCH:
407 : 0 : return RPC_DESERIALIZATION_ERROR;
408 : 0 : default: break;
409 : : }
410 : 0 : return RPC_TRANSACTION_ERROR;
411 : : }
412 : :
413 : 4201 : RPCErrorCode RPCErrorFromTransactionError(TransactionError terr)
414 : : {
415 [ + + + ]: 4201 : switch (terr) {
416 : : case TransactionError::MEMPOOL_REJECTED:
417 : : return RPC_TRANSACTION_REJECTED;
418 : 3 : case TransactionError::ALREADY_IN_UTXO_SET:
419 : 3 : return RPC_VERIFY_ALREADY_IN_UTXO_SET;
420 : 9 : default: break;
421 : : }
422 : 9 : return RPC_TRANSACTION_ERROR;
423 : : }
424 : :
425 : 0 : UniValue JSONRPCPSBTError(PSBTError err)
426 : : {
427 [ # # # # ]: 0 : return JSONRPCError(RPCErrorFromPSBTError(err), PSBTErrorString(err).original);
428 : : }
429 : :
430 : 4201 : UniValue JSONRPCTransactionError(TransactionError terr, const std::string& err_string)
431 : : {
432 [ + + ]: 4201 : if (err_string.length() > 0) {
433 : 4191 : return JSONRPCError(RPCErrorFromTransactionError(terr), err_string);
434 : : } else {
435 [ + - + - ]: 20 : return JSONRPCError(RPCErrorFromTransactionError(terr), TransactionErrorString(terr).original);
436 : : }
437 : : }
438 : :
439 : : /**
440 : : * A pair of strings that can be aligned (through padding) with other Sections
441 : : * later on
442 : : */
443 : 55165 : struct Section {
444 : 17802 : Section(const std::string& left, const std::string& right)
445 [ + - ]: 17802 : : m_left{left}, m_right{right} {}
446 : : std::string m_left;
447 : : const std::string m_right;
448 : : };
449 : :
450 : : /**
451 : : * Keeps track of RPCArgs by transforming them into sections for the purpose
452 : : * of serializing everything to a single string
453 : : */
454 : 0 : struct Sections {
455 : : std::vector<Section> m_sections;
456 : : size_t m_max_pad{0};
457 : :
458 : 15996 : void PushSection(const Section& s)
459 : : {
460 [ + + ]: 15996 : m_max_pad = std::max(m_max_pad, s.m_left.size());
461 : 15996 : m_sections.push_back(s);
462 : 15996 : }
463 : :
464 : : /**
465 : : * Recursive helper to translate an RPCArg into sections
466 : : */
467 : : // NOLINTNEXTLINE(misc-no-recursion)
468 : 3030 : void Push(const RPCArg& arg, const size_t current_indent = 5, const OuterType outer_type = OuterType::NONE)
469 : : {
470 [ + - ]: 3030 : const auto indent = std::string(current_indent, ' ');
471 [ + - + + : 3030 : const auto indent_next = std::string(current_indent + 2, ' ');
+ - ]
472 : 3030 : const bool push_name{outer_type == OuterType::OBJ}; // Dictionary keys must have a name
473 : 3030 : const bool is_top_level_arg{outer_type == OuterType::NONE}; // True on the first recursion
474 : :
475 [ + + + - ]: 3030 : switch (arg.m_type) {
476 : 2515 : case RPCArg::Type::STR_HEX:
477 : 2515 : case RPCArg::Type::STR:
478 : 2515 : case RPCArg::Type::NUM:
479 : 2515 : case RPCArg::Type::AMOUNT:
480 : 2515 : case RPCArg::Type::RANGE:
481 : 2515 : case RPCArg::Type::BOOL:
482 : 2515 : case RPCArg::Type::OBJ_NAMED_PARAMS: {
483 [ + + ]: 2515 : if (is_top_level_arg) return; // Nothing more to do for non-recursive types on first recursion
484 [ + - ]: 674 : auto left = indent;
485 [ + + + - ]: 674 : if (arg.m_opts.type_str.size() != 0 && push_name) {
486 [ + - + - : 27 : left += "\"" + arg.GetName() + "\": " + arg.m_opts.type_str.at(0);
+ - + - ]
487 : : } else {
488 [ + + + - : 1330 : left += push_name ? arg.ToStringObj(/*oneline=*/false) : arg.ToString(/*oneline=*/false);
+ - ]
489 : : }
490 [ + - ]: 674 : left += ",";
491 [ + - + - : 1348 : PushSection({left, arg.ToDescriptionString(/*is_named_arg=*/push_name)});
+ - ]
492 : 674 : break;
493 : 674 : }
494 : 193 : case RPCArg::Type::OBJ:
495 : 193 : case RPCArg::Type::OBJ_USER_KEYS: {
496 [ + + + - : 193 : const auto right = is_top_level_arg ? "" : arg.ToDescriptionString(/*is_named_arg=*/push_name);
+ - ]
497 [ - + - - : 579 : PushSection({indent + (push_name ? "\"" + arg.GetName() + "\": " : "") + "{", right});
- - - - +
- + - + -
+ - - + -
+ - - -
- ]
498 [ + + ]: 671 : for (const auto& arg_inner : arg.m_inner) {
499 [ + - ]: 478 : Push(arg_inner, current_indent + 2, OuterType::OBJ);
500 : : }
501 [ + + ]: 193 : if (arg.m_type != RPCArg::Type::OBJ) {
502 [ + - + - : 80 : PushSection({indent_next + "...", ""});
+ - + - ]
503 : : }
504 [ + + + - : 748 : PushSection({indent + "}" + (is_top_level_arg ? "" : ","), ""});
+ - + - +
- ]
505 : 193 : break;
506 : 193 : }
507 : 322 : case RPCArg::Type::ARR: {
508 [ + - ]: 322 : auto left = indent;
509 [ + + + - : 764 : left += push_name ? "\"" + arg.GetName() + "\": " : "";
+ - + - +
- + + + +
- - - - ]
510 [ + - ]: 322 : left += "[";
511 [ + + + - : 322 : const auto right = is_top_level_arg ? "" : arg.ToDescriptionString(/*is_named_arg=*/push_name);
+ - ]
512 [ + - + - ]: 322 : PushSection({left, right});
513 [ + + ]: 747 : for (const auto& arg_inner : arg.m_inner) {
514 [ + - ]: 425 : Push(arg_inner, current_indent + 2, OuterType::ARR);
515 : : }
516 [ + - + - : 644 : PushSection({indent_next + "...", ""});
+ - + - ]
517 [ + + + - : 1026 : PushSection({indent + "]" + (is_top_level_arg ? "" : ","), ""});
+ - + - +
- ]
518 : 322 : break;
519 : 322 : }
520 : : } // no default case, so the compiler can warn about missing cases
521 : 3030 : }
522 : :
523 : : /**
524 : : * Concatenate all sections with proper padding
525 : : */
526 : 3380 : std::string ToString() const
527 : : {
528 : 3380 : std::string ret;
529 : 3380 : const size_t pad = m_max_pad + 4;
530 [ + + ]: 21182 : for (const auto& s : m_sections) {
531 : : // The left part of a section is assumed to be a single line, usually it is the name of the JSON struct or a
532 : : // brace like {, }, [, or ]
533 [ + - ]: 17802 : CHECK_NONFATAL(s.m_left.find('\n') == std::string::npos);
534 [ + + ]: 17802 : if (s.m_right.empty()) {
535 [ + - ]: 4774 : ret += s.m_left;
536 [ + - ]: 4774 : ret += "\n";
537 : 4774 : continue;
538 : : }
539 : :
540 [ + - ]: 13028 : std::string left = s.m_left;
541 [ + - ]: 13028 : left.resize(pad, ' ');
542 [ + - ]: 13028 : ret += left;
543 : :
544 : : // Properly pad after newlines
545 : 13028 : std::string right;
546 : 13028 : size_t begin = 0;
547 : 13028 : size_t new_line_pos = s.m_right.find_first_of('\n');
548 : 16848 : while (true) {
549 [ + - ]: 29876 : right += s.m_right.substr(begin, new_line_pos - begin);
550 [ + + ]: 14938 : if (new_line_pos == std::string::npos) {
551 : : break; //No new line
552 : : }
553 [ + - + - ]: 4186 : right += "\n" + std::string(pad, ' ');
554 : 2093 : begin = s.m_right.find_first_not_of(' ', new_line_pos + 1);
555 [ + + ]: 2093 : if (begin == std::string::npos) {
556 : : break; // Empty line
557 : : }
558 : 1910 : new_line_pos = s.m_right.find_first_of('\n', begin + 1);
559 : : }
560 [ + - ]: 13028 : ret += right;
561 [ + - ]: 13028 : ret += "\n";
562 : 13028 : }
563 : 3380 : return ret;
564 : 0 : }
565 : : };
566 : :
567 : 19 : RPCHelpMan::RPCHelpMan(std::string name, std::string description, std::vector<RPCArg> args, RPCResults results, RPCExamples examples)
568 [ + - + - : 62 : : RPCHelpMan{std::move(name), std::move(description), std::move(args), std::move(results), std::move(examples), nullptr} {}
+ + ]
569 : :
570 : 450696 : RPCHelpMan::RPCHelpMan(std::string name, std::string description, std::vector<RPCArg> args, RPCResults results, RPCExamples examples, RPCMethodImpl fun)
571 : 450704 : : m_name{std::move(name)},
572 : 450704 : m_fun{std::move(fun)},
573 : 450704 : m_description{std::move(description)},
574 [ + - ]: 450696 : m_args{std::move(args)},
575 [ + - ]: 450704 : m_results{std::move(results)},
576 [ + - ]: 450704 : m_examples{std::move(examples)}
577 : : {
578 : : // Map of parameter names and types just used to check whether the names are
579 : : // unique. Parameter names always need to be unique, with the exception that
580 : : // there can be pairs of POSITIONAL and NAMED parameters with the same name.
581 : 450696 : enum ParamType { POSITIONAL = 1, NAMED = 2, NAMED_ONLY = 4 };
582 : 450696 : std::map<std::string, int> param_names;
583 : :
584 [ + + ]: 1260099 : for (const auto& arg : m_args) {
585 [ + - ]: 809411 : std::vector<std::string> names = SplitString(arg.m_names, '|');
586 : : // Should have unique named arguments
587 [ + + ]: 1630172 : for (const std::string& name : names) {
588 [ + - ]: 820763 : auto& param_type = param_names[name];
589 [ + + ]: 820763 : CHECK_NONFATAL(!(param_type & POSITIONAL));
590 [ + + ]: 820762 : CHECK_NONFATAL(!(param_type & NAMED_ONLY));
591 : 820761 : param_type |= POSITIONAL;
592 : : }
593 [ + + ]: 809409 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
594 [ + + ]: 111746 : for (const auto& inner : arg.m_inner) {
595 [ + - ]: 95810 : std::vector<std::string> inner_names = SplitString(inner.m_names, '|');
596 [ + + ]: 191615 : for (const std::string& inner_name : inner_names) {
597 [ + - ]: 95811 : auto& param_type = param_names[inner_name];
598 [ + + + + : 95813 : CHECK_NONFATAL(!(param_type & POSITIONAL) || inner.m_opts.also_positional);
+ + ]
599 [ + + ]: 95809 : CHECK_NONFATAL(!(param_type & NAMED));
600 [ + + ]: 95807 : CHECK_NONFATAL(!(param_type & NAMED_ONLY));
601 [ + + ]: 182278 : param_type |= inner.m_opts.also_positional ? NAMED : NAMED_ONLY;
602 : : }
603 : 95810 : }
604 : : }
605 : : // Default value type should match argument type only when defined
606 [ + + ]: 809403 : if (arg.m_fallback.index() == 2) {
607 : 264867 : const RPCArg::Type type = arg.m_type;
608 [ - + + + : 264867 : switch (std::get<RPCArg::Default>(arg.m_fallback).getType()) {
+ - - ]
609 : 0 : case UniValue::VOBJ:
610 [ # # ]: 0 : CHECK_NONFATAL(type == RPCArg::Type::OBJ);
611 : : break;
612 : 1929 : case UniValue::VARR:
613 [ + - ]: 1929 : CHECK_NONFATAL(type == RPCArg::Type::ARR);
614 : : break;
615 : 94442 : case UniValue::VSTR:
616 [ + + - + : 188884 : CHECK_NONFATAL(type == RPCArg::Type::STR || type == RPCArg::Type::STR_HEX || type == RPCArg::Type::AMOUNT);
- ]
617 : : break;
618 : 54461 : case UniValue::VNUM:
619 [ + - - + : 108922 : CHECK_NONFATAL(type == RPCArg::Type::NUM || type == RPCArg::Type::AMOUNT || type == RPCArg::Type::RANGE);
- ]
620 : : break;
621 : 114035 : case UniValue::VBOOL:
622 [ + - ]: 114035 : CHECK_NONFATAL(type == RPCArg::Type::BOOL);
623 : : break;
624 : : case UniValue::VNULL:
625 : : // Null values are accepted in all arguments
626 : : break;
627 : 0 : default:
628 [ # # ]: 0 : NONFATAL_UNREACHABLE();
629 : : break;
630 : : }
631 : : }
632 : 809411 : }
633 : 450728 : }
634 : :
635 : 1057 : std::string RPCResults::ToDescriptionString() const
636 : : {
637 : 1057 : std::string result;
638 [ + + ]: 2333 : for (const auto& r : m_results) {
639 [ + + ]: 1276 : if (r.m_type == RPCResult::Type::ANY) continue; // for testing only
640 [ + + ]: 1266 : if (r.m_cond.empty()) {
641 [ + - ]: 929 : result += "\nResult:\n";
642 : : } else {
643 [ + - + - ]: 1011 : result += "\nResult (" + r.m_cond + "):\n";
644 : : }
645 : 1266 : Sections sections;
646 [ + - ]: 1266 : r.ToSections(sections);
647 [ + - ]: 2532 : result += sections.ToString();
648 : 1266 : }
649 : 1057 : return result;
650 : 0 : }
651 : :
652 : 1057 : std::string RPCExamples::ToDescriptionString() const
653 : : {
654 [ + + ]: 1057 : return m_examples.empty() ? m_examples : "\nExamples:\n" + m_examples;
655 : : }
656 : :
657 : 172971 : UniValue RPCHelpMan::HandleRequest(const JSONRPCRequest& request) const
658 : : {
659 [ + + ]: 172971 : if (request.mode == JSONRPCRequest::GET_ARGS) {
660 : 178 : return GetArgMap();
661 : : }
662 : : /*
663 : : * Check if the given request is valid according to this command or if
664 : : * the user is asking for help information, and throw help when appropriate.
665 : : */
666 [ + + + + ]: 172793 : if (request.mode == JSONRPCRequest::GET_HELP || !IsValidNumArgs(request.params.size())) {
667 [ + - + - ]: 2108 : throw std::runtime_error(ToString());
668 : : }
669 : 171739 : UniValue arg_mismatch{UniValue::VOBJ};
670 [ + + ]: 473790 : for (size_t i{0}; i < m_args.size(); ++i) {
671 [ + - ]: 302051 : const auto& arg{m_args.at(i)};
672 [ + - + - ]: 302051 : UniValue match{arg.MatchesType(request.params[i])};
673 [ + + ]: 302051 : if (!match.isTrue()) {
674 [ + - + - ]: 60 : arg_mismatch.pushKV(strprintf("Position %s (%s)", i + 1, arg.m_names), std::move(match));
675 : : }
676 : 302051 : }
677 [ + + ]: 171739 : if (!arg_mismatch.empty()) {
678 [ + - + - : 56 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Wrong type passed:\n%s", arg_mismatch.write(4)));
+ - ]
679 : : }
680 [ + - ]: 171711 : CHECK_NONFATAL(m_req == nullptr);
681 : 171711 : m_req = &request;
682 [ + + ]: 171711 : UniValue ret = m_fun(*this, request);
683 : 165861 : m_req = nullptr;
684 [ + - + - : 165861 : if (gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
+ + ]
685 : 165820 : UniValue mismatch{UniValue::VARR};
686 [ + - ]: 178528 : for (const auto& res : m_results.m_results) {
687 [ + - ]: 178528 : UniValue match{res.MatchesType(ret)};
688 [ + + ]: 178528 : if (match.isTrue()) {
689 [ + - ]: 165820 : mismatch.setNull();
690 : 165820 : break;
691 : : }
692 [ + - ]: 12708 : mismatch.push_back(std::move(match));
693 : 178528 : }
694 [ - + ]: 165820 : if (!mismatch.isNull()) {
695 [ # # ]: 0 : std::string explain{
696 [ # # ]: 0 : mismatch.empty() ? "no possible results defined" :
697 [ # # # # ]: 0 : mismatch.size() == 1 ? mismatch[0].write(4) :
698 [ # # # # : 0 : mismatch.write(4)};
# # ]
699 : 0 : throw std::runtime_error{
700 : 0 : strprintf("Internal bug detected: RPC call \"%s\" returned incorrect type:\n%s\n%s %s\nPlease report this issue here: %s\n",
701 [ # # ]: 0 : m_name, explain,
702 [ # # ]: 0 : CLIENT_NAME, FormatFullVersion(),
703 [ # # ]: 0 : CLIENT_BUGREPORT)};
704 : 0 : }
705 : 165820 : }
706 : 165861 : return ret;
707 : 171739 : }
708 : :
709 : : using CheckFn = void(const RPCArg&);
710 : 29488 : static const UniValue* DetailMaybeArg(CheckFn* check, const std::vector<RPCArg>& params, const JSONRPCRequest* req, size_t i)
711 : : {
712 : 29488 : CHECK_NONFATAL(i < params.size());
713 : 29488 : const UniValue& arg{CHECK_NONFATAL(req)->params[i]};
714 : 29488 : const RPCArg& param{params.at(i)};
715 [ + + ]: 29488 : if (check) check(param);
716 : :
717 [ + + ]: 29488 : if (!arg.isNull()) return &arg;
718 [ + + ]: 7070 : if (!std::holds_alternative<RPCArg::Default>(param.m_fallback)) return nullptr;
719 : 5208 : return &std::get<RPCArg::Default>(param.m_fallback);
720 : : }
721 : :
722 : 27582 : static void CheckRequiredOrDefault(const RPCArg& param)
723 : : {
724 : : // Must use `Arg<Type>(key)` to get the argument or its default value.
725 : 27582 : const bool required{
726 [ + + - + ]: 27582 : std::holds_alternative<RPCArg::Optional>(param.m_fallback) && RPCArg::Optional::NO == std::get<RPCArg::Optional>(param.m_fallback),
727 : 51512 : };
728 [ + - ]: 51512 : CHECK_NONFATAL(required || std::holds_alternative<RPCArg::Default>(param.m_fallback));
729 : 27582 : }
730 : :
731 : : #define TMPL_INST(check_param, ret_type, return_code) \
732 : : template <> \
733 : : ret_type RPCHelpMan::ArgValue<ret_type>(size_t i) const \
734 : : { \
735 : : const UniValue* maybe_arg{ \
736 : : DetailMaybeArg(check_param, m_args, m_req, i), \
737 : : }; \
738 : : return return_code \
739 : : } \
740 : : void force_semicolon(ret_type)
741 : :
742 : : // Optional arg (without default). Can also be called on required args, if needed.
743 : 0 : TMPL_INST(nullptr, const UniValue*, maybe_arg;);
744 [ + + ]: 712 : TMPL_INST(nullptr, std::optional<double>, maybe_arg ? std::optional{maybe_arg->get_real()} : std::nullopt;);
745 [ + + ]: 717 : TMPL_INST(nullptr, std::optional<bool>, maybe_arg ? std::optional{maybe_arg->get_bool()} : std::nullopt;);
746 [ + + ]: 477 : TMPL_INST(nullptr, const std::string*, maybe_arg ? &maybe_arg->get_str() : nullptr;);
747 : :
748 : : // Required arg or optional arg with default value.
749 : 22135 : TMPL_INST(CheckRequiredOrDefault, const UniValue&, *CHECK_NONFATAL(maybe_arg););
750 : 633 : TMPL_INST(CheckRequiredOrDefault, bool, CHECK_NONFATAL(maybe_arg)->get_bool(););
751 : 1287 : TMPL_INST(CheckRequiredOrDefault, int, CHECK_NONFATAL(maybe_arg)->getInt<int>(););
752 : 764 : TMPL_INST(CheckRequiredOrDefault, uint64_t, CHECK_NONFATAL(maybe_arg)->getInt<uint64_t>(););
753 : 2763 : TMPL_INST(CheckRequiredOrDefault, const std::string&, CHECK_NONFATAL(maybe_arg)->get_str(););
754 : :
755 : 171780 : bool RPCHelpMan::IsValidNumArgs(size_t num_args) const
756 : : {
757 : 171780 : size_t num_required_args = 0;
758 [ + + ]: 338450 : for (size_t n = m_args.size(); n > 0; --n) {
759 [ + + ]: 262698 : if (!m_args.at(n - 1).IsOptional()) {
760 : : num_required_args = n;
761 : : break;
762 : : }
763 : : }
764 [ + + + + ]: 171780 : return num_required_args <= num_args && num_args <= m_args.size();
765 : : }
766 : :
767 : 138853 : std::vector<std::pair<std::string, bool>> RPCHelpMan::GetArgNames() const
768 : : {
769 : 138853 : std::vector<std::pair<std::string, bool>> ret;
770 [ + - ]: 138853 : ret.reserve(m_args.size());
771 [ + + ]: 391439 : for (const auto& arg : m_args) {
772 [ + + ]: 252586 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
773 [ + + ]: 47451 : for (const auto& inner : arg.m_inner) {
774 [ + - ]: 40182 : ret.emplace_back(inner.m_names, /*named_only=*/true);
775 : : }
776 : : }
777 [ + - ]: 252586 : ret.emplace_back(arg.m_names, /*named_only=*/false);
778 : : }
779 : 138853 : return ret;
780 : 0 : }
781 : :
782 : 29488 : size_t RPCHelpMan::GetParamIndex(std::string_view key) const
783 : : {
784 : 29488 : auto it{std::find_if(
785 : 59593 : m_args.begin(), m_args.end(), [&key](const auto& arg) { return arg.GetName() == key;}
786 : : )};
787 : :
788 : 29488 : CHECK_NONFATAL(it != m_args.end()); // TODO: ideally this is checked at compile time
789 : 29488 : return std::distance(m_args.begin(), it);
790 : : }
791 : :
792 : 1057 : std::string RPCHelpMan::ToString() const
793 : : {
794 [ + - ]: 1057 : std::string ret;
795 : :
796 : : // Oneline summary
797 [ + - ]: 1057 : ret += m_name;
798 : 1057 : bool was_optional{false};
799 [ + + ]: 2863 : for (const auto& arg : m_args) {
800 [ + + ]: 1815 : if (arg.m_opts.hidden) break; // Any arg that follows is also hidden
801 [ + - ]: 1806 : const bool optional = arg.IsOptional();
802 [ + - ]: 1806 : ret += " ";
803 [ + + ]: 1806 : if (optional) {
804 [ + + + - ]: 1000 : if (!was_optional) ret += "( ";
805 : : was_optional = true;
806 : : } else {
807 [ + + + - ]: 806 : if (was_optional) ret += ") ";
808 : : was_optional = false;
809 : : }
810 [ + - ]: 3612 : ret += arg.ToString(/*oneline=*/true);
811 : : }
812 [ + + + - ]: 1057 : if (was_optional) ret += " )";
813 : :
814 : : // Description
815 [ + - + - : 3171 : ret += "\n\n" + TrimString(m_description) + "\n";
+ - ]
816 : :
817 : : // Arguments
818 : 1057 : Sections sections;
819 : 1057 : Sections named_only_sections;
820 [ + + ]: 2863 : for (size_t i{0}; i < m_args.size(); ++i) {
821 [ + - ]: 1815 : const auto& arg = m_args.at(i);
822 [ + + ]: 1815 : if (arg.m_opts.hidden) break; // Any arg that follows is also hidden
823 : :
824 : : // Push named argument name and description
825 [ + - + - : 5418 : sections.m_sections.emplace_back(util::ToString(i + 1) + ". " + arg.GetFirstName(), arg.ToDescriptionString(/*is_named_arg=*/true));
+ - + - +
- ]
826 [ + + ]: 1806 : sections.m_max_pad = std::max(sections.m_max_pad, sections.m_sections.back().m_left.size());
827 : :
828 : : // Recursively push nested args
829 [ + - ]: 1806 : sections.Push(arg);
830 : :
831 : : // Push named-only argument sections
832 [ + + ]: 1806 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
833 [ + + ]: 381 : for (const auto& arg_inner : arg.m_inner) {
834 [ + - + - : 642 : named_only_sections.PushSection({arg_inner.GetFirstName(), arg_inner.ToDescriptionString(/*is_named_arg=*/true)});
+ - + - ]
835 [ + - ]: 321 : named_only_sections.Push(arg_inner);
836 : : }
837 : : }
838 : : }
839 : :
840 [ + + + - ]: 1057 : if (!sections.m_sections.empty()) ret += "\nArguments:\n";
841 [ + - ]: 2114 : ret += sections.ToString();
842 [ + + + - ]: 1057 : if (!named_only_sections.m_sections.empty()) ret += "\nNamed Arguments:\n";
843 [ + - ]: 2114 : ret += named_only_sections.ToString();
844 : :
845 : : // Result
846 [ + - ]: 2114 : ret += m_results.ToDescriptionString();
847 : :
848 : : // Examples
849 [ + - ]: 2114 : ret += m_examples.ToDescriptionString();
850 : :
851 : 1057 : return ret;
852 : 1057 : }
853 : :
854 : 178 : UniValue RPCHelpMan::GetArgMap() const
855 : : {
856 : 178 : UniValue arr{UniValue::VARR};
857 : :
858 : 627 : auto push_back_arg_info = [&arr](const std::string& rpc_name, int pos, const std::string& arg_name, const RPCArg::Type& type) {
859 : 449 : UniValue map{UniValue::VARR};
860 [ + - + - ]: 449 : map.push_back(rpc_name);
861 [ + - + - ]: 449 : map.push_back(pos);
862 [ + - + - ]: 449 : map.push_back(arg_name);
863 [ + - + - ]: 449 : map.push_back(type == RPCArg::Type::STR ||
864 : : type == RPCArg::Type::STR_HEX);
865 [ + - ]: 449 : arr.push_back(std::move(map));
866 : 449 : };
867 : :
868 [ + + ]: 527 : for (int i{0}; i < int(m_args.size()); ++i) {
869 [ + - ]: 349 : const auto& arg = m_args.at(i);
870 [ + - ]: 349 : std::vector<std::string> arg_names = SplitString(arg.m_names, '|');
871 [ + + ]: 701 : for (const auto& arg_name : arg_names) {
872 [ + - ]: 352 : push_back_arg_info(m_name, i, arg_name, arg.m_type);
873 [ + + ]: 352 : if (arg.m_type == RPCArg::Type::OBJ_NAMED_PARAMS) {
874 [ + + ]: 111 : for (const auto& inner : arg.m_inner) {
875 [ + - ]: 97 : std::vector<std::string> inner_names = SplitString(inner.m_names, '|');
876 [ + + ]: 194 : for (const std::string& inner_name : inner_names) {
877 [ + - ]: 97 : push_back_arg_info(m_name, i, inner_name, inner.m_type);
878 : : }
879 : 97 : }
880 : : }
881 : : }
882 : 349 : }
883 : 178 : return arr;
884 : 0 : }
885 : :
886 : 167125 : static std::optional<UniValue::VType> ExpectedType(RPCArg::Type type)
887 : : {
888 : 167125 : using Type = RPCArg::Type;
889 [ + + + + : 167125 : switch (type) {
+ + + - ]
890 : 91644 : case Type::STR_HEX:
891 : 91644 : case Type::STR: {
892 : 91644 : return UniValue::VSTR;
893 : : }
894 : 44931 : case Type::NUM: {
895 : 44931 : return UniValue::VNUM;
896 : : }
897 : 19550 : case Type::AMOUNT: {
898 : : // VNUM or VSTR, checked inside AmountFromValue()
899 : 19550 : return std::nullopt;
900 : : }
901 : 86 : case Type::RANGE: {
902 : : // VNUM or VARR, checked inside ParseRange()
903 : 86 : return std::nullopt;
904 : : }
905 : 3478 : case Type::BOOL: {
906 : 3478 : return UniValue::VBOOL;
907 : : }
908 : 2741 : case Type::OBJ:
909 : 2741 : case Type::OBJ_NAMED_PARAMS:
910 : 2741 : case Type::OBJ_USER_KEYS: {
911 : 2741 : return UniValue::VOBJ;
912 : : }
913 : 4695 : case Type::ARR: {
914 : 4695 : return UniValue::VARR;
915 : : }
916 : : } // no default case, so the compiler can warn about missing cases
917 [ # # ]: 0 : NONFATAL_UNREACHABLE();
918 : : }
919 : :
920 : 302051 : UniValue RPCArg::MatchesType(const UniValue& request) const
921 : : {
922 [ + + ]: 302051 : if (m_opts.skip_type_check) return true;
923 [ + + + + ]: 294194 : if (IsOptional() && request.isNull()) return true;
924 : 167125 : const auto exp_type{ExpectedType(m_type)};
925 [ + + ]: 167125 : if (!exp_type) return true; // nothing to check
926 : :
927 [ + + ]: 147489 : if (*exp_type != request.getType()) {
928 [ + - ]: 60 : return strprintf("JSON value of type %s is not of expected type %s", uvTypeName(request.getType()), uvTypeName(*exp_type));
929 : : }
930 : 147459 : return true;
931 : : }
932 : :
933 : 4778 : std::string RPCArg::GetFirstName() const
934 : : {
935 : 4778 : return m_names.substr(0, m_names.find('|'));
936 : : }
937 : :
938 : 59662 : std::string RPCArg::GetName() const
939 : : {
940 : 59662 : CHECK_NONFATAL(std::string::npos == m_names.find('|'));
941 : 59662 : return m_names;
942 : : }
943 : :
944 : 558698 : bool RPCArg::IsOptional() const
945 : : {
946 [ + + ]: 558698 : if (m_fallback.index() != 0) {
947 : : return true;
948 : : } else {
949 : 263060 : return RPCArg::Optional::NO != std::get<RPCArg::Optional>(m_fallback);
950 : : }
951 : : }
952 : :
953 : 3030 : std::string RPCArg::ToDescriptionString(bool is_named_arg) const
954 : : {
955 [ + - ]: 3030 : std::string ret;
956 [ + - ]: 3030 : ret += "(";
957 [ + + ]: 3030 : if (m_opts.type_str.size() != 0) {
958 [ + - + - ]: 38 : ret += m_opts.type_str.at(1);
959 : : } else {
960 [ + + + + : 2992 : switch (m_type) {
+ + + - ]
961 : 1286 : case Type::STR_HEX:
962 : 1286 : case Type::STR: {
963 [ + - ]: 1286 : ret += "string";
964 : : break;
965 : : }
966 : 474 : case Type::NUM: {
967 [ + - ]: 474 : ret += "numeric";
968 : : break;
969 : : }
970 : 150 : case Type::AMOUNT: {
971 [ + - ]: 150 : ret += "numeric or string";
972 : : break;
973 : : }
974 : 52 : case Type::RANGE: {
975 [ + - ]: 52 : ret += "numeric or array";
976 : : break;
977 : : }
978 : 455 : case Type::BOOL: {
979 [ + - ]: 455 : ret += "boolean";
980 : : break;
981 : : }
982 : 253 : case Type::OBJ:
983 : 253 : case Type::OBJ_NAMED_PARAMS:
984 : 253 : case Type::OBJ_USER_KEYS: {
985 [ + - ]: 253 : ret += "json object";
986 : : break;
987 : : }
988 : 322 : case Type::ARR: {
989 [ + - + + ]: 3030 : ret += "json array";
990 : : break;
991 : : }
992 : : } // no default case, so the compiler can warn about missing cases
993 : : }
994 [ + + ]: 3030 : if (m_fallback.index() == 1) {
995 [ + - ]: 790 : ret += ", optional, default=" + std::get<RPCArg::DefaultHint>(m_fallback);
996 [ + + ]: 2635 : } else if (m_fallback.index() == 2) {
997 [ + - + - ]: 1582 : ret += ", optional, default=" + std::get<RPCArg::Default>(m_fallback).write();
998 : : } else {
999 [ - + + + : 1844 : switch (std::get<RPCArg::Optional>(m_fallback)) {
- ]
1000 : 751 : case RPCArg::Optional::OMITTED: {
1001 [ + + + - ]: 751 : if (is_named_arg) ret += ", optional"; // Default value is "null" in dicts. Otherwise,
1002 : : // nothing to do. Element is treated as if not present and has no default value
1003 : : break;
1004 : : }
1005 : 1093 : case RPCArg::Optional::NO: {
1006 [ + - ]: 1093 : ret += ", required";
1007 : : break;
1008 : : }
1009 : : } // no default case, so the compiler can warn about missing cases
1010 : : }
1011 [ + - ]: 3030 : ret += ")";
1012 [ + + + - ]: 3030 : if (m_type == Type::OBJ_NAMED_PARAMS) ret += " Options object that can be used to pass named arguments, listed below.";
1013 [ + + + - : 6060 : ret += m_description.empty() ? "" : " " + m_description;
+ - ]
1014 : 3030 : return ret;
1015 : 0 : }
1016 : :
1017 : : // NOLINTNEXTLINE(misc-no-recursion)
1018 : 10016 : void RPCResult::ToSections(Sections& sections, const OuterType outer_type, const int current_indent) const
1019 : : {
1020 : : // Indentation
1021 [ + - ]: 10016 : const std::string indent(current_indent, ' ');
1022 [ + - + + ]: 10016 : const std::string indent_next(current_indent + 2, ' ');
1023 : :
1024 : : // Elements in a JSON structure (dictionary or array) are separated by a comma
1025 [ + + + - ]: 11282 : const std::string maybe_separator{outer_type != OuterType::NONE ? "," : ""};
1026 : :
1027 : : // The key name if recursed into a dictionary
1028 : 10016 : const std::string maybe_key{
1029 [ + + ]: 10016 : outer_type == OuterType::OBJ ?
1030 [ + - - - ]: 15506 : "\"" + this->m_key_name + "\" : " :
1031 [ + - + - ]: 17769 : ""};
1032 : :
1033 : : // Format description with type
1034 : 19937 : const auto Description = [&](const std::string& type) {
1035 [ + + + - : 37703 : return "(" + type + (this->m_optional ? ", optional" : "") + ")" +
+ - ]
1036 [ + + + - ]: 29763 : (this->m_description.empty() ? "" : " " + this->m_description);
1037 : 10016 : };
1038 : :
1039 [ + - + + : 10016 : switch (m_type) {
+ + + + +
+ + - ]
1040 : 95 : case Type::ELISION: {
1041 : : // If the inner result is empty, use three dots for elision
1042 [ + - + - : 190 : sections.PushSection({indent + "..." + maybe_separator, m_description});
+ - + - ]
1043 : 95 : return;
1044 : : }
1045 : 0 : case Type::ANY: {
1046 [ # # ]: 0 : NONFATAL_UNREACHABLE(); // Only for testing
1047 : : }
1048 : 157 : case Type::NONE: {
1049 [ + - + - : 314 : sections.PushSection({indent + "null" + maybe_separator, Description("json null")});
+ - + - +
- + - ]
1050 : 157 : return;
1051 : : }
1052 : 1735 : case Type::STR: {
1053 [ + - + - : 5205 : sections.PushSection({indent + maybe_key + "\"str\"" + maybe_separator, Description("string")});
+ - + - +
- + - ]
1054 : 1735 : return;
1055 : : }
1056 : 495 : case Type::STR_AMOUNT: {
1057 [ + - + - : 1485 : sections.PushSection({indent + maybe_key + "n" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1058 : 495 : return;
1059 : : }
1060 : 1451 : case Type::STR_HEX: {
1061 [ + - + - : 4353 : sections.PushSection({indent + maybe_key + "\"hex\"" + maybe_separator, Description("string")});
+ - + - +
- + - ]
1062 : 1451 : return;
1063 : : }
1064 : 2582 : case Type::NUM: {
1065 [ + - + - : 7746 : sections.PushSection({indent + maybe_key + "n" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1066 : 2582 : return;
1067 : : }
1068 : 324 : case Type::NUM_TIME: {
1069 [ + - + - : 972 : sections.PushSection({indent + maybe_key + "xxx" + maybe_separator, Description("numeric")});
+ - + - +
- + - ]
1070 : 324 : return;
1071 : : }
1072 : 692 : case Type::BOOL: {
1073 [ + - + - : 2076 : sections.PushSection({indent + maybe_key + "true|false" + maybe_separator, Description("boolean")});
+ - + - +
- + - ]
1074 : 692 : return;
1075 : : }
1076 : 944 : case Type::ARR_FIXED:
1077 : 944 : case Type::ARR: {
1078 [ + - + - : 2832 : sections.PushSection({indent + maybe_key + "[", Description("json array")});
+ - + - +
- ]
1079 [ + + ]: 1941 : for (const auto& i : m_inner) {
1080 [ + - ]: 997 : i.ToSections(sections, OuterType::ARR, current_indent + 2);
1081 : : }
1082 [ + - ]: 944 : CHECK_NONFATAL(!m_inner.empty());
1083 [ + + + + ]: 944 : if (m_type == Type::ARR && m_inner.back().m_type != Type::ELISION) {
1084 [ + - + - : 1848 : sections.PushSection({indent_next + "...", ""});
+ - + - ]
1085 : : } else {
1086 : : // Remove final comma, which would be invalid JSON
1087 : 20 : sections.m_sections.back().m_left.pop_back();
1088 : : }
1089 [ + - + - : 1888 : sections.PushSection({indent + "]" + maybe_separator, ""});
+ - + - +
- ]
1090 : 944 : return;
1091 : : }
1092 : 1541 : case Type::OBJ_DYN:
1093 : 1541 : case Type::OBJ: {
1094 [ + + ]: 1541 : if (m_inner.empty()) {
1095 [ + - + - : 54 : sections.PushSection({indent + maybe_key + "{}", Description("empty JSON object")});
+ - + - +
- ]
1096 : 18 : return;
1097 : : }
1098 [ + - + - : 4569 : sections.PushSection({indent + maybe_key + "{", Description("json object")});
+ - + - +
- ]
1099 [ + + ]: 9276 : for (const auto& i : m_inner) {
1100 [ + - ]: 7753 : i.ToSections(sections, OuterType::OBJ, current_indent + 2);
1101 : : }
1102 [ + + - + ]: 1523 : if (m_type == Type::OBJ_DYN && m_inner.back().m_type != Type::ELISION) {
1103 : : // If the dictionary keys are dynamic, use three dots for continuation
1104 [ + - + - : 404 : sections.PushSection({indent_next + "...", ""});
+ - + - ]
1105 : : } else {
1106 : : // Remove final comma, which would be invalid JSON
1107 : 1321 : sections.m_sections.back().m_left.pop_back();
1108 : : }
1109 [ + - + - : 3046 : sections.PushSection({indent + "}" + maybe_separator, ""});
+ - + - +
- ]
1110 : 1523 : return;
1111 : : }
1112 : : } // no default case, so the compiler can warn about missing cases
1113 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1114 : 10016 : }
1115 : :
1116 : 4182741 : static std::optional<UniValue::VType> ExpectedType(RPCResult::Type type)
1117 : : {
1118 : 4182741 : using Type = RPCResult::Type;
1119 [ + + + + : 4182741 : switch (type) {
+ + + - ]
1120 : 15 : case Type::ELISION:
1121 : 15 : case Type::ANY: {
1122 : 15 : return std::nullopt;
1123 : : }
1124 : 15106 : case Type::NONE: {
1125 : 15106 : return UniValue::VNULL;
1126 : : }
1127 : 1515177 : case Type::STR:
1128 : 1515177 : case Type::STR_HEX: {
1129 : 1515177 : return UniValue::VSTR;
1130 : : }
1131 : 1663254 : case Type::NUM:
1132 : 1663254 : case Type::STR_AMOUNT:
1133 : 1663254 : case Type::NUM_TIME: {
1134 : 1663254 : return UniValue::VNUM;
1135 : : }
1136 : 404029 : case Type::BOOL: {
1137 : 404029 : return UniValue::VBOOL;
1138 : : }
1139 : 183905 : case Type::ARR_FIXED:
1140 : 183905 : case Type::ARR: {
1141 : 183905 : return UniValue::VARR;
1142 : : }
1143 : 401255 : case Type::OBJ_DYN:
1144 : 401255 : case Type::OBJ: {
1145 : 401255 : return UniValue::VOBJ;
1146 : : }
1147 : : } // no default case, so the compiler can warn about missing cases
1148 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1149 : : }
1150 : :
1151 : : // NOLINTNEXTLINE(misc-no-recursion)
1152 : 4183234 : UniValue RPCResult::MatchesType(const UniValue& result) const
1153 : : {
1154 [ + + ]: 4183234 : if (m_skip_type_check) {
1155 : 493 : return true;
1156 : : }
1157 : :
1158 : 4182741 : const auto exp_type = ExpectedType(m_type);
1159 [ + + ]: 4182741 : if (!exp_type) return true; // can be any type, so nothing to check
1160 : :
1161 [ + + ]: 4182726 : if (*exp_type != result.getType()) {
1162 [ + - ]: 45286 : return strprintf("returned type is %s, but declared as %s in doc", uvTypeName(result.getType()), uvTypeName(*exp_type));
1163 : : }
1164 : :
1165 [ + + ]: 4160083 : if (UniValue::VARR == result.getType()) {
1166 : 182890 : UniValue errors(UniValue::VOBJ);
1167 [ + - + + ]: 821156 : for (size_t i{0}; i < result.get_array().size(); ++i) {
1168 : : // If there are more results than documented, reuse the last doc_inner.
1169 [ + + + - ]: 1276306 : const RPCResult& doc_inner{m_inner.at(std::min(m_inner.size() - 1, i))};
1170 [ + - + - : 638266 : UniValue match{doc_inner.MatchesType(result.get_array()[i])};
+ - ]
1171 [ + + + - : 648445 : if (!match.isTrue()) errors.pushKV(strprintf("%d", i), std::move(match));
+ - ]
1172 : 638266 : }
1173 [ + + + - ]: 182890 : if (errors.empty()) return true; // empty result array is valid
1174 : 242 : return errors;
1175 : 182890 : }
1176 : :
1177 [ + + ]: 3977193 : if (UniValue::VOBJ == result.getType()) {
1178 [ + + + + ]: 400807 : if (!m_inner.empty() && m_inner.at(0).m_type == Type::ELISION) return true;
1179 : 399683 : UniValue errors(UniValue::VOBJ);
1180 [ + + ]: 399683 : if (m_type == Type::OBJ_DYN) {
1181 [ + - ]: 36723 : const RPCResult& doc_inner{m_inner.at(0)}; // Assume all types are the same, randomly pick the first
1182 [ + - + + ]: 343147 : for (size_t i{0}; i < result.get_obj().size(); ++i) {
1183 [ + - + - : 306424 : UniValue match{doc_inner.MatchesType(result.get_obj()[i])};
+ - ]
1184 [ + + + - : 306436 : if (!match.isTrue()) errors.pushKV(result.getKeys()[i], std::move(match));
+ - + - ]
1185 : 306424 : }
1186 [ + + + - ]: 36723 : if (errors.empty()) return true; // empty result obj is valid
1187 : 6 : return errors;
1188 : : }
1189 : 362960 : std::set<std::string> doc_keys;
1190 [ + + ]: 3827794 : for (const auto& doc_entry : m_inner) {
1191 [ + - ]: 3464834 : doc_keys.insert(doc_entry.m_key_name);
1192 : : }
1193 [ + - ]: 362960 : std::map<std::string, UniValue> result_obj;
1194 [ + - ]: 362960 : result.getObjMap(result_obj);
1195 [ + + ]: 3422989 : for (const auto& result_entry : result_obj) {
1196 [ + + ]: 3060029 : if (doc_keys.find(result_entry.first) == doc_keys.end()) {
1197 [ + - + - : 26 : errors.pushKV(result_entry.first, "key returned that was not in doc");
+ - ]
1198 : : }
1199 : : }
1200 : :
1201 [ + + ]: 3827794 : for (const auto& doc_entry : m_inner) {
1202 : 3464834 : const auto result_it{result_obj.find(doc_entry.m_key_name)};
1203 [ + + ]: 3464834 : if (result_it == result_obj.end()) {
1204 [ - + ]: 404818 : if (!doc_entry.m_optional) {
1205 [ # # # # : 0 : errors.pushKV(doc_entry.m_key_name, "key missing, despite not being optional in doc");
# # ]
1206 : : }
1207 : 404818 : continue;
1208 : : }
1209 [ + - ]: 3060016 : UniValue match{doc_entry.MatchesType(result_it->second)};
1210 [ + + + - : 3060145 : if (!match.isTrue()) errors.pushKV(doc_entry.m_key_name, std::move(match));
+ - ]
1211 : 3060016 : }
1212 [ + + + - ]: 362960 : if (errors.empty()) return true;
1213 : 137 : return errors;
1214 : 399683 : }
1215 : :
1216 : 3576386 : return true;
1217 : : }
1218 : :
1219 : 4093571 : void RPCResult::CheckInnerDoc() const
1220 : : {
1221 [ + + ]: 4093571 : if (m_type == Type::OBJ) {
1222 : : // May or may not be empty
1223 : : return;
1224 : : }
1225 : : // Everything else must either be empty or not
1226 [ + + + + ]: 3596756 : const bool inner_needed{m_type == Type::ARR || m_type == Type::ARR_FIXED || m_type == Type::OBJ_DYN};
1227 : 3596756 : CHECK_NONFATAL(inner_needed != m_inner.empty());
1228 : : }
1229 : :
1230 : : // NOLINTNEXTLINE(misc-no-recursion)
1231 : 750 : std::string RPCArg::ToStringObj(const bool oneline) const
1232 : : {
1233 [ + - ]: 750 : std::string res;
1234 [ + - ]: 750 : res += "\"";
1235 [ + - ]: 1500 : res += GetFirstName();
1236 [ + + ]: 750 : if (oneline) {
1237 [ + - ]: 341 : res += "\":";
1238 : : } else {
1239 [ + - ]: 409 : res += "\": ";
1240 : : }
1241 [ + + + + : 750 : switch (m_type) {
+ + + -
- ]
1242 : 112 : case Type::STR:
1243 [ + - ]: 112 : return res + "\"str\"";
1244 : 256 : case Type::STR_HEX:
1245 [ + - ]: 256 : return res + "\"hex\"";
1246 : 178 : case Type::NUM:
1247 [ + - ]: 178 : return res + "n";
1248 : 61 : case Type::RANGE:
1249 [ + - ]: 61 : return res + "n or [n,n]";
1250 : 98 : case Type::AMOUNT:
1251 [ + - ]: 98 : return res + "amount";
1252 : 27 : case Type::BOOL:
1253 [ + - ]: 27 : return res + "bool";
1254 : 18 : case Type::ARR:
1255 [ + - ]: 18 : res += "[";
1256 [ + + ]: 45 : for (const auto& i : m_inner) {
1257 [ + - + - ]: 81 : res += i.ToString(oneline) + ",";
1258 : : }
1259 [ + - ]: 18 : return res + "...]";
1260 : 0 : case Type::OBJ:
1261 : 0 : case Type::OBJ_NAMED_PARAMS:
1262 : 0 : case Type::OBJ_USER_KEYS:
1263 : : // Currently unused, so avoid writing dead code
1264 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1265 : : } // no default case, so the compiler can warn about missing cases
1266 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1267 : 750 : }
1268 : :
1269 : : // NOLINTNEXTLINE(misc-no-recursion)
1270 : 2340 : std::string RPCArg::ToString(const bool oneline) const
1271 : : {
1272 [ + + + + ]: 2340 : if (oneline && !m_opts.oneline_description.empty()) {
1273 [ + + + - : 81 : if (m_opts.oneline_description[0] == '\"' && m_type != Type::STR_HEX && m_type != Type::STR && gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
- + - - -
- - + ]
1274 : 0 : throw std::runtime_error{
1275 [ # # # # ]: 0 : STR_INTERNAL_BUG(strprintf("non-string RPC arg \"%s\" quotes oneline_description:\n%s",
1276 : : m_names, m_opts.oneline_description)
1277 [ # # # # ]: 0 : )};
1278 : : }
1279 : 81 : return m_opts.oneline_description;
1280 : : }
1281 : :
1282 [ + + + + : 2259 : switch (m_type) {
- ]
1283 : 1189 : case Type::STR_HEX:
1284 : 1189 : case Type::STR: {
1285 [ + - ]: 2378 : return "\"" + GetFirstName() + "\"";
1286 : : }
1287 : 712 : case Type::NUM:
1288 : 712 : case Type::RANGE:
1289 : 712 : case Type::AMOUNT:
1290 : 712 : case Type::BOOL: {
1291 : 712 : return GetFirstName();
1292 : : }
1293 : 156 : case Type::OBJ:
1294 : 156 : case Type::OBJ_NAMED_PARAMS:
1295 : 156 : case Type::OBJ_USER_KEYS: {
1296 : : // NOLINTNEXTLINE(misc-no-recursion)
1297 [ + - ]: 497 : const std::string res = Join(m_inner, ",", [&](const RPCArg& i) { return i.ToStringObj(oneline); });
1298 [ + + ]: 156 : if (m_type == Type::OBJ) {
1299 [ + - ]: 208 : return "{" + res + "}";
1300 : : } else {
1301 [ + - ]: 104 : return "{" + res + ",...}";
1302 : : }
1303 : 156 : }
1304 : 202 : case Type::ARR: {
1305 : 202 : std::string res;
1306 [ + + ]: 453 : for (const auto& i : m_inner) {
1307 [ + - + - ]: 753 : res += i.ToString(oneline) + ",";
1308 : : }
1309 [ + - ]: 404 : return "[" + res + "...]";
1310 : 202 : }
1311 : : } // no default case, so the compiler can warn about missing cases
1312 [ # # ]: 0 : NONFATAL_UNREACHABLE();
1313 : : }
1314 : :
1315 : 208 : static std::pair<int64_t, int64_t> ParseRange(const UniValue& value)
1316 : : {
1317 [ + + ]: 208 : if (value.isNum()) {
1318 : 86 : return {0, value.getInt<int64_t>()};
1319 : : }
1320 [ + - + - : 122 : if (value.isArray() && value.size() == 2 && value[0].isNum() && value[1].isNum()) {
+ - + - ]
1321 : 122 : int64_t low = value[0].getInt<int64_t>();
1322 : 122 : int64_t high = value[1].getInt<int64_t>();
1323 [ + + + - : 126 : if (low > high) throw JSONRPCError(RPC_INVALID_PARAMETER, "Range specified as [begin,end] must not have begin after end");
+ - ]
1324 : 118 : return {low, high};
1325 : : }
1326 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range must be specified as end or as [begin,end]");
1327 : : }
1328 : :
1329 : 208 : std::pair<int64_t, int64_t> ParseDescriptorRange(const UniValue& value)
1330 : : {
1331 : 208 : int64_t low, high;
1332 [ + + ]: 208 : std::tie(low, high) = ParseRange(value);
1333 [ + + ]: 204 : if (low < 0) {
1334 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should be greater or equal than 0");
1335 : : }
1336 [ + + ]: 200 : if ((high >> 31) != 0) {
1337 [ + - + - ]: 12 : throw JSONRPCError(RPC_INVALID_PARAMETER, "End of range is too high");
1338 : : }
1339 [ + + ]: 194 : if (high >= low + 1000000) {
1340 [ + - + - ]: 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range is too large");
1341 : : }
1342 : 190 : return {low, high};
1343 : : }
1344 : :
1345 : 1013 : std::vector<CScript> EvalDescriptorStringOrObject(const UniValue& scanobject, FlatSigningProvider& provider, const bool expand_priv)
1346 : : {
1347 [ + + ]: 1013 : std::string desc_str;
1348 : 1013 : std::pair<int64_t, int64_t> range = {0, 1000};
1349 [ + + ]: 1013 : if (scanobject.isStr()) {
1350 [ + - + - ]: 987 : desc_str = scanobject.get_str();
1351 [ + - ]: 26 : } else if (scanobject.isObject()) {
1352 [ + - ]: 26 : const UniValue& desc_uni{scanobject.find_value("desc")};
1353 [ - + - - : 26 : if (desc_uni.isNull()) throw JSONRPCError(RPC_INVALID_PARAMETER, "Descriptor needs to be provided in scan object");
- - ]
1354 [ + - + - ]: 26 : desc_str = desc_uni.get_str();
1355 [ + - ]: 26 : const UniValue& range_uni{scanobject.find_value("range")};
1356 [ + + ]: 26 : if (!range_uni.isNull()) {
1357 [ + + ]: 19 : range = ParseDescriptorRange(range_uni);
1358 : : }
1359 : : } else {
1360 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Scan object needs to be either a string or an object");
1361 : : }
1362 : :
1363 [ + - ]: 1008 : std::string error;
1364 [ + - ]: 1008 : auto descs = Parse(desc_str, provider, error);
1365 [ - + ]: 1008 : if (descs.empty()) {
1366 [ # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
1367 : : }
1368 [ + - + - : 1008 : if (!descs.at(0)->IsRange()) {
+ + ]
1369 : 994 : range.first = 0;
1370 : 994 : range.second = 0;
1371 : : }
1372 : 1008 : std::vector<CScript> ret;
1373 [ + + ]: 20110 : for (int i = range.first; i <= range.second; ++i) {
1374 [ + + ]: 38205 : for (const auto& desc : descs) {
1375 : 19103 : std::vector<CScript> scripts;
1376 [ + - - + ]: 19103 : if (!desc->Expand(i, provider, scripts, provider)) {
1377 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Cannot derive script without private keys: '%s'", desc_str));
1378 : : }
1379 [ + + ]: 19103 : if (expand_priv) {
1380 [ + - ]: 4 : desc->ExpandPrivate(/*pos=*/i, provider, /*out=*/provider);
1381 : : }
1382 [ + - ]: 19103 : std::move(scripts.begin(), scripts.end(), std::back_inserter(ret));
1383 : 19103 : }
1384 : : }
1385 : 2016 : return ret;
1386 : 1008 : }
1387 : :
1388 : : /** Convert a vector of bilingual strings to a UniValue::VARR containing their original untranslated values. */
1389 : 473 : [[nodiscard]] static UniValue BilingualStringsToUniValue(const std::vector<bilingual_str>& bilingual_strings)
1390 : : {
1391 : 473 : CHECK_NONFATAL(!bilingual_strings.empty());
1392 : 473 : UniValue result{UniValue::VARR};
1393 [ + + ]: 951 : for (const auto& s : bilingual_strings) {
1394 [ + - + - ]: 478 : result.push_back(s.original);
1395 : : }
1396 : 473 : return result;
1397 : 0 : }
1398 : :
1399 : 788 : void PushWarnings(const UniValue& warnings, UniValue& obj)
1400 : : {
1401 [ + + ]: 788 : if (warnings.empty()) return;
1402 [ + - + - ]: 634 : obj.pushKV("warnings", warnings);
1403 : : }
1404 : :
1405 : 876 : void PushWarnings(const std::vector<bilingual_str>& warnings, UniValue& obj)
1406 : : {
1407 [ + + ]: 876 : if (warnings.empty()) return;
1408 [ + - + - ]: 946 : obj.pushKV("warnings", BilingualStringsToUniValue(warnings));
1409 : : }
|
