A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet. More...

#include <scriptpubkeyman.h>

Inheritance diagram for ScriptPubKeyMan:

Collaboration diagram for ScriptPubKeyMan:

Public Member Functions
	ScriptPubKeyMan (WalletStorage &storage)

virtual	~ScriptPubKeyMan ()

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

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. 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) const
	Returns true if the wallet can give out new addresses. More...

virtual bool	Upgrade (int prev_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 int64_t	GetOldestKeyPoolTime () const

virtual size_t	KeypoolCountExternalKeys () 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, SigHashType sighash, std::map< int, std::string > &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 TransactionError	FillPSBT (PartiallySignedTransaction &psbt, SigHashType sighash_type=SigHashType().withForkId(), bool sign=true, bool bip32derivs=false) const
	Adds script and derivation path information to a PSBT, and optionally signs it. More...

virtual uint256	GetID () const

virtual void	SetInternal (bool internal)

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
WalletStorage &	m_storage

Detailed Description

A class implementing ScriptPubKeyMan manages some (or all) scriptPubKeys used in a wallet.

It contains the scripts and keys related to the scriptPubKeys it manages. A ScriptPubKeyMan will be able to give out scriptPubKeys to be used, as well as marking when a scriptPubKey has been used. It also handles when and how to store a scriptPubKey and its related scripts and keys, including encryption.

Definition at line 172 of file scriptpubkeyman.h.

Constructor & Destructor Documentation

◆ ScriptPubKeyMan()

ScriptPubKeyMan::ScriptPubKeyMan ( WalletStorage & storage )

inlineexplicit

Definition at line 177 of file scriptpubkeyman.h.

◆ ~ScriptPubKeyMan()

virtual ScriptPubKeyMan::~ScriptPubKeyMan ( )

inlinevirtual

Definition at line 178 of file scriptpubkeyman.h.

Member Function Documentation

◆ CanGetAddresses()

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

inlinevirtual

Returns true if the wallet can give out new addresses.

This means it has keys in the keypool or can generate new keys.

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 232 of file scriptpubkeyman.h.

◆ CanProvide()

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

Definition at line 266 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, and DescriptorScriptPubKeyMan.

Definition at line 187 of file scriptpubkeyman.h.

◆ Encrypt()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 191 of file scriptpubkeyman.h.

◆ FillPSBT()

virtual TransactionError ScriptPubKeyMan::FillPSBT	(	PartiallySignedTransaction &	psbt,
		SigHashType	sighash_type = `SigHashType().withForkId()`,
		bool	sign = `true`,
		bool	bip32derivs = `false`
	)		const

inlinevirtual

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

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 291 of file scriptpubkeyman.h.

◆ GetID()

virtual uint256 ScriptPubKeyMan::GetID ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 297 of file scriptpubkeyman.h.

◆ GetKeyPoolSize()

virtual unsigned int ScriptPubKeyMan::GetKeyPoolSize ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 247 of file scriptpubkeyman.h.

◆ GetMetadata()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 252 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ GetNewDestination()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 180 of file scriptpubkeyman.h.

Here is the call graph for this function:

◆ GetOldestKeyPoolTime()

virtual int64_t ScriptPubKeyMan::GetOldestKeyPoolTime ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 244 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, and DescriptorScriptPubKeyMan.

Definition at line 196 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ GetSolvingProvider()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 257 of file scriptpubkeyman.h.

◆ GetTimeFirstKey()

virtual int64_t ScriptPubKeyMan::GetTimeFirstKey ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 249 of file scriptpubkeyman.h.

◆ HavePrivateKeys()

virtual bool ScriptPubKeyMan::HavePrivateKeys ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 239 of file scriptpubkeyman.h.

◆ IsHDEnabled()

virtual bool ScriptPubKeyMan::IsHDEnabled ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 226 of file scriptpubkeyman.h.

◆ IsMine()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 183 of file scriptpubkeyman.h.

◆ KeepDestination()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 201 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ KeypoolCountExternalKeys()

virtual size_t ScriptPubKeyMan::KeypoolCountExternalKeys ( ) const

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 246 of file scriptpubkeyman.h.

◆ MarkUnusedAddresses()

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

inlinevirtual

Mark unused addresses as being used.

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 215 of file scriptpubkeyman.h.

◆ ReturnDestination()

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

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 202 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ RewriteDB()

virtual void ScriptPubKeyMan::RewriteDB ( )

inlinevirtual

The action to do when the DB needs rewrite.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 242 of file scriptpubkeyman.h.

◆ SetInternal()

virtual void ScriptPubKeyMan::SetInternal ( bool internal )

inlinevirtual

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 299 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 223 of file scriptpubkeyman.h.

◆ SignMessage()

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

inlinevirtual

Sign a message with the given script.

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 281 of file scriptpubkeyman.h.

◆ SignTransaction()

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

inlinevirtual

Creates new signatures and adds them to the transaction.

Returns whether all inputs were signed

Reimplemented in LegacyScriptPubKeyMan, and DescriptorScriptPubKeyMan.

Definition at line 275 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, and DescriptorScriptPubKeyMan.

Definition at line 212 of file scriptpubkeyman.h.

Here is the caller graph for this function:

◆ Upgrade()

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

inlinevirtual

Upgrades the wallet to the specified version.

Reimplemented in LegacyScriptPubKeyMan.

Definition at line 235 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 306 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 174 of file scriptpubkeyman.h.

◆ NotifyCanGetAddressesChanged

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

Keypool has new keys.

Definition at line 315 of file scriptpubkeyman.h.

◆ NotifyWatchonlyChanged

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

Watch-only address added.

Definition at line 312 of file scriptpubkeyman.h.

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

/work/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()

◆ GetSolvingProvider()

◆ GetTimeFirstKey()

◆ HavePrivateKeys()

◆ IsHDEnabled()

◆ IsMine()

◆ KeepDestination()

◆ KeypoolCountExternalKeys()

◆ MarkUnusedAddresses()

◆ ReturnDestination()

◆ RewriteDB()

◆ SetInternal()

◆ SetupGeneration()

◆ SignMessage()

◆ SignTransaction()

◆ TopUp()

◆ Upgrade()

◆ WalletLogPrintf()

Member Data Documentation

◆ m_storage

◆ NotifyCanGetAddressesChanged

◆ NotifyWatchonlyChanged