A CWallet is an extension of a keystore, which also maintains a set of transactions and balances, and provides the ability to create new transactions. More...

#include <wallet.h>

Inheritance diagram for CWallet:

[legend]

Collaboration diagram for CWallet:

[legend]

Public Types
typedef std::map< unsigned int, CMasterKey >	MasterKeyMap

typedef std::pair< CWalletTx , CAccountingEntry >	TxPair

typedef std::multimap< int64, TxPair >	TxItems

Public Member Functions
	CWallet ()

	CWallet (std::string strWalletFileIn)

bool	CanSupportFeature (enum WalletFeature wf)

void	AvailableCoins (std::vector< COutput > &vCoins, bool fOnlyConfirmed=true, const CCoinControl *coinControl=NULL) const

bool	SelectCoinsMinConf (int64 nTargetValue, int nConfMine, int nConfTheirs, std::vector< COutput > vCoins, std::set< std::pair< const CWalletTx *, unsigned int > > &setCoinsRet, int64 &nValueRet) const

bool	IsLockedCoin (uint256 hash, unsigned int n) const

void	LockCoin (COutPoint &output)

void	UnlockCoin (COutPoint &output)

void	UnlockAllCoins ()

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

CPubKey	GenerateNewKey ()

bool	AddKeyPubKey (const CKey &key, const CPubKey &pubkey)

bool	LoadKey (const CKey &key, const CPubKey &pubkey)

bool	LoadMinVersion (int nVersion)

bool	AddCryptedKey (const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)

bool	LoadCryptedKey (const CPubKey &vchPubKey, const std::vector< unsigned char > &vchCryptedSecret)

bool	AddCScript (const CScript &redeemScript)

bool	LoadCScript (const CScript &redeemScript)

bool	Unlock (const SecureString &strWalletPassphrase)

bool	ChangeWalletPassphrase (const SecureString &strOldWalletPassphrase, const SecureString &strNewWalletPassphrase)

bool	EncryptWallet (const SecureString &strWalletPassphrase)

int64	IncOrderPosNext (CWalletDB *pwalletdb=NULL)
	Increment the next transaction order id. More...

TxItems	OrderedTxItems (std::list< CAccountingEntry > &acentries, std::string strAccount="")
	Get the wallet's activity log. More...

void	MarkDirty ()

bool	AddToWallet (const CWalletTx &wtxIn)

bool	AddToWalletIfInvolvingMe (const uint256 &hash, const CTransaction &tx, const CBlock *pblock, bool fUpdate=false, bool fFindBlock=false)

bool	EraseFromWallet (uint256 hash)

void	WalletUpdateSpent (const CTransaction &prevout)

int	ScanForWalletTransactions (CBlockIndex *pindexStart, bool fUpdate=false)

void	ReacceptWalletTransactions ()

void	ResendWalletTransactions ()

int64	GetBalance () const

int64	GetUnconfirmedBalance () const

int64	GetImmatureBalance () const

bool	CreateTransaction (const std::vector< std::pair< CScript, int64 > > &vecSend, CWalletTx &wtxNew, CReserveKey &reservekey, int64 &nFeeRet, std::string &strFailReason, const CCoinControl *coinControl=NULL)

bool	CreateTransaction (CScript scriptPubKey, int64 nValue, CWalletTx &wtxNew, CReserveKey &reservekey, int64 &nFeeRet, std::string &strFailReason, const CCoinControl *coinControl=NULL)

bool	CommitTransaction (CWalletTx &wtxNew, CReserveKey &reservekey)

std::string	SendMoney (CScript scriptPubKey, int64 nValue, CWalletTx &wtxNew, bool fAskFee=false)

std::string	SendMoneyToDestination (const CTxDestination &address, int64 nValue, CWalletTx &wtxNew, bool fAskFee=false)

bool	NewKeyPool ()

bool	TopUpKeyPool ()

int64	AddReserveKey (const CKeyPool &keypool)

void	ReserveKeyFromKeyPool (int64 &nIndex, CKeyPool &keypool)

void	KeepKey (int64 nIndex)

void	ReturnKey (int64 nIndex)

bool	GetKeyFromPool (CPubKey &key, bool fAllowReuse=true)

int64	GetOldestKeyPoolTime ()

void	GetAllReserveKeys (std::set< CKeyID > &setAddress)

std::set< std::set < CTxDestination > >	GetAddressGroupings ()

std::map< CTxDestination, int64 >	GetAddressBalances ()

bool	IsMine (const CTxIn &txin) const

