Bitcoin Core  0.19.99
P2P Digital Currency
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ScriptPubKeyMan Class Reference

#include <scriptpubkeyman.h>

Inheritance diagram for ScriptPubKeyMan:
[legend]
Collaboration diagram for ScriptPubKeyMan:
[legend]

Public Member Functions

 ScriptPubKeyMan (WalletStorage &storage)
 
virtual ~ScriptPubKeyMan ()
 
virtual bool GetNewDestination (const OutputType type, CTxDestination &dest, std::string &error)
 
virtual isminetype IsMine (const CScript &script) const
 
virtual bool CheckDecryptionKey (const CKeyingMaterial &master_key, bool accept_no_keys=false)
 Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the keys handled by it. More...
 
virtual bool Encrypt (const CKeyingMaterial &master_key, WalletBatch *batch)
 
virtual bool GetReservedDestination (const OutputType type, bool internal, CTxDestination &address, int64_t &index, CKeyPool &keypool)
 
virtual void KeepDestination (int64_t index, const OutputType &type)
 
virtual void ReturnDestination (int64_t index, bool internal, const CTxDestination &addr)
 
virtual bool TopUp (unsigned int size=0)
 Fills internal address pool. More...
 
virtual void MarkUnusedAddresses (const CScript &script)
 Mark unused addresses as being used. More...
 
virtual bool SetupGeneration (bool force=false)
 Sets up the key generation stuff, i.e. More...
 
virtual bool IsHDEnabled () const
 
virtual bool CanGetAddresses (bool internal=false)
 
virtual bool Upgrade (int prev_version, std::string &error)
 Upgrades the wallet to the specified version. More...
 
virtual bool HavePrivateKeys () const
 
virtual void RewriteDB ()
 The action to do when the DB needs rewrite. More...
 
virtual int64_t GetOldestKeyPoolTime ()
 
virtual size_t KeypoolCountExternalKeys ()
 
virtual unsigned int GetKeyPoolSize () const
 
virtual int64_t GetTimeFirstKey () const
 
virtual const CKeyMetadataGetMetadata (const CTxDestination &dest) const
 
virtual std::unique_ptr< SigningProviderGetSigningProvider (const CScript &script) const
 
virtual bool CanProvide (const CScript &script, SignatureData &sigdata)
 Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSigningProvider) that, combined with sigdata, can produce a valid signature. More...
 
virtual uint256 GetID () const
 
template<typename... Params>
void WalletLogPrintf (std::string fmt, Params... parameters) const
 Prepends the wallet name in logging output to ease debugging in multi-wallet use cases. More...
 

Public Attributes

boost::signals2::signal< void(bool fHaveWatchOnly)> NotifyWatchonlyChanged
 Watch-only address added. More...
 
boost::signals2::signal< void()> NotifyCanGetAddressesChanged
 Keypool has new keys. More...
 

Protected Attributes

WalletStoragem_storage
 

Detailed Description

Definition at line 149 of file scriptpubkeyman.h.

Constructor & Destructor Documentation

◆ ScriptPubKeyMan()

ScriptPubKeyMan::ScriptPubKeyMan ( WalletStorage storage)
inline

Definition at line 155 of file scriptpubkeyman.h.

◆ ~ScriptPubKeyMan()

virtual ScriptPubKeyMan::~ScriptPubKeyMan ( )
inlinevirtual

Definition at line 156 of file scriptpubkeyman.h.

Member Function Documentation

◆ CanGetAddresses()

virtual bool ScriptPubKeyMan::CanGetAddresses ( bool  internal = false)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 187 of file scriptpubkeyman.h.

◆ CanProvide()

virtual bool ScriptPubKeyMan::CanProvide ( const CScript script,
SignatureData sigdata 
)
inlinevirtual

Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSigningProvider) that, combined with sigdata, can produce a valid signature.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 211 of file scriptpubkeyman.h.

◆ CheckDecryptionKey()

virtual bool ScriptPubKeyMan::CheckDecryptionKey ( const CKeyingMaterial master_key,
bool  accept_no_keys = false 
)
inlinevirtual

Check that the given decryption key is valid for this ScriptPubKeyMan, i.e. it decrypts all of the keys handled by it.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 161 of file scriptpubkeyman.h.

◆ Encrypt()

virtual bool ScriptPubKeyMan::Encrypt ( const CKeyingMaterial master_key,
WalletBatch batch 
)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 162 of file scriptpubkeyman.h.

◆ GetID()

virtual uint256 ScriptPubKeyMan::GetID ( ) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 213 of file scriptpubkeyman.h.

Here is the call graph for this function:

◆ GetKeyPoolSize()

virtual unsigned int ScriptPubKeyMan::GetKeyPoolSize ( ) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 200 of file scriptpubkeyman.h.

