// Copyright (c) 2009-present The Bitcoin Core developers

// Distributed under the MIT software license, see the accompanying

// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <rpc/register.h> // IWYU pragma: associated

#include <rpc/server.h>

#include <addrman.h>

#include <addrman_impl.h>

#include <banman.h>

#include <chainparams.h>

#include <clientversion.h>

#include <core_io.h>

#include <crypto/hex_base.h>

#include <net.h>

#include <net_permissions.h>

#include <net_processing.h>

#include <net_types.h>

#include <netaddress.h>

#include <netbase.h>

#include <netgroup.h>

#include <node/connection_types.h>

#include <node/context.h>

#include <node/protocol_version.h>

#include <node/warnings.h>

#include <policy/feerate.h>

#include <protocol.h>

#include <rpc/protocol.h>

#include <rpc/request.h>

#include <rpc/server_util.h>

#include <rpc/util.h>

#include <semaphore_grant.h>

#include <sync.h>

#include <tinyformat.h>

#include <txmempool.h>

#include <uint256.h>

#include <univalue.h>

#include <util/chaintype.h>

#include <util/check.h>

#include <util/strencodings.h>

#include <util/string.h>

#include <util/time.h>

#include <validation.h>

#ifdef ENABLE_EMBEDDED_ASMAP

#include <common/args.h>

#include <node/data/ip_asn.dat.h>

#include <streams.h>

#include <util/asmap.h>

#include <util/fs.h>

#endif

#include <atomic>

#include <compare>

#include <cstdint>

#include <map>

#include <memory>

#include <optional>

#include <span>

#include <sstream>

#include <stdexcept>

#include <string>

#include <string_view>

#include <type_traits>

#include <utility>

#include <vector>

using node::NodeContext;

using util::Join;

using util::TrimStringView;

const std::vector<std::string> CONNECTION_TYPE_DOC{

        "outbound-full-relay (default automatic connections)",

        "block-relay-only (does not relay transactions or addresses)",

        "inbound (initiated by the peer)",

        "manual (added via addnode RPC or -addnode/-connect configuration options)",

        "addr-fetch (short-lived automatic connection for soliciting addresses)",

        "feeler (short-lived automatic connection for testing addresses)",

        "private-broadcast (short-lived automatic connection for broadcasting privacy-sensitive transactions)"

};

const std::vector<std::string> TRANSPORT_TYPE_DOC{

    "detecting (peer could be v1 or v2)",

    "v1 (plaintext transport protocol)",

    "v2 (BIP324 encrypted transport protocol)"

};

static RPCMethod getconnectioncount()