int64	GetDebit (const CTxIn &txin) const

bool	IsMine (const CTxOut &txout) const

int64	GetCredit (const CTxOut &txout) const

bool	IsChange (const CTxOut &txout) const

int64	GetChange (const CTxOut &txout) const

bool	IsMine (const CTransaction &tx) const

bool	IsFromMe (const CTransaction &tx) const

int64	GetDebit (const CTransaction &tx) const

int64	GetCredit (const CTransaction &tx) const

int64	GetChange (const CTransaction &tx) const

void	SetBestChain (const CBlockLocator &loc)

DBErrors	LoadWallet (bool &fFirstRunRet)

bool	SetAddressBookName (const CTxDestination &address, const std::string &strName)

bool	DelAddressBookName (const CTxDestination &address)

void	UpdatedTransaction (const uint256 &hashTx)

void	PrintWallet (const CBlock &block)

void	Inventory (const uint256 &hash)

int	GetKeyPoolSize ()

bool	GetTransaction (const uint256 &hashTx, CWalletTx &wtx)

bool	SetDefaultKey (const CPubKey &vchPubKey)

bool	SetMinVersion (enum WalletFeature, CWalletDB *pwalletdbIn=NULL, bool fExplicit=false)

bool	SetMaxVersion (int nVersion)

int	GetVersion ()

Public Member Functions inherited from CCryptoKeyStore
	CCryptoKeyStore ()

bool	IsCrypted () const

bool	IsLocked () const

bool	Lock ()

bool	HaveKey (const CKeyID &address) const

bool	GetKey (const CKeyID &address, CKey &keyOut) const

bool	GetPubKey (const CKeyID &address, CPubKey &vchPubKeyOut) const

void	GetKeys (std::set< CKeyID > &setAddress) const

Public Member Functions inherited from CBasicKeyStore
virtual bool	HaveCScript (const CScriptID &hash) const

virtual bool	GetCScript (const CScriptID &hash, CScript &redeemScriptOut) const

Public Member Functions inherited from CKeyStore
virtual	~CKeyStore ()

virtual bool	AddKey (const CKey &key)

Public Attributes
CCriticalSection	cs_wallet

bool	fFileBacked

std::string	strWalletFile

std::set< int64 >	setKeyPool

MasterKeyMap	mapMasterKeys

unsigned int	nMasterKeyMaxID

std::map< uint256, CWalletTx >	mapWallet

int64	nOrderPosNext

std::map< uint256, int >	mapRequestCount

std::map< CTxDestination, std::string >	mapAddressBook

CPubKey	vchDefaultKey

std::set< COutPoint >	setLockedCoins

boost::signals2::signal< void(CWallet *wallet, const CTxDestination &address, const std::string &label, bool isMine, ChangeType status)>	NotifyAddressBookChanged
	Address book entry changed. More...

boost::signals2::signal< void(CWallet *wallet, const uint256 &hashTx, ChangeType status)>	NotifyTransactionChanged
	Wallet transaction added, removed or updated. More...

Public Attributes inherited from CCryptoKeyStore
boost::signals2::signal< void(CCryptoKeyStore *wallet)>	NotifyStatusChanged

Private Member Functions
bool	SelectCoins (int64 nTargetValue, std::set< std::pair< const CWalletTx , unsigned int > > &setCoinsRet, int64 &nValueRet, const CCoinControl coinControl=NULL) const

Private Attributes
CWalletDB *	pwalletdbEncryption

int	nWalletVersion

int	nWalletMaxVersion

Additional Inherited Members
Protected Member Functions inherited from CCryptoKeyStore
bool	SetCrypted ()

bool	EncryptKeys (CKeyingMaterial &vMasterKeyIn)

bool	Unlock (const CKeyingMaterial &vMasterKeyIn)

Protected Attributes inherited from CBasicKeyStore
KeyMap	mapKeys

ScriptMap	mapScripts

Protected Attributes inherited from CKeyStore
CCriticalSection	cs_KeyStore

Detailed Description

A CWallet is an extension of a keystore, which also maintains a set of transactions and balances, and provides the ability to create new transactions.

Definition at line 69 of file wallet.h.

Member Typedef Documentation

typedef std::map<unsigned int, CMasterKey> CWallet::MasterKeyMap

Definition at line 91 of file wallet.h.

typedef std::multimap<int64, TxPair > CWallet::TxItems

Definition at line 163 of file wallet.h.

typedef std::pair<CWalletTx*, CAccountingEntry*> CWallet::TxPair

