Bitcoin Core  26.99.0
P2P Digital Currency
client.cpp
Go to the documentation of this file.
1 // Copyright (c) 2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #include <common/args.h>
7 #include <rpc/client.h>
8 #include <tinyformat.h>
9 
10 #include <set>
11 #include <stdint.h>
12 #include <string>
13 #include <string_view>
14 
16 {
17 public:
18  std::string methodName;
19  int paramIdx;
20  std::string paramName;
21 };
22 
23 // clang-format off
31 {
32  { "setmocktime", 0, "timestamp" },
33  { "mockscheduler", 0, "delta_time" },
34  { "utxoupdatepsbt", 1, "descriptors" },
35  { "generatetoaddress", 0, "nblocks" },
36  { "generatetoaddress", 2, "maxtries" },
37  { "generatetodescriptor", 0, "num_blocks" },
38  { "generatetodescriptor", 2, "maxtries" },
39  { "generateblock", 1, "transactions" },
40  { "generateblock", 2, "submit" },
41  { "getnetworkhashps", 0, "nblocks" },
42  { "getnetworkhashps", 1, "height" },
43  { "sendtoaddress", 1, "amount" },
44  { "sendtoaddress", 4, "subtractfeefromamount" },
45  { "sendtoaddress", 5 , "replaceable" },
46  { "sendtoaddress", 6 , "conf_target" },
47  { "sendtoaddress", 8, "avoid_reuse" },
48  { "sendtoaddress", 9, "fee_rate"},
49  { "sendtoaddress", 10, "verbose"},
50  { "settxfee", 0, "amount" },
51  { "sethdseed", 0, "newkeypool" },
52  { "getreceivedbyaddress", 1, "minconf" },
53  { "getreceivedbyaddress", 2, "include_immature_coinbase" },
54  { "getreceivedbylabel", 1, "minconf" },
55  { "getreceivedbylabel", 2, "include_immature_coinbase" },
56  { "listreceivedbyaddress", 0, "minconf" },
57  { "listreceivedbyaddress", 1, "include_empty" },
58  { "listreceivedbyaddress", 2, "include_watchonly" },
59  { "listreceivedbyaddress", 4, "include_immature_coinbase" },
60  { "listreceivedbylabel", 0, "minconf" },
61  { "listreceivedbylabel", 1, "include_empty" },
62  { "listreceivedbylabel", 2, "include_watchonly" },
63  { "listreceivedbylabel", 3, "include_immature_coinbase" },
64  { "getbalance", 1, "minconf" },
65  { "getbalance", 2, "include_watchonly" },
66  { "getbalance", 3, "avoid_reuse" },
67  { "getblockfrompeer", 1, "peer_id" },
68  { "getblockhash", 0, "height" },
69  { "waitforblockheight", 0, "height" },
70  { "waitforblockheight", 1, "timeout" },
71  { "waitforblock", 1, "timeout" },
72  { "waitfornewblock", 0, "timeout" },
73  { "listtransactions", 1, "count" },
74  { "listtransactions", 2, "skip" },
75  { "listtransactions", 3, "include_watchonly" },
76  { "walletpassphrase", 1, "timeout" },
77  { "getblocktemplate", 0, "template_request" },
78  { "listsinceblock", 1, "target_confirmations" },
79  { "listsinceblock", 2, "include_watchonly" },
80  { "listsinceblock", 3, "include_removed" },
81  { "listsinceblock", 4, "include_change" },
82  { "sendmany", 1, "amounts" },
83  { "sendmany", 2, "minconf" },
84  { "sendmany", 4, "subtractfeefrom" },
85  { "sendmany", 5 , "replaceable" },
86  { "sendmany", 6 , "conf_target" },
87  { "sendmany", 8, "fee_rate"},
88  { "sendmany", 9, "verbose" },
89  { "deriveaddresses", 1, "range" },
90  { "scanblocks", 1, "scanobjects" },
91  { "scanblocks", 2, "start_height" },
92  { "scanblocks", 3, "stop_height" },
93  { "scanblocks", 5, "options" },
94  { "scantxoutset", 1, "scanobjects" },
95  { "addmultisigaddress", 0, "nrequired" },
96  { "addmultisigaddress", 1, "keys" },
97  { "createmultisig", 0, "nrequired" },
98  { "createmultisig", 1, "keys" },
99  { "listunspent", 0, "minconf" },
100  { "listunspent", 1, "maxconf" },
101  { "listunspent", 2, "addresses" },
102  { "listunspent", 3, "include_unsafe" },
103  { "listunspent", 4, "query_options" },
104  { "listunspent", 4, "minimumAmount" },
105  { "listunspent", 4, "maximumAmount" },
106  { "listunspent", 4, "maximumCount" },
107  { "listunspent", 4, "minimumSumAmount" },
108  { "listunspent", 4, "include_immature_coinbase" },
109  { "getblock", 1, "verbosity" },
110  { "getblock", 1, "verbose" },
111  { "getblockheader", 1, "verbose" },
112  { "getchaintxstats", 0, "nblocks" },
113  { "gettransaction", 1, "include_watchonly" },
114  { "gettransaction", 2, "verbose" },
115  { "getrawtransaction", 1, "verbosity" },
116  { "getrawtransaction", 1, "verbose" },
117  { "createrawtransaction", 0, "inputs" },
118  { "createrawtransaction", 1, "outputs" },
119  { "createrawtransaction", 2, "locktime" },
120  { "createrawtransaction", 3, "replaceable" },
121  { "decoderawtransaction", 1, "iswitness" },
122  { "signrawtransactionwithkey", 1, "privkeys" },
123  { "signrawtransactionwithkey", 2, "prevtxs" },
124  { "signrawtransactionwithwallet", 1, "prevtxs" },
125  { "sendrawtransaction", 1, "maxfeerate" },
126  { "sendrawtransaction", 2, "maxburnamount" },
127  { "testmempoolaccept", 0, "rawtxs" },
128  { "testmempoolaccept", 1, "maxfeerate" },
129  { "submitpackage", 0, "package" },
130  { "combinerawtransaction", 0, "txs" },
131  { "fundrawtransaction", 1, "options" },
132  { "fundrawtransaction", 1, "add_inputs"},
133  { "fundrawtransaction", 1, "include_unsafe"},
134  { "fundrawtransaction", 1, "minconf"},
135  { "fundrawtransaction", 1, "maxconf"},
136  { "fundrawtransaction", 1, "changePosition"},
137  { "fundrawtransaction", 1, "includeWatching"},
138  { "fundrawtransaction", 1, "lockUnspents"},
139  { "fundrawtransaction", 1, "fee_rate"},
140  { "fundrawtransaction", 1, "feeRate"},
141  { "fundrawtransaction", 1, "subtractFeeFromOutputs"},
142  { "fundrawtransaction", 1, "input_weights"},
143  { "fundrawtransaction", 1, "conf_target"},
144  { "fundrawtransaction", 1, "replaceable"},
145  { "fundrawtransaction", 1, "solving_data"},
146  { "fundrawtransaction", 2, "iswitness" },
147  { "walletcreatefundedpsbt", 0, "inputs" },
148  { "walletcreatefundedpsbt", 1, "outputs" },
149  { "walletcreatefundedpsbt", 2, "locktime" },
150  { "walletcreatefundedpsbt", 3, "options" },
151  { "walletcreatefundedpsbt", 3, "add_inputs"},
152  { "walletcreatefundedpsbt", 3, "include_unsafe"},
153  { "walletcreatefundedpsbt", 3, "minconf"},
154  { "walletcreatefundedpsbt", 3, "maxconf"},
155  { "walletcreatefundedpsbt", 3, "changePosition"},
156  { "walletcreatefundedpsbt", 3, "includeWatching"},
157  { "walletcreatefundedpsbt", 3, "lockUnspents"},
158  { "walletcreatefundedpsbt", 3, "fee_rate"},
159  { "walletcreatefundedpsbt", 3, "feeRate"},
160  { "walletcreatefundedpsbt", 3, "subtractFeeFromOutputs"},
161  { "walletcreatefundedpsbt", 3, "conf_target"},
162  { "walletcreatefundedpsbt", 3, "replaceable"},
163  { "walletcreatefundedpsbt", 3, "solving_data"},
164  { "walletcreatefundedpsbt", 4, "bip32derivs" },
165  { "walletprocesspsbt", 1, "sign" },
166  { "walletprocesspsbt", 3, "bip32derivs" },
167  { "walletprocesspsbt", 4, "finalize" },
168  { "descriptorprocesspsbt", 1, "descriptors"},
169  { "descriptorprocesspsbt", 3, "bip32derivs" },
170  { "descriptorprocesspsbt", 4, "finalize" },
171  { "createpsbt", 0, "inputs" },
172  { "createpsbt", 1, "outputs" },
173  { "createpsbt", 2, "locktime" },
174  { "createpsbt", 3, "replaceable" },
175  { "combinepsbt", 0, "txs"},
176  { "joinpsbts", 0, "txs"},
177  { "finalizepsbt", 1, "extract"},
178  { "converttopsbt", 1, "permitsigdata"},
179  { "converttopsbt", 2, "iswitness"},
180  { "gettxout", 1, "n" },
181  { "gettxout", 2, "include_mempool" },
182  { "gettxoutproof", 0, "txids" },
183  { "gettxoutsetinfo", 1, "hash_or_height" },
184  { "gettxoutsetinfo", 2, "use_index"},
185  { "lockunspent", 0, "unlock" },
186  { "lockunspent", 1, "transactions" },
187  { "lockunspent", 2, "persistent" },
188  { "send", 0, "outputs" },
189  { "send", 1, "conf_target" },
190  { "send", 3, "fee_rate"},
191  { "send", 4, "options" },
192  { "send", 4, "add_inputs"},
193  { "send", 4, "include_unsafe"},
194  { "send", 4, "minconf"},
195  { "send", 4, "maxconf"},
196  { "send", 4, "add_to_wallet"},
197  { "send", 4, "change_position"},
198  { "send", 4, "fee_rate"},
199  { "send", 4, "include_watching"},
200  { "send", 4, "inputs"},
201  { "send", 4, "locktime"},
202  { "send", 4, "lock_unspents"},
203  { "send", 4, "psbt"},
204  { "send", 4, "subtract_fee_from_outputs"},
205  { "send", 4, "conf_target"},
206  { "send", 4, "replaceable"},
207  { "send", 4, "solving_data"},
208  { "sendall", 0, "recipients" },
209  { "sendall", 1, "conf_target" },
210  { "sendall", 3, "fee_rate"},
211  { "sendall", 4, "options" },
212  { "sendall", 4, "add_to_wallet"},
213  { "sendall", 4, "fee_rate"},
214  { "sendall", 4, "include_watching"},
215  { "sendall", 4, "inputs"},
216  { "sendall", 4, "locktime"},
217  { "sendall", 4, "lock_unspents"},
218  { "sendall", 4, "psbt"},
219  { "sendall", 4, "send_max"},
220  { "sendall", 4, "minconf"},
221  { "sendall", 4, "maxconf"},
222  { "sendall", 4, "conf_target"},
223  { "sendall", 4, "replaceable"},
224  { "sendall", 4, "solving_data"},
225  { "simulaterawtransaction", 0, "rawtxs" },
226  { "simulaterawtransaction", 1, "options" },
227  { "simulaterawtransaction", 1, "include_watchonly"},
228  { "importprivkey", 2, "rescan" },
229  { "importaddress", 2, "rescan" },
230  { "importaddress", 3, "p2sh" },
231  { "importpubkey", 2, "rescan" },
232  { "importmempool", 1, "options" },
233  { "importmempool", 1, "apply_fee_delta_priority" },
234  { "importmempool", 1, "use_current_time" },
235  { "importmempool", 1, "apply_unbroadcast_set" },
236  { "importmulti", 0, "requests" },
237  { "importmulti", 1, "options" },
238  { "importmulti", 1, "rescan" },
239  { "importdescriptors", 0, "requests" },
240  { "listdescriptors", 0, "private" },
241  { "verifychain", 0, "checklevel" },
242  { "verifychain", 1, "nblocks" },
243  { "getblockstats", 0, "hash_or_height" },
244  { "getblockstats", 1, "stats" },
245  { "pruneblockchain", 0, "height" },
246  { "keypoolrefill", 0, "newsize" },
247  { "getrawmempool", 0, "verbose" },
248  { "getrawmempool", 1, "mempool_sequence" },
249  { "estimatesmartfee", 0, "conf_target" },
250  { "estimaterawfee", 0, "conf_target" },
251  { "estimaterawfee", 1, "threshold" },
252  { "prioritisetransaction", 1, "dummy" },
253  { "prioritisetransaction", 2, "fee_delta" },
254  { "setban", 2, "bantime" },
255  { "setban", 3, "absolute" },
256  { "setnetworkactive", 0, "state" },
257  { "setwalletflag", 1, "value" },
258  { "getmempoolancestors", 1, "verbose" },
259  { "getmempooldescendants", 1, "verbose" },
260  { "gettxspendingprevout", 0, "outputs" },
261  { "bumpfee", 1, "options" },
262  { "bumpfee", 1, "conf_target"},
263  { "bumpfee", 1, "fee_rate"},
264  { "bumpfee", 1, "replaceable"},
265  { "bumpfee", 1, "outputs"},
266  { "bumpfee", 1, "original_change_index"},
267  { "psbtbumpfee", 1, "options" },
268  { "psbtbumpfee", 1, "conf_target"},
269  { "psbtbumpfee", 1, "fee_rate"},
270  { "psbtbumpfee", 1, "replaceable"},
271  { "psbtbumpfee", 1, "outputs"},
272  { "psbtbumpfee", 1, "original_change_index"},
273  { "logging", 0, "include" },
274  { "logging", 1, "exclude" },
275  { "disconnectnode", 1, "nodeid" },
276  { "upgradewallet", 0, "version" },
277  // Echo with conversion (For testing only)
278  { "echojson", 0, "arg0" },
279  { "echojson", 1, "arg1" },
280  { "echojson", 2, "arg2" },
281  { "echojson", 3, "arg3" },
282  { "echojson", 4, "arg4" },
283  { "echojson", 5, "arg5" },
284  { "echojson", 6, "arg6" },
285  { "echojson", 7, "arg7" },
286  { "echojson", 8, "arg8" },
287  { "echojson", 9, "arg9" },
288  { "rescanblockchain", 0, "start_height"},
289  { "rescanblockchain", 1, "stop_height"},
290  { "createwallet", 1, "disable_private_keys"},
291  { "createwallet", 2, "blank"},
292  { "createwallet", 4, "avoid_reuse"},
293  { "createwallet", 5, "descriptors"},
294  { "createwallet", 6, "load_on_startup"},
295  { "createwallet", 7, "external_signer"},
296  { "restorewallet", 2, "load_on_startup"},
297  { "loadwallet", 1, "load_on_startup"},
298  { "unloadwallet", 1, "load_on_startup"},
299  { "getnodeaddresses", 0, "count"},
300  { "addpeeraddress", 1, "port"},
301  { "addpeeraddress", 2, "tried"},
302  { "sendmsgtopeer", 0, "peer_id" },
303  { "stop", 0, "wait" },
304  { "addnode", 2, "v2transport" },
305 };
306 // clang-format on
307 
309 static UniValue Parse(std::string_view raw)
310 {
311  UniValue parsed;
312  if (!parsed.read(raw)) throw std::runtime_error(tfm::format("Error parsing JSON: %s", raw));
313  return parsed;
314 }
315 
317 {
318 private:
319  std::set<std::pair<std::string, int>> members;
320  std::set<std::pair<std::string, std::string>> membersByName;
321 
322 public:
324 
326  UniValue ArgToUniValue(std::string_view arg_value, const std::string& method, int param_idx)
327  {
328  return members.count({method, param_idx}) > 0 ? Parse(arg_value) : arg_value;
329  }
330 
332  UniValue ArgToUniValue(std::string_view arg_value, const std::string& method, const std::string& param_name)
333  {
334  return membersByName.count({method, param_name}) > 0 ? Parse(arg_value) : arg_value;
335  }
336 };
337 
339 {
340  for (const auto& cp : vRPCConvertParams) {
341  members.emplace(cp.methodName, cp.paramIdx);
342  membersByName.emplace(cp.methodName, cp.paramName);
343  }
344 }
345 
347 
348 UniValue RPCConvertValues(const std::string &strMethod, const std::vector<std::string> &strParams)
349 {
350  UniValue params(UniValue::VARR);
351 
352  for (unsigned int idx = 0; idx < strParams.size(); idx++) {
353  std::string_view value{strParams[idx]};
354  params.push_back(rpcCvtTable.ArgToUniValue(value, strMethod, idx));
355  }
356 
357  return params;
358 }
359 
360 UniValue RPCConvertNamedValues(const std::string &strMethod, const std::vector<std::string> &strParams)
361 {
362  UniValue params(UniValue::VOBJ);
363  UniValue positional_args{UniValue::VARR};
364 
365  for (std::string_view s: strParams) {
366  size_t pos = s.find('=');
367  if (pos == std::string::npos) {
368  positional_args.push_back(rpcCvtTable.ArgToUniValue(s, strMethod, positional_args.size()));
369  continue;
370  }
371 
372  std::string name{s.substr(0, pos)};
373  std::string_view value{s.substr(pos+1)};
374 
375  // Intentionally overwrite earlier named values with later ones as a
376  // convenience for scripts and command line users that want to merge
377  // options.
378  params.pushKV(name, rpcCvtTable.ArgToUniValue(value, strMethod, name));
379  }
380 
381  if (!positional_args.empty()) {
382  // Use pushKVEnd instead of pushKV to avoid overwriting an explicit
383  // "args" value with an implicit one. Let the RPC server handle the
384  // request as given.
385  params.pushKVEnd("args", positional_args);
386  }
387 
388  return params;
389 }
std::string methodName
method whose params want conversion
Definition: client.cpp:18
int paramIdx
0-based idx of param to convert
Definition: client.cpp:19
std::string paramName
parameter name
Definition: client.cpp:20
std::set< std::pair< std::string, std::string > > membersByName
Definition: client.cpp:320
UniValue ArgToUniValue(std::string_view arg_value, const std::string &method, int param_idx)
Return arg_value as UniValue, and first parse it if it is a non-string parameter.
Definition: client.cpp:326
std::set< std::pair< std::string, int > > members
Definition: client.cpp:319
UniValue ArgToUniValue(std::string_view arg_value, const std::string &method, const std::string &param_name)
Return arg_value as UniValue, and first parse it if it is a non-string parameter.
Definition: client.cpp:332
void push_back(UniValue val)
Definition: univalue.cpp:104
@ VOBJ
Definition: univalue.h:23
@ VARR
Definition: univalue.h:23
void pushKVEnd(std::string key, UniValue val)
Definition: univalue.cpp:118
bool read(std::string_view raw)
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
UniValue RPCConvertValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert positional arguments to command-specific RPC representation.
Definition: client.cpp:348
static UniValue Parse(std::string_view raw)
Parse string to UniValue or throw runtime_error if string contains invalid JSON.
Definition: client.cpp:309
UniValue RPCConvertNamedValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert named arguments to command-specific RPC representation.
Definition: client.cpp:360
static CRPCConvertTable rpcCvtTable
Definition: client.cpp:346
static const CRPCConvertParam vRPCConvertParams[]
Specify a (method, idx, name) here if the argument is a non-string RPC argument and needs to be conve...
Definition: client.cpp:30
void format(std::ostream &out, const char *fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1060
const char * name
Definition: rest.cpp:45