Access to the wallet database. More...

#include <walletdb.h>

Collaboration diagram for WalletBatch:

Public Member Functions
	WalletBatch (WalletDatabase &database, const char *pszMode="r+", bool _fFlushOnClose=true)

	WalletBatch (const WalletBatch &)=delete

WalletBatch &	operator= (const WalletBatch &)=delete

bool	WriteName (const std::string &strAddress, const std::string &strName)

bool	EraseName (const std::string &strAddress)

bool	WritePurpose (const std::string &strAddress, const std::string &purpose)

bool	ErasePurpose (const std::string &strAddress)

bool	WriteTx (const CWalletTx &wtx)

bool	EraseTx (uint256 hash)

bool	WriteKeyMetadata (const CKeyMetadata &meta, const CPubKey &pubkey, const bool overwrite)

bool	WriteKey (const CPubKey &vchPubKey, const CPrivKey &vchPrivKey, const CKeyMetadata &keyMeta)

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

bool	WriteMasterKey (unsigned int nID, const CMasterKey &kMasterKey)

bool	WriteCScript (const uint160 &hash, const CScript &redeemScript)

bool	WriteWatchOnly (const CScript &script, const CKeyMetadata &keymeta)

bool	EraseWatchOnly (const CScript &script)

bool	WriteBestBlock (const CBlockLocator &locator)

bool	ReadBestBlock (CBlockLocator &locator)

bool	WriteOrderPosNext (int64_t nOrderPosNext)

bool	ReadPool (int64_t nPool, CKeyPool &keypool)

bool	WritePool (int64_t nPool, const CKeyPool &keypool)

bool	ErasePool (int64_t nPool)

bool	WriteMinVersion (int nVersion)

bool	WriteDescriptorKey (const uint256 &desc_id, const CPubKey &pubkey, const CPrivKey &privkey)

bool	WriteCryptedDescriptorKey (const uint256 &desc_id, const CPubKey &pubkey, const std::vector< unsigned char > &secret)

bool	WriteDescriptor (const uint256 &desc_id, const WalletDescriptor &descriptor)

bool	WriteDescriptorDerivedCache (const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index, uint32_t der_index)

bool	WriteDescriptorParentCache (const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)

bool	WriteDestData (const std::string &address, const std::string &key, const std::string &value)
	Write destination data key,value tuple to database. More...

bool	EraseDestData (const std::string &address, const std::string &key)
	Erase destination data tuple from wallet database. More...

bool	WriteActiveScriptPubKeyMan (uint8_t type, const uint256 &id, bool internal)

DBErrors	LoadWallet (CWallet *pwallet)

DBErrors	FindWalletTx (std::vector< uint256 > &vTxHash, std::list< CWalletTx > &vWtx)

DBErrors	ZapWalletTx (std::list< CWalletTx > &vWtx)

DBErrors	ZapSelectTx (std::vector< uint256 > &vHashIn, std::vector< uint256 > &vHashOut)

bool	WriteHDChain (const CHDChain &chain)
	write the hdchain model (external chain child index counter) More...

bool	WriteWalletFlags (const uint64_t flags)

bool	TxnBegin ()
	Begin a new transaction. More...

bool	TxnCommit ()
	Commit current transaction. More...

bool	TxnAbort ()
	Abort current transaction. More...

Static Public Member Functions
static bool	Recover (const fs::path &wallet_path, void callbackDataIn, bool(recoverKVcallback)(void *callbackData, CDataStream ssKey, CDataStream ssValue), std::string &out_backup_filename)

static bool	Recover (const fs::path &wallet_path, std::string &out_backup_filename)

static bool	RecoverKeysOnlyFilter (void *callbackData, CDataStream ssKey, CDataStream ssValue)

static bool	IsKeyType (const std::string &strType)

static bool	VerifyEnvironment (const fs::path &wallet_path, bilingual_str &errorStr)