◆ GetMetadata()

virtual const CKeyMetadata* ScriptPubKeyMan::GetMetadata ( const CTxDestination dest) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 204 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ GetNewDestination()

virtual bool ScriptPubKeyMan::GetNewDestination ( const OutputType  type,
CTxDestination dest,
std::string &  error 
)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 157 of file scriptpubkeyman.h.

◆ GetOldestKeyPoolTime()

virtual int64_t ScriptPubKeyMan::GetOldestKeyPoolTime ( )
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 197 of file scriptpubkeyman.h.

Here is the call graph for this function:

◆ GetReservedDestination()

virtual bool ScriptPubKeyMan::GetReservedDestination ( const OutputType  type,
bool  internal,
CTxDestination address,
int64_t &  index,
CKeyPool keypool 
)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 164 of file scriptpubkeyman.h.

◆ GetSigningProvider()

virtual std::unique_ptr<SigningProvider> ScriptPubKeyMan::GetSigningProvider ( const CScript script) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 206 of file scriptpubkeyman.h.

◆ GetTimeFirstKey()

virtual int64_t ScriptPubKeyMan::GetTimeFirstKey ( ) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 202 of file scriptpubkeyman.h.

◆ HavePrivateKeys()

virtual bool ScriptPubKeyMan::HavePrivateKeys ( ) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 192 of file scriptpubkeyman.h.

◆ IsHDEnabled()

virtual bool ScriptPubKeyMan::IsHDEnabled ( ) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 184 of file scriptpubkeyman.h.

◆ IsMine()

virtual isminetype ScriptPubKeyMan::IsMine ( const CScript script) const
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 158 of file scriptpubkeyman.h.

◆ KeepDestination()

virtual void ScriptPubKeyMan::KeepDestination ( int64_t  index,
const OutputType type 
)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 165 of file scriptpubkeyman.h.

◆ KeypoolCountExternalKeys()

virtual size_t ScriptPubKeyMan::KeypoolCountExternalKeys ( )
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 199 of file scriptpubkeyman.h.

◆ MarkUnusedAddresses()

virtual void ScriptPubKeyMan::MarkUnusedAddresses ( const CScript script)
inlinevirtual

Mark unused addresses as being used.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 175 of file scriptpubkeyman.h.

◆ ReturnDestination()

virtual void ScriptPubKeyMan::ReturnDestination ( int64_t  index,
bool  internal,
const CTxDestination addr 
)
inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 166 of file scriptpubkeyman.h.

◆ RewriteDB()

virtual void ScriptPubKeyMan::RewriteDB ( )
inlinevirtual

The action to do when the DB needs rewrite.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 195 of file scriptpubkeyman.h.

◆ SetupGeneration()

virtual bool ScriptPubKeyMan::SetupGeneration ( bool  force = false)
inlinevirtual

Sets up the key generation stuff, i.e.

generates new HD seeds and sets them as active. Returns false if already setup or setup fails, true if setup is successful Set force=true to make it re-setup if already setup, used for upgrades

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 181 of file scriptpubkeyman.h.

◆ TopUp()

virtual bool ScriptPubKeyMan::TopUp ( unsigned int  size = 0)
inlinevirtual

Fills internal address pool.

Use within ScriptPubKeyMan implementations should be used sparingly and only when something from the address pool is removed, excluding GetNewDestination and GetReservedDestination. External wallet code is primarily responsible for topping up prior to fetching new addresses

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 172 of file scriptpubkeyman.h.

◆ Upgrade()

virtual bool ScriptPubKeyMan::Upgrade ( int  prev_version,
std::string &  error 
)
inlinevirtual

Upgrades the wallet to the specified version.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 190 of file scriptpubkeyman.h.

◆ WalletLogPrintf()

template<typename... Params>
void ScriptPubKeyMan::WalletLogPrintf ( std::string  fmt,
Params...  parameters 
) const
inline

Prepends the wallet name in logging output to ease debugging in multi-wallet use cases.

Definition at line 217 of file scriptpubkeyman.h.

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

Member Data Documentation

◆ m_storage

WalletStorage& ScriptPubKeyMan::m_storage
protected

Definition at line 152 of file scriptpubkeyman.h.

◆ NotifyCanGetAddressesChanged

boost::signals2::signal<void ()> ScriptPubKeyMan::NotifyCanGetAddressesChanged

Keypool has new keys.

Definition at line 225 of file scriptpubkeyman.h.

◆ NotifyWatchonlyChanged

boost::signals2::signal<void (bool fHaveWatchOnly)> ScriptPubKeyMan::NotifyWatchonlyChanged

Watch-only address added.

Definition at line 219 of file scriptpubkeyman.h.


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