6#include <bitcoin-build-config.h>
45#include <event2/buffer.h>
46#include <event2/keyvalq_struct.h>
67static constexpr std::array
NETWORKS{
"not_publicly_routable",
"ipv4",
"ipv6",
"onion",
"i2p",
"cjdns",
"internal"};
68static constexpr std::array
NETWORK_SHORT_NAMES{
"npr",
"ipv4",
"ipv6",
"onion",
"i2p",
"cjdns",
"int"};
90 argsman.
AddArg(
"-generate",
91 strprintf(
"Generate blocks, equivalent to RPC getnewaddress followed by RPC generatetoaddress. Optional positional integer "
92 "arguments are number of blocks to generate (default: %s) and maximum iterations to try (default: %s), equivalent to "
93 "RPC generatetoaddress nblocks and maxtries arguments. Example: bitcoin-cli -generate 4 1000",
97 argsman.
AddArg(
"-getinfo",
"Get general information from the remote server. Note that unlike server-side RPC calls, the output of -getinfo is the result of multiple non-atomic requests. Some entries in the output 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::CLI_COMMANDS);
98 argsman.
AddArg(
"-netinfo",
strprintf(
"Get network peer connection information from the remote server. An optional argument from 0 to %d can be passed for different peers listings (default: 0). If a non-zero value is passed, an additional \"outonly\" (or \"o\") argument can be passed to see outbound peers only. Pass \"help\" (or \"h\") for detailed help documentation.",
NETINFO_MAX_LEVEL),
ArgsManager::ALLOW_ANY,
OptionsCategory::CLI_COMMANDS);
107 argsman.
AddArg(
"-rpcport=<port>",
strprintf(
"Connect to JSON-RPC on <port> (default: %u, testnet: %u, testnet4: %u, signet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), testnet4BaseParams->RPCPort(), signetBaseParams->RPCPort(), regtestBaseParams->RPCPort()),
ArgsManager::ALLOW_ANY |
ArgsManager::NETWORK_ONLY,
OptionsCategory::OPTIONS);
111 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);
112 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);
113 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);
115 argsman.
AddArg(
"-ipcconnect=<address>",
"Connect to bitcoin-node through IPC socket instead of TCP socket to execute requests. Valid <address> values are 'auto' to try to connect to default socket path at <datadir>/node.sock but fall back to TCP if it is not available, 'unix' to connect to the default socket and fail if it isn't available, or 'unix:<socket path>' to connect to a socket at a nonstandard path. -noipcconnect can be specified to avoid attempting to use IPC at all. Default value: auto",
ArgsManager::ALLOW_ANY,
OptionsCategory::IPC);
129 if (severity >= EVENT_LOG_ERR) {
130 throw std::runtime_error(
strprintf(
"libevent error: %s",
msg));
153 tfm::format(std::cerr,
"Error parsing command line arguments: %s\n", error);
157 std::string strUsage = CLIENT_NAME
" RPC client version " +
FormatFullVersion() +
"\n";
163 "The bitcoin-cli utility provides a command line interface to interact with a " CLIENT_NAME
" RPC server.\n"
164 "\nIt can be used to query network information, manage wallets, create or broadcast transactions, and control the " CLIENT_NAME
" server.\n"
165 "\nUse the \"help\" command to list all commands. Use \"help <command>\" to show help for that command.\n"
166 "The -named option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.\n"
168 "Usage: bitcoin-cli [options] <command> [params]\n"
169 "or: bitcoin-cli [options] -named <command> [name=value]...\n"
170 "or: bitcoin-cli [options] help\n"
171 "or: bitcoin-cli [options] help <command>\n"
178 tfm::format(std::cerr,
"Error: too few parameters\n");
184 tfm::format(std::cerr,
"Error: Specified data directory \"%s\" does not exist.\n",
gArgs.
GetArg(
"-datadir",
""));
188 tfm::format(std::cerr,
"Error reading configuration file: %s\n", error);
194 }
catch (
const std::exception& e) {
215 case EVREQ_HTTP_TIMEOUT:
216 return "timeout reached";
218 return "EOF reached";
219 case EVREQ_HTTP_INVALID_HEADER:
220 return "error while reading header, or invalid header";
221 case EVREQ_HTTP_BUFFER_ERROR:
222 return "error encountered while reading or writing";
223 case EVREQ_HTTP_REQUEST_CANCEL:
224 return "request was canceled";
225 case EVREQ_HTTP_DATA_TOO_LONG:
226 return "response body is larger than allowed";
236 if (req ==
nullptr) {
244 reply->
status = evhttp_request_get_response_code(req);
246 struct evbuffer *buf = evhttp_request_get_input_buffer(req);
249 size_t size = evbuffer_get_length(buf);
250 const char *
data = (
const char*)evbuffer_pullup(buf, size);
252 reply->
body = std::string(
data, size);
253 evbuffer_drain(buf, size);
265 for (
size_t i = 0; i <
NETWORKS.size(); ++i) {
285 throw std::runtime_error(
"-addrinfo takes no arguments");
292 if (!reply[
"error"].isNull()) {
294 throw std::runtime_error(
"-addrinfo requires bitcoind v26.0 or later which supports getaddrmaninfo RPC. Please upgrade your node or use bitcoin-cli from the same version.");
299 const std::vector<std::string>& network_types{reply[
"result"].
getKeys()};
300 const std::vector<UniValue>& addrman_counts{reply[
"result"].
getValues()};
305 for (
size_t i = 0; i < network_types.size(); ++i) {
306 int addr_count = addrman_counts[i][
"total"].getInt<
int>();
307 if (network_types[i] ==
"all_networks") {
308 addresses.pushKV(
"total", addr_count);
310 addresses.pushKV(network_types[i], addr_count);
313 result.pushKV(
"addresses_known", std::move(addresses));
329 throw std::runtime_error(
"-getinfo takes no arguments");
362 result.
pushKV(
"connections", std::move(connections));
368 result.
pushKV(
"has_wallet",
true);
371 if (!batch[
ID_WALLETINFO][
"result"][
"unlocked_until"].isNull()) {
448 if (seconds < 0)
return "";
449 const double milliseconds{round(1000 * seconds)};
450 return milliseconds > 999999 ?
"-" :
ToString(milliseconds);
454 if (conn_type ==
"outbound-full-relay")
return "full";
455 if (conn_type ==
"block-relay-only")
return "block";
456 if (conn_type ==
"manual" || conn_type ==
"feeler")
return conn_type;
457 if (conn_type ==
"addr-fetch")
return "addr";
458 if (conn_type ==
"private-broadcast")
return "priv";
464 for (
size_t i = 0; i < services.
size(); ++i) {
465 const std::string
s{services[i].
get_str()};
466 str +=
s ==
"NETWORK_LIMITED" ?
'l' :
s ==
"P2P_V2" ?
'2' :
ToLower(
s[0]);
472 std::string str{services.
size() ? services[0].
get_str() :
""};
473 for (
size_t i{1}; i < services.
size(); ++i) {
474 str +=
", " + services[i].
get_str();
477 c = (c ==
'_' ?
' ' :
ToLower(c));
490 if (
const auto res{ToIntegral<uint8_t>(
args.at(0))}) {
494 throw std::runtime_error(
strprintf(
"invalid -netinfo level argument: %s\nFor more information, run: bitcoin-cli -netinfo help",
args.at(0)));
496 if (
args.size() > 1) {
497 if (std::string_view
s{
args.at(1)}; n && (
s ==
"o" ||
s ==
"outonly")) {
500 throw std::runtime_error(
strprintf(
"invalid -netinfo outonly argument: %s\nFor more information, run: bitcoin-cli -netinfo help",
s));
502 throw std::runtime_error(
strprintf(
"invalid -netinfo outonly argument: %s\nThe outonly argument is only valid for a level greater than 0 (the first argument). For more information, run: bitcoin-cli -netinfo help",
s));
519 if (networkinfo[
"version"].getInt<int>() < 209900) {
520 throw std::runtime_error(
"-netinfo requires bitcoind server to be running v0.21.0 and up");
522 const int64_t time_now{TicksSinceEpoch<std::chrono::seconds>(CliClock::now())};
526 const std::string network{peer[
"network"].get_str()};
529 const bool is_outbound{!peer[
"inbound"].get_bool()};
530 const bool is_tx_relay{peer[
"relaytxes"].isNull() ? true : peer[
"relaytxes"].get_bool()};
531 const std::string conn_type{peer[
"connection_type"].get_str()};
532 ++
m_counts.at(is_outbound).at(network_id);
541 const int peer_id{peer[
"id"].getInt<
int>()};
542 const int mapped_as{peer[
"mapped_as"].isNull() ? 0 : peer[
"mapped_as"].getInt<
int>()};
543 const int version{peer[
"version"].getInt<
int>()};
544 const int64_t addr_processed{peer[
"addr_processed"].isNull() ? 0 : peer[
"addr_processed"].getInt<int64_t>()};
545 const int64_t addr_rate_limited{peer[
"addr_rate_limited"].isNull() ? 0 : peer[
"addr_rate_limited"].getInt<int64_t>()};
546 const int64_t conn_time{peer[
"conntime"].getInt<int64_t>()};
547 const int64_t last_blck{peer[
"last_block"].getInt<int64_t>()};
548 const int64_t last_recv{peer[
"lastrecv"].getInt<int64_t>()};
549 const int64_t last_send{peer[
"lastsend"].getInt<int64_t>()};
550 const int64_t last_trxn{peer[
"last_transaction"].getInt<int64_t>()};
551 const double min_ping{peer[
"minping"].isNull() ? -1 : peer[
"minping"].get_real()};
552 const double ping{peer[
"pingtime"].isNull() ? -1 : peer[
"pingtime"].get_real()};
553 const std::string addr{peer[
"addr"].get_str()};
554 const std::string age{conn_time == 0 ?
"" :
ToString((time_now - conn_time) / 60)};
555 const std::string services{
FormatServices(peer[
"servicesnames"])};
556 const std::string sub_version{peer[
"subver"].get_str()};
557 const std::string transport{peer[
"transport_protocol_type"].isNull() ?
"v1" : peer[
"transport_protocol_type"].get_str()};
558 const bool is_addr_relay_enabled{peer[
"addr_relay_enabled"].isNull() ? false : peer[
"addr_relay_enabled"].get_bool()};
559 const bool is_bip152_hb_from{peer[
"bip152_hb_from"].get_bool()};
560 const bool is_bip152_hb_to{peer[
"bip152_hb_to"].get_bool()};
561 m_peers.push_back({addr, sub_version, conn_type,
NETWORK_SHORT_NAMES[network_id], age, services, transport, 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_outbound, is_tx_relay});
574 std::string result{
strprintf(
"%s client %s%s - server %i%s%s\n\n", CLIENT_NAME,
FormatFullVersion(),
ChainToString(), networkinfo[
"protocolversion"].getInt<int>(), networkinfo[
"subversion"].get_str(), services)};
579 result +=
strprintf(
"<-> type net %*s v mping ping send recv txn blk hb %*s%*s%*s ",
587 std::string version{
ToString(peer.version) + peer.sub_version};
589 "%3s %6s %5s %*s %2s%7s%7s%5s%5s%5s%5s %2s %*s%*s%*s%*i %*s %-*s%s\n",
590 peer.is_outbound ?
"out" :
"in",
595 (peer.transport_protocol_type.size() == 2 && peer.transport_protocol_type[0] ==
'v') ? peer.transport_protocol_type[1] :
' ',
598 peer.last_send ?
ToString(time_now - peer.last_send) :
"",
599 peer.last_recv ?
ToString(time_now - peer.last_recv) :
"",
600 peer.last_trxn ?
ToString((time_now - peer.last_trxn) / 60) : peer.is_tx_relay ?
"" :
"*",
601 peer.last_blck ?
ToString((time_now - peer.last_blck) / 60) :
"",
602 strprintf(
"%s%s", peer.is_bip152_hb_to ?
"." :
" ", peer.is_bip152_hb_from ?
"*" :
" "),
604 peer.addr_processed ?
ToString(peer.addr_processed) : peer.is_addr_relay_enabled ?
"" :
".",
606 peer.addr_rate_limited ?
ToString(peer.addr_rate_limited) :
"",
622 std::vector<int8_t> reachable_networks;
623 for (
const UniValue& network : networkinfo[
"networks"].getValues()) {
624 if (network[
"reachable"].get_bool()) {
625 const std::string& network_name{network[
"name"].get_str()};
628 result +=
strprintf(
"%8s", network_name);
629 reachable_networks.push_back(network_id);
634 if (
m_counts.at(2).at(network_id) == 0)
continue;
636 reachable_networks.push_back(network_id);
639 result +=
" total block";
642 const std::array rows{
"in",
"out",
"total"};
643 for (
size_t i = 0; i < rows.size(); ++i) {
645 for (int8_t n : reachable_networks) {
659 result +=
"\n\nLocal addresses";
660 const std::vector<UniValue>& local_addrs{networkinfo[
"localaddresses"].getValues()};
661 if (local_addrs.empty()) {
664 size_t max_addr_size{0};
665 for (
const UniValue& addr : local_addrs) {
666 max_addr_size = std::max(addr[
"address"].get_str().length() + 1, max_addr_size);
668 for (
const UniValue& addr : local_addrs) {
669 result +=
strprintf(
"\n%-*s port %6i score %6i", max_addr_size, addr[
"address"].get_str(), addr[
"port"].getInt<int>(), addr[
"score"].getInt<int>());
677 "-netinfo (level [outonly]) | help\n\n"
678 "Returns a network peer connections dashboard with information from the remote server.\n"
679 "This human-readable interface will change regularly and is not intended to be a stable API.\n"
680 "Under the hood, -netinfo fetches the data by calling getpeerinfo and getnetworkinfo.\n"
682 "If that argument is passed, an optional additional \"outonly\" argument may be passed to obtain the listing with outbound peers only.\n"
683 "Pass \"help\" or \"h\" to see this detailed help documentation.\n"
684 "If more than two arguments are passed, only the first two are read and parsed.\n"
685 "Suggestion: use -netinfo with the Linux watch(1) command for a live dashboard; see example below.\n\n"
687 +
strprintf(
"1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n",
NETINFO_MAX_LEVEL) +
688 " 0 - Peer counts for each reachable network as well as for block relay peers\n"
689 " and manual peers, and the list of local addresses and ports\n"
690 " 1 - Like 0 but preceded by a peers listing (without address and version columns)\n"
691 " 2 - Like 1 but with an address column\n"
692 " 3 - Like 1 but with a version column\n"
693 " 4 - Like 1 but with both address and version columns\n"
694 "2. outonly (\"outonly\" or \"o\", optional) Return the peers listing with outbound peers only, i.e. to save screen space\n"
695 " when a node has many inbound peers. Only valid if a level is passed.\n\n"
696 "help (\"help\" or \"h\", optional) Print this help documentation instead of the dashboard.\n\n"
698 +
strprintf(
"* The peers listing in levels 1-%d displays all of the peers sorted by direction and minimum ping time:\n\n",
NETINFO_MAX_LEVEL) +
699 " Column Description\n"
700 " ------ -----------\n"
702 " \"in\" - inbound connections are those initiated by the peer\n"
703 " \"out\" - outbound connections are those initiated by us\n"
704 " type Type of peer connection\n"
705 " \"full\" - full relay, the default\n"
706 " \"block\" - block relay; like full relay but does not relay transactions or addresses\n"
707 " \"manual\" - peer we manually added using RPC addnode or the -addnode/-connect config options\n"
708 " \"feeler\" - short-lived connection for testing addresses\n"
709 " \"addr\" - address fetch; short-lived connection for requesting addresses\n"
710 " \"priv\" - private broadcast; short-lived connection for broadcasting our transactions\n"
711 " net Network the peer connected through (\"ipv4\", \"ipv6\", \"onion\", \"i2p\", \"cjdns\", or \"npr\" (not publicly routable))\n"
712 " serv Services offered by the peer\n"
713 " \"n\" - NETWORK: peer can serve the full block chain\n"
714 " \"b\" - BLOOM: peer can handle bloom-filtered connections (see BIP 111)\n"
715 " \"w\" - WITNESS: peer can be asked for blocks and transactions with witness data (SegWit)\n"
716 " \"c\" - COMPACT_FILTERS: peer can handle basic block filter requests (see BIPs 157 and 158)\n"
717 " \"l\" - NETWORK_LIMITED: peer limited to serving only the last 288 blocks (~2 days)\n"
718 " \"2\" - P2P_V2: peer supports version 2 P2P transport protocol, as defined in BIP 324\n"
719 " \"u\" - UNKNOWN: unrecognized bit flag\n"
720 " v Version of transport protocol used for the connection\n"
721 " mping Minimum observed ping time, in milliseconds (ms)\n"
722 " ping Last observed ping time, in milliseconds (ms)\n"
723 " send Time since last message sent to the peer, in seconds\n"
724 " recv Time since last message received from the peer, in seconds\n"
725 " txn Time since last novel transaction received from the peer and accepted into our mempool, in minutes\n"
726 " \"*\" - we do not relay transactions to this peer (getpeerinfo \"relaytxes\" is false)\n"
727 " blk Time since last novel block passing initial validity checks received from the peer, in minutes\n"
728 " hb High-bandwidth BIP152 compact block relay\n"
729 " \".\" (to) - we selected the peer as a high-bandwidth peer\n"
730 " \"*\" (from) - the peer selected us as a high-bandwidth peer\n"
731 " addrp Total number of addresses processed, excluding those dropped due to rate limiting\n"
732 " \".\" - we do not relay addresses to this peer (getpeerinfo \"addr_relay_enabled\" is false)\n"
733 " addrl Total number of addresses dropped due to rate limiting\n"
734 " age Duration of connection to the peer, in minutes\n"
735 " asmap Mapped AS (Autonomous System) number at the end of the BGP route to the peer, used for diversifying\n"
736 " peer selection (only displayed if the -asmap config option is set)\n"
737 " id Peer index, in increasing order of peer connections since node startup\n"
738 " address IP address and port of the peer\n"
739 " version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
740 "* The peer counts table displays the number of peers for each reachable network as well as\n"
741 " the number of block relay peers and manual peers.\n\n"
742 "* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
744 "Peer counts table of reachable networks and list of local addresses\n"
745 "> bitcoin-cli -netinfo\n\n"
746 "The same, preceded by a peers listing without address and version columns\n"
747 "> bitcoin-cli -netinfo 1\n\n"
750 "Full dashboard, but with outbound peers only\n"
752 "Full live dashboard, adjust --interval or --no-title as needed (Linux)\n"
755 "> bitcoin-cli -netinfo help\n"};
799static std::optional<UniValue>
CallIPC(
BaseRequestHandler* rh,
const std::string& strMethod,
const std::vector<std::string>&
args,
const std::string& endpoint,
const std::string& username)
801 auto ipcconnect{
gArgs.
GetArg(
"-ipcconnect",
"auto")};
802 if (ipcconnect ==
"0")
return {};
804 if (ipcconnect ==
"auto")
return {};
805 throw std::runtime_error(
"-rpcconnect and -ipcconnect options cannot both be enabled");
809 if (!local_init || !local_init->ipc()) {
810 if (ipcconnect ==
"auto")
return {};
811 throw std::runtime_error(
"bitcoin-cli was not built with IPC support");
814 std::unique_ptr<interfaces::Init> node_init;
816 node_init = local_init->ipc()->connectAddress(ipcconnect);
817 if (!node_init)
return {};
818 }
catch (
const std::exception& e) {
821 "Probably bitcoin-node is not running or not listening on a unix socket. Can be started with:\n\n"
825 std::unique_ptr<interfaces::Rpc> rpc{node_init->makeRpc()};
828 UniValue reply{rpc->executeRpc(std::move(request), endpoint, username)};
841 uint16_t rpcconnect_port{0};
847 throw std::runtime_error(
strprintf(
"Invalid port provided in -rpcconnect: %s", rpcconnect_str));
849 if (rpcconnect_port != 0) {
851 port = rpcconnect_port;
855 if (std::optional<std::string> rpcport_arg =
gArgs.
GetArg(
"-rpcport")) {
857 const uint16_t rpcport_int{ToIntegral<uint16_t>(rpcport_arg.value()).value_or(0)};
858 if (rpcport_int == 0) {
862 throw std::runtime_error(
strprintf(
"Invalid port provided in -rpcport: %s", rpcport_arg.value()));
870 if (rpcconnect_port != 0) {
871 tfm::format(std::cerr,
"Warning: Port specified in both -rpcconnect and -rpcport. Using -rpcport %u\n", port);
886 evhttp_connection_set_timeout(evcon.get(), timeout);
891 constexpr int YEAR_IN_SECONDS = 31556952;
892 evhttp_connection_set_timeout(evcon.get(), 5 * YEAR_IN_SECONDS);
898 if (req ==
nullptr) {
899 throw std::runtime_error(
"create http request failed");
905 std::string rpc_credentials;
906 std::optional<AuthCookieResult> auth_cookie_result;
911 rpc_credentials = username +
":" +
gArgs.
GetArg(
"-rpcpassword",
"");
914 struct evkeyvalq* output_headers = evhttp_request_get_output_headers(req.get());
916 evhttp_add_header(output_headers,
"Host", host.c_str());
917 evhttp_add_header(output_headers,
"Connection",
"close");
918 evhttp_add_header(output_headers,
"Content-Type",
"application/json");
919 evhttp_add_header(output_headers,
"Authorization", (std::string(
"Basic ") +
EncodeBase64(rpc_credentials)).c_str());
923 struct evbuffer* output_buffer = evhttp_request_get_output_buffer(req.get());
925 evbuffer_add(output_buffer, strRequest.data(), strRequest.size());
927 int r = evhttp_make_request(evcon.get(), req.release(), EVHTTP_REQ_POST, endpoint.c_str());
932 event_base_dispatch(base.get());
934 if (response.
status == 0) {
935 std::string responseErrorMessage;
936 if (response.
error != -1) {
940 "Make sure the bitcoind server is running and that you are connecting to the correct RPC port.\n"
941 "Use \"bitcoin-cli -help\" for more info.",
942 host, port, responseErrorMessage));
944 std::string error{
"Authorization failed: "};
945 if (auth_cookie_result.has_value()) {
946 switch (*auth_cookie_result) {
948 error +=
"Failed to read cookie file and no rpcpassword was specified.";
951 error +=
"Cookie file was disabled via -norpccookiefile and no rpcpassword was specified.";
954 error +=
"Cookie file credentials were invalid and no rpcpassword was specified.";
958 error +=
"Incorrect rpcuser or rpcpassword were specified.";
961 throw std::runtime_error(error);
963 throw std::runtime_error(
strprintf(
"Server response: %s", response.
body));
965 throw std::runtime_error(
strprintf(
"server returned HTTP error %d", response.
status));
966 else if (response.
body.empty())
967 throw std::runtime_error(
"no response from server");
972 throw std::runtime_error(
"couldn't parse reply from server");
975 throw std::runtime_error(
"expected reply to have result, error and id properties");
995 const auto deadline{std::chrono::steady_clock::now() + 1
s * timeout};
998 std::string endpoint =
"/";
1000 char* encodedURI = evhttp_uriencode(rpcwallet->data(), rpcwallet->size(),
false);
1002 endpoint =
"/wallet/" + std::string(encodedURI);
1009 std::string username{
gArgs.
GetArg(
"-rpcuser",
"")};
1012 if (
auto ipc_response{
CallIPC(rh, strMethod,
args, endpoint, username)}) {
1013 response = std::move(*ipc_response);
1015 response =
CallRPC(rh, strMethod,
args, endpoint, username);
1025 if (fWait && (timeout <= 0 || std::chrono::steady_clock::now() < deadline)) {
1038 if (result.
isNull())
return;
1048 if (!err_code.
isNull()) {
1051 if (err_msg.
isStr()) {
1055 strPrint +=
" Or for the CLI, specify the \"-rpcwallet=<walletname>\" option before the command";
1056 strPrint +=
" (run \"bitcoin-cli -h\" for help or \"bitcoin-cli listwallets\" to see which wallets are currently loaded).";
1061 nRet = abs(error[
"code"].getInt<int>());
1074 if (!
listwallets.find_value(
"error").isNull())
return;
1076 if (wallets.
size() <= 1)
return;
1080 const std::string& wallet_name =
wallet.get_str();
1083 balances.
pushKV(wallet_name, balance);
1085 result.
pushKV(
"balances", std::move(balances));
1096 if (progress < 0 || progress > 1)
return;
1098 static constexpr double INCREMENT{0.05};
1099 static const std::string COMPLETE_BAR{
"\u2592"};
1100 static const std::string INCOMPLETE_BAR{
"\u2591"};
1102 for (
int i = 0; i < progress / INCREMENT; ++i) {
1103 progress_bar += COMPLETE_BAR;
1106 for (
int i = 0; i < (1 - progress) / INCREMENT; ++i) {
1107 progress_bar += INCOMPLETE_BAR;
1120 std::string RESET, GREEN, BLUE, YELLOW, MAGENTA, CYAN;
1121 bool should_colorize =
false;
1124 if (isatty(fileno(stdout))) {
1126 should_colorize =
true;
1132 if (color ==
"always") {
1133 should_colorize =
true;
1134 }
else if (color ==
"never") {
1135 should_colorize =
false;
1136 }
else if (color !=
"auto") {
1137 throw std::runtime_error(
"Invalid value for -color option. Valid values: always, auto, never.");
1141 if (should_colorize) {
1145 YELLOW =
"\x1B[33m";
1146 MAGENTA =
"\x1B[35m";
1150 std::string result_string =
strprintf(
"%sChain: %s%s\n", BLUE, result[
"chain"].getValStr(), RESET);
1151 result_string +=
strprintf(
"Blocks: %s\n", result[
"blocks"].getValStr());
1152 result_string +=
strprintf(
"Headers: %s\n", result[
"headers"].getValStr());
1154 const double ibd_progress{result[
"verificationprogress"].
get_real()};
1155 std::string ibd_progress_bar;
1157 if (ibd_progress < 0.99) {
1160 ibd_progress_bar +=
" ";
1163 result_string +=
strprintf(
"Verification progress: %s%.4f%%\n", ibd_progress_bar, ibd_progress * 100);
1164 result_string +=
strprintf(
"Difficulty: %s\n\n", result[
"difficulty"].getValStr());
1167 "%sNetwork: in %s, out %s, total %s%s\n",
1169 result[
"connections"][
"in"].getValStr(),
1170 result[
"connections"][
"out"].getValStr(),
1171 result[
"connections"][
"total"].getValStr(),
1173 result_string +=
strprintf(
"Version: %s\n", result[
"version"].getValStr());
1174 result_string +=
strprintf(
"Time offset (s): %s\n", result[
"timeoffset"].getValStr());
1177 std::map<std::string, std::vector<std::string>> proxy_networks;
1178 std::vector<std::string> ordered_proxies;
1180 for (
const UniValue& network : result[
"networks"].getValues()) {
1181 const std::string proxy = network[
"proxy"].getValStr();
1182 if (proxy.empty())
continue;
1184 if (!proxy_networks.contains(proxy)) ordered_proxies.push_back(proxy);
1186 proxy_networks[proxy].push_back(network[
"name"].getValStr());
1189 std::vector<std::string> formatted_proxies;
1190 formatted_proxies.reserve(ordered_proxies.size());
1191 for (
const std::string& proxy : ordered_proxies) {
1192 formatted_proxies.emplace_back(
strprintf(
"%s (%s)", proxy,
Join(proxy_networks.find(proxy)->second,
", ")));
1194 result_string +=
strprintf(
"Proxies: %s\n", formatted_proxies.empty() ?
"n/a" :
Join(formatted_proxies,
", "));
1196 result_string +=
strprintf(
"Min tx relay fee rate (%s/kvB): %s\n\n",
CURRENCY_UNIT, result[
"relayfee"].getValStr());
1198 if (!result[
"has_wallet"].isNull()) {
1199 const std::string walletname = result[
"walletname"].
getValStr();
1200 result_string +=
strprintf(
"%sWallet: %s%s\n", MAGENTA, walletname.empty() ?
"\"\"" : walletname, RESET);
1202 result_string +=
strprintf(
"Keypool size: %s\n", result[
"keypoolsize"].getValStr());
1203 if (!result[
"unlocked_until"].isNull()) {
1204 result_string +=
strprintf(
"Unlocked until: %s\n", result[
"unlocked_until"].getValStr());
1207 if (!result[
"balance"].isNull()) {
1208 result_string +=
strprintf(
"%sBalance:%s %s\n\n", CYAN, RESET, result[
"balance"].getValStr());
1211 if (!result[
"balances"].isNull()) {
1212 result_string +=
strprintf(
"%sBalances%s\n", CYAN, RESET);
1214 size_t max_balance_length{10};
1216 for (
const std::string&
wallet : result[
"balances"].getKeys()) {
1217 max_balance_length = std::max(result[
"balances"][
wallet].getValStr().length(), max_balance_length);
1220 for (
const std::string&
wallet : result[
"balances"].getKeys()) {
1223 result[
"balances"][
wallet].getValStr(),
1226 result_string +=
"\n";
1229 const std::string warnings{result[
"warnings"].
getValStr()};
1230 result_string +=
strprintf(
"%sWarnings:%s %s", YELLOW, RESET, warnings.empty() ?
"(none)" : warnings);
1232 result.
setStr(result_string);
1252 if (
args.size() > 2)
throw std::runtime_error(
"too many arguments (maximum 2 for nblocks and maxtries)");
1253 if (
args.size() == 0) {
1255 }
else if (
args.at(0) ==
"0") {
1256 throw std::runtime_error(
"the first argument (number of blocks to generate, default: " +
DEFAULT_NBLOCKS +
") must be an integer value greater than zero");
1258 args.emplace(
args.begin() + 1, address);
1271 std::string rpcPass;
1275 fputs(
"RPC password> ", stderr);
1278 if (!std::getline(std::cin, rpcPass)) {
1279 throw std::runtime_error(
"-stdinrpcpass specified but failed to read from standard input");
1282 fputc(
'\n', stdout);
1286 std::vector<std::string>
args = std::vector<std::string>(&argv[1], &argv[argc]);
1289 std::string walletPass;
1290 if (
args.size() < 1 || !
args[0].starts_with(
"walletpassphrase")) {
1291 throw std::runtime_error(
"-stdinwalletpassphrase is only applicable for walletpassphrase(change)");
1294 fputs(
"Wallet passphrase> ", stderr);
1297 if (!std::getline(std::cin, walletPass)) {
1298 throw std::runtime_error(
"-stdinwalletpassphrase specified but failed to read from standard input");
1301 fputc(
'\n', stdout);
1303 args.insert(
args.begin() + 1, walletPass);
1308 while (std::getline(std::cin, line)) {
1309 args.push_back(line);
1312 fputc(
'\n', stdout);
1316 std::unique_ptr<BaseRequestHandler> rh;
1321 if (!
args.empty() && (
args.at(0) ==
"h" ||
args.at(0) ==
"help")) {
1339 if (
args.size() < 1) {
1340 throw std::runtime_error(
"too few parameters (need at least command)");
1366 }
catch (
const std::exception& e) {
1367 strPrint = std::string(
"error: ") + e.what();
1368 nRet = EXIT_FAILURE;
1384 tfm::format(std::cerr,
"Error: Initializing networking failed\n");
1385 return EXIT_FAILURE;
1394 catch (
const std::exception& e) {
1396 return EXIT_FAILURE;
1399 return EXIT_FAILURE;
1406 catch (
const std::exception& e) {
bool HelpRequested(const ArgsManager &args)
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
bool CheckDataDirOption(const ArgsManager &args)
const char *const BITCOIN_CONF_FILENAME
bool IsSwitchChar(char c)
static const char DEFAULT_RPCCONNECT[]
static constexpr int8_t UNKNOWN_NETWORK
static constexpr int DEFAULT_WAIT_CLIENT_TIMEOUT
static const int CONTINUE_EXECUTION
static int AppInitRPC(int argc, char *argv[])
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.
static constexpr std::array UNREACHABLE_NETWORK_IDS
static void http_error_cb(enum evhttp_request_error err, void *ctx)
static int CommandLineRPC(int argc, char *argv[])
static constexpr uint8_t NETINFO_MAX_LEVEL
static const int DEFAULT_HTTP_CLIENT_TIMEOUT
static void ParseGetInfoResult(UniValue &result)
ParseGetInfoResult takes in -getinfo result in UniValue object and parses it into a user friendly Uni...
static std::optional< UniValue > CallIPC(BaseRequestHandler *rh, const std::string &strMethod, const std::vector< std::string > &args, const std::string &endpoint, const std::string &username)
static void http_request_done(struct evhttp_request *req, void *ctx)
static void ParseResult(const UniValue &result, std::string &strPrint)
Parse UniValue result to update the message to print to std::cout.
static const std::string DEFAULT_NBLOCKS
Default number of blocks to generate for RPC generatetoaddress.
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.
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.
static void GetWalletBalances(UniValue &result)
GetWalletBalances calls listwallets; if more than one wallet is loaded, it then fetches mine....
static constexpr std::array NETWORKS
static void SetupCliArgs(ArgsManager &argsman)
static const std::string DEFAULT_COLOR_SETTING
Default -color setting.
std::optional< std::string > RpcWalletName(const ArgsManager &args)
const TranslateFn G_TRANSLATION_FUN
Translate string to current locale using Qt.
std::chrono::system_clock CliClock
static constexpr std::array NETWORK_SHORT_NAMES
static int8_t NetworkStringToId(const std::string &str)
static std::string http_errorstring(int code)
static const bool DEFAULT_NAMED
static void GetProgressBar(double progress, std::string &progress_bar)
GetProgressBar constructs a progress bar with 5% intervals.
static UniValue CallRPC(BaseRequestHandler *rh, const std::string &strMethod, const std::vector< std::string > &args, const std::string &endpoint, const std::string &username)
event_set_log_callback & libevent_log_cb
static UniValue GetNewAddress()
Call RPC getnewaddress.
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::unique_ptr< CBaseChainParams > CreateBaseChainParams(const ChainType chain)
Port numbers for incoming Tor connections (8334, 18334, 38334, 48334, 18445) have been chosen arbitra...
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
void SelectBaseParams(const ChainType chain)
Sets the params returned by Params() to those for the given chain.
bool ParseParameters(int argc, const char *const argv[], std::string &error) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
ChainType GetChainType() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Returns the appropriate chain type from the program arguments.
void CheckMultipleCLIArgs() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Check CLI command args.
@ ALLOW_ANY
disable validation
@ DISALLOW_NEGATION
disallow -nofoo syntax
fs::path GetConfigFilePath() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return config file path (read-only)
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Add argument.
bool ReadConfigFiles(std::string &error, bool ignore_invalid_keys=false) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
void ForceSetArg(const std::string &strArg, const std::string &strValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
std::string GetArg(const std::string &strArg, const std::string &strDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return string argument or default value.
std::string GetChainTypeString() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Returns the appropriate chain type string from the program arguments.
bool IsArgSet(const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return true if the given argument has been manually set.
bool IsArgNegated(const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return true if the argument was originally passed as a negated option, i.e.
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
bool GetBoolArg(const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Return boolean argument or default value.
std::string GetHelpMessage() const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
Get the help string.
Process RPC generatetoaddress request.
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
UniValue ProcessReply(const UniValue &reply) override
Process netinfo requests.
bool m_outbound_only_selected
uint8_t m_block_relay_peers_count
bool DetailsRequested() const
std::vector< Peer > m_peers
UniValue ProcessReply(const UniValue &batch_in) override
static std::string ServicesList(const UniValue &services)
uint8_t m_details_level
Optional user-supplied arg to set dashboard details level.
size_t m_max_addr_rate_limited_length
size_t m_max_addr_processed_length
bool IsAddressSelected() const
std::string FormatServices(const UniValue &services)
std::string ConnectionTypeForNetinfo(const std::string &conn_type) const
bool IsVersionSelected() const
uint8_t m_manual_peers_count
const std::string m_help_doc
static constexpr int ID_PEERINFO
std::string ChainToString() const
size_t m_max_services_length
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
std::array< std::array< uint16_t, NETWORKS.size()+1 >, 3 > m_counts
Peer counts by (in/out/total, networks/total)
static constexpr int ID_NETWORKINFO
std::string PingTimeToString(double seconds) const
void push_back(UniValue val)
const std::string & get_str() const
const UniValue & find_value(std::string_view key) const
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
const std::string & getValStr() const
const UniValue & get_obj() const
const std::vector< UniValue > & getValues() const
const std::vector< std::string > & getKeys() const
bool read(std::string_view raw)
void setStr(std::string str)
void pushKV(std::string key, UniValue val)
UniValue RPCConvertValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert command lines arguments to params object when -named is disabled.
UniValue RPCConvertNamedValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert command line arguments to params object when -named is enabled.
std::string FormatFullVersion()
raii_evhttp_request obtain_evhttp_request(void(*cb)(struct evhttp_request *, void *), void *arg)
raii_evhttp_connection obtain_evhttp_connection_base(struct event_base *base, std::string host, uint16_t port)
raii_event_base obtain_event_base()
void PrintExceptionContinue(const std::exception *pex, std::string_view thread_name)
const std::string CURRENCY_UNIT
static std::string PathToString(const path &path)
Convert path object to a byte string.
std::string LicenseInfo()
Returns licensing information (for -version)
std::unique_ptr< Init > MakeBasicInit(const char *exe_name, const char *process_argv0)
Return implementation of Init interface for a basic IPC client that doesn't provide any IPC services ...
std::string ToString(const T &t)
Locale-independent version of std::to_string.
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
static RPCMethod listwallets()
RPCMethod getnewaddress()
std::vector< UniValue > JSONRPCProcessBatchReply(const UniValue &in)
Parse JSON-RPC batch reply into a vector.
UniValue JSONRPCRequestObj(const std::string &strMethod, const UniValue ¶ms, const UniValue &id)
JSON-RPC protocol.
AuthCookieResult GetAuthCookie(std::string &cookie_out)
Read the RPC authentication cookie from disk.
UniValue JSONRPCReplyObj(UniValue result, UniValue error, std::optional< UniValue > id, JSONRPCVersion jsonrpc_version)
static const uint64_t DEFAULT_MAX_TRIES
Default max iterations to try in RPC generatetodescriptor, generatetoaddress, and generateblock.
@ HTTP_SERVICE_UNAVAILABLE
@ HTTP_INTERNAL_SERVER_ERROR
@ RPC_WALLET_NOT_SPECIFIED
No wallet specified (error when there are multiple wallets loaded)
@ RPC_IN_WARMUP
Client still warming up.
Process addrinfo requests.
UniValue ProcessReply(const UniValue &reply) override
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Handle the conversion from a command-line to a JSON-RPC request, as well as converting back to a JSON...
virtual UniValue ProcessReply(const UniValue &batch_in)=0
virtual ~BaseRequestHandler()=default
virtual UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args)=0
CConnectionFailed(const std::string &msg)
Process default single requests.
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
UniValue ProcessReply(const UniValue &reply) override
Process getinfo requests.
const int ID_BLOCKCHAININFO
UniValue PrepareRequest(const std::string &method, const std::vector< std::string > &args) override
Create a simulated getinfo request.
UniValue ProcessReply(const UniValue &batch_in) override
Collect values from the batch and form a simulated getinfo reply.
Reply structure for request_done to fill in.
bool is_addr_relay_enabled
std::string transport_protocol_type
int64_t addr_rate_limited
bool operator<(const Peer &rhs) const
std::function< std::string(const char *)> TranslateFn
Translate a message to the native language of the user.
const UniValue NullUniValue
std::string FormatParagraph(std::string_view in, size_t width, size_t indent)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.
bool SplitHostPort(std::string_view in, uint16_t &portOut, std::string &hostOut)
Splits socket address string into host string and port value.
std::string EncodeBase64(std::span< const unsigned char > input)
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.
void UninterruptibleSleep(const std::chrono::microseconds &n)