Descriptor Struct Reference

Interface for parsed descriptor objects. More...

#include <descriptor.h>

Public Member Functions
virtual	~Descriptor ()=default
virtual bool	IsRange () const =0
	Whether the expansion of this descriptor depends on the position. More...
virtual std::string	ToString () const =0
	Convert the descriptor back to a string, undoing parsing. More...
virtual bool	ToPrivateString (const SigningProvider &provider, std::string &out) const =0
	Convert the descriptor to a private string. More...
virtual bool	Expand (int pos, const SigningProvider &provider, std::vector< CScript > &output_scripts, FlatSigningProvider &out) const =0
	Expand a descriptor at a specified position. More...

Detailed Description

Interface for parsed descriptor objects.

Definition at line 29 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  ) const

pure virtual

Expand a descriptor at a specified position.

pos: the position at which to expand the descriptor. If IsRange() is false, this is ignored. provider: the provider to query for private keys in case of hardened derivation. output_script: the expanded scriptPubKeys will be put here. out: scripts and public keys necessary for solving the expanded scriptPubKeys will be put here (may be equal to provider).

IsRange()

virtual bool Descriptor::IsRange ( ) const

pure virtual

Whether the expansion of this descriptor depends on the position.

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.

ToString()

virtual std::string Descriptor::ToString ( ) const

pure virtual

Convert the descriptor back to a string, undoing parsing.

---

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

• src/script/descriptor.h