10 #include <chainparams.h> 30 #include <validation.h> 41 "outbound-full-relay (default automatic connections)",
42 "block-relay-only (does not relay transactions or addresses)",
43 "inbound (initiated by the peer)",
44 "manual (added via addnode RPC or -addnode/-connect configuration options)",
45 "addr-fetch (short-lived automatic connection for soliciting addresses)",
46 "feeler (short-lived automatic connection for testing addresses)" 50 "detecting (peer could be v1 or v2)",
51 "v1 (plaintext transport protocol)",
52 "v2 (BIP324 encrypted transport protocol)" 58 "\nReturns the number of connections to other nodes.\n",
80 "\nRequests that a ping be sent to all other nodes, to measure ping time.\n" 81 "Results provided in getpeerinfo, pingtime and pingwait fields are decimal seconds.\n" 82 "Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.\n",
105 "Returns data about each connected network peer as a json array of objects.",
115 {
RPCResult::Type::STR,
"addrbind",
true,
"(ip:port) Bind address of the connection to the peer"},
118 {
RPCResult::Type::NUM,
"mapped_as",
true,
"The AS in the BGP route to the peer used for diversifying\n" 119 "peer selection (only available if the asmap config flag is set)"},
135 {
RPCResult::Type::NUM,
"minping",
true,
"The minimum observed ping time in milliseconds (ms), if any"},
136 {
RPCResult::Type::NUM,
"pingwait",
true,
"The duration in milliseconds (ms) of an outstanding ping (if non-zero)"},
140 {
RPCResult::Type::BOOL,
"bip152_hb_to",
"Whether we selected peer as (compact blocks) high-bandwidth peer"},
141 {
RPCResult::Type::BOOL,
"bip152_hb_from",
"Whether peer selected us as (compact blocks) high-bandwidth peer"},
143 {
RPCResult::Type::NUM,
"presynced_headers",
"The current height of header pre-synchronization with this peer, or -1 if no low-work sync is in progress"},
150 {
RPCResult::Type::BOOL,
"addr_relay_enabled",
"Whether we participate in address relay with this peer"},
151 {
RPCResult::Type::NUM,
"addr_processed",
"The total number of addresses processed, excluding those dropped due to rate limiting"},
152 {
RPCResult::Type::NUM,
"addr_rate_limited",
"The total number of addresses dropped due to rate limiting"},
153 {
RPCResult::Type::ARR,
"permissions",
"Any special permissions that have been granted to this peer",
157 {
RPCResult::Type::NUM,
"minfeefilter",
"The minimum fee rate for transactions this peer accepts"},
161 "When a message type is not listed in this json object, the bytes sent are 0.\n" 162 "Only known message types can appear as keys in the object."}
167 "When a message type is not listed in this json object, the bytes received are 0.\n" 168 "Only known message types can appear as keys in the object and all bytes received\n" 172 "Please note this output is unlikely to be stable in upcoming releases as we iterate to\n" 173 "best capture connection behaviors."},
175 {
RPCResult::Type::STR,
"session_id",
"The session ID for this connection, or \"\" if there is none (\"v2\" transport protocol only).\n"},
189 std::vector<CNodeStats> vstats;
206 obj.
pushKV(
"id", stats.nodeid);
207 obj.
pushKV(
"addr", stats.m_addr_name);
208 if (stats.addrBind.IsValid()) {
209 obj.
pushKV(
"addrbind", stats.addrBind.ToStringAddrPort());
211 if (!(stats.addrLocal.empty())) {
212 obj.
pushKV(
"addrlocal", stats.addrLocal);
215 if (stats.m_mapped_as != 0) {
216 obj.
pushKV(
"mapped_as", uint64_t(stats.m_mapped_as));
226 obj.
pushKV(
"bytessent", stats.nSendBytes);
227 obj.
pushKV(
"bytesrecv", stats.nRecvBytes);
229 obj.
pushKV(
"timeoffset", stats.nTimeOffset);
230 if (stats.m_last_ping_time > 0us) {
231 obj.
pushKV(
"pingtime", Ticks<SecondsDouble>(stats.m_last_ping_time));
233 if (stats.m_min_ping_time < std::chrono::microseconds::max()) {
234 obj.
pushKV(
"minping", Ticks<SecondsDouble>(stats.m_min_ping_time));
239 obj.
pushKV(
"version", stats.nVersion);
243 obj.
pushKV(
"subver", stats.cleanSubVer);
244 obj.
pushKV(
"inbound", stats.fInbound);
245 obj.
pushKV(
"bip152_hb_to", stats.m_bip152_highbandwidth_to);
246 obj.
pushKV(
"bip152_hb_from", stats.m_bip152_highbandwidth_from);
255 obj.
pushKV(
"inflight", heights);
263 obj.
pushKV(
"permissions", permissions);
267 for (
const auto& i : stats.mapSendBytesPerMsgType) {
269 sendPerMsgType.
pushKV(i.first, i.second);
271 obj.
pushKV(
"bytessent_per_msg", sendPerMsgType);
274 for (
const auto& i : stats.mapRecvBytesPerMsgType) {
276 recvPerMsgType.
pushKV(i.first, i.second);
278 obj.
pushKV(
"bytesrecv_per_msg", recvPerMsgType);
281 obj.
pushKV(
"session_id", stats.m_session_id);
294 "\nAttempts to add or remove a node from the addnode list.\n" 295 "Or try a connection to a node once.\n" 296 "Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be\n" 297 "full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).\n" +
299 " and are counted separately from the -maxconnections limit.\n",
308 +
HelpExampleRpc(
"addnode",
"\"192.168.0.6:8333\", \"onetry\" true")
312 const std::string
command{request.params[1].get_str()};
314 throw std::runtime_error(
321 const std::string node_arg{request.params[0].get_str()};
322 bool use_v2transport =
self.Arg<
bool>(2);
324 if (use_v2transport && !(
node.connman->GetLocalServices() &
NODE_P2P_V2)) {
337 if (!connman.
AddNode({node_arg, use_v2transport})) {
356 "\nOpen an outbound connection to a specified node. This RPC is for testing only.\n",
368 HelpExampleCli(
"addconnection",
"\"192.168.0.6:8333\" \"outbound-full-relay\"")
369 +
HelpExampleRpc(
"addconnection",
"\"192.168.0.6:8333\" \"outbound-full-relay\"")
374 throw std::runtime_error(
"addconnection is for regression testing (-regtest mode) only.");
377 const std::string address = request.params[0].get_str();
378 const std::string conn_type_in{
TrimString(request.params[1].get_str())};
380 if (conn_type_in ==
"outbound-full-relay") {
382 }
else if (conn_type_in ==
"block-relay-only") {
384 }
else if (conn_type_in ==
"addr-fetch") {
386 }
else if (conn_type_in ==
"feeler") {
395 const bool success = connman.
AddConnection(address, conn_type);
401 info.
pushKV(
"address", address);
402 info.
pushKV(
"connection_type", conn_type_in);
412 "\nImmediately disconnects from the specified peer node.\n" 413 "\nStrictly one out of 'address' and 'nodeid' can be provided to identify the node.\n" 414 "\nTo disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.\n",
432 const UniValue &address_arg = request.params[0];
433 const UniValue &id_arg = request.params[1];
458 "\nReturns information about the given added node, or all added nodes\n" 459 "(note that onetry addnodes are not listed here)\n",
492 if (!request.params[0].isNull()) {
495 if (info.m_params.m_added_node == request.params[0].get_str()) {
496 vInfo.assign(1, info);
510 obj.
pushKV(
"addednode", info.m_params.m_added_node);
511 obj.
pushKV(
"connected", info.fConnected);
513 if (info.fConnected) {
515 address.
pushKV(
"address", info.resolvedAddress.ToStringAddrPort());
516 address.
pushKV(
"connected", info.fInbound ?
"inbound" :
"outbound");
519 obj.
pushKV(
"addresses", addresses);
531 "Returns information about network traffic, including bytes in, bytes out,\n" 532 "and current system time.",
563 obj.
pushKV(
"timemillis", TicksSinceEpoch<std::chrono::milliseconds>(SystemClock::now()));
572 obj.
pushKV(
"uploadtarget", outboundLimit);
581 for (
int n = 0; n <
NET_MAX; ++n) {
600 "Returns an object containing various state info regarding P2P networking.\n",
609 {
RPCResult::Type::ARR,
"localservicesnames",
"the services we offer to the network, in human-readable form",
626 {
RPCResult::Type::STR,
"proxy",
"(\"host:port\") the proxy that is used for this network, or empty if none"},
662 obj.
pushKV(
"localrelay", !
node.peerman->IgnoresIncomingTxs());
666 obj.
pushKV(
"networkactive",
node.connman->GetNetworkActive());
680 for (
const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)
683 rec.
pushKV(
"address", item.first.ToStringAddr());
684 rec.
pushKV(
"port", item.second.nPort);
685 rec.
pushKV(
"score", item.second.nScore);
689 obj.
pushKV(
"localaddresses", localAddresses);
699 "\nAttempts to add or remove an IP/Subnet from the banned list.\n",
703 {
"bantime",
RPCArg::Type::NUM,
RPCArg::Default{0},
"time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument)"},
714 std::string strCommand;
715 if (!request.params[1].isNull())
716 strCommand = request.params[1].
get_str();
717 if (strCommand !=
"add" && strCommand !=
"remove") {
725 bool isSubnet =
false;
727 if (request.params[0].get_str().find(
'/') != std::string::npos)
731 const std::optional<CNetAddr> addr{
LookupHost(request.params[0].get_str(),
false)};
732 if (addr.has_value()) {
742 if (strCommand ==
"add")
749 if (!request.params[2].isNull())
750 banTime = request.params[2].getInt<int64_t>();
752 const bool absolute{request.params[3].isNull() ? false : request.params[3].get_bool()};
761 node.connman->DisconnectNode(subNet);
766 node.connman->DisconnectNode(netAddr);
770 else if(strCommand ==
"remove")
772 if (!( isSubnet ? banman.
Unban(subNet) : banman.
Unban(netAddr) )) {
784 "\nList all manually banned IPs/Subnets.\n",
807 const int64_t current_time{
GetTime()};
810 for (
const auto& entry : banMap)
812 const CBanEntry& banEntry = entry.second;
814 rec.
pushKV(
"address", entry.first.ToString());
823 return bannedAddresses;
831 "\nClear all banned IPs.\n",
852 "\nDisable/enable all p2p network activity.\n",
873 "Return known addresses, after filtering for quality and recency.\n" 874 "These can potentially be used to find new peers in the network.\n" 875 "The total number of addresses known to the node may be higher.",
896 +
HelpExampleCli(
"-named getnodeaddresses",
"network=onion count=12")
905 const int count{request.params[0].isNull() ? 1 : request.params[0].getInt<
int>()};
908 const std::optional<Network> network{request.params[1].isNull() ? std::nullopt : std::optional<Network>{
ParseNetwork(request.params[1].get_str())}};
917 for (
const CAddress& addr : vAddr) {
919 obj.
pushKV(
"time", int64_t{TicksSinceEpoch<std::chrono::seconds>(addr.nTime)});
920 obj.
pushKV(
"services", (uint64_t)addr.nServices);
921 obj.
pushKV(
"address", addr.ToStringAddr());
922 obj.
pushKV(
"port", addr.GetPort());
934 "\nAdd the address of a potential peer to the address manager. This RPC is for testing only.\n",
943 {
RPCResult::Type::BOOL,
"success",
"whether the peer address was successfully added to the address manager"},
954 const std::string& addr_string{request.params[0].get_str()};
955 const auto port{request.params[1].getInt<uint16_t>()};
956 const bool tried{request.params[2].isNull() ? false : request.params[2].get_bool()};
959 std::optional<CNetAddr> net_addr{
LookupHost(addr_string,
false)};
962 if (net_addr.has_value()) {
963 CService service{net_addr.value(), port};
965 address.nTime = Now<NodeSeconds>();
968 if (addrman.
Add({address}, address)) {
972 addrman.
Good(address);
977 obj.
pushKV(
"success", success);
987 "Send a p2p message to a peer specified by id.\n" 988 "The message type and body must be provided, the message header will be generated.\n" 989 "This RPC is for testing only.",
999 const NodeId peer_id{request.params[0].
getInt<int64_t>()};
1000 const std::string& msg_type{request.params[1].get_str()};
1004 auto msg{TryParseHex<unsigned char>(request.params[2].get_str())};
1005 if (!
msg.has_value()) {
1014 msg_ser.
m_type = msg_type;
1035 "\nProvides information about the node's address manager by returning the number of " 1036 "addresses in the `new` and `tried` tables and their sum for all networks.\n",
1041 {
RPCResult::Type::NUM,
"new",
"number of addresses in the new table, which represent potential peers the node has discovered but hasn't yet successfully connected to."},
1042 {
RPCResult::Type::NUM,
"tried",
"number of addresses in the tried table, which represent peers the node has successfully connected to in the past."},
1051 for (
int n = 0; n <
NET_MAX; ++n) {
1055 obj.
pushKV(
"new", addrman.
Size(network,
true));
1056 obj.
pushKV(
"tried", addrman.
Size(network,
false));
1061 obj.
pushKV(
"new", addrman.
Size(std::nullopt,
true));
1062 obj.
pushKV(
"tried", addrman.
Size(std::nullopt,
false));
1064 ret.pushKV(
"all_networks", obj);
1076 ret.pushKV(
"time", int64_t{TicksSinceEpoch<std::chrono::seconds>(info.
nTime)});
1086 for (
const auto& e : tableInfos) {
1089 std::ostringstream key;
1102 "EXPERIMENTAL warning: this call may be changed in future releases.\n" 1103 "\nReturns information on all address manager entries for the new and tried tables.\n",
1108 {
RPCResult::Type::OBJ,
"bucket/position",
"the location in the address manager table (<bucket>/<position>)", {
1157 for (
const auto& c : commands) {
1158 t.appendCommand(c.name, &c);
bool RemoveAddedNode(const std::string &node) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
size_t Size(std::optional< Network > net=std::nullopt, std::optional< bool > in_new=std::nullopt) const
Return size information about addrman.
void push_back(UniValue val)
AddrFetch connections are short lived connections used to solicit addresses from peers.
void Ban(const CNetAddr &net_addr, int64_t ban_time_offset=0, bool since_unix_epoch=false)
Node has not been added before.
static RPCHelpMan sendmsgtopeer()
const std::vector< std::string > NET_PERMISSIONS_DOC
ServiceFlags
nServices flags
static RPCHelpMan clearbanned()
UniValue AddrmanTableToJSON(const std::vector< std::pair< AddrInfo, AddressPosition >> &tableInfos)
A set of addresses that represent the hash of a string or FQDN.
Max number of outbound or block-relay connections already open.
Dummy value to indicate the number of NET_* constants.
uint64_t m_addr_rate_limited
bool OutboundTargetReached(bool historicalBlockServingLimit) const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
check if the outbound target is reached if param historicalBlockServingLimit is set true...
Feeler connections are short-lived connections made to check that a node is alive.
bool randomize_credentials
const std::string NET_MESSAGE_TYPE_OTHER
std::vector< unsigned char > data
UniValue GetServicesNames(ServiceFlags services)
Returns, given services flags, a list of humanly readable (known) network services.
uint64_t GetTotalBytesRecv() const
bool GetProxy(enum Network net, Proxy &proxyInfoOut)
void RegisterNetRPCCommands(CRPCTable &t)
static UniValue GetNetworksInfo()
static RPCHelpMan addpeeraddress()
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
const std::string & get_str() const
void pushKVEnd(std::string key, UniValue val)
static RPCHelpMan getaddrmaninfo()
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
CService MaybeFlipIPv6toCJDNS(const CService &service)
If an IPv6 address belongs to the address range used by the CJDNS network and the CJDNS network is re...
int64_t GetTimeOffset()
"Never go to sea with two chronometers; take one or three." Our three time sources are: ...
Network GetNetClass() const
static RPCHelpMan getnettotals()
These are the default connections that we use to connect with the network.
std::vector< CAddress > GetAddresses(size_t max_addresses, size_t max_pct, std::optional< Network > network) const
Return all or many randomly selected addresses, optionally by network.
void GetNodeStats(std::vector< CNodeStats > &vstats) const
std::string ToString() const
std::string ToStringAddrPort() const
AddrMan & EnsureAnyAddrman(const std::any &context)
uint64_t GetMaxOutboundTarget() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Invalid, missing or duplicate parameter.
Stochastic address manager.
bool ForNode(NodeId id, std::function< bool(CNode *pnode)> func)
std::string ToStringAddr() const
bool DisconnectNode(const std::string &node)
std::string TransportTypeAsString(TransportProtocolType transport_type)
Convert TransportProtocolType enum to a string value.
static RPCHelpMan getpeerinfo()
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Special type that is a STR with only hex chars.
NodeContext struct containing references to chain state and connection state.
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
CAmount m_fee_filter_received
UniValue JSONRPCError(int code, const std::string &message)
static RPCHelpMan getnodeaddresses()
bool Add(const std::vector< CAddress > &vAddr, const CNetAddr &source, std::chrono::seconds time_penalty=0s)
Attempt to add one or more addresses to addrman's new table.
Special string with only hex chars.
uint64_t m_addr_processed
std::vector< AddedNodeInfo > GetAddedNodeInfo() const EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
We open manual connections to addresses that users explicitly requested via the addnode RPC or the -a...
std::vector< CNetAddr > LookupHost(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
std::string ConnectionTypeAsString(ConnectionType conn_type)
Convert ConnectionType enum to a string value.
A combination of a network address (CNetAddr) and a (TCP) port.
Extended statistics about a CAddress.
void OpenNetworkConnection(const CAddress &addrConnect, bool fCountFailure, CSemaphoreGrant &&grant_outbound, const char *strDest, ConnectionType conn_type, bool use_v2transport) EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex)
static RPCHelpMan disconnectnode()
bool AddConnection(const std::string &address, ConnectionType conn_type) EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex)
Attempts to open a connection.
A CService with information about it as peer.
const std::string CURRENCY_UNIT
static RPCHelpMan setban()
static RPCHelpMan addnode()
General application defined errors.
std::string DefaultHint
Hint for default value.
void SetNetworkActive(bool active)
bool GetNetworkActive() const
NodeSeconds nTime
Always included in serialization. The behavior is unspecified if the value is not representable as ui...
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
std::string strSubVersion
Subversion as sent to the P2P network in version messages.
Special numeric to denote unix epoch time.
static RPCHelpMan setnetworkactive()
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
void GetBanned(banmap_t &banmap)
constexpr int64_t count_seconds(std::chrono::seconds t)
std::chrono::microseconds m_ping_wait
enum Network ParseNetwork(const std::string &net_in)
const std::vector< std::string > CONNECTION_TYPE_DOC
CNetAddr source
where knowledge about this address first came from
std::chrono::seconds GetMaxOutboundTimeLeftInCycle() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
ServiceFlags their_services
size_t GetNodeCount(ConnectionDirection) const
ServiceFlags nServices
Serialized as uint64_t in V1, and as CompactSize in V2.
ChainType GetChainType() const
Return the chain type.
bilingual_str GetWarnings(bool verbose)
Format a string that describes several potential problems detected by the core.
virtual bool GetNodeStateStats(NodeId nodeid, CNodeStateStats &stats) const =0
Get statistics from node state.
bool Unban(const CNetAddr &net_addr)
void PushMessage(CNode *pnode, CSerializedNetMsg &&msg) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
virtual void SendPings()=0
Send ping message to all peers.
uint64_t GetTotalBytesSent() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
const CChainParams & Params()
Return the currently selected parameters.
void pushKV(std::string key, UniValue val)
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
static const int PROTOCOL_VERSION
network protocol versioning
GlobalMutex g_maplocalhost_mutex
UniValue AddrmanEntryToJSON(const AddrInfo &info)
BanMan & EnsureAnyBanman(const std::any &context)
static RPCHelpMan getnetworkinfo()
Node to disconnect not found in connected nodes.
std::chrono::seconds GetMaxOutboundTimeframe() const
UniValue ValueFromAmount(const CAmount amount)
static RPCHelpMan getaddednodeinfo()
bool LookupSubNet(const std::string &subnet_str, CSubNet &subnet_out)
Parse and resolve a specified subnet string into the appropriate internal representation.
bool AddNode(const AddedNodeParams &add) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
ConnectionType
Different types of connections to a peer.
PeerManager & EnsurePeerman(const NodeContext &node)
static RPCHelpMan getconnectioncount()
std::map< CSubNet, CBanEntry > banmap_t
const std::vector< std::string > TRANSPORT_TYPE_DOC
bool IsBanned(const CNetAddr &net_addr)
Return whether net_addr is banned.
static RPCHelpMan listbanned()
Location information for an address in AddrMan.
std::string GetNetworkName(enum Network net)
Information about a peer.
std::vector< int > vHeightInFlight
Special dictionary with keys that are not literals.
bool Good(const CService &addr, NodeSeconds time=Now< NodeSeconds >())
Mark an address record as accessible and attempt to move it to addrman's tried table.
int64_t GetTime()
DEPRECATED, see GetTime.
std::string TrimString(std::string_view str, std::string_view pattern=" \\\)
static const int CLIENT_VERSION
bitcoind-res.rc includes this file, but it cannot cope with real c++ code.
static path absolute(const path &p)
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate...
std::vector< std::pair< AddrInfo, AddressPosition > > GetEntries(bool from_tried) const
Returns an information-location pair for all addresses in the selected addrman table.
bool m_addr_relay_enabled
uint64_t GetOutboundTargetBytesLeft() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
response the bytes left in the current max outbound cycle in case of no limit, it will always respons...
NodeContext & EnsureAnyNodeContext(const std::any &context)
We use block-relay-only connections to help prevent against partition attacks.
CConnman & EnsureConnman(const NodeContext &node)
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency...
ReachableNets g_reachable_nets
static std::vector< std::string > ToStrings(NetPermissionFlags flags)
static RPCHelpMan addconnection()
BanMan & EnsureBanman(const NodeContext &node)
static RPCHelpMan getrawaddrman()
Addresses from these networks are not publicly routable on the global Internet.