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