Classes
class	FoundBlock
class	Chain
class	ChainClient
class	Echo
	Simple string echoing interface for testing. More...
class	Handler
class	Init
class	Ipc
class	BlockTemplate
	Block template interface. More...
class	Mining
struct	BlockAndHeaderTipInfo
	Block and header tip information. More...
class	ExternalSigner
	External signer interface used by the GUI. More...
class	Node
	Top-level interface for a bitcoin node (bitcoind process). More...
struct	BlockTip
	Block tip (could be a header or not, depends on the subscribed signal). More...
struct	BlockRef
	Hash/height pair to help track and identify blocks. More...
class	Wallet
	Interface for accessing a wallet. More...
class	WalletLoader
struct	WalletAddress
	Information about one wallet address. More...
struct	WalletBalances
	Collection of wallet balances. More...
struct	WalletTx
struct	WalletTxStatus
	Updated transaction status. More...
struct	WalletTxOut
	Wallet transaction output. More...
struct	WalletMigrationResult
	Migrated wallet info. More...
struct	BlockInfo
	Block data sent with blockConnected, blockDisconnected notifications. More...

Typedefs
using	SettingsUpdate = std::function<std::optional<interfaces::SettingsAction>(common::SettingsValue&)>
using	WalletOrderForm = std::vector<std::pair<std::string, std::string>>
using	WalletValueMap = std::map<std::string, std::string>

Enumerations
enum class	SettingsAction { WRITE , SKIP_WRITE }

Functions
std::unique_ptr< Handler >	MakeCleanupHandler (std::function< void()> cleanup)
	Return handler wrapping a cleanup function.
std::unique_ptr< Handler >	MakeSignalHandler (boost::signals2::connection connection)
	Return handler wrapping a boost signal connection.
std::unique_ptr< Echo >	MakeEcho ()
	Return implementation of Echo interface.
std::unique_ptr< WalletLoader >	MakeWalletLoader (Chain &chain, ArgsManager &args)
std::unique_ptr< Init >	MakeGuiInit (int argc, char *argv[])
	Return implementation of Init interface for the gui process.
std::unique_ptr< Init >	MakeNodeInit (node::NodeContext &node, int argc, char *argv[], int &exit_status)
std::unique_ptr< Init >	MakeWalletInit (int argc, char *argv[], int &exit_status)
	Return implementation of Init interface for the wallet process.
std::unique_ptr< Chain >	MakeChain (node::NodeContext &node)
	Return implementation of Chain interface.
std::unique_ptr< Ipc >	MakeIpc (const char exe_name, const char process_argv0, Init &init)
	Return implementation of Ipc interface.
std::unique_ptr< Mining >	MakeMining (node::NodeContext &node, bool wait_loaded=true)
std::unique_ptr< Node >	MakeNode (node::NodeContext &context)
	Return implementation of Node interface.
std::unique_ptr< Wallet >	MakeWallet (wallet::WalletContext &context, const std::shared_ptr< wallet::CWallet > &wallet)

Typedef Documentation

◆ SettingsUpdate

using interfaces::SettingsUpdate = std::function<std::optional<interfaces::SettingsAction>(common::SettingsValue&)>

Definition at line 91 of file chain.h.

◆ WalletOrderForm

using interfaces::WalletOrderForm = std::vector<std::pair<std::string, std::string>>

Definition at line 61 of file wallet.h.

◆ WalletValueMap

using interfaces::WalletValueMap = std::map<std::string, std::string>

Definition at line 62 of file wallet.h.

Enumeration Type Documentation

◆ SettingsAction

enum class interfaces::SettingsAction

strong

The action to be taken after updating a settings value. WRITE indicates that the updated value must be written to disk, while SKIP_WRITE indicates that the change will be kept in memory-only without persisting it.

Enumerator
WRITE
SKIP_WRITE

Definition at line 86 of file chain.h.

Function Documentation

◆ MakeChain()

