#include <scriptpubkeyman.h>

Inheritance diagram for wallet::ScriptPubKeyMan:

Collaboration diagram for wallet::ScriptPubKeyMan:

Public Member Functions
	ScriptPubKeyMan (WalletStorage &storage)

virtual	~ScriptPubKeyMan ()=default

virtual util::Result< CTxDestination >	GetNewDestination (const OutputType type)

virtual isminetype	IsMine (const CScript &script) const

virtual bool	CheckDecryptionKey (const CKeyingMaterial &master_key)
	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 util::Result< CTxDestination >	GetReservedDestination (const OutputType type, bool internal, 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 std::vector< WalletDestination >	MarkUnusedAddresses (const CScript &script)
	Mark unused addresses as being used Affects all keys up to and including the one determined by provided script. 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) const

virtual bool	Upgrade (int prev_version, int new_version, bilingual_str &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 std::optional< int64_t >	GetOldestKeyPoolTime () const

virtual unsigned int	GetKeyPoolSize () const

virtual int64_t	GetTimeFirstKey () const

virtual std::unique_ptr< CKeyMetadata >	GetMetadata (const CTxDestination &dest) const

virtual std::unique_ptr< SigningProvider >	GetSolvingProvider (const CScript &script) const

virtual bool	CanProvide (const CScript &script, SignatureData &sigdata)
	Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that, combined with sigdata, can produce solving data. More...

virtual bool	SignTransaction (CMutableTransaction &tx, const std::map< COutPoint, Coin > &coins, int sighash, std::map< int, bilingual_str > &input_errors) const
	Creates new signatures and adds them to the transaction. More...

virtual SigningResult	SignMessage (const std::string &message, const PKHash &pkhash, std::string &str_sig) const
	Sign a message with the given script. More...

virtual std::optional< common::PSBTError >	FillPSBT (PartiallySignedTransaction &psbt, const PrecomputedTransactionData &txdata, int sighash_type=SIGHASH_DEFAULT, bool sign=true, bool bip32derivs=false, int *n_signed=nullptr, bool finalize=true) const
	Adds script and derivation path information to a PSBT, and optionally signs it. More...

virtual uint256	GetID () const

virtual std::unordered_set< CScript, SaltedSipHasher >	GetScriptPubKeys () const
	Returns a set of all the scriptPubKeys that this ScriptPubKeyMan watches. More...

template<typename... Params>
void	WalletLogPrintf (util::ConstevalFormatString< sizeof...(Params)> wallet_fmt, const Params &... params) 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...

boost::signals2::signal< void(const ScriptPubKeyMan *spkm, int64_t new_birth_time)>	NotifyFirstKeyTimeChanged
	Birth time changed. More...

Protected Attributes
WalletStorage &	m_storage

Detailed Description

Definition at line 174 of file scriptpubkeyman.h.

Constructor & Destructor Documentation

◆ ScriptPubKeyMan()

wallet::ScriptPubKeyMan::ScriptPubKeyMan ( WalletStorage & storage )

inlineexplicit

Definition at line 180 of file scriptpubkeyman.h.

◆ ~ScriptPubKeyMan()

virtual wallet::ScriptPubKeyMan::~ScriptPubKeyMan ( )

virtualdefault

Member Function Documentation

◆ CanGetAddresses()

virtual bool wallet::ScriptPubKeyMan::CanGetAddresses ( bool internal = false ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 218 of file scriptpubkeyman.h.

◆ CanProvide()

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

inlinevirtual

Whether this ScriptPubKeyMan can provide a SigningProvider (via GetSolvingProvider) that, combined with sigdata, can produce solving data.

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 241 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ CheckDecryptionKey()

virtual bool wallet::ScriptPubKeyMan::CheckDecryptionKey ( const CKeyingMaterial & master_key )

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 wallet::LegacyDataSPKM, and wallet::DescriptorScriptPubKeyMan.

Definition at line 186 of file scriptpubkeyman.h.

◆ Encrypt()

virtual bool wallet::ScriptPubKeyMan::Encrypt	(	const CKeyingMaterial &	master_key,
		WalletBatch *	batch
	)

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 187 of file scriptpubkeyman.h.

◆ FillPSBT()

virtual std::optional< common::PSBTError > wallet::ScriptPubKeyMan::FillPSBT	(	PartiallySignedTransaction &	psbt,
		const PrecomputedTransactionData &	txdata,
		int	sighash_type = `SIGHASH_DEFAULT`,
		bool	sign = `true`,
		bool	bip32derivs = `false`,
		int *	n_signed = `nullptr`,
		bool	finalize = `true`
	)		const

inlinevirtual

Adds script and derivation path information to a PSBT, and optionally signs it.

Reimplemented in wallet::ExternalSignerScriptPubKeyMan, wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 248 of file scriptpubkeyman.h.

◆ GetID()

virtual uint256 wallet::ScriptPubKeyMan::GetID ( ) const

inlinevirtual

Reimplemented in wallet::LegacyDataSPKM, wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 250 of file scriptpubkeyman.h.

◆ GetKeyPoolSize()

virtual unsigned int wallet::ScriptPubKeyMan::GetKeyPoolSize ( ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 230 of file scriptpubkeyman.h.

◆ GetMetadata()

virtual std::unique_ptr< CKeyMetadata > wallet::ScriptPubKeyMan::GetMetadata ( const CTxDestination & dest ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 234 of file scriptpubkeyman.h.

◆ GetNewDestination()

virtual util::Result< CTxDestination > wallet::ScriptPubKeyMan::GetNewDestination ( const OutputType type )

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 182 of file scriptpubkeyman.h.

Here is the call graph for this function:

◆ GetOldestKeyPoolTime()

virtual std::optional< int64_t > wallet::ScriptPubKeyMan::GetOldestKeyPoolTime ( ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 228 of file scriptpubkeyman.h.

Here is the call graph for this function:

◆ GetReservedDestination()

virtual util::Result< CTxDestination > wallet::ScriptPubKeyMan::GetReservedDestination	(	const OutputType	type,
		bool	internal,
		int64_t &	index,
		CKeyPool &	keypool
	)

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 189 of file scriptpubkeyman.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScriptPubKeys()

virtual std::unordered_set< CScript, SaltedSipHasher > wallet::ScriptPubKeyMan::GetScriptPubKeys ( ) const

inlinevirtual

Returns a set of all the scriptPubKeys that this ScriptPubKeyMan watches.

Reimplemented in wallet::LegacyDataSPKM, and wallet::DescriptorScriptPubKeyMan.

Definition at line 253 of file scriptpubkeyman.h.

◆ GetSolvingProvider()

virtual std::unique_ptr< SigningProvider > wallet::ScriptPubKeyMan::GetSolvingProvider ( const CScript & script ) const

inlinevirtual

Reimplemented in wallet::LegacyDataSPKM, and wallet::DescriptorScriptPubKeyMan.

Definition at line 236 of file scriptpubkeyman.h.

◆ GetTimeFirstKey()

virtual int64_t wallet::ScriptPubKeyMan::GetTimeFirstKey ( ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 232 of file scriptpubkeyman.h.

◆ HavePrivateKeys()

virtual bool wallet::ScriptPubKeyMan::HavePrivateKeys ( ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 223 of file scriptpubkeyman.h.

◆ IsHDEnabled()

virtual bool wallet::ScriptPubKeyMan::IsHDEnabled ( ) const

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 215 of file scriptpubkeyman.h.

◆ IsMine()

virtual isminetype wallet::ScriptPubKeyMan::IsMine ( const CScript & script ) const

inlinevirtual

Reimplemented in wallet::LegacyDataSPKM, and wallet::DescriptorScriptPubKeyMan.

Definition at line 183 of file scriptpubkeyman.h.

◆ KeepDestination()

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

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan.

Definition at line 190 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ MarkUnusedAddresses()

virtual std::vector< WalletDestination > wallet::ScriptPubKeyMan::MarkUnusedAddresses ( const CScript & script )

inlinevirtual

Mark unused addresses as being used Affects all keys up to and including the one determined by provided script.

Parameters

script determines the last key to mark as used

Returns: All of the addresses affected

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 206 of file scriptpubkeyman.h.

◆ ReturnDestination()

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

inlinevirtual

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 191 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ RewriteDB()

virtual void wallet::ScriptPubKeyMan::RewriteDB ( )

inlinevirtual

The action to do when the DB needs rewrite.

Reimplemented in wallet::LegacyScriptPubKeyMan.

Definition at line 226 of file scriptpubkeyman.h.

◆ SetupGeneration()

virtual bool wallet::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 wallet::LegacyScriptPubKeyMan.

Definition at line 212 of file scriptpubkeyman.h.

◆ SignMessage()

virtual SigningResult wallet::ScriptPubKeyMan::SignMessage	(	const std::string &	message,
		const PKHash &	pkhash,
		std::string &	str_sig
	)		const

inlinevirtual

Sign a message with the given script.

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 246 of file scriptpubkeyman.h.

◆ SignTransaction()

virtual bool wallet::ScriptPubKeyMan::SignTransaction	(	CMutableTransaction &	tx,
		const std::map< COutPoint, Coin > &	coins,
		int	sighash,
		std::map< int, bilingual_str > &	input_errors
	)		const

inlinevirtual

Creates new signatures and adds them to the transaction.

Returns whether all inputs were signed

Reimplemented in wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 244 of file scriptpubkeyman.h.

◆ TopUp()

virtual bool wallet::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 wallet::LegacyScriptPubKeyMan, and wallet::DescriptorScriptPubKeyMan.

Definition at line 197 of file scriptpubkeyman.h.

◆ Upgrade()

virtual bool wallet::ScriptPubKeyMan::Upgrade	(	int	prev_version,
		int	new_version,
		bilingual_str &	error
	)

inlinevirtual

Upgrades the wallet to the specified version.

Reimplemented in wallet::LegacyScriptPubKeyMan.

Definition at line 221 of file scriptpubkeyman.h.

◆ WalletLogPrintf()

template<typename... Params>

void wallet::ScriptPubKeyMan::WalletLogPrintf	(	util::ConstevalFormatString< sizeof...(Params)>	wallet_fmt,
		const Params &...	params
	)		const

inline

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

Definition at line 257 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& wallet::ScriptPubKeyMan::m_storage

protected

Definition at line 177 of file scriptpubkeyman.h.

◆ NotifyCanGetAddressesChanged

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

Keypool has new keys.

Definition at line 266 of file scriptpubkeyman.h.

◆ NotifyFirstKeyTimeChanged

boost::signals2::signal<void (const ScriptPubKeyMan* spkm, int64_t new_birth_time)> wallet::ScriptPubKeyMan::NotifyFirstKeyTimeChanged

Birth time changed.

Definition at line 269 of file scriptpubkeyman.h.

◆ NotifyWatchonlyChanged

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

Watch-only address added.

Definition at line 263 of file scriptpubkeyman.h.

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

src/wallet/scriptpubkeyman.h

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ScriptPubKeyMan()

◆ ~ScriptPubKeyMan()

Member Function Documentation

◆ CanGetAddresses()

◆ CanProvide()

◆ CheckDecryptionKey()

◆ Encrypt()

◆ FillPSBT()

◆ GetID()

◆ GetKeyPoolSize()

◆ GetMetadata()

◆ GetNewDestination()

◆ GetOldestKeyPoolTime()

◆ GetReservedDestination()

◆ GetScriptPubKeys()

◆ GetSolvingProvider()

◆ GetTimeFirstKey()

◆ HavePrivateKeys()

◆ IsHDEnabled()

◆ IsMine()

◆ KeepDestination()

◆ MarkUnusedAddresses()

◆ ReturnDestination()

◆ RewriteDB()

◆ SetupGeneration()

◆ SignMessage()

◆ SignTransaction()

◆ TopUp()

◆ Upgrade()

◆ WalletLogPrintf()

Member Data Documentation

◆ m_storage

◆ NotifyCanGetAddressesChanged

◆ NotifyFirstKeyTimeChanged

◆ NotifyWatchonlyChanged