// Copyright (c) 2018-2022 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 <common/settings.h>

#include <consensus/amount.h>          // For CAmount

#include <logging.h>                   // For BCLog::CategoryMask

#include <net.h>                       // For NodeId

#include <net_types.h>                 // For banmap_t

#include <netaddress.h>                // For Network

#include <netbase.h>                   // For ConnectionDirection

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

#include <util/translation.h>

#include <functional>

#include <memory>

#include <stddef.h>

#include <stdint.h>

#include <string>

#include <tuple>

#include <vector>

class BanMan;

class CFeeRate;

class CNodeStats;

class Coin;

class RPCTimerInterface;

class UniValue;

class Proxy;

enum class SynchronizationState;

struct CNodeStateStats;

struct bilingual_str;

namespace node {

enum class TransactionError;

struct NodeContext;

} // namespace node

namespace wallet {

class CCoinControl;

} // namespace wallet

namespace interfaces {

class Handler;

class WalletLoader;

struct BlockTip;

//! Block and header tip information

struct BlockAndHeaderTipInfo

{

    int block_height;

    int64_t block_time;

    int header_height;

    int64_t header_time;

    double verification_progress;

};

//! External signer interface used by the GUI.

class ExternalSigner

{

public:

    virtual ~ExternalSigner() = default;

    //! Get signer display name

    virtual std::string getName() = 0;

};

//! Top-level interface for a bitcoin node (bitcoind process).

class Node

{

public:

    virtual ~Node() = default;

    //! Init logging.

    virtual void initLogging() = 0;

    //! Init parameter interaction.

    virtual void initParameterInteraction() = 0;

    //! Get warnings.

    virtual bilingual_str getWarnings() = 0;

    //! Get exit status.

    virtual int getExitStatus() = 0;

    // Get log flags.

    virtual BCLog::CategoryMask getLogCategories() = 0;

    //! Initialize app dependencies.

    virtual bool baseInitialize() = 0;

    //! Start node.

    virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo* tip_info = nullptr) = 0;

    //! Stop node.

    virtual void appShutdown() = 0;

    //! Start shutdown.

    virtual void startShutdown() = 0;

    //! Return whether shutdown was requested.

    virtual bool shutdownRequested() = 0;

    //! Return whether a particular setting in <datadir>/settings.json is or

    //! would be ignored because it is also specified in the command line.

    virtual bool isSettingIgnored(const std::string& name) = 0;

    //! Return setting value from <datadir>/settings.json or bitcoin.conf.

    virtual common::SettingsValue getPersistentSetting(const std::string& name) = 0;

    //! Update a setting in <datadir>/settings.json.

    virtual void updateRwSetting(const std::string& name, const common::SettingsValue& value) = 0;

    //! Force a setting value to be applied, overriding any other configuration

    //! source, but not being persisted.

    virtual void forceSetting(const std::string& name, const common::SettingsValue& value) = 0;

    //! Clear all settings in <datadir>/settings.json and store a backup of

    //! previous settings in <datadir>/settings.json.bak.

    virtual void resetSettings() = 0;

    //! Map port.

    virtual void mapPort(bool use_pcp) = 0;

    //! Get proxy.

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

    //! Get number of connections.

    virtual size_t getNodeCount(ConnectionDirection flags) = 0;

    //! Get stats for connected nodes.

    using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;

    virtual bool getNodesStats(NodesStats& stats) = 0;

    //! Get ban map entries.

    virtual bool getBanned(banmap_t& banmap) = 0;

    //! Ban node.

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

    //! Unban node.

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

    //! Disconnect node by address.

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

    //! Disconnect node by id.

    virtual bool disconnectById(NodeId id) = 0;

    //! Return list of external signers (attached devices which can sign transactions).

    virtual std::vector<std::unique_ptr<ExternalSigner>> listExternalSigners() = 0;

    //! Get total bytes recv.

    virtual int64_t getTotalBytesRecv() = 0;

    //! Get total bytes sent.

    virtual int64_t getTotalBytesSent() = 0;

    //! Get mempool size.

    virtual size_t getMempoolSize() = 0;

    //! Get mempool dynamic usage.

