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