Basic key store, that keeps keys in an address->secret map. More...

#include <keystore.h>

Inheritance diagram for CBasicKeyStore:

Collaboration diagram for CBasicKeyStore:

Public Member Functions
bool	AddKeyPubKey (const CKey &key, const CPubKey &pubkey)
	Add a key to the store. More...

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

bool	HaveKey (const CKeyID &address) const
	Check whether a key corresponding to a given address is present in the store. More...

bool	HaveKey (const CExchangeKeyID &address) const

std::set< CKeyID >	GetKeys () const

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

virtual bool	AddCScript (const CScript &redeemScript)
	Support for BIP 0013 : see https://github.com/bitcoin/bips/blob/master/bip-0013.mediawiki. More...

virtual bool	HaveCScript (const CScriptID &hash) const

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

virtual bool	AddWatchOnly (const CScript &dest)
	Support for Watch-only addresses. More...

virtual bool	RemoveWatchOnly (const CScript &dest)

virtual bool	HaveWatchOnly (const CScript &dest) const

virtual bool	HaveWatchOnly () const

bool	AddSaplingSpendingKey (const libzcash::SaplingExtendedSpendingKey &sk)
	Sapling. More...

bool	HaveSaplingSpendingKey (const libzcash::SaplingExtendedFullViewingKey &extfvk) const

bool	GetSaplingSpendingKey (const libzcash::SaplingExtendedFullViewingKey &extfvk, libzcash::SaplingExtendedSpendingKey &skOut) const

virtual bool	AddSaplingFullViewingKey (const libzcash::SaplingExtendedFullViewingKey &extfvk)
	Support for Sapling full viewing keys. More...

virtual bool	HaveSaplingFullViewingKey (const libzcash::SaplingIncomingViewingKey &ivk) const

virtual bool	GetSaplingFullViewingKey (const libzcash::SaplingIncomingViewingKey &ivk, libzcash::SaplingExtendedFullViewingKey &extfvkOut) const

virtual bool	AddSaplingIncomingViewingKey (const libzcash::SaplingIncomingViewingKey &ivk, const libzcash::SaplingPaymentAddress &addr)
	Sapling incoming viewing keys. More...

virtual bool	HaveSaplingIncomingViewingKey (const libzcash::SaplingPaymentAddress &addr) const

virtual bool	GetSaplingIncomingViewingKey (const libzcash::SaplingPaymentAddress &addr, libzcash::SaplingIncomingViewingKey &ivkOut) const

bool	GetSaplingExtendedSpendingKey (const libzcash::SaplingPaymentAddress &addr, libzcash::SaplingExtendedSpendingKey &extskOut) const

void	GetSaplingPaymentAddresses (std::set< libzcash::SaplingPaymentAddress > &setAddress) const

Public Member Functions inherited from CKeyStore
virtual	~CKeyStore ()

virtual bool	AddKey (const CKey &key)

Public Attributes
SaplingSpendingKeyMap	mapSaplingSpendingKeys

SaplingFullViewingKeyMap	mapSaplingFullViewingKeys

SaplingIncomingViewingKeyMap	mapSaplingIncomingViewingKeys

Public Attributes inherited from CKeyStore
RecursiveMutex	cs_KeyStore

Protected Attributes
KeyMap	mapKeys

WatchKeyMap	mapWatchKeys

ScriptMap	mapScripts

WatchOnlySet	setWatchOnly

Detailed Description

Basic key store, that keeps keys in an address->secret map.

Definition at line 98 of file keystore.h.

Member Function Documentation

◆ AddCScript()

bool CBasicKeyStore::AddCScript ( const CScript & redeemScript )

virtual

Support for BIP 0013 : see https://github.com/bitcoin/bips/blob/master/bip-0013.mediawiki.

Implements CKeyStore.

Reimplemented in CWallet.

Definition at line 41 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddKeyPubKey()

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

virtual

