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