interfaces Namespace Reference

Classes
class	Chain
	Interface giving clients (wallet processes, maybe other analysis tools in the future) ability to access to the chain state, receive notifications, estimate fees, and submit transactions. More...
class	ChainClient
	Interface to let node manage chain clients (wallets, or maybe tools for monitoring and analysis in the future). More...
class	Handler
	Generic interface for managing an event handler or callback function registered with another interface. More...
class	Node
	Top-level interface for a bitcoin node (bitcoind process). More...
class	Wallet
	Interface for accessing a wallet. More...
struct	WalletAddress
	Information about one wallet address. More...
struct	WalletBalances
	Collection of wallet balances. More...
struct	WalletTx
struct	WalletTxOut
	Wallet transaction output. More...
struct	WalletTxStatus
	Updated transaction status. More...

Typedefs
using	WalletOrderForm = std::vector< std::pair< std::string, std::string > >
using	WalletValueMap = std::map< std::string, std::string >

Functions
std::unique_ptr< Wallet >	MakeWallet (const std::shared_ptr< CWallet > &wallet)
	Return implementation of Wallet interface. More...
std::unique_ptr< Chain >	MakeChain (NodeContext &node)
	Return implementation of Chain interface. More...
std::unique_ptr< ChainClient >	MakeWalletClient (Chain &chain, std::vector< std::string > wallet_filenames)
	Return implementation of ChainClient interface for a wallet client. More...
std::unique_ptr< Handler >	MakeHandler (boost::signals2::connection connection)
	Return handler wrapping a boost signal connection. More...
std::unique_ptr< Handler >	MakeHandler (std::function< void()> cleanup)
	Return handler wrapping a cleanup function. More...
std::unique_ptr< Node >	MakeNode ()
	Return implementation of Node interface. More...

Typedef Documentation

WalletOrderForm

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

Definition at line 44 of file wallet.h.

WalletValueMap

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

Definition at line 45 of file wallet.h.

Function Documentation

MakeChain()

std::unique_ptr< Chain > interfaces::MakeChain

(

NodeContext &

node

)

Return implementation of Chain interface.

Definition at line 378 of file chain.cpp.

Here is the caller graph for this function:

MakeHandler() [1/2]

std::unique_ptr< Handler > interfaces::MakeHandler

(

boost::signals2::connection

connection

)

Return handler wrapping a boost signal connection.

Definition at line 36 of file handler.cpp.

Here is the caller graph for this function:

MakeHandler() [2/2]

std::unique_ptr< Handler > interfaces::MakeHandler

(

std::function< void()>

cleanup

)

Return handler wrapping a cleanup function.

Definition at line 41 of file handler.cpp.

MakeNode()

std::unique_ptr< Node > interfaces::MakeNode

(

)

Return implementation of Node interface.

Definition at line 327 of file node.cpp.

Here is the caller graph for this function:

MakeWallet()

std::unique_ptr< Wallet > interfaces::MakeWallet

(

const std::shared_ptr< 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 93 of file dummywallet.cpp.

Here is the caller graph for this function:

MakeWalletClient()

std::unique_ptr< ChainClient > interfaces::MakeWalletClient	(	Chain &	chain,
		std::vector< std::string >	wallet_filenames
	)

Return implementation of ChainClient interface for a wallet client.

This function will be undefined in builds where ENABLE_WALLET is false.

Currently, wallets are the only chain clients. But in the future, other types of chain clients could be added, such as tools for monitoring, analysis, or fee estimation. These clients need to expose their own MakeXXXClient functions returning their implementations of the ChainClient interface.

Definition at line 543 of file wallet.cpp.

Here is the caller graph for this function: