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