Interface for parsed descriptor objects. More...

#include <descriptor.h>

Inheritance diagram for Descriptor:

Public Member Functions
virtual	~Descriptor ()=default

virtual bool	IsRange () const =0
	Whether the expansion of this descriptor depends on the position. More...

virtual bool	IsSolvable () const =0
	Whether this descriptor has all information about signing ignoring lack of private keys. More...

virtual std::string	ToString (bool compat_format=false) const =0
	Convert the descriptor back to a string, undoing parsing. More...

virtual bool	IsSingleType () const =0
	Whether this descriptor will return one scriptPubKey or multiple (aka is or is not combo) More...

virtual bool	ToPrivateString (const SigningProvider &provider, std::string &out) const =0
	Convert the descriptor to a private string. More...

virtual bool	ToNormalizedString (const SigningProvider &provider, std::string &out, const DescriptorCache *cache=nullptr) const =0
	Convert the descriptor to a normalized string. More...

virtual bool	Expand (int pos, const SigningProvider &provider, std::vector< CScript > &output_scripts, FlatSigningProvider &out, DescriptorCache *write_cache=nullptr) const =0
	Expand a descriptor at a specified position. More...

virtual bool	ExpandFromCache (int pos, const DescriptorCache &read_cache, std::vector< CScript > &output_scripts, FlatSigningProvider &out) const =0
	Expand a descriptor at a specified position using cached expansion data. More...

virtual void	ExpandPrivate (int pos, const SigningProvider &provider, FlatSigningProvider &out) const =0
	Expand the private key for a descriptor at a specified position, if possible. More...

virtual std::optional< OutputType >	GetOutputType () const =0

virtual std::optional< int64_t >	ScriptSize () const =0
	Get the size of the scriptPubKey for this descriptor. More...

virtual std::optional< int64_t >	MaxSatisfactionWeight (bool use_max_sig) const =0
	Get the maximum size of a satisfaction for this descriptor, in weight units. More...

virtual std::optional< int64_t >	MaxSatisfactionElems () const =0
	Get the maximum size number of stack elements for satisfying this descriptor. More...

virtual void	GetPubKeys (std::set< CPubKey > &pubkeys, std::set< CExtPubKey > &ext_pubs) const =0
	Return all (extended) public keys for this descriptor, including any from subdescriptors. More...

Detailed Description

Interface for parsed descriptor objects.

Descriptors are strings that describe a set of scriptPubKeys, together with all information necessary to solve them. By combining all information into one, they avoid the need to separately import keys and scripts.

Descriptors may be ranged, which occurs when the public keys inside are specified in the form of HD chains (xpubs).

Descriptors always represent public information - public keys and scripts - but in cases where private keys need to be conveyed along with a descriptor, they can be included inside by changing public keys to private keys (WIF format), and changing xpubs by xprvs.

Reference documentation about the descriptor language can be found in doc/descriptors.md.

Definition at line 98 of file descriptor.h.

Constructor & Destructor Documentation

◆ ~Descriptor()

virtual Descriptor::~Descriptor ( )

virtualdefault

Member Function Documentation

◆ Expand()

virtual bool Descriptor::Expand	(	int	pos,
		const SigningProvider &	provider,
		std::vector< CScript > &	output_scripts,
		FlatSigningProvider &	out,
		DescriptorCache *	write_cache = `nullptr`
	)		const

pure virtual

Expand a descriptor at a specified position.

Parameters

[in]	pos	The position at which to expand the descriptor. If IsRange() is false, this is ignored.
[in]	provider	The provider to query for private keys in case of hardened derivation.
[out]	output_scripts	The expanded scriptPubKeys.
[out]	out	Scripts and public keys necessary for solving the expanded scriptPubKeys (may be equal to `provider`).
[out]	write_cache	Cache data necessary to evaluate the descriptor at this point without access to private keys.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ExpandFromCache()

virtual bool Descriptor::ExpandFromCache	(	int	pos,
		const DescriptorCache &	read_cache,
		std::vector< CScript > &	output_scripts,
		FlatSigningProvider &	out
	)		const

pure virtual

