Functions
bool	wallet::CWallet::SignTransaction (CMutableTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Fetch the inputs and sign with SIGHASH_ALL. More...

bool	wallet::CWallet::SignTransaction (CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, bilingual_str > &input_errors) const
	Sign the tx given the input coins and sighash. More...

std::optional< common::PSBTError >	wallet::CWallet::FillPSBT (PartiallySignedTransaction &psbtx, bool &complete, int sighash_type=SIGHASH_DEFAULT, bool sign=true, bool bip32derivs=true, size_t *n_signed=nullptr, bool finalize=true) const
	Fills out a PSBT with information from the wallet. More...

SigningResult	wallet::CWallet::SignMessage (const std::string &message, const PKHash &pkhash, std::string &str_sig) const

OutputType	wallet::CWallet::TransactionChangeType (const std::optional< OutputType > &change_type, const std::vector< CRecipient > &vecSend) const

void	wallet::CWallet::CommitTransaction (CTransactionRef tx, mapValue_t mapValue, std::vector< std::pair< std::string, std::string > > orderForm)
	Submit the transaction to the node's mempool and then relay to peers. More...

DBErrors	wallet::CWallet::LoadWallet ()

util::Result< void >	wallet::CWallet::RemoveTxs (std::vector< uint256 > &txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Erases the provided transactions from the wallet. More...

util::Result< void >	wallet::CWallet::RemoveTxs (WalletBatch &batch, std::vector< uint256 > &txs_to_remove) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	wallet::CWallet::SetAddressBookWithDB (WalletBatch &batch, const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &strPurpose)

bool	wallet::CWallet::SetAddressBook (const CTxDestination &address, const std::string &strName, const std::optional< AddressPurpose > &purpose)

bool	wallet::CWallet::DelAddressBook (const CTxDestination &address)

bool	wallet::CWallet::DelAddressBookWithDB (WalletBatch &batch, const CTxDestination &address)

size_t	wallet::CWallet::KeypoolCountExternalKeys () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

unsigned int	wallet::CWallet::GetKeyPoolSize () const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	wallet::CWallet::TopUpKeyPool (unsigned int kpSize=0)

util::Result< CTxDestination >	wallet::CWallet::GetNewDestination (const OutputType type, const std::string label)

util::Result< CTxDestination >	wallet::CWallet::GetNewChangeDestination (const OutputType type)

std::optional< int64_t >	wallet::CWallet::GetOldestKeyPoolTime () const

void	wallet::CWallet::MarkDestinationsDirty (const std::set< CTxDestination > &destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return outdated information. More...

void	wallet::CWallet::ForEachAddrBookEntry (const ListAddrBookFunc &func) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

std::vector< CTxDestination >	wallet::CWallet::ListAddrBookAddresses (const std::optional< AddrBookFilter > &filter) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Filter and retrieve destinations stored in the addressbook. More...

std::set< std::string >	wallet::CWallet::ListAddrBookLabels (const std::optional< AddressPurpose > purpose) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Retrieve all the known labels in the address book. More...

util::Result< CTxDestination >	wallet::ReserveDestination::GetReservedDestination (bool internal)
	Reserve an address. More...

void	wallet::ReserveDestination::KeepDestination ()
	Keep the address. Do not return its key to the keypool when this object goes out of scope. More...

void	wallet::ReserveDestination::ReturnDestination ()
	Return reserved address. More...

util::Result< void >	wallet::CWallet::DisplayAddress (const CTxDestination &dest) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
	Display address on an external signer. More...

bool	wallet::CWallet::LockCoin (const COutPoint &output, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	wallet::CWallet::UnlockCoin (const COutPoint &output, WalletBatch *batch=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	wallet::CWallet::UnlockAllCoins () EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

bool	wallet::CWallet::IsLockedCoin (const COutPoint &output) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

void	wallet::CWallet::ListLockedCoins (std::vector< COutPoint > &vOutpts) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)

Detailed Description

Function Documentation

◆ CommitTransaction()

void wallet::CWallet::CommitTransaction	(	CTransactionRef	tx,
		mapValue_t	mapValue,
		std::vector< std::pair< std::string, std::string > >	orderForm
	)

Submit the transaction to the node's mempool and then relay to peers.

Should be called after CreateTransaction unless you want to abort broadcasting the transaction.

Parameters

[in]	tx	The transaction to be broadcast.
[in]	mapValue	key-values to be set on the transaction.
[in]	orderForm	BIP 70 / BIP 21 order form details to be set on the transaction.

Definition at line 2328 of file wallet.cpp.

Here is the call graph for this function:

◆ DelAddressBook()

bool wallet::CWallet::DelAddressBook ( const CTxDestination & address )

Definition at line 2488 of file wallet.cpp.

Here is the call graph for this function:

◆ DelAddressBookWithDB()

bool wallet::CWallet::DelAddressBookWithDB	(	WalletBatch &	batch,
		const CTxDestination &	address
	)

Definition at line 2495 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DisplayAddress()

util::Result< void > wallet::CWallet::DisplayAddress ( const CTxDestination & dest )

Display address on an external signer.

Definition at line 2703 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FillPSBT()

std::optional< PSBTError > wallet::CWallet::FillPSBT	(	PartiallySignedTransaction &	psbtx,
		bool &	complete,
		int	sighash_type = `SIGHASH_DEFAULT`,
		bool	sign = `true`,
		bool	bip32derivs = `true`,
		size_t *	n_signed = `nullptr`,
		bool	finalize = `true`
	)		const

Fills out a PSBT with information from the wallet.

Fills in UTXOs if we have them. Tries to sign if sign=true. Sets complete if the PSBT is now complete (i.e. has all required signatures or signature-parts, and is ready to finalize.) Sets error and returns false if something goes wrong.

Parameters

[in]	psbtx	PartiallySignedTransaction to fill in
[out]	complete	indicates whether the PSBT is now complete
[in]	sighash_type	the sighash type to use when signing (if PSBT does not specify)
[in]	sign	whether to sign or not
[in]	bip32derivs	whether to fill in bip32 derivation information if available
[out]	n_signed	the number of inputs signed by this wallet
[in]	finalize	whether to create the final scriptSig or scriptWitness if possible return error

Definition at line 2200 of file wallet.cpp.

Here is the call graph for this function:

◆ ForEachAddrBookEntry()

void wallet::CWallet::ForEachAddrBookEntry ( const ListAddrBookFunc & func ) const

Definition at line 2627 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetKeyPoolSize()

unsigned int wallet::CWallet::GetKeyPoolSize ( ) const

Definition at line 2551 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNewChangeDestination()

util::Result< CTxDestination > wallet::CWallet::GetNewChangeDestination ( const OutputType type )

Definition at line 2588 of file wallet.cpp.

Here is the call graph for this function:

◆ GetNewDestination()

util::Result< CTxDestination > wallet::CWallet::GetNewDestination	(	const OutputType	type,
		const std::string	label
	)

Definition at line 2572 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetOldestKeyPoolTime()

std::optional< int64_t > wallet::CWallet::GetOldestKeyPoolTime ( ) const

Definition at line 2599 of file wallet.cpp.

◆ GetReservedDestination()

util::Result< CTxDestination > wallet::ReserveDestination::GetReservedDestination ( bool internal )

Reserve an address.

Definition at line 2666 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsLockedCoin()

bool wallet::CWallet::IsLockedCoin ( const COutPoint & output ) const

Definition at line 2749 of file wallet.cpp.

Here is the call graph for this function:

◆ KeepDestination()

void wallet::ReserveDestination::KeepDestination ( )

Keep the address. Do not return its key to the keypool when this object goes out of scope.

Definition at line 2685 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ KeypoolCountExternalKeys()

size_t wallet::CWallet::KeypoolCountExternalKeys ( ) const

Definition at line 2534 of file wallet.cpp.

Here is the call graph for this function:

◆ ListAddrBookAddresses()

std::vector< CTxDestination > wallet::CWallet::ListAddrBookAddresses ( const std::optional< AddrBookFilter > & filter ) const

Filter and retrieve destinations stored in the addressbook.

Definition at line 2636 of file wallet.cpp.

Here is the call graph for this function:

◆ ListAddrBookLabels()

std::set< std::string > wallet::CWallet::ListAddrBookLabels ( const std::optional< AddressPurpose > purpose ) const

Retrieve all the known labels in the address book.

Definition at line 2652 of file wallet.cpp.

Here is the call graph for this function:

◆ ListLockedCoins()

void wallet::CWallet::ListLockedCoins ( std::vector< COutPoint > & vOutpts ) const

Definition at line 2755 of file wallet.cpp.

Here is the call graph for this function:

◆ LoadWallet()

DBErrors wallet::CWallet::LoadWallet ( )

Definition at line 2369 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LockCoin()

bool wallet::CWallet::LockCoin	(	const COutPoint &	output,
		WalletBatch *	batch = `nullptr`
	)

Definition at line 2717 of file wallet.cpp.

Here is the call graph for this function:

◆ MarkDestinationsDirty()

void wallet::CWallet::MarkDestinationsDirty ( const std::set< CTxDestination > & destinations )

Marks all outputs in each one of the destinations dirty, so their cache is reset and does not return outdated information.

Definition at line 2613 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveTxs() [1/2]

util::Result< void > wallet::CWallet::RemoveTxs ( std::vector< uint256 > & txs_to_remove )

Erases the provided transactions from the wallet.

Definition at line 2394 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveTxs() [2/2]

util::Result< void > wallet::CWallet::RemoveTxs	(	WalletBatch &	batch,
		std::vector< uint256 > &	txs_to_remove
	)

Definition at line 2408 of file wallet.cpp.

Here is the call graph for this function:

◆ ReturnDestination()

void wallet::ReserveDestination::ReturnDestination ( )

Return reserved address.

Definition at line 2694 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressBook()

bool wallet::CWallet::SetAddressBook	(	const CTxDestination &	address,
		const std::string &	strName,
		const std::optional< AddressPurpose > &	purpose
	)

Definition at line 2482 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAddressBookWithDB()

bool wallet::CWallet::SetAddressBookWithDB	(	WalletBatch &	batch,
		const CTxDestination &	address,
		const std::string &	strName,
		const std::optional< AddressPurpose > &	strPurpose
	)

private

Definition at line 2446 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SignMessage()

SigningResult wallet::CWallet::SignMessage	(	const std::string &	message,
		const PKHash &	pkhash,
		std::string &	str_sig
	)		const

Definition at line 2254 of file wallet.cpp.

Here is the call graph for this function:

◆ SignTransaction() [1/2]

bool wallet::CWallet::SignTransaction ( CMutableTransaction & tx ) const

Fetch the inputs and sign with SIGHASH_ALL.

Definition at line 2166 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SignTransaction() [2/2]

bool wallet::CWallet::SignTransaction	(	CMutableTransaction &	tx,
		const std::map< COutPoint, Coin > &	coins,
		int	sighash,
		std::map< int, bilingual_str > &	input_errors
	)		const

Sign the tx given the input coins and sighash.

Definition at line 2185 of file wallet.cpp.

Here is the call graph for this function:

◆ TopUpKeyPool()

bool wallet::CWallet::TopUpKeyPool ( unsigned int kpSize = 0 )

Definition at line 2562 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TransactionChangeType()

OutputType wallet::CWallet::TransactionChangeType	(	const std::optional< OutputType > &	change_type,
		const std::vector< CRecipient > &	vecSend
	)		const

Definition at line 2267 of file wallet.cpp.

Here is the call graph for this function:

◆ UnlockAllCoins()

bool wallet::CWallet::UnlockAllCoins ( )

Definition at line 2737 of file wallet.cpp.

Here is the call graph for this function:

◆ UnlockCoin()

bool wallet::CWallet::UnlockCoin	(	const COutPoint &	output,
		WalletBatch *	batch = `nullptr`
	)

Definition at line 2727 of file wallet.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ CommitTransaction()

◆ DelAddressBook()

◆ DelAddressBookWithDB()

◆ DisplayAddress()

◆ FillPSBT()

◆ ForEachAddrBookEntry()

◆ GetKeyPoolSize()

◆ GetNewChangeDestination()

◆ GetNewDestination()

◆ GetOldestKeyPoolTime()

◆ GetReservedDestination()

◆ IsLockedCoin()

◆ KeepDestination()

◆ KeypoolCountExternalKeys()

◆ ListAddrBookAddresses()

◆ ListAddrBookLabels()

◆ ListLockedCoins()

◆ LoadWallet()

◆ LockCoin()

◆ MarkDestinationsDirty()

◆ RemoveTxs() [1/2]

◆ RemoveTxs() [2/2]

◆ ReturnDestination()

◆ SetAddressBook()

◆ SetAddressBookWithDB()

◆ SignMessage()

◆ SignTransaction() [1/2]

◆ SignTransaction() [2/2]

◆ TopUpKeyPool()

◆ TransactionChangeType()

◆ UnlockAllCoins()

◆ UnlockCoin()