Definition at line 162 of file wallet.h.

Constructor & Destructor Documentation

CWallet::CWallet ( )

inline

Definition at line 95 of file wallet.h.

CWallet::CWallet ( std::string strWalletFileIn )

inline

Definition at line 104 of file wallet.h.

Member Function Documentation

bool CWallet::AddCryptedKey	(	const CPubKey &	vchPubKey,
		const std::vector< unsigned char > &	vchCryptedSecret
	)

virtual

Reimplemented from CCryptoKeyStore.

Definition at line 61 of file wallet.cpp.

bool CWallet::AddCScript ( const CScript & redeemScript )

virtual

Reimplemented from CBasicKeyStore.

Definition at line 82 of file wallet.cpp.

bool CWallet::AddKeyPubKey	(	const CKey &	key,
		const CPubKey &	pubkey
	)

virtual

Reimplemented from CCryptoKeyStore.

Definition at line 49 of file wallet.cpp.

int64 CWallet::AddReserveKey ( const CKeyPool & keypool )

Definition at line 1610 of file wallet.cpp.

bool CWallet::AddToWallet ( const CWalletTx & wtxIn )

Definition at line 374 of file wallet.cpp.

bool CWallet::AddToWalletIfInvolvingMe	(	const uint256 &	hash,
		const CTransaction &	tx,
		const CBlock *	pblock,
		bool	fUpdate = `false`,
		bool	fFindBlock = `false`
	)

Definition at line 507 of file wallet.cpp.

void CWallet::AvailableCoins	(	std::vector< COutput > &	vCoins,
		bool	fOnlyConfirmed = `true`,
		const CCoinControl *	coinControl = `NULL`
	)		const

Definition at line 968 of file wallet.cpp.

bool CWallet::CanSupportFeature ( enum WalletFeature wf )

inline

Definition at line 126 of file wallet.h.

bool CWallet::ChangeWalletPassphrase	(	const SecureString &	strOldWalletPassphrase,
		const SecureString &	strNewWalletPassphrase
	)

Definition at line 114 of file wallet.cpp.

bool CWallet::CommitTransaction	(	CWalletTx &	wtxNew,
		CReserveKey &	reservekey
	)

Definition at line 1338 of file wallet.cpp.

bool CWallet::CreateTransaction	(	const std::vector< std::pair< CScript, int64 > > &	vecSend,
		CWalletTx &	wtxNew,
		CReserveKey &	reservekey,
		int64 &	nFeeRet,
		std::string &	strFailReason,
		const CCoinControl *	coinControl = `NULL`
	)

bool CWallet::CreateTransaction	(	CScript	scriptPubKey,
		int64	nValue,
		CWalletTx &	wtxNew,
		CReserveKey &	reservekey,
		int64 &	nFeeRet,
		std::string &	strFailReason,
		const CCoinControl *	coinControl = `NULL`
	)

Definition at line 1329 of file wallet.cpp.

bool CWallet::DelAddressBookName ( const CTxDestination & address )

Definition at line 1473 of file wallet.cpp.

bool CWallet::EncryptWallet ( const SecureString & strWalletPassphrase )

Definition at line 222 of file wallet.cpp.

bool CWallet::EraseFromWallet ( uint256 hash )

Definition at line 527 of file wallet.cpp.

CPubKey CWallet::GenerateNewKey ( )

Definition at line 31 of file wallet.cpp.

std::map< CTxDestination, int64 > CWallet::GetAddressBalances ( )

Definition at line 1681 of file wallet.cpp.

set< set< CTxDestination > > CWallet::GetAddressGroupings ( )

Definition at line 1721 of file wallet.cpp.

void CWallet::GetAllReserveKeys ( std::set< CKeyID > & setAddress )

Definition at line 1850 of file wallet.cpp.

int64 CWallet::GetBalance ( ) const

Definition at line 922 of file wallet.cpp.

int64 CWallet::GetChange ( const CTxOut & txout ) const

inline

Definition at line 216 of file wallet.h.

int64 CWallet::GetChange ( const CTransaction & tx ) const

inline

Definition at line 255 of file wallet.h.

int64 CWallet::GetCredit ( const CTxOut & txout ) const

inline

Definition at line 209 of file wallet.h.

int64 CWallet::GetCredit ( const CTransaction & tx ) const

inline

Definition at line 244 of file wallet.h.

int64 CWallet::GetDebit ( const CTxIn & txin ) const

Definition at line 556 of file wallet.cpp.