{

    return RPCMethod{

        "getconnectioncount",

        "Returns the number of connections to other nodes.\n",

                {},

                RPCResult{

                    RPCResult::Type::NUM, "", "The connection count"

                },

                RPCExamples{

                    HelpExampleCli("getconnectioncount", "")

            + HelpExampleRpc("getconnectioncount", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    const CConnman& connman = EnsureConnman(node);

    return connman.GetNodeCount(ConnectionDirection::Both);

},

    };

}

static RPCMethod ping()

{

    return RPCMethod{

        "ping",

        "Requests that a ping be sent to all other nodes, to measure ping time.\n"

                "Results are provided in getpeerinfo.\n"

                "Ping command is handled in queue with all other commands, so it measures processing backlog, not just network ping.\n",

                {},

                RPCResult{RPCResult::Type::NONE, "", ""},

                RPCExamples{

                    HelpExampleCli("ping", "")

            + HelpExampleRpc("ping", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    PeerManager& peerman = EnsurePeerman(node);

    // Request that each node send a ping during next message processing pass

    peerman.SendPings();

    return UniValue::VNULL;

},

    };

}

/** Returns, given services flags, a list of humanly readable (known) network services */

static UniValue GetServicesNames(ServiceFlags services)

{

    UniValue servicesNames(UniValue::VARR);

    for (const auto& flag : serviceFlagsToStr(services)) {

        servicesNames.push_back(flag);

    }

    return servicesNames;

}

static RPCMethod getpeerinfo()

{

    return RPCMethod{

        "getpeerinfo",

        "Returns data about each connected network peer as a json array of objects.",

        {},

        RPCResult{

            RPCResult::Type::ARR, "", "",

            {

                {RPCResult::Type::OBJ, "", "",

                {

                    {

                    {RPCResult::Type::NUM, "id", "Peer index"},

                    {RPCResult::Type::STR, "addr", "(host:port) The IP address/hostname optionally followed by :port of the peer"},

                    {RPCResult::Type::STR, "addrbind", /*optional=*/true, "(ip:port) Bind address of the connection to the peer"},

                    {RPCResult::Type::STR, "addrlocal", /*optional=*/true, "(ip:port) Local address as reported by the peer"},

                    {RPCResult::Type::STR, "network", "Network (" + Join(GetNetworkNames(/*append_unroutable=*/true), ", ") + ")"},

                    {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"

                                                        "peer selection (only displayed if the -asmap config option is set)"},

                    {RPCResult::Type::STR_HEX, "services", "The services offered"},

                    {RPCResult::Type::ARR, "servicesnames", "the services offered, in human-readable form",

                    {

                        {RPCResult::Type::STR, "SERVICE_NAME", "the service name if it is recognised"}

                    }},

                    {RPCResult::Type::BOOL, "relaytxes", "Whether we relay transactions to this peer"},

                    {RPCResult::Type::NUM, "last_inv_sequence", "Mempool sequence number of this peer's last INV"},

                    {RPCResult::Type::NUM, "inv_to_send", "How many txs we have queued to announce to this peer"},

                    {RPCResult::Type::NUM_TIME, "lastsend", "The " + UNIX_EPOCH_TIME + " of the last send"},

                    {RPCResult::Type::NUM_TIME, "lastrecv", "The " + UNIX_EPOCH_TIME + " of the last receive"},

                    {RPCResult::Type::NUM_TIME, "last_transaction", "The " + UNIX_EPOCH_TIME + " of the last valid transaction received from this peer"},

                    {RPCResult::Type::NUM_TIME, "last_block", "The " + UNIX_EPOCH_TIME + " of the last block received from this peer"},

                    {RPCResult::Type::NUM_TIME, "last_block_announcement", "The " + UNIX_EPOCH_TIME + " this peer was first to announce a block"},

                    {RPCResult::Type::NUM, "bytessent", "The total bytes sent"},

                    {RPCResult::Type::NUM, "bytesrecv", "The total bytes received"},

                    {RPCResult::Type::NUM_TIME, "conntime", "The " + UNIX_EPOCH_TIME + " of the connection"},

                    {RPCResult::Type::NUM, "timeoffset", "The time offset in seconds"},

                    {RPCResult::Type::NUM, "pingtime", /*optional=*/true, "The last ping time in seconds, if any"},

                    {RPCResult::Type::NUM, "minping", /*optional=*/true, "The minimum observed ping time in seconds, if any"},

                    {RPCResult::Type::NUM, "pingwait", /*optional=*/true, "The duration in seconds of an outstanding ping (if non-zero)"},

                    {RPCResult::Type::NUM, "version", "The peer version, such as 70001"},

                    {RPCResult::Type::STR, "subver", "The string version"},

                    {RPCResult::Type::BOOL, "inbound", "Inbound (true) or Outbound (false)"},

                    {RPCResult::Type::BOOL, "bip152_hb_to", "Whether we selected peer as (compact blocks) high-bandwidth peer"},

                    {RPCResult::Type::BOOL, "bip152_hb_from", "Whether peer selected us as (compact blocks) high-bandwidth peer"},

                    {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"},

                    {RPCResult::Type::NUM, "synced_headers", "The last header we have in common with this peer"},

                    {RPCResult::Type::NUM, "synced_blocks", "The last block we have in common with this peer"},

                    {RPCResult::Type::ARR, "inflight", "",

                    {

                        {RPCResult::Type::NUM, "n", "The heights of blocks we're currently asking from this peer"},

                    }},

                    {RPCResult::Type::BOOL, "addr_relay_enabled", "Whether we participate in address relay with this peer"},

                    {RPCResult::Type::NUM, "addr_processed", "The total number of addresses processed, excluding those dropped due to rate limiting"},

                    {RPCResult::Type::NUM, "addr_rate_limited", "The total number of addresses dropped due to rate limiting"},

                    {RPCResult::Type::ARR, "permissions", "Any special permissions that have been granted to this peer",

                    {

                        {RPCResult::Type::STR, "permission_type", Join(NET_PERMISSIONS_DOC, ",\n") + ".\n"},

                    }},

                    {RPCResult::Type::STR_AMOUNT, "minfeefilter", "The minimum fee rate for transactions this peer accepts"},

                    {RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "",

                    {

                        {RPCResult::Type::NUM, "msg", "The total bytes sent aggregated by message type\n"

                                                      "When a message type is not listed in this json object, the bytes sent are 0.\n"

                                                      "Only known message types can appear as keys in the object."}

                    }},

                    {RPCResult::Type::OBJ_DYN, "bytesrecv_per_msg", "",

                    {

                        {RPCResult::Type::NUM, "msg", "The total bytes received aggregated by message type\n"

                                                      "When a message type is not listed in this json object, the bytes received are 0.\n"

                                                      "Only known message types can appear as keys in the object and all bytes received\n"

                                                      "of unknown message types are listed under '"+NET_MESSAGE_TYPE_OTHER+"'."}

                    }},

                    {RPCResult::Type::STR, "connection_type", "Type of connection: \n" + Join(CONNECTION_TYPE_DOC, ",\n") + ".\n"

                                                              "Please note this output is unlikely to be stable in upcoming releases as we iterate to\n"

                                                              "best capture connection behaviors."},

                    {RPCResult::Type::STR, "transport_protocol_type", "Type of transport protocol: \n" + Join(TRANSPORT_TYPE_DOC, ",\n") + ".\n"},

                    {RPCResult::Type::STR, "session_id", "The session ID for this connection, or \"\" if there is none (\"v2\" transport protocol only).\n"},

                }},

            }},

        },

        RPCExamples{

            HelpExampleCli("getpeerinfo", "")

            + HelpExampleRpc("getpeerinfo", "")

        },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    const CConnman& connman = EnsureConnman(node);

    const PeerManager& peerman = EnsurePeerman(node);

    std::vector<CNodeStats> vstats;

    connman.GetNodeStats(vstats);

    UniValue ret(UniValue::VARR);

    for (const CNodeStats& stats : vstats) {

        UniValue obj(UniValue::VOBJ);

        CNodeStateStats statestats;

        bool fStateStats = peerman.GetNodeStateStats(stats.nodeid, statestats);

        // GetNodeStateStats() requires the existence of a CNodeState and a Peer object

        // to succeed for this peer. These are created at connection initialisation and

        // exist for the duration of the connection - except if there is a race where the

        // peer got disconnected in between the GetNodeStats() and the GetNodeStateStats()

        // calls. In this case, the peer doesn't need to be reported here.

        if (!fStateStats) {

            continue;

        }

        obj.pushKV("id", stats.nodeid);

        obj.pushKV("addr", stats.m_addr_name);

        if (stats.addrBind.IsValid()) {

            obj.pushKV("addrbind", stats.addrBind.ToStringAddrPort());

        }

        if (!(stats.addrLocal.empty())) {

            obj.pushKV("addrlocal", stats.addrLocal);

        }

        obj.pushKV("network", GetNetworkName(stats.m_network));

        if (stats.m_mapped_as != 0) {

            obj.pushKV("mapped_as", stats.m_mapped_as);

        }

        ServiceFlags services{statestats.their_services};

        obj.pushKV("services", strprintf("%016x", services));

        obj.pushKV("servicesnames", GetServicesNames(services));

        obj.pushKV("relaytxes", statestats.m_relay_txs);

        obj.pushKV("last_inv_sequence", statestats.m_last_inv_seq);

        obj.pushKV("inv_to_send", statestats.m_inv_to_send);

        obj.pushKV("lastsend", TicksSinceEpoch<std::chrono::seconds>(stats.m_last_send));

        obj.pushKV("lastrecv", TicksSinceEpoch<std::chrono::seconds>(stats.m_last_recv));

        obj.pushKV("last_transaction", count_seconds(stats.m_last_tx_time));

        obj.pushKV("last_block", count_seconds(stats.m_last_block_time));

        obj.pushKV("last_block_announcement", TicksSinceEpoch<std::chrono::seconds>(statestats.m_last_block_announcement));

        obj.pushKV("bytessent", stats.nSendBytes);

        obj.pushKV("bytesrecv", stats.nRecvBytes);

        obj.pushKV("conntime", TicksSinceEpoch<std::chrono::seconds>(stats.m_connected));

        obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(statestats.time_offset));

        if (stats.m_last_ping_time > 0us) {

            obj.pushKV("pingtime", Ticks<SecondsDouble>(stats.m_last_ping_time));

        }

        if (stats.m_min_ping_time < decltype(CNode::m_min_ping_time.load())::max()) {

            obj.pushKV("minping", Ticks<SecondsDouble>(stats.m_min_ping_time));

        }

        if (statestats.m_ping_wait > 0s) {

            obj.pushKV("pingwait", Ticks<SecondsDouble>(statestats.m_ping_wait));

        }

        obj.pushKV("version", stats.nVersion);

        // Use the sanitized form of subver here, to avoid tricksy remote peers from

        // corrupting or modifying the JSON output by putting special characters in

        // their ver message.

        obj.pushKV("subver", stats.cleanSubVer);

        obj.pushKV("inbound", stats.fInbound);

        obj.pushKV("bip152_hb_to", stats.m_bip152_highbandwidth_to);

        obj.pushKV("bip152_hb_from", stats.m_bip152_highbandwidth_from);

        obj.pushKV("presynced_headers", statestats.presync_height);

        obj.pushKV("synced_headers", statestats.nSyncHeight);

        obj.pushKV("synced_blocks", statestats.nCommonHeight);

        UniValue heights(UniValue::VARR);

        for (const int height : statestats.vHeightInFlight) {

            heights.push_back(height);

        }

        obj.pushKV("inflight", std::move(heights));

        obj.pushKV("addr_relay_enabled", statestats.m_addr_relay_enabled);

        obj.pushKV("addr_processed", statestats.m_addr_processed);

        obj.pushKV("addr_rate_limited", statestats.m_addr_rate_limited);

        UniValue permissions(UniValue::VARR);

        for (const auto& permission : NetPermissions::ToStrings(stats.m_permission_flags)) {

            permissions.push_back(permission);

        }

        obj.pushKV("permissions", std::move(permissions));

        obj.pushKV("minfeefilter", ValueFromAmount(statestats.m_fee_filter_received));

        UniValue sendPerMsgType(UniValue::VOBJ);

        for (const auto& [message_type, total_bytes] : stats.mapSendBytesPerMsgType) {

            if (total_bytes > 0) {

                sendPerMsgType.pushKVEnd(message_type, total_bytes);

            }

        }

        obj.pushKV("bytessent_per_msg", std::move(sendPerMsgType));

        UniValue recvPerMsgType(UniValue::VOBJ);

        for (const auto& [message_type, total_bytes] : stats.mapRecvBytesPerMsgType) {

            if (total_bytes > 0) {

                recvPerMsgType.pushKVEnd(message_type, total_bytes);

            }

        }

        obj.pushKV("bytesrecv_per_msg", std::move(recvPerMsgType));

        obj.pushKV("connection_type", ConnectionTypeAsString(stats.m_conn_type));

        obj.pushKV("transport_protocol_type", TransportTypeAsString(stats.m_transport_type));

        obj.pushKV("session_id", stats.m_session_id);

        ret.push_back(std::move(obj));

    }

    return ret;

},

    };

}

static RPCMethod addnode()

{

    return RPCMethod{

        "addnode",

        "Attempts to add or remove a node from the addnode list.\n"

                "Or try a connection to a node once.\n"

                "Nodes added using addnode (or -connect) are protected from DoS disconnection and IBD block stalling\n"

                "disconnection, and are not required to be full nodes or support SegWit as other outbound peers are (though\n"

                "such peers will not be synced from).\n" +

                strprintf("Addnode connections are limited to %u at a time", MAX_ADDNODE_CONNECTIONS) +

                " and are counted separately from the -maxconnections limit.\n",

                {

                    {"node", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address/hostname optionally followed by :port of the peer to connect to"},

                    {"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"},

                    {"v2transport", RPCArg::Type::BOOL, RPCArg::DefaultHint{"set by -v2transport"}, "Attempt to connect using BIP324 v2 transport protocol (ignored for 'remove' command)"},

                },

                RPCResult{RPCResult::Type::NONE, "", ""},

                RPCExamples{

                    HelpExampleCli("addnode", "\"192.168.0.6:8333\" \"onetry\" true")

            + HelpExampleRpc("addnode", R"("192.168.0.6:8333", "onetry", true)")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    const auto command{self.Arg<std::string_view>("command")};

    if (command != "onetry" && command != "add" && command != "remove") {

        throw std::runtime_error(

            self.ToString());

    }

    NodeContext& node = EnsureAnyNodeContext(request.context);

    CConnman& connman = EnsureConnman(node);

    const auto node_arg{self.Arg<std::string_view>("node")};

    if (TrimStringView(node_arg).empty()) {

        // Such a node would never resolve, but would be retried indefinitely.

        throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Node address cannot be empty");

    }

    bool node_v2transport = connman.GetLocalServices() & NODE_P2P_V2;

    bool use_v2transport = self.MaybeArg<bool>("v2transport").value_or(node_v2transport);

    if (use_v2transport && !node_v2transport) {

        throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: v2transport requested but not enabled (see -v2transport)");

    }

    if (command == "onetry")

    {

        CAddress addr;

        connman.OpenNetworkConnection(/*addrConnect=*/addr,

                                      /*fCountFailure=*/false,

                                      /*grant_outbound=*/{},

                                      /*pszDest=*/std::string{node_arg}.c_str(),

                                      /*conn_type=*/ConnectionType::MANUAL,

                                      /*use_v2transport=*/use_v2transport,

                                      /*proxy_override=*/std::nullopt);

        return UniValue::VNULL;

    }

    if (command == "add")

    {

        if (!connman.AddNode({std::string{node_arg}, use_v2transport})) {

            throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: Node already added");

        }

    }

    else if (command == "remove")

    {

        if (!connman.RemoveAddedNode(node_arg)) {

            throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node could not be removed. It has not been added previously.");

        }

    }

    return UniValue::VNULL;

},

    };

}

static RPCMethod addconnection()

{

    return RPCMethod{

        "addconnection",

        "Open an outbound connection to a specified node. This RPC is for testing only.\n",

        {

            {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP address and port to attempt connecting to."},

            {"connection_type", RPCArg::Type::STR, RPCArg::Optional::NO, "Type of connection to open (\"outbound-full-relay\", \"block-relay-only\", \"addr-fetch\", \"feeler\" or \"manual\")."},

            {"v2transport", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Attempt to connect using BIP324 v2 transport protocol"},

        },

        RPCResult{

            RPCResult::Type::OBJ, "", "",

            {

                { RPCResult::Type::STR, "address", "Address of newly added connection." },

                { RPCResult::Type::STR, "connection_type", "Type of connection opened." },

            }},

        RPCExamples{

            HelpExampleCli("addconnection", "\"192.168.0.6:8333\" \"outbound-full-relay\" true")

            + HelpExampleRpc("addconnection", R"("192.168.0.6:8333", "outbound-full-relay", true)")

        },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    if (Params().GetChainType() != ChainType::REGTEST) {

        throw std::runtime_error("addconnection is for regression testing (-regtest mode) only.");

    }

    const std::string address = request.params[0].get_str();

    auto conn_type_in{util::TrimStringView(self.Arg<std::string_view>("connection_type"))};

    ConnectionType conn_type{};

    if (conn_type_in == "outbound-full-relay") {

        conn_type = ConnectionType::OUTBOUND_FULL_RELAY;

    } else if (conn_type_in == "block-relay-only") {

        conn_type = ConnectionType::BLOCK_RELAY;

    } else if (conn_type_in == "addr-fetch") {

        conn_type = ConnectionType::ADDR_FETCH;

    } else if (conn_type_in == "feeler") {

        conn_type = ConnectionType::FEELER;

    } else if (conn_type_in == "manual") {

        conn_type = ConnectionType::MANUAL;

    } else {

        throw JSONRPCError(RPC_INVALID_PARAMETER, self.ToString());

    }

    bool use_v2transport{self.Arg<bool>("v2transport")};

    NodeContext& node = EnsureAnyNodeContext(request.context);

    CConnman& connman = EnsureConnman(node);

    if (use_v2transport && !(connman.GetLocalServices() & NODE_P2P_V2)) {

        throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Adding v2transport connections requires -v2transport init flag to be set.");

    }

    const bool success = connman.AddConnection(address, conn_type, use_v2transport);

    if (!success) {

        throw JSONRPCError(RPC_CLIENT_NODE_CAPACITY_REACHED, "Error: Already at capacity for specified connection type.");

    }

    UniValue info(UniValue::VOBJ);

    info.pushKV("address", address);

    info.pushKV("connection_type", conn_type_in);

    return info;

},

    };

}

static RPCMethod disconnectnode()

{

    return RPCMethod{

        "disconnectnode",

        "Immediately disconnects from the specified peer node.\n"

                "\nStrictly one out of 'address' and 'nodeid' can be provided to identify the node.\n"

                "\nTo disconnect by nodeid, either set 'address' to the empty string, or call using the named 'nodeid' argument only.\n",

                {

                    {"address", RPCArg::Type::STR, RPCArg::DefaultHint{"fallback to nodeid"}, "The IP address/port of the node"},

                    {"nodeid", RPCArg::Type::NUM, RPCArg::DefaultHint{"fallback to address"}, "The node ID (see getpeerinfo for node IDs)"},

                },

                RPCResult{RPCResult::Type::NONE, "", ""},

                RPCExamples{

                    HelpExampleCli("disconnectnode", "\"192.168.0.6:8333\"")

            + HelpExampleCli("disconnectnode", "\"\" 1")

            + HelpExampleRpc("disconnectnode", "\"192.168.0.6:8333\"")

            + HelpExampleRpc("disconnectnode", "\"\", 1")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    CConnman& connman = EnsureConnman(node);

    bool success;

    auto address{self.MaybeArg<std::string_view>("address")};

    auto node_id{self.MaybeArg<int64_t>("nodeid")};

    if (address && !node_id) {

        /* handle disconnect-by-address */

        success = connman.DisconnectNode(*address);

    } else if (node_id && (!address || address->empty())) {

        /* handle disconnect-by-id */

        success = connman.DisconnectNode(*node_id);

    } else {

        throw JSONRPCError(RPC_INVALID_PARAMS, "Only one of address and nodeid should be provided.");

    }

    if (!success) {

        throw JSONRPCError(RPC_CLIENT_NODE_NOT_CONNECTED, "Node not found in connected nodes");

    }

    return UniValue::VNULL;

},

    };

}

static RPCMethod getaddednodeinfo()

{

    return RPCMethod{

        "getaddednodeinfo",

        "Returns information about the given added node, or all added nodes\n"

                "(note that onetry addnodes are not listed here)\n",

                {

                    {"node", RPCArg::Type::STR, RPCArg::DefaultHint{"all nodes"}, "If provided, return information about this specific node, otherwise all nodes are returned."},

                },

                RPCResult{

                    RPCResult::Type::ARR, "", "",

                    {

                        {RPCResult::Type::OBJ, "", "",

                        {

                            {RPCResult::Type::STR, "addednode", "The node IP address or name (as provided to addnode)"},

                            {RPCResult::Type::BOOL, "connected", "If connected"},

                            {RPCResult::Type::ARR, "addresses", "Only when connected = true",

                            {

                                {RPCResult::Type::OBJ, "", "",

                                {

                                    {RPCResult::Type::STR, "address", "The bitcoin server IP and port we're connected to"},

                                    {RPCResult::Type::STR, "connected", "connection, inbound or outbound"},

                                }},

                            }},

                        }},

                    }

                },

                RPCExamples{

                    HelpExampleCli("getaddednodeinfo", "\"192.168.0.201\"")

            + HelpExampleRpc("getaddednodeinfo", "\"192.168.0.201\"")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    const CConnman& connman = EnsureConnman(node);

    std::vector<AddedNodeInfo> vInfo = connman.GetAddedNodeInfo(/*include_connected=*/true);

    if (auto node{self.MaybeArg<std::string_view>("node")}) {

        bool found = false;

        for (const AddedNodeInfo& info : vInfo) {

            if (info.m_params.m_added_node == *node) {

                vInfo.assign(1, info);

                found = true;

                break;

            }

        }

        if (!found) {

            throw JSONRPCError(RPC_CLIENT_NODE_NOT_ADDED, "Error: Node has not been added.");

        }

    }

    UniValue ret(UniValue::VARR);

    for (const AddedNodeInfo& info : vInfo) {

        UniValue obj(UniValue::VOBJ);

        obj.pushKV("addednode", info.m_params.m_added_node);

        obj.pushKV("connected", info.fConnected);

        UniValue addresses(UniValue::VARR);

        if (info.fConnected) {

            UniValue address(UniValue::VOBJ);

            address.pushKV("address", info.resolvedAddress.ToStringAddrPort());

            address.pushKV("connected", info.fInbound ? "inbound" : "outbound");

            addresses.push_back(std::move(address));

        }

        obj.pushKV("addresses", std::move(addresses));

        ret.push_back(std::move(obj));

    }

    return ret;

},

    };

}

static RPCMethod getnettotals()

{

    return RPCMethod{"getnettotals",

        "Returns information about network traffic, including bytes in, bytes out,\n"

        "and current system time.",

        {},

                RPCResult{

                   RPCResult::Type::OBJ, "", "",

                   {

                       {RPCResult::Type::NUM, "totalbytesrecv", "Total bytes received"},

                       {RPCResult::Type::NUM, "totalbytessent", "Total bytes sent"},

                       {RPCResult::Type::NUM_TIME, "timemillis", "Current system " + UNIX_EPOCH_TIME + " in milliseconds"},

                       {RPCResult::Type::OBJ, "uploadtarget", "",

                       {

                           {RPCResult::Type::NUM, "timeframe", "Length of the measuring timeframe in seconds"},

                           {RPCResult::Type::NUM, "target", "Target in bytes"},

                           {RPCResult::Type::BOOL, "target_reached", "True if target is reached"},

                           {RPCResult::Type::BOOL, "serve_historical_blocks", "True if serving historical blocks"},

                           {RPCResult::Type::NUM, "bytes_left_in_cycle", "Bytes left in current time cycle"},

                           {RPCResult::Type::NUM, "time_left_in_cycle", "Seconds left in current time cycle"},

                        }},

                    }

                },

                RPCExamples{

                    HelpExampleCli("getnettotals", "")

            + HelpExampleRpc("getnettotals", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    const CConnman& connman = EnsureConnman(node);

    UniValue obj(UniValue::VOBJ);

    obj.pushKV("totalbytesrecv", connman.GetTotalBytesRecv());

    obj.pushKV("totalbytessent", connman.GetTotalBytesSent());

    obj.pushKV("timemillis", TicksSinceEpoch<std::chrono::milliseconds>(SystemClock::now()));

    UniValue outboundLimit(UniValue::VOBJ);

    outboundLimit.pushKV("timeframe", count_seconds(connman.GetMaxOutboundTimeframe()));

    outboundLimit.pushKV("target", connman.GetMaxOutboundTarget());

    outboundLimit.pushKV("target_reached", connman.OutboundTargetReached(false));

    outboundLimit.pushKV("serve_historical_blocks", !connman.OutboundTargetReached(true));

    outboundLimit.pushKV("bytes_left_in_cycle", connman.GetOutboundTargetBytesLeft());

    outboundLimit.pushKV("time_left_in_cycle", count_seconds(connman.GetMaxOutboundTimeLeftInCycle()));

    obj.pushKV("uploadtarget", std::move(outboundLimit));

    return obj;

},

    };

}

static UniValue GetNetworksInfo()

{

    UniValue networks(UniValue::VARR);

    for (int n = 0; n < NET_MAX; ++n) {

        enum Network network = static_cast<enum Network>(n);

        if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;

        UniValue obj(UniValue::VOBJ);

        obj.pushKV("name", GetNetworkName(network));

        obj.pushKV("limited", !g_reachable_nets.Contains(network));

        obj.pushKV("reachable", g_reachable_nets.Contains(network));

        if (const auto proxy = GetProxy(network)) {

            obj.pushKV("proxy", proxy->ToString());

            obj.pushKV("proxy_randomize_credentials", proxy->m_tor_stream_isolation);

        } else {

            obj.pushKV("proxy", std::string());

            obj.pushKV("proxy_randomize_credentials", false);

        }

        networks.push_back(std::move(obj));

    }

    return networks;

}

static RPCMethod getnetworkinfo()

{

    return RPCMethod{"getnetworkinfo",

                "Returns an object containing various state info regarding P2P networking.\n",

                {},

                RPCResult{

                    RPCResult::Type::OBJ, "", "",

                    {

                        {RPCResult::Type::NUM, "version", "the server version"},

                        {RPCResult::Type::STR, "subversion", "the server subversion string"},

                        {RPCResult::Type::NUM, "protocolversion", "the protocol version"},

                        {RPCResult::Type::STR_HEX, "localservices", "the services we offer to the network"},

                        {RPCResult::Type::ARR, "localservicesnames", "the services we offer to the network, in human-readable form",

                        {

                            {RPCResult::Type::STR, "SERVICE_NAME", "the service name"},

                        }},

                        {RPCResult::Type::BOOL, "localrelay", "true if transaction relay is requested from peers"},

                        {RPCResult::Type::NUM, "timeoffset", "the time offset"},

                        {RPCResult::Type::NUM, "tx_send_rate", "configured target for maximum number of transactions per second to send to inbound peers"},

                        {RPCResult::Type::OBJ_DYN, "inv_buckets", "", {

                          {RPCResult::Type::OBJ, "inbound/outbound", "connection direction",

                            {

                                {RPCResult::Type::NUM, "backlog", "number of queued txs to announce"},

                                {RPCResult::Type::NUM, "count_tok", "tokens available to be consumed per-transaction"},

                                {RPCResult::Type::NUM, "size_tok", "tokens available to be consumed per-byte"},

                            }

                          }

                        }},

                        {RPCResult::Type::NUM, "connections", "the total number of connections"},

                        {RPCResult::Type::NUM, "connections_in", "the number of inbound connections"},

                        {RPCResult::Type::NUM, "connections_out", "the number of outbound connections"},

                        {RPCResult::Type::BOOL, "networkactive", "whether p2p networking is enabled"},

                        {RPCResult::Type::ARR, "networks", "information per network",

                        {

                            {RPCResult::Type::OBJ, "", "",

                            {

                                {RPCResult::Type::STR, "name", "network (" + Join(GetNetworkNames(), ", ") + ")"},

                                {RPCResult::Type::BOOL, "limited", "is the network limited using -onlynet?"},

                                {RPCResult::Type::BOOL, "reachable", "is the network reachable?"},

                                {RPCResult::Type::STR, "proxy", "(\"host:port\") the proxy that is used for this network, or empty if none"},

                                {RPCResult::Type::BOOL, "proxy_randomize_credentials", "Whether randomized credentials are used"},

                            }},

                        }},

                        {RPCResult::Type::STR_HEX, "asmap_version", /*optional=*/true, "the SHA256 hash of the asmap data used for IP bucketing (only displayed if the -asmap config option is set)"},

                        {RPCResult::Type::STR_AMOUNT, "relayfee", "minimum relay fee rate for transactions in " + CURRENCY_UNIT + "/kvB"},

                        {RPCResult::Type::STR_AMOUNT, "incrementalfee", "minimum fee rate increment for mempool limiting or replacement in " + CURRENCY_UNIT + "/kvB"},

                        {RPCResult::Type::ARR, "localaddresses", "list of local addresses",

                        {

                            {RPCResult::Type::OBJ, "", "",

                            {

                                {RPCResult::Type::STR, "address", "network address"},

                                {RPCResult::Type::NUM, "port", "network port"},

                                {RPCResult::Type::NUM, "score", "relative score"},

                            }},

                        }},

                        (IsDeprecatedRPCEnabled("warnings") ?

                            RPCResult{RPCResult::Type::STR, "warnings", "any network and blockchain warnings (DEPRECATED)"} :

                            RPCResult{RPCResult::Type::ARR, "warnings", "any network and blockchain warnings (run with `-deprecatedrpc=warnings` to return the latest warning as a single string)",

                            {

                                {RPCResult::Type::STR, "", "warning"},

                            }

                            }

                        ),

                    }

                },

                RPCExamples{

                    HelpExampleCli("getnetworkinfo", "")

            + HelpExampleRpc("getnetworkinfo", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    LOCK(cs_main);

    UniValue obj(UniValue::VOBJ);

    obj.pushKV("version",       CLIENT_VERSION);

    obj.pushKV("subversion",    strSubVersion);

    obj.pushKV("protocolversion",PROTOCOL_VERSION);

    NodeContext& node = EnsureAnyNodeContext(request.context);

    CConnman& connman = EnsureConnman(node);

    ServiceFlags services = connman.GetLocalServices();

    obj.pushKV("localservices", strprintf("%016x", services));

    obj.pushKV("localservicesnames", GetServicesNames(services));

    auto peerman_info{EnsurePeerman(node).GetInfo()};

    obj.pushKV("localrelay", !peerman_info.ignores_incoming_txs);

    obj.pushKV("timeoffset", Ticks<std::chrono::seconds>(peerman_info.median_outbound_time_offset));

    obj.pushKV("tx_send_rate", peerman_info.tx_send_rate);

    auto buckjson = [&](const auto& buckinfo) {

        UniValue b{UniValue::VOBJ};

        b.pushKV("backlog", buckinfo.backlog_count);

        b.pushKV("count_tok", buckinfo.count_bucket);

        b.pushKV("size_tok", buckinfo.size_bucket);

        return b;

    };

    UniValue invbuckets{UniValue::VOBJ};

    invbuckets.pushKV("inbound", buckjson(peerman_info.inbound_bucket));

    invbuckets.pushKV("outbound", buckjson(peerman_info.outbound_bucket));

    obj.pushKV("inv_buckets", invbuckets);

    obj.pushKV("networkactive", connman.GetNetworkActive());

    obj.pushKV("connections", connman.GetNodeCount(ConnectionDirection::Both));

    obj.pushKV("connections_in", connman.GetNodeCount(ConnectionDirection::In));

    obj.pushKV("connections_out", connman.GetNodeCount(ConnectionDirection::Out));

    obj.pushKV("networks",      GetNetworksInfo());

    const NetGroupManager& netgroupman{*CHECK_NONFATAL(node.netgroupman)};

    if (netgroupman.UsingASMap()) {

        obj.pushKV("asmap_version", HexStr(netgroupman.GetAsmapVersion()));

    }

    const CTxMemPool& mempool = EnsureAnyMemPool(request.context);

    // Those fields can be deprecated, to be replaced by the getmempoolinfo fields

    obj.pushKV("relayfee", ValueFromAmount(mempool.m_opts.min_relay_feerate.GetFeePerK()));

    obj.pushKV("incrementalfee", ValueFromAmount(mempool.m_opts.incremental_relay_feerate.GetFeePerK()));

    UniValue localAddresses(UniValue::VARR);

    {

        LOCK(g_maplocalhost_mutex);

        for (const std::pair<const CNetAddr, LocalServiceInfo> &item : mapLocalHost)

        {

            UniValue rec(UniValue::VOBJ);

            rec.pushKV("address", item.first.ToStringAddr());

            rec.pushKV("port", item.second.nPort);

            rec.pushKV("score", item.second.nScore);

            localAddresses.push_back(std::move(rec));

        }

    }

    obj.pushKV("localaddresses", std::move(localAddresses));

    obj.pushKV("warnings", node::GetWarningsForRpc(*CHECK_NONFATAL(node.warnings), IsDeprecatedRPCEnabled("warnings")));

    return obj;

},

    };

}

static RPCMethod setban()

{

    return RPCMethod{

        "setban",

        "Attempts to add or remove an IP/Subnet from the banned list.\n",

                {

                    {"subnet", RPCArg::Type::STR, RPCArg::Optional::NO, "The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)"},

                    {"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"},

                    {"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)"},

                    {"absolute", RPCArg::Type::BOOL, RPCArg::Default{false}, "If set, the bantime must be an absolute timestamp expressed in " + UNIX_EPOCH_TIME},

                },

                RPCResult{RPCResult::Type::NONE, "", ""},

                RPCExamples{

                    HelpExampleCli("setban", "\"192.168.0.6\" \"add\" 86400")

                            + HelpExampleCli("setban", "\"192.168.0.0/24\" \"add\"")

                            + HelpExampleRpc("setban", "\"192.168.0.6\", \"add\", 86400")

                },

        [](const RPCMethod& help, const JSONRPCRequest& request) -> UniValue

{

    auto command{help.Arg<std::string_view>("command")};

    if (command != "add" && command != "remove") {

        throw std::runtime_error(help.ToString());

    }

    NodeContext& node = EnsureAnyNodeContext(request.context);

    BanMan& banman = EnsureBanman(node);

    CSubNet subNet;

    CNetAddr netAddr;

    std::string subnet_arg{help.Arg<std::string_view>("subnet")};

    const bool isSubnet{subnet_arg.find('/') != subnet_arg.npos};

    if (!isSubnet) {

        const std::optional<CNetAddr> addr{LookupHost(subnet_arg, false)};

        if (addr.has_value()) {

            netAddr = static_cast<CNetAddr>(MaybeFlipIPv6toCJDNS(CService{addr.value(), /*port=*/0}));

        }

    } else {

        subNet = LookupSubNet(subnet_arg);

    }

    if (! (isSubnet ? subNet.IsValid() : netAddr.IsValid()) ) {

        throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Invalid IP/Subnet");

    }

    if (command == "add") {

        if (isSubnet ? banman.IsBanned(subNet) : banman.IsBanned(netAddr)) {

            throw JSONRPCError(RPC_CLIENT_NODE_ALREADY_ADDED, "Error: IP/Subnet already banned");

        }

        int64_t banTime = 0; //use standard bantime if not specified

        if (!request.params[2].isNull())

            banTime = request.params[2].getInt<int64_t>();

        const bool absolute{request.params[3].isNull() ? false : request.params[3].get_bool()};

        if (absolute && banTime < GetTime()) {

            throw JSONRPCError(RPC_INVALID_PARAMETER, "Error: Absolute timestamp is in the past");

        }

        if (isSubnet) {

            banman.Ban(subNet, banTime, absolute);

            if (node.connman) {

                node.connman->DisconnectNode(subNet);

            }

        } else {

            banman.Ban(netAddr, banTime, absolute);

            if (node.connman) {

                node.connman->DisconnectNode(netAddr);

            }

        }

    } else if(command == "remove") {

        if (!( isSubnet ? banman.Unban(subNet) : banman.Unban(netAddr) )) {

            throw JSONRPCError(RPC_CLIENT_INVALID_IP_OR_SUBNET, "Error: Unban failed. Requested address/subnet was not previously manually banned.");

        }

    }

    return UniValue::VNULL;

},

    };

}

static RPCMethod listbanned()

{

    return RPCMethod{

        "listbanned",

        "List all manually banned IPs/Subnets.\n",

                {},

        RPCResult{RPCResult::Type::ARR, "", "",

            {

                {RPCResult::Type::OBJ, "", "",

                    {

                        {RPCResult::Type::STR, "address", "The IP/Subnet of the banned node"},

                        {RPCResult::Type::NUM_TIME, "ban_created", "The " + UNIX_EPOCH_TIME + " the ban was created"},

                        {RPCResult::Type::NUM_TIME, "banned_until", "The " + UNIX_EPOCH_TIME + " the ban expires"},

                        {RPCResult::Type::NUM_TIME, "ban_duration", "The ban duration, in seconds"},

                        {RPCResult::Type::NUM_TIME, "time_remaining", "The time remaining until the ban expires, in seconds"},

                    }},

            }},

                RPCExamples{

                    HelpExampleCli("listbanned", "")

                            + HelpExampleRpc("listbanned", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    BanMan& banman = EnsureAnyBanman(request.context);

    banmap_t banMap;

    banman.GetBanned(banMap);

    const int64_t current_time{GetTime()};

    UniValue bannedAddresses(UniValue::VARR);

    for (const auto& entry : banMap)

    {

        const CBanEntry& banEntry = entry.second;

        UniValue rec(UniValue::VOBJ);

        rec.pushKV("address", entry.first.ToString());

        rec.pushKV("ban_created", banEntry.nCreateTime);

        rec.pushKV("banned_until", banEntry.nBanUntil);

        rec.pushKV("ban_duration", (banEntry.nBanUntil - banEntry.nCreateTime));

        rec.pushKV("time_remaining", (banEntry.nBanUntil - current_time));

        bannedAddresses.push_back(std::move(rec));

    }

    return bannedAddresses;

},

    };

}

static RPCMethod clearbanned()

{

    return RPCMethod{

        "clearbanned",

        "Clear all banned IPs.\n",

                {},

                RPCResult{RPCResult::Type::NONE, "", ""},

                RPCExamples{

                    HelpExampleCli("clearbanned", "")

                            + HelpExampleRpc("clearbanned", "")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    BanMan& banman = EnsureAnyBanman(request.context);

    banman.ClearBanned();

    return UniValue::VNULL;

},

    };

}

static RPCMethod setnetworkactive()

{

    return RPCMethod{

        "setnetworkactive",

        "Disable/enable all p2p network activity.\n",

                {

                    {"state", RPCArg::Type::BOOL, RPCArg::Optional::NO, "true to enable networking, false to disable"},

                },

                RPCResult{RPCResult::Type::BOOL, "", "The value that was passed in"},

                RPCExamples{""},

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    CConnman& connman = EnsureConnman(node);

    connman.SetNetworkActive(request.params[0].get_bool());

    return connman.GetNetworkActive();

},

    };

}

static RPCMethod getnodeaddresses()

{

    return RPCMethod{"getnodeaddresses",

                "Return known addresses, after filtering for quality and recency.\n"

                "These can potentially be used to find new peers in the network.\n"

                "The total number of addresses known to the node may be higher.",

                {

                    {"count", RPCArg::Type::NUM, RPCArg::Default{1}, "The maximum number of addresses to return. Specify 0 to return all known addresses."},

                    {"network", RPCArg::Type::STR, RPCArg::DefaultHint{"all networks"}, "Return only addresses of the specified network. Can be one of: " + Join(GetNetworkNames(), ", ") + "."},

                },

                RPCResult{

                    RPCResult::Type::ARR, "", "",

                    {

                        {RPCResult::Type::OBJ, "", "",

                        {

                            {RPCResult::Type::NUM_TIME, "time", "The " + UNIX_EPOCH_TIME + " when the node was last seen"},

                            {RPCResult::Type::NUM, "services", "The services offered by the node"},

                            {RPCResult::Type::STR, "address", "The address of the node"},

                            {RPCResult::Type::NUM, "port", "The port number of the node"},

                            {RPCResult::Type::STR, "network", "The network (" + Join(GetNetworkNames(), ", ") + ") the node connected through"},

                        }},

                    }

                },

                RPCExamples{

                    HelpExampleCli("getnodeaddresses", "8")

                    + HelpExampleCli("getnodeaddresses", "4 \"i2p\"")

                    + HelpExampleCli("-named getnodeaddresses", "network=onion count=12")

                    + HelpExampleRpc("getnodeaddresses", "8")

                    + HelpExampleRpc("getnodeaddresses", "4, \"i2p\"")

                },

        [](const RPCMethod& self, const JSONRPCRequest& request) -> UniValue

{

    NodeContext& node = EnsureAnyNodeContext(request.context);

    const CConnman& connman = EnsureConnman(node);

    const int count{request.params[0].isNull() ? 1 : request.params[0].getInt<int>()};

    if (count < 0) throw JSONRPCError(RPC_INVALID_PARAMETER, "Address count out of range");

    const std::optional<Network> network{request.params[1].isNull() ? std::nullopt : std::optional<Network>{ParseNetwork(request.params[1].get_str())}};

    if (network == NET_UNROUTABLE) {

        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Network not recognized: %s", request.params[1].get_str()));