mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-02-01 03:01:05 +00:00
89372213048adf37a47427112a1ff836ee84c50e doc: add release notes for 29415 (Vasil Dimov)
582016fa5f013817db650bbba0a40d9195c18e2e test: add unit test for the private broadcast storage (Vasil Dimov)
e74d54e04896a86cad4e4b1bd9641afcc3a026c2 test: add functional test for private broadcast (Vasil Dimov)
818b780a05db126dcfe7efe12c46c84b5cfc3de6 rpc: use private broadcast from sendrawtransaction RPC if -privatebroadcast is ON (Vasil Dimov)
eab595f9cf13f7cb1d25a0db51409535cfe053b1 net_processing: retry private broadcast (Vasil Dimov)
37b79f9c39db5a4a61d360a6a29c8853bb5c7ac0 net_processing: stop private broadcast of a transaction after round-trip (Vasil Dimov)
2de53eee742da11b0e3f6fc44c39f2b5b5929da1 net_processing: handle ConnectionType::PRIVATE_BROADCAST connections (Vasil Dimov)
30a9853ad35365af8545e8e766d75cf398968480 net_processing: move a debug check in VERACK processing earlier (Vasil Dimov)
d1092e5d48ce67bd517068550c78bfcab062a554 net_processing: modernize PushNodeVersion() (Vasil Dimov)
9937a12a2fd5a0033f37f4dda5d75bfc5f15c3b6 net_processing: move the debug log about receiving VERSION earlier (Vasil Dimov)
a098f37b9e240291077a7f440e9f57e61f30e158 net_processing: reorder the code that handles the VERSION message (Vasil Dimov)
679ce3a0b8df6e8cab07965301382d2036ef2368 net_processing: store transactions for private broadcast in PeerManager (Vasil Dimov)
a3faa6f944a672faccac5dd201c8d33a638d9091 node: extend node::TxBroadcast with a 3rd option (Vasil Dimov)
95c051e21051bd469fda659fe7c495d5e264d221 net_processing: rename RelayTransaction() to better describe what it does (Vasil Dimov)
bb49d26032c57714c62a4b31ff1fdd969751683f net: implement opening PRIVATE_BROADCAST connections (Vasil Dimov)
01dad4efe2b38b7a71c96b6222147f395e0c11d9 net: introduce a new connection type for private broadcast (Vasil Dimov)
94aaa5d31b6ff1d0122319fc70e70a7e27e1a0ba init: introduce a new option to enable/disable private broadcast (Vasil Dimov)
d6ee490e0a9a81b69a4751087918303163ba8869 log: introduce a new category for private broadcast (Vasil Dimov)
Pull request description:
_Parts of this PR are isolated in independent smaller PRs to ease review:_
* [x] _https://github.com/bitcoin/bitcoin/pull/29420_
* [x] _https://github.com/bitcoin/bitcoin/pull/33454_
* [x] _https://github.com/bitcoin/bitcoin/pull/33567_
* [x] _https://github.com/bitcoin/bitcoin/pull/33793_
---
To improve privacy, broadcast locally submitted transactions (from the `sendrawtransaction` RPC) to the P2P network only via Tor or I2P short-lived connections, or to IPv4/IPv6 peers but through the Tor network.
* Introduce a new connection type for private broadcast of transactions with the following properties:
* started whenever there are local transactions to be sent
* opened to Tor or I2P peers or IPv4/IPv6 via the Tor proxy
* opened regardless of max connections limits
* after handshake is completed one local transaction is pushed to the peer, `PING` is sent and after receiving `PONG` the connection is closed
* ignore all incoming messages after handshake is completed (except `PONG`)
* Broadcast transactions submitted via `sendrawtransaction` using this new mechanism, to a few peers. Keep doing this until we receive back this transaction from one of our ordinary peers (this takes about 1 second on mainnet).
* The transaction is stored in peerman and does not enter the mempool.
* Once we get an `INV` from one of our ordinary peers, then the normal flow executes: we request the transaction with `GETDATA`, receive it with a `TX` message, put it in our mempool and broadcast it to all our existent connections (as if we see it for the first time).
* After we receive the full transaction as a `TX` message, in reply to our `GETDATA` request, only then consider the transaction has propagated through the network and remove it from the storage in peerman, ending the private broadcast attempts.
The messages exchange should look like this:
```
tx-sender >--- connect -------> tx-recipient
tx-sender >--- VERSION -------> tx-recipient (dummy VERSION with no revealing data)
tx-sender <--- VERSION -------< tx-recipient
tx-sender <--- WTXIDRELAY ----< tx-recipient (maybe)
tx-sender <--- SENDADDRV2 ----< tx-recipient (maybe)
tx-sender <--- SENDTXRCNCL ---< tx-recipient (maybe)
tx-sender <--- VERACK --------< tx-recipient
tx-sender >--- VERACK --------> tx-recipient
tx-sender >--- INV/TX --------> tx-recipient
tx-sender <--- GETDATA/TX ----< tx-recipient
tx-sender >--- TX ------------> tx-recipient
tx-sender >--- PING ----------> tx-recipient
tx-sender <--- PONG ----------< tx-recipient
tx-sender disconnects
```
Whenever a new transaction is received from `sendrawtransaction` RPC, the node will send it to a few (`NUM_PRIVATE_BROADCAST_PER_TX`) recipients right away. If after some time we still have not heard anything about the transaction from the network, then it will be sent to 1 more peer (see `PeerManagerImpl::ReattemptPrivateBroadcast()`).
A few considerations:
* The short-lived private broadcast connections are very cheap and fast wrt network traffic. It is expected that some of those peers could blackhole the transaction. Just one honest/proper peer is enough for successful propagation.
* The peers that receive the transaction could deduce that this is initial transaction broadcast from the transaction originator. This is ok, they can't identify the sender.
---
<details>
<summary>How to test this?</summary>
Thank you, @stratospher and @andrewtoth!
Start `bitcoind` with `-privatebroadcast=1 -debug=privatebroadcast`.
Create a wallet and get a new address, go to the Signet faucet and request some coins to that address:
```bash
build/bin/bitcoin-cli -chain="signet" createwallet test
build/bin/bitcoin-cli -chain="signet" getnewaddress
```
Get a new address for the test transaction recipient:
```bash
build/bin/bitcoin-cli -chain="signet" loadwallet test
new_address=$(build/bin/bitcoin-cli -chain="signet" getnewaddress)
```
Create the transaction:
```bash
# Option 1: `createrawtransaction` and `signrawtransactionwithwallet`:
txid=$(build/bin/bitcoin-cli -chain="signet" listunspent | jq -r '.[0] | .txid')
vout=$(build/bin/bitcoin-cli -chain="signet" listunspent | jq -r '.[0] | .vout')
echo "txid: $txid"
echo "vout: $vout"
tx=$(build/bin/bitcoin-cli -chain="signet" createrawtransaction "[{\"txid\": \"$txid\", \"vout\": $vout}]" "[{\"$new_address\": 0.00001000}]" 0 false)
echo "tx: $tx"
signed_tx=$(build/bin/bitcoin-cli -chain="signet" signrawtransactionwithwallet "$tx" | jq -r '.hex')
echo "signed_tx: $signed_tx"
# OR Option 2: `walletcreatefundedpsbt` and `walletprocesspsbt`:
# This makes it not have to worry about inputs and also automatically sends back change to the wallet.
# Start `bitcoind` with `-fallbackfee=0.00003000` for instance for 3 sat/vbyte fee.
psbt=$(build/bin/bitcoin-cli -chain="signet" walletcreatefundedpsbt "[]" "[{\"$new_address\": 0.00001000}]" | jq -r '.psbt')
echo "psbt: $psbt"
signed_tx=$(build/bin/bitcoin-cli -chain="signet" walletprocesspsbt "$psbt" | jq -r '.hex')
echo "signed_tx: $signed_tx"
```
Finally, send the transaction:
```bash
raw_tx=$(build/bin/bitcoin-cli -chain="signet" sendrawtransaction "$signed_tx")
echo "raw_tx: $raw_tx"
```
</details>
---
<details>
<summary>High-level explanation of the commits</summary>
* New logging category and config option to enable private broadcast
* `log: introduce a new category for private broadcast`
* `init: introduce a new option to enable/disable private broadcast`
* Implement the private broadcast connection handling on the `CConnman` side:
* `net: introduce a new connection type for private broadcast`
* `net: implement opening PRIVATE_BROADCAST connections`
* Prepare `BroadcastTransaction()` for private broadcast requests:
* `net_processing: rename RelayTransaction to better describe what it does`
* `node: extend node::TxBroadcast with a 3rd option`
* `net_processing: store transactions for private broadcast in PeerManager`
* Implement the private broadcast connection handling on the `PeerManager` side:
* `net_processing: reorder the code that handles the VERSION message`
* `net_processing: move the debug log about receiving VERSION earlier`
* `net_processing: modernize PushNodeVersion()`
* `net_processing: move a debug check in VERACK processing earlier`
* `net_processing: handle ConnectionType::PRIVATE_BROADCAST connections`
* `net_processing: stop private broadcast of a transaction after round-trip`
* `net_processing: retry private broadcast`
* Engage the new functionality from `sendrawtransaction`:
* `rpc: use private broadcast from sendrawtransaction RPC if -privatebroadcast is ON`
* New tests:
* `test: add functional test for private broadcast`
* `test: add unit test for the private broadcast storage`
</details>
---
**This PR would resolve the following issues:**
https://github.com/bitcoin/bitcoin/issues/3828 Clients leak IPs if they are recipients of a transaction
https://github.com/bitcoin/bitcoin/issues/14692 Can't configure bitocoind to only send tx via Tor but receive clearnet transactions
https://github.com/bitcoin/bitcoin/issues/19042 Tor-only transaction broadcast onlynet=onion alternative
https://github.com/bitcoin/bitcoin/issues/24557 Option for receive events with all networks, but send transactions and/or blocks only with anonymous network[s]?
https://github.com/bitcoin/bitcoin/issues/25450 Ability to broadcast wallet transactions only via dedicated oneshot Tor connections
https://github.com/bitcoin/bitcoin/issues/32235 Tor: TX circuit isolation
**Issues that are related, but (maybe?) not to be resolved by this PR:**
https://github.com/bitcoin/bitcoin/issues/21876 Broadcast a transaction to specific nodes
https://github.com/bitcoin/bitcoin/issues/28636 new RPC: sendrawtransactiontopeer
---
Further extensions:
* Have the wallet do the private broadcast as well, https://github.com/bitcoin/bitcoin/issues/11887 would have to be resolved.
* Have the `submitpackage` RPC do the private broadcast as well, [draft diff in the comment below](https://github.com/bitcoin/bitcoin/pull/29415#pullrequestreview-2972293733), thanks ismaelsadeeq!
* Add some stats via RPC, so that the user can better monitor what is going on during and after the broadcast. Currently this can be done via the debug log, but that is not convenient.
* Make the private broadcast storage, currently in peerman, persistent over node restarts.
* Add (optional) random delay before starting to broadcast the transaction in order to avoid correlating unrelated transactions based on the time when they were broadcast. Suggested independently of this PR [here](https://github.com/bitcoin/bitcoin/issues/30471).
* Consider periodically sending transactions that did not originate from the node as decoy, discussed [here](https://github.com/bitcoin/bitcoin/pull/29415#discussion_r2035414972).
* Consider waiting for peer's FEEFILTER message and if the transaction that was sent to the peer is below that threshold, then assume the peer is going to drop it. Then use this knowledge to retry more aggressively with another peer, instead of the current 10 min. See [comment below](https://github.com/bitcoin/bitcoin/pull/29415#issuecomment-3258611648).
* It may make sense to be able to override the default policy -- eg so submitrawtransaction can go straight to the mempool and relay, even if txs are normally privately relayed. See [comment below](https://github.com/bitcoin/bitcoin/pull/29415#issuecomment-3427086681).
* As a side effect we have a new metric available - the time it takes for a transaction to reach a random node in the network (from the point of view of the private broadcast recipient the tx originator is a random node somewhere in the network). This can be useful for monitoring, unrelated to privacy characteristics of this feature.
---
_A previous incarnation of this can be found at https://github.com/bitcoin/bitcoin/pull/27509. It puts the transaction in the mempool and (tries to) hide it from the outside observers. This turned out to be too error prone or maybe even impossible._
ACKs for top commit:
l0rinc:
code review diff ACK 89372213048adf37a47427112a1ff836ee84c50e
andrewtoth:
ACK 89372213048adf37a47427112a1ff836ee84c50e
pinheadmz:
ACK 89372213048adf37a47427112a1ff836ee84c50e
w0xlt:
ACK 8937221304 with nit https://github.com/bitcoin/bitcoin/pull/29415#discussion_r2654849875
mzumsande:
re-ACK 89372213048adf37a47427112a1ff836ee84c50e
Tree-SHA512: d51dadc865c2eb080c903cbe2f669e69a967e5f9fc64e9a20a68f39a67bf0db6ac2ad682af7fa24ef9f0942a41c89959341a16ba7b616475e1c5ab8e563b9b96
1363 lines
66 KiB
C++
1363 lines
66 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-present The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include <bitcoin-build-config.h> // IWYU pragma: keep
|
|
|
|
#include <chainparamsbase.h>
|
|
#include <clientversion.h>
|
|
#include <common/args.h>
|
|
#include <common/system.h>
|
|
#include <compat/compat.h>
|
|
#include <compat/stdin.h>
|
|
#include <policy/feerate.h>
|
|
#include <rpc/client.h>
|
|
#include <rpc/mining.h>
|
|
#include <rpc/protocol.h>
|
|
#include <rpc/request.h>
|
|
#include <tinyformat.h>
|
|
#include <univalue.h>
|
|
#include <util/chaintype.h>
|
|
#include <util/exception.h>
|
|
#include <util/strencodings.h>
|
|
#include <util/time.h>
|
|
#include <util/translation.h>
|
|
|
|
#include <algorithm>
|
|
#include <chrono>
|
|
#include <cmath>
|
|
#include <cstdio>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <tuple>
|
|
|
|
#ifndef WIN32
|
|
#include <unistd.h>
|
|
#endif
|
|
|
|
#include <event2/buffer.h>
|
|
#include <event2/keyvalq_struct.h>
|
|
#include <support/events.h>
|
|
|
|
using util::Join;
|
|
using util::ToString;
|
|
|
|
// The server returns time values from a mockable system clock, but it is not
|
|
// trivial to get the mocked time from the server, nor is it needed for now, so
|
|
// just use a plain system_clock.
|
|
using CliClock = std::chrono::system_clock;
|
|
|
|
const TranslateFn G_TRANSLATION_FUN{nullptr};
|
|
|
|
static const char DEFAULT_RPCCONNECT[] = "127.0.0.1";
|
|
static const int DEFAULT_HTTP_CLIENT_TIMEOUT=900;
|
|
static constexpr int DEFAULT_WAIT_CLIENT_TIMEOUT = 0;
|
|
static const bool DEFAULT_NAMED=false;
|
|
static const int CONTINUE_EXECUTION=-1;
|
|
static constexpr uint8_t NETINFO_MAX_LEVEL{4};
|
|
static constexpr int8_t UNKNOWN_NETWORK{-1};
|
|
// See GetNetworkName() in netbase.cpp
|
|
static constexpr std::array NETWORKS{"not_publicly_routable", "ipv4", "ipv6", "onion", "i2p", "cjdns", "internal"};
|
|
static constexpr std::array NETWORK_SHORT_NAMES{"npr", "ipv4", "ipv6", "onion", "i2p", "cjdns", "int"};
|
|
static constexpr std::array UNREACHABLE_NETWORK_IDS{/*not_publicly_routable*/0, /*internal*/6};
|
|
|
|
/** Default number of blocks to generate for RPC generatetoaddress. */
|
|
static const std::string DEFAULT_NBLOCKS = "1";
|
|
|
|
/** Default -color setting. */
|
|
static const std::string DEFAULT_COLOR_SETTING{"auto"};
|
|
|
|
static void SetupCliArgs(ArgsManager& argsman)
|
|
{
|
|
SetupHelpOptions(argsman);
|
|
|
|
const auto defaultBaseParams = CreateBaseChainParams(ChainType::MAIN);
|
|
const auto testnetBaseParams = CreateBaseChainParams(ChainType::TESTNET);
|
|
const auto testnet4BaseParams = CreateBaseChainParams(ChainType::TESTNET4);
|
|
const auto signetBaseParams = CreateBaseChainParams(ChainType::SIGNET);
|
|
const auto regtestBaseParams = CreateBaseChainParams(ChainType::REGTEST);
|
|
|
|
argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
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);
|
|
argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
|
|
argsman.AddArg("-generate",
|
|
strprintf("Generate blocks, 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::CLI_COMMANDS);
|
|
argsman.AddArg("-addrinfo", "Get the number of addresses known to the node, per network and total, after filtering for quality and recency. The total number of addresses known to the node may be higher.", ArgsManager::ALLOW_ANY, OptionsCategory::CLI_COMMANDS);
|
|
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);
|
|
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);
|
|
|
|
SetupChainParamsBaseOptions(argsman);
|
|
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. Only applies to the output of -getinfo.", DEFAULT_COLOR_SETTING), ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
|
|
argsman.AddArg("-named", strprintf("Pass named instead of positional arguments (default: %s)", DEFAULT_NAMED), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
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);
|
|
argsman.AddArg("-rpcconnect=<ip>", strprintf("Send commands to node running on <ip> (default: %s)", DEFAULT_RPCCONNECT), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
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);
|
|
argsman.AddArg("-rpcpassword=<pw>", "Password for JSON-RPC connections", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
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);
|
|
argsman.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
argsman.AddArg("-rpcwait", "Wait for RPC server to start", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
|
|
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_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
|
|
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);
|
|
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);
|
|
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);
|
|
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);
|
|
}
|
|
|
|
std::optional<std::string> RpcWalletName(const ArgsManager& args)
|
|
{
|
|
// Check IsArgNegated to return nullopt instead of "0" if -norpcwallet is specified
|
|
if (args.IsArgNegated("-rpcwallet")) return std::nullopt;
|
|
return args.GetArg("-rpcwallet");
|
|
}
|
|
|
|
/** libevent event log callback */
|
|
static void libevent_log_cb(int severity, const char *msg)
|
|
{
|
|
// Ignore everything other than errors
|
|
if (severity >= EVENT_LOG_ERR) {
|
|
throw std::runtime_error(strprintf("libevent error: %s", msg));
|
|
}
|
|
}
|
|
|
|
//
|
|
// Exception thrown on connection error. This error is used to determine
|
|
// when to wait if -rpcwait is given.
|
|
//
|
|
struct CConnectionFailed : std::runtime_error {
|
|
explicit inline CConnectionFailed(const std::string& msg) :
|
|
std::runtime_error(msg)
|
|
{}
|
|
};
|
|
|
|
//
|
|
// This function returns either one of EXIT_ codes when it's expected to stop the process or
|
|
// CONTINUE_EXECUTION when it's expected to continue further.
|
|
//
|
|
static int AppInitRPC(int argc, char* argv[])
|
|
{
|
|
SetupCliArgs(gArgs);
|
|
std::string error;
|
|
if (!gArgs.ParseParameters(argc, argv, error)) {
|
|
tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error);
|
|
return EXIT_FAILURE;
|
|
}
|
|
if (argc < 2 || HelpRequested(gArgs) || gArgs.GetBoolArg("-version", false)) {
|
|
std::string strUsage = CLIENT_NAME " RPC client version " + FormatFullVersion() + "\n";
|
|
|
|
if (gArgs.GetBoolArg("-version", false)) {
|
|
strUsage += FormatParagraph(LicenseInfo());
|
|
} else {
|
|
strUsage += "\n"
|
|
"The bitcoin-cli utility provides a command line interface to interact with a " CLIENT_NAME " RPC server.\n"
|
|
"\nIt can be used to query network information, manage wallets, create or broadcast transactions, and control the " CLIENT_NAME " server.\n"
|
|
"\nUse the \"help\" command to list all commands. Use \"help <command>\" to show help for that command.\n"
|
|
"The -named option allows you to specify parameters using the key=value format, eliminating the need to pass unused positional parameters.\n"
|
|
"\n"
|
|
"Usage: bitcoin-cli [options] <command> [params]\n"
|
|
"or: bitcoin-cli [options] -named <command> [name=value]...\n"
|
|
"or: bitcoin-cli [options] help\n"
|
|
"or: bitcoin-cli [options] help <command>\n"
|
|
"\n";
|
|
strUsage += "\n" + gArgs.GetHelpMessage();
|
|
}
|
|
|
|
tfm::format(std::cout, "%s", strUsage);
|
|
if (argc < 2) {
|
|
tfm::format(std::cerr, "Error: too few parameters\n");
|
|
return EXIT_FAILURE;
|
|
}
|
|
return EXIT_SUCCESS;
|
|
}
|
|
if (!CheckDataDirOption(gArgs)) {
|
|
tfm::format(std::cerr, "Error: Specified data directory \"%s\" does not exist.\n", gArgs.GetArg("-datadir", ""));
|
|
return EXIT_FAILURE;
|
|
}
|
|
if (!gArgs.ReadConfigFiles(error, true)) {
|
|
tfm::format(std::cerr, "Error reading configuration file: %s\n", error);
|
|
return EXIT_FAILURE;
|
|
}
|
|
// Check for chain settings (BaseParams() calls are only valid after this clause)
|
|
try {
|
|
SelectBaseParams(gArgs.GetChainType());
|
|
} catch (const std::exception& e) {
|
|
tfm::format(std::cerr, "Error: %s\n", e.what());
|
|
return EXIT_FAILURE;
|
|
}
|
|
return CONTINUE_EXECUTION;
|
|
}
|
|
|
|
|
|
/** Reply structure for request_done to fill in */
|
|
struct HTTPReply
|
|
{
|
|
HTTPReply() = default;
|
|
|
|
int status{0};
|
|
int error{-1};
|
|
std::string body;
|
|
};
|
|
|
|
static std::string http_errorstring(int code)
|
|
{
|
|
switch(code) {
|
|
case EVREQ_HTTP_TIMEOUT:
|
|
return "timeout reached";
|
|
case EVREQ_HTTP_EOF:
|
|
return "EOF reached";
|
|
case EVREQ_HTTP_INVALID_HEADER:
|
|
return "error while reading header, or invalid header";
|
|
case EVREQ_HTTP_BUFFER_ERROR:
|
|
return "error encountered while reading or writing";
|
|
case EVREQ_HTTP_REQUEST_CANCEL:
|
|
return "request was canceled";
|
|
case EVREQ_HTTP_DATA_TOO_LONG:
|
|
return "response body is larger than allowed";
|
|
default:
|
|
return "unknown";
|
|
}
|
|
}
|
|
|
|
static void http_request_done(struct evhttp_request *req, void *ctx)
|
|
{
|
|
HTTPReply *reply = static_cast<HTTPReply*>(ctx);
|
|
|
|
if (req == nullptr) {
|
|
/* If req is nullptr, it means an error occurred while connecting: the
|
|
* error code will have been passed to http_error_cb.
|
|
*/
|
|
reply->status = 0;
|
|
return;
|
|
}
|
|
|
|
reply->status = evhttp_request_get_response_code(req);
|
|
|
|
struct evbuffer *buf = evhttp_request_get_input_buffer(req);
|
|
if (buf)
|
|
{
|
|
size_t size = evbuffer_get_length(buf);
|
|
const char *data = (const char*)evbuffer_pullup(buf, size);
|
|
if (data)
|
|
reply->body = std::string(data, size);
|
|
evbuffer_drain(buf, size);
|
|
}
|
|
}
|
|
|
|
static void http_error_cb(enum evhttp_request_error err, void *ctx)
|
|
{
|
|
HTTPReply *reply = static_cast<HTTPReply*>(ctx);
|
|
reply->error = err;
|
|
}
|
|
|
|
static int8_t NetworkStringToId(const std::string& str)
|
|
{
|
|
for (size_t i = 0; i < NETWORKS.size(); ++i) {
|
|
if (str == NETWORKS[i]) return i;
|
|
}
|
|
return UNKNOWN_NETWORK;
|
|
}
|
|
|
|
/** Handle the conversion from a command-line to a JSON-RPC request,
|
|
* as well as converting back to a JSON object that can be shown as result.
|
|
*/
|
|
struct BaseRequestHandler {
|
|
virtual ~BaseRequestHandler() = default;
|
|
virtual UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) = 0;
|
|
virtual UniValue ProcessReply(const UniValue &batch_in) = 0;
|
|
};
|
|
|
|
/** Process addrinfo requests */
|
|
struct AddrinfoRequestHandler : BaseRequestHandler {
|
|
UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
|
|
{
|
|
if (!args.empty()) {
|
|
throw std::runtime_error("-addrinfo takes no arguments");
|
|
}
|
|
UniValue params{RPCConvertValues("getnodeaddresses", std::vector<std::string>{{"0"}})};
|
|
return JSONRPCRequestObj("getnodeaddresses", params, 1);
|
|
}
|
|
|
|
UniValue ProcessReply(const UniValue& reply) override
|
|
{
|
|
if (!reply["error"].isNull()) return reply;
|
|
const std::vector<UniValue>& nodes{reply["result"].getValues()};
|
|
if (!nodes.empty() && nodes.at(0)["network"].isNull()) {
|
|
throw std::runtime_error("-addrinfo requires bitcoind server to be running v22.0 and up");
|
|
}
|
|
// Count the number of peers known to our node, by network.
|
|
std::array<uint64_t, NETWORKS.size()> counts{{}};
|
|
for (const UniValue& node : nodes) {
|
|
std::string network_name{node["network"].get_str()};
|
|
const int8_t network_id{NetworkStringToId(network_name)};
|
|
if (network_id == UNKNOWN_NETWORK) continue;
|
|
++counts.at(network_id);
|
|
}
|
|
// Prepare result to return to user.
|
|
UniValue result{UniValue::VOBJ}, addresses{UniValue::VOBJ};
|
|
uint64_t total{0}; // Total address count
|
|
for (size_t i = 1; i < NETWORKS.size() - 1; ++i) {
|
|
addresses.pushKV(NETWORKS[i], counts.at(i));
|
|
total += counts.at(i);
|
|
}
|
|
addresses.pushKV("total", total);
|
|
result.pushKV("addresses_known", std::move(addresses));
|
|
return JSONRPCReplyObj(std::move(result), NullUniValue, /*id=*/1, JSONRPCVersion::V2);
|
|
}
|
|
};
|
|
|
|
/** Process getinfo requests */
|
|
struct GetinfoRequestHandler : BaseRequestHandler {
|
|
const int ID_NETWORKINFO = 0;
|
|
const int ID_BLOCKCHAININFO = 1;
|
|
const int ID_WALLETINFO = 2;
|
|
const int ID_BALANCES = 3;
|
|
|
|
/** Create a simulated `getinfo` request. */
|
|
UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
|
|
{
|
|
if (!args.empty()) {
|
|
throw std::runtime_error("-getinfo takes no arguments");
|
|
}
|
|
UniValue result(UniValue::VARR);
|
|
result.push_back(JSONRPCRequestObj("getnetworkinfo", NullUniValue, ID_NETWORKINFO));
|
|
result.push_back(JSONRPCRequestObj("getblockchaininfo", NullUniValue, ID_BLOCKCHAININFO));
|
|
result.push_back(JSONRPCRequestObj("getwalletinfo", NullUniValue, ID_WALLETINFO));
|
|
result.push_back(JSONRPCRequestObj("getbalances", NullUniValue, ID_BALANCES));
|
|
return result;
|
|
}
|
|
|
|
/** Collect values from the batch and form a simulated `getinfo` reply. */
|
|
UniValue ProcessReply(const UniValue &batch_in) override
|
|
{
|
|
UniValue result(UniValue::VOBJ);
|
|
const std::vector<UniValue> batch = JSONRPCProcessBatchReply(batch_in);
|
|
// Errors in getnetworkinfo() and getblockchaininfo() are fatal, pass them on;
|
|
// getwalletinfo() and getbalances() are allowed to fail if there is no wallet.
|
|
if (!batch[ID_NETWORKINFO]["error"].isNull()) {
|
|
return batch[ID_NETWORKINFO];
|
|
}
|
|
if (!batch[ID_BLOCKCHAININFO]["error"].isNull()) {
|
|
return batch[ID_BLOCKCHAININFO];
|
|
}
|
|
result.pushKV("version", batch[ID_NETWORKINFO]["result"]["version"]);
|
|
result.pushKV("blocks", batch[ID_BLOCKCHAININFO]["result"]["blocks"]);
|
|
result.pushKV("headers", batch[ID_BLOCKCHAININFO]["result"]["headers"]);
|
|
result.pushKV("verificationprogress", batch[ID_BLOCKCHAININFO]["result"]["verificationprogress"]);
|
|
result.pushKV("timeoffset", batch[ID_NETWORKINFO]["result"]["timeoffset"]);
|
|
|
|
UniValue connections(UniValue::VOBJ);
|
|
connections.pushKV("in", batch[ID_NETWORKINFO]["result"]["connections_in"]);
|
|
connections.pushKV("out", batch[ID_NETWORKINFO]["result"]["connections_out"]);
|
|
connections.pushKV("total", batch[ID_NETWORKINFO]["result"]["connections"]);
|
|
result.pushKV("connections", std::move(connections));
|
|
|
|
result.pushKV("networks", batch[ID_NETWORKINFO]["result"]["networks"]);
|
|
result.pushKV("difficulty", batch[ID_BLOCKCHAININFO]["result"]["difficulty"]);
|
|
result.pushKV("chain", UniValue(batch[ID_BLOCKCHAININFO]["result"]["chain"]));
|
|
if (!batch[ID_WALLETINFO]["result"].isNull()) {
|
|
result.pushKV("has_wallet", true);
|
|
result.pushKV("keypoolsize", batch[ID_WALLETINFO]["result"]["keypoolsize"]);
|
|
result.pushKV("walletname", batch[ID_WALLETINFO]["result"]["walletname"]);
|
|
if (!batch[ID_WALLETINFO]["result"]["unlocked_until"].isNull()) {
|
|
result.pushKV("unlocked_until", batch[ID_WALLETINFO]["result"]["unlocked_until"]);
|
|
}
|
|
result.pushKV("paytxfee", batch[ID_WALLETINFO]["result"]["paytxfee"]);
|
|
}
|
|
if (!batch[ID_BALANCES]["result"].isNull()) {
|
|
result.pushKV("balance", batch[ID_BALANCES]["result"]["mine"]["trusted"]);
|
|
}
|
|
result.pushKV("relayfee", batch[ID_NETWORKINFO]["result"]["relayfee"]);
|
|
result.pushKV("warnings", batch[ID_NETWORKINFO]["result"]["warnings"]);
|
|
return JSONRPCReplyObj(std::move(result), NullUniValue, /*id=*/1, JSONRPCVersion::V2);
|
|
}
|
|
};
|
|
|
|
/** Process netinfo requests */
|
|
class NetinfoRequestHandler : public BaseRequestHandler
|
|
{
|
|
private:
|
|
std::array<std::array<uint16_t, NETWORKS.size() + 1>, 3> m_counts{{{}}}; //!< Peer counts by (in/out/total, networks/total)
|
|
uint8_t m_block_relay_peers_count{0};
|
|
uint8_t m_manual_peers_count{0};
|
|
uint8_t m_details_level{0}; //!< Optional user-supplied arg to set dashboard details level
|
|
bool DetailsRequested() const { return m_details_level; }
|
|
bool IsAddressSelected() const { return m_details_level == 2 || m_details_level == 4; }
|
|
bool IsVersionSelected() const { return m_details_level == 3 || m_details_level == 4; }
|
|
bool m_outbound_only_selected{false};
|
|
bool m_is_asmap_on{false};
|
|
size_t m_max_addr_length{0};
|
|
size_t m_max_addr_processed_length{5};
|
|
size_t m_max_addr_rate_limited_length{6};
|
|
size_t m_max_age_length{5};
|
|
size_t m_max_id_length{2};
|
|
size_t m_max_services_length{6};
|
|
struct Peer {
|
|
std::string addr;
|
|
std::string sub_version;
|
|
std::string conn_type;
|
|
std::string network;
|
|
std::string age;
|
|
std::string services;
|
|
std::string transport_protocol_type;
|
|
double min_ping;
|
|
double ping;
|
|
int64_t addr_processed;
|
|
int64_t addr_rate_limited;
|
|
int64_t last_blck;
|
|
int64_t last_recv;
|
|
int64_t last_send;
|
|
int64_t last_trxn;
|
|
int id;
|
|
int mapped_as;
|
|
int version;
|
|
bool is_addr_relay_enabled;
|
|
bool is_bip152_hb_from;
|
|
bool is_bip152_hb_to;
|
|
bool is_outbound;
|
|
bool is_tx_relay;
|
|
bool operator<(const Peer& rhs) const { return std::tie(is_outbound, min_ping) < std::tie(rhs.is_outbound, rhs.min_ping); }
|
|
};
|
|
std::vector<Peer> m_peers;
|
|
std::string ChainToString() const
|
|
{
|
|
switch (gArgs.GetChainType()) {
|
|
case ChainType::TESTNET4:
|
|
return " testnet4";
|
|
case ChainType::TESTNET:
|
|
return " testnet";
|
|
case ChainType::SIGNET:
|
|
return " signet";
|
|
case ChainType::REGTEST:
|
|
return " regtest";
|
|
case ChainType::MAIN:
|
|
return "";
|
|
}
|
|
assert(false);
|
|
}
|
|
std::string PingTimeToString(double seconds) const
|
|
{
|
|
if (seconds < 0) return "";
|
|
const double milliseconds{round(1000 * seconds)};
|
|
return milliseconds > 999999 ? "-" : ToString(milliseconds);
|
|
}
|
|
std::string ConnectionTypeForNetinfo(const std::string& conn_type) const
|
|
{
|
|
if (conn_type == "outbound-full-relay") return "full";
|
|
if (conn_type == "block-relay-only") return "block";
|
|
if (conn_type == "manual" || conn_type == "feeler") return conn_type;
|
|
if (conn_type == "addr-fetch") return "addr";
|
|
if (conn_type == "private-broadcast") return "priv";
|
|
return "";
|
|
}
|
|
std::string FormatServices(const UniValue& services)
|
|
{
|
|
std::string str;
|
|
for (size_t i = 0; i < services.size(); ++i) {
|
|
const std::string s{services[i].get_str()};
|
|
str += s == "NETWORK_LIMITED" ? 'l' : s == "P2P_V2" ? '2' : ToLower(s[0]);
|
|
}
|
|
return str;
|
|
}
|
|
static std::string ServicesList(const UniValue& services)
|
|
{
|
|
std::string str{services.size() ? services[0].get_str() : ""};
|
|
for (size_t i{1}; i < services.size(); ++i) {
|
|
str += ", " + services[i].get_str();
|
|
}
|
|
for (auto& c: str) {
|
|
c = (c == '_' ? ' ' : ToLower(c));
|
|
}
|
|
return str;
|
|
}
|
|
|
|
public:
|
|
static constexpr int ID_PEERINFO = 0;
|
|
static constexpr int ID_NETWORKINFO = 1;
|
|
|
|
UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
|
|
{
|
|
if (!args.empty()) {
|
|
uint8_t n{0};
|
|
if (const auto res{ToIntegral<uint8_t>(args.at(0))}) {
|
|
n = *res;
|
|
m_details_level = std::min(n, NETINFO_MAX_LEVEL);
|
|
} else {
|
|
throw std::runtime_error(strprintf("invalid -netinfo level argument: %s\nFor more information, run: bitcoin-cli -netinfo help", args.at(0)));
|
|
}
|
|
if (args.size() > 1) {
|
|
if (std::string_view s{args.at(1)}; n && (s == "o" || s == "outonly")) {
|
|
m_outbound_only_selected = true;
|
|
} else if (n) {
|
|
throw std::runtime_error(strprintf("invalid -netinfo outonly argument: %s\nFor more information, run: bitcoin-cli -netinfo help", s));
|
|
} else {
|
|
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));
|
|
}
|
|
}
|
|
}
|
|
UniValue result(UniValue::VARR);
|
|
result.push_back(JSONRPCRequestObj("getpeerinfo", NullUniValue, ID_PEERINFO));
|
|
result.push_back(JSONRPCRequestObj("getnetworkinfo", NullUniValue, ID_NETWORKINFO));
|
|
return result;
|
|
}
|
|
|
|
UniValue ProcessReply(const UniValue& batch_in) override
|
|
{
|
|
const std::vector<UniValue> batch{JSONRPCProcessBatchReply(batch_in)};
|
|
if (!batch[ID_PEERINFO]["error"].isNull()) return batch[ID_PEERINFO];
|
|
if (!batch[ID_NETWORKINFO]["error"].isNull()) return batch[ID_NETWORKINFO];
|
|
|
|
const UniValue& networkinfo{batch[ID_NETWORKINFO]["result"]};
|
|
if (networkinfo["version"].getInt<int>() < 209900) {
|
|
throw std::runtime_error("-netinfo requires bitcoind server to be running v0.21.0 and up");
|
|
}
|
|
const int64_t time_now{TicksSinceEpoch<std::chrono::seconds>(CliClock::now())};
|
|
|
|
// Count peer connection totals, and if DetailsRequested(), store peer data in a vector of structs.
|
|
for (const UniValue& peer : batch[ID_PEERINFO]["result"].getValues()) {
|
|
const std::string network{peer["network"].get_str()};
|
|
const int8_t network_id{NetworkStringToId(network)};
|
|
if (network_id == UNKNOWN_NETWORK) continue;
|
|
const bool is_outbound{!peer["inbound"].get_bool()};
|
|
const bool is_tx_relay{peer["relaytxes"].isNull() ? true : peer["relaytxes"].get_bool()};
|
|
const std::string conn_type{peer["connection_type"].get_str()};
|
|
++m_counts.at(is_outbound).at(network_id); // in/out by network
|
|
++m_counts.at(is_outbound).at(NETWORKS.size()); // in/out overall
|
|
++m_counts.at(2).at(network_id); // total by network
|
|
++m_counts.at(2).at(NETWORKS.size()); // total overall
|
|
if (conn_type == "block-relay-only") ++m_block_relay_peers_count;
|
|
if (conn_type == "manual") ++m_manual_peers_count;
|
|
if (m_outbound_only_selected && !is_outbound) continue;
|
|
if (DetailsRequested()) {
|
|
// Push data for this peer to the peers vector.
|
|
const int peer_id{peer["id"].getInt<int>()};
|
|
const int mapped_as{peer["mapped_as"].isNull() ? 0 : peer["mapped_as"].getInt<int>()};
|
|
const int version{peer["version"].getInt<int>()};
|
|
const int64_t addr_processed{peer["addr_processed"].isNull() ? 0 : peer["addr_processed"].getInt<int64_t>()};
|
|
const int64_t addr_rate_limited{peer["addr_rate_limited"].isNull() ? 0 : peer["addr_rate_limited"].getInt<int64_t>()};
|
|
const int64_t conn_time{peer["conntime"].getInt<int64_t>()};
|
|
const int64_t last_blck{peer["last_block"].getInt<int64_t>()};
|
|
const int64_t last_recv{peer["lastrecv"].getInt<int64_t>()};
|
|
const int64_t last_send{peer["lastsend"].getInt<int64_t>()};
|
|
const int64_t last_trxn{peer["last_transaction"].getInt<int64_t>()};
|
|
const double min_ping{peer["minping"].isNull() ? -1 : peer["minping"].get_real()};
|
|
const double ping{peer["pingtime"].isNull() ? -1 : peer["pingtime"].get_real()};
|
|
const std::string addr{peer["addr"].get_str()};
|
|
const std::string age{conn_time == 0 ? "" : ToString((time_now - conn_time) / 60)};
|
|
const std::string services{FormatServices(peer["servicesnames"])};
|
|
const std::string sub_version{peer["subver"].get_str()};
|
|
const std::string transport{peer["transport_protocol_type"].isNull() ? "v1" : peer["transport_protocol_type"].get_str()};
|
|
const bool is_addr_relay_enabled{peer["addr_relay_enabled"].isNull() ? false : peer["addr_relay_enabled"].get_bool()};
|
|
const bool is_bip152_hb_from{peer["bip152_hb_from"].get_bool()};
|
|
const bool is_bip152_hb_to{peer["bip152_hb_to"].get_bool()};
|
|
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});
|
|
m_max_addr_length = std::max(addr.length() + 1, m_max_addr_length);
|
|
m_max_addr_processed_length = std::max(ToString(addr_processed).length(), m_max_addr_processed_length);
|
|
m_max_addr_rate_limited_length = std::max(ToString(addr_rate_limited).length(), m_max_addr_rate_limited_length);
|
|
m_max_age_length = std::max(age.length(), m_max_age_length);
|
|
m_max_id_length = std::max(ToString(peer_id).length(), m_max_id_length);
|
|
m_max_services_length = std::max(services.length(), m_max_services_length);
|
|
m_is_asmap_on |= (mapped_as != 0);
|
|
}
|
|
}
|
|
|
|
// Generate report header.
|
|
const std::string services{DetailsRequested() ? strprintf(" - services %s", FormatServices(networkinfo["localservicesnames"])) : ""};
|
|
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)};
|
|
|
|
// Report detailed peer connections list sorted by direction and minimum ping time.
|
|
if (DetailsRequested() && !m_peers.empty()) {
|
|
std::sort(m_peers.begin(), m_peers.end());
|
|
result += strprintf("<-> type net %*s v mping ping send recv txn blk hb %*s%*s%*s ",
|
|
m_max_services_length, "serv",
|
|
m_max_addr_processed_length, "addrp",
|
|
m_max_addr_rate_limited_length, "addrl",
|
|
m_max_age_length, "age");
|
|
if (m_is_asmap_on) result += " asmap ";
|
|
result += strprintf("%*s %-*s%s\n", m_max_id_length, "id", IsAddressSelected() ? m_max_addr_length : 0, IsAddressSelected() ? "address" : "", IsVersionSelected() ? "version" : "");
|
|
for (const Peer& peer : m_peers) {
|
|
std::string version{ToString(peer.version) + peer.sub_version};
|
|
result += strprintf(
|
|
"%3s %6s %5s %*s %2s%7s%7s%5s%5s%5s%5s %2s %*s%*s%*s%*i %*s %-*s%s\n",
|
|
peer.is_outbound ? "out" : "in",
|
|
ConnectionTypeForNetinfo(peer.conn_type),
|
|
peer.network,
|
|
m_max_services_length, // variable spacing
|
|
peer.services,
|
|
(peer.transport_protocol_type.size() == 2 && peer.transport_protocol_type[0] == 'v') ? peer.transport_protocol_type[1] : ' ',
|
|
PingTimeToString(peer.min_ping),
|
|
PingTimeToString(peer.ping),
|
|
peer.last_send ? ToString(time_now - peer.last_send) : "",
|
|
peer.last_recv ? ToString(time_now - peer.last_recv) : "",
|
|
peer.last_trxn ? ToString((time_now - peer.last_trxn) / 60) : peer.is_tx_relay ? "" : "*",
|
|
peer.last_blck ? ToString((time_now - peer.last_blck) / 60) : "",
|
|
strprintf("%s%s", peer.is_bip152_hb_to ? "." : " ", peer.is_bip152_hb_from ? "*" : " "),
|
|
m_max_addr_processed_length, // variable spacing
|
|
peer.addr_processed ? ToString(peer.addr_processed) : peer.is_addr_relay_enabled ? "" : ".",
|
|
m_max_addr_rate_limited_length, // variable spacing
|
|
peer.addr_rate_limited ? ToString(peer.addr_rate_limited) : "",
|
|
m_max_age_length, // variable spacing
|
|
peer.age,
|
|
m_is_asmap_on ? 7 : 0, // variable spacing
|
|
m_is_asmap_on && peer.mapped_as ? ToString(peer.mapped_as) : "",
|
|
m_max_id_length, // variable spacing
|
|
peer.id,
|
|
IsAddressSelected() ? m_max_addr_length : 0, // variable spacing
|
|
IsAddressSelected() ? peer.addr : "",
|
|
IsVersionSelected() && version != "0" ? version : "");
|
|
}
|
|
result += strprintf(" %*s ms ms sec sec min min %*s\n\n", m_max_services_length, "", m_max_age_length, "min");
|
|
}
|
|
|
|
// Report peer connection totals by type.
|
|
result += " ";
|
|
std::vector<int8_t> reachable_networks;
|
|
for (const UniValue& network : networkinfo["networks"].getValues()) {
|
|
if (network["reachable"].get_bool()) {
|
|
const std::string& network_name{network["name"].get_str()};
|
|
const int8_t network_id{NetworkStringToId(network_name)};
|
|
if (network_id == UNKNOWN_NETWORK) continue;
|
|
result += strprintf("%8s", network_name); // column header
|
|
reachable_networks.push_back(network_id);
|
|
}
|
|
};
|
|
|
|
for (const size_t network_id : UNREACHABLE_NETWORK_IDS) {
|
|
if (m_counts.at(2).at(network_id) == 0) continue;
|
|
result += strprintf("%8s", NETWORK_SHORT_NAMES.at(network_id)); // column header
|
|
reachable_networks.push_back(network_id);
|
|
}
|
|
|
|
result += " total block";
|
|
if (m_manual_peers_count) result += " manual";
|
|
|
|
const std::array rows{"in", "out", "total"};
|
|
for (size_t i = 0; i < rows.size(); ++i) {
|
|
result += strprintf("\n%-5s", rows[i]); // row header
|
|
for (int8_t n : reachable_networks) {
|
|
result += strprintf("%8i", m_counts.at(i).at(n)); // network peers count
|
|
}
|
|
result += strprintf(" %5i", m_counts.at(i).at(NETWORKS.size())); // total peers count
|
|
if (i == 1) { // the outbound row has two extra columns for block relay and manual peer counts
|
|
result += strprintf(" %5i", m_block_relay_peers_count);
|
|
if (m_manual_peers_count) result += strprintf(" %5i", m_manual_peers_count);
|
|
}
|
|
}
|
|
|
|
// Report local services, addresses, ports, and scores.
|
|
if (!DetailsRequested()) {
|
|
result += strprintf("\n\nLocal services: %s", ServicesList(networkinfo["localservicesnames"]));
|
|
}
|
|
result += "\n\nLocal addresses";
|
|
const std::vector<UniValue>& local_addrs{networkinfo["localaddresses"].getValues()};
|
|
if (local_addrs.empty()) {
|
|
result += ": n/a\n";
|
|
} else {
|
|
size_t max_addr_size{0};
|
|
for (const UniValue& addr : local_addrs) {
|
|
max_addr_size = std::max(addr["address"].get_str().length() + 1, max_addr_size);
|
|
}
|
|
for (const UniValue& addr : local_addrs) {
|
|
result += strprintf("\n%-*s port %6i score %6i", max_addr_size, addr["address"].get_str(), addr["port"].getInt<int>(), addr["score"].getInt<int>());
|
|
}
|
|
}
|
|
|
|
return JSONRPCReplyObj(UniValue{result}, NullUniValue, /*id=*/1, JSONRPCVersion::V2);
|
|
}
|
|
|
|
const std::string m_help_doc{
|
|
"-netinfo (level [outonly]) | help\n\n"
|
|
"Returns a network peer connections dashboard with information from the remote server.\n"
|
|
"This human-readable interface will change regularly and is not intended to be a stable API.\n"
|
|
"Under the hood, -netinfo fetches the data by calling getpeerinfo and getnetworkinfo.\n"
|
|
+ strprintf("An optional argument from 0 to %d can be passed for different peers listings; values above %d up to 255 are parsed as %d.\n", NETINFO_MAX_LEVEL, NETINFO_MAX_LEVEL, NETINFO_MAX_LEVEL) +
|
|
"If that argument is passed, an optional additional \"outonly\" argument may be passed to obtain the listing with outbound peers only.\n"
|
|
"Pass \"help\" or \"h\" to see this detailed help documentation.\n"
|
|
"If more than two arguments are passed, only the first two are read and parsed.\n"
|
|
"Suggestion: use -netinfo with the Linux watch(1) command for a live dashboard; see example below.\n\n"
|
|
"Arguments:\n"
|
|
+ strprintf("1. level (integer 0-%d, optional) Specify the info level of the peers dashboard (default 0):\n", NETINFO_MAX_LEVEL) +
|
|
" 0 - Peer counts for each reachable network as well as for block relay peers\n"
|
|
" and manual peers, and the list of local addresses and ports\n"
|
|
" 1 - Like 0 but preceded by a peers listing (without address and version columns)\n"
|
|
" 2 - Like 1 but with an address column\n"
|
|
" 3 - Like 1 but with a version column\n"
|
|
" 4 - Like 1 but with both address and version columns\n"
|
|
"2. outonly (\"outonly\" or \"o\", optional) Return the peers listing with outbound peers only, i.e. to save screen space\n"
|
|
" when a node has many inbound peers. Only valid if a level is passed.\n\n"
|
|
"help (\"help\" or \"h\", optional) Print this help documentation instead of the dashboard.\n\n"
|
|
"Result:\n\n"
|
|
+ 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) +
|
|
" Column Description\n"
|
|
" ------ -----------\n"
|
|
" <-> Direction\n"
|
|
" \"in\" - inbound connections are those initiated by the peer\n"
|
|
" \"out\" - outbound connections are those initiated by us\n"
|
|
" type Type of peer connection\n"
|
|
" \"full\" - full relay, the default\n"
|
|
" \"block\" - block relay; like full relay but does not relay transactions or addresses\n"
|
|
" \"manual\" - peer we manually added using RPC addnode or the -addnode/-connect config options\n"
|
|
" \"feeler\" - short-lived connection for testing addresses\n"
|
|
" \"addr\" - address fetch; short-lived connection for requesting addresses\n"
|
|
" \"priv\" - private broadcast; short-lived connection for broadcasting our transactions\n"
|
|
" net Network the peer connected through (\"ipv4\", \"ipv6\", \"onion\", \"i2p\", \"cjdns\", or \"npr\" (not publicly routable))\n"
|
|
" serv Services offered by the peer\n"
|
|
" \"n\" - NETWORK: peer can serve the full block chain\n"
|
|
" \"b\" - BLOOM: peer can handle bloom-filtered connections (see BIP 111)\n"
|
|
" \"w\" - WITNESS: peer can be asked for blocks and transactions with witness data (SegWit)\n"
|
|
" \"c\" - COMPACT_FILTERS: peer can handle basic block filter requests (see BIPs 157 and 158)\n"
|
|
" \"l\" - NETWORK_LIMITED: peer limited to serving only the last 288 blocks (~2 days)\n"
|
|
" \"2\" - P2P_V2: peer supports version 2 P2P transport protocol, as defined in BIP 324\n"
|
|
" \"u\" - UNKNOWN: unrecognized bit flag\n"
|
|
" v Version of transport protocol used for the connection\n"
|
|
" mping Minimum observed ping time, in milliseconds (ms)\n"
|
|
" ping Last observed ping time, in milliseconds (ms)\n"
|
|
" send Time since last message sent to the peer, in seconds\n"
|
|
" recv Time since last message received from the peer, in seconds\n"
|
|
" txn Time since last novel transaction received from the peer and accepted into our mempool, in minutes\n"
|
|
" \"*\" - we do not relay transactions to this peer (getpeerinfo \"relaytxes\" is false)\n"
|
|
" blk Time since last novel block passing initial validity checks received from the peer, in minutes\n"
|
|
" hb High-bandwidth BIP152 compact block relay\n"
|
|
" \".\" (to) - we selected the peer as a high-bandwidth peer\n"
|
|
" \"*\" (from) - the peer selected us as a high-bandwidth peer\n"
|
|
" addrp Total number of addresses processed, excluding those dropped due to rate limiting\n"
|
|
" \".\" - we do not relay addresses to this peer (getpeerinfo \"addr_relay_enabled\" is false)\n"
|
|
" addrl Total number of addresses dropped due to rate limiting\n"
|
|
" age Duration of connection to the peer, in minutes\n"
|
|
" asmap Mapped AS (Autonomous System) number at the end of the BGP route to the peer, used for diversifying\n"
|
|
" peer selection (only displayed if the -asmap config option is set)\n"
|
|
" id Peer index, in increasing order of peer connections since node startup\n"
|
|
" address IP address and port of the peer\n"
|
|
" version Peer version and subversion concatenated, e.g. \"70016/Satoshi:21.0.0/\"\n\n"
|
|
"* The peer counts table displays the number of peers for each reachable network as well as\n"
|
|
" the number of block relay peers and manual peers.\n\n"
|
|
"* The local addresses table lists each local address broadcast by the node, the port, and the score.\n\n"
|
|
"Examples:\n\n"
|
|
"Peer counts table of reachable networks and list of local addresses\n"
|
|
"> bitcoin-cli -netinfo\n\n"
|
|
"The same, preceded by a peers listing without address and version columns\n"
|
|
"> bitcoin-cli -netinfo 1\n\n"
|
|
"Full dashboard\n"
|
|
+ strprintf("> bitcoin-cli -netinfo %d\n\n", NETINFO_MAX_LEVEL) +
|
|
"Full dashboard, but with outbound peers only\n"
|
|
+ strprintf("> bitcoin-cli -netinfo %d outonly\n\n", NETINFO_MAX_LEVEL) +
|
|
"Full live dashboard, adjust --interval or --no-title as needed (Linux)\n"
|
|
+ strprintf("> watch --interval 1 --no-title bitcoin-cli -netinfo %d\n\n", NETINFO_MAX_LEVEL) +
|
|
"See this help\n"
|
|
"> bitcoin-cli -netinfo help\n"};
|
|
};
|
|
|
|
/** Process RPC generatetoaddress request. */
|
|
class GenerateToAddressRequestHandler : public BaseRequestHandler
|
|
{
|
|
public:
|
|
UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
|
|
{
|
|
address_str = args.at(1);
|
|
UniValue params{RPCConvertValues("generatetoaddress", args)};
|
|
return JSONRPCRequestObj("generatetoaddress", params, 1);
|
|
}
|
|
|
|
UniValue ProcessReply(const UniValue &reply) override
|
|
{
|
|
UniValue result(UniValue::VOBJ);
|
|
result.pushKV("address", address_str);
|
|
result.pushKV("blocks", reply.get_obj()["result"]);
|
|
return JSONRPCReplyObj(std::move(result), NullUniValue, /*id=*/1, JSONRPCVersion::V2);
|
|
}
|
|
protected:
|
|
std::string address_str;
|
|
};
|
|
|
|
/** Process default single requests */
|
|
struct DefaultRequestHandler : BaseRequestHandler {
|
|
UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
|
|
{
|
|
UniValue params;
|
|
if(gArgs.GetBoolArg("-named", DEFAULT_NAMED)) {
|
|
params = RPCConvertNamedValues(method, args);
|
|
} else {
|
|
params = RPCConvertValues(method, args);
|
|
}
|
|
return JSONRPCRequestObj(method, params, 1);
|
|
}
|
|
|
|
UniValue ProcessReply(const UniValue &reply) override
|
|
{
|
|
return reply.get_obj();
|
|
}
|
|
};
|
|
|
|
static UniValue CallRPC(BaseRequestHandler* rh, const std::string& strMethod, const std::vector<std::string>& args, const std::optional<std::string>& rpcwallet = {})
|
|
{
|
|
std::string host;
|
|
// In preference order, we choose the following for the port:
|
|
// 1. -rpcport
|
|
// 2. port in -rpcconnect (ie following : in ipv4 or ]: in ipv6)
|
|
// 3. default port for chain
|
|
uint16_t port{BaseParams().RPCPort()};
|
|
{
|
|
uint16_t rpcconnect_port{0};
|
|
const std::string rpcconnect_str = gArgs.GetArg("-rpcconnect", DEFAULT_RPCCONNECT);
|
|
if (!SplitHostPort(rpcconnect_str, rpcconnect_port, host)) {
|
|
// Uses argument provided as-is
|
|
// (rather than value parsed)
|
|
// to aid the user in troubleshooting
|
|
throw std::runtime_error(strprintf("Invalid port provided in -rpcconnect: %s", rpcconnect_str));
|
|
} else {
|
|
if (rpcconnect_port != 0) {
|
|
// Use the valid port provided in rpcconnect
|
|
port = rpcconnect_port;
|
|
} // else, no port was provided in rpcconnect (continue using default one)
|
|
}
|
|
|
|
if (std::optional<std::string> rpcport_arg = gArgs.GetArg("-rpcport")) {
|
|
// -rpcport was specified
|
|
const uint16_t rpcport_int{ToIntegral<uint16_t>(rpcport_arg.value()).value_or(0)};
|
|
if (rpcport_int == 0) {
|
|
// Uses argument provided as-is
|
|
// (rather than value parsed)
|
|
// to aid the user in troubleshooting
|
|
throw std::runtime_error(strprintf("Invalid port provided in -rpcport: %s", rpcport_arg.value()));
|
|
}
|
|
|
|
// Use the valid port provided
|
|
port = rpcport_int;
|
|
|
|
// If there was a valid port provided in rpcconnect,
|
|
// rpcconnect_port is non-zero.
|
|
if (rpcconnect_port != 0) {
|
|
tfm::format(std::cerr, "Warning: Port specified in both -rpcconnect and -rpcport. Using -rpcport %u\n", port);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Obtain event base
|
|
raii_event_base base = obtain_event_base();
|
|
|
|
// Synchronously look up hostname
|
|
raii_evhttp_connection evcon = obtain_evhttp_connection_base(base.get(), host, port);
|
|
|
|
// Set connection timeout
|
|
{
|
|
const int timeout = gArgs.GetIntArg("-rpcclienttimeout", DEFAULT_HTTP_CLIENT_TIMEOUT);
|
|
if (timeout > 0) {
|
|
evhttp_connection_set_timeout(evcon.get(), timeout);
|
|
} else {
|
|
// Indefinite request timeouts are not possible in libevent-http, so we
|
|
// set the timeout to a very long time period instead.
|
|
|
|
constexpr int YEAR_IN_SECONDS = 31556952; // Average length of year in Gregorian calendar
|
|
evhttp_connection_set_timeout(evcon.get(), 5 * YEAR_IN_SECONDS);
|
|
}
|
|
}
|
|
|
|
HTTPReply response;
|
|
raii_evhttp_request req = obtain_evhttp_request(http_request_done, (void*)&response);
|
|
if (req == nullptr) {
|
|
throw std::runtime_error("create http request failed");
|
|
}
|
|
|
|
evhttp_request_set_error_cb(req.get(), http_error_cb);
|
|
|
|
// Get credentials
|
|
std::string strRPCUserColonPass;
|
|
bool failedToGetAuthCookie = false;
|
|
if (gArgs.GetArg("-rpcpassword", "") == "") {
|
|
// Try fall back to cookie-based authentication if no password is provided
|
|
if (!GetAuthCookie(&strRPCUserColonPass)) {
|
|
failedToGetAuthCookie = true;
|
|
}
|
|
} else {
|
|
strRPCUserColonPass = gArgs.GetArg("-rpcuser", "") + ":" + gArgs.GetArg("-rpcpassword", "");
|
|
}
|
|
|
|
struct evkeyvalq* output_headers = evhttp_request_get_output_headers(req.get());
|
|
assert(output_headers);
|
|
evhttp_add_header(output_headers, "Host", host.c_str());
|
|
evhttp_add_header(output_headers, "Connection", "close");
|
|
evhttp_add_header(output_headers, "Content-Type", "application/json");
|
|
evhttp_add_header(output_headers, "Authorization", (std::string("Basic ") + EncodeBase64(strRPCUserColonPass)).c_str());
|
|
|
|
// Attach request data
|
|
std::string strRequest = rh->PrepareRequest(strMethod, args).write() + "\n";
|
|
struct evbuffer* output_buffer = evhttp_request_get_output_buffer(req.get());
|
|
assert(output_buffer);
|
|
evbuffer_add(output_buffer, strRequest.data(), strRequest.size());
|
|
|
|
// check if we should use a special wallet endpoint
|
|
std::string endpoint = "/";
|
|
if (rpcwallet) {
|
|
char* encodedURI = evhttp_uriencode(rpcwallet->data(), rpcwallet->size(), false);
|
|
if (encodedURI) {
|
|
endpoint = "/wallet/" + std::string(encodedURI);
|
|
free(encodedURI);
|
|
} else {
|
|
throw CConnectionFailed("uri-encode failed");
|
|
}
|
|
}
|
|
int r = evhttp_make_request(evcon.get(), req.release(), EVHTTP_REQ_POST, endpoint.c_str());
|
|
if (r != 0) {
|
|
throw CConnectionFailed("send http request failed");
|
|
}
|
|
|
|
event_base_dispatch(base.get());
|
|
|
|
if (response.status == 0) {
|
|
std::string responseErrorMessage;
|
|
if (response.error != -1) {
|
|
responseErrorMessage = strprintf(" (error code %d - \"%s\")", response.error, http_errorstring(response.error));
|
|
}
|
|
throw CConnectionFailed(strprintf("Could not connect to the server %s:%d%s\n\n"
|
|
"Make sure the bitcoind server is running and that you are connecting to the correct RPC port.\n"
|
|
"Use \"bitcoin-cli -help\" for more info.",
|
|
host, port, responseErrorMessage));
|
|
} else if (response.status == HTTP_UNAUTHORIZED) {
|
|
if (failedToGetAuthCookie) {
|
|
throw std::runtime_error(strprintf(
|
|
"Could not locate RPC credentials. No authentication cookie could be found, and RPC password is not set. See -rpcpassword and -stdinrpcpass. Configuration file: (%s)",
|
|
fs::PathToString(gArgs.GetConfigFilePath())));
|
|
} else {
|
|
throw std::runtime_error("Authorization failed: Incorrect rpcuser or rpcpassword");
|
|
}
|
|
} else if (response.status == HTTP_SERVICE_UNAVAILABLE) {
|
|
throw std::runtime_error(strprintf("Server response: %s", response.body));
|
|
} else if (response.status >= 400 && response.status != HTTP_BAD_REQUEST && response.status != HTTP_NOT_FOUND && response.status != HTTP_INTERNAL_SERVER_ERROR)
|
|
throw std::runtime_error(strprintf("server returned HTTP error %d", response.status));
|
|
else if (response.body.empty())
|
|
throw std::runtime_error("no response from server");
|
|
|
|
// Parse reply
|
|
UniValue valReply(UniValue::VSTR);
|
|
if (!valReply.read(response.body))
|
|
throw std::runtime_error("couldn't parse reply from server");
|
|
UniValue reply = rh->ProcessReply(valReply);
|
|
if (reply.empty())
|
|
throw std::runtime_error("expected reply to have result, error and id properties");
|
|
|
|
return reply;
|
|
}
|
|
|
|
/**
|
|
* ConnectAndCallRPC wraps CallRPC with -rpcwait and an exception handler.
|
|
*
|
|
* @param[in] rh Pointer to RequestHandler.
|
|
* @param[in] strMethod Reference to const string method to forward to CallRPC.
|
|
* @param[in] rpcwallet Reference to const optional string wallet name to forward to CallRPC.
|
|
* @returns the RPC response as a UniValue object.
|
|
* @throws a CConnectionFailed std::runtime_error if connection failed or RPC server still in warmup.
|
|
*/
|
|
static UniValue ConnectAndCallRPC(BaseRequestHandler* rh, const std::string& strMethod, const std::vector<std::string>& args, const std::optional<std::string>& rpcwallet = {})
|
|
{
|
|
UniValue response(UniValue::VOBJ);
|
|
// Execute and handle connection failures with -rpcwait.
|
|
const bool fWait = gArgs.GetBoolArg("-rpcwait", false);
|
|
const int timeout = gArgs.GetIntArg("-rpcwaittimeout", DEFAULT_WAIT_CLIENT_TIMEOUT);
|
|
const auto deadline{std::chrono::steady_clock::now() + 1s * timeout};
|
|
|
|
do {
|
|
try {
|
|
response = CallRPC(rh, strMethod, args, rpcwallet);
|
|
if (fWait) {
|
|
const UniValue& error = response.find_value("error");
|
|
if (!error.isNull() && error["code"].getInt<int>() == RPC_IN_WARMUP) {
|
|
throw CConnectionFailed("server in warmup");
|
|
}
|
|
}
|
|
break; // Connection succeeded, no need to retry.
|
|
} catch (const CConnectionFailed& e) {
|
|
if (fWait && (timeout <= 0 || std::chrono::steady_clock::now() < deadline)) {
|
|
UninterruptibleSleep(1s);
|
|
} else {
|
|
throw CConnectionFailed(strprintf("timeout on transient error: %s", e.what()));
|
|
}
|
|
}
|
|
} while (fWait);
|
|
return response;
|
|
}
|
|
|
|
/** Parse UniValue result to update the message to print to std::cout. */
|
|
static void ParseResult(const UniValue& result, std::string& strPrint)
|
|
{
|
|
if (result.isNull()) return;
|
|
strPrint = result.isStr() ? result.get_str() : result.write(2);
|
|
}
|
|
|
|
/** Parse UniValue error to update the message to print to std::cerr and the code to return. */
|
|
static void ParseError(const UniValue& error, std::string& strPrint, int& nRet)
|
|
{
|
|
if (error.isObject()) {
|
|
const UniValue& err_code = error.find_value("code");
|
|
const UniValue& err_msg = error.find_value("message");
|
|
if (!err_code.isNull()) {
|
|
strPrint = "error code: " + err_code.getValStr() + "\n";
|
|
}
|
|
if (err_msg.isStr()) {
|
|
strPrint += ("error message:\n" + err_msg.get_str());
|
|
}
|
|
if (err_code.isNum() && err_code.getInt<int>() == RPC_WALLET_NOT_SPECIFIED) {
|
|
strPrint += " Or for the CLI, specify the \"-rpcwallet=<walletname>\" option before the command";
|
|
strPrint += " (run \"bitcoin-cli -h\" for help or \"bitcoin-cli listwallets\" to see which wallets are currently loaded).";
|
|
}
|
|
} else {
|
|
strPrint = "error: " + error.write();
|
|
}
|
|
nRet = abs(error["code"].getInt<int>());
|
|
}
|
|
|
|
/**
|
|
* GetWalletBalances calls listwallets; if more than one wallet is loaded, it then
|
|
* fetches mine.trusted balances for each loaded wallet and pushes them to `result`.
|
|
*
|
|
* @param result Reference to UniValue object the wallet names and balances are pushed to.
|
|
*/
|
|
static void GetWalletBalances(UniValue& result)
|
|
{
|
|
DefaultRequestHandler rh;
|
|
const UniValue listwallets = ConnectAndCallRPC(&rh, "listwallets", /* args=*/{});
|
|
if (!listwallets.find_value("error").isNull()) return;
|
|
const UniValue& wallets = listwallets.find_value("result");
|
|
if (wallets.size() <= 1) return;
|
|
|
|
UniValue balances(UniValue::VOBJ);
|
|
for (const UniValue& wallet : wallets.getValues()) {
|
|
const std::string& wallet_name = wallet.get_str();
|
|
const UniValue getbalances = ConnectAndCallRPC(&rh, "getbalances", /* args=*/{}, wallet_name);
|
|
const UniValue& balance = getbalances.find_value("result")["mine"]["trusted"];
|
|
balances.pushKV(wallet_name, balance);
|
|
}
|
|
result.pushKV("balances", std::move(balances));
|
|
}
|
|
|
|
/**
|
|
* GetProgressBar constructs a progress bar with 5% intervals.
|
|
*
|
|
* @param[in] progress The proportion of the progress bar to be filled between 0 and 1.
|
|
* @param[out] progress_bar String representation of the progress bar.
|
|
*/
|
|
static void GetProgressBar(double progress, std::string& progress_bar)
|
|
{
|
|
if (progress < 0 || progress > 1) return;
|
|
|
|
static constexpr double INCREMENT{0.05};
|
|
static const std::string COMPLETE_BAR{"\u2592"};
|
|
static const std::string INCOMPLETE_BAR{"\u2591"};
|
|
|
|
for (int i = 0; i < progress / INCREMENT; ++i) {
|
|
progress_bar += COMPLETE_BAR;
|
|
}
|
|
|
|
for (int i = 0; i < (1 - progress) / INCREMENT; ++i) {
|
|
progress_bar += INCOMPLETE_BAR;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* ParseGetInfoResult takes in -getinfo result in UniValue object and parses it
|
|
* into a user friendly UniValue string to be printed on the console.
|
|
* @param[out] result Reference to UniValue result containing the -getinfo output.
|
|
*/
|
|
static void ParseGetInfoResult(UniValue& result)
|
|
{
|
|
if (!result.find_value("error").isNull()) return;
|
|
|
|
std::string RESET, GREEN, BLUE, YELLOW, MAGENTA, CYAN;
|
|
bool should_colorize = false;
|
|
|
|
#ifndef WIN32
|
|
if (isatty(fileno(stdout))) {
|
|
// By default, only print colored text if OS is not WIN32 and stdout is connected to a terminal.
|
|
should_colorize = true;
|
|
}
|
|
#endif
|
|
|
|
{
|
|
const std::string color{gArgs.GetArg("-color", DEFAULT_COLOR_SETTING)};
|
|
if (color == "always") {
|
|
should_colorize = true;
|
|
} else if (color == "never") {
|
|
should_colorize = false;
|
|
} else if (color != "auto") {
|
|
throw std::runtime_error("Invalid value for -color option. Valid values: always, auto, never.");
|
|
}
|
|
}
|
|
|
|
if (should_colorize) {
|
|
RESET = "\x1B[0m";
|
|
GREEN = "\x1B[32m";
|
|
BLUE = "\x1B[34m";
|
|
YELLOW = "\x1B[33m";
|
|
MAGENTA = "\x1B[35m";
|
|
CYAN = "\x1B[36m";
|
|
}
|
|
|
|
std::string result_string = strprintf("%sChain: %s%s\n", BLUE, result["chain"].getValStr(), RESET);
|
|
result_string += strprintf("Blocks: %s\n", result["blocks"].getValStr());
|
|
result_string += strprintf("Headers: %s\n", result["headers"].getValStr());
|
|
|
|
const double ibd_progress{result["verificationprogress"].get_real()};
|
|
std::string ibd_progress_bar;
|
|
// Display the progress bar only if IBD progress is less than 99%
|
|
if (ibd_progress < 0.99) {
|
|
GetProgressBar(ibd_progress, ibd_progress_bar);
|
|
// Add padding between progress bar and IBD progress
|
|
ibd_progress_bar += " ";
|
|
}
|
|
|
|
result_string += strprintf("Verification progress: %s%.4f%%\n", ibd_progress_bar, ibd_progress * 100);
|
|
result_string += strprintf("Difficulty: %s\n\n", result["difficulty"].getValStr());
|
|
|
|
result_string += strprintf(
|
|
"%sNetwork: in %s, out %s, total %s%s\n",
|
|
GREEN,
|
|
result["connections"]["in"].getValStr(),
|
|
result["connections"]["out"].getValStr(),
|
|
result["connections"]["total"].getValStr(),
|
|
RESET);
|
|
result_string += strprintf("Version: %s\n", result["version"].getValStr());
|
|
result_string += strprintf("Time offset (s): %s\n", result["timeoffset"].getValStr());
|
|
|
|
// proxies
|
|
std::map<std::string, std::vector<std::string>> proxy_networks;
|
|
std::vector<std::string> ordered_proxies;
|
|
|
|
for (const UniValue& network : result["networks"].getValues()) {
|
|
const std::string proxy = network["proxy"].getValStr();
|
|
if (proxy.empty()) continue;
|
|
// Add proxy to ordered_proxy if has not been processed
|
|
if (!proxy_networks.contains(proxy)) ordered_proxies.push_back(proxy);
|
|
|
|
proxy_networks[proxy].push_back(network["name"].getValStr());
|
|
}
|
|
|
|
std::vector<std::string> formatted_proxies;
|
|
formatted_proxies.reserve(ordered_proxies.size());
|
|
for (const std::string& proxy : ordered_proxies) {
|
|
formatted_proxies.emplace_back(strprintf("%s (%s)", proxy, Join(proxy_networks.find(proxy)->second, ", ")));
|
|
}
|
|
result_string += strprintf("Proxies: %s\n", formatted_proxies.empty() ? "n/a" : Join(formatted_proxies, ", "));
|
|
|
|
result_string += strprintf("Min tx relay fee rate (%s/kvB): %s\n\n", CURRENCY_UNIT, result["relayfee"].getValStr());
|
|
|
|
if (!result["has_wallet"].isNull()) {
|
|
const std::string walletname = result["walletname"].getValStr();
|
|
result_string += strprintf("%sWallet: %s%s\n", MAGENTA, walletname.empty() ? "\"\"" : walletname, RESET);
|
|
|
|
result_string += strprintf("Keypool size: %s\n", result["keypoolsize"].getValStr());
|
|
if (!result["unlocked_until"].isNull()) {
|
|
result_string += strprintf("Unlocked until: %s\n", result["unlocked_until"].getValStr());
|
|
}
|
|
result_string += strprintf("Transaction fee rate (-paytxfee) (%s/kvB): %s\n\n", CURRENCY_UNIT, result["paytxfee"].getValStr());
|
|
}
|
|
if (!result["balance"].isNull()) {
|
|
result_string += strprintf("%sBalance:%s %s\n\n", CYAN, RESET, result["balance"].getValStr());
|
|
}
|
|
|
|
if (!result["balances"].isNull()) {
|
|
result_string += strprintf("%sBalances%s\n", CYAN, RESET);
|
|
|
|
size_t max_balance_length{10};
|
|
|
|
for (const std::string& wallet : result["balances"].getKeys()) {
|
|
max_balance_length = std::max(result["balances"][wallet].getValStr().length(), max_balance_length);
|
|
}
|
|
|
|
for (const std::string& wallet : result["balances"].getKeys()) {
|
|
result_string += strprintf("%*s %s\n",
|
|
max_balance_length,
|
|
result["balances"][wallet].getValStr(),
|
|
wallet.empty() ? "\"\"" : wallet);
|
|
}
|
|
result_string += "\n";
|
|
}
|
|
|
|
const std::string warnings{result["warnings"].getValStr()};
|
|
result_string += strprintf("%sWarnings:%s %s", YELLOW, RESET, warnings.empty() ? "(none)" : warnings);
|
|
|
|
result.setStr(result_string);
|
|
}
|
|
|
|
/**
|
|
* Call RPC getnewaddress.
|
|
* @returns getnewaddress response as a UniValue object.
|
|
*/
|
|
static UniValue GetNewAddress()
|
|
{
|
|
DefaultRequestHandler rh;
|
|
return ConnectAndCallRPC(&rh, "getnewaddress", /* args=*/{}, RpcWalletName(gArgs));
|
|
}
|
|
|
|
/**
|
|
* Check bounds and set up args for RPC generatetoaddress params: nblocks, address, maxtries.
|
|
* @param[in] address Reference to const string address to insert into the args.
|
|
* @param args Reference to vector of string args to modify.
|
|
*/
|
|
static void SetGenerateToAddressArgs(const std::string& address, std::vector<std::string>& args)
|
|
{
|
|
if (args.size() > 2) throw std::runtime_error("too many arguments (maximum 2 for nblocks and maxtries)");
|
|
if (args.size() == 0) {
|
|
args.emplace_back(DEFAULT_NBLOCKS);
|
|
} else if (args.at(0) == "0") {
|
|
throw std::runtime_error("the first argument (number of blocks to generate, default: " + DEFAULT_NBLOCKS + ") must be an integer value greater than zero");
|
|
}
|
|
args.emplace(args.begin() + 1, address);
|
|
}
|
|
|
|
static int CommandLineRPC(int argc, char *argv[])
|
|
{
|
|
std::string strPrint;
|
|
int nRet = 0;
|
|
try {
|
|
// Skip switches
|
|
while (argc > 1 && IsSwitchChar(argv[1][0])) {
|
|
argc--;
|
|
argv++;
|
|
}
|
|
std::string rpcPass;
|
|
if (gArgs.GetBoolArg("-stdinrpcpass", false)) {
|
|
NO_STDIN_ECHO();
|
|
if (!StdinReady()) {
|
|
fputs("RPC password> ", stderr);
|
|
fflush(stderr);
|
|
}
|
|
if (!std::getline(std::cin, rpcPass)) {
|
|
throw std::runtime_error("-stdinrpcpass specified but failed to read from standard input");
|
|
}
|
|
if (StdinTerminal()) {
|
|
fputc('\n', stdout);
|
|
}
|
|
gArgs.ForceSetArg("-rpcpassword", rpcPass);
|
|
}
|
|
std::vector<std::string> args = std::vector<std::string>(&argv[1], &argv[argc]);
|
|
if (gArgs.GetBoolArg("-stdinwalletpassphrase", false)) {
|
|
NO_STDIN_ECHO();
|
|
std::string walletPass;
|
|
if (args.size() < 1 || !args[0].starts_with("walletpassphrase")) {
|
|
throw std::runtime_error("-stdinwalletpassphrase is only applicable for walletpassphrase(change)");
|
|
}
|
|
if (!StdinReady()) {
|
|
fputs("Wallet passphrase> ", stderr);
|
|
fflush(stderr);
|
|
}
|
|
if (!std::getline(std::cin, walletPass)) {
|
|
throw std::runtime_error("-stdinwalletpassphrase specified but failed to read from standard input");
|
|
}
|
|
if (StdinTerminal()) {
|
|
fputc('\n', stdout);
|
|
}
|
|
args.insert(args.begin() + 1, walletPass);
|
|
}
|
|
if (gArgs.GetBoolArg("-stdin", false)) {
|
|
// Read one arg per line from stdin and append
|
|
std::string line;
|
|
while (std::getline(std::cin, line)) {
|
|
args.push_back(line);
|
|
}
|
|
if (StdinTerminal()) {
|
|
fputc('\n', stdout);
|
|
}
|
|
}
|
|
gArgs.CheckMultipleCLIArgs();
|
|
std::unique_ptr<BaseRequestHandler> rh;
|
|
std::string method;
|
|
if (gArgs.GetBoolArg("-getinfo", false)) {
|
|
rh.reset(new GetinfoRequestHandler());
|
|
} else if (gArgs.GetBoolArg("-netinfo", false)) {
|
|
if (!args.empty() && (args.at(0) == "h" || args.at(0) == "help")) {
|
|
tfm::format(std::cout, "%s\n", NetinfoRequestHandler().m_help_doc);
|
|
return 0;
|
|
}
|
|
rh.reset(new NetinfoRequestHandler());
|
|
} else if (gArgs.GetBoolArg("-generate", false)) {
|
|
const UniValue getnewaddress{GetNewAddress()};
|
|
const UniValue& error{getnewaddress.find_value("error")};
|
|
if (error.isNull()) {
|
|
SetGenerateToAddressArgs(getnewaddress.find_value("result").get_str(), args);
|
|
rh.reset(new GenerateToAddressRequestHandler());
|
|
} else {
|
|
ParseError(error, strPrint, nRet);
|
|
}
|
|
} else if (gArgs.GetBoolArg("-addrinfo", false)) {
|
|
rh.reset(new AddrinfoRequestHandler());
|
|
} else {
|
|
rh.reset(new DefaultRequestHandler());
|
|
if (args.size() < 1) {
|
|
throw std::runtime_error("too few parameters (need at least command)");
|
|
}
|
|
method = args[0];
|
|
args.erase(args.begin()); // Remove trailing method name from arguments vector
|
|
}
|
|
if (nRet == 0) {
|
|
// Perform RPC call
|
|
const std::optional<std::string> wallet_name{RpcWalletName(gArgs)};
|
|
const UniValue reply = ConnectAndCallRPC(rh.get(), method, args, wallet_name);
|
|
|
|
// Parse reply
|
|
UniValue result = reply.find_value("result");
|
|
const UniValue& error = reply.find_value("error");
|
|
if (error.isNull()) {
|
|
if (gArgs.GetBoolArg("-getinfo", false)) {
|
|
if (!wallet_name) {
|
|
GetWalletBalances(result); // fetch multiwallet balances and append to result
|
|
}
|
|
ParseGetInfoResult(result);
|
|
}
|
|
|
|
ParseResult(result, strPrint);
|
|
} else {
|
|
ParseError(error, strPrint, nRet);
|
|
}
|
|
}
|
|
} catch (const std::exception& e) {
|
|
strPrint = std::string("error: ") + e.what();
|
|
nRet = EXIT_FAILURE;
|
|
} catch (...) {
|
|
PrintExceptionContinue(nullptr, "CommandLineRPC()");
|
|
throw;
|
|
}
|
|
|
|
if (strPrint != "") {
|
|
tfm::format(nRet == 0 ? std::cout : std::cerr, "%s\n", strPrint);
|
|
}
|
|
return nRet;
|
|
}
|
|
|
|
MAIN_FUNCTION
|
|
{
|
|
SetupEnvironment();
|
|
if (!SetupNetworking()) {
|
|
tfm::format(std::cerr, "Error: Initializing networking failed\n");
|
|
return EXIT_FAILURE;
|
|
}
|
|
event_set_log_callback(&libevent_log_cb);
|
|
|
|
try {
|
|
int ret = AppInitRPC(argc, argv);
|
|
if (ret != CONTINUE_EXECUTION)
|
|
return ret;
|
|
}
|
|
catch (const std::exception& e) {
|
|
PrintExceptionContinue(&e, "AppInitRPC()");
|
|
return EXIT_FAILURE;
|
|
} catch (...) {
|
|
PrintExceptionContinue(nullptr, "AppInitRPC()");
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
int ret = EXIT_FAILURE;
|
|
try {
|
|
ret = CommandLineRPC(argc, argv);
|
|
}
|
|
catch (const std::exception& e) {
|
|
PrintExceptionContinue(&e, "CommandLineRPC()");
|
|
} catch (...) {
|
|
PrintExceptionContinue(nullptr, "CommandLineRPC()");
|
|
}
|
|
return ret;
|
|
}
|