    virtual size_t getMempoolDynamicUsage() = 0;

    //! Get mempool maximum memory usage.

    virtual size_t getMempoolMaxUsage() = 0;

    //! Get header tip height and time.

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

    //! Get num blocks.

    virtual int getNumBlocks() = 0;

    //! Get network local addresses.

    virtual std::map<CNetAddr, LocalServiceInfo> getNetLocalAddresses() = 0;

    //! Get best block hash.

    virtual uint256 getBestBlockHash() = 0;

    //! Get last block time.

    virtual int64_t getLastBlockTime() = 0;

    //! Get verification progress.

    virtual double getVerificationProgress() = 0;

    //! Is initial block download.

    virtual bool isInitialBlockDownload() = 0;

    //! Is loading blocks.

    virtual bool isLoadingBlocks() = 0;

    //! Set network active.

    virtual void setNetworkActive(bool active) = 0;

    //! Get network active.

    virtual bool getNetworkActive() = 0;

    //! Get dust relay fee.

    virtual CFeeRate getDustRelayFee() = 0;

    //! Execute rpc command.

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

    //! List rpc commands.

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

    //! Set RPC timer interface if unset.

    virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface* iface) = 0;

    //! Unset RPC timer interface.

    virtual void rpcUnsetTimerInterface(RPCTimerInterface* iface) = 0;

    //! Get unspent output associated with a transaction.

    virtual std::optional<Coin> getUnspentOutput(const COutPoint& output) = 0;

    //! Broadcast transaction.

    virtual node::TransactionError broadcastTransaction(CTransactionRef tx, CAmount max_tx_fee, std::string& err_string) = 0;

    //! Get wallet loader.

    virtual WalletLoader& walletLoader() = 0;

    //! Register handler for init messages.

    using InitMessageFn = std::function<void(const std::string& message)>;

    virtual std::unique_ptr<Handler> handleInitMessage(InitMessageFn fn) = 0;

    //! Register handler for message box messages.

    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;

    //! Register handler for question messages.

    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;

    //! Register handler for progress messages.

    using ShowProgressFn = std::function<void(const std::string& title, int progress, bool resume_possible)>;

    virtual std::unique_ptr<Handler> handleShowProgress(ShowProgressFn fn) = 0;

    //! Register handler for wallet loader constructed messages.

    using InitWalletFn = std::function<void()>;

    virtual std::unique_ptr<Handler> handleInitWallet(InitWalletFn fn) = 0;

    //! Register handler for number of connections changed messages.

    using NotifyNumConnectionsChangedFn = std::function<void(int new_num_connections)>;

    virtual std::unique_ptr<Handler> handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn) = 0;

    //! Register handler for network active messages.

    using NotifyNetworkActiveChangedFn = std::function<void(bool network_active)>;

    virtual std::unique_ptr<Handler> handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn) = 0;

    //! Register handler for notify alert messages.

    using NotifyAlertChangedFn = std::function<void()>;

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

    //! Register handler for ban list messages.

    using BannedListChangedFn = std::function<void()>;

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

    //! Register handler for block tip messages.

    using NotifyBlockTipFn =

        std::function<void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)>;

    virtual std::unique_ptr<Handler> handleNotifyBlockTip(NotifyBlockTipFn fn) = 0;

    //! Register handler for header tip messages.

    using NotifyHeaderTipFn =

        std::function<void(SynchronizationState, interfaces::BlockTip tip, bool presync)>;

    virtual std::unique_ptr<Handler> handleNotifyHeaderTip(NotifyHeaderTipFn fn) = 0;

    //! Get and set internal node context. Useful for testing, but not

    //! accessible across processes.

    virtual node::NodeContext* context() { return nullptr; }

    virtual void setContext(node::NodeContext* context) { }

};

//! Return implementation of Node interface.

std::unique_ptr<Node> MakeNode(node::NodeContext& context);

//! Block tip (could be a header or not, depends on the subscribed signal).

struct BlockTip {

    int block_height;

    int64_t block_time;

    uint256 block_hash;

};

} // namespace interfaces

#endif // BITCOIN_INTERFACES_NODE_H