static bool	VerifyDatabaseFile (const fs::path &wallet_path, std::vector< bilingual_str > &warnings, bilingual_str &errorStr)

Private Member Functions
template<typename K , typename T >
bool	WriteIC (const K &key, const T &value, bool fOverwrite=true)

template<typename K >
bool	EraseIC (const K &key)

Private Attributes
BerkeleyBatch	m_batch

WalletDatabase &	m_database

Detailed Description

Access to the wallet database.

Opens the database and provides read and write access to it. Each read and write is its own transaction. Multiple operation transactions can be started using TxnBegin() and committed using TxnCommit() Otherwise the transaction will be committed when the object goes out of scope. Optionally (on by default) it will flush to disk on close. Every 1000 writes will automatically trigger a flush to disk.

Definition at line 186 of file walletdb.h.

Constructor & Destructor Documentation

◆ WalletBatch() [1/2]

WalletBatch::WalletBatch	(	WalletDatabase &	database,
		const char *	pszMode = `"r+"`,
		bool	_fFlushOnClose = `true`
	)

inlineexplicit

Definition at line 216 of file walletdb.h.

Here is the call graph for this function:

◆ WalletBatch() [2/2]

WalletBatch::WalletBatch ( const WalletBatch & )

delete

Member Function Documentation

◆ EraseDestData()

bool WalletBatch::EraseDestData	(	const std::string &	address,
		const std::string &	key
	)

Erase destination data tuple from wallet database.

Definition at line 1033 of file walletdb.cpp.

Here is the caller graph for this function:

◆ EraseIC()

template<typename K >

bool WalletBatch::EraseIC ( const K & key )

inlineprivate

Definition at line 203 of file walletdb.h.

◆ EraseName()

bool WalletBatch::EraseName ( const std::string & strAddress )

Definition at line 64 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ErasePool()

bool WalletBatch::ErasePool ( int64_t nPool )

Definition at line 190 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ErasePurpose()

bool WalletBatch::ErasePurpose ( const std::string & strAddress )

Definition at line 76 of file walletdb.cpp.

Here is the caller graph for this function:

◆ EraseTx()

bool WalletBatch::EraseTx ( uint256 hash )

Definition at line 86 of file walletdb.cpp.

◆ EraseWatchOnly()

bool WalletBatch::EraseWatchOnly ( const CScript & script )

Definition at line 155 of file walletdb.cpp.

◆ FindWalletTx()

DBErrors WalletBatch::FindWalletTx	(	std::vector< uint256 > &	vTxHash,
		std::list< CWalletTx > &	vWtx
	)

Definition at line 839 of file walletdb.cpp.

Here is the call graph for this function:

◆ IsKeyType()

bool WalletBatch::IsKeyType ( const std::string & strType )

static

Definition at line 675 of file walletdb.cpp.

◆ LoadWallet()

DBErrors WalletBatch::LoadWallet ( CWallet * pwallet )

Definition at line 681 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

WalletBatch& WalletBatch::operator= ( const WalletBatch & )

delete

◆ ReadBestBlock()

bool WalletBatch::ReadBestBlock ( CBlockLocator & locator )

Definition at line 169 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ReadPool()

bool WalletBatch::ReadPool	(	int64_t	nPool,
		CKeyPool &	keypool
	)

Definition at line 180 of file walletdb.cpp.

Here is the caller graph for this function:

◆ Recover() [1/2]

bool WalletBatch::Recover	(	const fs::path &	wallet_path,
		void *	callbackDataIn,
		bool()(void callbackData, CDataStream ssKey, CDataStream ssValue)	recoverKVcallback,
		std::string &	out_backup_filename
	)

static

Definition at line 982 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Recover() [2/2]

bool WalletBatch::Recover	(	const fs::path &	wallet_path,
		std::string &	out_backup_filename
	)

static

Definition at line 987 of file walletdb.cpp.

Here is the call graph for this function:

◆ RecoverKeysOnlyFilter()