std::unique_ptr< Chain > interfaces::MakeChain ( node::NodeContext & node )

Return implementation of Chain interface.

Definition at line 1023 of file interfaces.cpp.

Here is the caller graph for this function:

◆ MakeCleanupHandler()

std::unique_ptr< Handler > interfaces::MakeCleanupHandler ( std::function< void()> cleanup )

Return handler wrapping a cleanup function.

Definition at line 42 of file interfaces.cpp.

Here is the caller graph for this function:

◆ MakeEcho()

std::unique_ptr< Echo > interfaces::MakeEcho ( )

Return implementation of Echo interface.

Definition at line 52 of file interfaces.cpp.

Here is the caller graph for this function:

◆ MakeGuiInit()

std::unique_ptr< Init > interfaces::MakeGuiInit	(	int	argc,
		char *	argv[] )

Return implementation of Init interface for the gui process.

Definition at line 50 of file bitcoin-gui.cpp.

Here is the caller graph for this function:

◆ MakeIpc()

std::unique_ptr< Ipc > interfaces::MakeIpc	(	const char *	exe_name,
		const char *	process_argv0,
		Init &	init )

Return implementation of Ipc interface.

Definition at line 132 of file interfaces.cpp.

◆ MakeMining()

std::unique_ptr< Mining > interfaces::MakeMining	(	node::NodeContext &	node,
		bool	wait_loaded = true )

Return implementation of Mining interface.

Parameters

[in] wait_loaded waits for chainstate data to be loaded before returning. Used to prevent external clients from being able to crash the node during startup.

Definition at line 1024 of file interfaces.cpp.

Here is the caller graph for this function:

◆ MakeNode()

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

Return implementation of Node interface.

Definition at line 1022 of file interfaces.cpp.

◆ MakeNodeInit()

std::unique_ptr< Init > interfaces::MakeNodeInit	(	node::NodeContext &	node,
		int	argc,
		char *	argv[],
		int &	exit_status )

Return implementation of Init interface for the node process. If the argv indicates that this is a child process spawned to handle requests from a parent process, this blocks and handles requests, then returns null and a status code to exit with. If this returns non-null, the caller can start up normally and use the Init object to spawn and connect to other processes while it is running.

Definition at line 49 of file bitcoin-node.cpp.

◆ MakeSignalHandler()

std::unique_ptr< Handler > interfaces::MakeSignalHandler ( boost::signals2::connection connection )

Return handler wrapping a boost signal connection.

Definition at line 47 of file interfaces.cpp.

◆ MakeWallet()

std::unique_ptr< Wallet > interfaces::MakeWallet	(	wallet::WalletContext &	context,
		const std::shared_ptr< wallet::CWallet > &	wallet )

Return implementation of Wallet interface. This function is defined in dummywallet.cpp and throws if the wallet component is not compiled.

Definition at line 668 of file interfaces.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeWalletInit()

std::unique_ptr< Init > interfaces::MakeWalletInit	(	int	argc,
		char *	argv[],
		int &	exit_status )

Return implementation of Init interface for the wallet process.

Definition at line 10 of file bitcoin-wallet.cpp.

◆ MakeWalletLoader()

std::unique_ptr< WalletLoader > interfaces::MakeWalletLoader	(	Chain &	chain,
		ArgsManager &	args )

Return implementation of ChainClient interface for a wallet loader. This function will be undefined in builds where ENABLE_WALLET is false.

Definition at line 59 of file dummywallet.cpp.

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ SettingsUpdate

◆ WalletOrderForm

◆ WalletValueMap

Enumeration Type Documentation

◆ SettingsAction

Function Documentation

◆ MakeChain()

◆ MakeCleanupHandler()

◆ MakeEcho()

◆ MakeGuiInit()

◆ MakeIpc()

◆ MakeMining()

◆ MakeNode()

◆ MakeNodeInit()

◆ MakeSignalHandler()

◆ MakeWallet()

◆ MakeWalletInit()

◆ MakeWalletLoader()