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