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