Bitcoin Core 30.99.0
P2P Digital Currency
net.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#include <rpc/server.h>
6
7#include <addrman.h>
8#include <addrman_impl.h>
9#include <banman.h>
10#include <chainparams.h>
11#include <clientversion.h>
12#include <core_io.h>
13#include <net_permissions.h>
14#include <net_processing.h>
15#include <net_types.h>
16#include <netbase.h>
17#include <node/context.h>
19#include <node/warnings.h>
20#include <policy/settings.h>
21#include <protocol.h>
22#include <rpc/blockchain.h>
23#include <rpc/protocol.h>
24#include <rpc/server_util.h>
25#include <rpc/util.h>
26#include <sync.h>
27#include <univalue.h>
28#include <util/chaintype.h>
29#include <util/strencodings.h>
30#include <util/string.h>
31#include <util/time.h>
32#include <util/translation.h>
33#include <validation.h>
34
35#include <chrono>
36#include <optional>
37#include <stdexcept>
38#include <string>
39#include <string_view>
40#include <vector>
41
43using util::Join;
44
45const std::vector<std::string> CONNECTION_TYPE_DOC{
46 "outbound-full-relay (default automatic connections)",
47 "block-relay-only (does not relay transactions or addresses)",
48 "inbound (initiated by the peer)",
49 "manual (added via addnode RPC or -addnode/-connect configuration options)",
50 "addr-fetch (short-lived automatic connection for soliciting addresses)",
51 "feeler (short-lived automatic connection for testing addresses)"
52};
53
54const std::vector<std::string> TRANSPORT_TYPE_DOC{
55 "detecting (peer could be v1 or v2)",
56 "v1 (plaintext transport protocol)",
57 "v2 (BIP324 encrypted transport protocol)"
58};
59
61{
62 return RPCHelpMan{
63 "getconnectioncount",
64 "Returns the number of connections to other nodes.\n",
65 {},
67 RPCResult::Type::NUM, "", "The connection count"
68 },
70 HelpExampleCli("getconnectioncount", "")
71 + HelpExampleRpc("getconnectioncount", "")
72 },
73 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
74{
75 NodeContext& node = EnsureAnyNodeContext(request.context);
76 const CConnman& connman = EnsureConnman(node);
77
79},
80 };
81}
82
84{
85 return RPCHelpMan{
86 "ping",
87 "Requests that a ping be sent to all other nodes, to measure ping time.\n"
88 "Results are provided in getpeerinfo.\n"
89 "Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.\n",
90 {},
93 HelpExampleCli("ping", "")
94 + HelpExampleRpc("ping", "")
95 },
96 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
97{
98 NodeContext& node = EnsureAnyNodeContext(request.context);
99 PeerManager& peerman = EnsurePeerman(node);
100
101 // Request that each node send a ping during next message processing pass
102 peerman.SendPings();
103 return UniValue::VNULL;
104},
105 };
106}
107
110{
111 UniValue servicesNames(UniValue::VARR);
112
113 for (const auto& flag : serviceFlagsToStr(services)) {
114 servicesNames.push_back(flag);
115 }
116
117 return servicesNames;
118}
119
121{
122 return RPCHelpMan{
123 "getpeerinfo",
124 "Returns data about each connected network peer as a json array of objects.",
125 {},
126 RPCResult{
127 RPCResult::Type::ARR, "", "",
128 {
129 {RPCResult::Type::OBJ, "", "",
130 {
131 {
132 {RPCResult::Type::NUM, "id", "Peer index"},
133 {RPCResult::Type::STR, "addr", "(host:port) The IP address/hostname optionally followed by :port of the peer"},
134 {RPCResult::Type::STR, "addrbind", /*optional=*/true, "(ip:port) Bind address of the connection to the peer"},
135 {RPCResult::Type::STR, "addrlocal", /*optional=*/true, "(ip:port) Local address as reported by the peer"},
136 {RPCResult::Type::STR, "network", "Network (" + Join(GetNetworkNames(/*append_unroutable=*/true), ", ") + ")"},
137 {RPCResult::Type::NUM, "mapped_as", /*optional=*/true, "Mapped AS (Autonomous System) number at the end of the BGP route to the peer, used for diversifying\n"
138 "peer selection (only displayed if the -asmap config option is set)"},
139 {RPCResult::Type::STR_HEX, "services", "The services offered"},
140 {RPCResult::Type::ARR, "servicesnames", "the services offered, in human-readable form",
141 {
142 {RPCResult::Type::STR, "SERVICE_NAME", "the service name if it is recognised"}
143 }},
144 {RPCResult::Type::BOOL, "relaytxes", "Whether we relay transactions to this peer"},
145 {RPCResult::Type::NUM, "last_inv_sequence", "Mempool sequence number of this peer's last INV"},
146 {RPCResult::Type::NUM, "inv_to_send", "How many txs we have queued to announce to this peer"},
147 {RPCResult::Type::NUM_TIME, "lastsend", "The " + UNIX_EPOCH_TIME + " of the last send"},
148 {RPCResult::Type::NUM_TIME, "lastrecv", "The " + UNIX_EPOCH_TIME + " of the last receive"},
149 {RPCResult::Type::NUM_TIME, "last_transaction", "The " + UNIX_EPOCH_TIME + " of the last valid transaction received from this peer"},
150 {RPCResult::Type::NUM_TIME, "last_block", "The " + UNIX_EPOCH_TIME + " of the last block received from this peer"},
151 {RPCResult::Type::NUM, "bytessent", "The total bytes sent"},
152 {RPCResult::Type::NUM, "bytesrecv", "The total bytes received"},
153 {RPCResult::Type::NUM_TIME, "conntime", "The " + UNIX_EPOCH_TIME + " of the connection"},
154 {RPCResult::Type::NUM, "timeoffset", "The time offset in seconds"},
155 {RPCResult::Type::NUM, "pingtime", /*optional=*/true, "The last ping time in seconds, if any"},
156 {RPCResult::Type::NUM, "minping", /*optional=*/true, "The minimum observed ping time in seconds, if any"},
157 {RPCResult::Type::NUM, "pingwait", /*optional=*/true, "The duration in seconds of an outstanding ping (if non-zero)"},
158 {RPCResult::Type::NUM, "version", "The peer version, such as 70001"},
159 {RPCResult::Type::STR, "subver", "The string version"},
160 {RPCResult::Type::BOOL, "inbound", "Inbound (true) or Outbound (false)"},
161 {RPCResult::Type::BOOL, "bip152_hb_to", "Whether we selected peer as (compact blocks) high-bandwidth peer"},
162 {RPCResult::Type::BOOL, "bip152_hb_from", "Whether peer selected us as (compact blocks) high-bandwidth peer"},
163 {RPCResult::Type::NUM, "startingheight", /*optional=*/true, "(DEPRECATED, returned only if config option -deprecatedrpc=startingheight is passed) The starting height (block) of the peer"},
164 {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"},
165 {RPCResult::Type::NUM, "synced_headers", "The last header we have in common with this peer"},
166 {RPCResult::Type::NUM, "synced_blocks", "The last block we have in common with this peer"},
167 {RPCResult::Type::ARR, "inflight", "",
168 {
169 {RPCResult::Type::NUM, "n", "The heights of blocks we're currently asking from this peer"},
170 }},
171 {RPCResult::Type::BOOL, "addr_relay_enabled", "Whether we participate in address relay with this peer"},
172 {RPCResult::Type::NUM, "addr_processed", "The total number of addresses processed, excluding those dropped due to rate limiting"},
173 {RPCResult::Type::NUM, "addr_rate_limited", "The total number of addresses dropped due to rate limiting"},
174 {RPCResult::Type::ARR, "permissions", "Any special permissions that have been granted to this peer",
175 {
176 {RPCResult::Type::STR, "permission_type", Join(NET_PERMISSIONS_DOC, ",\n") + ".\n"},
177 }},
178 {RPCResult::Type::NUM, "minfeefilter", "The minimum fee rate for transactions this peer accepts"},
179 {RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "",
180 {
181 {RPCResult::Type::NUM, "msg", "The total bytes sent aggregated by message type\n"
182 "When a message type is not listed in this json object, the bytes sent are 0.\n"
183 "Only known message types can appear as keys in the object."}
184 }},
185 {RPCResult::Type::OBJ_DYN, "bytesrecv_per_msg", "",
186 {
187 {RPCResult::Type::NUM, "msg", "The total bytes received aggregated by message type\n"
188 "When a message type is not listed in this json object, the bytes received are 0.\n"
189 "Only known message types can appear as keys in the object and all bytes received\n"
190 "of unknown message types are listed under '"+NET_MESSAGE_TYPE_OTHER+"'."}
191 }},
192 {RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + ".\n"
193 "Please note this output is unlikely to be stable in upcoming releases as we iterate to\n"
194 "best capture connection behaviors."},
195 {RPCResult::Type::STR, "transport_protocol_type", "Type of transport protocol: \n" + Join(TRANSPORT_TYPE_DOC, ",\n") + ".\n"},
196 {RPCResult::Type::STR, "session_id", "The session ID for this connection, or \"\" if there is none (\"v2\" transport protocol only).\n"},
197 }},
198 }},
199 },
201 HelpExampleCli("getpeerinfo", "")
202 + HelpExampleRpc("getpeerinfo", "")
203 },
204 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
205{
206 NodeContext& node = EnsureAnyNodeContext(request.context);
207 const CConnman& connman = EnsureConnman(node);
208 const PeerManager& peerman = EnsurePeerman(node);
209
210 std::vector<CNodeStats> vstats;
211 connman.GetNodeStats(vstats);
212
214
215 for (const CNodeStats& stats : vstats) {
217 CNodeStateStats statestats;
218 bool fStateStats = peerman.GetNodeStateStats(stats.nodeid, statestats);
219 // GetNodeStateStats() requires the existence of a CNodeState and a Peer object
220 // to succeed for this peer. These are created at connection initialisation and
221 // exist for the duration of the connection - except if there is a race where the
222 // peer got disconnected in between the GetNodeStats() and the GetNodeStateStats()
223 // calls. In this case, the peer doesn't need to be reported here.
224 if (!fStateStats) {
225 continue;
226 }
227 obj.pushKV("id", stats.nodeid);
228 obj.pushKV("addr", stats.m_addr_name);
229 if (stats.addrBind.IsValid()) {
230 obj.pushKV("addrbind", stats.addrBind.ToStringAddrPort());
231 }
232 if (!(stats.addrLocal.empty())) {
233 obj.pushKV("addrlocal", stats.addrLocal);
234 }
235 obj.pushKV("network", GetNetworkName(stats.m_network));
236 if (stats.m_mapped_as != 0) {
237 obj.pushKV("mapped_as", uint64_t(stats.m_mapped_as));
238 }
239 ServiceFlags services{statestats.their_services};
240 obj.pushKV("services", strprintf("%016x", services));
241 obj.pushKV("servicesnames", GetServicesNames(services));
242 obj.pushKV("relaytxes", statestats.m_relay_txs);
243 obj.pushKV("last_inv_sequence", statestats.m_last_inv_seq);
244 obj.pushKV("inv_to_send", statestats.m_inv_to_send);
245 obj.pushKV("lastsend", count_seconds(stats.m_last_send));
246 obj.pushKV("lastrecv", count_seconds(stats.m_last_recv));
247 obj.pushKV("last_transaction", count_seconds(stats.m_last_tx_time));
248 obj.pushKV("last_block", count_seconds(stats.m_last_block_time));
249 obj.pushKV("bytessent", stats.nSendBytes);
250 obj.pushKV("bytesrecv", stats.nRecvBytes);
251 obj.pushKV("conntime", count_seconds(stats.m_connected));
252 obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(statestats.time_offset));
253 if (stats.m_last_ping_time > 0us) {
254 obj.pushKV("pingtime", Ticks<SecondsDouble>(stats.m_last_ping_time));
255 }
256 if (stats.m_min_ping_time < std::chrono::microseconds::max()) {
257 obj.pushKV("minping", Ticks<SecondsDouble>(stats.m_min_ping_time));
258 }
259 if (statestats.m_ping_wait > 0s) {
260 obj.pushKV("pingwait", Ticks<SecondsDouble>(statestats.m_ping_wait));
261 }
262 obj.pushKV("version", stats.nVersion);
263 // Use the sanitized form of subver here, to avoid tricksy remote peers from
264 // corrupting or modifying the JSON output by putting special characters in
265 // their ver message.
266 obj.pushKV("subver", stats.cleanSubVer);
267 obj.pushKV("inbound", stats.fInbound);
268 obj.pushKV("bip152_hb_to", stats.m_bip152_highbandwidth_to);
269 obj.pushKV("bip152_hb_from", stats.m_bip152_highbandwidth_from);
270 if (IsDeprecatedRPCEnabled("startingheight")) {
271 obj.pushKV("startingheight", statestats.m_starting_height);
272 }
273 obj.pushKV("presynced_headers", statestats.presync_height);
274 obj.pushKV("synced_headers", statestats.nSyncHeight);
275 obj.pushKV("synced_blocks", statestats.nCommonHeight);
276 UniValue heights(UniValue::VARR);
277 for (const int height : statestats.vHeightInFlight) {
278 heights.push_back(height);
279 }
280 obj.pushKV("inflight", std::move(heights));
281 obj.pushKV("addr_relay_enabled", statestats.m_addr_relay_enabled);
282 obj.pushKV("addr_processed", statestats.m_addr_processed);
283 obj.pushKV("addr_rate_limited", statestats.m_addr_rate_limited);
284 UniValue permissions(UniValue::VARR);
285 for (const auto& permission : NetPermissions::ToStrings(stats.m_permission_flags)) {
286 permissions.push_back(permission);
287 }
288 obj.pushKV("permissions", std::move(permissions));
289 obj.pushKV("minfeefilter", ValueFromAmount(statestats.m_fee_filter_received));
290
291 UniValue sendPerMsgType(UniValue::VOBJ);
292 for (const auto& i : stats.mapSendBytesPerMsgType) {
293 if (i.second > 0)
294 sendPerMsgType.pushKV(i.first, i.second);
295 }
296 obj.pushKV("bytessent_per_msg", std::move(sendPerMsgType));
297
298 UniValue recvPerMsgType(UniValue::VOBJ);
299 for (const auto& i : stats.mapRecvBytesPerMsgType) {
300 if (i.second > 0)
301 recvPerMsgType.pushKV(i.first, i.second);
302 }
303 obj.pushKV("bytesrecv_per_msg", std::move(recvPerMsgType));
304 obj.pushKV("connection_type", ConnectionTypeAsString(stats.m_conn_type));
305 obj.pushKV("transport_protocol_type", TransportTypeAsString(stats.m_transport_type));
306 obj.pushKV("session_id", stats.m_session_id);
307
308 ret.push_back(std::move(obj));
309 }
310
311 return ret;
312},
313 };
314}
315
317{
318 return RPCHelpMan{
319 "addnode",
320 "Attempts to add or remove a node from the addnode list.\n"
321 "Or try a connection to a node once.\n"
322 "Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be\n"
323 "full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).\n" +
324 strprintf("Addnode connections are limited to %u at a time", MAX_ADDNODE_CONNECTIONS) +
325 " and are counted separately from the -maxconnections limit.\n",
326 {
327 {"node", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address/hostname optionally followed by :port of the peer to connect to"},
328 {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "'add' to add a node to the list, 'remove' to remove a node from the list, 'onetry' to try a connection to the node once"},
329 {"v2transport", RPCArg::Type::BOOL, RPCArg::DefaultHint{"set by -v2transport"}, "Attempt to connect using BIP324 v2 transport protocol (ignored for 'remove' command)"},
330 },
333 HelpExampleCli("addnode", "\"192.168.0.6:8333\" \"onetry\" true")
334 + HelpExampleRpc("addnode", "\"192.168.0.6:8333\", \"onetry\" true")
335 },
336 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
337{
338 const auto command{self.Arg<std::string_view>("command")};
339 if (command != "onetry" && command != "add" && command != "remove") {
340 throw std::runtime_error(
341 self.ToString());
342 }
343
344 NodeContext& node = EnsureAnyNodeContext(request.context);
345 CConnman& connman = EnsureConnman(node);
346
347 const auto node_arg{self.Arg<std::string_view>("node")};
348 bool node_v2transport = connman.GetLocalServices() & NODE_P2P_V2;
349 bool use_v2transport = self.MaybeArg<bool>("v2transport").value_or(node_v2transport);
350
351 if (use_v2transport && !node_v2transport) {
352 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: v2transport requested but not enabled (see -v2transport)");
353 }
354
355 if (command == "onetry")
356 {
357 CAddress addr;
358 connman.OpenNetworkConnection(addr, /*fCountFailure=*/false, /*grant_outbound=*/{}, std::string{node_arg}.c_str(), ConnectionType::MANUAL, use_v2transport);
359 return UniValue::VNULL;
360 }
361
362 if (command == "add")
363 {
364 if (!connman.AddNode({std::string{node_arg}, use_v2transport})) {
365 throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: Node already added");
366 }
367 }
368 else if (command == "remove")
369 {
370 if (!connman.RemoveAddedNode(node_arg)) {
371 throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node could not be removed. It has not been added previously.");
372 }
373 }
374
375 return UniValue::VNULL;
376},
377 };
378}
379
381{
382 return RPCHelpMan{
383 "addconnection",
384 "Open an outbound connection to a specified node. This RPC is for testing only.\n",
385 {
386 {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address and port to attempt connecting to."},
387 {"connection_type", RPCArg::Type::STR, RPCArg::Optional::NO, "Type of connection to open (\"outbound-full-relay\", \"block-relay-only\", \"addr-fetch\" or \"feeler\")."},
388 {"v2transport", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Attempt to connect using BIP324 v2 transport protocol"},
389 },
390 RPCResult{
391 RPCResult::Type::OBJ, "", "",
392 {
393 { RPCResult::Type::STR, "address", "Address of newly added connection." },
394 { RPCResult::Type::STR, "connection_type", "Type of connection opened." },
395 }},
397 HelpExampleCli("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")
398 + HelpExampleRpc("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")
399 },
400 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
401{
403 throw std::runtime_error("addconnection is for regression testing (-regtest mode) only.");
404 }
405
406 const std::string address = request.params[0].get_str();
407 auto conn_type_in{util::TrimStringView(self.Arg<std::string_view>("connection_type"))};
408 ConnectionType conn_type{};
409 if (conn_type_in == "outbound-full-relay") {
411 } else if (conn_type_in == "block-relay-only") {
412 conn_type = ConnectionType::BLOCK_RELAY;
413 } else if (conn_type_in == "addr-fetch") {
414 conn_type = ConnectionType::ADDR_FETCH;
415 } else if (conn_type_in == "feeler") {
416 conn_type = ConnectionType::FEELER;
417 } else {
419 }
420 bool use_v2transport{self.Arg<bool>("v2transport")};
421
422 NodeContext& node = EnsureAnyNodeContext(request.context);
423 CConnman& connman = EnsureConnman(node);
424
425 if (use_v2transport && !(connman.GetLocalServices() & NODE_P2P_V2)) {
426 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Adding v2transport connections requires -v2transport init flag to be set.");
427 }
428
429 const bool success = connman.AddConnection(address, conn_type, use_v2transport);
430 if (!success) {
431 throw JSONRPCError(RPC_CLIENT_NODE_CAPACITY_REACHED, "Error: Already at capacity for specified connection type.");
432 }
433
435 info.pushKV("address", address);
436 info.pushKV("connection_type", conn_type_in);
437
438 return info;
439},
440 };
441}
442
444{
445 return RPCHelpMan{
446 "disconnectnode",
447 "Immediately disconnects from the specified peer node.\n"
448 "\nStrictly one out of 'address' and 'nodeid' can be provided to identify the node.\n"
449 "\nTo disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.\n",
450 {
451 {"address", RPCArg::Type::STR, RPCArg::DefaultHint{"fallback to nodeid"}, "The IP address/port of the node"},
452 {"nodeid", RPCArg::Type::NUM, RPCArg::DefaultHint{"fallback to address"}, "The node ID (see getpeerinfo for node IDs)"},
453 },
456 HelpExampleCli("disconnectnode", "\"192.168.0.6:8333\"")
457 + HelpExampleCli("disconnectnode", "\"\" 1")
458 + HelpExampleRpc("disconnectnode", "\"192.168.0.6:8333\"")
459 + HelpExampleRpc("disconnectnode", "\"\", 1")
460 },
461 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
462{
463 NodeContext& node = EnsureAnyNodeContext(request.context);
464 CConnman& connman = EnsureConnman(node);
465
466 bool success;
467 auto address{self.MaybeArg<std::string_view>("address")};
468 auto node_id{self.MaybeArg<int64_t>("nodeid")};
469
470 if (address && !node_id) {
471 /* handle disconnect-by-address */
472 success = connman.DisconnectNode(*address);
473 } else if (node_id && (!address || address->empty())) {
474 /* handle disconnect-by-id */
475 success = connman.DisconnectNode(*node_id);
476 } else {
477 throw JSONRPCError(RPC_INVALID_PARAMS, "Only one of address and nodeid should be provided.");
478 }
479
480 if (!success) {
481 throw JSONRPCError(RPC_CLIENT_NODE_NOT_CONNECTED, "Node not found in connected nodes");
482 }
483
484 return UniValue::VNULL;
485},
486 };
487}
488
490{
491 return RPCHelpMan{
492 "getaddednodeinfo",
493 "Returns information about the given added node, or all added nodes\n"
494 "(note that onetry addnodes are not listed here)\n",
495 {
496 {"node", RPCArg::Type::STR, RPCArg::DefaultHint{"all nodes"}, "If provided, return information about this specific node, otherwise all nodes are returned."},
497 },
498 RPCResult{
499 RPCResult::Type::ARR, "", "",
500 {
501 {RPCResult::Type::OBJ, "", "",
502 {
503 {RPCResult::Type::STR, "addednode", "The node IP address or name (as provided to addnode)"},
504 {RPCResult::Type::BOOL, "connected", "If connected"},
505 {RPCResult::Type::ARR, "addresses", "Only when connected = true",
506 {
507 {RPCResult::Type::OBJ, "", "",
508 {
509 {RPCResult::Type::STR, "address", "The bitcoin server IP and port we're connected to"},
510 {RPCResult::Type::STR, "connected", "connection, inbound or outbound"},
511 }},
512 }},
513 }},
514 }
515 },
517 HelpExampleCli("getaddednodeinfo", "\"192.168.0.201\"")
518 + HelpExampleRpc("getaddednodeinfo", "\"192.168.0.201\"")
519 },
520 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
521{
522 NodeContext& node = EnsureAnyNodeContext(request.context);
523 const CConnman& connman = EnsureConnman(node);
524
525 std::vector<AddedNodeInfo> vInfo = connman.GetAddedNodeInfo(/*include_connected=*/true);
526
527 if (auto node{self.MaybeArg<std::string_view>("node")}) {
528 bool found = false;
529 for (const AddedNodeInfo& info : vInfo) {
530 if (info.m_params.m_added_node == *node) {
531 vInfo.assign(1, info);
532 found = true;
533 break;
534 }
535 }
536 if (!found) {
537 throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node has not been added.");
538 }
539 }
540
542
543 for (const AddedNodeInfo& info : vInfo) {
545 obj.pushKV("addednode", info.m_params.m_added_node);
546 obj.pushKV("connected", info.fConnected);
547 UniValue addresses(UniValue::VARR);
548 if (info.fConnected) {
549 UniValue address(UniValue::VOBJ);
550 address.pushKV("address", info.resolvedAddress.ToStringAddrPort());
551 address.pushKV("connected", info.fInbound ? "inbound" : "outbound");
552 addresses.push_back(std::move(address));
553 }
554 obj.pushKV("addresses", std::move(addresses));
555 ret.push_back(std::move(obj));
556 }
557
558 return ret;
559},
560 };
561}
562
564{
565 return RPCHelpMan{"getnettotals",
566 "Returns information about network traffic, including bytes in, bytes out,\n"
567 "and current system time.",
568 {},
569 RPCResult{
570 RPCResult::Type::OBJ, "", "",
571 {
572 {RPCResult::Type::NUM, "totalbytesrecv", "Total bytes received"},
573 {RPCResult::Type::NUM, "totalbytessent", "Total bytes sent"},
574 {RPCResult::Type::NUM_TIME, "timemillis", "Current system " + UNIX_EPOCH_TIME + " in milliseconds"},
575 {RPCResult::Type::OBJ, "uploadtarget", "",
576 {
577 {RPCResult::Type::NUM, "timeframe", "Length of the measuring timeframe in seconds"},
578 {RPCResult::Type::NUM, "target", "Target in bytes"},
579 {RPCResult::Type::BOOL, "target_reached", "True if target is reached"},
580 {RPCResult::Type::BOOL, "serve_historical_blocks", "True if serving historical blocks"},
581 {RPCResult::Type::NUM, "bytes_left_in_cycle", "Bytes left in current time cycle"},
582 {RPCResult::Type::NUM, "time_left_in_cycle", "Seconds left in current time cycle"},
583 }},
584 }
585 },
587 HelpExampleCli("getnettotals", "")
588 + HelpExampleRpc("getnettotals", "")
589 },
590 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
591{
592 NodeContext& node = EnsureAnyNodeContext(request.context);
593 const CConnman& connman = EnsureConnman(node);
594
596 obj.pushKV("totalbytesrecv", connman.GetTotalBytesRecv());
597 obj.pushKV("totalbytessent", connman.GetTotalBytesSent());
598 obj.pushKV("timemillis", TicksSinceEpoch<std::chrono::milliseconds>(SystemClock::now()));
599
600 UniValue outboundLimit(UniValue::VOBJ);
601 outboundLimit.pushKV("timeframe", count_seconds(connman.GetMaxOutboundTimeframe()));
602 outboundLimit.pushKV("target", connman.GetMaxOutboundTarget());
603 outboundLimit.pushKV("target_reached", connman.OutboundTargetReached(false));
604 outboundLimit.pushKV("serve_historical_blocks", !connman.OutboundTargetReached(true));
605 outboundLimit.pushKV("bytes_left_in_cycle", connman.GetOutboundTargetBytesLeft());
606 outboundLimit.pushKV("time_left_in_cycle", count_seconds(connman.GetMaxOutboundTimeLeftInCycle()));
607 obj.pushKV("uploadtarget", std::move(outboundLimit));
608 return obj;
609},
610 };
611}
612
614{
615 UniValue networks(UniValue::VARR);
616 for (int n = 0; n < NET_MAX; ++n) {
617 enum Network network = static_cast<enum Network>(n);
618 if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
619 Proxy proxy;
621 GetProxy(network, proxy);
622 obj.pushKV("name", GetNetworkName(network));
623 obj.pushKV("limited", !g_reachable_nets.Contains(network));
624 obj.pushKV("reachable", g_reachable_nets.Contains(network));
625 obj.pushKV("proxy", proxy.IsValid() ? proxy.ToString() : std::string());
626 obj.pushKV("proxy_randomize_credentials", proxy.m_tor_stream_isolation);
627 networks.push_back(std::move(obj));
628 }
629 return networks;
630}
631
633{
634 return RPCHelpMan{"getnetworkinfo",
635 "Returns an object containing various state info regarding P2P networking.\n",
636 {},
637 RPCResult{
638 RPCResult::Type::OBJ, "", "",
639 {
640 {RPCResult::Type::NUM, "version", "the server version"},
641 {RPCResult::Type::STR, "subversion", "the server subversion string"},
642 {RPCResult::Type::NUM, "protocolversion", "the protocol version"},
643 {RPCResult::Type::STR_HEX, "localservices", "the services we offer to the network"},
644 {RPCResult::Type::ARR, "localservicesnames", "the services we offer to the network, in human-readable form",
645 {
646 {RPCResult::Type::STR, "SERVICE_NAME", "the service name"},
647 }},
648 {RPCResult::Type::BOOL, "localrelay", "true if transaction relay is requested from peers"},
649 {RPCResult::Type::NUM, "timeoffset", "the time offset"},
650 {RPCResult::Type::NUM, "connections", "the total number of connections"},
651 {RPCResult::Type::NUM, "connections_in", "the number of inbound connections"},
652 {RPCResult::Type::NUM, "connections_out", "the number of outbound connections"},
653 {RPCResult::Type::BOOL, "networkactive", "whether p2p networking is enabled"},
654 {RPCResult::Type::ARR, "networks", "information per network",
655 {
656 {RPCResult::Type::OBJ, "", "",
657 {
658 {RPCResult::Type::STR, "name", "network (" + Join(GetNetworkNames(), ", ") + ")"},
659 {RPCResult::Type::BOOL, "limited", "is the network limited using -onlynet?"},
660 {RPCResult::Type::BOOL, "reachable", "is the network reachable?"},
661 {RPCResult::Type::STR, "proxy", "(\"host:port\") the proxy that is used for this network, or empty if none"},
662 {RPCResult::Type::BOOL, "proxy_randomize_credentials", "Whether randomized credentials are used"},
663 }},
664 }},
665 {RPCResult::Type::NUM, "relayfee", "minimum relay fee rate for transactions in " + CURRENCY_UNIT + "/kvB"},
666 {RPCResult::Type::NUM, "incrementalfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
667 {RPCResult::Type::ARR, "localaddresses", "list of local addresses",
668 {
669 {RPCResult::Type::OBJ, "", "",
670 {
671 {RPCResult::Type::STR, "address", "network address"},
672 {RPCResult::Type::NUM, "port", "network port"},
673 {RPCResult::Type::NUM, "score", "relative score"},
674 }},
675 }},
676 (IsDeprecatedRPCEnabled("warnings") ?
677 RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :
678 RPCResult{RPCResult::Type::ARR, "warnings", "any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
679 {
680 {RPCResult::Type::STR, "", "warning"},
681 }
682 }
683 ),
684 }
685 },
687 HelpExampleCli("getnetworkinfo", "")
688 + HelpExampleRpc("getnetworkinfo", "")
689 },
690 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
691{
692 LOCK(cs_main);
694 obj.pushKV("version", CLIENT_VERSION);
695 obj.pushKV("subversion", strSubVersion);
696 obj.pushKV("protocolversion",PROTOCOL_VERSION);
697 NodeContext& node = EnsureAnyNodeContext(request.context);
698 if (node.connman) {
699 ServiceFlags services = node.connman->GetLocalServices();
700 obj.pushKV("localservices", strprintf("%016x", services));
701 obj.pushKV("localservicesnames", GetServicesNames(services));
702 }
703 if (node.peerman) {
704 auto peerman_info{node.peerman->GetInfo()};
705 obj.pushKV("localrelay", !peerman_info.ignores_incoming_txs);
706 obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(peerman_info.median_outbound_time_offset));
707 }
708 if (node.connman) {
709 obj.pushKV("networkactive", node.connman->GetNetworkActive());
710 obj.pushKV("connections", node.connman->GetNodeCount(ConnectionDirection::Both));
711 obj.pushKV("connections_in", node.connman->GetNodeCount(ConnectionDirection::In));
712 obj.pushKV("connections_out", node.connman->GetNodeCount(ConnectionDirection::Out));
713 }
714 obj.pushKV("networks", GetNetworksInfo());
715 if (node.mempool) {
716 // Those fields can be deprecated, to be replaced by the getmempoolinfo fields
717 obj.pushKV("relayfee", ValueFromAmount(node.mempool->m_opts.min_relay_feerate.GetFeePerK()));
718 obj.pushKV("incrementalfee", ValueFromAmount(node.mempool->m_opts.incremental_relay_feerate.GetFeePerK()));
719 }
720 UniValue localAddresses(UniValue::VARR);
721 {
723 for (const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)
724 {
726 rec.pushKV("address", item.first.ToStringAddr());
727 rec.pushKV("port", item.second.nPort);
728 rec.pushKV("score", item.second.nScore);
729 localAddresses.push_back(std::move(rec));
730 }
731 }
732 obj.pushKV("localaddresses", std::move(localAddresses));
733 obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));
734 return obj;
735},
736 };
737}
738
740{
741 return RPCHelpMan{
742 "setban",
743 "Attempts to add or remove an IP/Subnet from the banned list.\n",
744 {
745 {"subnet", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)"},
746 {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list"},
747 {"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)"},
748 {"absolute", RPCArg::Type::BOOL, RPCArg::Default{false}, "If set, the bantime must be an absolute timestamp expressed in " + UNIX_EPOCH_TIME},
749 },
752 HelpExampleCli("setban", "\"192.168.0.6\" \"add\" 86400")
753 + HelpExampleCli("setban", "\"192.168.0.0/24\" \"add\"")
754 + HelpExampleRpc("setban", "\"192.168.0.6\", \"add\", 86400")
755 },
756 [&](const RPCHelpMan& help, const JSONRPCRequest& request) -> UniValue
757{
758 auto command{help.Arg<std::string_view>("command")};
759 if (command != "add" && command != "remove") {
760 throw std::runtime_error(help.ToString());
761 }
762 NodeContext& node = EnsureAnyNodeContext(request.context);
763 BanMan& banman = EnsureBanman(node);
764
765 CSubNet subNet;
766 CNetAddr netAddr;
767 std::string subnet_arg{help.Arg<std::string_view>("subnet")};
768 const bool isSubnet{subnet_arg.find('/') != subnet_arg.npos};
769
770 if (!isSubnet) {
771 const std::optional<CNetAddr> addr{LookupHost(subnet_arg, false)};
772 if (addr.has_value()) {
773 netAddr = static_cast<CNetAddr>(MaybeFlipIPv6toCJDNS(CService{addr.value(), /*port=*/0}));
774 }
775 } else {
776 subNet = LookupSubNet(subnet_arg);
777 }
778
779 if (! (isSubnet ? subNet.IsValid() : netAddr.IsValid()) ) {
780 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Invalid IP/Subnet");
781 }
782
783 if (command == "add") {
784 if (isSubnet ? banman.IsBanned(subNet) : banman.IsBanned(netAddr)) {
785 throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: IP/Subnet already banned");
786 }
787
788 int64_t banTime = 0; //use standard bantime if not specified
789 if (!request.params[2].isNull())
790 banTime = request.params[2].getInt<int64_t>();
791
792 const bool absolute{request.params[3].isNull() ? false : request.params[3].get_bool()};
793
794 if (absolute && banTime < GetTime()) {
795 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Absolute timestamp is in the past");
796 }
797
798 if (isSubnet) {
799 banman.Ban(subNet, banTime, absolute);
800 if (node.connman) {
801 node.connman->DisconnectNode(subNet);
802 }
803 } else {
804 banman.Ban(netAddr, banTime, absolute);
805 if (node.connman) {
806 node.connman->DisconnectNode(netAddr);
807 }
808 }
809 } else if(command == "remove") {
810 if (!( isSubnet ? banman.Unban(subNet) : banman.Unban(netAddr) )) {
811 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Unban failed. Requested address/subnet was not previously manually banned.");
812 }
813 }
814 return UniValue::VNULL;
815},
816 };
817}
818
820{
821 return RPCHelpMan{
822 "listbanned",
823 "List all manually banned IPs/Subnets.\n",
824 {},
826 {
827 {RPCResult::Type::OBJ, "", "",
828 {
829 {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},
830 {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},
831 {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},
832 {RPCResult::Type::NUM_TIME, "ban_duration", "The ban duration, in seconds"},
833 {RPCResult::Type::NUM_TIME, "time_remaining", "The time remaining until the ban expires, in seconds"},
834 }},
835 }},
837 HelpExampleCli("listbanned", "")
838 + HelpExampleRpc("listbanned", "")
839 },
840 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
841{
842 BanMan& banman = EnsureAnyBanman(request.context);
843
844 banmap_t banMap;
845 banman.GetBanned(banMap);
846 const int64_t current_time{GetTime()};
847
848 UniValue bannedAddresses(UniValue::VARR);
849 for (const auto& entry : banMap)
850 {
851 const CBanEntry& banEntry = entry.second;
853 rec.pushKV("address", entry.first.ToString());
854 rec.pushKV("ban_created", banEntry.nCreateTime);
855 rec.pushKV("banned_until", banEntry.nBanUntil);
856 rec.pushKV("ban_duration", (banEntry.nBanUntil - banEntry.nCreateTime));
857 rec.pushKV("time_remaining", (banEntry.nBanUntil - current_time));
858
859 bannedAddresses.push_back(std::move(rec));
860 }
861
862 return bannedAddresses;
863},
864 };
865}
866
868{
869 return RPCHelpMan{
870 "clearbanned",
871 "Clear all banned IPs.\n",
872 {},
875 HelpExampleCli("clearbanned", "")
876 + HelpExampleRpc("clearbanned", "")
877 },
878 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
879{
880 BanMan& banman = EnsureAnyBanman(request.context);
881
882 banman.ClearBanned();
883
884 return UniValue::VNULL;
885},
886 };
887}
888
890{
891 return RPCHelpMan{
892 "setnetworkactive",
893 "Disable/enable all p2p network activity.\n",
894 {
895 {"state", RPCArg::Type::BOOL, RPCArg::Optional::NO, "true to enable networking, false to disable"},
896 },
897 RPCResult{RPCResult::Type::BOOL, "", "The value that was passed in"},
898 RPCExamples{""},
899 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
900{
901 NodeContext& node = EnsureAnyNodeContext(request.context);
902 CConnman& connman = EnsureConnman(node);
903
904 connman.SetNetworkActive(request.params[0].get_bool());
905
906 return connman.GetNetworkActive();
907},
908 };
909}
910
912{
913 return RPCHelpMan{"getnodeaddresses",
914 "Return known addresses, after filtering for quality and recency.\n"
915 "These can potentially be used to find new peers in the network.\n"
916 "The total number of addresses known to the node may be higher.",
917 {
918 {"count", RPCArg::Type::NUM, RPCArg::Default{1}, "The maximum number of addresses to return. Specify 0 to return all known addresses."},
919 {"network", RPCArg::Type::STR, RPCArg::DefaultHint{"all networks"}, "Return only addresses of the specified network. Can be one of: " + Join(GetNetworkNames(), ", ") + "."},
920 },
921 RPCResult{
922 RPCResult::Type::ARR, "", "",
923 {
924 {RPCResult::Type::OBJ, "", "",
925 {
926 {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
927 {RPCResult::Type::NUM, "services", "The services offered by the node"},
928 {RPCResult::Type::STR, "address", "The address of the node"},
929 {RPCResult::Type::NUM, "port", "The port number of the node"},
930 {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") the node connected through"},
931 }},
932 }
933 },
935 HelpExampleCli("getnodeaddresses", "8")
936 + HelpExampleCli("getnodeaddresses", "4 \"i2p\"")
937 + HelpExampleCli("-named getnodeaddresses", "network=onion count=12")
938 + HelpExampleRpc("getnodeaddresses", "8")
939 + HelpExampleRpc("getnodeaddresses", "4, \"i2p\"")
940 },
941 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
942{
943 NodeContext& node = EnsureAnyNodeContext(request.context);
944 const CConnman& connman = EnsureConnman(node);
945
946 const int count{request.params[0].isNull() ? 1 : request.params[0].getInt<int>()};
947 if (count < 0) throw JSONRPCError(RPC_INVALID_PARAMETER, "Address count out of range");
948
949 const std::optional<Network> network{request.params[1].isNull() ? std::nullopt : std::optional<Network>{ParseNetwork(request.params[1].get_str())}};
950 if (network == NET_UNROUTABLE) {
951 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Network not recognized: %s", request.params[1].get_str()));
952 }
953
954 // returns a shuffled list of CAddress
955 const std::vector<CAddress> vAddr{connman.GetAddressesUnsafe(count, /*max_pct=*/0, network)};
957
958 for (const CAddress& addr : vAddr) {
960 obj.pushKV("time", int64_t{TicksSinceEpoch<std::chrono::seconds>(addr.nTime)});
961 obj.pushKV("services", static_cast<std::underlying_type_t<decltype(addr.nServices)>>(addr.nServices));
962 obj.pushKV("address", addr.ToStringAddr());
963 obj.pushKV("port", addr.GetPort());
964 obj.pushKV("network", GetNetworkName(addr.GetNetClass()));
965 ret.push_back(std::move(obj));
966 }
967 return ret;
968},
969 };
970}
971
973{
974 return RPCHelpMan{"addpeeraddress",
975 "Add the address of a potential peer to an address manager table. This RPC is for testing only.",
976 {
977 {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address of the peer"},
978 {"port", RPCArg::Type::NUM, RPCArg::Optional::NO, "The port of the peer"},
979 {"tried", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, attempt to add the peer to the tried addresses table"},
980 },
981 RPCResult{
982 RPCResult::Type::OBJ, "", "",
983 {
984 {RPCResult::Type::BOOL, "success", "whether the peer address was successfully added to the address manager table"},
985 {RPCResult::Type::STR, "error", /*optional=*/true, "error description, if the address could not be added"},
986 },
987 },
989 HelpExampleCli("addpeeraddress", "\"1.2.3.4\" 8333 true")
990 + HelpExampleRpc("addpeeraddress", "\"1.2.3.4\", 8333, true")
991 },
992 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
993{
994 AddrMan& addrman = EnsureAnyAddrman(request.context);
995
996 const std::string& addr_string{request.params[0].get_str()};
997 const auto port{request.params[1].getInt<uint16_t>()};
998 const bool tried{request.params[2].isNull() ? false : request.params[2].get_bool()};
999
1001 std::optional<CNetAddr> net_addr{LookupHost(addr_string, false)};
1002 if (!net_addr.has_value()) {
1003 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Invalid IP address");
1004 }
1005
1006 bool success{false};
1007
1008 CService service{net_addr.value(), port};
1010 address.nTime = Now<NodeSeconds>();
1011 // The source address is set equal to the address. This is equivalent to the peer
1012 // announcing itself.
1013 if (addrman.Add({address}, address)) {
1014 success = true;
1015 if (tried) {
1016 // Attempt to move the address to the tried addresses table.
1017 if (!addrman.Good(address)) {
1018 success = false;
1019 obj.pushKV("error", "failed-adding-to-tried");
1020 }
1021 }
1022 } else {
1023 obj.pushKV("error", "failed-adding-to-new");
1024 }
1025
1026 obj.pushKV("success", success);
1027 return obj;
1028},
1029 };
1030}
1031
1033{
1034 return RPCHelpMan{
1035 "sendmsgtopeer",
1036 "Send a p2p message to a peer specified by id.\n"
1037 "The message type and body must be provided, the message header will be generated.\n"
1038 "This RPC is for testing only.",
1039 {
1040 {"peer_id", RPCArg::Type::NUM, RPCArg::Optional::NO, "The peer to send the message to."},
1041 {"msg_type", RPCArg::Type::STR, RPCArg::Optional::NO, strprintf("The message type (maximum length %i)", CMessageHeader::MESSAGE_TYPE_SIZE)},
1042 {"msg", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The serialized message body to send, in hex, without a message header"},
1043 },
1044 RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
1046 HelpExampleCli("sendmsgtopeer", "0 \"addr\" \"ffffff\"") + HelpExampleRpc("sendmsgtopeer", "0 \"addr\" \"ffffff\"")},
1047 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1048 const NodeId peer_id{request.params[0].getInt<int64_t>()};
1049 const auto msg_type{self.Arg<std::string_view>("msg_type")};
1050 if (msg_type.size() > CMessageHeader::MESSAGE_TYPE_SIZE) {
1051 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Error: msg_type too long, max length is %i", CMessageHeader::MESSAGE_TYPE_SIZE));
1052 }
1053 auto msg{TryParseHex<unsigned char>(self.Arg<std::string_view>("msg"))};
1054 if (!msg.has_value()) {
1055 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error parsing input for msg");
1056 }
1057
1058 NodeContext& node = EnsureAnyNodeContext(request.context);
1059 CConnman& connman = EnsureConnman(node);
1060
1061 CSerializedNetMsg msg_ser;
1062 msg_ser.data = msg.value();
1063 msg_ser.m_type = msg_type;
1064
1065 bool success = connman.ForNode(peer_id, [&](CNode* node) {
1066 connman.PushMessage(node, std::move(msg_ser));
1067 return true;
1068 });
1069
1070 if (!success) {
1071 throw JSONRPCError(RPC_MISC_ERROR, "Error: Could not send message to peer");
1072 }
1073
1075 return ret;
1076 },
1077 };
1078}
1079
1081{
1082 return RPCHelpMan{
1083 "getaddrmaninfo",
1084 "Provides information about the node's address manager by returning the number of "
1085 "addresses in the `new` and `tried` tables and their sum for all networks.\n",
1086 {},
1087 RPCResult{
1088 RPCResult::Type::OBJ_DYN, "", "json object with network type as keys", {
1089 {RPCResult::Type::OBJ, "network", "the network (" + Join(GetNetworkNames(), ", ") + ", all_networks)", {
1090 {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."},
1091 {RPCResult::Type::NUM, "tried", "number of addresses in the tried table, which represent peers the node has successfully connected to in the past."},
1092 {RPCResult::Type::NUM, "total", "total number of addresses in both new/tried tables"},
1093 }},
1094 }},
1095 RPCExamples{HelpExampleCli("getaddrmaninfo", "") + HelpExampleRpc("getaddrmaninfo", "")},
1096 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1097 AddrMan& addrman = EnsureAnyAddrman(request.context);
1098
1100 for (int n = 0; n < NET_MAX; ++n) {
1101 enum Network network = static_cast<enum Network>(n);
1102 if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
1104 obj.pushKV("new", addrman.Size(network, true));
1105 obj.pushKV("tried", addrman.Size(network, false));
1106 obj.pushKV("total", addrman.Size(network));
1107 ret.pushKV(GetNetworkName(network), std::move(obj));
1108 }
1110 obj.pushKV("new", addrman.Size(std::nullopt, true));
1111 obj.pushKV("tried", addrman.Size(std::nullopt, false));
1112 obj.pushKV("total", addrman.Size());
1113 ret.pushKV("all_networks", std::move(obj));
1114 return ret;
1115 },
1116 };
1117}
1118
1119UniValue AddrmanEntryToJSON(const AddrInfo& info, const CConnman& connman)
1120{
1122 ret.pushKV("address", info.ToStringAddr());
1123 const uint32_t mapped_as{connman.GetMappedAS(info)};
1124 if (mapped_as) {
1125 ret.pushKV("mapped_as", mapped_as);
1126 }
1127 ret.pushKV("port", info.GetPort());
1128 ret.pushKV("services", static_cast<std::underlying_type_t<decltype(info.nServices)>>(info.nServices));
1129 ret.pushKV("time", int64_t{TicksSinceEpoch<std::chrono::seconds>(info.nTime)});
1130 ret.pushKV("network", GetNetworkName(info.GetNetClass()));
1131 ret.pushKV("source", info.source.ToStringAddr());
1132 ret.pushKV("source_network", GetNetworkName(info.source.GetNetClass()));
1133 const uint32_t source_mapped_as{connman.GetMappedAS(info.source)};
1134 if (source_mapped_as) {
1135 ret.pushKV("source_mapped_as", source_mapped_as);
1136 }
1137 return ret;
1138}
1139
1140UniValue AddrmanTableToJSON(const std::vector<std::pair<AddrInfo, AddressPosition>>& tableInfos, const CConnman& connman)
1141{
1142 UniValue table(UniValue::VOBJ);
1143 for (const auto& e : tableInfos) {
1144 AddrInfo info = e.first;
1145 AddressPosition location = e.second;
1146 std::ostringstream key;
1147 key << location.bucket << "/" << location.position;
1148 // Address manager tables have unique entries so there is no advantage
1149 // in using UniValue::pushKV, which checks if the key already exists
1150 // in O(N). UniValue::pushKVEnd is used instead which currently is O(1).
1151 table.pushKVEnd(key.str(), AddrmanEntryToJSON(info, connman));
1152 }
1153 return table;
1154}
1155
1157{
1158 return RPCHelpMan{"getrawaddrman",
1159 "EXPERIMENTAL warning: this call may be changed in future releases.\n"
1160 "\nReturns information on all address manager entries for the new and tried tables.\n",
1161 {},
1162 RPCResult{
1163 RPCResult::Type::OBJ_DYN, "", "", {
1164 {RPCResult::Type::OBJ_DYN, "table", "buckets with addresses in the address manager table ( new, tried )", {
1165 {RPCResult::Type::OBJ, "bucket/position", "the location in the address manager table (<bucket>/<position>)", {
1166 {RPCResult::Type::STR, "address", "The address of the node"},
1167 {RPCResult::Type::NUM, "mapped_as", /*optional=*/true, "Mapped AS (Autonomous System) number at the end of the BGP route to the peer, used for diversifying peer selection (only displayed if the -asmap config option is set)"},
1168 {RPCResult::Type::NUM, "port", "The port number of the node"},
1169 {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the address"},
1170 {RPCResult::Type::NUM, "services", "The services offered by the node"},
1171 {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
1172 {RPCResult::Type::STR, "source", "The address that relayed the address to us"},
1173 {RPCResult::Type::STR, "source_network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the source address"},
1174 {RPCResult::Type::NUM, "source_mapped_as", /*optional=*/true, "Mapped AS (Autonomous System) number at the end of the BGP route to the source, used for diversifying peer selection (only displayed if the -asmap config option is set)"}
1175 }}
1176 }}
1177 }
1178 },
1180 HelpExampleCli("getrawaddrman", "")
1181 + HelpExampleRpc("getrawaddrman", "")
1182 },
1183 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1184 AddrMan& addrman = EnsureAnyAddrman(request.context);
1185 NodeContext& node_context = EnsureAnyNodeContext(request.context);
1186 CConnman& connman = EnsureConnman(node_context);
1187
1189 ret.pushKV("new", AddrmanTableToJSON(addrman.GetEntries(false), connman));
1190 ret.pushKV("tried", AddrmanTableToJSON(addrman.GetEntries(true), connman));
1191 return ret;
1192 },
1193 };
1194}
1195
1197{
1198 static const CRPCCommand commands[]{
1199 {"network", &getconnectioncount},
1200 {"network", &ping},
1201 {"network", &getpeerinfo},
1202 {"network", &addnode},
1203 {"network", &disconnectnode},
1204 {"network", &getaddednodeinfo},
1205 {"network", &getnettotals},
1206 {"network", &getnetworkinfo},
1207 {"network", &setban},
1208 {"network", &listbanned},
1209 {"network", &clearbanned},
1210 {"network", &setnetworkactive},
1211 {"network", &getnodeaddresses},
1212 {"network", &getaddrmaninfo},
1213 {"hidden", &addconnection},
1214 {"hidden", &addpeeraddress},
1215 {"hidden", &sendmsgtopeer},
1216 {"hidden", &getrawaddrman},
1217 };
1218 for (const auto& c : commands) {
1219 t.appendCommand(c.name, &c);
1220 }
1221}
int ret
const auto command
const CChainParams & Params()
Return the currently selected parameters.
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:109
Extended statistics about a CAddress.
Definition: addrman_impl.h:46
CNetAddr source
where knowledge about this address first came from
Definition: addrman_impl.h:55
Stochastic address manager.
Definition: addrman.h:89
size_t Size(std::optional< Network > net=std::nullopt, std::optional< bool > in_new=std::nullopt) const
Return size information about addrman.
Definition: addrman.cpp:1297
std::vector< std::pair< AddrInfo, AddressPosition > > GetEntries(bool from_tried) const
Returns an information-location pair for all addresses in the selected addrman table.
Definition: addrman.cpp:1337
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.
Definition: addrman.cpp:1307
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.
Definition: addrman.cpp:1302
Definition: banman.h:64
void Ban(const CNetAddr &net_addr, int64_t ban_time_offset=0, bool since_unix_epoch=false) EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Definition: banman.cpp:118
bool IsBanned(const CNetAddr &net_addr) EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Return whether net_addr is banned.
Definition: banman.cpp:89
void GetBanned(banmap_t &banmap) EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Definition: banman.cpp:174
void ClearBanned() EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Definition: banman.cpp:72
bool Unban(const CNetAddr &net_addr) EXCLUSIVE_LOCKS_REQUIRED(!m_banned_mutex)
Definition: banman.cpp:156
A CService with information about it as peer.
Definition: protocol.h:367
ServiceFlags nServices
Serialized as uint64_t in V1, and as CompactSize in V2.
Definition: protocol.h:459
NodeSeconds nTime
Always included in serialization. The behavior is unspecified if the value is not representable as ui...
Definition: protocol.h:457
Definition: net_types.h:15
int64_t nCreateTime
Definition: net_types.h:19
int64_t nBanUntil
Definition: net_types.h:20
ChainType GetChainType() const
Return the chain type.
Definition: chainparams.h:112
Definition: net.h:1060
bool ForNode(NodeId id, std::function< bool(CNode *pnode)> func)
Definition: net.cpp:3946
bool GetNetworkActive() const
Definition: net.h:1155
std::vector< CAddress > GetAddressesUnsafe(size_t max_addresses, size_t max_pct, std::optional< Network > network, const bool filtered=true) const
Return randomly selected addresses.
Definition: net.cpp:3535
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,...
Definition: net.cpp:3763
uint64_t GetMaxOutboundTarget() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3729
bool DisconnectNode(std::string_view node)
Definition: net.cpp:3661
std::chrono::seconds GetMaxOutboundTimeframe() const
Definition: net.cpp:3736
ServiceFlags GetLocalServices() const
Used to convey which local services we are offering peers during node connection.
Definition: net.cpp:3806
bool AddNode(const AddedNodeParams &add) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
Definition: net.cpp:3584
bool AddConnection(const std::string &address, ConnectionType conn_type, bool use_v2transport) EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex)
Attempts to open a connection.
Definition: net.cpp:1872
std::vector< AddedNodeInfo > GetAddedNodeInfo(bool include_connected) const EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
Definition: net.cpp:2908
size_t GetNodeCount(ConnectionDirection) const
Definition: net.cpp:3621
uint32_t GetMappedAS(const CNetAddr &addr) const
Definition: net.cpp:3644
void GetNodeStats(std::vector< CNodeStats > &vstats) const
Definition: net.cpp:3649
uint64_t GetTotalBytesRecv() const
Definition: net.cpp:3794
bool OpenNetworkConnection(const CAddress &addrConnect, bool fCountFailure, CountingSemaphoreGrant<> &&grant_outbound, const char *pszDest, ConnectionType conn_type, bool use_v2transport, const std::optional< Proxy > &proxy_override=std::nullopt) EXCLUSIVE_LOCKS_REQUIRED(!m_unused_i2p_sessions_mutex)
Open a new P2P connection and initialize it with the PeerManager at m_msgproc.
Definition: net.cpp:2999
void SetNetworkActive(bool active)
Definition: net.cpp:3217
std::chrono::seconds GetMaxOutboundTimeLeftInCycle() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3741
uint64_t GetTotalBytesSent() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3799
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...
Definition: net.cpp:3784
void PushMessage(CNode *pnode, CSerializedNetMsg &&msg) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3899
static constexpr size_t MESSAGE_TYPE_SIZE
Definition: protocol.h:31
Network address.
Definition: netaddress.h:113
Network GetNetClass() const
Definition: netaddress.cpp:674
std::string ToStringAddr() const
Definition: netaddress.cpp:580
bool IsValid() const
Definition: netaddress.cpp:424
Information about a peer.
Definition: net.h:676
RPC command dispatcher.
Definition: server.h:87
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:530
uint16_t GetPort() const
Definition: netaddress.cpp:835
bool IsValid() const
static std::vector< std::string > ToStrings(NetPermissionFlags flags)
virtual void SendPings()=0
Send ping message to all peers.
virtual bool GetNodeStateStats(NodeId nodeid, CNodeStateStats &stats) const =0
Get statistics from node state.
Definition: netbase.h:59
std::string ToString() const
Definition: netbase.h:82
bool IsValid() const
Definition: netbase.h:70
bool m_tor_stream_isolation
Definition: netbase.h:68
std::string ToString() const
Definition: util.cpp:770
auto Arg(std::string_view key) const
Helper to get a required or default-valued request argument.
Definition: util.h:444
auto MaybeArg(std::string_view key) const
Helper to get an optional request argument.
Definition: util.h:476
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:131
void push_back(UniValue val)
Definition: univalue.cpp:104
@ VNULL
Definition: univalue.h:24
@ VOBJ
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
void pushKVEnd(std::string key, UniValue val)
Definition: univalue.cpp:118
Int getInt() const
Definition: univalue.h:140
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
static const int CLIENT_VERSION
Definition: clientversion.h:26
std::string TransportTypeAsString(TransportProtocolType transport_type)
Convert TransportProtocolType enum to a string value.
std::string ConnectionTypeAsString(ConnectionType conn_type)
Convert ConnectionType enum to a string value.
ConnectionType
Different types of connections to a peer.
@ BLOCK_RELAY
We use block-relay-only connections to help prevent against partition attacks.
@ MANUAL
We open manual connections to addresses that users explicitly requested via the addnode RPC or the -a...
@ OUTBOUND_FULL_RELAY
These are the default connections that we use to connect with the network.
@ FEELER
Feeler connections are short-lived connections made to check that a node is alive.
@ ADDR_FETCH
AddrFetch connections are short lived connections used to solicit addresses from peers.
UniValue ValueFromAmount(const CAmount amount)
Definition: core_write.cpp:26
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
const std::string CURRENCY_UNIT
Definition: feerate.h:18
Definition: messages.h:21
UniValue GetWarningsForRpc(const Warnings &warnings, bool use_deprecated)
RPC helper function that wraps warnings.GetMessages().
Definition: warnings.cpp:54
std::string_view TrimStringView(std::string_view str, std::string_view pattern=" \f\n\r\t\v")
Definition: string.h:158
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:204
std::string strSubVersion
Subversion as sent to the P2P network in version messages.
Definition: net.cpp:120
const std::string NET_MESSAGE_TYPE_OTHER
Definition: net.cpp:108
GlobalMutex g_maplocalhost_mutex
Definition: net.cpp:118
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:71
int64_t NodeId
Definition: net.h:99
const std::vector< std::string > NET_PERMISSIONS_DOC
std::map< CSubNet, CBanEntry > banmap_t
Definition: net_types.h:41
Network
A network type.
Definition: netaddress.h:33
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:57
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:35
@ NET_INTERNAL
A set of addresses that represent the hash of a string or FQDN.
Definition: netaddress.h:54
CSubNet LookupSubNet(const std::string &subnet_str)
Parse and resolve a specified subnet string into the appropriate internal representation.
Definition: netbase.cpp:812
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.
Definition: netbase.cpp:173
std::string GetNetworkName(enum Network net)
Definition: netbase.cpp:114
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:100
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...
Definition: netbase.cpp:942
ReachableNets g_reachable_nets
Definition: netbase.cpp:43
bool GetProxy(enum Network net, Proxy &proxyInfoOut)
Definition: netbase.cpp:709
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:130
std::vector< std::string > serviceFlagsToStr(uint64_t flags)
Convert service flags (a bitmask of NODE_*) to human readable strings.
Definition: protocol.cpp:108
ServiceFlags
nServices flags
Definition: protocol.h:309
@ NODE_P2P_V2
Definition: protocol.h:330
@ NODE_WITNESS
Definition: protocol.h:320
@ NODE_NETWORK
Definition: protocol.h:315
static const int PROTOCOL_VERSION
network protocol versioning
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:70
const std::vector< std::string > CONNECTION_TYPE_DOC
Definition: net.cpp:45
void RegisterNetRPCCommands(CRPCTable &t)
Definition: net.cpp:1196
static RPCHelpMan getnetworkinfo()
Definition: net.cpp:632
static RPCHelpMan addconnection()
Definition: net.cpp:380
static RPCHelpMan getaddednodeinfo()
Definition: net.cpp:489
static RPCHelpMan clearbanned()
Definition: net.cpp:867
static RPCHelpMan getnettotals()
Definition: net.cpp:563
static RPCHelpMan getaddrmaninfo()
Definition: net.cpp:1080
static RPCHelpMan addnode()
Definition: net.cpp:316
static RPCHelpMan getnodeaddresses()
Definition: net.cpp:911
static RPCHelpMan setban()
Definition: net.cpp:739
static RPCHelpMan getrawaddrman()
Definition: net.cpp:1156
static UniValue GetNetworksInfo()
Definition: net.cpp:613
static RPCHelpMan ping()
Definition: net.cpp:83
UniValue AddrmanTableToJSON(const std::vector< std::pair< AddrInfo, AddressPosition > > &tableInfos, const CConnman &connman)
Definition: net.cpp:1140
static RPCHelpMan getconnectioncount()
Definition: net.cpp:60
static RPCHelpMan disconnectnode()
Definition: net.cpp:443
static RPCHelpMan listbanned()
Definition: net.cpp:819
const std::vector< std::string > TRANSPORT_TYPE_DOC
Definition: net.cpp:54
static UniValue GetServicesNames(ServiceFlags services)
Returns, given services flags, a list of humanly readable (known) network services.
Definition: net.cpp:109
static RPCHelpMan setnetworkactive()
Definition: net.cpp:889
static RPCHelpMan addpeeraddress()
Definition: net.cpp:972
static RPCHelpMan getpeerinfo()
Definition: net.cpp:120
UniValue AddrmanEntryToJSON(const AddrInfo &info, const CConnman &connman)
Definition: net.cpp:1119
static RPCHelpMan sendmsgtopeer()
Definition: net.cpp:1032
@ RPC_CLIENT_NODE_NOT_CONNECTED
Node to disconnect not found in connected nodes.
Definition: protocol.h:62
@ RPC_CLIENT_INVALID_IP_OR_SUBNET
Invalid IP/Subnet.
Definition: protocol.h:63
@ RPC_MISC_ERROR
General application defined errors.
Definition: protocol.h:40
@ RPC_CLIENT_NODE_ALREADY_ADDED
Node is already added.
Definition: protocol.h:60
@ RPC_INVALID_PARAMS
Definition: protocol.h:33
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
Definition: protocol.h:44
@ RPC_CLIENT_NODE_NOT_ADDED
Node has not been added before.
Definition: protocol.h:61
@ RPC_CLIENT_NODE_CAPACITY_REACHED
Max number of outbound or block-relay connections already open.
Definition: protocol.h:65
std::string HelpExampleCli(const std::string &methodname, const std::string &args)
Definition: util.cpp:183
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:201
const std::string UNIX_EPOCH_TIME
String used to describe UNIX epoch time in documentation, factored out to a constant for consistency.
Definition: util.cpp:43
bool IsDeprecatedRPCEnabled(const std::string &method)
Definition: server.cpp:339
static RPCHelpMan help()
Definition: server.cpp:119
BanMan & EnsureBanman(const NodeContext &node)
Definition: server_util.cpp:48
AddrMan & EnsureAnyAddrman(const std::any &context)
NodeContext & EnsureAnyNodeContext(const std::any &context)
Definition: server_util.cpp:25
BanMan & EnsureAnyBanman(const std::any &context)
Definition: server_util.cpp:56
PeerManager & EnsurePeerman(const NodeContext &node)
CConnman & EnsureConnman(const NodeContext &node)
Location information for an address in AddrMan.
Definition: addrman.h:35
const int bucket
Definition: addrman.h:48
const int position
Definition: addrman.h:49
std::chrono::microseconds m_ping_wait
std::vector< int > vHeightInFlight
CAmount m_fee_filter_received
std::chrono::seconds time_offset
uint64_t m_addr_rate_limited
uint64_t m_last_inv_seq
uint64_t m_addr_processed
int64_t presync_height
ServiceFlags their_services
std::string m_type
Definition: net.h:133
std::vector< unsigned char > data
Definition: net.h:132
@ STR_HEX
Special type that is a STR with only hex chars.
std::string DefaultHint
Hint for default value.
Definition: util.h:220
@ NO
Required arg.
@ NUM_TIME
Special numeric to denote unix epoch time.
@ OBJ_DYN
Special dictionary with keys that are not literals.
@ STR_HEX
Special string with only hex chars.
NodeContext struct containing references to chain state and connection state.
Definition: context.h:56
#define LOCK(cs)
Definition: sync.h:259
static int count
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.cpp:77
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:82