bool WalletBatch::RecoverKeysOnlyFilter	(	void *	callbackData,
		CDataStream	ssKey,
		CDataStream	ssValue
	)

static

Definition at line 994 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TxnAbort()

bool WalletBatch::TxnAbort ( )

Abort current transaction.

Definition at line 1059 of file walletdb.cpp.

Here is the caller graph for this function:

◆ TxnBegin()

bool WalletBatch::TxnBegin ( )

Begin a new transaction.

Definition at line 1049 of file walletdb.cpp.

Here is the caller graph for this function:

◆ TxnCommit()

bool WalletBatch::TxnCommit ( )

Commit current transaction.

Definition at line 1054 of file walletdb.cpp.

Here is the caller graph for this function:

◆ VerifyDatabaseFile()

bool WalletBatch::VerifyDatabaseFile	(	const fs::path &	wallet_path,
		std::vector< bilingual_str > &	warnings,
		bilingual_str &	errorStr
	)

static

Definition at line 1023 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VerifyEnvironment()

bool WalletBatch::VerifyEnvironment	(	const fs::path &	wallet_path,
		bilingual_str &	errorStr
	)

static

Definition at line 1018 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteActiveScriptPubKeyMan()

bool WalletBatch::WriteActiveScriptPubKeyMan	(	uint8_t	type,
		const uint256 &	id,
		bool	internal
	)

Definition at line 200 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteBestBlock()

bool WalletBatch::WriteBestBlock ( const CBlockLocator & locator )

Definition at line 163 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteCryptedDescriptorKey()

bool WalletBatch::WriteCryptedDescriptorKey	(	const uint256 &	desc_id,
		const CPubKey &	pubkey,
		const std::vector< unsigned char > &	secret
	)

Definition at line 217 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteCryptedKey()

bool WalletBatch::WriteCryptedKey	(	const CPubKey &	vchPubKey,
		const std::vector< unsigned char > &	vchCryptedSecret,
		const CKeyMetadata &	keyMeta
	)

Definition at line 111 of file walletdb.cpp.

Here is the call graph for this function:

◆ WriteCScript()

bool WalletBatch::WriteCScript	(	const uint160 &	hash,
		const CScript &	redeemScript
	)

Definition at line 142 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteDescriptor()

bool WalletBatch::WriteDescriptor	(	const uint256 &	desc_id,
		const WalletDescriptor &	descriptor
	)

Definition at line 226 of file walletdb.cpp.

◆ WriteDescriptorDerivedCache()

bool WalletBatch::WriteDescriptorDerivedCache	(	const CExtPubKey &	xpub,
		const uint256 &	desc_id,
		uint32_t	key_exp_index,
		uint32_t	der_index
	)

Definition at line 231 of file walletdb.cpp.

Here is the call graph for this function:

◆ WriteDescriptorKey()

bool WalletBatch::WriteDescriptorKey	(	const uint256 &	desc_id,
		const CPubKey &	pubkey,
		const CPrivKey &	privkey
	)

Definition at line 206 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteDescriptorParentCache()

bool WalletBatch::WriteDescriptorParentCache	(	const CExtPubKey &	xpub,
		const uint256 &	desc_id,
		uint32_t	key_exp_index
	)

Definition at line 238 of file walletdb.cpp.

Here is the call graph for this function:

◆ WriteDestData()

bool WalletBatch::WriteDestData	(	const std::string &	address,
		const std::string &	key,
		const std::string &	value
	)

Write destination data key,value tuple to database.

Definition at line 1028 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteHDChain()

bool WalletBatch::WriteHDChain ( const CHDChain & chain )

write the hdchain model (external chain child index counter)

Definition at line 1039 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteIC()

template<typename K , typename T >

bool WalletBatch::WriteIC	(	const K &	key,
		const T &	value,
		bool	fOverwrite = `true`
	)

inlineprivate

Definition at line 190 of file walletdb.h.

◆ WriteKey()

