6#include <bitcoin-build-config.h>
45#include <event2/buffer.h>
46#include <event2/keyvalq_struct.h>
68static constexpr std::array
NETWORKS{
"not_publicly_routable",
"ipv4",
"ipv6",
"onion",
"i2p",
"cjdns",
"internal"};
69static constexpr std::array
NETWORK_SHORT_NAMES{
"npr",
"ipv4",
"ipv6",
"onion",
"i2p",
"cjdns",
"int"};
91 argsman.
AddArg(
"-generate",
92 strprintf(
"Generate blocks, equivalent to RPC getnewaddress followed by RPC generatetoaddress. Optional positional integer "
93 "arguments are number of blocks to generate (default: %s) and maximum iterations to try (default: %s), equivalent to "
94 "RPC generatetoaddress nblocks and maxtries arguments. Example: bitcoin-cli -generate 4 1000",
98 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);
99 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);
109 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);
113 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);
114 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);
115 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);
117 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);
131 if (severity >= EVENT_LOG_ERR) {
132 throw std::runtime_error(
strprintf(
"libevent error: %s",
msg));
155 tfm::format(std::cerr,
"Error parsing command line arguments: %s\n", error);
159 std::string strUsage = CLIENT_NAME
" RPC client version " +
FormatFullVersion() +
"\n";
165 "The bitcoin-cli utility provides a command line interface to interact with a " CLIENT_NAME
" RPC server.\n"
166 "\nIt can be used to query network information, manage wallets, create or broadcast transactions, and control the " CLIENT_NAME
" server.\n"
167 "\nUse the \"help\" command to list all commands. Use \"help <command>\" to show help for that command.\n"
168 "The -named option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.\n"
170 "Usage: bitcoin-cli [options] <command> [params]\n"
171 "or: bitcoin-cli [options] -named <command> [name=value]...\n"
172 "or: bitcoin-cli [options] help\n"
173 "or: bitcoin-cli [options] help <command>\n"
180 tfm::format(std::cerr,
"Error: too few parameters\n");
186 tfm::format(std::cerr,
"Error: Specified data directory \"%s\" does not exist.\n",
gArgs.
GetArg(
"-datadir",
""));
190 tfm::format(std::cerr,
"Error reading configuration file: %s\n", error);
196 }
catch (
const std::exception& e) {
217 case EVREQ_HTTP_TIMEOUT:
218 return "timeout reached";
220 return "EOF reached";
221 case EVREQ_HTTP_INVALID_HEADER:
222 return "error while reading header, or invalid header";
223 case EVREQ_HTTP_BUFFER_ERROR:
224 return "error encountered while reading or writing";
225 case EVREQ_HTTP_REQUEST_CANCEL:
226 return "request was canceled";
227 case EVREQ_HTTP_DATA_TOO_LONG:
228 return "response body is larger than allowed";
238 if (req ==
nullptr) {
246 reply->
status = evhttp_request_get_response_code(req);
248 struct evbuffer *buf = evhttp_request_get_input_buffer(req);
251 size_t size = evbuffer_get_length(buf);
252 const char *
data = (
const char*)evbuffer_pullup(buf, size);
254 reply->
body = std::string(
data, size);
255 evbuffer_drain(buf, size);
267 for (
size_t i = 0; i <
NETWORKS.size(); ++i) {
287 throw std::runtime_error(
"-addrinfo takes no arguments");
294 if (!reply[
"error"].isNull()) {
296 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.");
301 const std::vector<std::string>& network_types{reply[
"result"].
getKeys()};
302 const std::vector<UniValue>& addrman_counts{reply[
"result"].
getValues()};
307 for (
size_t i = 0; i < network_types.size(); ++i) {
308 int addr_count = addrman_counts[i][
"total"].getInt<
int>();
309 if (network_types[i] ==
"all_networks") {
310 addresses.pushKV(
"total", addr_count);
312 addresses.pushKV(network_types[i], addr_count);
315 result.pushKV(
"addresses_known", std::move(addresses));
331 throw std::runtime_error(
"-getinfo takes no arguments");
364 result.
pushKV(
"connections", std::move(connections));
370 result.
pushKV(
"has_wallet",
true);
373 if (!batch[
ID_WALLETINFO][
"result"][
"unlocked_until"].isNull()) {
450 if (seconds < 0)
return "";
451 const double milliseconds{round(1000 * seconds)};
452 return milliseconds > 999999 ?
"-" :
ToString(milliseconds);
456 if (conn_type ==
"outbound-full-relay")
return "full";
457 if (conn_type ==
"block-relay-only")
return "block";
458 if (conn_type ==
"manual" || conn_type ==
"feeler")
return conn_type;
459 if (conn_type ==
"addr-fetch")
return "addr";
460 if (conn_type ==
"private-broadcast")
return "priv";
466 for (
size_t i = 0; i < services.
size(); ++i) {
467 const std::string
s{services[i].
get_str()};
468 str +=
s ==
"NETWORK_LIMITED" ?
'l' :
s ==
"P2P_V2" ?
'2' :
ToLower(
s[0]);
474 std::string str{services.
size() ? services[0].
get_str() :
""};
475 for (
size_t i{1}; i < services.
size(); ++i) {
476 str +=
", " + services[i].
get_str();
479 c = (c ==
'_' ?
' ' :
ToLower(c));
492 if (
const auto res{ToIntegral<uint8_t>(
args.at(0))}) {
496 throw std::runtime_error(
strprintf(
"invalid -netinfo level argument: %s\nFor more information, run: bitcoin-cli -netinfo help",
args.at(0)));
498 if (
args.size() > 1) {
499 if (std::string_view
s{
args.at(1)}; n && (
s ==
"o" ||
s ==
"outonly")) {
502 throw std::runtime_error(
strprintf(
"invalid -netinfo outonly argument: %s\nFor more information, run: bitcoin-cli -netinfo help",
s));
504 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));
521 if (networkinfo[
"version"].getInt<int>() < 209900) {
522 throw std::runtime_error(
"-netinfo requires bitcoind server to be running v0.21.0 and up");
524 const int64_t time_now{TicksSinceEpoch<std::chrono::seconds>(CliClock::now())};
528 const std::string network{peer[
"network"].get_str()};
531 const bool is_outbound{!peer[
"inbound"].get_bool()};
532 const bool is_tx_relay{peer[
"relaytxes"].isNull() ? true : peer[
"relaytxes"].get_bool()};
533 const std::string conn_type{peer[
"connection_type"].get_str()};
534 ++
m_counts.at(is_outbound).at(network_id);
543 const int peer_id{peer[
"id"].getInt<
int>()};
544 const int mapped_as{peer[
"mapped_as"].isNull() ? 0 : peer[
"mapped_as"].getInt<
int>()};
545 const int version{peer[
"version"].getInt<
int>()};
546 const int64_t addr_processed{peer[
"addr_processed"].isNull() ? 0 : peer[
"addr_processed"].getInt<int64_t>()};
547 const int64_t addr_rate_limited{peer[
"addr_rate_limited"].isNull() ? 0 : peer[
"addr_rate_limited"].getInt<int64_t>()};
548 const int64_t conn_time{peer[
"conntime"].getInt<int64_t>()};
549 const int64_t last_blck{peer[
"last_block"].getInt<int64_t>()};
550 const int64_t last_recv{peer[
"lastrecv"].getInt<int64_t>()};
551 const int64_t last_send{peer[
"lastsend"].getInt<int64_t>()};
552 const int64_t last_trxn{peer[
"last_transaction"].getInt<int64_t>()};
553 const double min_ping{peer[
"minping"].isNull() ? -1 : peer[
"minping"].get_real()};
554 const double ping{peer[
"pingtime"].isNull() ? -1 : peer[
"pingtime"].get_real()};
555 const std::string addr{peer[
"addr"].get_str()};
556 const std::string age{conn_time == 0 ?
"" :
ToString((time_now - conn_time) / 60)};
557 const std::string services{
FormatServices(peer[
"servicesnames"])};
558 const std::string sub_version{peer[
"subver"].get_str()};
559 const std::string transport{peer[
"transport_protocol_type"].isNull() ?
"v1" : peer[
"transport_protocol_type"].get_str()};
560 const bool is_addr_relay_enabled{peer[
"addr_relay_enabled"].isNull() ? false : peer[
"addr_relay_enabled"].get_bool()};
561 const bool is_bip152_hb_from{peer[
"bip152_hb_from"].get_bool()};
562 const bool is_bip152_hb_to{peer[
"bip152_hb_to"].get_bool()};
563 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});
576 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)};
581 result +=
strprintf(
"<-> type net %*s v mping ping send recv txn blk hb %*s%*s%*s ",
589 std::string version{
ToString(peer.version) + peer.sub_version};
591 "%3s %6s %5s %*s %2s%7s%7s%5s%5s%5s%5s %2s %*s%*s%*s%*i %*s %-*s%s\n",
592 peer.is_outbound ?
"out" :
"in",
597 (peer.transport_protocol_type.size() == 2 && peer.transport_protocol_type[0] ==
'v') ? peer.transport_protocol_type[1] :
' ',
600 peer.last_send ?
ToString(time_now - peer.last_send) :
"",
601 peer.last_recv ?
ToString(time_now - peer.last_recv) :
"",
602 peer.last_trxn ?
ToString((time_now - peer.last_trxn) / 60) : peer.is_tx_relay ?
"" :
"*",
603 peer.last_blck ?
ToString((time_now - peer.last_blck) / 60) :
"",
604 strprintf(
"%s%s", peer.is_bip152_hb_to ?
"." :
" ", peer.is_bip152_hb_from ?
"*" :
" "),
606 peer.addr_processed ?
ToString(peer.addr_processed) : peer.is_addr_relay_enabled ?
"" :
".",
608 peer.addr_rate_limited ?
ToString(peer.addr_rate_limited) :
"",
624 std::vector<int8_t> reachable_networks;
625 for (
const UniValue& network : networkinfo[
"networks"].getValues()) {
626 if (network[
"reachable"].get_bool()) {
627 const std::string& network_name{network[
"name"].get_str()};
630 result +=
strprintf(
"%8s", network_name);
631 reachable_networks.push_back(network_id);
636 if (
m_counts.at(2).at(network_id) == 0)
continue;
638 reachable_networks.push_back(network_id);
641 result +=
" total block";
644 const std::array rows{
"in",
"out",
"total"};
645 for (
size_t i = 0; i < rows.size(); ++i) {
647 for (int8_t n : reachable_networks) {
661 result +=
"\n\nLocal addresses";
662 const std::vector<UniValue>& local_addrs{networkinfo[
"localaddresses"].getValues()};
663 if (local_addrs.empty()) {
666 size_t max_addr_size{0};
667 for (
const UniValue& addr : local_addrs) {
668 max_addr_size = std::max(addr[
"address"].get_str().length() + 1, max_addr_size);
670 for (
const UniValue& addr : local_addrs) {
671 result +=
strprintf(
"\n%-*s port %6i score %6i", max_addr_size, addr[
"address"].get_str(), addr[
"port"].getInt<int>(), addr[
"score"].getInt<int>());
679 "-netinfo (level [outonly]) | help\n\n"
680 "Returns a network peer connections dashboard with information from the remote server.\n"
681 "This human-readable interface will change regularly and is not intended to be a stable API.\n"
682 "Under the hood, -netinfo fetches the data by calling getpeerinfo and getnetworkinfo.\n"
684 "If that argument is passed, an optional additional \"outonly\" argument may be passed to obtain the listing with outbound peers only.\n"
685 "Pass \"help\" or \"h\" to see this detailed help documentation.\n"
686 "If more than two arguments are passed, only the first two are read and parsed.\n"
687 "Suggestion: use -netinfo with the Linux watch(1) command for a live dashboard; see example below.\n\n"
689 +
strprintf(
"1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n",
NETINFO_MAX_LEVEL) +
690 " 0 - Peer counts for each reachable network as well as for block relay peers\n"
691 " and manual peers, and the list of local addresses and ports\n"
692 " 1 - Like 0 but preceded by a peers listing (without address and version columns)\n"
693 " 2 - Like 1 but with an address column\n"
694 " 3 - Like 1 but with a version column\n"
695 " 4 - Like 1 but with both address and version columns\n"
696 "2. outonly (\"outonly\" or \"o\", optional) Return the peers listing with outbound peers only, i.e. to save screen space\n"
697 " when a node has many inbound peers. Only valid if a level is passed.\n\n"
698 "help (\"help\" or \"h\", optional) Print this help documentation instead of the dashboard.\n\n"
700 +
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) +
701 " Column Description\n"
702 " ------ -----------\n"
704 " \"in\" - inbound connections are those initiated by the peer\n"
705 " \"out\" - outbound connections are those initiated by us\n"
706 " type Type of peer connection\n"
707 " \"full\" - full relay, the default\n"
708 " \"block\" - block relay; like full relay but does not relay transactions or addresses\n"
709 " \"manual\" - peer we manually added using RPC addnode or the -addnode/-connect config options\n"
710 " \"feeler\" - short-lived connection for testing addresses\n"
711 " \"addr\" - address fetch; short-lived connection for requesting addresses\n"
712 " \"priv\" - private broadcast; short-lived connection for broadcasting our transactions\n"
713 " net Network the peer connected through (\"ipv4\", \"ipv6\", \"onion\", \"i2p\", \"cjdns\", or \"npr\" (not publicly routable))\n"
714 " serv Services offered by the peer\n"
715 " \"n\" - NETWORK: peer can serve the full block chain\n"
716 " \"b\" - BLOOM: peer can handle bloom-filtered connections (see BIP 111)\n"
717 " \"w\" - WITNESS: peer can be asked for blocks and transactions with witness data (SegWit)\n"
718 " \"c\" - COMPACT_FILTERS: peer can handle basic block filter requests (see BIPs 157 and 158)\n"
719 " \"l\" - NETWORK_LIMITED: peer limited to serving only the last 288 blocks (~2 days)\n"
720 " \"2\" - P2P_V2: peer supports version 2 P2P transport protocol, as defined in BIP 324\n"
721 " \"u\" - UNKNOWN: unrecognized bit flag\n"
722 " v Version of transport protocol used for the connection\n"
723 " mping Minimum observed ping time, in milliseconds (ms)\n"
724 " ping Last observed ping time, in milliseconds (ms)\n"
725 " send Time since last message sent to the peer, in seconds\n"
726 " recv Time since last message received from the peer, in seconds\n"
727 " txn Time since last novel transaction received from the peer and accepted into our mempool, in minutes\n"
728 " \"*\" - we do not relay transactions to this peer (getpeerinfo \"relaytxes\" is false)\n"
729 " blk Time since last novel block passing initial validity checks received from the peer, in minutes\n"
730 " hb High-bandwidth BIP152 compact block relay\n"
731 " \".\" (to) - we selected the peer as a high-bandwidth peer\n"
732 " \"*\" (from) - the peer selected us as a high-bandwidth peer\n"
733 " addrp Total number of addresses processed, excluding those dropped due to rate limiting\n"
734 " \".\" - we do not relay addresses to this peer (getpeerinfo \"addr_relay_enabled\" is false)\n"
735 " addrl Total number of addresses dropped due to rate limiting\n"
736 " age Duration of connection to the peer, in minutes\n"
737 " asmap Mapped AS (Autonomous System) number at the end of the BGP route to the peer, used for diversifying\n"
738 " peer selection (only displayed if the -asmap config option is set)\n"
739 " id Peer index, in increasing order of peer connections since node startup\n"
740 " address IP address and port of the peer\n"
741 " version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
742 "* The peer counts table displays the number of peers for each reachable network as well as\n"
743 " the number of block relay peers and manual peers.\n\n"
744 "* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
746 "Peer counts table of reachable networks and list of local addresses\n"
747 "> bitcoin-cli -netinfo\n\n"
748 "The same, preceded by a peers listing without address and version columns\n"
749 "> bitcoin-cli -netinfo 1\n\n"
752 "Full dashboard, but with outbound peers only\n"
754 "Full live dashboard, adjust --interval or --no-title as needed (Linux)\n"
757 "> bitcoin-cli -netinfo help\n"};
802static std::optional<UniValue>
CallIPC(
BaseRequestHandler* rh,
const std::string& strMethod,
const std::vector<std::string>&
args,
const std::string& endpoint,
const std::string& username)
804 auto ipcconnect{
gArgs.
GetArg(
"-ipcconnect",
"auto")};
805 if (ipcconnect ==
"0")
return {};
807 if (ipcconnect ==
"auto")
return {};
808 throw std::runtime_error(
"-rpcconnect and -ipcconnect options cannot both be enabled");
812 if (!local_init || !local_init->ipc()) {
813 if (ipcconnect ==
"auto")
return {};
814 throw std::runtime_error(
"bitcoin-cli was not built with IPC support");
817 std::unique_ptr<interfaces::Init> node_init;
819 node_init = local_init->ipc()->connectAddress(ipcconnect);
820 if (!node_init)
return {};
821 }
catch (
const std::exception& e) {
824 "Probably bitcoin-node is not running or not listening on a unix socket. Can be started with:\n\n"
828 std::unique_ptr<interfaces::Rpc> rpc{node_init->makeRpc()};
831 UniValue reply{rpc->executeRpc(std::move(request), endpoint, username)};
844 uint16_t rpcconnect_port{0};
850 throw std::runtime_error(
strprintf(
"Invalid port provided in -rpcconnect: %s", rpcconnect_str));
852 if (rpcconnect_port != 0) {
854 port = rpcconnect_port;
858 if (std::optional<std::string> rpcport_arg =
gArgs.
GetArg(
"-rpcport")) {
860 const uint16_t rpcport_int{ToIntegral<uint16_t>(rpcport_arg.value()).value_or(0)};
861 if (rpcport_int == 0) {
865 throw std::runtime_error(
strprintf(
"Invalid port provided in -rpcport: %s", rpcport_arg.value()));
873 if (rpcconnect_port != 0) {
874 tfm::format(std::cerr,
"Warning: Port specified in both -rpcconnect and -rpcport. Using -rpcport %u\n", port);
889 evhttp_connection_set_timeout(evcon.get(), timeout);
894 constexpr int YEAR_IN_SECONDS = 31556952;
895 evhttp_connection_set_timeout(evcon.get(), 5 * YEAR_IN_SECONDS);
901 if (req ==
nullptr) {
902 throw std::runtime_error(
"create http request failed");
908 std::string rpc_credentials;
909 std::optional<AuthCookieResult> auth_cookie_result;
914 rpc_credentials = username +
":" +
gArgs.
GetArg(
"-rpcpassword",
"");
917 struct evkeyvalq* output_headers = evhttp_request_get_output_headers(req.get());
919 evhttp_add_header(output_headers,
"Host", host.c_str());
920 evhttp_add_header(output_headers,
"Connection",
"close");
921 evhttp_add_header(output_headers,
"Content-Type",
"application/json");
922 evhttp_add_header(output_headers,
"Authorization", (std::string(
"Basic ") +
EncodeBase64(rpc_credentials)).c_str());
926 struct evbuffer* output_buffer = evhttp_request_get_output_buffer(req.get());
928 evbuffer_add(output_buffer, strRequest.data(), strRequest.size());
930 int r = evhttp_make_request(evcon.get(), req.release(), EVHTTP_REQ_POST, endpoint.c_str());
935 event_base_dispatch(base.get());
937 if (response.
status == 0) {
938 std::string responseErrorMessage;
939 if (response.
error != -1) {
943 "Make sure the bitcoind server is running and that you are connecting to the correct RPC port.\n"
944 "Use \"bitcoin-cli -help\" for more info.",
945 host, port, responseErrorMessage));
947 std::string error{
"Authorization failed: "};
948 if (auth_cookie_result.has_value()) {
949 switch (*auth_cookie_result) {
951 error +=
"Failed to read cookie file and no rpcpassword was specified.";
954 error +=
"Cookie file was disabled via -norpccookiefile and no rpcpassword was specified.";
957 error +=
"Cookie file credentials were invalid and no rpcpassword was specified.";
961 error +=
"Incorrect rpcuser or rpcpassword were specified.";
964 throw std::runtime_error(error);
966 throw std::runtime_error(
strprintf(
"Server response: %s", response.
body));
968 throw std::runtime_error(
strprintf(
"server returned HTTP error %d", response.
status));
969 else if (response.
body.empty())
970 throw std::runtime_error(
"no response from server");
975 throw std::runtime_error(
"couldn't parse reply from server");
978 throw std::runtime_error(
"expected reply to have result, error and id properties");
998 const auto deadline{std::chrono::steady_clock::now() + 1
s * timeout};
1001 std::string endpoint =
"/";
1003 char* encodedURI = evhttp_uriencode(rpcwallet->data(), rpcwallet->size(),
false);
1005 endpoint =
"/wallet/" + std::string(encodedURI);
1012 std::string username{
gArgs.
GetArg(
"-rpcuser",
"")};
1015 if (
auto ipc_response{
CallIPC(rh, strMethod,
args, endpoint, username)}) {
1016 response = std::move(*ipc_response);
1018 response =
CallRPC(rh, strMethod,
args, endpoint, username);
1028 if (fWait && (timeout <= 0 || std::chrono::steady_clock::now() < deadline)) {
1041 if (result.
isNull())
return;
1051 if (!err_code.
isNull()) {
1054 if (err_msg.
isStr()) {
1058 strPrint +=
" Or for the CLI, specify the \"-rpcwallet=<walletname>\" option before the command";
1059 strPrint +=
" (run \"bitcoin-cli -h\" for help or \"bitcoin-cli listwallets\" to see which wallets are currently loaded).";
1064 nRet = abs(error[
"code"].getInt<int>());
1077 if (!
listwallets.find_value(
"error").isNull())
return;
1079 if (wallets.
size() <= 1)
return;
1083 const std::string& wallet_name =
wallet.get_str();
1086 balances.
pushKV(wallet_name, balance);
1088 result.
pushKV(
"balances", std::move(balances));
1099 if (progress < 0 || progress > 1)
return;
1101 static constexpr double INCREMENT{0.05};
1102 static const std::string COMPLETE_BAR{
"\u2592"};
1103 static const std::string INCOMPLETE_BAR{
"\u2591"};
1105 for (
int i = 0; i < progress / INCREMENT; ++i) {
1106 progress_bar += COMPLETE_BAR;
1109 for (
int i = 0; i < (1 - progress) / INCREMENT; ++i) {
1110 progress_bar += INCOMPLETE_BAR;
1123 std::string RESET, GREEN, BLUE, YELLOW, MAGENTA, CYAN;
1124 bool should_colorize =
false;
1127 if (isatty(fileno(stdout))) {
1129 should_colorize =
true;
1135 if (color ==
"always") {
1136 should_colorize =
true;
1137 }
else if (color ==
"never") {
1138 should_colorize =
false;
1139 }
else if (color !=
"auto") {
1140 throw std::runtime_error(
"Invalid value for -color option. Valid values: always, auto, never.");
1144 if (should_colorize) {
1148 YELLOW =
"\x1B[33m";
1149 MAGENTA =
"\x1B[35m";
1153 std::string result_string =
strprintf(
"%sChain: %s%s\n", BLUE, result[
"chain"].getValStr(), RESET);
1154 result_string +=
strprintf(
"Blocks: %s\n", result[
"blocks"].getValStr());
1155 result_string +=
strprintf(
"Headers: %s\n", result[
"headers"].getValStr());
1157 const double ibd_progress{result[
"verificationprogress"].
get_real()};
1158 std::string ibd_progress_bar;
1160 if (ibd_progress < 0.99) {
1163 ibd_progress_bar +=
" ";
1166 result_string +=
strprintf(
"Verification progress: %s%.4f%%\n", ibd_progress_bar, ibd_progress * 100);
1167 result_string +=
strprintf(
"Difficulty: %s\n\n", result[
"difficulty"].getValStr());
1170 "%sNetwork: in %s, out %s, total %s%s\n",
1172 result[
"connections"][
"in"].getValStr(),
1173 result[
"connections"][
"out"].getValStr(),
1174 result[
"connections"][
"total"].getValStr(),
1176 result_string +=
strprintf(
"Version: %s\n", result[
"version"].getValStr());
1177 result_string +=
strprintf(
"Time offset (s): %s\n", result[
"timeoffset"].getValStr());
1180 std::map<std::string, std::vector<std::string>> proxy_networks;
1181 std::vector<std::string> ordered_proxies;
1183 for (
const UniValue& network : result[
"networks"].getValues()) {
1184 const std::string proxy = network[
"proxy"].getValStr();
1185 if (proxy.empty())
continue;
1187 if (!proxy_networks.contains(proxy)) ordered_proxies.push_back(proxy);
1189 proxy_networks[proxy].push_back(network[
"name"].getValStr());
1192 std::vector<std::string> formatted_proxies;
1193 formatted_proxies.reserve(ordered_proxies.size());
1194 for (
const std::string& proxy : ordered_proxies) {
1195 formatted_proxies.emplace_back(
strprintf(
"%s (%s)", proxy,
Join(proxy_networks.find(proxy)->second,
", ")));
1197 result_string +=
strprintf(
"Proxies: %s\n", formatted_proxies.empty() ?
"n/a" :
Join(formatted_proxies,
", "));
1199 result_string +=
strprintf(
"Min tx relay fee rate (%s/kvB): %s\n\n",
CURRENCY_UNIT, result[
"relayfee"].getValStr());
1201 if (!result[
"has_wallet"].isNull()) {
1202 const std::string walletname = result[
"walletname"].
getValStr();
1203 result_string +=
strprintf(
"%sWallet: %s%s\n", MAGENTA, walletname.empty() ?
"\"\"" : walletname, RESET);
1205 result_string +=
strprintf(
"Keypool size: %s\n", result[
"keypoolsize"].getValStr());
1206 if (!result[
"unlocked_until"].isNull()) {
1207 result_string +=
strprintf(
"Unlocked until: %s\n", result[
"unlocked_until"].getValStr());
1210 if (!result[
"balance"].isNull()) {
1211 result_string +=
strprintf(
"%sBalance:%s %s\n\n", CYAN, RESET, result[
"balance"].getValStr());
1214 if (!result[
"balances"].isNull()) {
1215 result_string +=
strprintf(
"%sBalances%s\n", CYAN, RESET);
1217 size_t max_balance_length{10};
1219 for (
const std::string&
wallet : result[
"balances"].getKeys()) {
1220 max_balance_length = std::max(result[
"balances"][
wallet].getValStr().length(), max_balance_length);
1223 for (
const std::string&
wallet : result[
"balances"].getKeys()) {
1226 result[
"balances"][
wallet].getValStr(),
1229 result_string +=
"\n";
1232 const std::string warnings{result[
"warnings"].
getValStr()};
1233 result_string +=
strprintf(
"%sWarnings:%s %s", YELLOW, RESET, warnings.empty() ?
"(none)" : warnings);
1235 result.
setStr(result_string);
1255 if (
args.size() > 2)
throw std::runtime_error(
"too many arguments (maximum 2 for nblocks and maxtries)");
1256 if (
args.size() == 0) {
1258 }
else if (
args.at(0) ==
"0") {
1259 throw std::runtime_error(
"the first argument (number of blocks to generate, default: " +
DEFAULT_NBLOCKS +
") must be an integer value greater than zero");
1261 args.emplace(
args.begin() + 1, address);
1274 std::string rpcPass;
1278 fputs(
"RPC password> ", stderr);
1281 if (!std::getline(std::cin, rpcPass)) {
1282 throw std::runtime_error(
"-stdinrpcpass specified but failed to read from standard input");
1285 fputc(
'\n', stdout);
1289 std::vector<std::string>
args = std::vector<std::string>(&argv[1], &argv[argc]);
1292 std::string walletPass;
1293 if (
args.size() < 1 || !
args[0].starts_with(
"walletpassphrase")) {
1294 throw std::runtime_error(
"-stdinwalletpassphrase is only applicable for walletpassphrase(change)");
1297 fputs(
"Wallet passphrase> ", stderr);
1300 if (!std::getline(std::cin, walletPass)) {
1301 throw std::runtime_error(
"-stdinwalletpassphrase specified but failed to read from standard input");
1304 fputc(
'\n', stdout);
1306 args.insert(
args.begin() + 1, walletPass);
1311 while (std::getline(std::cin, line)) {
1312 args.push_back(line);
1315 fputc(
'\n', stdout);
1319 std::unique_ptr<BaseRequestHandler> rh;
1324 if (!
args.empty() && (
args.at(0) ==
"h" ||
args.at(0) ==
"help")) {
1342 if (
args.size() < 1) {
1343 throw std::runtime_error(
"too few parameters (need at least command)");
1369 }
catch (
const std::exception& e) {
1370 strPrint = std::string(
"error: ") + e.what();
1371 nRet = EXIT_FAILURE;
1387 tfm::format(std::cerr,
"Error: Initializing networking failed\n");
1388 return EXIT_FAILURE;
1397 catch (
const std::exception& e) {
1399 return EXIT_FAILURE;
1402 return EXIT_FAILURE;
1409 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 const char * DEFAULT_RPC_REQ_ID
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
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
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)