Add a key to the store.

Implements CKeyStore.

Reimplemented in CWallet.

Definition at line 34 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddSaplingFullViewingKey()

bool CBasicKeyStore::AddSaplingFullViewingKey ( const libzcash::SaplingExtendedFullViewingKey & extfvk )

virtual

Support for Sapling full viewing keys.

Implements CKeyStore.

Definition at line 164 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddSaplingIncomingViewingKey()

bool CBasicKeyStore::AddSaplingIncomingViewingKey	(	const libzcash::SaplingIncomingViewingKey &	ivk,
		const libzcash::SaplingPaymentAddress &	addr
	)

virtual

Sapling incoming viewing keys.

Implements CKeyStore.

Definition at line 177 of file keystore.cpp.

Here is the caller graph for this function:

◆ AddSaplingSpendingKey()

bool CBasicKeyStore::AddSaplingSpendingKey ( const libzcash::SaplingExtendedSpendingKey & sk )

virtual

Sapling.

Implements CKeyStore.

Definition at line 148 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddWatchOnly()

bool CBasicKeyStore::AddWatchOnly ( const CScript & dest )

virtual

Support for Watch-only addresses.

Implements CKeyStore.

Reimplemented in CWallet.

Definition at line 84 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetCScript()

bool CBasicKeyStore::GetCScript	(	const CScriptID &	hash,
		CScript &	redeemScriptOut
	)		const

virtual

Implements CKeyStore.

Definition at line 57 of file keystore.cpp.

◆ GetKey()

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

virtual

Implements CKeyStore.

Definition at line 136 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetKeys()

std::set< CKeyID > CBasicKeyStore::GetKeys ( ) const

virtual

Implements CKeyStore.

Definition at line 126 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetPubKey()

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

virtual

Implements CKeyStore.

Definition at line 19 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSaplingExtendedSpendingKey()

bool CBasicKeyStore::GetSaplingExtendedSpendingKey	(	const libzcash::SaplingPaymentAddress &	addr,
		libzcash::SaplingExtendedSpendingKey &	extskOut
	)		const

Definition at line 240 of file keystore.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSaplingFullViewingKey()

bool CBasicKeyStore::GetSaplingFullViewingKey	(	const libzcash::SaplingIncomingViewingKey &	ivk,
		libzcash::SaplingExtendedFullViewingKey &	extfvkOut
	)		const

virtual

Implements CKeyStore.

Definition at line 215 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetSaplingIncomingViewingKey()

bool CBasicKeyStore::GetSaplingIncomingViewingKey	(	const libzcash::SaplingPaymentAddress &	addr,
		libzcash::SaplingIncomingViewingKey &	ivkOut
	)		const

virtual

Implements CKeyStore.

Definition at line 228 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetSaplingPaymentAddresses()

void CBasicKeyStore::GetSaplingPaymentAddresses ( std::set< libzcash::SaplingPaymentAddress > & setAddress ) const

virtual

Implements CKeyStore.

Definition at line 252 of file keystore.cpp.

Here is the caller graph for this function:

◆ GetSaplingSpendingKey()

bool CBasicKeyStore::GetSaplingSpendingKey	(	const libzcash::SaplingExtendedFullViewingKey &	extfvk,
		libzcash::SaplingExtendedSpendingKey &	skOut
	)		const

virtual

Implements CKeyStore.

Definition at line 204 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveCScript()

bool CBasicKeyStore::HaveCScript ( const CScriptID & hash ) const

virtual

Implements CKeyStore.

Definition at line 51 of file keystore.cpp.

◆ HaveKey() [1/2]

bool CBasicKeyStore::HaveKey ( const CExchangeKeyID & address ) const

◆ HaveKey() [2/2]

bool CBasicKeyStore::HaveKey ( const CKeyID & address ) const

virtual

Check whether a key corresponding to a given address is present in the store.

Implements CKeyStore.

