Bitcoin Core  22.99.0
P2P Digital Currency
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
wallet::WalletBatch Class Reference

Access to the wallet database. More...

#include <walletdb.h>

Collaboration diagram for wallet::WalletBatch:
[legend]

Public Member Functions

 WalletBatch (WalletDatabase &database, bool _fFlushOnClose=true)
 
 WalletBatch (const WalletBatch &)=delete
 
WalletBatchoperator= (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 WriteDescriptorLastHardenedCache (const CExtPubKey &xpub, const uint256 &desc_id, uint32_t key_exp_index)
 
bool WriteDescriptorCacheItems (const uint256 &desc_id, const DescriptorCache &cache)
 
bool WriteLockedUTXO (const COutPoint &output)
 
bool EraseLockedUTXO (const COutPoint &output)
 
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)
 
bool EraseActiveScriptPubKeyMan (uint8_t type, bool internal)
 
DBErrors LoadWallet (CWallet *pwallet)
 
DBErrors FindWalletTx (std::vector< uint256 > &vTxHash, 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 IsKeyType (const std::string &strType)
 

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

std::unique_ptr< DatabaseBatchm_batch
 
WalletDatabasem_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 180 of file walletdb.h.

Constructor & Destructor Documentation

◆ WalletBatch() [1/2]

wallet::WalletBatch::WalletBatch ( WalletDatabase database,
bool  _fFlushOnClose = true 
)
inlineexplicit

Definition at line 210 of file walletdb.h.

◆ WalletBatch() [2/2]

wallet::WalletBatch::WalletBatch ( const WalletBatch )
delete

Member Function Documentation

◆ EraseActiveScriptPubKeyMan()

bool wallet::WalletBatch::EraseActiveScriptPubKeyMan ( uint8_t  type,
bool  internal 
)

Definition at line 215 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseDestData()

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

Erase destination data tuple from wallet database.

Definition at line 1073 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseIC()

template<typename K >
bool wallet::WalletBatch::EraseIC ( const K &  key)
inlineprivate

Definition at line 197 of file walletdb.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseLockedUTXO()

bool wallet::WalletBatch::EraseLockedUTXO ( const COutPoint output)

Definition at line 294 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseName()

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

Definition at line 73 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ErasePool()

bool wallet::WalletBatch::ErasePool ( int64_t  nPool)

Definition at line 199 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ErasePurpose()

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

Definition at line 85 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseTx()

bool wallet::WalletBatch::EraseTx ( uint256  hash)

Definition at line 95 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EraseWatchOnly()

bool wallet::WalletBatch::EraseWatchOnly ( const CScript script)

Definition at line 164 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FindWalletTx()

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

Definition at line 952 of file walletdb.cpp.

Here is the caller graph for this function:

◆ IsKeyType()

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

Definition at line 756 of file walletdb.cpp.

Here is the caller graph for this function:

◆ LoadWallet()

DBErrors wallet::WalletBatch::LoadWallet ( CWallet pwallet)

Definition at line 762 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

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

◆ ReadBestBlock()

bool wallet::WalletBatch::ReadBestBlock ( CBlockLocator locator)

Definition at line 178 of file walletdb.cpp.

Here is the caller graph for this function:

◆ ReadPool()

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

Definition at line 189 of file walletdb.cpp.

Here is the caller graph for this function:

◆ TxnAbort()

bool wallet::WalletBatch::TxnAbort ( )

Abort current transaction.

Definition at line 1099 of file walletdb.cpp.

Here is the caller graph for this function:

◆ TxnBegin()

bool wallet::WalletBatch::TxnBegin ( )

Begin a new transaction.

Definition at line 1089 of file walletdb.cpp.

Here is the caller graph for this function:

◆ TxnCommit()

bool wallet::WalletBatch::TxnCommit ( )

Commit current transaction.

Definition at line 1094 of file walletdb.cpp.

Here is the caller graph for this function:

◆ WriteActiveScriptPubKeyMan()

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

Definition at line 209 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteBestBlock()

bool wallet::WalletBatch::WriteBestBlock ( const CBlockLocator locator)

Definition at line 172 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteCryptedDescriptorKey()

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

Definition at line 232 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteCryptedKey()

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

Definition at line 120 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteCScript()

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

Definition at line 151 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptor()

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

Definition at line 241 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptorCacheItems()

bool wallet::WalletBatch::WriteDescriptorCacheItems ( const uint256 desc_id,
const DescriptorCache cache 
)

Definition at line 267 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptorDerivedCache()

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

Definition at line 246 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptorKey()

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

Definition at line 221 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptorLastHardenedCache()

bool wallet::WalletBatch::WriteDescriptorLastHardenedCache ( const CExtPubKey xpub,
const uint256 desc_id,
uint32_t  key_exp_index 
)

Definition at line 260 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDescriptorParentCache()

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

Definition at line 253 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteDestData()

bool wallet::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 1068 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteHDChain()

bool wallet::WalletBatch::WriteHDChain ( const CHDChain chain)

write the hdchain model (external chain child index counter)

Definition at line 1079 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteIC()

template<typename K , typename T >
bool wallet::WalletBatch::WriteIC ( const K &  key,
const T &  value,
bool  fOverwrite = true 
)
inlineprivate

Definition at line 184 of file walletdb.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteKey()

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

Definition at line 105 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteKeyMetadata()

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

Definition at line 100 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteLockedUTXO()

bool wallet::WalletBatch::WriteLockedUTXO ( const COutPoint output)

Definition at line 289 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteMasterKey()

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

Definition at line 146 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteMinVersion()

bool wallet::WalletBatch::WriteMinVersion ( int  nVersion)

Definition at line 204 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteName()

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

Definition at line 68 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteOrderPosNext()

bool wallet::WalletBatch::WriteOrderPosNext ( int64_t  nOrderPosNext)

Definition at line 184 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WritePool()

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

Definition at line 194 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WritePurpose()

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

Definition at line 80 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteTx()

bool wallet::WalletBatch::WriteTx ( const CWalletTx wtx)

Definition at line 90 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteWalletFlags()

bool wallet::WalletBatch::WriteWalletFlags ( const uint64_t  flags)

Definition at line 1084 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ WriteWatchOnly()

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

Definition at line 156 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ZapSelectTx()

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

Definition at line 1003 of file walletdb.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_batch

std::unique_ptr<DatabaseBatch> wallet::WalletBatch::m_batch
private

Definition at line 284 of file walletdb.h.

◆ m_database

WalletDatabase& wallet::WalletBatch::m_database
private

Definition at line 285 of file walletdb.h.


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