Branch data Line data Source code
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>
22 : : #include <node/connection_types.h>
23 : : #include <node/context.h>
24 : : #include <node/protocol_version.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 : :
67 : : using node::NodeContext;
68 : : using util::Join;
69 : : using util::TrimStringView;
70 : :
71 : : const 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 : :
81 : : const 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 : :
87 : 2657 : static RPCMethod getconnectioncount()
88 : : {
89 : 2657 : return RPCMethod{
90 : 2657 : "getconnectioncount",
91 [ + - ]: 5314 : "Returns the number of connections to other nodes.\n",
92 : : {},
93 [ + - ]: 5314 : RPCResult{
94 [ + - ]: 5314 : RPCResult::Type::NUM, "", "The connection count"
95 [ + - ]: 5314 : },
96 : 2657 : RPCExamples{
97 [ + - + - : 5314 : HelpExampleCli("getconnectioncount", "")
+ - ]
98 [ + - + - : 10628 : + HelpExampleRpc("getconnectioncount", "")
+ - + - ]
99 [ + - ]: 2657 : },
100 : 2657 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
101 : : {
102 : 7 : NodeContext& node = EnsureAnyNodeContext(request.context);
103 : 7 : const CConnman& connman = EnsureConnman(node);
104 : :
105 : 7 : return connman.GetNodeCount(ConnectionDirection::Both);
106 : : },
107 [ + - + - ]: 10628 : };
108 : : }
109 : :
110 : 2657 : static RPCMethod ping()
111 : : {
112 : 2657 : return RPCMethod{
113 : 2657 : "ping",
114 [ + - ]: 5314 : "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 : : {},
118 [ + - + - : 5314 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - ]
119 : 2657 : RPCExamples{
120 [ + - + - : 5314 : HelpExampleCli("ping", "")
+ - ]
121 [ + - + - : 10628 : + HelpExampleRpc("ping", "")
+ - + - ]
122 [ + - ]: 2657 : },
123 : 2657 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
124 : : {
125 : 7 : NodeContext& node = EnsureAnyNodeContext(request.context);
126 : 7 : PeerManager& peerman = EnsurePeerman(node);
127 : :
128 : : // Request that each node send a ping during next message processing pass
129 : 7 : peerman.SendPings();
130 : 7 : return UniValue::VNULL;
131 : : },
132 [ + - + - ]: 10628 : };
133 : : }
134 : :
135 : : /** Returns, given services flags, a list of humanly readable (known) network services */
136 : 19614 : static UniValue GetServicesNames(ServiceFlags services)
137 : : {
138 : 19614 : UniValue servicesNames(UniValue::VARR);
139 : :
140 [ + - + + ]: 71156 : for (const auto& flag : serviceFlagsToStr(services)) {
141 [ + - + - ]: 51542 : servicesNames.push_back(flag);
142 : 19614 : }
143 : :
144 : 19614 : return servicesNames;
145 : 0 : }
146 : :
147 : 12585 : static RPCMethod getpeerinfo()
148 : : {
149 : 12585 : return RPCMethod{
150 : 12585 : "getpeerinfo",
151 [ + - ]: 25170 : "Returns data about each connected network peer as a json array of objects.",
152 : : {},
153 [ + - ]: 25170 : RPCResult{
154 [ + - ]: 25170 : RPCResult::Type::ARR, "", "",
155 : : {
156 [ + - + - ]: 25170 : {RPCResult::Type::OBJ, "", "",
157 : : {
158 : : {
159 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "id", "Peer index"},
160 [ + - + - ]: 25170 : {RPCResult::Type::STR, "addr", "(host:port) The IP address/hostname optionally followed by :port of the peer"},
161 [ + - + - ]: 25170 : {RPCResult::Type::STR, "addrbind", /*optional=*/true, "(ip:port) Bind address of the connection to the peer"},
162 [ + - + - ]: 25170 : {RPCResult::Type::STR, "addrlocal", /*optional=*/true, "(ip:port) Local address as reported by the peer"},
163 [ + - + - : 25170 : {RPCResult::Type::STR, "network", "Network (" + Join(GetNetworkNames(/*append_unroutable=*/true), ", ") + ")"},
+ - + - ]
164 [ + - + - ]: 25170 : {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 [ + - + - ]: 25170 : {RPCResult::Type::STR_HEX, "services", "The services offered"},
167 [ + - + - ]: 25170 : {RPCResult::Type::ARR, "servicesnames", "the services offered, in human-readable form",
168 : : {
169 [ + - + - ]: 25170 : {RPCResult::Type::STR, "SERVICE_NAME", "the service name if it is recognised"}
170 : : }},
171 [ + - + - ]: 25170 : {RPCResult::Type::BOOL, "relaytxes", "Whether we relay transactions to this peer"},
172 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "last_inv_sequence", "Mempool sequence number of this peer's last INV"},
173 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "inv_to_send", "How many txs we have queued to announce to this peer"},
174 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "lastsend", "The " + UNIX_EPOCH_TIME + " of the last send"},
175 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "lastrecv", "The " + UNIX_EPOCH_TIME + " of the last receive"},
176 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "last_transaction", "The " + UNIX_EPOCH_TIME + " of the last valid transaction received from this peer"},
177 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "last_block", "The " + UNIX_EPOCH_TIME + " of the last block received from this peer"},
178 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "last_block_announcement", "The " + UNIX_EPOCH_TIME + " this peer was first to announce a block"},
179 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "bytessent", "The total bytes sent"},
180 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "bytesrecv", "The total bytes received"},
181 [ + - + - ]: 25170 : {RPCResult::Type::NUM_TIME, "conntime", "The " + UNIX_EPOCH_TIME + " of the connection"},
182 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "timeoffset", "The time offset in seconds"},
183 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "pingtime", /*optional=*/true, "The last ping time in seconds, if any"},
184 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "minping", /*optional=*/true, "The minimum observed ping time in seconds, if any"},
185 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "pingwait", /*optional=*/true, "The duration in seconds of an outstanding ping (if non-zero)"},
186 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "version", "The peer version, such as 70001"},
187 [ + - + - ]: 25170 : {RPCResult::Type::STR, "subver", "The string version"},
188 [ + - + - ]: 25170 : {RPCResult::Type::BOOL, "inbound", "Inbound (true) or Outbound (false)"},
189 [ + - + - ]: 12585 : {RPCResult::Type::BOOL, "bip152_hb_to", "Whether we selected peer as (compact blocks) high-bandwidth peer"},
190 [ + - + - ]: 25170 : {RPCResult::Type::BOOL, "bip152_hb_from", "Whether peer selected us as (compact blocks) high-bandwidth peer"},
191 [ + - + - ]: 25170 : {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 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "synced_headers", "The last header we have in common with this peer"},
193 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "synced_blocks", "The last block we have in common with this peer"},
194 [ + - + - ]: 25170 : {RPCResult::Type::ARR, "inflight", "",
195 : : {
196 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "n", "The heights of blocks we're currently asking from this peer"},
197 : : }},
198 [ + - + - ]: 25170 : {RPCResult::Type::BOOL, "addr_relay_enabled", "Whether we participate in address relay with this peer"},
199 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "addr_processed", "The total number of addresses processed, excluding those dropped due to rate limiting"},
200 [ + - + - ]: 25170 : {RPCResult::Type::NUM, "addr_rate_limited", "The total number of addresses dropped due to rate limiting"},
201 [ + - + - ]: 25170 : {RPCResult::Type::ARR, "permissions", "Any special permissions that have been granted to this peer",
202 : : {
203 [ + - + - ]: 25170 : {RPCResult::Type::STR, "permission_type", Join(NET_PERMISSIONS_DOC, ",\n") + ".\n"},
204 : : }},
205 [ + - + - ]: 25170 : {RPCResult::Type::STR_AMOUNT, "minfeefilter", "The minimum fee rate for transactions this peer accepts"},
206 [ + - + - ]: 25170 : {RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "",
207 : : {
208 [ + - + - ]: 25170 : {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 [ + - + - ]: 25170 : {RPCResult::Type::OBJ_DYN, "bytesrecv_per_msg", "",
213 : : {
214 [ + - ]: 25170 : {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 [ + - ]: 25170 : "of unknown message types are listed under '"+NET_MESSAGE_TYPE_OTHER+"'."}
218 : : }},
219 [ + - + - : 25170 : {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 : 12585 : "best capture connection behaviors."},
222 [ + - + - : 25170 : {RPCResult::Type::STR, "transport_protocol_type", "Type of transport protocol: \n" + Join(TRANSPORT_TYPE_DOC, ",\n") + ".\n"},
+ - ]
223 [ + - + - ]: 25170 : {RPCResult::Type::STR, "session_id", "The session ID for this connection, or \"\" if there is none (\"v2\" transport protocol only).\n"},
224 : : }},
225 : : }},
226 [ + - + - : 1308840 : },
+ - + - +
- + - + -
+ - + + +
+ + + + +
+ + + + +
+ - - - -
- - - - -
- - - -
- ]
227 : 12585 : RPCExamples{
228 [ + - + - : 25170 : HelpExampleCli("getpeerinfo", "")
+ - ]
229 [ + - + - : 50340 : + HelpExampleRpc("getpeerinfo", "")
+ - + - ]
230 [ + - ]: 12585 : },
231 : 12585 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
232 : : {
233 : 9933 : NodeContext& node = EnsureAnyNodeContext(request.context);
234 : 9933 : const CConnman& connman = EnsureConnman(node);
235 : 9933 : const PeerManager& peerman = EnsurePeerman(node);
236 : :
237 : 9933 : std::vector<CNodeStats> vstats;
238 [ + - ]: 9933 : connman.GetNodeStats(vstats);
239 : :
240 : 9933 : UniValue ret(UniValue::VARR);
241 : :
242 [ + + ]: 28528 : for (const CNodeStats& stats : vstats) {
243 : 18595 : UniValue obj(UniValue::VOBJ);
244 [ + - ]: 18595 : CNodeStateStats statestats;
245 [ + - ]: 18595 : 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 [ + + ]: 18595 : if (!fStateStats) {
252 : 4 : continue;
253 : : }
254 [ + - + - : 37182 : obj.pushKV("id", stats.nodeid);
+ - ]
255 [ + - + - : 37182 : obj.pushKV("addr", stats.m_addr_name);
+ - ]
256 [ + - + + ]: 18591 : if (stats.addrBind.IsValid()) {
257 [ + - + - : 37162 : obj.pushKV("addrbind", stats.addrBind.ToStringAddrPort());
+ - + - ]
258 : : }
259 [ + + ]: 18591 : if (!(stats.addrLocal.empty())) {
260 [ + - + - : 11178 : obj.pushKV("addrlocal", stats.addrLocal);
+ - ]
261 : : }
262 [ + - + - : 37182 : obj.pushKV("network", GetNetworkName(stats.m_network));
+ - + - ]
263 [ - + ]: 18591 : if (stats.m_mapped_as != 0) {
264 [ # # # # : 0 : obj.pushKV("mapped_as", stats.m_mapped_as);
# # ]
265 : : }
266 : 18591 : ServiceFlags services{statestats.their_services};
267 [ + - + - : 37182 : obj.pushKV("services", strprintf("%016x", services));
+ - + - ]
268 [ + - + - : 37182 : obj.pushKV("servicesnames", GetServicesNames(services));
+ - ]
269 [ + - + - : 37182 : obj.pushKV("relaytxes", statestats.m_relay_txs);
+ - ]
270 [ + - + - : 37182 : obj.pushKV("last_inv_sequence", statestats.m_last_inv_seq);
+ - ]
271 [ + - + - : 37182 : obj.pushKV("inv_to_send", statestats.m_inv_to_send);
+ - ]
272 [ + - + - : 37182 : obj.pushKV("lastsend", TicksSinceEpoch<std::chrono::seconds>(stats.m_last_send));
+ - ]
273 [ + - + - : 37182 : obj.pushKV("lastrecv", TicksSinceEpoch<std::chrono::seconds>(stats.m_last_recv));
+ - ]
274 [ + - + - : 37182 : obj.pushKV("last_transaction", count_seconds(stats.m_last_tx_time));
+ - ]
275 [ + - + - : 37182 : obj.pushKV("last_block", count_seconds(stats.m_last_block_time));
+ - ]
276 [ + - + - : 37182 : obj.pushKV("last_block_announcement", TicksSinceEpoch<std::chrono::seconds>(statestats.m_last_block_announcement));
+ - ]
277 [ + - + - : 37182 : obj.pushKV("bytessent", stats.nSendBytes);
+ - ]
278 [ + - + - : 37182 : obj.pushKV("bytesrecv", stats.nRecvBytes);
+ - ]
279 [ + - + - : 37182 : obj.pushKV("conntime", TicksSinceEpoch<std::chrono::seconds>(stats.m_connected));
+ - ]
280 [ + - + - : 37182 : obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(statestats.time_offset));
+ - ]
281 [ + + ]: 18591 : if (stats.m_last_ping_time > 0us) {
282 [ + - + - : 28486 : obj.pushKV("pingtime", Ticks<SecondsDouble>(stats.m_last_ping_time));
+ - ]
283 : : }
284 [ + + ]: 18591 : if (stats.m_min_ping_time < decltype(CNode::m_min_ping_time.load())::max()) {
285 [ + - + - : 35172 : obj.pushKV("minping", Ticks<SecondsDouble>(stats.m_min_ping_time));
+ - ]
286 : : }
287 [ + + ]: 18591 : if (statestats.m_ping_wait > 0s) {
288 [ + - + - : 264 : obj.pushKV("pingwait", Ticks<SecondsDouble>(statestats.m_ping_wait));
+ - ]
289 : : }
290 [ + - + - : 37182 : 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 [ + - + - : 37182 : obj.pushKV("subver", stats.cleanSubVer);
+ - ]
295 [ + - + - : 37182 : obj.pushKV("inbound", stats.fInbound);
+ - ]
296 [ + - + - : 37182 : obj.pushKV("bip152_hb_to", stats.m_bip152_highbandwidth_to);
+ - ]
297 [ + - + - : 37182 : obj.pushKV("bip152_hb_from", stats.m_bip152_highbandwidth_from);
+ - ]
298 [ + - + - : 37182 : obj.pushKV("presynced_headers", statestats.presync_height);
+ - ]
299 [ + - + - : 37182 : obj.pushKV("synced_headers", statestats.nSyncHeight);
+ - ]
300 [ + - + - : 37182 : obj.pushKV("synced_blocks", statestats.nCommonHeight);
+ - ]
301 : 18591 : UniValue heights(UniValue::VARR);
302 [ + + ]: 36326 : for (const int height : statestats.vHeightInFlight) {
303 [ + - + - ]: 17735 : heights.push_back(height);
304 : : }
305 [ + - + - ]: 37182 : obj.pushKV("inflight", std::move(heights));
306 [ + - + - : 37182 : obj.pushKV("addr_relay_enabled", statestats.m_addr_relay_enabled);
+ - ]
307 [ + - + - : 37182 : obj.pushKV("addr_processed", statestats.m_addr_processed);
+ - ]
308 [ + - + - : 37182 : obj.pushKV("addr_rate_limited", statestats.m_addr_rate_limited);
+ - ]
309 : 18591 : UniValue permissions(UniValue::VARR);
310 [ + - + + ]: 27857 : for (const auto& permission : NetPermissions::ToStrings(stats.m_permission_flags)) {
311 [ + - + - ]: 9266 : permissions.push_back(permission);
312 : 18591 : }
313 [ + - + - ]: 37182 : obj.pushKV("permissions", std::move(permissions));
314 [ + - + - : 37182 : obj.pushKV("minfeefilter", ValueFromAmount(statestats.m_fee_filter_received));
+ - ]
315 : :
316 : 18591 : UniValue sendPerMsgType(UniValue::VOBJ);
317 [ + - + + ]: 227997 : for (const auto& [message_type, total_bytes] : stats.mapSendBytesPerMsgType) {
318 [ + - ]: 209406 : if (total_bytes > 0) {
319 [ + - + - ]: 628218 : sendPerMsgType.pushKVEnd(message_type, total_bytes);
320 : : }
321 : : }
322 [ + - + - ]: 37182 : obj.pushKV("bytessent_per_msg", std::move(sendPerMsgType));
323 : :
324 : 18591 : UniValue recvPerMsgType(UniValue::VOBJ);
325 [ + + + + ]: 706458 : for (const auto& [message_type, total_bytes] : stats.mapRecvBytesPerMsgType) {
326 [ + + ]: 687867 : if (total_bytes > 0) {
327 [ + - + - ]: 562281 : recvPerMsgType.pushKVEnd(message_type, total_bytes);
328 : : }
329 : : }
330 [ + - + - ]: 37182 : obj.pushKV("bytesrecv_per_msg", std::move(recvPerMsgType));
331 [ + - + - : 37182 : obj.pushKV("connection_type", ConnectionTypeAsString(stats.m_conn_type));
+ - + - ]
332 [ + - + - : 37182 : obj.pushKV("transport_protocol_type", TransportTypeAsString(stats.m_transport_type));
+ - + - ]
333 [ + - + - : 37182 : obj.pushKV("session_id", stats.m_session_id);
+ - ]
334 : :
335 [ + - ]: 18591 : ret.push_back(std::move(obj));
336 : 18595 : }
337 : :
338 : 9933 : return ret;
339 : 9933 : },
340 [ + - + - ]: 50340 : };
341 [ + - + - : 1208160 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - ]
342 : :
343 : 3173 : static RPCMethod addnode()
344 : : {
345 : 3173 : return RPCMethod{
346 : 3173 : "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 : 3173 : "such peers will not be synced from).\n" +
352 [ + - + - ]: 9519 : strprintf("Addnode connections are limited to %u at a time", MAX_ADDNODE_CONNECTIONS) +
353 : 3173 : " and are counted separately from the -maxconnections limit.\n",
354 : : {
355 [ + - + - ]: 6346 : {"node", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address/hostname optionally followed by :port of the peer to connect to"},
356 [ + - + - ]: 6346 : {"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 [ + - + - : 9519 : {"v2transport", RPCArg::Type::BOOL, RPCArg::DefaultHint{"set by -v2transport"}, "Attempt to connect using BIP324 v2 transport protocol (ignored for 'remove' command)"},
+ - ]
358 : : },
359 [ + - + - : 6346 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
360 : 3173 : RPCExamples{
361 [ + - + - : 6346 : HelpExampleCli("addnode", "\"192.168.0.6:8333\" \"onetry\" true")
+ - ]
362 [ + - + - : 12692 : + HelpExampleRpc("addnode", R"("192.168.0.6:8333", "onetry", true)")
+ - + - ]
363 [ + - ]: 3173 : },
364 : 3173 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
365 : : {
366 : 523 : const auto command{self.Arg<std::string_view>("command")};
367 [ + + + + : 523 : if (command != "onetry" && command != "add" && command != "remove") {
+ + ]
368 : 2 : throw std::runtime_error(
369 [ + - + - ]: 4 : self.ToString());
370 : : }
371 : :
372 : 521 : NodeContext& node = EnsureAnyNodeContext(request.context);
373 : 521 : CConnman& connman = EnsureConnman(node);
374 : :
375 : 521 : const auto node_arg{self.Arg<std::string_view>("node")};
376 [ + + ]: 521 : if (TrimStringView(node_arg).empty()) {
377 : : // Such a node would never resolve, but would be retried indefinitely.
378 [ + - + - ]: 24 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Node address cannot be empty");
379 : : }
380 : :
381 : 509 : bool node_v2transport = connman.GetLocalServices() & NODE_P2P_V2;
382 [ + + ]: 509 : bool use_v2transport = self.MaybeArg<bool>("v2transport").value_or(node_v2transport);
383 : :
384 [ + + + + ]: 509 : if (use_v2transport && !node_v2transport) {
385 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: v2transport requested but not enabled (see -v2transport)");
386 : : }
387 : :
388 [ + + ]: 508 : if (command == "onetry")
389 : : {
390 : 496 : CAddress addr;
391 [ + - ]: 992 : connman.OpenNetworkConnection(/*addrConnect=*/addr,
392 : : /*fCountFailure=*/false,
393 : : /*grant_outbound=*/{},
394 [ - + ]: 496 : /*pszDest=*/std::string{node_arg}.c_str(),
395 : : /*conn_type=*/ConnectionType::MANUAL,
396 : : /*use_v2transport=*/use_v2transport,
397 [ + - ]: 496 : /*proxy_override=*/std::nullopt);
398 : 496 : return UniValue::VNULL;
399 : 496 : }
400 : :
401 [ + + ]: 12 : if (command == "add")
402 : : {
403 [ + + ]: 8 : if (!connman.AddNode({std::string{node_arg}, use_v2transport})) {
404 [ + - + - ]: 8 : throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: Node already added");
405 : : }
406 : : }
407 [ + - ]: 4 : else if (command == "remove")
408 : : {
409 [ + + ]: 4 : if (!connman.RemoveAddedNode(node_arg)) {
410 [ + - + - ]: 4 : throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node could not be removed. It has not been added previously.");
411 : : }
412 : : }
413 : :
414 : 6 : return UniValue::VNULL;
415 [ + - ]: 8 : },
416 [ + - + - : 22211 : };
+ + - - ]
417 [ + - + - : 19038 : }
+ - - - ]
418 : :
419 : 2809 : static RPCMethod addconnection()
420 : : {
421 : 2809 : return RPCMethod{
422 : 2809 : "addconnection",
423 [ + - ]: 5618 : "Open an outbound connection to a specified node. This RPC is for testing only.\n",
424 : : {
425 [ + - + - ]: 5618 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address and port to attempt connecting to."},
426 [ + - + - ]: 5618 : {"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 [ + - + - ]: 5618 : {"v2transport", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Attempt to connect using BIP324 v2 transport protocol"},
428 : : },
429 [ + - ]: 5618 : RPCResult{
430 [ + - + - ]: 5618 : RPCResult::Type::OBJ, "", "",
431 : : {
432 [ + - + - ]: 5618 : { RPCResult::Type::STR, "address", "Address of newly added connection." },
433 [ + - + - ]: 5618 : { RPCResult::Type::STR, "connection_type", "Type of connection opened." },
434 [ + - + - : 16854 : }},
+ + - - ]
435 : 2809 : RPCExamples{
436 [ + - + - : 5618 : HelpExampleCli("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")
+ - ]
437 [ + - + - : 11236 : + HelpExampleRpc("addconnection", R"("192.168.0.6:8333", "outbound-full-relay", true)")
+ - + - ]
438 [ + - ]: 2809 : },
439 : 2809 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
440 : : {
441 [ - + ]: 170 : if (Params().GetChainType() != ChainType::REGTEST) {
442 [ # # ]: 0 : throw std::runtime_error("addconnection is for regression testing (-regtest mode) only.");
443 : : }
444 : :
445 [ - + ]: 170 : const std::string address = request.params[0].get_str();
446 [ + - + - ]: 170 : auto conn_type_in{util::TrimStringView(self.Arg<std::string_view>("connection_type"))};
447 : 170 : ConnectionType conn_type{};
448 [ + + ]: 170 : if (conn_type_in == "outbound-full-relay") {
449 : : conn_type = ConnectionType::OUTBOUND_FULL_RELAY;
450 [ + + ]: 61 : } else if (conn_type_in == "block-relay-only") {
451 : : conn_type = ConnectionType::BLOCK_RELAY;
452 [ + + ]: 24 : } else if (conn_type_in == "addr-fetch") {
453 : : conn_type = ConnectionType::ADDR_FETCH;
454 [ + + ]: 9 : } else if (conn_type_in == "feeler") {
455 : : conn_type = ConnectionType::FEELER;
456 [ - + ]: 4 : } else if (conn_type_in == "manual") {
457 : : conn_type = ConnectionType::MANUAL;
458 : : } else {
459 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, self.ToString());
460 : : }
461 [ + - ]: 170 : bool use_v2transport{self.Arg<bool>("v2transport")};
462 : :
463 [ + - ]: 170 : NodeContext& node = EnsureAnyNodeContext(request.context);
464 [ + - ]: 170 : CConnman& connman = EnsureConnman(node);
465 : :
466 [ + + + - : 170 : if (use_v2transport && !(connman.GetLocalServices() & NODE_P2P_V2)) {
- + ]
467 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Adding v2transport connections requires -v2transport init flag to be set.");
468 : : }
469 : :
470 [ + - ]: 170 : const bool success = connman.AddConnection(address, conn_type, use_v2transport);
471 [ - + ]: 170 : if (!success) {
472 [ # # # # ]: 0 : throw JSONRPCError(RPC_CLIENT_NODE_CAPACITY_REACHED, "Error: Already at capacity for specified connection type.");
473 : : }
474 : :
475 : 170 : UniValue info(UniValue::VOBJ);
476 [ + - + - : 340 : info.pushKV("address", address);
+ - ]
477 [ + - + - : 340 : info.pushKV("connection_type", conn_type_in);
+ - ]
478 : :
479 : 170 : return info;
480 : 170 : },
481 [ + - + - : 19663 : };
+ + - - ]
482 [ + - + - : 28090 : }
+ - + - +
- - - -
- ]
483 : :
484 : 2782 : static RPCMethod disconnectnode()
485 : : {
486 : 2782 : return RPCMethod{
487 : 2782 : "disconnectnode",
488 [ + - ]: 5564 : "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 [ + - + - : 8346 : {"address", RPCArg::Type::STR, RPCArg::DefaultHint{"fallback to nodeid"}, "The IP address/port of the node"},
+ - ]
493 [ + - + - : 8346 : {"nodeid", RPCArg::Type::NUM, RPCArg::DefaultHint{"fallback to address"}, "The node ID (see getpeerinfo for node IDs)"},
+ - ]
494 : : },
495 [ + - + - : 5564 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
496 : 2782 : RPCExamples{
497 [ + - + - : 5564 : HelpExampleCli("disconnectnode", "\"192.168.0.6:8333\"")
+ - ]
498 [ + - + - : 11128 : + HelpExampleCli("disconnectnode", "\"\" 1")
+ - + - ]
499 [ + - + - : 11128 : + HelpExampleRpc("disconnectnode", "\"192.168.0.6:8333\"")
+ - + - ]
500 [ + - + - : 11128 : + HelpExampleRpc("disconnectnode", "\"\", 1")
+ - + - ]
501 [ + - ]: 2782 : },
502 : 2782 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
503 : : {
504 : 132 : NodeContext& node = EnsureAnyNodeContext(request.context);
505 : 132 : CConnman& connman = EnsureConnman(node);
506 : :
507 : 132 : bool success;
508 : 132 : auto address{self.MaybeArg<std::string_view>("address")};
509 : 132 : auto node_id{self.MaybeArg<int64_t>("nodeid")};
510 : :
511 [ + + + + ]: 132 : if (address && !node_id) {
512 : : /* handle disconnect-by-address */
513 : 4 : success = connman.DisconnectNode(*address);
514 [ + - + + : 128 : } else if (node_id && (!address || address->empty())) {
- + ]
515 : : /* handle disconnect-by-id */
516 : 126 : success = connman.DisconnectNode(*node_id);
517 : : } else {
518 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMS, "Only one of address and nodeid should be provided.");
519 : : }
520 : :
521 [ + + ]: 130 : if (!success) {
522 [ + - + - ]: 4 : throw JSONRPCError(RPC_CLIENT_NODE_NOT_CONNECTED, "Node not found in connected nodes");
523 : : }
524 : :
525 : 128 : return UniValue::VNULL;
526 : : },
527 [ + - + - : 16692 : };
+ + - - ]
528 [ + - + - : 11128 : }
- - ]
529 : :
530 : 2665 : static RPCMethod getaddednodeinfo()
531 : : {
532 : 2665 : return RPCMethod{
533 : 2665 : "getaddednodeinfo",
534 [ + - ]: 5330 : "Returns information about the given added node, or all added nodes\n"
535 : : "(note that onetry addnodes are not listed here)\n",
536 : : {
537 [ + - + - : 7995 : {"node", RPCArg::Type::STR, RPCArg::DefaultHint{"all nodes"}, "If provided, return information about this specific node, otherwise all nodes are returned."},
+ - ]
538 : : },
539 [ + - ]: 5330 : RPCResult{
540 [ + - + - ]: 5330 : RPCResult::Type::ARR, "", "",
541 : : {
542 [ + - + - ]: 5330 : {RPCResult::Type::OBJ, "", "",
543 : : {
544 [ + - + - ]: 5330 : {RPCResult::Type::STR, "addednode", "The node IP address or name (as provided to addnode)"},
545 [ + - + - ]: 5330 : {RPCResult::Type::BOOL, "connected", "If connected"},
546 [ + - + - ]: 5330 : {RPCResult::Type::ARR, "addresses", "Only when connected = true",
547 : : {
548 [ + - + - ]: 5330 : {RPCResult::Type::OBJ, "", "",
549 : : {
550 [ + - + - ]: 5330 : {RPCResult::Type::STR, "address", "The bitcoin server IP and port we're connected to"},
551 [ + - + - ]: 5330 : {RPCResult::Type::STR, "connected", "connection, inbound or outbound"},
552 : : }},
553 : : }},
554 : : }},
555 : : }
556 [ + - + - : 50635 : },
+ - + - +
- + + + +
+ + + + -
- - - - -
- - ]
557 : 2665 : RPCExamples{
558 [ + - + - : 5330 : HelpExampleCli("getaddednodeinfo", "\"192.168.0.201\"")
+ - ]
559 [ + - + - : 10660 : + HelpExampleRpc("getaddednodeinfo", "\"192.168.0.201\"")
+ - + - ]
560 [ + - ]: 2665 : },
561 : 2665 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
562 : : {
563 : 15 : NodeContext& node = EnsureAnyNodeContext(request.context);
564 : 15 : const CConnman& connman = EnsureConnman(node);
565 : :
566 : 15 : std::vector<AddedNodeInfo> vInfo = connman.GetAddedNodeInfo(/*include_connected=*/true);
567 : :
568 [ + - + + ]: 15 : if (auto node{self.MaybeArg<std::string_view>("node")}) {
569 : 4 : bool found = false;
570 [ + + ]: 6 : for (const AddedNodeInfo& info : vInfo) {
571 [ - + + + ]: 4 : if (info.m_params.m_added_node == *node) {
572 [ + - ]: 2 : vInfo.assign(1, info);
573 : : found = true;
574 : : break;
575 : : }
576 : : }
577 : 2 : if (!found) {
578 [ + - + - ]: 4 : throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node has not been added.");
579 : : }
580 : : }
581 : :
582 : 13 : UniValue ret(UniValue::VARR);
583 : :
584 [ + + ]: 26 : for (const AddedNodeInfo& info : vInfo) {
585 : 13 : UniValue obj(UniValue::VOBJ);
586 [ + - + - : 26 : obj.pushKV("addednode", info.m_params.m_added_node);
+ - ]
587 [ + - + - : 26 : obj.pushKV("connected", info.fConnected);
+ - ]
588 : 13 : UniValue addresses(UniValue::VARR);
589 [ - + ]: 13 : if (info.fConnected) {
590 : 0 : UniValue address(UniValue::VOBJ);
591 [ # # # # : 0 : address.pushKV("address", info.resolvedAddress.ToStringAddrPort());
# # # # ]
592 [ # # # # : 0 : address.pushKV("connected", info.fInbound ? "inbound" : "outbound");
# # # # ]
593 [ # # ]: 0 : addresses.push_back(std::move(address));
594 : 0 : }
595 [ + - + - ]: 26 : obj.pushKV("addresses", std::move(addresses));
596 [ + - ]: 13 : ret.push_back(std::move(obj));
597 : 13 : }
598 : :
599 : 13 : return ret;
600 : 15 : },
601 [ + - + - : 13325 : };
+ + - - ]
602 [ + - + - : 42640 : }
+ - + - +
- + - + -
+ - - - -
- ]
603 : :
604 : 2669 : static RPCMethod getnettotals()
605 : : {
606 : 2669 : return RPCMethod{"getnettotals",
607 [ + - ]: 5338 : "Returns information about network traffic, including bytes in, bytes out,\n"
608 : : "and current system time.",
609 : : {},
610 [ + - ]: 5338 : RPCResult{
611 [ + - ]: 5338 : RPCResult::Type::OBJ, "", "",
612 : : {
613 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "totalbytesrecv", "Total bytes received"},
614 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "totalbytessent", "Total bytes sent"},
615 [ + - + - ]: 5338 : {RPCResult::Type::NUM_TIME, "timemillis", "Current system " + UNIX_EPOCH_TIME + " in milliseconds"},
616 [ + - + - ]: 5338 : {RPCResult::Type::OBJ, "uploadtarget", "",
617 : : {
618 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "timeframe", "Length of the measuring timeframe in seconds"},
619 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "target", "Target in bytes"},
620 [ + - + - ]: 5338 : {RPCResult::Type::BOOL, "target_reached", "True if target is reached"},
621 [ + - + - ]: 5338 : {RPCResult::Type::BOOL, "serve_historical_blocks", "True if serving historical blocks"},
622 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "bytes_left_in_cycle", "Bytes left in current time cycle"},
623 [ + - + - ]: 5338 : {RPCResult::Type::NUM, "time_left_in_cycle", "Seconds left in current time cycle"},
624 : : }},
625 : : }
626 [ + - + - : 61387 : },
+ - + + +
+ - - -
- ]
627 : 2669 : RPCExamples{
628 [ + - + - : 5338 : HelpExampleCli("getnettotals", "")
+ - ]
629 [ + - + - : 10676 : + HelpExampleRpc("getnettotals", "")
+ - + - ]
630 [ + - ]: 2669 : },
631 : 2669 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
632 : : {
633 : 19 : NodeContext& node = EnsureAnyNodeContext(request.context);
634 : 19 : const CConnman& connman = EnsureConnman(node);
635 : :
636 : 19 : UniValue obj(UniValue::VOBJ);
637 [ + - + - : 38 : obj.pushKV("totalbytesrecv", connman.GetTotalBytesRecv());
+ - + - ]
638 [ + - + - : 38 : obj.pushKV("totalbytessent", connman.GetTotalBytesSent());
+ - + - ]
639 [ + - + - : 38 : obj.pushKV("timemillis", TicksSinceEpoch<std::chrono::milliseconds>(SystemClock::now()));
+ - ]
640 : :
641 : 19 : UniValue outboundLimit(UniValue::VOBJ);
642 [ + - + - : 38 : outboundLimit.pushKV("timeframe", count_seconds(connman.GetMaxOutboundTimeframe()));
+ - + - ]
643 [ + - + - : 38 : outboundLimit.pushKV("target", connman.GetMaxOutboundTarget());
+ - + - ]
644 [ + - + - : 38 : outboundLimit.pushKV("target_reached", connman.OutboundTargetReached(false));
+ - + - ]
645 [ + - + - : 38 : outboundLimit.pushKV("serve_historical_blocks", !connman.OutboundTargetReached(true));
+ - + - ]
646 [ + - + - : 38 : outboundLimit.pushKV("bytes_left_in_cycle", connman.GetOutboundTargetBytesLeft());
+ - + - ]
647 [ + - + - : 38 : outboundLimit.pushKV("time_left_in_cycle", count_seconds(connman.GetMaxOutboundTimeLeftInCycle()));
+ - + - ]
648 [ + - + - ]: 38 : obj.pushKV("uploadtarget", std::move(outboundLimit));
649 : 19 : return obj;
650 : 19 : },
651 [ + - + - ]: 10676 : };
652 [ + - + - : 53380 : }
+ - + - +
- + - + -
+ - + - +
- - - -
- ]
653 : :
654 : 1023 : static UniValue GetNetworksInfo()
655 : : {
656 : 1023 : UniValue networks(UniValue::VARR);
657 [ + + ]: 8184 : for (int n = 0; n < NET_MAX; ++n) {
658 : 7161 : enum Network network = static_cast<enum Network>(n);
659 [ + + ]: 7161 : if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
660 : 5115 : UniValue obj(UniValue::VOBJ);
661 [ + - + - : 10230 : obj.pushKV("name", GetNetworkName(network));
+ - + - ]
662 [ + - + - : 10230 : obj.pushKV("limited", !g_reachable_nets.Contains(network));
+ - + - ]
663 [ + - + - : 10230 : obj.pushKV("reachable", g_reachable_nets.Contains(network));
+ - + - ]
664 [ + - + + ]: 5115 : if (const auto proxy = GetProxy(network)) {
665 [ + - + - : 436 : obj.pushKV("proxy", proxy->ToString());
+ - + - ]
666 [ + - + - : 436 : obj.pushKV("proxy_randomize_credentials", proxy->m_tor_stream_isolation);
+ - ]
667 : : } else {
668 [ + - + - : 9794 : obj.pushKV("proxy", std::string());
+ - ]
669 [ + - + - : 9794 : obj.pushKV("proxy_randomize_credentials", false);
+ - ]
670 : 0 : }
671 [ + - ]: 5115 : networks.push_back(std::move(obj));
672 : 5115 : }
673 : 1023 : return networks;
674 : 0 : }
675 : :
676 : 3675 : static RPCMethod getnetworkinfo()
677 : : {
678 : 3675 : return RPCMethod{"getnetworkinfo",
679 [ + - ]: 7350 : "Returns an object containing various state info regarding P2P networking.\n",
680 : : {},
681 [ + - ]: 7350 : RPCResult{
682 [ + - ]: 7350 : RPCResult::Type::OBJ, "", "",
683 : : {
684 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "version", "the server version"},
685 [ + - + - ]: 7350 : {RPCResult::Type::STR, "subversion", "the server subversion string"},
686 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "protocolversion", "the protocol version"},
687 [ + - + - ]: 7350 : {RPCResult::Type::STR_HEX, "localservices", "the services we offer to the network"},
688 [ + - + - ]: 7350 : {RPCResult::Type::ARR, "localservicesnames", "the services we offer to the network, in human-readable form",
689 : : {
690 [ + - + - ]: 7350 : {RPCResult::Type::STR, "SERVICE_NAME", "the service name"},
691 : : }},
692 [ + - + - ]: 7350 : {RPCResult::Type::BOOL, "localrelay", "true if transaction relay is requested from peers"},
693 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "timeoffset", "the time offset"},
694 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "tx_send_rate", "configured target for maximum number of transactions per second to send to inbound peers"},
695 [ + - + - ]: 7350 : {RPCResult::Type::OBJ_DYN, "inv_buckets", "", {
696 [ + - + - ]: 7350 : {RPCResult::Type::OBJ, "inbound/outbound", "connection direction",
697 : : {
698 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "backlog", "number of queued txs to announce"},
699 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "count_tok", "tokens available to be consumed per-transaction"},
700 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "size_tok", "tokens available to be consumed per-byte"},
701 : : }
702 : : }
703 : : }},
704 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "connections", "the total number of connections"},
705 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "connections_in", "the number of inbound connections"},
706 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "connections_out", "the number of outbound connections"},
707 [ + - + - ]: 7350 : {RPCResult::Type::BOOL, "networkactive", "whether p2p networking is enabled"},
708 [ + - + - ]: 7350 : {RPCResult::Type::ARR, "networks", "information per network",
709 : : {
710 [ + - + - ]: 7350 : {RPCResult::Type::OBJ, "", "",
711 : : {
712 [ + - + - : 7350 : {RPCResult::Type::STR, "name", "network (" + Join(GetNetworkNames(), ", ") + ")"},
+ - + - ]
713 [ + - + - ]: 7350 : {RPCResult::Type::BOOL, "limited", "is the network limited using -onlynet?"},
714 [ + - + - ]: 7350 : {RPCResult::Type::BOOL, "reachable", "is the network reachable?"},
715 [ + - + - ]: 7350 : {RPCResult::Type::STR, "proxy", "(\"host:port\") the proxy that is used for this network, or empty if none"},
716 [ + - + - ]: 7350 : {RPCResult::Type::BOOL, "proxy_randomize_credentials", "Whether randomized credentials are used"},
717 : : }},
718 : : }},
719 [ + - + - ]: 7350 : {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 [ + - + - ]: 7350 : {RPCResult::Type::STR_AMOUNT, "relayfee", "minimum relay fee rate for transactions in " + CURRENCY_UNIT + "/kvB"},
721 [ + - + - ]: 7350 : {RPCResult::Type::STR_AMOUNT, "incrementalfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},
722 [ + - + - ]: 7350 : {RPCResult::Type::ARR, "localaddresses", "list of local addresses",
723 : : {
724 [ + - + - ]: 7350 : {RPCResult::Type::OBJ, "", "",
725 : : {
726 [ + - + - ]: 7350 : {RPCResult::Type::STR, "address", "network address"},
727 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "port", "network port"},
728 [ + - + - ]: 7350 : {RPCResult::Type::NUM, "score", "relative score"},
729 : : }},
730 : : }},
731 [ + - + - : 7350 : (IsDeprecatedRPCEnabled("warnings") ?
- + ]
732 [ - - - - : 3675 : RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :
- + - + -
+ - - - -
- - ]
733 [ + - + - : 14700 : 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 [ + - + - : 14700 : {RPCResult::Type::STR, "", "warning"},
+ - + - -
- - - ]
736 : : }
737 [ + - + - : 18375 : }
+ - + + +
- - - - -
- - - - ]
738 : : ),
739 : : }
740 [ + - + - : 279300 : },
+ - + - +
- + - + -
+ - + - +
+ + + + +
+ + + + +
+ + + + +
- - - - -
- - - - -
- - - - -
- ]
741 : 3675 : RPCExamples{
742 [ + - + - : 7350 : HelpExampleCli("getnetworkinfo", "")
+ - ]
743 [ + - + - : 14700 : + HelpExampleRpc("getnetworkinfo", "")
+ - + - ]
744 [ + - ]: 3675 : },
745 : 3675 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
746 : : {
747 : 1023 : LOCK(cs_main);
748 : 1023 : UniValue obj(UniValue::VOBJ);
749 [ + - + - : 2046 : obj.pushKV("version", CLIENT_VERSION);
+ - ]
750 [ + - + - : 2046 : obj.pushKV("subversion", strSubVersion);
+ - ]
751 [ + - + - : 2046 : obj.pushKV("protocolversion",PROTOCOL_VERSION);
+ - ]
752 [ + - ]: 1023 : NodeContext& node = EnsureAnyNodeContext(request.context);
753 [ + - ]: 1023 : CConnman& connman = EnsureConnman(node);
754 [ + - ]: 1023 : ServiceFlags services = connman.GetLocalServices();
755 [ + - + - : 2046 : obj.pushKV("localservices", strprintf("%016x", services));
+ - + - ]
756 [ + - + - : 2046 : obj.pushKV("localservicesnames", GetServicesNames(services));
+ - ]
757 [ + - + - ]: 1023 : auto peerman_info{EnsurePeerman(node).GetInfo()};
758 [ + - + - : 2046 : obj.pushKV("localrelay", !peerman_info.ignores_incoming_txs);
+ - ]
759 [ + - + - : 2046 : obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(peerman_info.median_outbound_time_offset));
+ - ]
760 [ + - + - : 2046 : obj.pushKV("tx_send_rate", peerman_info.tx_send_rate);
+ - ]
761 : 2046 : auto buckjson = [&](const auto& buckinfo) {
762 : 2046 : UniValue b{UniValue::VOBJ};
763 [ + - + - : 4092 : b.pushKV("backlog", buckinfo.backlog_count);
+ - ]
764 [ + - + - : 4092 : b.pushKV("count_tok", buckinfo.count_bucket);
+ - ]
765 [ + - + - : 4092 : b.pushKV("size_tok", buckinfo.size_bucket);
+ - ]
766 : 2046 : return b;
767 : 0 : };
768 : 1023 : UniValue invbuckets{UniValue::VOBJ};
769 [ + - + - : 2046 : invbuckets.pushKV("inbound", buckjson(peerman_info.inbound_bucket));
+ - ]
770 [ + - + - : 2046 : invbuckets.pushKV("outbound", buckjson(peerman_info.outbound_bucket));
+ - ]
771 [ + - + - : 2046 : obj.pushKV("inv_buckets", invbuckets);
+ - ]
772 [ + - + - : 2046 : obj.pushKV("networkactive", connman.GetNetworkActive());
+ - ]
773 [ + - + - : 2046 : obj.pushKV("connections", connman.GetNodeCount(ConnectionDirection::Both));
+ - + - ]
774 [ + - + - : 2046 : obj.pushKV("connections_in", connman.GetNodeCount(ConnectionDirection::In));
+ - + - ]
775 [ + - + - : 2046 : obj.pushKV("connections_out", connman.GetNodeCount(ConnectionDirection::Out));
+ - + - ]
776 [ + - + - : 2046 : obj.pushKV("networks", GetNetworksInfo());
+ - ]
777 [ + - + - ]: 1023 : const NetGroupManager& netgroupman{*CHECK_NONFATAL(node.netgroupman)};
778 [ + - + + ]: 1023 : if (netgroupman.UsingASMap()) {
779 [ + - + - : 6 : obj.pushKV("asmap_version", HexStr(netgroupman.GetAsmapVersion()));
+ - + - +
- ]
780 : : }
781 [ + - ]: 1023 : const CTxMemPool& mempool = EnsureAnyMemPool(request.context);
782 : : // Those fields can be deprecated, to be replaced by the getmempoolinfo fields
783 [ + - + - : 2046 : obj.pushKV("relayfee", ValueFromAmount(mempool.m_opts.min_relay_feerate.GetFeePerK()));
+ - + - ]
784 [ + - + - : 2046 : obj.pushKV("incrementalfee", ValueFromAmount(mempool.m_opts.incremental_relay_feerate.GetFeePerK()));
+ - + - ]
785 : 1023 : UniValue localAddresses(UniValue::VARR);
786 : 1023 : {
787 [ + - ]: 1023 : LOCK(g_maplocalhost_mutex);
788 [ + + ]: 1028 : for (const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)
789 : : {
790 : 5 : UniValue rec(UniValue::VOBJ);
791 [ + - + - : 10 : rec.pushKV("address", item.first.ToStringAddr());
+ - + - ]
792 [ + - + - : 10 : rec.pushKV("port", item.second.nPort);
+ - ]
793 [ + - + - : 10 : rec.pushKV("score", item.second.nScore);
+ - ]
794 [ + - ]: 5 : localAddresses.push_back(std::move(rec));
795 : 5 : }
796 : 0 : }
797 [ + - + - ]: 2046 : obj.pushKV("localaddresses", std::move(localAddresses));
798 [ + - + - : 2046 : obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));
+ - + - +
- + - ]
799 : 2046 : return obj;
800 [ + - ]: 2046 : },
801 [ + - + - ]: 14700 : };
802 [ + - + - : 268275 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - +
- + - + -
+ - - + -
- - - - -
- - - - -
- - - ]
803 : :
804 : 2699 : static RPCMethod setban()
805 : : {
806 : 2699 : return RPCMethod{
807 : 2699 : "setban",
808 [ + - ]: 5398 : "Attempts to add or remove an IP/Subnet from the banned list.\n",
809 : : {
810 [ + - + - ]: 5398 : {"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 [ + - + - ]: 5398 : {"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 [ + - + - : 8097 : {"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 [ + - + - : 8097 : {"absolute", RPCArg::Type::BOOL, RPCArg::Default{false}, "If set, the bantime must be an absolute timestamp expressed in " + UNIX_EPOCH_TIME},
+ - ]
814 : : },
815 [ + - + - : 5398 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
816 : 2699 : RPCExamples{
817 [ + - + - : 5398 : HelpExampleCli("setban", "\"192.168.0.6\" \"add\" 86400")
+ - ]
818 [ + - + - : 10796 : + HelpExampleCli("setban", "\"192.168.0.0/24\" \"add\"")
+ - + - ]
819 [ + - + - : 10796 : + HelpExampleRpc("setban", "\"192.168.0.6\", \"add\", 86400")
+ - + - ]
820 [ + - ]: 2699 : },
821 : 2699 : [](const RPCMethod& help, const JSONRPCRequest& request) -> UniValue
822 : : {
823 : 48 : auto command{help.Arg<std::string_view>("command")};
824 [ + + - + ]: 48 : if (command != "add" && command != "remove") {
825 [ # # # # ]: 0 : throw std::runtime_error(help.ToString());
826 : : }
827 : 48 : NodeContext& node = EnsureAnyNodeContext(request.context);
828 : 48 : BanMan& banman = EnsureBanman(node);
829 : :
830 : 48 : CSubNet subNet;
831 [ + - ]: 48 : CNetAddr netAddr;
832 [ + - + - ]: 48 : std::string subnet_arg{help.Arg<std::string_view>("subnet")};
833 : 48 : const bool isSubnet{subnet_arg.find('/') != subnet_arg.npos};
834 : :
835 [ + + ]: 48 : if (!isSubnet) {
836 [ + - + - ]: 30 : const std::optional<CNetAddr> addr{LookupHost(subnet_arg, false)};
837 [ + + ]: 30 : if (addr.has_value()) {
838 [ + - + - ]: 29 : netAddr = static_cast<CNetAddr>(MaybeFlipIPv6toCJDNS(CService{addr.value(), /*port=*/0}));
839 : : }
840 : 30 : } else {
841 [ + - ]: 18 : subNet = LookupSubNet(subnet_arg);
842 : : }
843 : :
844 [ + + + - : 48 : if (! (isSubnet ? subNet.IsValid() : netAddr.IsValid()) ) {
+ - + + ]
845 [ + - + - ]: 6 : throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Invalid IP/Subnet");
846 : : }
847 : :
848 [ + + ]: 45 : if (command == "add") {
849 [ + + + - : 35 : if (isSubnet ? banman.IsBanned(subNet) : banman.IsBanned(netAddr)) {
+ - + + ]
850 [ + - + - ]: 8 : throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: IP/Subnet already banned");
851 : : }
852 : :
853 [ + - ]: 31 : const int64_t banTime{help.Arg<int64_t>("bantime")};
854 [ + - ]: 31 : const bool absolute{help.Arg<bool>("absolute")};
855 : :
856 [ + + + - : 31 : if (absolute && banTime < GetTime()) {
+ + ]
857 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Absolute timestamp is in the past");
858 : : }
859 : :
860 [ + + ]: 29 : if (isSubnet) {
861 [ + - ]: 13 : banman.Ban(subNet, banTime, absolute);
862 [ + - ]: 13 : if (node.connman) {
863 [ + - ]: 13 : node.connman->DisconnectNode(subNet);
864 : : }
865 : : } else {
866 [ + - ]: 16 : banman.Ban(netAddr, banTime, absolute);
867 [ + - ]: 16 : if (node.connman) {
868 [ + - ]: 16 : node.connman->DisconnectNode(netAddr);
869 : : }
870 : : }
871 [ + - ]: 10 : } else if(command == "remove") {
872 [ + + + - : 10 : if (!( isSubnet ? banman.Unban(subNet) : banman.Unban(netAddr) )) {
+ - + + ]
873 [ + - + - ]: 4 : throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Unban failed. Requested address/subnet was not previously manually banned.");
874 : : }
875 : : }
876 : 37 : return UniValue::VNULL;
877 : 59 : },
878 [ + - + - : 21592 : };
+ + - - ]
879 [ + - + - : 21592 : }
+ - + - -
- ]
880 : :
881 : 2697 : static RPCMethod listbanned()
882 : : {
883 : 2697 : return RPCMethod{
884 : 2697 : "listbanned",
885 [ + - ]: 5394 : "List all manually banned IPs/Subnets.\n",
886 : : {},
887 [ + - + - ]: 10788 : RPCResult{RPCResult::Type::ARR, "", "",
888 : : {
889 [ + - + - ]: 5394 : {RPCResult::Type::OBJ, "", "",
890 : : {
891 [ + - + - ]: 5394 : {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},
892 [ + - + - ]: 5394 : {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},
893 [ + - + - ]: 5394 : {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},
894 [ + - + - ]: 5394 : {RPCResult::Type::NUM_TIME, "ban_duration", "The ban duration, in seconds"},
895 [ + - + - ]: 8091 : {RPCResult::Type::NUM_TIME, "time_remaining", "The time remaining until the ban expires, in seconds"},
896 : : }},
897 [ + - + - : 40455 : }},
+ - + + +
+ - - -
- ]
898 : 2697 : RPCExamples{
899 [ + - + - : 5394 : HelpExampleCli("listbanned", "")
+ - ]
900 [ + - + - : 10788 : + HelpExampleRpc("listbanned", "")
+ - + - ]
901 [ + - ]: 2697 : },
902 : 2697 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
903 : : {
904 : 47 : BanMan& banman = EnsureAnyBanman(request.context);
905 : :
906 [ + - ]: 47 : banmap_t banMap;
907 [ + - ]: 47 : banman.GetBanned(banMap);
908 [ + - ]: 47 : const int64_t current_time{GetTime()};
909 : :
910 : 47 : UniValue bannedAddresses(UniValue::VARR);
911 [ + + ]: 107 : for (const auto& entry : banMap)
912 : : {
913 : 60 : const CBanEntry& banEntry = entry.second;
914 : 60 : UniValue rec(UniValue::VOBJ);
915 [ + - + - : 120 : rec.pushKV("address", entry.first.ToString());
+ - + - ]
916 [ + - + - : 120 : rec.pushKV("ban_created", banEntry.nCreateTime);
+ - ]
917 [ + - + - : 120 : rec.pushKV("banned_until", banEntry.nBanUntil);
+ - ]
918 [ + - + - : 120 : rec.pushKV("ban_duration", (banEntry.nBanUntil - banEntry.nCreateTime));
+ - ]
919 [ + - + - : 120 : rec.pushKV("time_remaining", (banEntry.nBanUntil - current_time));
+ - ]
920 : :
921 [ + - ]: 60 : bannedAddresses.push_back(std::move(rec));
922 : 60 : }
923 : :
924 : 47 : return bannedAddresses;
925 : 47 : },
926 [ + - + - ]: 10788 : };
927 [ + - + - : 32364 : }
+ - + - +
- + - -
- ]
928 : :
929 : 2661 : static RPCMethod clearbanned()
930 : : {
931 : 2661 : return RPCMethod{
932 : 2661 : "clearbanned",
933 [ + - ]: 5322 : "Clear all banned IPs.\n",
934 : : {},
935 [ + - + - : 5322 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - ]
936 : 2661 : RPCExamples{
937 [ + - + - : 5322 : HelpExampleCli("clearbanned", "")
+ - ]
938 [ + - + - : 10644 : + HelpExampleRpc("clearbanned", "")
+ - + - ]
939 [ + - ]: 2661 : },
940 : 2661 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
941 : : {
942 : 11 : BanMan& banman = EnsureAnyBanman(request.context);
943 : :
944 : 11 : banman.ClearBanned();
945 : :
946 : 11 : return UniValue::VNULL;
947 : : },
948 [ + - + - ]: 10644 : };
949 : : }
950 : :
951 : 2663 : static RPCMethod setnetworkactive()
952 : : {
953 : 2663 : return RPCMethod{
954 : 2663 : "setnetworkactive",
955 [ + - ]: 5326 : "Disable/enable all p2p network activity.\n",
956 : : {
957 [ + - + - ]: 5326 : {"state", RPCArg::Type::BOOL, RPCArg::Optional::NO, "true to enable networking, false to disable"},
958 : : },
959 [ + - + - : 5326 : RPCResult{RPCResult::Type::BOOL, "", "The value that was passed in"},
+ - + - ]
960 [ + - + - ]: 7989 : RPCExamples{""},
961 : 2663 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
962 : : {
963 : 13 : NodeContext& node = EnsureAnyNodeContext(request.context);
964 : 13 : CConnman& connman = EnsureConnman(node);
965 : :
966 : 13 : connman.SetNetworkActive(request.params[0].get_bool());
967 : :
968 : 13 : return connman.GetNetworkActive();
969 : : },
970 [ + - + - : 13315 : };
+ + - - ]
971 [ + - ]: 5326 : }
972 : :
973 : 2695 : static RPCMethod getnodeaddresses()
974 : : {
975 : 2695 : return RPCMethod{"getnodeaddresses",
976 [ + - ]: 5390 : "Return known addresses, after filtering for quality and recency.\n"
977 : : "These can potentially be used to find new peers in the network.\n"
978 : : "The total number of addresses known to the node may be higher.",
979 : : {
980 [ + - + - : 8085 : {"count", RPCArg::Type::NUM, RPCArg::Default{1}, "The maximum number of addresses to return. Specify 0 to return all known addresses."},
+ - ]
981 [ + - + - : 8085 : {"network", RPCArg::Type::STR, RPCArg::DefaultHint{"all networks"}, "Return only addresses of the specified network. Can be one of: " + Join(GetNetworkNames(), ", ") + "."},
+ - + - +
- ]
982 : : },
983 [ + - ]: 5390 : RPCResult{
984 [ + - + - ]: 5390 : RPCResult::Type::ARR, "", "",
985 : : {
986 [ + - + - ]: 5390 : {RPCResult::Type::OBJ, "", "",
987 : : {
988 [ + - + - ]: 5390 : {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
989 [ + - + - ]: 5390 : {RPCResult::Type::NUM, "services", "The services offered by the node"},
990 [ + - + - ]: 5390 : {RPCResult::Type::STR, "address", "The address of the node"},
991 [ + - + - ]: 5390 : {RPCResult::Type::NUM, "port", "The port number of the node"},
992 [ + - + - : 5390 : {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") the node connected through"},
+ - + - ]
993 : : }},
994 : : }
995 [ + - + - : 40425 : },
+ - + + +
+ - - -
- ]
996 : 2695 : RPCExamples{
997 [ + - + - : 5390 : HelpExampleCli("getnodeaddresses", "8")
+ - ]
998 [ + - + - : 10780 : + HelpExampleCli("getnodeaddresses", "4 \"i2p\"")
+ - + - ]
999 [ + - + - : 10780 : + HelpExampleCli("-named getnodeaddresses", "network=onion count=12")
+ - + - ]
1000 [ + - + - : 10780 : + HelpExampleRpc("getnodeaddresses", "8")
+ - + - ]
1001 [ + - + - : 10780 : + HelpExampleRpc("getnodeaddresses", "4, \"i2p\"")
+ - + - ]
1002 [ + - ]: 2695 : },
1003 : 2695 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1004 : : {
1005 : 45 : NodeContext& node = EnsureAnyNodeContext(request.context);
1006 : 45 : const CConnman& connman = EnsureConnman(node);
1007 : :
1008 : 45 : const int count{self.Arg<int>("count")};
1009 [ + + + - : 47 : if (count < 0) throw JSONRPCError(RPC_INVALID_PARAMETER, "Address count out of range");
+ - ]
1010 : :
1011 [ + + ]: 43 : const std::optional<Network> network{request.params[1].isNull() ? std::nullopt : std::optional<Network>{ParseNetwork(request.params[1].get_str())}};
1012 [ + + ]: 43 : if (network == NET_UNROUTABLE) {
1013 [ + - + - : 8 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Network not recognized: %s", request.params[1].get_str()));
+ - + - ]
1014 : : }
1015 : :
1016 : : // returns a shuffled list of CAddress
1017 : 39 : const std::vector<CAddress> vAddr{connman.GetAddressesUnsafe(count, /*max_pct=*/0, network)};
1018 : 39 : UniValue ret(UniValue::VARR);
1019 : :
1020 [ + + ]: 27736 : for (const CAddress& addr : vAddr) {
1021 : 27697 : UniValue obj(UniValue::VOBJ);
1022 [ + - + - : 55394 : obj.pushKV("time", TicksSinceEpoch<std::chrono::seconds>(addr.nTime));
+ - ]
1023 [ + - + - : 55394 : obj.pushKV("services", static_cast<std::underlying_type_t<decltype(addr.nServices)>>(addr.nServices));
+ - ]
1024 [ + - + - : 55394 : obj.pushKV("address", addr.ToStringAddr());
+ - + - ]
1025 [ + - + - : 55394 : obj.pushKV("port", addr.GetPort());
+ - + - ]
1026 [ + - + - : 55394 : obj.pushKV("network", GetNetworkName(addr.GetNetClass()));
+ - + - +
- ]
1027 [ + - ]: 27697 : ret.push_back(std::move(obj));
1028 : 27697 : }
1029 : 39 : return ret;
1030 : 39 : },
1031 [ + - + - : 16170 : };
+ + - - ]
1032 [ + - + - : 43120 : }
+ - + - +
- + - + -
+ - - - -
- ]
1033 : :
1034 : 35013 : static RPCMethod addpeeraddress()
1035 : : {
1036 : 35013 : return RPCMethod{"addpeeraddress",
1037 [ + - ]: 70026 : "Add the address of a potential peer to an address manager table. This RPC is for testing only.",
1038 : : {
1039 [ + - + - ]: 70026 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address of the peer"},
1040 [ + - + - ]: 70026 : {"port", RPCArg::Type::NUM, RPCArg::Optional::NO, "The port of the peer"},
1041 [ + - + - : 105039 : {"tried", RPCArg::Type::BOOL, RPCArg::Default{false}, "If true, attempt to add the peer to the tried addresses table"},
+ - ]
1042 : : },
1043 [ + - ]: 70026 : RPCResult{
1044 [ + - + - ]: 70026 : RPCResult::Type::OBJ, "", "",
1045 : : {
1046 [ + - + - ]: 70026 : {RPCResult::Type::BOOL, "success", "whether the peer address was successfully added to the address manager table"},
1047 [ + - + - ]: 70026 : {RPCResult::Type::STR, "error", /*optional=*/true, "error description, if the address could not be added"},
1048 : : },
1049 [ + - + - : 210078 : },
+ + - - ]
1050 : 35013 : RPCExamples{
1051 [ + - + - : 70026 : HelpExampleCli("addpeeraddress", "\"1.2.3.4\" 8333 true")
+ - ]
1052 [ + - + - : 140052 : + HelpExampleRpc("addpeeraddress", "\"1.2.3.4\", 8333, true")
+ - + - ]
1053 [ + - ]: 35013 : },
1054 : 35013 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue
1055 : : {
1056 : 32370 : AddrMan& addrman = EnsureAnyAddrman(request.context);
1057 : :
1058 : 32370 : const std::string& addr_string{request.params[0].get_str()};
1059 : 32370 : const auto port{request.params[1].getInt<uint16_t>()};
1060 : 32366 : const bool tried{self.Arg<bool>("tried")};
1061 : :
1062 : 32366 : UniValue obj(UniValue::VOBJ);
1063 [ + - + - ]: 32366 : std::optional<CNetAddr> net_addr{LookupHost(addr_string, false)};
1064 [ + + ]: 32366 : if (!net_addr.has_value()) {
1065 [ + - + - ]: 8 : throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Invalid IP address");
1066 : : }
1067 : :
1068 : 32362 : bool success{false};
1069 : :
1070 [ + - ]: 32362 : CService service{net_addr.value(), port};
1071 [ + - ]: 64724 : CAddress address{MaybeFlipIPv6toCJDNS(service), ServiceFlags{NODE_NETWORK | NODE_WITNESS}};
1072 : 32362 : address.nTime = Now<NodeSeconds>();
1073 : : // The source address is set equal to the address. This is equivalent to the peer
1074 : : // announcing itself.
1075 [ + - + - : 64724 : if (addrman.Add({address}, address)) {
+ + + + -
- ]
1076 : 28555 : success = true;
1077 [ + + ]: 28555 : if (tried) {
1078 : : // Attempt to move the address to the tried addresses table.
1079 [ + - + + ]: 22 : if (!addrman.Good(address)) {
1080 : 2 : success = false;
1081 [ + - + - : 4 : obj.pushKV("error", "failed-adding-to-tried");
+ - ]
1082 : : }
1083 : : }
1084 : : } else {
1085 [ + - + - : 7614 : obj.pushKV("error", "failed-adding-to-new");
+ - ]
1086 : : }
1087 : :
1088 [ + - + - : 64724 : obj.pushKV("success", success);
+ - ]
1089 : 32362 : return obj;
1090 : 64728 : },
1091 [ + - + - : 245091 : };
+ + - - ]
1092 [ + - + - : 350130 : }
+ - + - +
- - - -
- ]
1093 : :
1094 : 2657 : static RPCMethod sendmsgtopeer()
1095 : : {
1096 : 2657 : return RPCMethod{
1097 : 2657 : "sendmsgtopeer",
1098 [ + - ]: 5314 : "Send a p2p message to a peer specified by id.\n"
1099 : : "The message type and body must be provided, the message header will be generated.\n"
1100 : : "This RPC is for testing only.",
1101 : : {
1102 [ + - + - ]: 5314 : {"peer_id", RPCArg::Type::NUM, RPCArg::Optional::NO, "The peer to send the message to."},
1103 [ + - + - ]: 5314 : {"msg_type", RPCArg::Type::STR, RPCArg::Optional::NO, strprintf("The message type (maximum length %i)", CMessageHeader::MESSAGE_TYPE_SIZE)},
1104 [ + - + - ]: 5314 : {"msg", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The serialized message body to send, in hex, without a message header"},
1105 : : },
1106 [ + - + - : 5314 : RPCResult{RPCResult::Type::OBJ, "", "", std::vector<RPCResult>{}},
+ - + - ]
1107 : 2657 : RPCExamples{
1108 [ + - + - : 7971 : HelpExampleCli("sendmsgtopeer", "0 \"addr\" \"ffffff\"") + HelpExampleRpc("sendmsgtopeer", R"(0, "addr", "ffffff")")},
+ - + - +
- + - + -
+ - ]
1109 : 2657 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1110 : 18 : const NodeId peer_id{request.params[0].getInt<int64_t>()};
1111 : 18 : const auto msg_type{self.Arg<std::string_view>("msg_type")};
1112 [ + + ]: 18 : if (msg_type.size() > CMessageHeader::MESSAGE_TYPE_SIZE) {
1113 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Error: msg_type too long, max length is %i", CMessageHeader::MESSAGE_TYPE_SIZE));
1114 : : }
1115 : 16 : auto msg{TryParseHex<unsigned char>(self.Arg<std::string_view>("msg"))};
1116 [ - + ]: 16 : if (!msg.has_value()) {
1117 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Error parsing input for msg");
1118 : : }
1119 : :
1120 [ + - ]: 16 : NodeContext& node = EnsureAnyNodeContext(request.context);
1121 [ + - ]: 16 : CConnman& connman = EnsureConnman(node);
1122 : :
1123 [ + - ]: 16 : CSerializedNetMsg msg_ser;
1124 [ + - + - ]: 16 : msg_ser.data = msg.value();
1125 [ + - ]: 16 : msg_ser.m_type = msg_type;
1126 : :
1127 [ + - ]: 16 : bool success = connman.ForNode(peer_id, [&](CNode* node) {
1128 : 14 : connman.PushMessage(node, std::move(msg_ser));
1129 : 14 : return true;
1130 : : });
1131 : :
1132 [ + + ]: 16 : if (!success) {
1133 [ + - + - ]: 4 : throw JSONRPCError(RPC_MISC_ERROR, "Error: Could not send message to peer");
1134 : : }
1135 : :
1136 : 14 : UniValue ret{UniValue::VOBJ};
1137 : 14 : return ret;
1138 : 16 : },
1139 [ + - + - : 18599 : };
+ + - - ]
1140 [ + - + - : 15942 : }
+ - - - ]
1141 : :
1142 : 2658 : static RPCMethod getaddrmaninfo()
1143 : : {
1144 : 2658 : return RPCMethod{
1145 : 2658 : "getaddrmaninfo",
1146 [ + - ]: 5316 : "Provides information about the node's address manager by returning the number of "
1147 : : "unique addresses in the `new` and `tried` tables and their sum for all networks.\n",
1148 : : {},
1149 [ + - ]: 5316 : RPCResult{
1150 [ + - ]: 5316 : RPCResult::Type::OBJ_DYN, "", "json object with network type as keys", {
1151 [ + - + - : 5316 : {RPCResult::Type::OBJ, "network", "the network (" + Join(GetNetworkNames(), ", ") + ", all_networks)", {
+ - + - ]
1152 [ + - + - ]: 5316 : {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. "
1153 : : "An address can be stored in multiple new table buckets but is counted only once."},
1154 [ + - + - ]: 5316 : {RPCResult::Type::NUM, "tried", "number of addresses in the tried table, which represent peers the node has successfully connected to in the past."},
1155 [ + - + - ]: 5316 : {RPCResult::Type::NUM, "total", "total number of unique addresses in both new/tried tables"},
1156 : : }},
1157 [ + - + - : 29238 : }},
+ - + + +
+ - - -
- ]
1158 [ + - + - : 7974 : RPCExamples{HelpExampleCli("getaddrmaninfo", "") + HelpExampleRpc("getaddrmaninfo", "")},
+ - + - +
- + - + -
+ - ]
1159 : 2658 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1160 : 8 : AddrMan& addrman = EnsureAnyAddrman(request.context);
1161 : :
1162 : 8 : UniValue ret(UniValue::VOBJ);
1163 [ + + ]: 64 : for (int n = 0; n < NET_MAX; ++n) {
1164 : 56 : enum Network network = static_cast<enum Network>(n);
1165 [ + + ]: 56 : if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
1166 : 40 : UniValue obj(UniValue::VOBJ);
1167 [ + - + - : 80 : obj.pushKV("new", addrman.Size(network, true));
+ - + - ]
1168 [ + - + - : 80 : obj.pushKV("tried", addrman.Size(network, false));
+ - + - ]
1169 [ + - + - : 80 : obj.pushKV("total", addrman.Size(network));
+ - + - ]
1170 [ + - + - ]: 80 : ret.pushKV(GetNetworkName(network), std::move(obj));
1171 : 40 : }
1172 : 8 : UniValue obj(UniValue::VOBJ);
1173 [ + - + - : 16 : obj.pushKV("new", addrman.Size(std::nullopt, true));
+ - + - ]
1174 [ + - + - : 16 : obj.pushKV("tried", addrman.Size(std::nullopt, false));
+ - + - ]
1175 [ + - + - : 16 : obj.pushKV("total", addrman.Size());
+ - + - ]
1176 [ + - + - ]: 16 : ret.pushKV("all_networks", std::move(obj));
1177 : 8 : return ret;
1178 : 8 : },
1179 [ + - + - ]: 10632 : };
1180 [ + - + - : 21264 : }
+ - + - -
- ]
1181 : :
1182 : 2651 : static RPCMethod exportasmap()
1183 : : {
1184 : 2651 : return RPCMethod{
1185 : 2651 : "exportasmap",
1186 [ + - ]: 5302 : "Export the embedded ASMap data to a file. Any existing file at the path will be overwritten.\n",
1187 : : {
1188 [ + - + - ]: 5302 : {"path", RPCArg::Type::STR, RPCArg::Optional::NO, "Path to the output file. If relative, will be prefixed by datadir."},
1189 : : },
1190 [ + - ]: 5302 : RPCResult{
1191 [ + - + - ]: 5302 : RPCResult::Type::OBJ, "", "",
1192 : : {
1193 [ + - + - ]: 5302 : {RPCResult::Type::STR, "path", "the absolute path that the ASMap data was written to"},
1194 [ + - + - ]: 5302 : {RPCResult::Type::NUM, "bytes_written", "the number of bytes written to the file"},
1195 [ + - + - ]: 5302 : {RPCResult::Type::STR_HEX, "file_hash", "the SHA256 hash of the exported ASMap data"},
1196 : : }
1197 [ + - + - : 21208 : },
+ + - - ]
1198 : 2651 : RPCExamples{
1199 [ + - + - : 7953 : HelpExampleCli("exportasmap", "\"asmap.dat\"") + HelpExampleRpc("exportasmap", "\"asmap.dat\"")},
+ - + - +
- + - + -
+ - ]
1200 : 2651 : [&](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1201 : : #ifndef ENABLE_EMBEDDED_ASMAP
1202 : : throw JSONRPCError(RPC_MISC_ERROR, "No embedded ASMap data available");
1203 : : #else
1204 [ - + ]: 1 : if (node::data::ip_asn.empty() || !CheckStandardAsmap(node::data::ip_asn)) {
1205 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Embedded ASMap data appears to be corrupted");
1206 : : }
1207 : :
1208 : 1 : const ArgsManager& args{EnsureAnyArgsman(request.context)};
1209 [ + - + - ]: 2 : const fs::path export_path{fsbridge::AbsPathJoin(args.GetDataDirNet(), fs::u8path(self.Arg<std::string_view>("path")))};
1210 : :
1211 [ + - + - ]: 2 : AutoFile file{fsbridge::fopen(export_path, "wb")};
1212 [ - + ]: 1 : if (file.IsNull()) {
1213 [ # # # # : 0 : throw JSONRPCError(RPC_MISC_ERROR, strprintf("Failed to open asmap file: %s", fs::PathToString(export_path)));
# # ]
1214 : : }
1215 : :
1216 [ + - ]: 1 : file << node::data::ip_asn;
1217 : :
1218 [ + - - + ]: 2 : if (file.fclose() != 0) {
1219 [ # # # # : 0 : throw JSONRPCError(RPC_MISC_ERROR, strprintf("Failed to close asmap file: %s", fs::PathToString(export_path)));
# # ]
1220 : : }
1221 : :
1222 : 1 : UniValue result(UniValue::VOBJ);
1223 [ + - + - : 2 : result.pushKV("path", export_path.utf8string());
+ - + - ]
1224 [ + - + - : 2 : result.pushKV("bytes_written", node::data::ip_asn.size());
+ - ]
1225 [ + - + - : 2 : result.pushKV("file_hash", HexStr(AsmapVersion(node::data::ip_asn)));
+ - + - +
- ]
1226 : 2 : return result;
1227 : : #endif
1228 : 2 : },
1229 [ + - + - : 13255 : };
+ + - - ]
1230 [ + - + - : 21208 : }
+ - + - -
- ]
1231 : :
1232 : 26 : UniValue AddrmanEntryToJSON(const AddrInfo& info, const CConnman& connman)
1233 : : {
1234 : 26 : UniValue ret(UniValue::VOBJ);
1235 [ + - + - : 52 : ret.pushKV("address", info.ToStringAddr());
+ - + - ]
1236 [ + - ]: 26 : const uint32_t mapped_as{connman.GetMappedAS(info)};
1237 [ + + ]: 26 : if (mapped_as) {
1238 [ + - + - : 8 : ret.pushKV("mapped_as", mapped_as);
+ - ]
1239 : : }
1240 [ + - + - : 52 : ret.pushKV("port", info.GetPort());
+ - + - ]
1241 [ + - + - : 52 : ret.pushKV("services", static_cast<std::underlying_type_t<decltype(info.nServices)>>(info.nServices));
+ - ]
1242 [ + - + - : 52 : ret.pushKV("time", TicksSinceEpoch<std::chrono::seconds>(info.nTime));
+ - ]
1243 [ + - + - : 52 : ret.pushKV("network", GetNetworkName(info.GetNetClass()));
+ - + - +
- ]
1244 [ + - + - : 52 : ret.pushKV("source", info.source.ToStringAddr());
+ - + - ]
1245 [ + - + - : 52 : ret.pushKV("source_network", GetNetworkName(info.source.GetNetClass()));
+ - + - +
- ]
1246 [ + - ]: 26 : const uint32_t source_mapped_as{connman.GetMappedAS(info.source)};
1247 [ + + ]: 26 : if (source_mapped_as) {
1248 [ + - + - : 8 : ret.pushKV("source_mapped_as", source_mapped_as);
+ - ]
1249 : : }
1250 : 26 : return ret;
1251 : 0 : }
1252 : :
1253 : 14 : UniValue AddrmanTableToJSON(const std::vector<std::pair<AddrInfo, AddressPosition>>& tableInfos, const CConnman& connman)
1254 : : {
1255 : 14 : UniValue table(UniValue::VOBJ);
1256 [ + + ]: 40 : for (const auto& e : tableInfos) {
1257 : 26 : AddrInfo info = e.first;
1258 : 26 : AddressPosition location = e.second;
1259 [ + - ]: 26 : std::ostringstream key;
1260 [ + - + - : 26 : key << location.bucket << "/" << location.position;
+ - ]
1261 : : // Address manager tables have unique entries so there is no advantage
1262 : : // in using UniValue::pushKV, which checks if the key already exists
1263 : : // in O(N). UniValue::pushKVEnd is used instead which currently is O(1).
1264 [ + - + - ]: 78 : table.pushKVEnd(key.str(), AddrmanEntryToJSON(info, connman));
1265 : 52 : }
1266 : 14 : return table;
1267 : 0 : }
1268 : :
1269 : 2648 : static RPCMethod getrawaddrman()
1270 : : {
1271 : 2648 : return RPCMethod{"getrawaddrman",
1272 [ + - ]: 5296 : "EXPERIMENTAL warning: this call may be changed in future releases.\n"
1273 : : "\nReturns information on all address manager entries for the new and tried tables.\n",
1274 : : {},
1275 [ + - ]: 5296 : RPCResult{
1276 [ + - ]: 5296 : RPCResult::Type::OBJ_DYN, "", "", {
1277 [ + - + - ]: 5296 : {RPCResult::Type::OBJ_DYN, "table", "buckets with addresses in the address manager table ( new, tried )", {
1278 [ + - + - ]: 5296 : {RPCResult::Type::OBJ, "bucket/position", "the location in the address manager table (<bucket>/<position>)", {
1279 [ + - + - ]: 5296 : {RPCResult::Type::STR, "address", "The address of the node"},
1280 [ + - + - ]: 5296 : {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)"},
1281 [ + - + - ]: 5296 : {RPCResult::Type::NUM, "port", "The port number of the node"},
1282 [ + - + - : 5296 : {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the address"},
+ - + - ]
1283 [ + - + - ]: 5296 : {RPCResult::Type::NUM, "services", "The services offered by the node"},
1284 [ + - + - ]: 5296 : {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},
1285 [ + - + - ]: 5296 : {RPCResult::Type::STR, "source", "The address that relayed the address to us"},
1286 [ + - + - : 5296 : {RPCResult::Type::STR, "source_network", "The network (" + Join(GetNetworkNames(), ", ") + ") of the source address"},
+ - + - ]
1287 [ + - + - ]: 5296 : {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)"}
1288 : : }}
1289 : : }}
1290 : : }
1291 [ + - + - : 68848 : },
+ - + - +
+ + + + +
- - - - -
- ]
1292 : 2648 : RPCExamples{
1293 [ + - + - : 5296 : HelpExampleCli("getrawaddrman", "")
+ - ]
1294 [ + - + - : 10592 : + HelpExampleRpc("getrawaddrman", "")
+ - + - ]
1295 [ + - ]: 2648 : },
1296 : 2648 : [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue {
1297 : 7 : AddrMan& addrman = EnsureAnyAddrman(request.context);
1298 : 7 : NodeContext& node_context = EnsureAnyNodeContext(request.context);
1299 : 7 : CConnman& connman = EnsureConnman(node_context);
1300 : :
1301 : 7 : UniValue ret(UniValue::VOBJ);
1302 [ + - + - : 14 : ret.pushKV("new", AddrmanTableToJSON(addrman.GetEntries(false), connman));
+ - + - ]
1303 [ + - + - : 14 : ret.pushKV("tried", AddrmanTableToJSON(addrman.GetEntries(true), connman));
+ - + - ]
1304 : 7 : return ret;
1305 : 0 : },
1306 [ + - + - ]: 10592 : };
1307 [ + - + - : 58256 : }
+ - + - +
- + - + -
+ - + - +
- + - -
- ]
1308 : :
1309 : 1466 : void RegisterNetRPCCommands(CRPCTable& t)
1310 : : {
1311 : 1466 : static const CRPCCommand commands[]{
1312 [ + - ]: 2636 : {"network", &getconnectioncount},
1313 [ + - ]: 2636 : {"network", &ping},
1314 [ + - ]: 2636 : {"network", &getpeerinfo},
1315 [ + - ]: 2636 : {"network", &addnode},
1316 [ + - ]: 2636 : {"network", &disconnectnode},
1317 [ + - ]: 2636 : {"network", &getaddednodeinfo},
1318 [ + - ]: 2636 : {"network", &getnettotals},
1319 [ + - ]: 2636 : {"network", &getnetworkinfo},
1320 [ + - ]: 2636 : {"network", &setban},
1321 [ + - ]: 2636 : {"network", &listbanned},
1322 [ + - ]: 2636 : {"network", &clearbanned},
1323 [ + - ]: 2636 : {"network", &setnetworkactive},
1324 [ + - ]: 2636 : {"network", &getnodeaddresses},
1325 [ + - ]: 2636 : {"network", &getaddrmaninfo},
1326 [ + - ]: 2636 : {"network", &exportasmap},
1327 [ + - ]: 2636 : {"hidden", &addconnection},
1328 [ + - ]: 2636 : {"hidden", &addpeeraddress},
1329 [ + - ]: 2636 : {"hidden", &sendmsgtopeer},
1330 [ + - ]: 2636 : {"hidden", &getrawaddrman},
1331 [ + + + - : 26508 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - -
- ]
1332 [ + + ]: 29320 : for (const auto& c : commands) {
1333 : 27854 : t.appendCommand(c.name, &c);
1334 : : }
1335 : 1466 : }
|