bool WalletBatch::WriteKey	(	const CPubKey &	vchPubKey,
		const CPrivKey &	vchPrivKey,
		const CKeyMetadata &	keyMeta
	)

Definition at line 96 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteKeyMetadata()

bool WalletBatch::WriteKeyMetadata	(	const CKeyMetadata &	meta,
		const CPubKey &	pubkey,
		const bool	overwrite
	)

Definition at line 91 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteMasterKey()

bool WalletBatch::WriteMasterKey	(	unsigned int	nID,
		const CMasterKey &	kMasterKey
	)

Definition at line 137 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteMinVersion()

bool WalletBatch::WriteMinVersion ( int nVersion )

Definition at line 195 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteName()

bool WalletBatch::WriteName	(	const std::string &	strAddress,
		const std::string &	strName
	)

Definition at line 59 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteOrderPosNext()

bool WalletBatch::WriteOrderPosNext ( int64_t nOrderPosNext )

Definition at line 175 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WritePool()

bool WalletBatch::WritePool	(	int64_t	nPool,
		const CKeyPool &	keypool
	)

Definition at line 185 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WritePurpose()

bool WalletBatch::WritePurpose	(	const std::string &	strAddress,
		const std::string &	purpose
	)

Definition at line 71 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteTx()

bool WalletBatch::WriteTx ( const CWalletTx & wtx )

Definition at line 81 of file walletdb.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteWalletFlags()

bool WalletBatch::WriteWalletFlags ( const uint64_t flags )

Definition at line 1044 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteWatchOnly()

bool WalletBatch::WriteWatchOnly	(	const CScript &	script,
		const CKeyMetadata &	keymeta
	)

Definition at line 147 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ZapSelectTx()

DBErrors WalletBatch::ZapSelectTx	(	std::vector< uint256 > &	vHashIn,
		std::vector< uint256 > &	vHashOut
	)

Definition at line 894 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ZapWalletTx()

DBErrors WalletBatch::ZapWalletTx ( std::list< CWalletTx > & vWtx )

Definition at line 932 of file walletdb.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_batch

BerkeleyBatch WalletBatch::m_batch

private

Definition at line 295 of file walletdb.h.

◆ m_database

WalletDatabase& WalletBatch::m_database

private

Definition at line 296 of file walletdb.h.

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

src/wallet/walletdb.h
src/wallet/walletdb.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WalletBatch() [1/2]

◆ WalletBatch() [2/2]

Member Function Documentation

◆ EraseDestData()

◆ EraseIC()

◆ EraseName()

◆ ErasePool()

◆ ErasePurpose()

◆ EraseTx()

◆ EraseWatchOnly()

◆ FindWalletTx()

◆ IsKeyType()

◆ LoadWallet()

◆ operator=()

◆ ReadBestBlock()

◆ ReadPool()

◆ Recover() [1/2]

◆ Recover() [2/2]

◆ RecoverKeysOnlyFilter()

◆ TxnAbort()

◆ TxnBegin()

◆ TxnCommit()

◆ VerifyDatabaseFile()

◆ VerifyEnvironment()

◆ WriteActiveScriptPubKeyMan()

◆ WriteBestBlock()

◆ WriteCryptedDescriptorKey()

◆ WriteCryptedKey()

◆ WriteCScript()

◆ WriteDescriptor()

◆ WriteDescriptorDerivedCache()

◆ WriteDescriptorKey()

◆ WriteDescriptorParentCache()

◆ WriteDestData()

◆ WriteHDChain()

◆ WriteIC()

◆ WriteKey()

◆ WriteKeyMetadata()

◆ WriteMasterKey()

◆ WriteMinVersion()

◆ WriteName()

◆ WriteOrderPosNext()

◆ WritePool()

◆ WritePurpose()

◆ WriteTx()

◆ WriteWalletFlags()

◆ WriteWatchOnly()

◆ ZapSelectTx()

◆ ZapWalletTx()

Member Data Documentation

◆ m_batch

◆ m_database