Bitcoin Core  22.99.0
P2P Digital Currency
bitcoin-cli.cpp
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 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 #if defined(HAVE_CONFIG_H)
8 #endif
9 
10 #include <chainparamsbase.h>
11 #include <clientversion.h>
12 #include <policy/feerate.h>
13 #include <rpc/client.h>
14 #include <rpc/mining.h>
15 #include <rpc/protocol.h>
16 #include <rpc/request.h>
17 #include <tinyformat.h>
18 #include <util/strencodings.h>
19 #include <util/system.h>
20 #include <util/translation.h>
21 #include <util/url.h>
22 
23 #include <algorithm>
24 #include <cmath>
25 #include <functional>
26 #include <memory>
27 #include <optional>
28 #include <stdio.h>
29 #include <string>
30 #include <tuple>
31 
32 #ifndef WIN32
33 #include <unistd.h>
34 #endif
35 
36 #include <event2/buffer.h>
37 #include <event2/keyvalq_struct.h>
38 #include <support/events.h>
39 
40 #include <univalue.h>
41 #include <compat/stdin.h>
42 
43 const std::function<std::string(const char*)> G_TRANSLATION_FUN = nullptr;
45 
46 static const char DEFAULT_RPCCONNECT[] = "127.0.0.1";
47 static const int DEFAULT_HTTP_CLIENT_TIMEOUT=900;
48 static constexpr int DEFAULT_WAIT_CLIENT_TIMEOUT = 0;
49 static const bool DEFAULT_NAMED=false;
50 static const int CONTINUE_EXECUTION=-1;
51 static constexpr int8_t UNKNOWN_NETWORK{-1};
52 
54 static const std::string DEFAULT_NBLOCKS = "1";
55 
57 static const std::string DEFAULT_COLOR_SETTING{"auto"};
58 
59 static void SetupCliArgs(ArgsManager& argsman)
60 {
61  SetupHelpOptions(argsman);
62 
63  const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
64  const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
65  const auto signetBaseParams = CreateBaseChainParams(CBaseChainParams::SIGNET);
66  const auto regtestBaseParams = CreateBaseChainParams(CBaseChainParams::REGTEST);
67 
68  argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
69  argsman.AddArg("-conf=<file>", strprintf("Specify configuration file. Relative paths will be prefixed by datadir location. (default: %s)", BITCOIN_CONF_FILENAME), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
70  argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
71  argsman.AddArg("-generate", strprintf("Generate blocks immediately, equivalent to RPC getnewaddress followed by RPC generatetoaddress. Optional positional integer arguments are number of blocks to generate (default: %s) and maximum iterations to try (default: %s), equivalent to RPC generatetoaddress nblocks and maxtries arguments. Example: bitcoin-cli -generate 4 1000", DEFAULT_NBLOCKS, DEFAULT_MAX_TRIES), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
72  argsman.AddArg("-addrinfo", "Get the number of addresses known to the node, per network and total.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
73  argsman.AddArg("-getinfo", "Get general information from the remote server. Note that unlike server-side RPC calls, the results of -getinfo is the result of multiple non-atomic requests. Some entries in the result may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
74  argsman.AddArg("-netinfo", "Get network peer connection information from the remote server. An optional integer argument from 0 to 4 can be passed for different peers listings (default: 0). Pass \"help\" for detailed help documentation.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
75 
77  argsman.AddArg("-color=<when>", strprintf("Color setting for CLI output (default: %s). Valid values: always, auto (add color codes when standard output is connected to a terminal and OS is not WIN32), never.", DEFAULT_COLOR_SETTING), ArgsManager::ALLOW_STRING, OptionsCategory::OPTIONS);
78  argsman.AddArg("-named", strprintf("Pass named instead of positional arguments (default: %s)", DEFAULT_NAMED), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
79  argsman.AddArg("-rpcclienttimeout=<n>", strprintf("Timeout in seconds during HTTP requests, or 0 for no timeout. (default: %d)", DEFAULT_HTTP_CLIENT_TIMEOUT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
80  argsman.AddArg("-rpcconnect=<ip>", strprintf("Send commands to node running on <ip> (default: %s)", DEFAULT_RPCCONNECT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
81  argsman.AddArg("-rpccookiefile=<loc>", "Location of the auth cookie. Relative paths will be prefixed by a net-specific datadir location. (default: data dir)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
82  argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
83  argsman.AddArg("-rpcport=<port>", strprintf("Connect to JSON-RPC on <port> (default: %u, testnet: %u, signet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), signetBaseParams->RPCPort(), regtestBaseParams->RPCPort()), ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::OPTIONS);
84  argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
85  argsman.AddArg("-rpcwait", "Wait for RPC server to start", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
86  argsman.AddArg("-rpcwaittimeout=<n>", strprintf("Timeout in seconds to wait for the RPC server to start, or 0 for no timeout. (default: %d)", DEFAULT_WAIT_CLIENT_TIMEOUT), ArgsManager::ALLOW_INT, OptionsCategory::OPTIONS);
87  argsman.AddArg("-rpcwallet=<walletname>", "Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to bitcoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/<walletname>", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
88  argsman.AddArg("-stdin", "Read extra arguments from standard input, one per line until EOF/Ctrl-D (recommended for sensitive information such as passphrases). When combined with -stdinrpcpass, the first line from standard input is used for the RPC password.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
89  argsman.AddArg("-stdinrpcpass", "Read RPC password from standard input as a single line. When combined with -stdin, the first line from standard input is used for the RPC password. When combined with -stdinwalletpassphrase, -stdinrpcpass consumes the first line, and -stdinwalletpassphrase consumes the second.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
90  argsman.AddArg("-stdinwalletpassphrase", "Read wallet passphrase from standard input as a single line. When combined with -stdin, the first line from standard input is used for the wallet passphrase.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
91 }
92 
94 static void libevent_log_cb(int severity, const char *msg)
95 {
96  // Ignore everything other than errors
97  if (severity >= EVENT_LOG_ERR) {
98  throw std::runtime_error(strprintf("libevent error: %s", msg));
99  }
100 }
101 
102 //
103 // Exception thrown on connection error. This error is used to determine
104 // when to wait if -rpcwait is given.
105 //
106 class CConnectionFailed : public std::runtime_error
107 {
108 public:
109 
110  explicit inline CConnectionFailed(const std::string& msg) :
111  std::runtime_error(msg)
112  {}
113 
114 };
115 
116 //
117 // This function returns either one of EXIT_ codes when it's expected to stop the process or
118 // CONTINUE_EXECUTION when it's expected to continue further.
119 //
120 static int AppInitRPC(int argc, char* argv[])
121 {
123  std::string error;
124  if (!gArgs.ParseParameters(argc, argv, error)) {
125  tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error);
126  return EXIT_FAILURE;
127  }
128  if (argc < 2 || HelpRequested(gArgs) || gArgs.IsArgSet("-version")) {
129  std::string strUsage = PACKAGE_NAME " RPC client version " + FormatFullVersion() + "\n";
130  if (!gArgs.IsArgSet("-version")) {
131  strUsage += "\n"
132  "Usage: bitcoin-cli [options] <command> [params] Send command to " PACKAGE_NAME "\n"
133  "or: bitcoin-cli [options] -named <command> [name=value]... Send command to " PACKAGE_NAME " (with named arguments)\n"
134  "or: bitcoin-cli [options] help List commands\n"
135  "or: bitcoin-cli [options] help <command> Get help for a command\n";
136  strUsage += "\n" + gArgs.GetHelpMessage();
137  }
138 
139  tfm::format(std::cout, "%s", strUsage);
140  if (argc < 2) {
141  tfm::format(std::cerr, "Error: too few parameters\n");
142  return EXIT_FAILURE;
143  }
144  return EXIT_SUCCESS;
145  }
146  if (!CheckDataDirOption()) {
147  tfm::format(std::cerr, "Error: Specified data directory \"%s\" does not exist.\n", gArgs.GetArg("-datadir", ""));
148  return EXIT_FAILURE;
149  }
150  if (!gArgs.ReadConfigFiles(error, true)) {
151  tfm::format(std::cerr, "Error reading configuration file: %s\n", error);
152  return EXIT_FAILURE;
153  }
154  // Check for chain settings (BaseParams() calls are only valid after this clause)
155  try {
157  } catch (const std::exception& e) {
158  tfm::format(std::cerr, "Error: %s\n", e.what());
159  return EXIT_FAILURE;
160  }
161  return CONTINUE_EXECUTION;
162 }
163 
164 
166 struct HTTPReply
167 {
168  HTTPReply(): status(0), error(-1) {}
169 
170  int status;
171  int error;
172  std::string body;
173 };
174 
175 static std::string http_errorstring(int code)
176 {
177  switch(code) {
178 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
179  case EVREQ_HTTP_TIMEOUT:
180  return "timeout reached";
181  case EVREQ_HTTP_EOF:
182  return "EOF reached";
183  case EVREQ_HTTP_INVALID_HEADER:
184  return "error while reading header, or invalid header";
185  case EVREQ_HTTP_BUFFER_ERROR:
186  return "error encountered while reading or writing";
187  case EVREQ_HTTP_REQUEST_CANCEL:
188  return "request was canceled";
189  case EVREQ_HTTP_DATA_TOO_LONG:
190  return "response body is larger than allowed";
191 #endif
192  default:
193  return "unknown";
194  }
195 }
196 
197 static void http_request_done(struct evhttp_request *req, void *ctx)
198 {
199  HTTPReply *reply = static_cast<HTTPReply*>(ctx);
200 
201  if (req == nullptr) {
202  /* If req is nullptr, it means an error occurred while connecting: the
203  * error code will have been passed to http_error_cb.
204  */
205  reply->status = 0;
206  return;
207  }
208 
209  reply->status = evhttp_request_get_response_code(req);
210 
211  struct evbuffer *buf = evhttp_request_get_input_buffer(req);
212  if (buf)
213  {
214  size_t size = evbuffer_get_length(buf);
215  const char *data = (const char*)evbuffer_pullup(buf, size);
216  if (data)
217  reply->body = std::string(data, size);
218  evbuffer_drain(buf, size);
219  }
220 }
221 
222 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
223 static void http_error_cb(enum evhttp_request_error err, void *ctx)
224 {
225  HTTPReply *reply = static_cast<HTTPReply*>(ctx);
226  reply->error = err;
227 }
228 #endif
229 
234 {
235 public:
236  virtual ~BaseRequestHandler() {}
237  virtual UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) = 0;
238  virtual UniValue ProcessReply(const UniValue &batch_in) = 0;
239 };
240 
243 {
244 private:
245  static constexpr std::array m_networks{"ipv4", "ipv6", "onion", "i2p"};
246  int8_t NetworkStringToId(const std::string& str) const
247  {
248  for (size_t i = 0; i < m_networks.size(); ++i) {
249  if (str == m_networks.at(i)) return i;
250  }
251  return UNKNOWN_NETWORK;
252  }
253 
254 public:
255  UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
256  {
257  if (!args.empty()) {
258  throw std::runtime_error("-addrinfo takes no arguments");
259  }
260  UniValue params{RPCConvertValues("getnodeaddresses", std::vector<std::string>{{"0"}})};
261  return JSONRPCRequestObj("getnodeaddresses", params, 1);
262  }
263 
264  UniValue ProcessReply(const UniValue& reply) override
265  {
266  if (!reply["error"].isNull()) return reply;
267  const std::vector<UniValue>& nodes{reply["result"].getValues()};
268  if (!nodes.empty() && nodes.at(0)["network"].isNull()) {
269  throw std::runtime_error("-addrinfo requires bitcoind server to be running v22.0 and up");
270  }
271  // Count the number of peers known to our node, by network.
272  std::array<uint64_t, m_networks.size()> counts{{}};
273  for (const UniValue& node : nodes) {
274  std::string network_name{node["network"].get_str()};
275  const int8_t network_id{NetworkStringToId(network_name)};
276  if (network_id == UNKNOWN_NETWORK) continue;
277  ++counts.at(network_id);
278  }
279  // Prepare result to return to user.
280  UniValue result{UniValue::VOBJ}, addresses{UniValue::VOBJ};
281  uint64_t total{0}; // Total address count
282  for (size_t i = 0; i < m_networks.size(); ++i) {
283  addresses.pushKV(m_networks.at(i), counts.at(i));
284  total += counts.at(i);
285  }
286  addresses.pushKV("total", total);
287  result.pushKV("addresses_known", addresses);
288  return JSONRPCReplyObj(result, NullUniValue, 1);
289  }
290 };
291 
294 {
295 public:
296  const int ID_NETWORKINFO = 0;
297  const int ID_BLOCKCHAININFO = 1;
298  const int ID_WALLETINFO = 2;
299  const int ID_BALANCES = 3;
300 
302  UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
303  {
304  if (!args.empty()) {
305  throw std::runtime_error("-getinfo takes no arguments");
306  }
307  UniValue result(UniValue::VARR);
308  result.push_back(JSONRPCRequestObj("getnetworkinfo", NullUniValue, ID_NETWORKINFO));
309  result.push_back(JSONRPCRequestObj("getblockchaininfo", NullUniValue, ID_BLOCKCHAININFO));
310  result.push_back(JSONRPCRequestObj("getwalletinfo", NullUniValue, ID_WALLETINFO));
311  result.push_back(JSONRPCRequestObj("getbalances", NullUniValue, ID_BALANCES));
312  return result;
313  }
314 
316  UniValue ProcessReply(const UniValue &batch_in) override
317  {
318  UniValue result(UniValue::VOBJ);
319  const std::vector<UniValue> batch = JSONRPCProcessBatchReply(batch_in);
320  // Errors in getnetworkinfo() and getblockchaininfo() are fatal, pass them on;
321  // getwalletinfo() and getbalances() are allowed to fail if there is no wallet.
322  if (!batch[ID_NETWORKINFO]["error"].isNull()) {
323  return batch[ID_NETWORKINFO];
324  }
325  if (!batch[ID_BLOCKCHAININFO]["error"].isNull()) {
326  return batch[ID_BLOCKCHAININFO];
327  }
328  result.pushKV("version", batch[ID_NETWORKINFO]["result"]["version"]);
329  result.pushKV("blocks", batch[ID_BLOCKCHAININFO]["result"]["blocks"]);
330  result.pushKV("headers", batch[ID_BLOCKCHAININFO]["result"]["headers"]);
331  result.pushKV("verificationprogress", batch[ID_BLOCKCHAININFO]["result"]["verificationprogress"]);
332  result.pushKV("timeoffset", batch[ID_NETWORKINFO]["result"]["timeoffset"]);
333 
334  UniValue connections(UniValue::VOBJ);
335  connections.pushKV("in", batch[ID_NETWORKINFO]["result"]["connections_in"]);
336  connections.pushKV("out", batch[ID_NETWORKINFO]["result"]["connections_out"]);
337  connections.pushKV("total", batch[ID_NETWORKINFO]["result"]["connections"]);
338  result.pushKV("connections", connections);
339 
340  result.pushKV("networks", batch[ID_NETWORKINFO]["result"]["networks"]);
341  result.pushKV("difficulty", batch[ID_BLOCKCHAININFO]["result"]["difficulty"]);
342  result.pushKV("chain", UniValue(batch[ID_BLOCKCHAININFO]["result"]["chain"]));
343  if (!batch[ID_WALLETINFO]["result"].isNull()) {
344  result.pushKV("has_wallet", true);
345  result.pushKV("keypoolsize", batch[ID_WALLETINFO]["result"]["keypoolsize"]);
346  result.pushKV("walletname", batch[ID_WALLETINFO]["result"]["walletname"]);
347  if (!batch[ID_WALLETINFO]["result"]["unlocked_until"].isNull()) {
348  result.pushKV("unlocked_until", batch[ID_WALLETINFO]["result"]["unlocked_until"]);
349  }
350  result.pushKV("paytxfee", batch[ID_WALLETINFO]["result"]["paytxfee"]);
351  }
352  if (!batch[ID_BALANCES]["result"].isNull()) {
353  result.pushKV("balance", batch[ID_BALANCES]["result"]["mine"]["trusted"]);
354  }
355  result.pushKV("relayfee", batch[ID_NETWORKINFO]["result"]["relayfee"]);
356  result.pushKV("warnings", batch[ID_NETWORKINFO]["result"]["warnings"]);
357  return JSONRPCReplyObj(result, NullUniValue, 1);
358  }
359 };
360 
363 {
364 private:
365  static constexpr uint8_t MAX_DETAIL_LEVEL{4};
366  static constexpr std::array m_networks{"ipv4", "ipv6", "onion", "i2p"};
367  std::array<std::array<uint16_t, m_networks.size() + 1>, 3> m_counts{{{}}};
370  int8_t NetworkStringToId(const std::string& str) const
371  {
372  for (size_t i = 0; i < m_networks.size(); ++i) {
373  if (str == m_networks.at(i)) return i;
374  }
375  return UNKNOWN_NETWORK;
376  }
377  uint8_t m_details_level{0};
378  bool DetailsRequested() const { return m_details_level > 0 && m_details_level < 5; }
379  bool IsAddressSelected() const { return m_details_level == 2 || m_details_level == 4; }
380  bool IsVersionSelected() const { return m_details_level == 3 || m_details_level == 4; }
381  bool m_is_asmap_on{false};
382  size_t m_max_addr_length{0};
385  size_t m_max_age_length{5};
386  size_t m_max_id_length{2};
387  struct Peer {
388  std::string addr;
389  std::string sub_version;
390  std::string conn_type;
391  std::string network;
392  std::string age;
393  double min_ping;
394  double ping;
395  int64_t addr_processed;
397  int64_t last_blck;
398  int64_t last_recv;
399  int64_t last_send;
400  int64_t last_trxn;
401  int id;
403  int version;
409  bool operator<(const Peer& rhs) const { return std::tie(is_outbound, min_ping) < std::tie(rhs.is_outbound, rhs.min_ping); }
410  };
411  std::vector<Peer> m_peers;
412  std::string ChainToString() const
413  {
414  if (gArgs.GetChainName() == CBaseChainParams::TESTNET) return " testnet";
415  if (gArgs.GetChainName() == CBaseChainParams::SIGNET) return " signet";
416  if (gArgs.GetChainName() == CBaseChainParams::REGTEST) return " regtest";
417  return "";
418  }
419  std::string PingTimeToString(double seconds) const
420  {
421  if (seconds < 0) return "";
422  const double milliseconds{round(1000 * seconds)};
423  return milliseconds > 999999 ? "-" : ToString(milliseconds);
424  }
425  std::string ConnectionTypeForNetinfo(const std::string& conn_type) const
426  {
427  if (conn_type == "outbound-full-relay") return "full";
428  if (conn_type == "block-relay-only") return "block";
429  if (conn_type == "manual" || conn_type == "feeler") return conn_type;
430  if (conn_type == "addr-fetch") return "addr";
431  return "";
432  }
433  const int64_t m_time_now{GetTimeSeconds()};
434 
435 public:
436  static constexpr int ID_PEERINFO = 0;
437  static constexpr int ID_NETWORKINFO = 1;
438 
439  UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
440  {
441  if (!args.empty()) {
442  uint8_t n{0};
443  if (ParseUInt8(args.at(0), &n)) {
444  m_details_level = std::min(n, MAX_DETAIL_LEVEL);
445  } else {
446  throw std::runtime_error(strprintf("invalid -netinfo argument: %s\nFor more information, run: bitcoin-cli -netinfo help", args.at(0)));
447  }
448  }
449  UniValue result(UniValue::VARR);
450  result.push_back(JSONRPCRequestObj("getpeerinfo", NullUniValue, ID_PEERINFO));
451  result.push_back(JSONRPCRequestObj("getnetworkinfo", NullUniValue, ID_NETWORKINFO));
452  return result;
453  }
454 
455  UniValue ProcessReply(const UniValue& batch_in) override
456  {
457  const std::vector<UniValue> batch{JSONRPCProcessBatchReply(batch_in)};
458  if (!batch[ID_PEERINFO]["error"].isNull()) return batch[ID_PEERINFO];
459  if (!batch[ID_NETWORKINFO]["error"].isNull()) return batch[ID_NETWORKINFO];
460 
461  const UniValue& networkinfo{batch[ID_NETWORKINFO]["result"]};
462  if (networkinfo["version"].get_int() < 209900) {
463  throw std::runtime_error("-netinfo requires bitcoind server to be running v0.21.0 and up");
464  }
465 
466  // Count peer connection totals, and if DetailsRequested(), store peer data in a vector of structs.
467  for (const UniValue& peer : batch[ID_PEERINFO]["result"].getValues()) {
468  const std::string network{peer["network"].get_str()};
469  const int8_t network_id{NetworkStringToId(network)};
470  if (network_id == UNKNOWN_NETWORK) continue;
471  const bool is_outbound{!peer["inbound"].get_bool()};
472  const bool is_block_relay{!peer["relaytxes"].get_bool()};
473  const std::string conn_type{peer["connection_type"].get_str()};
474  ++m_counts.at(is_outbound).at(network_id); // in/out by network
475  ++m_counts.at(is_outbound).at(m_networks.size()); // in/out overall
476  ++m_counts.at(2).at(network_id); // total by network
477  ++m_counts.at(2).at(m_networks.size()); // total overall
478  if (conn_type == "block-relay-only") ++m_block_relay_peers_count;
479  if (conn_type == "manual") ++m_manual_peers_count;
480  if (DetailsRequested()) {
481  // Push data for this peer to the peers vector.
482  const int peer_id{peer["id"].get_int()};
483  const int mapped_as{peer["mapped_as"].isNull() ? 0 : peer["mapped_as"].get_int()};
484  const int version{peer["version"].get_int()};
485  const int64_t addr_processed{peer["addr_processed"].isNull() ? 0 : peer["addr_processed"].get_int64()};
486  const int64_t addr_rate_limited{peer["addr_rate_limited"].isNull() ? 0 : peer["addr_rate_limited"].get_int64()};
487  const int64_t conn_time{peer["conntime"].get_int64()};
488  const int64_t last_blck{peer["last_block"].get_int64()};
489  const int64_t last_recv{peer["lastrecv"].get_int64()};
490  const int64_t last_send{peer["lastsend"].get_int64()};
491  const int64_t last_trxn{peer["last_transaction"].get_int64()};
492  const double min_ping{peer["minping"].isNull() ? -1 : peer["minping"].get_real()};
493  const double ping{peer["pingtime"].isNull() ? -1 : peer["pingtime"].get_real()};
494  const std::string addr{peer["addr"].get_str()};
495  const std::string age{conn_time == 0 ? "" : ToString((m_time_now - conn_time) / 60)};
496  const std::string sub_version{peer["subver"].get_str()};
497  const bool is_addr_relay_enabled{peer["addr_relay_enabled"].isNull() ? false : peer["addr_relay_enabled"].get_bool()};
498  const bool is_bip152_hb_from{peer["bip152_hb_from"].get_bool()};
499  const bool is_bip152_hb_to{peer["bip152_hb_to"].get_bool()};
500  m_peers.push_back({addr, sub_version, conn_type, network, age, min_ping, ping, addr_processed, addr_rate_limited, last_blck, last_recv, last_send, last_trxn, peer_id, mapped_as, version, is_addr_relay_enabled, is_bip152_hb_from, is_bip152_hb_to, is_block_relay, is_outbound});
501  m_max_addr_length = std::max(addr.length() + 1, m_max_addr_length);
502  m_max_addr_processed_length = std::max(ToString(addr_processed).length(), m_max_addr_processed_length);
503  m_max_addr_rate_limited_length = std::max(ToString(addr_rate_limited).length(), m_max_addr_rate_limited_length);
504  m_max_age_length = std::max(age.length(), m_max_age_length);
505  m_max_id_length = std::max(ToString(peer_id).length(), m_max_id_length);
506  m_is_asmap_on |= (mapped_as != 0);
507  }
508  }
509 
510  // Generate report header.
511  std::string result{strprintf("%s client %s%s - server %i%s\n\n", PACKAGE_NAME, FormatFullVersion(), ChainToString(), networkinfo["protocolversion"].get_int(), networkinfo["subversion"].get_str())};
512 
513  // Report detailed peer connections list sorted by direction and minimum ping time.
514  if (DetailsRequested() && !m_peers.empty()) {
515  std::sort(m_peers.begin(), m_peers.end());
516  result += strprintf("<-> type net mping ping send recv txn blk hb %*s%*s%*s ",
519  m_max_age_length, "age");
520  if (m_is_asmap_on) result += " asmap ";
521  result += strprintf("%*s %-*s%s\n", m_max_id_length, "id", IsAddressSelected() ? m_max_addr_length : 0, IsAddressSelected() ? "address" : "", IsVersionSelected() ? "version" : "");
522  for (const Peer& peer : m_peers) {
523  std::string version{ToString(peer.version) + peer.sub_version};
524  result += strprintf(
525  "%3s %6s %5s%7s%7s%5s%5s%5s%5s %2s %*s%*s%*s%*i %*s %-*s%s\n",
526  peer.is_outbound ? "out" : "in",
527  ConnectionTypeForNetinfo(peer.conn_type),
528  peer.network,
529  PingTimeToString(peer.min_ping),
530  PingTimeToString(peer.ping),
531  peer.last_send ? ToString(m_time_now - peer.last_send) : "",
532  peer.last_recv ? ToString(m_time_now - peer.last_recv) : "",
533  peer.last_trxn ? ToString((m_time_now - peer.last_trxn) / 60) : peer.is_block_relay ? "*" : "",
534  peer.last_blck ? ToString((m_time_now - peer.last_blck) / 60) : "",
535  strprintf("%s%s", peer.is_bip152_hb_to ? "." : " ", peer.is_bip152_hb_from ? "*" : " "),
536  m_max_addr_processed_length, // variable spacing
537  peer.addr_processed ? ToString(peer.addr_processed) : peer.is_addr_relay_enabled ? "" : ".",
538  m_max_addr_rate_limited_length, // variable spacing
539  peer.addr_rate_limited ? ToString(peer.addr_rate_limited) : "",
540  m_max_age_length, // variable spacing
541  peer.age,
542  m_is_asmap_on ? 7 : 0, // variable spacing
543  m_is_asmap_on && peer.mapped_as ? ToString(peer.mapped_as) : "",
544  m_max_id_length, // variable spacing
545  peer.id,
546  IsAddressSelected() ? m_max_addr_length : 0, // variable spacing
547  IsAddressSelected() ? peer.addr : "",
548  IsVersionSelected() && version != "0" ? version : "");
549  }
550  result += strprintf(" ms ms sec sec min min %*s\n\n", m_max_age_length, "min");
551  }
552 
553  // Report peer connection totals by type.
554  result += " ipv4 ipv6 onion";
555  const bool any_i2p_peers = m_counts.at(2).at(3); // false if total i2p peers count is 0, otherwise true
556  if (any_i2p_peers) result += " i2p";
557  result += " total block";
558  if (m_manual_peers_count) result += " manual";
559  const std::array rows{"in", "out", "total"};
560  for (uint8_t i = 0; i < 3; ++i) {
561  result += strprintf("\n%-5s %5i %5i %5i", rows.at(i), m_counts.at(i).at(0), m_counts.at(i).at(1), m_counts.at(i).at(2)); // ipv4/ipv6/onion peers counts
562  if (any_i2p_peers) result += strprintf(" %5i", m_counts.at(i).at(3)); // i2p peers count
563  result += strprintf(" %5i", m_counts.at(i).at(m_networks.size())); // total peers count
564  if (i == 1) { // the outbound row has two extra columns for block relay and manual peer counts
565  result += strprintf(" %5i", m_block_relay_peers_count);
566  if (m_manual_peers_count) result += strprintf(" %5i", m_manual_peers_count);
567  }
568  }
569 
570  // Report local addresses, ports, and scores.
571  result += "\n\nLocal addresses";
572  const std::vector<UniValue>& local_addrs{networkinfo["localaddresses"].getValues()};
573  if (local_addrs.empty()) {
574  result += ": n/a\n";
575  } else {
576  size_t max_addr_size{0};
577  for (const UniValue& addr : local_addrs) {
578  max_addr_size = std::max(addr["address"].get_str().length() + 1, max_addr_size);
579  }
580  for (const UniValue& addr : local_addrs) {
581  result += strprintf("\n%-*s port %6i score %6i", max_addr_size, addr["address"].get_str(), addr["port"].get_int(), addr["score"].get_int());
582  }
583  }
584 
585  return JSONRPCReplyObj(UniValue{result}, NullUniValue, 1);
586  }
587 
588  const std::string m_help_doc{
589  "-netinfo level|\"help\" \n\n"
590  "Returns a network peer connections dashboard with information from the remote server.\n"
591  "This human-readable interface will change regularly and is not intended to be a stable API.\n"
592  "Under the hood, -netinfo fetches the data by calling getpeerinfo and getnetworkinfo.\n"
593  + strprintf("An optional integer argument from 0 to %d can be passed for different peers listings; %d to 255 are parsed as %d.\n", MAX_DETAIL_LEVEL, MAX_DETAIL_LEVEL, MAX_DETAIL_LEVEL) +
594  "Pass \"help\" to see this detailed help documentation.\n"
595  "If more than one argument is passed, only the first one is read and parsed.\n"
596  "Suggestion: use with the Linux watch(1) command for a live dashboard; see example below.\n\n"
597  "Arguments:\n"
598  + strprintf("1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n", MAX_DETAIL_LEVEL) +
599  " 0 - Connection counts and local addresses\n"
600  " 1 - Like 0 but with a peers listing (without address or version columns)\n"
601  " 2 - Like 1 but with an address column\n"
602  " 3 - Like 1 but with a version column\n"
603  " 4 - Like 1 but with both address and version columns\n"
604  "2. help (string \"help\", optional) Print this help documentation instead of the dashboard.\n\n"
605  "Result:\n\n"
606  + strprintf("* The peers listing in levels 1-%d displays all of the peers sorted by direction and minimum ping time:\n\n", MAX_DETAIL_LEVEL) +
607  " Column Description\n"
608  " ------ -----------\n"
609  " <-> Direction\n"
610  " \"in\" - inbound connections are those initiated by the peer\n"
611  " \"out\" - outbound connections are those initiated by us\n"
612  " type Type of peer connection\n"
613  " \"full\" - full relay, the default\n"
614  " \"block\" - block relay; like full relay but does not relay transactions or addresses\n"
615  " \"manual\" - peer we manually added using RPC addnode or the -addnode/-connect config options\n"
616  " \"feeler\" - short-lived connection for testing addresses\n"
617  " \"addr\" - address fetch; short-lived connection for requesting addresses\n"
618  " net Network the peer connected through (\"ipv4\", \"ipv6\", \"onion\", \"i2p\", or \"cjdns\")\n"
619  " mping Minimum observed ping time, in milliseconds (ms)\n"
620  " ping Last observed ping time, in milliseconds (ms)\n"
621  " send Time since last message sent to the peer, in seconds\n"
622  " recv Time since last message received from the peer, in seconds\n"
623  " txn Time since last novel transaction received from the peer and accepted into our mempool, in minutes\n"
624  " \"*\" - the peer requested we not relay transactions to it (relaytxes is false)\n"
625  " blk Time since last novel block passing initial validity checks received from the peer, in minutes\n"
626  " hb High-bandwidth BIP152 compact block relay\n"
627  " \".\" (to) - we selected the peer as a high-bandwidth peer\n"
628  " \"*\" (from) - the peer selected us as a high-bandwidth peer\n"
629  " addrp Total number of addresses processed, excluding those dropped due to rate limiting\n"
630  " \".\" - we do not relay addresses to this peer (addr_relay_enabled is false)\n"
631  " addrl Total number of addresses dropped due to rate limiting\n"
632  " age Duration of connection to the peer, in minutes\n"
633  " asmap Mapped AS (Autonomous System) number in the BGP route to the peer, used for diversifying\n"
634  " peer selection (only displayed if the -asmap config option is set)\n"
635  " id Peer index, in increasing order of peer connections since node startup\n"
636  " address IP address and port of the peer\n"
637  " version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
638  "* The connection counts table displays the number of peers by direction, network, and the totals\n"
639  " for each, as well as two special outbound columns for block relay peers and manual peers.\n\n"
640  "* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
641  "Examples:\n\n"
642  "Connection counts and local addresses only\n"
643  "> bitcoin-cli -netinfo\n\n"
644  "Compact peers listing\n"
645  "> bitcoin-cli -netinfo 1\n\n"
646  "Full dashboard\n"
647  + strprintf("> bitcoin-cli -netinfo %d\n\n", MAX_DETAIL_LEVEL) +
648  "Full live dashboard, adjust --interval or --no-title as needed (Linux)\n"
649  + strprintf("> watch --interval 1 --no-title bitcoin-cli -netinfo %d\n\n", MAX_DETAIL_LEVEL) +
650  "See this help\n"
651  "> bitcoin-cli -netinfo help\n"};
652 };
653 
656 {
657 public:
658  UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
659  {
660  address_str = args.at(1);
661  UniValue params{RPCConvertValues("generatetoaddress", args)};
662  return JSONRPCRequestObj("generatetoaddress", params, 1);
663  }
664 
665  UniValue ProcessReply(const UniValue &reply) override
666  {
667  UniValue result(UniValue::VOBJ);
668  result.pushKV("address", address_str);
669  result.pushKV("blocks", reply.get_obj()["result"]);
670  return JSONRPCReplyObj(result, NullUniValue, 1);
671  }
672 protected:
673  std::string address_str;
674 };
675 
678 public:
679  UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
680  {
681  UniValue params;
682  if(gArgs.GetBoolArg("-named", DEFAULT_NAMED)) {
683  params = RPCConvertNamedValues(method, args);
684  } else {
685  params = RPCConvertValues(method, args);
686  }
687  return JSONRPCRequestObj(method, params, 1);
688  }
689 
690  UniValue ProcessReply(const UniValue &reply) override
691  {
692  return reply.get_obj();
693  }
694 };
695 
696 static UniValue CallRPC(BaseRequestHandler* rh, const std::string& strMethod, const std::vector<std::string>& args, const std::optional<std::string>& rpcwallet = {})
697 {
698  std::string host;
699  // In preference order, we choose the following for the port:
700  // 1. -rpcport
701  // 2. port in -rpcconnect (ie following : in ipv4 or ]: in ipv6)
702  // 3. default port for chain
703  uint16_t port{BaseParams().RPCPort()};
704  SplitHostPort(gArgs.GetArg("-rpcconnect", DEFAULT_RPCCONNECT), port, host);
705  port = static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", port));
706 
707  // Obtain event base
708  raii_event_base base = obtain_event_base();
709 
710  // Synchronously look up hostname
711  raii_evhttp_connection evcon = obtain_evhttp_connection_base(base.get(), host, port);
712 
713  // Set connection timeout
714  {
715  const int timeout = gArgs.GetIntArg("-rpcclienttimeout", DEFAULT_HTTP_CLIENT_TIMEOUT);
716  if (timeout > 0) {
717  evhttp_connection_set_timeout(evcon.get(), timeout);
718  } else {
719  // Indefinite request timeouts are not possible in libevent-http, so we
720  // set the timeout to a very long time period instead.
721 
722  constexpr int YEAR_IN_SECONDS = 31556952; // Average length of year in Gregorian calendar
723  evhttp_connection_set_timeout(evcon.get(), 5 * YEAR_IN_SECONDS);
724  }
725  }
726 
727  HTTPReply response;
728  raii_evhttp_request req = obtain_evhttp_request(http_request_done, (void*)&response);
729  if (req == nullptr)
730  throw std::runtime_error("create http request failed");
731 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
732  evhttp_request_set_error_cb(req.get(), http_error_cb);
733 #endif
734 
735  // Get credentials
736  std::string strRPCUserColonPass;
737  bool failedToGetAuthCookie = false;
738  if (gArgs.GetArg("-rpcpassword", "") == "") {
739  // Try fall back to cookie-based authentication if no password is provided
741  failedToGetAuthCookie = true;
742  }
743  } else {
744  strRPCUserColonPass = gArgs.GetArg("-rpcuser", "") + ":" + gArgs.GetArg("-rpcpassword", "");
745  }
746 
747  struct evkeyvalq* output_headers = evhttp_request_get_output_headers(req.get());
748  assert(output_headers);
749  evhttp_add_header(output_headers, "Host", host.c_str());
750  evhttp_add_header(output_headers, "Connection", "close");
751  evhttp_add_header(output_headers, "Content-Type", "application/json");
752  evhttp_add_header(output_headers, "Authorization", (std::string("Basic ") + EncodeBase64(strRPCUserColonPass)).c_str());
753 
754  // Attach request data
755  std::string strRequest = rh->PrepareRequest(strMethod, args).write() + "\n";
756  struct evbuffer* output_buffer = evhttp_request_get_output_buffer(req.get());
757  assert(output_buffer);
758  evbuffer_add(output_buffer, strRequest.data(), strRequest.size());
759 
760  // check if we should use a special wallet endpoint
761  std::string endpoint = "/";
762  if (rpcwallet) {
763  char* encodedURI = evhttp_uriencode(rpcwallet->data(), rpcwallet->size(), false);
764  if (encodedURI) {
765  endpoint = "/wallet/" + std::string(encodedURI);
766  free(encodedURI);
767  } else {
768  throw CConnectionFailed("uri-encode failed");
769  }
770  }
771  int r = evhttp_make_request(evcon.get(), req.get(), EVHTTP_REQ_POST, endpoint.c_str());
772  req.release(); // ownership moved to evcon in above call
773  if (r != 0) {
774  throw CConnectionFailed("send http request failed");
775  }
776 
777  event_base_dispatch(base.get());
778 
779  if (response.status == 0) {
780  std::string responseErrorMessage;
781  if (response.error != -1) {
782  responseErrorMessage = strprintf(" (error code %d - \"%s\")", response.error, http_errorstring(response.error));
783  }
784  throw CConnectionFailed(strprintf("Could not connect to the server %s:%d%s\n\nMake sure the bitcoind server is running and that you are connecting to the correct RPC port.", host, port, responseErrorMessage));
785  } else if (response.status == HTTP_UNAUTHORIZED) {
786  if (failedToGetAuthCookie) {
787  throw std::runtime_error(strprintf(
788  "Could not locate RPC credentials. No authentication cookie could be found, and RPC password is not set. See -rpcpassword and -stdinrpcpass. Configuration file: (%s)",
790  } else {
791  throw std::runtime_error("Authorization failed: Incorrect rpcuser or rpcpassword");
792  }
793  } else if (response.status == HTTP_SERVICE_UNAVAILABLE) {
794  throw std::runtime_error(strprintf("Server response: %s", response.body));
795  } else if (response.status >= 400 && response.status != HTTP_BAD_REQUEST && response.status != HTTP_NOT_FOUND && response.status != HTTP_INTERNAL_SERVER_ERROR)
796  throw std::runtime_error(strprintf("server returned HTTP error %d", response.status));
797  else if (response.body.empty())
798  throw std::runtime_error("no response from server");
799 
800  // Parse reply
801  UniValue valReply(UniValue::VSTR);
802  if (!valReply.read(response.body))
803  throw std::runtime_error("couldn't parse reply from server");
804  const UniValue reply = rh->ProcessReply(valReply);
805  if (reply.empty())
806  throw std::runtime_error("expected reply to have result, error and id properties");
807 
808  return reply;
809 }
810 
820 static UniValue ConnectAndCallRPC(BaseRequestHandler* rh, const std::string& strMethod, const std::vector<std::string>& args, const std::optional<std::string>& rpcwallet = {})
821 {
822  UniValue response(UniValue::VOBJ);
823  // Execute and handle connection failures with -rpcwait.
824  const bool fWait = gArgs.GetBoolArg("-rpcwait", false);
825  const int timeout = gArgs.GetIntArg("-rpcwaittimeout", DEFAULT_WAIT_CLIENT_TIMEOUT);
826  const auto deadline{GetTime<std::chrono::microseconds>() + 1s * timeout};
827 
828  do {
829  try {
830  response = CallRPC(rh, strMethod, args, rpcwallet);
831  if (fWait) {
832  const UniValue& error = find_value(response, "error");
833  if (!error.isNull() && error["code"].get_int() == RPC_IN_WARMUP) {
834  throw CConnectionFailed("server in warmup");
835  }
836  }
837  break; // Connection succeeded, no need to retry.
838  } catch (const CConnectionFailed& e) {
839  const auto now{GetTime<std::chrono::microseconds>()};
840  if (fWait && (timeout <= 0 || now < deadline)) {
842  } else {
843  throw CConnectionFailed(strprintf("timeout on transient error: %s", e.what()));
844  }
845  }
846  } while (fWait);
847  return response;
848 }
849 
851 static void ParseResult(const UniValue& result, std::string& strPrint)
852 {
853  if (result.isNull()) return;
854  strPrint = result.isStr() ? result.get_str() : result.write(2);
855 }
856 
858 static void ParseError(const UniValue& error, std::string& strPrint, int& nRet)
859 {
860  if (error.isObject()) {
861  const UniValue& err_code = find_value(error, "code");
862  const UniValue& err_msg = find_value(error, "message");
863  if (!err_code.isNull()) {
864  strPrint = "error code: " + err_code.getValStr() + "\n";
865  }
866  if (err_msg.isStr()) {
867  strPrint += ("error message:\n" + err_msg.get_str());
868  }
869  if (err_code.isNum() && err_code.get_int() == RPC_WALLET_NOT_SPECIFIED) {
870  strPrint += "\nTry adding \"-rpcwallet=<filename>\" option to bitcoin-cli command line.";
871  }
872  } else {
873  strPrint = "error: " + error.write();
874  }
875  nRet = abs(error["code"].get_int());
876 }
877 
884 static void GetWalletBalances(UniValue& result)
885 {
887  const UniValue listwallets = ConnectAndCallRPC(&rh, "listwallets", /* args=*/{});
888  if (!find_value(listwallets, "error").isNull()) return;
889  const UniValue& wallets = find_value(listwallets, "result");
890  if (wallets.size() <= 1) return;
891 
892  UniValue balances(UniValue::VOBJ);
893  for (const UniValue& wallet : wallets.getValues()) {
894  const std::string wallet_name = wallet.get_str();
895  const UniValue getbalances = ConnectAndCallRPC(&rh, "getbalances", /* args=*/{}, wallet_name);
896  const UniValue& balance = find_value(getbalances, "result")["mine"]["trusted"];
897  balances.pushKV(wallet_name, balance);
898  }
899  result.pushKV("balances", balances);
900 }
901 
908 static void GetProgressBar(double progress, std::string& progress_bar)
909 {
910  if (progress < 0 || progress > 1) return;
911 
912  static constexpr double INCREMENT{0.05};
913  static const std::string COMPLETE_BAR{"\u2592"};
914  static const std::string INCOMPLETE_BAR{"\u2591"};
915 
916  for (int i = 0; i < progress / INCREMENT; ++i) {
917  progress_bar += COMPLETE_BAR;
918  }
919 
920  for (int i = 0; i < (1 - progress) / INCREMENT; ++i) {
921  progress_bar += INCOMPLETE_BAR;
922  }
923 }
924 
930 static void ParseGetInfoResult(UniValue& result)
931 {
932  if (!find_value(result, "error").isNull()) return;
933 
934  std::string RESET, GREEN, BLUE, YELLOW, MAGENTA, CYAN;
935  bool should_colorize = false;
936 
937 #ifndef WIN32
938  if (isatty(fileno(stdout))) {
939  // By default, only print colored text if OS is not WIN32 and stdout is connected to a terminal.
940  should_colorize = true;
941  }
942 #endif
943 
944  if (gArgs.IsArgSet("-color")) {
945  const std::string color{gArgs.GetArg("-color", DEFAULT_COLOR_SETTING)};
946  if (color == "always") {
947  should_colorize = true;
948  } else if (color == "never") {
949  should_colorize = false;
950  } else if (color != "auto") {
951  throw std::runtime_error("Invalid value for -color option. Valid values: always, auto, never.");
952  }
953  }
954 
955  if (should_colorize) {
956  RESET = "\x1B[0m";
957  GREEN = "\x1B[32m";
958  BLUE = "\x1B[34m";
959  YELLOW = "\x1B[33m";
960  MAGENTA = "\x1B[35m";
961  CYAN = "\x1B[36m";
962  }
963 
964  std::string result_string = strprintf("%sChain: %s%s\n", BLUE, result["chain"].getValStr(), RESET);
965  result_string += strprintf("Blocks: %s\n", result["blocks"].getValStr());
966  result_string += strprintf("Headers: %s\n", result["headers"].getValStr());
967 
968  const double ibd_progress{result["verificationprogress"].get_real()};
969  std::string ibd_progress_bar;
970  // Display the progress bar only if IBD progress is less than 99%
971  if (ibd_progress < 0.99) {
972  GetProgressBar(ibd_progress, ibd_progress_bar);
973  // Add padding between progress bar and IBD progress
974  ibd_progress_bar += " ";
975  }
976 
977  result_string += strprintf("Verification progress: %s%.4f%%\n", ibd_progress_bar, ibd_progress * 100);
978  result_string += strprintf("Difficulty: %s\n\n", result["difficulty"].getValStr());
979 
980  result_string += strprintf(
981  "%sNetwork: in %s, out %s, total %s%s\n",
982  GREEN,
983  result["connections"]["in"].getValStr(),
984  result["connections"]["out"].getValStr(),
985  result["connections"]["total"].getValStr(),
986  RESET);
987  result_string += strprintf("Version: %s\n", result["version"].getValStr());
988  result_string += strprintf("Time offset (s): %s\n", result["timeoffset"].getValStr());
989 
990  // proxies
991  std::map<std::string, std::vector<std::string>> proxy_networks;
992  std::vector<std::string> ordered_proxies;
993 
994  for (const UniValue& network : result["networks"].getValues()) {
995  const std::string proxy = network["proxy"].getValStr();
996  if (proxy.empty()) continue;
997  // Add proxy to ordered_proxy if has not been processed
998  if (proxy_networks.find(proxy) == proxy_networks.end()) ordered_proxies.push_back(proxy);
999 
1000  proxy_networks[proxy].push_back(network["name"].getValStr());
1001  }
1002 
1003  std::vector<std::string> formatted_proxies;
1004  for (const std::string& proxy : ordered_proxies) {
1005  formatted_proxies.emplace_back(strprintf("%s (%s)", proxy, Join(proxy_networks.find(proxy)->second, ", ")));
1006  }
1007  result_string += strprintf("Proxies: %s\n", formatted_proxies.empty() ? "n/a" : Join(formatted_proxies, ", "));
1008 
1009  result_string += strprintf("Min tx relay fee rate (%s/kvB): %s\n\n", CURRENCY_UNIT, result["relayfee"].getValStr());
1010 
1011  if (!result["has_wallet"].isNull()) {
1012  const std::string walletname = result["walletname"].getValStr();
1013  result_string += strprintf("%sWallet: %s%s\n", MAGENTA, walletname.empty() ? "\"\"" : walletname, RESET);
1014 
1015  result_string += strprintf("Keypool size: %s\n", result["keypoolsize"].getValStr());
1016  if (!result["unlocked_until"].isNull()) {
1017  result_string += strprintf("Unlocked until: %s\n", result["unlocked_until"].getValStr());
1018  }
1019  result_string += strprintf("Transaction fee rate (-paytxfee) (%s/kvB): %s\n\n", CURRENCY_UNIT, result["paytxfee"].getValStr());
1020  }
1021  if (!result["balance"].isNull()) {
1022  result_string += strprintf("%sBalance:%s %s\n\n", CYAN, RESET, result["balance"].getValStr());
1023  }
1024 
1025  if (!result["balances"].isNull()) {
1026  result_string += strprintf("%sBalances%s\n", CYAN, RESET);
1027 
1028  size_t max_balance_length{10};
1029 
1030  for (const std::string& wallet : result["balances"].getKeys()) {
1031  max_balance_length = std::max(result["balances"][wallet].getValStr().length(), max_balance_length);
1032  }
1033 
1034  for (const std::string& wallet : result["balances"].getKeys()) {
1035  result_string += strprintf("%*s %s\n",
1036  max_balance_length,
1037  result["balances"][wallet].getValStr(),
1038  wallet.empty() ? "\"\"" : wallet);
1039  }
1040  result_string += "\n";
1041  }
1042 
1043  result_string += strprintf("%sWarnings:%s %s", YELLOW, RESET, result["warnings"].getValStr());
1044  result.setStr(result_string);
1045 }
1046 
1052 {
1053  std::optional<std::string> wallet_name{};
1054  if (gArgs.IsArgSet("-rpcwallet")) wallet_name = gArgs.GetArg("-rpcwallet", "");
1056  return ConnectAndCallRPC(&rh, "getnewaddress", /* args=*/{}, wallet_name);
1057 }
1058 
1064 static void SetGenerateToAddressArgs(const std::string& address, std::vector<std::string>& args)
1065 {
1066  if (args.size() > 2) throw std::runtime_error("too many arguments (maximum 2 for nblocks and maxtries)");
1067  if (args.size() == 0) {
1068  args.emplace_back(DEFAULT_NBLOCKS);
1069  } else if (args.at(0) == "0") {
1070  throw std::runtime_error("the first argument (number of blocks to generate, default: " + DEFAULT_NBLOCKS + ") must be an integer value greater than zero");
1071  }
1072  args.emplace(args.begin() + 1, address);
1073 }
1074 
1075 static int CommandLineRPC(int argc, char *argv[])
1076 {
1077  std::string strPrint;
1078  int nRet = 0;
1079  try {
1080  // Skip switches
1081  while (argc > 1 && IsSwitchChar(argv[1][0])) {
1082  argc--;
1083  argv++;
1084  }
1085  std::string rpcPass;
1086  if (gArgs.GetBoolArg("-stdinrpcpass", false)) {
1087  NO_STDIN_ECHO();
1088  if (!StdinReady()) {
1089  fputs("RPC password> ", stderr);
1090  fflush(stderr);
1091  }
1092  if (!std::getline(std::cin, rpcPass)) {
1093  throw std::runtime_error("-stdinrpcpass specified but failed to read from standard input");
1094  }
1095  if (StdinTerminal()) {
1096  fputc('\n', stdout);
1097  }
1098  gArgs.ForceSetArg("-rpcpassword", rpcPass);
1099  }
1100  std::vector<std::string> args = std::vector<std::string>(&argv[1], &argv[argc]);
1101  if (gArgs.GetBoolArg("-stdinwalletpassphrase", false)) {
1102  NO_STDIN_ECHO();
1103  std::string walletPass;
1104  if (args.size() < 1 || args[0].substr(0, 16) != "walletpassphrase") {
1105  throw std::runtime_error("-stdinwalletpassphrase is only applicable for walletpassphrase(change)");
1106  }
1107  if (!StdinReady()) {
1108  fputs("Wallet passphrase> ", stderr);
1109  fflush(stderr);
1110  }
1111  if (!std::getline(std::cin, walletPass)) {
1112  throw std::runtime_error("-stdinwalletpassphrase specified but failed to read from standard input");
1113  }
1114  if (StdinTerminal()) {
1115  fputc('\n', stdout);
1116  }
1117  args.insert(args.begin() + 1, walletPass);
1118  }
1119  if (gArgs.GetBoolArg("-stdin", false)) {
1120  // Read one arg per line from stdin and append
1121  std::string line;
1122  while (std::getline(std::cin, line)) {
1123  args.push_back(line);
1124  }
1125  if (StdinTerminal()) {
1126  fputc('\n', stdout);
1127  }
1128  }
1129  std::unique_ptr<BaseRequestHandler> rh;
1130  std::string method;
1131  if (gArgs.IsArgSet("-getinfo")) {
1132  rh.reset(new GetinfoRequestHandler());
1133  } else if (gArgs.GetBoolArg("-netinfo", false)) {
1134  if (!args.empty() && args.at(0) == "help") {
1135  tfm::format(std::cout, "%s\n", NetinfoRequestHandler().m_help_doc);
1136  return 0;
1137  }
1138  rh.reset(new NetinfoRequestHandler());
1139  } else if (gArgs.GetBoolArg("-generate", false)) {
1141  const UniValue& error{find_value(getnewaddress, "error")};
1142  if (error.isNull()) {
1143  SetGenerateToAddressArgs(find_value(getnewaddress, "result").get_str(), args);
1144  rh.reset(new GenerateToAddressRequestHandler());
1145  } else {
1146  ParseError(error, strPrint, nRet);
1147  }
1148  } else if (gArgs.GetBoolArg("-addrinfo", false)) {
1149  rh.reset(new AddrinfoRequestHandler());
1150  } else {
1151  rh.reset(new DefaultRequestHandler());
1152  if (args.size() < 1) {
1153  throw std::runtime_error("too few parameters (need at least command)");
1154  }
1155  method = args[0];
1156  args.erase(args.begin()); // Remove trailing method name from arguments vector
1157  }
1158  if (nRet == 0) {
1159  // Perform RPC call
1160  std::optional<std::string> wallet_name{};
1161  if (gArgs.IsArgSet("-rpcwallet")) wallet_name = gArgs.GetArg("-rpcwallet", "");
1162  const UniValue reply = ConnectAndCallRPC(rh.get(), method, args, wallet_name);
1163 
1164  // Parse reply
1165  UniValue result = find_value(reply, "result");
1166  const UniValue& error = find_value(reply, "error");
1167  if (error.isNull()) {
1168  if (gArgs.GetBoolArg("-getinfo", false)) {
1169  if (!gArgs.IsArgSet("-rpcwallet")) {
1170  GetWalletBalances(result); // fetch multiwallet balances and append to result
1171  }
1172  ParseGetInfoResult(result);
1173  }
1174 
1175  ParseResult(result, strPrint);
1176  } else {
1177  ParseError(error, strPrint, nRet);
1178  }
1179  }
1180  } catch (const std::exception& e) {
1181  strPrint = std::string("error: ") + e.what();
1182  nRet = EXIT_FAILURE;
1183  } catch (...) {
1184  PrintExceptionContinue(nullptr, "CommandLineRPC()");
1185  throw;
1186  }
1187 
1188  if (strPrint != "") {
1189  tfm::format(nRet == 0 ? std::cout : std::cerr, "%s\n", strPrint);
1190  }
1191  return nRet;
1192 }
1193 
1194 #ifdef WIN32
1195 // Export main() and ensure working ASLR on Windows.
1196 // Exporting a symbol will prevent the linker from stripping
1197 // the .reloc section from the binary, which is a requirement
1198 // for ASLR. This is a temporary workaround until a fixed
1199 // version of binutils is used for releases.
1200 __declspec(dllexport) int main(int argc, char* argv[])
1201 {
1202  util::WinCmdLineArgs winArgs;
1203  std::tie(argc, argv) = winArgs.get();
1204 #else
1205 int main(int argc, char* argv[])
1206 {
1207 #endif
1208  SetupEnvironment();
1209  if (!SetupNetworking()) {
1210  tfm::format(std::cerr, "Error: Initializing networking failed\n");
1211  return EXIT_FAILURE;
1212  }
1213  event_set_log_callback(&libevent_log_cb);
1214 
1215  try {
1216  int ret = AppInitRPC(argc, argv);
1217  if (ret != CONTINUE_EXECUTION)
1218  return ret;
1219  }
1220  catch (const std::exception& e) {
1221  PrintExceptionContinue(&e, "AppInitRPC()");
1222  return EXIT_FAILURE;
1223  } catch (...) {
1224  PrintExceptionContinue(nullptr, "AppInitRPC()");
1225  return EXIT_FAILURE;
1226  }
1227 
1228  int ret = EXIT_FAILURE;
1229  try {
1230  ret = CommandLineRPC(argc, argv);
1231  }
1232  catch (const std::exception& e) {
1233  PrintExceptionContinue(&e, "CommandLineRPC()");
1234  } catch (...) {
1235  PrintExceptionContinue(nullptr, "CommandLineRPC()");
1236  }
1237  return ret;
1238 }
DefaultRequestHandler
Process default single requests.
Definition: bitcoin-cli.cpp:677
GenerateToAddressRequestHandler::PrepareRequest
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Definition: bitcoin-cli.cpp:658
urlDecode
UrlDecodeFn urlDecode
Definition: url.h:11
NetinfoRequestHandler::ConnectionTypeForNetinfo
std::string ConnectionTypeForNetinfo(const std::string &conn_type) const
Definition: bitcoin-cli.cpp:425
NetinfoRequestHandler::Peer::addr_processed
int64_t addr_processed
Definition: bitcoin-cli.cpp:395
NetinfoRequestHandler::m_peers
std::vector< Peer > m_peers
Definition: bitcoin-cli.cpp:411
NetinfoRequestHandler::Peer
Definition: bitcoin-cli.cpp:387
HTTPReply
Reply structure for request_done to fill in.
Definition: bitcoin-cli.cpp:166
feerate.h
NetinfoRequestHandler::m_is_asmap_on
bool m_is_asmap_on
Definition: bitcoin-cli.cpp:381
NetinfoRequestHandler
Process netinfo requests.
Definition: bitcoin-cli.cpp:362
ArgsManager::GetBoolArg
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: system.cpp:598
NetinfoRequestHandler::m_max_id_length
size_t m_max_id_length
Definition: bitcoin-cli.cpp:386
HTTP_SERVICE_UNAVAILABLE
@ HTTP_SERVICE_UNAVAILABLE
Definition: protocol.h:19
ToString
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:87
DEFAULT_NBLOCKS
static const std::string DEFAULT_NBLOCKS
Default number of blocks to generate for RPC generatetoaddress.
Definition: bitcoin-cli.cpp:54
UniValue::VOBJ
@ VOBJ
Definition: univalue.h:21
assert
assert(!tx.IsCoinBase())
tinyformat::format
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:1062
NetinfoRequestHandler::IsVersionSelected
bool IsVersionSelected() const
Definition: bitcoin-cli.cpp:380
NetinfoRequestHandler::Peer::mapped_as
int mapped_as
Definition: bitcoin-cli.cpp:402
NetinfoRequestHandler::m_networks
static constexpr std::array m_networks
Definition: bitcoin-cli.cpp:366
NetinfoRequestHandler::m_max_addr_processed_length
size_t m_max_addr_processed_length
Definition: bitcoin-cli.cpp:383
NetinfoRequestHandler::m_time_now
const int64_t m_time_now
Definition: bitcoin-cli.cpp:433
DEFAULT_COLOR_SETTING
static const std::string DEFAULT_COLOR_SETTING
Default -color setting.
Definition: bitcoin-cli.cpp:57
GenerateToAddressRequestHandler::address_str
std::string address_str
Definition: bitcoin-cli.cpp:673
NetinfoRequestHandler::m_details_level
uint8_t m_details_level
Optional user-supplied arg to set dashboard details level.
Definition: bitcoin-cli.cpp:377
ArgsManager::GetHelpMessage
std::string GetHelpMessage() const
Get the help string.
Definition: system.cpp:666
NullUniValue
const UniValue NullUniValue
Definition: univalue.cpp:13
NetinfoRequestHandler::Peer::addr
std::string addr
Definition: bitcoin-cli.cpp:388
libevent_log_cb
static void libevent_log_cb(int severity, const char *msg)
libevent event log callback
Definition: bitcoin-cli.cpp:94
NetinfoRequestHandler::Peer::is_addr_relay_enabled
bool is_addr_relay_enabled
Definition: bitcoin-cli.cpp:404
GetinfoRequestHandler
Process getinfo requests.
Definition: bitcoin-cli.cpp:293
AppInitRPC
static int AppInitRPC(int argc, char *argv[])
Definition: bitcoin-cli.cpp:120
NetinfoRequestHandler::ID_PEERINFO
static constexpr int ID_PEERINFO
Definition: bitcoin-cli.cpp:436
NetinfoRequestHandler::MAX_DETAIL_LEVEL
static constexpr uint8_t MAX_DETAIL_LEVEL
Definition: bitcoin-cli.cpp:365
chainparamsbase.h
HTTP_BAD_REQUEST
@ HTTP_BAD_REQUEST
Definition: protocol.h:13
ArgsManager::ALLOW_ANY
@ ALLOW_ANY
Definition: system.h:166
SetupChainParamsBaseOptions
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
Definition: chainparamsbase.cpp:18
ArgsManager::GetChainName
std::string GetChainName() const
Returns the appropriate chain name from the program arguments.
Definition: system.cpp:986
NetinfoRequestHandler::NetworkStringToId
int8_t NetworkStringToId(const std::string &str) const
Definition: bitcoin-cli.cpp:370
ArgsManager::IsArgSet
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: system.cpp:490
getnewaddress
std::string getnewaddress(CWallet &w)
Returns a new address from the wallet.
HTTPReply::body
std::string body
Definition: bitcoin-cli.cpp:172
AddrinfoRequestHandler::PrepareRequest
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Definition: bitcoin-cli.cpp:255
CBaseChainParams::TESTNET
static const std::string TESTNET
Definition: chainparamsbase.h:23
SetupEnvironment
void SetupEnvironment()
Definition: system.cpp:1293
SelectBaseParams
void SelectBaseParams(const std::string &chain)
Sets the params returned by Params() to those for the given network.
Definition: chainparamsbase.cpp:57
DEFAULT_MAX_TRIES
static const uint64_t DEFAULT_MAX_TRIES
Default max iterations to try in RPC generatetodescriptor, generatetoaddress, and generateblock.
Definition: mining.h:9
NetinfoRequestHandler::Peer::id
int id
Definition: bitcoin-cli.cpp:401
protocol.h
GenerateToAddressRequestHandler::ProcessReply
UniValue ProcessReply(const UniValue &reply) override
Definition: bitcoin-cli.cpp:665
GetAuthCookie
bool GetAuthCookie(std::string *cookie_out)
Read the RPC authentication cookie from disk.
Definition: request.cpp:108
clientversion.h
NetinfoRequestHandler::m_max_addr_rate_limited_length
size_t m_max_addr_rate_limited_length
Definition: bitcoin-cli.cpp:384
wallet
Definition: interfaces.cpp:50
UniValue::isNull
bool isNull() const
Definition: univalue.h:77
DEFAULT_HTTP_CLIENT_TIMEOUT
static const int DEFAULT_HTTP_CLIENT_TIMEOUT
Definition: bitcoin-cli.cpp:47
HelpRequested
bool HelpRequested(const ArgsManager &args)
Definition: system.cpp:735
JSONRPCReplyObj
UniValue JSONRPCReplyObj(const UniValue &result, const UniValue &error, const UniValue &id)
Definition: request.cpp:33
fs::PathToString
static std::string PathToString(const path &path)
Convert path object to byte string.
Definition: fs.h:120
RPCConvertValues
UniValue RPCConvertValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert positional arguments to command-specific RPC representation.
Definition: client.cpp:240
NetinfoRequestHandler::Peer::addr_rate_limited
int64_t addr_rate_limited
Definition: bitcoin-cli.cpp:396
EncodeBase64
std::string EncodeBase64(Span< const unsigned char > input)
Definition: strencodings.cpp:130
bitcoin-config.h
UniValue::write
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
Definition: univalue_write.cpp:29
UniValue::isNum
bool isNum() const
Definition: univalue.h:82
SetupHelpOptions
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: system.cpp:740
CConnectionFailed::CConnectionFailed
CConnectionFailed(const std::string &msg)
Definition: bitcoin-cli.cpp:110
NetinfoRequestHandler::m_max_addr_length
size_t m_max_addr_length
Definition: bitcoin-cli.cpp:382
NetinfoRequestHandler::Peer::age
std::string age
Definition: bitcoin-cli.cpp:392
UniValue::pushKV
bool pushKV(const std::string &key, const UniValue &val)
Definition: univalue.cpp:133
BITCOIN_CONF_FILENAME
const char *const BITCOIN_CONF_FILENAME
Definition: system.cpp:81
NetinfoRequestHandler::Peer::is_block_relay
bool is_block_relay
Definition: bitcoin-cli.cpp:407
http_errorstring
static std::string http_errorstring(int code)
Definition: bitcoin-cli.cpp:175
balance
static CAmount balance
Definition: coinselector_tests.cpp:35
UniValue
Definition: univalue.h:19
ArgsManager::ALLOW_INT
@ ALLOW_INT
Definition: system.h:164
tinyformat.h
NetinfoRequestHandler::Peer::is_bip152_hb_to
bool is_bip152_hb_to
Definition: bitcoin-cli.cpp:406
UNKNOWN_NETWORK
static constexpr int8_t UNKNOWN_NETWORK
Definition: bitcoin-cli.cpp:51
UniValue::get_str
const std::string & get_str() const
Definition: univalue_get.cpp:97
NetinfoRequestHandler::IsAddressSelected
bool IsAddressSelected() const
Definition: bitcoin-cli.cpp:379
strencodings.h
UniValue::isStr
bool isStr() const
Definition: univalue.h:81
DefaultRequestHandler::PrepareRequest
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Definition: bitcoin-cli.cpp:679
DEFAULT_RPCCONNECT
static const char DEFAULT_RPCCONNECT[]
Definition: bitcoin-cli.cpp:46
events.h
NetinfoRequestHandler::ProcessReply
UniValue ProcessReply(const UniValue &batch_in) override
Definition: bitcoin-cli.cpp:455
AddrinfoRequestHandler
Process addrinfo requests.
Definition: bitcoin-cli.cpp:242
CURRENCY_UNIT
const std::string CURRENCY_UNIT
Definition: feerate.h:14
SplitHostPort
void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut)
Definition: strencodings.cpp:109
UniValue::get_obj
const UniValue & get_obj() const
Definition: univalue_get.cpp:134
NetinfoRequestHandler::Peer::ping
double ping
Definition: bitcoin-cli.cpp:394
CallRPC
static UniValue CallRPC(BaseRequestHandler *rh, const std::string &strMethod, const std::vector< std::string > &args, const std::optional< std::string > &rpcwallet={})
Definition: bitcoin-cli.cpp:696
ParseError
static void ParseError(const UniValue &error, std::string &strPrint, int &nRet)
Parse UniValue error to update the message to print to std::cerr and the code to return.
Definition: bitcoin-cli.cpp:858
ArgsManager::ALLOW_STRING
@ ALLOW_STRING
Definition: system.h:165
NetinfoRequestHandler::m_manual_peers_count
uint8_t m_manual_peers_count
Definition: bitcoin-cli.cpp:369
PACKAGE_NAME
#define PACKAGE_NAME
Definition: bitcoin-config.h:359
ParseGetInfoResult
static void ParseGetInfoResult(UniValue &result)
ParseGetInfoResult takes in -getinfo result in UniValue object and parses it into a user friendly Uni...
Definition: bitcoin-cli.cpp:930
NetinfoRequestHandler::PingTimeToString
std::string PingTimeToString(double seconds) const
Definition: bitcoin-cli.cpp:419
NetinfoRequestHandler::PrepareRequest
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Definition: bitcoin-cli.cpp:439
ArgsManager::AddArg
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: system.cpp:638
NetinfoRequestHandler::m_help_doc
const std::string m_help_doc
Definition: bitcoin-cli.cpp:588
NetinfoRequestHandler::Peer::is_bip152_hb_from
bool is_bip152_hb_from
Definition: bitcoin-cli.cpp:405
univalue.h
CBaseChainParams::REGTEST
static const std::string REGTEST
Definition: chainparamsbase.h:25
RPCConvertNamedValues
UniValue RPCConvertNamedValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert named arguments to command-specific RPC representation.
Definition: client.cpp:259
IsSwitchChar
bool IsSwitchChar(char c)
Definition: system.h:124
GetProgressBar
static void GetProgressBar(double progress, std::string &progress_bar)
GetProgressBar constructs a progress bar with 5% intervals.
Definition: bitcoin-cli.cpp:908
JSONRPCRequestObj
UniValue JSONRPCRequestObj(const std::string &strMethod, const UniValue &params, const UniValue &id)
JSON-RPC protocol.
Definition: request.cpp:24
ArgsManager::ForceSetArg
void ForceSetArg(const std::string &strArg, const std::string &strValue)
Definition: system.cpp:620
obtain_evhttp_request
raii_evhttp_request obtain_evhttp_request(void(*cb)(struct evhttp_request *, void *), void *arg)
Definition: events.h:45
obtain_evhttp_connection_base
raii_evhttp_connection obtain_evhttp_connection_base(struct event_base *base, std::string host, uint16_t port)
Definition: events.h:49
AddrinfoRequestHandler::m_networks
static constexpr std::array m_networks
Definition: bitcoin-cli.cpp:245
ArgsManager::GetArg
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: system.cpp:586
OptionsCategory::OPTIONS
@ OPTIONS
CreateBaseChainParams
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const std::string &chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 18445) have been chosen arbitrarily to...
Definition: chainparamsbase.cpp:43
NetinfoRequestHandler::m_block_relay_peers_count
uint8_t m_block_relay_peers_count
Definition: bitcoin-cli.cpp:368
RPC_IN_WARMUP
@ RPC_IN_WARMUP
Client still warming up.
Definition: protocol.h:49
HTTP_UNAUTHORIZED
@ HTTP_UNAUTHORIZED
Definition: protocol.h:14
NetinfoRequestHandler::Peer::last_blck
int64_t last_blck
Definition: bitcoin-cli.cpp:397
main
int main(int argc, char *argv[])
Definition: bitcoin-cli.cpp:1205
ArgsManager::ParseParameters
bool ParseParameters(int argc, const char *const argv[], std::string &error)
Definition: system.cpp:302
DEFAULT_WAIT_CLIENT_TIMEOUT
static constexpr int DEFAULT_WAIT_CLIENT_TIMEOUT
Definition: bitcoin-cli.cpp:48
BaseRequestHandler::~BaseRequestHandler
virtual ~BaseRequestHandler()
Definition: bitcoin-cli.cpp:236
BaseRequestHandler::ProcessReply
virtual UniValue ProcessReply(const UniValue &batch_in)=0
CBaseChainParams::RPCPort
uint16_t RPCPort() const
Definition: chainparamsbase.h:29
HTTPReply::HTTPReply
HTTPReply()
Definition: bitcoin-cli.cpp:168
NO_STDIN_ECHO
#define NO_STDIN_ECHO()
Definition: stdin.h:13
GetinfoRequestHandler::ProcessReply
UniValue ProcessReply(const UniValue &batch_in) override
Collect values from the batch and form a simulated getinfo reply.
Definition: bitcoin-cli.cpp:316
ArgsManager::ReadConfigFiles
bool ReadConfigFiles(std::string &error, bool ignore_invalid_keys=false)
Definition: system.cpp:894
request.h
SetupCliArgs
static void SetupCliArgs(ArgsManager &argsman)
Definition: bitcoin-cli.cpp:59
CONTINUE_EXECUTION
static const int CONTINUE_EXECUTION
Definition: bitcoin-cli.cpp:50
GetWalletBalances
static void GetWalletBalances(UniValue &result)
GetWalletBalances calls listwallets; if more than one wallet is loaded, it then fetches mine....
Definition: bitcoin-cli.cpp:884
gArgs
ArgsManager gArgs
Definition: system.cpp:84
CBaseChainParams::MAIN
static const std::string MAIN
Chain name strings.
Definition: chainparamsbase.h:22
ping
static RPCHelpMan ping()
Definition: net.cpp:82
stdin.h
NetinfoRequestHandler::Peer::conn_type
std::string conn_type
Definition: bitcoin-cli.cpp:390
RPC_WALLET_NOT_SPECIFIED
@ RPC_WALLET_NOT_SPECIFIED
No wallet specified (error when there are multiple wallets loaded)
Definition: protocol.h:81
UninterruptibleSleep
void UninterruptibleSleep(const std::chrono::microseconds &n)
Definition: time.cpp:22
CheckDataDirOption
bool CheckDataDirOption()
Definition: system.cpp:809
system.h
mining.h
strprintf
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1164
listwallets
static RPCHelpMan listwallets()
Definition: rpcwallet.cpp:2596
NetinfoRequestHandler::Peer::network
std::string network
Definition: bitcoin-cli.cpp:391
UniValue::getValStr
const std::string & getValStr() const
Definition: univalue.h:65
Join
auto Join(const std::vector< T > &list, const BaseType &separator, UnaryOp unary_op) -> decltype(unary_op(list.at(0)))
Join a list of items.
Definition: string.h:44
GetinfoRequestHandler::PrepareRequest
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Create a simulated getinfo request.
Definition: bitcoin-cli.cpp:302
GetinfoRequestHandler::ID_WALLETINFO
const int ID_WALLETINFO
Definition: bitcoin-cli.cpp:298
JSONRPCProcessBatchReply
std::vector< UniValue > JSONRPCProcessBatchReply(const UniValue &in)
Parse JSON-RPC batch reply into a vector.
Definition: request.cpp:133
NetinfoRequestHandler::ID_NETWORKINFO
static constexpr int ID_NETWORKINFO
Definition: bitcoin-cli.cpp:437
obtain_event_base
raii_event_base obtain_event_base()
Definition: events.h:30
getbalances
static RPCHelpMan getbalances()
Definition: rpcwallet.cpp:2397
UniValue::get_int
int get_int() const
Definition: univalue_get.cpp:104
GetConfigFile
fs::path GetConfigFile(const std::string &confPath)
Definition: system.cpp:815
ArgsManager
Definition: system.h:158
translation.h
url.h
BaseParams
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
Definition: chainparamsbase.cpp:33
ParseResult
static void ParseResult(const UniValue &result, std::string &strPrint)
Parse UniValue result to update the message to print to std::cout.
Definition: bitcoin-cli.cpp:851
strRPCUserColonPass
static std::string strRPCUserColonPass
Definition: httprpc.cpp:69
NetinfoRequestHandler::Peer::last_recv
int64_t last_recv
Definition: bitcoin-cli.cpp:398
NetinfoRequestHandler::Peer::last_send
int64_t last_send
Definition: bitcoin-cli.cpp:399
HTTP_NOT_FOUND
@ HTTP_NOT_FOUND
Definition: protocol.h:16
DEFAULT_NAMED
static const bool DEFAULT_NAMED
Definition: bitcoin-cli.cpp:49
BaseRequestHandler
Class that handles the conversion from a command-line to a JSON-RPC request, as well as converting ba...
Definition: bitcoin-cli.cpp:233
UniValue::push_back
bool push_back(const UniValue &val)
Definition: univalue.cpp:108
UrlDecodeFn
std::string(const std::string &url_encoded) UrlDecodeFn
Definition: url.h:10
HTTPReply::error
int error
Definition: bitcoin-cli.cpp:171
ConnectAndCallRPC
static UniValue ConnectAndCallRPC(BaseRequestHandler *rh, const std::string &strMethod, const std::vector< std::string > &args, const std::optional< std::string > &rpcwallet={})
ConnectAndCallRPC wraps CallRPC with -rpcwait and an exception handler.
Definition: bitcoin-cli.cpp:820
NetinfoRequestHandler::Peer::sub_version
std::string sub_version
Definition: bitcoin-cli.cpp:389
UniValue::empty
bool empty() const
Definition: univalue.h:66
SetupNetworking
bool SetupNetworking()
Definition: system.cpp:1330
node
Definition: interfaces.cpp:68
UniValue::getValues
const std::vector< UniValue > & getValues() const
Definition: univalue_get.cpp:83
UniValue::get_real
double get_real() const
Definition: univalue_get.cpp:124
UniValue::size
size_t size() const
Definition: univalue.h:68
GetinfoRequestHandler::ID_NETWORKINFO
const int ID_NETWORKINFO
Definition: bitcoin-cli.cpp:296
AddrinfoRequestHandler::ProcessReply
UniValue ProcessReply(const UniValue &reply) override
Definition: bitcoin-cli.cpp:264
GenerateToAddressRequestHandler
Process RPC generatetoaddress request.
Definition: bitcoin-cli.cpp:655
PrintExceptionContinue
void PrintExceptionContinue(const std::exception *pex, const char *pszThread)
Definition: system.cpp:777
G_TRANSLATION_FUN
const std::function< std::string(const char *)> G_TRANSLATION_FUN
Translate string to current locale using Qt.
Definition: bitcoin-cli.cpp:43
find_value
const UniValue & find_value(const UniValue &obj, const std::string &name)
Definition: univalue.cpp:234
NetinfoRequestHandler::Peer::operator<
bool operator<(const Peer &rhs) const
Definition: bitcoin-cli.cpp:409
URL_DECODE
UrlDecodeFn *const URL_DECODE
Definition: bitcoin-cli.cpp:44
FormatFullVersion
std::string FormatFullVersion()
Definition: clientversion.cpp:50
NetinfoRequestHandler::Peer::is_outbound
bool is_outbound
Definition: bitcoin-cli.cpp:408
error
bool error(const char *fmt, const Args &... args)
Definition: system.h:49
UniValue::VARR
@ VARR
Definition: univalue.h:21
GetNewAddress
static UniValue GetNewAddress()
Call RPC getnewaddress.
Definition: bitcoin-cli.cpp:1051
NetinfoRequestHandler::Peer::min_ping
double min_ping
Definition: bitcoin-cli.cpp:393
NetinfoRequestHandler::Peer::last_trxn
int64_t last_trxn
Definition: bitcoin-cli.cpp:400
ArgsManager::GetIntArg
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: system.cpp:592
NetinfoRequestHandler::ChainToString
std::string ChainToString() const
Definition: bitcoin-cli.cpp:412
NetinfoRequestHandler::DetailsRequested
bool DetailsRequested() const
Definition: bitcoin-cli.cpp:378
GetinfoRequestHandler::ID_BALANCES
const int ID_BALANCES
Definition: bitcoin-cli.cpp:299
UniValue::VSTR
@ VSTR
Definition: univalue.h:21
DefaultRequestHandler::ProcessReply
UniValue ProcessReply(const UniValue &reply) override
Definition: bitcoin-cli.cpp:690
AddrinfoRequestHandler::NetworkStringToId
int8_t NetworkStringToId(const std::string &str) const
Definition: bitcoin-cli.cpp:246
http_request_done
static void http_request_done(struct evhttp_request *req, void *ctx)
Definition: bitcoin-cli.cpp:197
NetinfoRequestHandler::m_max_age_length
size_t m_max_age_length
Definition: bitcoin-cli.cpp:385
ParseUInt8
bool ParseUInt8(const std::string &str, uint8_t *out)
Convert decimal string to unsigned 8-bit integer with strict parse error feedback.
Definition: strencodings.cpp:315
NetinfoRequestHandler::Peer::version
int version
Definition: bitcoin-cli.cpp:403
UniValue::setStr
bool setStr(const std::string &val)
Definition: univalue.cpp:86
GetinfoRequestHandler::ID_BLOCKCHAININFO
const int ID_BLOCKCHAININFO
Definition: bitcoin-cli.cpp:297
CConnectionFailed
Definition: bitcoin-cli.cpp:106
client.h
StdinTerminal
bool StdinTerminal()
Definition: stdin.cpp:47
ctx
static secp256k1_context * ctx
Definition: tests.c:42
ArgsManager::NETWORK_ONLY
@ NETWORK_ONLY
Definition: system.h:173
HTTPReply::status
int status
Definition: bitcoin-cli.cpp:170
CBaseChainParams::SIGNET
static const std::string SIGNET
Definition: chainparamsbase.h:24
BaseRequestHandler::PrepareRequest
virtual UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args)=0
GetTimeSeconds
int64_t GetTimeSeconds()
Returns the system time (not mockable)
Definition: time.cpp:127
NetinfoRequestHandler::m_counts
std::array< std::array< uint16_t, m_networks.size()+1 >, 3 > m_counts
Peer counts by (in/out/total, networks/total)
Definition: bitcoin-cli.cpp:367
StdinReady
bool StdinReady()
Definition: stdin.cpp:56
HTTP_INTERNAL_SERVER_ERROR
@ HTTP_INTERNAL_SERVER_ERROR
Definition: protocol.h:18
CommandLineRPC
static int CommandLineRPC(int argc, char *argv[])
Definition: bitcoin-cli.cpp:1075
SetGenerateToAddressArgs
static void SetGenerateToAddressArgs(const std::string &address, std::vector< std::string > &args)
Check bounds and set up args for RPC generatetoaddress params: nblocks, address, maxtries.
Definition: bitcoin-cli.cpp:1064