Expand a descriptor at a specified position using cached expansion data.

Parameters

[in]	pos	The position at which to expand the descriptor. If IsRange() is false, this is ignored.
[in]	read_cache	Cached expansion data.
[out]	output_scripts	The expanded scriptPubKeys.
[out]	out	Scripts and public keys necessary for solving the expanded scriptPubKeys (may be equal to `provider`).

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ExpandPrivate()

virtual void Descriptor::ExpandPrivate	(	int	pos,
		const SigningProvider &	provider,
		FlatSigningProvider &	out
	)		const

pure virtual

Expand the private key for a descriptor at a specified position, if possible.

Parameters

[in]	pos	The position at which to expand the descriptor. If IsRange() is false, this is ignored.
[in]	provider	The provider to query for the private keys.
[out]	out	Any private keys available for the specified `pos`.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ GetOutputType()

virtual std::optional<OutputType> Descriptor::GetOutputType ( ) const

pure virtual

Returns: The OutputType of the scriptPubKey(s) produced by this descriptor. Or nullopt if indeterminate (multiple or none)

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ GetPubKeys()

virtual void Descriptor::GetPubKeys	(	std::set< CPubKey > &	pubkeys,
		std::set< CExtPubKey > &	ext_pubs
	)		const

pure virtual

Return all (extended) public keys for this descriptor, including any from subdescriptors.

Parameters

[out]	pubkeys	Any public keys
[out]	ext_pubs	Any extended public keys

Implemented in wallet::DummyDescriptor.

◆ IsRange()

virtual bool Descriptor::IsRange ( ) const

pure virtual

Whether the expansion of this descriptor depends on the position.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ IsSingleType()

virtual bool Descriptor::IsSingleType ( ) const

pure virtual

Whether this descriptor will return one scriptPubKey or multiple (aka is or is not combo)

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ IsSolvable()

virtual bool Descriptor::IsSolvable ( ) const

pure virtual

Whether this descriptor has all information about signing ignoring lack of private keys.

This is true for all descriptors except ones that use raw or addr constructions.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ MaxSatisfactionElems()

virtual std::optional<int64_t> Descriptor::MaxSatisfactionElems ( ) const

pure virtual

Get the maximum size number of stack elements for satisfying this descriptor.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ MaxSatisfactionWeight()

virtual std::optional<int64_t> Descriptor::MaxSatisfactionWeight ( bool use_max_sig ) const

pure virtual

Get the maximum size of a satisfaction for this descriptor, in weight units.

Parameters

use_max_sig Whether to assume ECDSA signatures will have a high-r.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ScriptSize()

virtual std::optional<int64_t> Descriptor::ScriptSize ( ) const

pure virtual

Get the size of the scriptPubKey for this descriptor.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ToNormalizedString()

virtual bool Descriptor::ToNormalizedString	(	const SigningProvider &	provider,
		std::string &	out,
		const DescriptorCache *	cache = `nullptr`
	)		const

pure virtual

Convert the descriptor to a normalized string.

Normalized descriptors have the xpub at the last hardened step. This fails if the provided provider does not have the private keys to derive that xpub.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ToPrivateString()

virtual bool Descriptor::ToPrivateString	(	const SigningProvider &	provider,
		std::string &	out
	)		const

pure virtual

Convert the descriptor to a private string.

This fails if the provided provider does not have the relevant private keys.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

◆ ToString()

virtual std::string Descriptor::ToString ( bool compat_format = false ) const

pure virtual

Convert the descriptor back to a string, undoing parsing.

Implemented in wallet::DummyDescriptor.

Here is the caller graph for this function:

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

src/script/descriptor.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Descriptor()

Member Function Documentation

◆ Expand()

◆ ExpandFromCache()

◆ ExpandPrivate()

◆ GetOutputType()

◆ GetPubKeys()

◆ IsRange()

◆ IsSingleType()

◆ IsSolvable()

◆ MaxSatisfactionElems()

◆ MaxSatisfactionWeight()

◆ ScriptSize()

◆ ToNormalizedString()

◆ ToPrivateString()

◆ ToString()