Definition at line 116 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveSaplingFullViewingKey()

bool CBasicKeyStore::HaveSaplingFullViewingKey ( const libzcash::SaplingIncomingViewingKey & ivk ) const

virtual

Implements CKeyStore.

Definition at line 194 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveSaplingIncomingViewingKey()

bool CBasicKeyStore::HaveSaplingIncomingViewingKey ( const libzcash::SaplingPaymentAddress & addr ) const

virtual

Implements CKeyStore.

Definition at line 199 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveSaplingSpendingKey()

bool CBasicKeyStore::HaveSaplingSpendingKey ( const libzcash::SaplingExtendedFullViewingKey & extfvk ) const

virtual

Implements CKeyStore.

Definition at line 189 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveWatchOnly() [1/2]

bool CBasicKeyStore::HaveWatchOnly ( ) const

virtual

Implements CKeyStore.

Definition at line 110 of file keystore.cpp.

Here is the caller graph for this function:

◆ HaveWatchOnly() [2/2]

bool CBasicKeyStore::HaveWatchOnly ( const CScript & dest ) const

virtual

Implements CKeyStore.

Definition at line 104 of file keystore.cpp.

Here is the caller graph for this function:

◆ RemoveWatchOnly()

bool CBasicKeyStore::RemoveWatchOnly ( const CScript & dest )

virtual

Implements CKeyStore.

Reimplemented in CWallet.

Definition at line 94 of file keystore.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ mapKeys

KeyMap CBasicKeyStore::mapKeys

protected

Definition at line 101 of file keystore.h.

◆ mapSaplingFullViewingKeys

SaplingFullViewingKeyMap CBasicKeyStore::mapSaplingFullViewingKeys

Definition at line 110 of file keystore.h.

◆ mapSaplingIncomingViewingKeys

SaplingIncomingViewingKeyMap CBasicKeyStore::mapSaplingIncomingViewingKeys

Definition at line 111 of file keystore.h.

◆ mapSaplingSpendingKeys

SaplingSpendingKeyMap CBasicKeyStore::mapSaplingSpendingKeys

Todo:: future: Move every Sapling map to the new sspkm box.

Definition at line 109 of file keystore.h.

◆ mapScripts

ScriptMap CBasicKeyStore::mapScripts

protected

Definition at line 103 of file keystore.h.

◆ mapWatchKeys

WatchKeyMap CBasicKeyStore::mapWatchKeys

protected

Definition at line 102 of file keystore.h.

◆ setWatchOnly

WatchOnlySet CBasicKeyStore::setWatchOnly

protected

Definition at line 104 of file keystore.h.

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

src/keystore.h
src/keystore.cpp

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

◆ AddCScript()

◆ AddKeyPubKey()

◆ AddSaplingFullViewingKey()

◆ AddSaplingIncomingViewingKey()

◆ AddSaplingSpendingKey()

◆ AddWatchOnly()

◆ GetCScript()

◆ GetKey()

◆ GetKeys()

◆ GetPubKey()

◆ GetSaplingExtendedSpendingKey()

◆ GetSaplingFullViewingKey()

◆ GetSaplingIncomingViewingKey()

◆ GetSaplingPaymentAddresses()

◆ GetSaplingSpendingKey()

◆ HaveCScript()

◆ HaveKey() [1/2]

◆ HaveKey() [2/2]

◆ HaveSaplingFullViewingKey()

◆ HaveSaplingIncomingViewingKey()

◆ HaveSaplingSpendingKey()

◆ HaveWatchOnly() [1/2]

◆ HaveWatchOnly() [2/2]

◆ RemoveWatchOnly()

Member Data Documentation

◆ mapKeys

◆ mapSaplingFullViewingKeys

◆ mapSaplingIncomingViewingKeys

◆ mapSaplingSpendingKeys

◆ mapScripts

◆ mapWatchKeys

◆ setWatchOnly