int64 CWallet::GetDebit ( const CTransaction & tx ) const

inline

Definition at line 233 of file wallet.h.

int64 CWallet::GetImmatureBalance ( ) const

Definition at line 953 of file wallet.cpp.

bool CWallet::GetKeyFromPool	(	CPubKey &	key,
		bool	fAllowReuse = `true`
	)

Definition at line 1646 of file wallet.cpp.

int CWallet::GetKeyPoolSize ( )

inline

Definition at line 288 of file wallet.h.

int64 CWallet::GetOldestKeyPoolTime ( )

Definition at line 1670 of file wallet.cpp.

bool CWallet::GetTransaction	(	const uint256 &	hashTx,
		CWalletTx &	wtx
	)

Definition at line 1496 of file wallet.cpp.

int64 CWallet::GetUnconfirmedBalance ( ) const

Definition at line 938 of file wallet.cpp.

int CWallet::GetVersion ( )

inline

Definition at line 304 of file wallet.h.

int64 CWallet::IncOrderPosNext ( CWalletDB * pwalletdb = NULL )

Increment the next transaction order id.

Returns: next transaction order id

Definition at line 303 of file wallet.cpp.

void CWallet::Inventory ( const uint256 & hash )

inline

Definition at line 278 of file wallet.h.

bool CWallet::IsChange ( const CTxOut & txout ) const

Definition at line 572 of file wallet.cpp.

bool CWallet::IsFromMe ( const CTransaction & tx ) const

inline

Definition at line 229 of file wallet.h.

bool CWallet::IsLockedCoin	(	uint256	hash,
		unsigned int	n
	)		const

Definition at line 1896 of file wallet.cpp.

bool CWallet::IsMine ( const CTxIn & txin ) const

Definition at line 540 of file wallet.cpp.

bool CWallet::IsMine ( const CTxOut & txout ) const

inline

Definition at line 205 of file wallet.h.

bool CWallet::IsMine ( const CTransaction & tx ) const

inline

Definition at line 222 of file wallet.h.

void CWallet::KeepKey ( int64 nIndex )

Definition at line 1625 of file wallet.cpp.

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

Definition at line 1903 of file wallet.cpp.

bool CWallet::LoadCryptedKey	(	const CPubKey &	vchPubKey,
		const std::vector< unsigned char > &	vchCryptedSecret
	)

Definition at line 77 of file wallet.cpp.

bool CWallet::LoadCScript ( const CScript & redeemScript )

inline

Definition at line 151 of file wallet.h.

bool CWallet::LoadKey	(	const CKey &	key,
		const CPubKey &	pubkey
	)

inline

Definition at line 142 of file wallet.h.

bool CWallet::LoadMinVersion ( int nVersion )

inline

Definition at line 144 of file wallet.h.

DBErrors CWallet::LoadWallet ( bool & fFirstRunRet )

Definition at line 1438 of file wallet.cpp.

void CWallet::LockCoin ( COutPoint & output )

Definition at line 1881 of file wallet.cpp.

void CWallet::MarkDirty ( )

Definition at line 365 of file wallet.cpp.

bool CWallet::NewKeyPool ( )

Definition at line 1533 of file wallet.cpp.

CWallet::TxItems CWallet::OrderedTxItems	(	std::list< CAccountingEntry > &	acentries,
		std::string	strAccount = `""`
	)

Get the wallet's activity log.

Returns: multimap of ordered transactions and accounting entries

Warning: Returned pointers are only valid within the scope of passed acentries

Definition at line 314 of file wallet.cpp.

void CWallet::PrintWallet ( const CBlock & block )

Definition at line 1483 of file wallet.cpp.

void CWallet::ReacceptWalletTransactions ( )

Definition at line 796 of file wallet.cpp.

void CWallet::ResendWalletTransactions ( )

Definition at line 871 of file wallet.cpp.

void CWallet::ReserveKeyFromKeyPool	(	int64 &	nIndex,
		CKeyPool &	keypool
	)

Definition at line 1583 of file wallet.cpp.

void CWallet::ReturnKey ( int64 nIndex )

Definition at line 1636 of file wallet.cpp.

int CWallet::ScanForWalletTransactions	(	CBlockIndex *	pindexStart,
		bool	fUpdate = `false`
	)

Definition at line 774 of file wallet.cpp.

bool CWallet::SelectCoins	(	int64	nTargetValue,
		std::set< std::pair< const CWalletTx *, unsigned int > > &	setCoinsRet,
		int64 &	nValueRet,
		const CCoinControl *	coinControl = `NULL`
	)		const

