Bitcoin Core Fuzz Coverage Report

Coverage Report

Created: 2026-03-24 13:57

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