 |
Bitcoin Core
21.99.0
P2P Digital Currency
|
Go to the documentation of this file.
5 #ifndef BITCOIN_INTERFACES_NODE_H
6 #define BITCOIN_INTERFACES_NODE_H
85 virtual void mapPort(
bool use_upnp,
bool use_natpmp) = 0;
94 using NodesStats = std::vector<std::tuple<CNodeStats, bool, CNodeStateStats>>;
101 virtual bool ban(
const CNetAddr& net_addr, int64_t ban_time_offset) = 0;
125 virtual bool getHeaderTip(
int& height, int64_t& block_time) = 0;
181 std::function<bool(
const bilingual_str& message,
const std::string& caption,
unsigned int style)>;
186 const std::string& non_interactive_message,
187 const std::string& caption,
188 unsigned int style)>;
192 using ShowProgressFn = std::function<void(
const std::string& title,
int progress,
bool resume_possible)>;
239 #endif // BITCOIN_INTERFACES_NODE_H
virtual bool ban(const CNetAddr &net_addr, int64_t ban_time_offset)=0
Ban node.
std::function< void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)> NotifyHeaderTipFn
Register handler for header tip messages.
virtual std::unique_ptr< Handler > handleShowProgress(ShowProgressFn fn)=0
virtual int getNumBlocks()=0
Get num blocks.
virtual int64_t getLastBlockTime()=0
Get last block time.
virtual std::unique_ptr< Handler > handleMessageBox(MessageBoxFn fn)=0
virtual bool getProxy(Network net, proxyType &proxy_info)=0
Get proxy.
virtual void initLogging()=0
Init logging.
virtual bool getNetworkActive()=0
Get network active.
virtual std::unique_ptr< Handler > handleNotifyNetworkActiveChanged(NotifyNetworkActiveChangedFn fn)=0
virtual std::unique_ptr< Handler > handleInitMessage(InitMessageFn fn)=0
virtual bool disconnectById(NodeId id)=0
Disconnect node by id.
virtual std::unique_ptr< Handler > handleNotifyHeaderTip(NotifyHeaderTipFn fn)=0
virtual void setNetworkActive(bool active)=0
Set network active.
virtual std::unique_ptr< Handler > handleNotifyBlockTip(NotifyBlockTipFn fn)=0
virtual bool getReindex()=0
Get reindex.
std::function< bool(const bilingual_str &message, const std::string &non_interactive_message, const std::string &caption, unsigned int style)> QuestionFn
Register handler for question messages.
virtual std::unique_ptr< Handler > handleNotifyAlertChanged(NotifyAlertChangedFn fn)=0
Block and header tip information.
virtual bool disconnectByAddress(const CNetAddr &net_addr)=0
Disconnect node by address.
virtual bool getUnspentOutput(const COutPoint &output, Coin &coin)=0
Get unspent outputs associated with a transaction.
virtual std::unique_ptr< Handler > handleBannedListChanged(BannedListChangedFn fn)=0
Fee rate in satoshis per kilobyte: CAmount / kB.
virtual void appShutdown()=0
Stop node.
virtual NodeContext * context()
Get and set internal node context.
std::function< void()> BannedListChangedFn
Register handler for ban list messages.
std::function< void(SynchronizationState, interfaces::BlockTip tip, double verification_progress)> NotifyBlockTipFn
Register handler for block tip messages.
virtual bool getHeaderTip(int &height, int64_t &block_time)=0
Get header tip height and time.
std::unique_ptr< Node > MakeNode(NodeContext *context=nullptr)
Return implementation of Node interface.
std::vector< std::tuple< CNodeStats, bool, CNodeStateStats > > NodesStats
Get stats for connected nodes.
std::function< void()> NotifyAlertChangedFn
Register handler for notify alert messages.
virtual void startShutdown()=0
Start shutdown.
virtual std::vector< std::string > listRpcCommands()=0
List rpc commands.
virtual WalletClient & walletClient()=0
Get wallet client.
virtual void setContext(NodeContext *context)
virtual std::unique_ptr< Handler > handleNotifyNumConnectionsChanged(NotifyNumConnectionsChangedFn fn)=0
virtual double getVerificationProgress()=0
Get verification progress.
Wallet chain client that in addition to having chain client methods for starting up,...
virtual bool isInitialBlockDownload()=0
Is initial block download.
virtual bool unban(const CSubNet &ip)=0
Unban node.
std::function< void(const std::string &title, int progress, bool resume_possible)> ShowProgressFn
Register handler for progress messages.
Top-level interface for a bitcoin node (bitcoind process).
double verification_progress
virtual bool getNodesStats(NodesStats &stats)=0
virtual CFeeRate getDustRelayFee()=0
Get dust relay fee.
virtual bool shutdownRequested()=0
Return whether shutdown was requested.
virtual uint32_t getLogCategories()=0
virtual size_t getMempoolDynamicUsage()=0
Get mempool dynamic usage.
virtual void rpcSetTimerInterfaceIfUnset(RPCTimerInterface *iface)=0
Set RPC timer interface if unset.
virtual bilingual_str getWarnings()=0
Get warnings.
SynchronizationState
Current sync state passed to tip changed callbacks.
std::map< CSubNet, CBanEntry > banmap_t
virtual void rpcUnsetTimerInterface(RPCTimerInterface *iface)=0
Unset RPC timer interface.
An outpoint - a combination of a transaction hash and an index n into its vout.
virtual bool getImporting()=0
Get importing.
virtual int64_t getTotalBytesRecv()=0
Get total bytes recv.
NodeContext struct containing references to chain state and connection state.
std::function< void(int new_num_connections)> NotifyNumConnectionsChangedFn
Register handler for number of connections changed messages.
virtual uint256 getBestBlockHash()=0
Get best block hash.
virtual size_t getMempoolSize()=0
Get mempool size.
virtual std::unique_ptr< Handler > handleQuestion(QuestionFn fn)=0
std::function< void(const std::string &message)> InitMessageFn
Register handler for init messages.
virtual UniValue executeRpc(const std::string &command, const UniValue ¶ms, const std::string &uri)=0
Execute rpc command.
std::function< void(bool network_active)> NotifyNetworkActiveChangedFn
Register handler for network active messages.
Block tip (could be a header or not, depends on the subscribed signal).
virtual size_t getNodeCount(CConnman::NumConnections flags)=0
Get number of connections.
virtual int64_t getTotalBytesSent()=0
Get total bytes sent.
virtual bool appInitMain(interfaces::BlockAndHeaderTipInfo *tip_info=nullptr)=0
Start node.
virtual bool baseInitialize()=0
Initialize app dependencies.
virtual void initParameterInteraction()=0
Init parameter interaction.
virtual bool getBanned(banmap_t &banmap)=0
Get ban map entries.
std::function< bool(const bilingual_str &message, const std::string &caption, unsigned int style)> MessageBoxFn
Register handler for message box messages.
virtual void mapPort(bool use_upnp, bool use_natpmp)=0
Map port.