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