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