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 <vector>
40
42using 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", "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 obj.pushKV("startingheight", statestats.m_starting_height);
271 obj.pushKV("presynced_headers", statestats.presync_height);
272 obj.pushKV("synced_headers", statestats.nSyncHeight);
273 obj.pushKV("synced_blocks", statestats.nCommonHeight);
274 UniValue heights(UniValue::VARR);
275 for (const int height : statestats.vHeightInFlight) {
276 heights.push_back(height);
277 }
278 obj.pushKV("inflight", std::move(heights));
279 obj.pushKV("addr_relay_enabled", statestats.m_addr_relay_enabled);
280 obj.pushKV("addr_processed", statestats.m_addr_processed);
281 obj.pushKV("addr_rate_limited", statestats.m_addr_rate_limited);
282 UniValue permissions(UniValue::VARR);
283 for (const auto& permission : NetPermissions::ToStrings(stats.m_permission_flags)) {
284 permissions.push_back(permission);
285 }
286 obj.pushKV("permissions", std::move(permissions));
287 obj.pushKV("minfeefilter", ValueFromAmount(statestats.m_fee_filter_received));
288
289 UniValue sendPerMsgType(UniValue::VOBJ);
290 for (const auto& i : stats.mapSendBytesPerMsgType) {
291 if (i.second > 0)
292 sendPerMsgType.pushKV(i.first, i.second);
293 }
294 obj.pushKV("bytessent_per_msg", std::move(sendPerMsgType));
295
296 UniValue recvPerMsgType(UniValue::VOBJ);
297 for (const auto& i : stats.mapRecvBytesPerMsgType) {
298 if (i.second > 0)
299 recvPerMsgType.pushKV(i.first, i.second);
300 }
301 obj.pushKV("bytesrecv_per_msg", std::move(recvPerMsgType));
302 obj.pushKV("connection_type", ConnectionTypeAsString(stats.m_conn_type));
303 obj.pushKV("transport_protocol_type", TransportTypeAsString(stats.m_transport_type));
304 obj.pushKV("session_id", stats.m_session_id);
305
306 ret.push_back(std::move(obj));
307 }
308
309 return ret;
310},
311 };
312}
313
315{
316 return RPCHelpMan{
317 "addnode",
318 "Attempts to add or remove a node from the addnode list.\n"
319 "Or try a connection to a node once.\n"
320 "Nodes added using addnode (or -connect) are protected from DoS disconnection and are not required to be\n"
321 "full nodes/support SegWit as other outbound peers are (though such peers will not be synced from).\n" +
322 strprintf("Addnode connections are limited to %u at a time", MAX_ADDNODE_CONNECTIONS) +
323 " and are counted separately from the -maxconnections limit.\n",
324 {
325 {"node", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address/hostname optionally followed by :port of the peer to connect to"},
326 {"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"},
327 {"v2transport", RPCArg::Type::BOOL, RPCArg::DefaultHint{"set by -v2transport"}, "Attempt to connect using BIP324 v2 transport protocol (ignored for 'remove' command)"},
328 },
331 HelpExampleCli("addnode", "\"192.168.0.6:8333\" \"onetry\" true")
332 + HelpExampleRpc("addnode", "\"192.168.0.6:8333\", \"onetry\" true")
333 },
334 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
335{
336 const auto command{self.Arg<std::string>("command")};
337 if (command != "onetry" && command != "add" && command != "remove") {
338 throw std::runtime_error(
339 self.ToString());
340 }
341
342 NodeContext& node = EnsureAnyNodeContext(request.context);
343 CConnman& connman = EnsureConnman(node);
344
345 const auto node_arg{self.Arg<std::string>("node")};
346 bool node_v2transport = connman.GetLocalServices() & NODE_P2P_V2;
347 bool use_v2transport = self.MaybeArg<bool>("v2transport").value_or(node_v2transport);
348
349 if (use_v2transport && !node_v2transport) {
350 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: v2transport requested but not enabled (see -v2transport)");
351 }
352
353 if (command == "onetry")
354 {
355 CAddress addr;
356 connman.OpenNetworkConnection(addr, /*fCountFailure=*/false, /*grant_outbound=*/{}, node_arg.c_str(), ConnectionType::MANUAL, use_v2transport);
357 return UniValue::VNULL;
358 }
359
360 if (command == "add")
361 {
362 if (!connman.AddNode({node_arg, use_v2transport})) {
363 throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: Node already added");
364 }
365 }
366 else if (command == "remove")
367 {
368 if (!connman.RemoveAddedNode(node_arg)) {
369 throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node could not be removed. It has not been added previously.");
370 }
371 }
372
373 return UniValue::VNULL;
374},
375 };
376}
377
379{
380 return RPCHelpMan{
381 "addconnection",
382 "Open an outbound connection to a specified node. This RPC is for testing only.\n",
383 {
384 {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address and port to attempt connecting to."},
385 {"connection_type", RPCArg::Type::STR, RPCArg::Optional::NO, "Type of connection to open (\"outbound-full-relay\", \"block-relay-only\", \"addr-fetch\" or \"feeler\")."},
386 {"v2transport", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Attempt to connect using BIP324 v2 transport protocol"},
387 },
388 RPCResult{
389 RPCResult::Type::OBJ, "", "",
390 {
391 { RPCResult::Type::STR, "address", "Address of newly added connection." },
392 { RPCResult::Type::STR, "connection_type", "Type of connection opened." },
393 }},
395 HelpExampleCli("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")
396 + HelpExampleRpc("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")
397 },
398 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
399{
401 throw std::runtime_error("addconnection is for regression testing (-regtest mode) only.");
402 }
403
404 const std::string address = request.params[0].get_str();
405 const std::string conn_type_in{TrimString(request.params[1].get_str())};
406 ConnectionType conn_type{};
407 if (conn_type_in == "outbound-full-relay") {
409 } else if (conn_type_in == "block-relay-only") {
410 conn_type = ConnectionType::BLOCK_RELAY;
411 } else if (conn_type_in == "addr-fetch") {
412 conn_type = ConnectionType::ADDR_FETCH;
413 } else if (conn_type_in == "feeler") {
414 conn_type = ConnectionType::FEELER;
415 } else {
417 }
418 bool use_v2transport{self.Arg<bool>("v2transport")};
419
420 NodeContext& node = EnsureAnyNodeContext(request.context);
421 CConnman& connman = EnsureConnman(node);
422
423 if (use_v2transport && !(connman.GetLocalServices() & NODE_P2P_V2)) {
424 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Adding v2transport connections requires -v2transport init flag to be set.");
425 }
426
427 const bool success = connman.AddConnection(address, conn_type, use_v2transport);
428 if (!success) {
429 throw JSONRPCError(RPC_CLIENT_NODE_CAPACITY_REACHED, "Error: Already at capacity for specified connection type.");
430 }
431
433 info.pushKV("address", address);
434 info.pushKV("connection_type", conn_type_in);
435
436 return info;
437},
438 };
439}
440
442{
443 return RPCHelpMan{
444 "disconnectnode",
445 "Immediately disconnects from the specified peer node.\n"
446 "\nStrictly one out of 'address' and 'nodeid' can be provided to identify the node.\n"
447 "\nTo disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.\n",
448 {
449 {"address", RPCArg::Type::STR, RPCArg::DefaultHint{"fallback to nodeid"}, "The IP address/port of the node"},
450 {"nodeid", RPCArg::Type::NUM, RPCArg::DefaultHint{"fallback to address"}, "The node ID (see getpeerinfo for node IDs)"},
451 },
454 HelpExampleCli("disconnectnode", "\"192.168.0.6:8333\"")
455 + HelpExampleCli("disconnectnode", "\"\" 1")
456 + HelpExampleRpc("disconnectnode", "\"192.168.0.6:8333\"")
457 + HelpExampleRpc("disconnectnode", "\"\", 1")
458 },
459 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
460{
461 NodeContext& node = EnsureAnyNodeContext(request.context);
462 CConnman& connman = EnsureConnman(node);
463
464 bool success;
465 const UniValue &address_arg = request.params[0];
466 const UniValue &id_arg = request.params[1];
467
468 if (!address_arg.isNull() && id_arg.isNull()) {
469 /* handle disconnect-by-address */
470 success = connman.DisconnectNode(address_arg.get_str());
471 } else if (!id_arg.isNull() && (address_arg.isNull() || (address_arg.isStr() && address_arg.get_str().empty()))) {
472 /* handle disconnect-by-id */
473 NodeId nodeid = (NodeId) id_arg.getInt<int64_t>();
474 success = connman.DisconnectNode(nodeid);
475 } else {
476 throw JSONRPCError(RPC_INVALID_PARAMS, "Only one of address and nodeid should be provided.");
477 }
478
479 if (!success) {
480 throw JSONRPCError(RPC_CLIENT_NODE_NOT_CONNECTED, "Node not found in connected nodes");
481 }
482
483 return UniValue::VNULL;
484},
485 };
486}
487
489{
490 return RPCHelpMan{
491 "getaddednodeinfo",
492 "Returns information about the given added node, or all added nodes\n"
493 "(note that onetry addnodes are not listed here)\n",
494 {
495 {"node", RPCArg::Type::STR, RPCArg::DefaultHint{"all nodes"}, "If provided, return information about this specific node, otherwise all nodes are returned."},
496 },
497 RPCResult{
498 RPCResult::Type::ARR, "", "",
499 {
500 {RPCResult::Type::OBJ, "", "",
501 {
502 {RPCResult::Type::STR, "addednode", "The node IP address or name (as provided to addnode)"},
503 {RPCResult::Type::BOOL, "connected", "If connected"},
504 {RPCResult::Type::ARR, "addresses", "Only when connected = true",
505 {
506 {RPCResult::Type::OBJ, "", "",
507 {
508 {RPCResult::Type::STR, "address", "The bitcoin server IP and port we're connected to"},
509 {RPCResult::Type::STR, "connected", "connection, inbound or outbound"},
510 }},
511 }},
512 }},
513 }
514 },
516 HelpExampleCli("getaddednodeinfo", "\"192.168.0.201\"")
517 + HelpExampleRpc("getaddednodeinfo", "\"192.168.0.201\"")
518 },
519 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
520{
521 NodeContext& node = EnsureAnyNodeContext(request.context);
522 const CConnman& connman = EnsureConnman(node);
523
524 std::vector<AddedNodeInfo> vInfo = connman.GetAddedNodeInfo(/*include_connected=*/true);
525
526 if (!request.params[0].isNull()) {
527 bool found = false;
528 for (const AddedNodeInfo& info : vInfo) {
529 if (info.m_params.m_added_node == request.params[0].get_str()) {
530 vInfo.assign(1, info);
531 found = true;
532 break;
533 }
534 }
535 if (!found) {
536 throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node has not been added.");
537 }
538 }
539
541
542 for (const AddedNodeInfo& info : vInfo) {
544 obj.pushKV("addednode", info.m_params.m_added_node);
545 obj.pushKV("connected", info.fConnected);
546 UniValue addresses(UniValue::VARR);
547 if (info.fConnected) {
548 UniValue address(UniValue::VOBJ);
549 address.pushKV("address", info.resolvedAddress.ToStringAddrPort());
550 address.pushKV("connected", info.fInbound ? "inbound" : "outbound");
551 addresses.push_back(std::move(address));
552 }
553 obj.pushKV("addresses", std::move(addresses));
554 ret.push_back(std::move(obj));
555 }
556
557 return ret;
558},
559 };
560}
561
563{
564 return RPCHelpMan{"getnettotals",
565 "Returns information about network traffic, including bytes in, bytes out,\n"
566 "and current system time.",
567 {},
568 RPCResult{
569 RPCResult::Type::OBJ, "", "",
570 {
571 {RPCResult::Type::NUM, "totalbytesrecv", "Total bytes received"},
572 {RPCResult::Type::NUM, "totalbytessent", "Total bytes sent"},
573 {RPCResult::Type::NUM_TIME, "timemillis", "Current system " + UNIX_EPOCH_TIME + " in milliseconds"},
574 {RPCResult::Type::OBJ, "uploadtarget", "",
575 {
576 {RPCResult::Type::NUM, "timeframe", "Length of the measuring timeframe in seconds"},
577 {RPCResult::Type::NUM, "target", "Target in bytes"},
578 {RPCResult::Type::BOOL, "target_reached", "True if target is reached"},
579 {RPCResult::Type::BOOL, "serve_historical_blocks", "True if serving historical blocks"},
580 {RPCResult::Type::NUM, "bytes_left_in_cycle", "Bytes left in current time cycle"},
581 {RPCResult::Type::NUM, "time_left_in_cycle", "Seconds left in current time cycle"},
582 }},
583 }
584 },
586 HelpExampleCli("getnettotals", "")
587 + HelpExampleRpc("getnettotals", "")
588 },
589 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
590{
591 NodeContext& node = EnsureAnyNodeContext(request.context);
592 const CConnman& connman = EnsureConnman(node);
593
595 obj.pushKV("totalbytesrecv", connman.GetTotalBytesRecv());
596 obj.pushKV("totalbytessent", connman.GetTotalBytesSent());
597 obj.pushKV("timemillis", TicksSinceEpoch<std::chrono::milliseconds>(SystemClock::now()));
598
599 UniValue outboundLimit(UniValue::VOBJ);
600 outboundLimit.pushKV("timeframe", count_seconds(connman.GetMaxOutboundTimeframe()));
601 outboundLimit.pushKV("target", connman.GetMaxOutboundTarget());
602 outboundLimit.pushKV("target_reached", connman.OutboundTargetReached(false));
603 outboundLimit.pushKV("serve_historical_blocks", !connman.OutboundTargetReached(true));
604 outboundLimit.pushKV("bytes_left_in_cycle", connman.GetOutboundTargetBytesLeft());
605 outboundLimit.pushKV("time_left_in_cycle", count_seconds(connman.GetMaxOutboundTimeLeftInCycle()));
606 obj.pushKV("uploadtarget", std::move(outboundLimit));
607 return obj;
608},
609 };
610}
611
613{
614 UniValue networks(UniValue::VARR);
615 for (int n = 0; n < NET_MAX; ++n) {
616 enum Network network = static_cast<enum Network>(n);
617 if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
618 Proxy proxy;
620 GetProxy(network, proxy);
621 obj.pushKV("name", GetNetworkName(network));
622 obj.pushKV("limited", !g_reachable_nets.Contains(network));
623 obj.pushKV("reachable", g_reachable_nets.Contains(network));
624 obj.pushKV("proxy", proxy.IsValid() ? proxy.ToString() : std::string());
625 obj.pushKV("proxy_randomize_credentials", proxy.m_tor_stream_isolation);
626 networks.push_back(std::move(obj));
627 }
628 return networks;
629}
630
632{
633 return RPCHelpMan{"getnetworkinfo",
634 "Returns an object containing various state info regarding P2P networking.\n",
635 {},
636 RPCResult{
637 RPCResult::Type::OBJ, "", "",
638 {
639 {RPCResult::Type::NUM, "version", "the server version"},
640 {RPCResult::Type::STR, "subversion", "the server subversion string"},
641 {RPCResult::Type::NUM, "protocolversion", "the protocol version"},
642 {RPCResult::Type::STR_HEX, "localservices", "the services we offer to the network"},
643 {RPCResult::Type::ARR, "localservicesnames", "the services we offer to the network, in human-readable form",
644 {
645 {RPCResult::Type::STR, "SERVICE_NAME", "the service name"},
646 }},
647 {RPCResult::Type::BOOL, "localrelay", "true if transaction relay is requested from peers"},
648 {RPCResult::Type::NUM, "timeoffset", "the time offset"},
649 {RPCResult::Type::NUM, "connections", "the total number of connections"},
650 {RPCResult::Type::NUM, "connections_in", "the number of inbound connections"},
651 {RPCResult::Type::NUM, "connections_out", "the number of outbound connections"},
652 {RPCResult::Type::BOOL, "networkactive", "whether p2p networking is enabled"},
653 {RPCResult::Type::ARR, "networks", "information per network",
654 {
655 {RPCResult::Type::OBJ, "", "",
656 {
657 {RPCResult::Type::STR, "name", "network (" + Join(GetNetworkNames(), ", ") + ")"},
658 {RPCResult::Type::BOOL, "limited", "is the network limited using -onlynet?"},
659 {RPCResult::Type::BOOL, "reachable", "is the network reachable?"},
660 {RPCResult::Type::STR, "proxy", "(\"host:port\") the proxy that is used for this network, or empty if none"},
661 {RPCResult::Type::BOOL, "proxy_randomize_credentials", "Whether randomized credentials are used"},
662 }},
663 }},
664 {RPCResult::Type::NUM, "relayfee", "minimum relay fee rate for transactions in " + CURRENCY_UNIT + "/kvB"},
665 {RPCResult::Type::NUM, "incrementalfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
666 {RPCResult::Type::ARR, "localaddresses", "list of local addresses",
667 {
668 {RPCResult::Type::OBJ, "", "",
669 {
670 {RPCResult::Type::STR, "address", "network address"},
671 {RPCResult::Type::NUM, "port", "network port"},
672 {RPCResult::Type::NUM, "score", "relative score"},
673 }},
674 }},
675 (IsDeprecatedRPCEnabled("warnings") ?
676 RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :
677 RPCResult{RPCResult::Type::ARR, "warnings", "any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",
678 {
679 {RPCResult::Type::STR, "", "warning"},
680 }
681 }
682 ),
683 }
684 },
686 HelpExampleCli("getnetworkinfo", "")
687 + HelpExampleRpc("getnetworkinfo", "")
688 },
689 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
690{
691 LOCK(cs_main);
693 obj.pushKV("version", CLIENT_VERSION);
694 obj.pushKV("subversion", strSubVersion);
695 obj.pushKV("protocolversion",PROTOCOL_VERSION);
696 NodeContext& node = EnsureAnyNodeContext(request.context);
697 if (node.connman) {
698 ServiceFlags services = node.connman->GetLocalServices();
699 obj.pushKV("localservices", strprintf("%016x", services));
700 obj.pushKV("localservicesnames", GetServicesNames(services));
701 }
702 if (node.peerman) {
703 auto peerman_info{node.peerman->GetInfo()};
704 obj.pushKV("localrelay", !peerman_info.ignores_incoming_txs);
705 obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(peerman_info.median_outbound_time_offset));
706 }
707 if (node.connman) {
708 obj.pushKV("networkactive", node.connman->GetNetworkActive());
709 obj.pushKV("connections", node.connman->GetNodeCount(ConnectionDirection::Both));
710 obj.pushKV("connections_in", node.connman->GetNodeCount(ConnectionDirection::In));
711 obj.pushKV("connections_out", node.connman->GetNodeCount(ConnectionDirection::Out));
712 }
713 obj.pushKV("networks", GetNetworksInfo());
714 if (node.mempool) {
715 // Those fields can be deprecated, to be replaced by the getmempoolinfo fields
716 obj.pushKV("relayfee", ValueFromAmount(node.mempool->m_opts.min_relay_feerate.GetFeePerK()));
717 obj.pushKV("incrementalfee", ValueFromAmount(node.mempool->m_opts.incremental_relay_feerate.GetFeePerK()));
718 }
719 UniValue localAddresses(UniValue::VARR);
720 {
722 for (const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)
723 {
725 rec.pushKV("address", item.first.ToStringAddr());
726 rec.pushKV("port", item.second.nPort);
727 rec.pushKV("score", item.second.nScore);
728 localAddresses.push_back(std::move(rec));
729 }
730 }
731 obj.pushKV("localaddresses", std::move(localAddresses));
732 obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));
733 return obj;
734},
735 };
736}
737
739{
740 return RPCHelpMan{
741 "setban",
742 "Attempts to add or remove an IP/Subnet from the banned list.\n",
743 {
744 {"subnet", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)"},
745 {"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"},
746 {"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)"},
747 {"absolute", RPCArg::Type::BOOL, RPCArg::Default{false}, "If set, the bantime must be an absolute timestamp expressed in " + UNIX_EPOCH_TIME},
748 },
751 HelpExampleCli("setban", "\"192.168.0.6\" \"add\" 86400")
752 + HelpExampleCli("setban", "\"192.168.0.0/24\" \"add\"")
753 + HelpExampleRpc("setban", "\"192.168.0.6\", \"add\", 86400")
754 },
755 [&](const RPCHelpMan& help, const JSONRPCRequest& request) -> UniValue
756{
757 std::string strCommand;
758 if (!request.params[1].isNull())
759 strCommand = request.params[1].get_str();
760 if (strCommand != "add" && strCommand != "remove") {
761 throw std::runtime_error(help.ToString());
762 }
763 NodeContext& node = EnsureAnyNodeContext(request.context);
764 BanMan& banman = EnsureBanman(node);
765
766 CSubNet subNet;
767 CNetAddr netAddr;
768 bool isSubnet = false;
769
770 if (request.params[0].get_str().find('/') != std::string::npos)
771 isSubnet = true;
772
773 if (!isSubnet) {
774 const std::optional<CNetAddr> addr{LookupHost(request.params[0].get_str(), false)};
775 if (addr.has_value()) {
776 netAddr = static_cast<CNetAddr>(MaybeFlipIPv6toCJDNS(CService{addr.value(), /*port=*/0}));
777 }
778 }
779 else
780 subNet = LookupSubNet(request.params[0].get_str());
781
782 if (! (isSubnet ? subNet.IsValid() : netAddr.IsValid()) )
783 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Invalid IP/Subnet");
784
785 if (strCommand == "add")
786 {
787 if (isSubnet ? banman.IsBanned(subNet) : banman.IsBanned(netAddr)) {
788 throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: IP/Subnet already banned");
789 }
790
791 int64_t banTime = 0; //use standard bantime if not specified
792 if (!request.params[2].isNull())
793 banTime = request.params[2].getInt<int64_t>();
794
795 const bool absolute{request.params[3].isNull() ? false : request.params[3].get_bool()};
796
797 if (absolute && banTime < GetTime()) {
798 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Absolute timestamp is in the past");
799 }
800
801 if (isSubnet) {
802 banman.Ban(subNet, banTime, absolute);
803 if (node.connman) {
804 node.connman->DisconnectNode(subNet);
805 }
806 } else {
807 banman.Ban(netAddr, banTime, absolute);
808 if (node.connman) {
809 node.connman->DisconnectNode(netAddr);
810 }
811 }
812 }
813 else if(strCommand == "remove")
814 {
815 if (!( isSubnet ? banman.Unban(subNet) : banman.Unban(netAddr) )) {
816 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Unban failed. Requested address/subnet was not previously manually banned.");
817 }
818 }
819 return UniValue::VNULL;
820},
821 };
822}
823
825{
826 return RPCHelpMan{
827 "listbanned",
828 "List all manually banned IPs/Subnets.\n",
829 {},
831 {
832 {RPCResult::Type::OBJ, "", "",
833 {
834 {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},
835 {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},
836 {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},
837 {RPCResult::Type::NUM_TIME, "ban_duration", "The ban duration, in seconds"},
838 {RPCResult::Type::NUM_TIME, "time_remaining", "The time remaining until the ban expires, in seconds"},
839 }},
840 }},
842 HelpExampleCli("listbanned", "")
843 + HelpExampleRpc("listbanned", "")
844 },
845 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
846{
847 BanMan& banman = EnsureAnyBanman(request.context);
848
849 banmap_t banMap;
850 banman.GetBanned(banMap);
851 const int64_t current_time{GetTime()};
852
853 UniValue bannedAddresses(UniValue::VARR);
854 for (const auto& entry : banMap)
855 {
856 const CBanEntry& banEntry = entry.second;
858 rec.pushKV("address", entry.first.ToString());
859 rec.pushKV("ban_created", banEntry.nCreateTime);
860 rec.pushKV("banned_until", banEntry.nBanUntil);
861 rec.pushKV("ban_duration", (banEntry.nBanUntil - banEntry.nCreateTime));
862 rec.pushKV("time_remaining", (banEntry.nBanUntil - current_time));
863
864 bannedAddresses.push_back(std::move(rec));
865 }
866
867 return bannedAddresses;
868},
869 };
870}
871
873{
874 return RPCHelpMan{
875 "clearbanned",
876 "Clear all banned IPs.\n",
877 {},
880 HelpExampleCli("clearbanned", "")
881 + HelpExampleRpc("clearbanned", "")
882 },
883 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
884{
885 BanMan& banman = EnsureAnyBanman(request.context);
886
887 banman.ClearBanned();
888
889 return UniValue::VNULL;
890},
891 };
892}
893
895{
896 return RPCHelpMan{
897 "setnetworkactive",
898 "Disable/enable all p2p network activity.\n",
899 {
900 {"state", RPCArg::Type::BOOL, RPCArg::Optional::NO, "true to enable networking, false to disable"},
901 },
902 RPCResult{RPCResult::Type::BOOL, "", "The value that was passed in"},
903 RPCExamples{""},
904 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
905{
906 NodeContext& node = EnsureAnyNodeContext(request.context);
907 CConnman& connman = EnsureConnman(node);
908
909 connman.SetNetworkActive(request.params[0].get_bool());
910
911 return connman.GetNetworkActive();
912},
913 };
914}
915
917{
918 return RPCHelpMan{"getnodeaddresses",
919 "Return known addresses, after filtering for quality and recency.\n"
920 "These can potentially be used to find new peers in the network.\n"
921 "The total number of addresses known to the node may be higher.",
922 {
923 {"count", RPCArg::Type::NUM, RPCArg::Default{1}, "The maximum number of addresses to return. Specify 0 to return all known addresses."},
924 {"network", RPCArg::Type::STR, RPCArg::DefaultHint{"all networks"}, "Return only addresses of the specified network. Can be one of: " + Join(GetNetworkNames(), ", ") + "."},
925 },
926 RPCResult{
927 RPCResult::Type::ARR, "", "",
928 {
929 {RPCResult::Type::OBJ, "", "",
930 {
931 {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
932 {RPCResult::Type::NUM, "services", "The services offered by the node"},
933 {RPCResult::Type::STR, "address", "The address of the node"},
934 {RPCResult::Type::NUM, "port", "The port number of the node"},
935 {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") the node connected through"},
936 }},
937 }
938 },
940 HelpExampleCli("getnodeaddresses", "8")
941 + HelpExampleCli("getnodeaddresses", "4 \"i2p\"")
942 + HelpExampleCli("-named getnodeaddresses", "network=onion count=12")
943 + HelpExampleRpc("getnodeaddresses", "8")
944 + HelpExampleRpc("getnodeaddresses", "4, \"i2p\"")
945 },
946 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
947{
948 NodeContext& node = EnsureAnyNodeContext(request.context);
949 const CConnman& connman = EnsureConnman(node);
950
951 const int count{request.params[0].isNull() ? 1 : request.params[0].getInt<int>()};
952 if (count < 0) throw JSONRPCError(RPC_INVALID_PARAMETER, "Address count out of range");
953
954 const std::optional<Network> network{request.params[1].isNull() ? std::nullopt : std::optional<Network>{ParseNetwork(request.params[1].get_str())}};
955 if (network == NET_UNROUTABLE) {
956 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Network not recognized: %s", request.params[1].get_str()));
957 }
958
959 // returns a shuffled list of CAddress
960 const std::vector<CAddress> vAddr{connman.GetAddressesUnsafe(count, /*max_pct=*/0, network)};
962
963 for (const CAddress& addr : vAddr) {
965 obj.pushKV("time", int64_t{TicksSinceEpoch<std::chrono::seconds>(addr.nTime)});
966 obj.pushKV("services", (uint64_t)addr.nServices);
967 obj.pushKV("address", addr.ToStringAddr());
968 obj.pushKV("port", addr.GetPort());
969 obj.pushKV("network", GetNetworkName(addr.GetNetClass()));
970 ret.push_back(std::move(obj));
971 }
972 return ret;
973},
974 };
975}
976
978{
979 return RPCHelpMan{"addpeeraddress",
980 "Add the address of a potential peer to an address manager table. This RPC is for testing only.",
981 {
982 {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address of the peer"},
983 {"port", RPCArg::Type::NUM, RPCArg::Optional::NO, "The port of the peer"},
984 {"tried", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, attempt to add the peer to the tried addresses table"},
985 },
986 RPCResult{
987 RPCResult::Type::OBJ, "", "",
988 {
989 {RPCResult::Type::BOOL, "success", "whether the peer address was successfully added to the address manager table"},
990 {RPCResult::Type::STR, "error", /*optional=*/true, "error description, if the address could not be added"},
991 },
992 },
994 HelpExampleCli("addpeeraddress", "\"1.2.3.4\" 8333 true")
995 + HelpExampleRpc("addpeeraddress", "\"1.2.3.4\", 8333, true")
996 },
997 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
998{
999 AddrMan& addrman = EnsureAnyAddrman(request.context);
1000
1001 const std::string& addr_string{request.params[0].get_str()};
1002 const auto port{request.params[1].getInt<uint16_t>()};
1003 const bool tried{request.params[2].isNull() ? false : request.params[2].get_bool()};
1004
1006 std::optional<CNetAddr> net_addr{LookupHost(addr_string, false)};
1007 if (!net_addr.has_value()) {
1008 throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Invalid IP address");
1009 }
1010
1011 bool success{false};
1012
1013 CService service{net_addr.value(), port};
1015 address.nTime = Now<NodeSeconds>();
1016 // The source address is set equal to the address. This is equivalent to the peer
1017 // announcing itself.
1018 if (addrman.Add({address}, address)) {
1019 success = true;
1020 if (tried) {
1021 // Attempt to move the address to the tried addresses table.
1022 if (!addrman.Good(address)) {
1023 success = false;
1024 obj.pushKV("error", "failed-adding-to-tried");
1025 }
1026 }
1027 } else {
1028 obj.pushKV("error", "failed-adding-to-new");
1029 }
1030
1031 obj.pushKV("success", success);
1032 return obj;
1033},
1034 };
1035}
1036
1038{
1039 return RPCHelpMan{
1040 "sendmsgtopeer",
1041 "Send a p2p message to a peer specified by id.\n"
1042 "The message type and body must be provided, the message header will be generated.\n"
1043 "This RPC is for testing only.",
1044 {
1045 {"peer_id", RPCArg::Type::NUM, RPCArg::Optional::NO, "The peer to send the message to."},
1046 {"msg_type", RPCArg::Type::STR, RPCArg::Optional::NO, strprintf("The message type (maximum length %i)", CMessageHeader::MESSAGE_TYPE_SIZE)},
1047 {"msg", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The serialized message body to send, in hex, without a message header"},
1048 },
1049 RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
1051 HelpExampleCli("sendmsgtopeer", "0 \"addr\" \"ffffff\"") + HelpExampleRpc("sendmsgtopeer", "0 \"addr\" \"ffffff\"")},
1052 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1053 const NodeId peer_id{request.params[0].getInt<int64_t>()};
1054 const std::string& msg_type{request.params[1].get_str()};
1055 if (msg_type.size() > CMessageHeader::MESSAGE_TYPE_SIZE) {
1056 throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Error: msg_type too long, max length is %i", CMessageHeader::MESSAGE_TYPE_SIZE));
1057 }
1058 auto msg{TryParseHex<unsigned char>(request.params[2].get_str())};
1059 if (!msg.has_value()) {
1060 throw JSONRPCError(RPC_INVALID_PARAMETER, "Error parsing input for msg");
1061 }
1062
1063 NodeContext& node = EnsureAnyNodeContext(request.context);
1064 CConnman& connman = EnsureConnman(node);
1065
1066 CSerializedNetMsg msg_ser;
1067 msg_ser.data = msg.value();
1068 msg_ser.m_type = msg_type;
1069
1070 bool success = connman.ForNode(peer_id, [&](CNode* node) {
1071 connman.PushMessage(node, std::move(msg_ser));
1072 return true;
1073 });
1074
1075 if (!success) {
1076 throw JSONRPCError(RPC_MISC_ERROR, "Error: Could not send message to peer");
1077 }
1078
1080 return ret;
1081 },
1082 };
1083}
1084
1086{
1087 return RPCHelpMan{
1088 "getaddrmaninfo",
1089 "Provides information about the node's address manager by returning the number of "
1090 "addresses in the `new` and `tried` tables and their sum for all networks.\n",
1091 {},
1092 RPCResult{
1093 RPCResult::Type::OBJ_DYN, "", "json object with network type as keys", {
1094 {RPCResult::Type::OBJ, "network", "the network (" + Join(GetNetworkNames(), ", ") + ", all_networks)", {
1095 {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."},
1096 {RPCResult::Type::NUM, "tried", "number of addresses in the tried table, which represent peers the node has successfully connected to in the past."},
1097 {RPCResult::Type::NUM, "total", "total number of addresses in both new/tried tables"},
1098 }},
1099 }},
1100 RPCExamples{HelpExampleCli("getaddrmaninfo", "") + HelpExampleRpc("getaddrmaninfo", "")},
1101 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1102 AddrMan& addrman = EnsureAnyAddrman(request.context);
1103
1105 for (int n = 0; n < NET_MAX; ++n) {
1106 enum Network network = static_cast<enum Network>(n);
1107 if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
1109 obj.pushKV("new", addrman.Size(network, true));
1110 obj.pushKV("tried", addrman.Size(network, false));
1111 obj.pushKV("total", addrman.Size(network));
1112 ret.pushKV(GetNetworkName(network), std::move(obj));
1113 }
1115 obj.pushKV("new", addrman.Size(std::nullopt, true));
1116 obj.pushKV("tried", addrman.Size(std::nullopt, false));
1117 obj.pushKV("total", addrman.Size());
1118 ret.pushKV("all_networks", std::move(obj));
1119 return ret;
1120 },
1121 };
1122}
1123
1124UniValue AddrmanEntryToJSON(const AddrInfo& info, const CConnman& connman)
1125{
1127 ret.pushKV("address", info.ToStringAddr());
1128 const uint32_t mapped_as{connman.GetMappedAS(info)};
1129 if (mapped_as) {
1130 ret.pushKV("mapped_as", mapped_as);
1131 }
1132 ret.pushKV("port", info.GetPort());
1133 ret.pushKV("services", (uint64_t)info.nServices);
1134 ret.pushKV("time", int64_t{TicksSinceEpoch<std::chrono::seconds>(info.nTime)});
1135 ret.pushKV("network", GetNetworkName(info.GetNetClass()));
1136 ret.pushKV("source", info.source.ToStringAddr());
1137 ret.pushKV("source_network", GetNetworkName(info.source.GetNetClass()));
1138 const uint32_t source_mapped_as{connman.GetMappedAS(info.source)};
1139 if (source_mapped_as) {
1140 ret.pushKV("source_mapped_as", source_mapped_as);
1141 }
1142 return ret;
1143}
1144
1145UniValue AddrmanTableToJSON(const std::vector<std::pair<AddrInfo, AddressPosition>>& tableInfos, const CConnman& connman)
1146{
1147 UniValue table(UniValue::VOBJ);
1148 for (const auto& e : tableInfos) {
1149 AddrInfo info = e.first;
1150 AddressPosition location = e.second;
1151 std::ostringstream key;
1152 key << location.bucket << "/" << location.position;
1153 // Address manager tables have unique entries so there is no advantage
1154 // in using UniValue::pushKV, which checks if the key already exists
1155 // in O(N). UniValue::pushKVEnd is used instead which currently is O(1).
1156 table.pushKVEnd(key.str(), AddrmanEntryToJSON(info, connman));
1157 }
1158 return table;
1159}
1160
1162{
1163 return RPCHelpMan{"getrawaddrman",
1164 "EXPERIMENTAL warning: this call may be changed in future releases.\n"
1165 "\nReturns information on all address manager entries for the new and tried tables.\n",
1166 {},
1167 RPCResult{
1168 RPCResult::Type::OBJ_DYN, "", "", {
1169 {RPCResult::Type::OBJ_DYN, "table", "buckets with addresses in the address manager table ( new, tried )", {
1170 {RPCResult::Type::OBJ, "bucket/position", "the location in the address manager table (<bucket>/<position>)", {
1171 {RPCResult::Type::STR, "address", "The address of the node"},
1172 {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)"},
1173 {RPCResult::Type::NUM, "port", "The port number of the node"},
1174 {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the address"},
1175 {RPCResult::Type::NUM, "services", "The services offered by the node"},
1176 {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
1177 {RPCResult::Type::STR, "source", "The address that relayed the address to us"},
1178 {RPCResult::Type::STR, "source_network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the source address"},
1179 {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)"}
1180 }}
1181 }}
1182 }
1183 },
1185 HelpExampleCli("getrawaddrman", "")
1186 + HelpExampleRpc("getrawaddrman", "")
1187 },
1188 [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
1189 AddrMan& addrman = EnsureAnyAddrman(request.context);
1190 NodeContext& node_context = EnsureAnyNodeContext(request.context);
1191 CConnman& connman = EnsureConnman(node_context);
1192
1194 ret.pushKV("new", AddrmanTableToJSON(addrman.GetEntries(false), connman));
1195 ret.pushKV("tried", AddrmanTableToJSON(addrman.GetEntries(true), connman));
1196 return ret;
1197 },
1198 };
1199}
1200
1202{
1203 static const CRPCCommand commands[]{
1204 {"network", &getconnectioncount},
1205 {"network", &ping},
1206 {"network", &getpeerinfo},
1207 {"network", &addnode},
1208 {"network", &disconnectnode},
1209 {"network", &getaddednodeinfo},
1210 {"network", &getnettotals},
1211 {"network", &getnetworkinfo},
1212 {"network", &setban},
1213 {"network", &listbanned},
1214 {"network", &clearbanned},
1215 {"network", &setnetworkactive},
1216 {"network", &getnodeaddresses},
1217 {"network", &getaddrmaninfo},
1218 {"hidden", &addconnection},
1219 {"hidden", &addpeeraddress},
1220 {"hidden", &sendmsgtopeer},
1221 {"hidden", &getrawaddrman},
1222 };
1223 for (const auto& c : commands) {
1224 t.appendCommand(c.name, &c);
1225 }
1226}
int ret
const auto command
const CChainParams & Params()
Return the currently selected parameters.
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:102
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:103
Definition: net.h:1059
bool ForNode(NodeId id, std::function< bool(CNode *pnode)> func)
Definition: net.cpp:3940
bool RemoveAddedNode(const std::string &node) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
Definition: net.cpp:3592
bool GetNetworkActive() const
Definition: net.h:1148
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:3528
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:3757
uint64_t GetMaxOutboundTarget() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3723
std::chrono::seconds GetMaxOutboundTimeframe() const
Definition: net.cpp:3730
ServiceFlags GetLocalServices() const
Used to convey which local services we are offering peers during node connection.
Definition: net.cpp:3800
bool AddNode(const AddedNodeParams &add) EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
Definition: net.cpp:3578
bool DisconnectNode(const std::string &node)
Definition: net.cpp:3655
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:1869
std::vector< AddedNodeInfo > GetAddedNodeInfo(bool include_connected) const EXCLUSIVE_LOCKS_REQUIRED(!m_added_nodes_mutex)
Definition: net.cpp:2904
size_t GetNodeCount(ConnectionDirection) const
Definition: net.cpp:3615
uint32_t GetMappedAS(const CNetAddr &addr) const
Definition: net.cpp:3638
void GetNodeStats(std::vector< CNodeStats > &vstats) const
Definition: net.cpp:3643
uint64_t GetTotalBytesRecv() const
Definition: net.cpp:3788
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:2995
void SetNetworkActive(bool active)
Definition: net.cpp:3213
std::chrono::seconds GetMaxOutboundTimeLeftInCycle() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3735
uint64_t GetTotalBytesSent() const EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3793
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:3778
void PushMessage(CNode *pnode, CSerializedNetMsg &&msg) EXCLUSIVE_LOCKS_REQUIRED(!m_total_bytes_sent_mutex)
Definition: net.cpp:3893
static constexpr size_t MESSAGE_TYPE_SIZE
Definition: protocol.h:31
Network address.
Definition: netaddress.h:112
Network GetNetClass() const
Definition: netaddress.cpp:678
std::string ToStringAddr() const
Definition: netaddress.cpp:584
bool IsValid() const
Definition: netaddress.cpp:428
Information about a peer.
Definition: net.h:675
RPC command dispatcher.
Definition: server.h:87
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:531
uint16_t GetPort() const
Definition: netaddress.cpp:839
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:774
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
const std::string & get_str() const
@ VNULL
Definition: univalue.h:24
@ VOBJ
Definition: univalue.h:24
@ VARR
Definition: univalue.h:24
bool isNull() const
Definition: univalue.h:81
void pushKVEnd(std::string key, UniValue val)
Definition: univalue.cpp:118
bool isStr() const
Definition: univalue.h:85
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:20
UniValue GetWarningsForRpc(const Warnings &warnings, bool use_deprecated)
RPC helper function that wraps warnings.GetMessages().
Definition: warnings.cpp:54
std::string TrimString(std::string_view str, std::string_view pattern=" \f\n\r\t\v")
Definition: string.h:168
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:119
const std::string NET_MESSAGE_TYPE_OTHER
Definition: net.cpp:107
GlobalMutex g_maplocalhost_mutex
Definition: net.cpp:117
static const int MAX_ADDNODE_CONNECTIONS
Maximum number of addnode outgoing nodes.
Definition: net.h:70
int64_t NodeId
Definition: net.h:98
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:32
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:56
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:34
@ NET_INTERNAL
A set of addresses that represent the hash of a string or FQDN.
Definition: netaddress.h:53
CSubNet LookupSubNet(const std::string &subnet_str)
Parse and resolve a specified subnet string into the appropriate internal representation.
Definition: netbase.cpp:816
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:177
std::string GetNetworkName(enum Network net)
Definition: netbase.cpp:118
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:946
ReachableNets g_reachable_nets
Definition: netbase.cpp:43
bool GetProxy(enum Network net, Proxy &proxyInfoOut)
Definition: netbase.cpp:713
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:134
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:1201
static RPCHelpMan getnetworkinfo()
Definition: net.cpp:631
static RPCHelpMan addconnection()
Definition: net.cpp:378
static RPCHelpMan getaddednodeinfo()
Definition: net.cpp:488
static RPCHelpMan clearbanned()
Definition: net.cpp:872
static RPCHelpMan getnettotals()
Definition: net.cpp:562
static RPCHelpMan getaddrmaninfo()
Definition: net.cpp:1085
static RPCHelpMan addnode()
Definition: net.cpp:314
static RPCHelpMan getnodeaddresses()
Definition: net.cpp:916
static RPCHelpMan setban()
Definition: net.cpp:738
static RPCHelpMan getrawaddrman()
Definition: net.cpp:1161
static UniValue GetNetworksInfo()
Definition: net.cpp:612
static RPCHelpMan ping()
Definition: net.cpp:83
UniValue AddrmanTableToJSON(const std::vector< std::pair< AddrInfo, AddressPosition > > &tableInfos, const CConnman &connman)
Definition: net.cpp:1145
static RPCHelpMan getconnectioncount()
Definition: net.cpp:60
static RPCHelpMan disconnectnode()
Definition: net.cpp:441
static RPCHelpMan listbanned()
Definition: net.cpp:824
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:894
static RPCHelpMan addpeeraddress()
Definition: net.cpp:977
static RPCHelpMan getpeerinfo()
Definition: net.cpp:120
UniValue AddrmanEntryToJSON(const AddrInfo &info, const CConnman &connman)
Definition: net.cpp:1124
static RPCHelpMan sendmsgtopeer()
Definition: net.cpp:1037
@ 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:186
std::string HelpExampleRpc(const std::string &methodname, const std::string &args)
Definition: util.cpp:204
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:46
bool IsDeprecatedRPCEnabled(const std::string &method)
Definition: server.cpp:341
static RPCHelpMan help()
Definition: server.cpp:118
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:132
std::vector< unsigned char > data
Definition: net.h:131
@ 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