private

Definition at line 1142 of file wallet.cpp.

bool CWallet::SelectCoinsMinConf	(	int64	nTargetValue,
		int	nConfMine,
		int	nConfTheirs,
		std::vector< COutput >	vCoins,
		std::set< std::pair< const CWalletTx *, unsigned int > > &	setCoinsRet,
		int64 &	nValueRet
	)		const

Definition at line 1043 of file wallet.cpp.

string CWallet::SendMoney	(	CScript	scriptPubKey,
		int64	nValue,
		CWalletTx &	wtxNew,
		bool	fAskFee = `false`
	)

Definition at line 1389 of file wallet.cpp.

string CWallet::SendMoneyToDestination	(	const CTxDestination &	address,
		int64	nValue,
		CWalletTx &	wtxNew,
		bool	fAskFee = `false`
	)

Definition at line 1420 of file wallet.cpp.

bool CWallet::SetAddressBookName	(	const CTxDestination &	address,
		const std::string &	strName
	)

Definition at line 1463 of file wallet.cpp.

void CWallet::SetBestChain ( const CBlockLocator & loc )

Definition at line 160 of file wallet.cpp.

bool CWallet::SetDefaultKey ( const CPubKey & vchPubKey )

Definition at line 1510 of file wallet.cpp.

bool CWallet::SetMaxVersion ( int nVersion )

Definition at line 211 of file wallet.cpp.

bool CWallet::SetMinVersion	(	enum WalletFeature	nVersion,
		CWalletDB *	pwalletdbIn = `NULL`,
		bool	fExplicit = `false`
	)

Definition at line 178 of file wallet.cpp.

bool CWallet::TopUpKeyPool ( )

Definition at line 1557 of file wallet.cpp.

bool CWallet::Unlock ( const SecureString & strWalletPassphrase )

Definition at line 91 of file wallet.cpp.

void CWallet::UnlockAllCoins ( )

Definition at line 1891 of file wallet.cpp.

void CWallet::UnlockCoin ( COutPoint & output )

Definition at line 1886 of file wallet.cpp.

void CWallet::UpdatedTransaction ( const uint256 & hashTx )

Definition at line 1870 of file wallet.cpp.

void CWallet::WalletUpdateSpent ( const CTransaction & prevout )

Definition at line 338 of file wallet.cpp.

Member Data Documentation

CCriticalSection CWallet::cs_wallet

mutable

Definition at line 83 of file wallet.h.

bool CWallet::fFileBacked

Definition at line 85 of file wallet.h.

std::map<CTxDestination, std::string> CWallet::mapAddressBook

Definition at line 119 of file wallet.h.

MasterKeyMap CWallet::mapMasterKeys

Definition at line 92 of file wallet.h.

std::map<uint256, int> CWallet::mapRequestCount

Definition at line 117 of file wallet.h.

std::map<uint256, CWalletTx> CWallet::mapWallet

Definition at line 115 of file wallet.h.

unsigned int CWallet::nMasterKeyMaxID

Definition at line 93 of file wallet.h.

int64 CWallet::nOrderPosNext

Definition at line 116 of file wallet.h.

boost::signals2::signal<void (CWallet *wallet, const CTxDestination &address, const std::string &label, bool isMine, ChangeType status)> CWallet::NotifyAddressBookChanged

Address book entry changed.

Note: called with lock cs_wallet held.

Definition at line 309 of file wallet.h.

boost::signals2::signal<void (CWallet *wallet, const uint256 &hashTx, ChangeType status)> CWallet::NotifyTransactionChanged

Wallet transaction added, removed or updated.

Note: called with lock cs_wallet held.

Definition at line 314 of file wallet.h.

int CWallet::nWalletMaxVersion

private

Definition at line 80 of file wallet.h.

int CWallet::nWalletVersion

private

Definition at line 77 of file wallet.h.

CWalletDB* CWallet::pwalletdbEncryption

private

Definition at line 74 of file wallet.h.

std::set<int64> CWallet::setKeyPool

Definition at line 88 of file wallet.h.

std::set<COutPoint> CWallet::setLockedCoins

Definition at line 123 of file wallet.h.

std::string CWallet::strWalletFile

Definition at line 86 of file wallet.h.

CPubKey CWallet::vchDefaultKey

Definition at line 121 of file wallet.h.

The documentation for this class was generated from the following files:

src/wallet.h
src/wallet.cpp

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation