node.h

Go to the documentation of this file.

// Copyright (c) 2018 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_INTERFACES_NODE_H
#define BITCOIN_INTERFACES_NODE_H

#include <amount.h>     // For Amount
#include <net.h>        // For CConnman::NumConnections
#include <net_types.h>  // For banmap_t
#include <netaddress.h> // For Network

#include <support/allocators/secure.h> // For SecureString

#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <tuple>
#include <vector>

class BanMan;
class CCoinControl;
class CFeeRate;
struct CNodeStateStats;
struct CNodeStats;
class Coin;
class Config;
class HTTPRPCRequestProcessor;
struct NodeContext;
class proxyType;
class RPCServer;
class RPCTimerInterface;
enum class SynchronizationState;
class UniValue;
enum class WalletCreationStatus;
struct bilingual_str;

namespace interfaces {
class Handler;
class Wallet;

class Node {
public:
    virtual ~Node() {}

    virtual void initLogging() = 0;

    virtual void initParameterInteraction() = 0;

    virtual std::string getWarnings() = 0;

    virtual bool baseInitialize(Config &config) = 0;

    virtual bool
    appInitMain(Config &config, RPCServer &rpcServer,
                HTTPRPCRequestProcessor &httpRPCRequestProcessor) = 0;

    virtual void appShutdown() = 0;

    virtual void startShutdown() = 0;

    virtual bool shutdownRequested() = 0;

    virtual void mapPort(bool use_upnp) = 0;

    virtual bool getProxy(Network net, proxyType &proxy_info) = 0;

    virtual size_t getNodeCount(CConnman::NumConnections flags) = 0;

    using NodesStats =
        std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
    virtual bool getNodesStats(NodesStats &stats) = 0;

    virtual bool getBanned(banmap_t &banmap) = 0;

    virtual bool ban(const CNetAddr &net_addr, int64_t ban_time_offset) = 0;

    virtual bool unban(const CSubNet &ip) = 0;

    virtual bool disconnectByAddress(const CNetAddr &net_addr) = 0;

    virtual bool disconnectById(NodeId id) = 0;

    virtual int64_t getTotalBytesRecv() = 0;

    virtual int64_t getTotalBytesSent() = 0;

    virtual size_t getMempoolSize() = 0;

    virtual size_t getMempoolDynamicUsage() = 0;

    virtual bool getHeaderTip(int &height, int64_t &block_time) = 0;

    virtual int getNumBlocks() = 0;

    virtual int64_t getLastBlockTime() = 0;

    virtual double getVerificationProgress() = 0;

    virtual bool isInitialBlockDownload() = 0;

    virtual bool getReindex() = 0;

    virtual bool getImporting() = 0;

    virtual void setNetworkActive(bool active) = 0;

    virtual bool getNetworkActive() = 0;

    virtual CFeeRate estimateSmartFee() = 0;

    virtual CFeeRate getDustRelayFee() = 0;

    virtual UniValue executeRpc(Config &config, const std::string &command,
                                const UniValue &params,
                                const std::string &uri) = 0;

    virtual std::vector<std::string> listRpcCommands() = 0;

    virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface *iface) = 0;

    virtual void rpcUnsetTimerInterface(RPCTimerInterface *iface) = 0;

    virtual bool getUnspentOutput(const COutPoint &output, Coin &coin) = 0;

    virtual std::string getWalletDir() = 0;

    virtual std::vector<std::string> listWalletDir() = 0;

    virtual std::vector<std::unique_ptr<Wallet>> getWallets() = 0;

    virtual std::unique_ptr<Wallet>
    loadWallet(const CChainParams &params, const std::string &name,
               bilingual_str &error,
               std::vector<bilingual_str> &warnings) const = 0;

    virtual std::unique_ptr<Wallet>
    createWallet(const CChainParams &params, const SecureString &passphrase,
                 uint64_t wallet_creation_flags, const std::string &name,
                 bilingual_str &error, std::vector<bilingual_str> &warnings,
                 WalletCreationStatus &status) = 0;

    using InitMessageFn = std::function<void(const std::string &message)>;
    virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;

    using MessageBoxFn =
        std::function<bool(const bilingual_str &message,
                           const std::string &caption, unsigned int style)>;
    virtual std::unique_ptr<Handler> handleMessageBox(MessageBoxFn fn) = 0;

    using QuestionFn =
        std::function<bool(const bilingual_str &message,
                           const std::string &non_interactive_message,
                           const std::string &caption, unsigned int style)>;
    virtual std::unique_ptr<Handler> handleQuestion(QuestionFn fn) = 0;

    using ShowProgressFn = std::function<void(
        const std::string &title, int progress, bool resume_possible)>;
    virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;

    using LoadWalletFn = std::function<void(std::unique_ptr<Wallet> wallet)>;
    virtual std::unique_ptr<Handler> handleLoadWallet(LoadWalletFn fn) = 0;

    using NotifyNumConnectionsChangedFn =
        std::function<void(int new_num_connections)>;
    virtual std::unique_ptr<Handler>
    handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;

    using NotifyNetworkActiveChangedFn =
        std::function<void(bool network_active)>;
    virtual std::unique_ptr<Handler>
    handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;

    using NotifyAlertChangedFn = std::function<void()>;
    virtual std::unique_ptr<Handler>
    handleNotifyAlertChanged(NotifyAlertChangedFn fn) = 0;

    using BannedListChangedFn = std::function<void()>;
    virtual std::unique_ptr<Handler>
    handleBannedListChanged(BannedListChangedFn fn) = 0;

    using NotifyBlockTipFn =
        std::function<void(SynchronizationState, int height, int64_t block_time,
                           double verification_progress)>;
    virtual std::unique_ptr<Handler>
    handleNotifyBlockTip(NotifyBlockTipFn fn) = 0;

    using NotifyHeaderTipFn =
        std::function<void(SynchronizationState, int height, int64_t block_time,
                           double verification_progress)>;
    virtual std::unique_ptr<Handler>
    handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0;

    virtual NodeContext *context() { return nullptr; }
    virtual void setContext(NodeContext *context) {}
};

std::unique_ptr<Node> MakeNode(NodeContext *context = nullptr);

} // namespace interfaces

#endif // BITCOIN_INTERFACES_NODE_H