Bitcoin Core  21.99.0
P2P Digital Currency
descriptor.h
Go to the documentation of this file.
1 // Copyright (c) 2018-2020 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_SCRIPT_DESCRIPTOR_H
6 #define BITCOIN_SCRIPT_DESCRIPTOR_H
7 
8 #include <outputtype.h>
9 #include <script/script.h>
10 #include <script/sign.h>
11 #include <script/signingprovider.h>
12 
13 #include <optional>
14 #include <vector>
15 
16 using ExtPubKeyMap = std::unordered_map<uint32_t, CExtPubKey>;
17 
20 private:
22  std::unordered_map<uint32_t, ExtPubKeyMap> m_derived_xpubs;
25 
26 public:
32  void CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub);
38  bool GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const;
45  void CacheDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, const CExtPubKey& xpub);
52  bool GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const;
53 
57  const std::unordered_map<uint32_t, ExtPubKeyMap> GetCachedDerivedExtPubKeys() const;
58 };
59 
77 struct Descriptor {
78  virtual ~Descriptor() = default;
79 
81  virtual bool IsRange() const = 0;
82 
85  virtual bool IsSolvable() const = 0;
86 
88  virtual std::string ToString() const = 0;
89 
91  virtual bool IsSingleType() const = 0;
92 
94  virtual bool ToPrivateString(const SigningProvider& provider, std::string& out) const = 0;
95 
97  virtual bool ToNormalizedString(const SigningProvider& provider, std::string& out, bool priv) const = 0;
98 
107  virtual bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const = 0;
108 
116  virtual bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const = 0;
117 
124  virtual void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const = 0;
125 
127  virtual std::optional<OutputType> GetOutputType() const = 0;
128 };
129 
138 std::unique_ptr<Descriptor> Parse(const std::string& descriptor, FlatSigningProvider& out, std::string& error, bool require_checksum = false);
139 
146 std::string GetDescriptorChecksum(const std::string& descriptor);
147 
162 std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const SigningProvider& provider);
163 
164 #endif // BITCOIN_SCRIPT_DESCRIPTOR_H
DescriptorCache::CacheParentExtPubKey
void CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey &xpub)
Cache a parent xpub.
Definition: descriptor.cpp:1359
Descriptor::GetOutputType
virtual std::optional< OutputType > GetOutputType() const =0
DescriptorCache::m_derived_xpubs
std::unordered_map< uint32_t, ExtPubKeyMap > m_derived_xpubs
Map key expression index -> map of (key derivation index -> xpub)
Definition: descriptor.h:22
DescriptorCache::GetCachedParentExtPubKey
bool GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey &xpub) const
Retrieve a cached parent xpub.
Definition: descriptor.cpp:1370
Descriptor::Expand
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.
DescriptorCache::GetCachedParentExtPubKeys
const ExtPubKeyMap GetCachedParentExtPubKeys() const
Retrieve all cached parent xpubs.
Definition: descriptor.cpp:1388
outputtype.h
SigningProvider
An interface to be implemented by keystores that support signing.
Definition: signingprovider.h:18
Parse
std::unique_ptr< Descriptor > Parse(const std::string &descriptor, FlatSigningProvider &out, std::string &error, bool require_checksum=false)
Parse a descriptor string.
Definition: descriptor.cpp:1335
Descriptor::ExpandPrivate
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.
signingprovider.h
Descriptor::IsSingleType
virtual bool IsSingleType() const =0
Whether this descriptor will return one scriptPubKey or multiple (aka is or is not combo)
sign.h
DescriptorCache::m_parent_xpubs
ExtPubKeyMap m_parent_xpubs
Map key expression index -> parent xpub.
Definition: descriptor.h:24
Descriptor::ToNormalizedString
virtual bool ToNormalizedString(const SigningProvider &provider, std::string &out, bool priv) const =0
Convert the descriptor to a normalized string.
CScript
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:404
DescriptorCache
Cache for single descriptor's derived extended pubkeys.
Definition: descriptor.h:19
InferDescriptor
std::unique_ptr< Descriptor > InferDescriptor(const CScript &script, const SigningProvider &provider)
Find a descriptor for the specified script, using information from provider where possible.
Definition: descriptor.cpp:1354
ExtPubKeyMap
std::unordered_map< uint32_t, CExtPubKey > ExtPubKeyMap
Definition: descriptor.h:16
DescriptorCache::CacheDerivedExtPubKey
void CacheDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, const CExtPubKey &xpub)
Cache an xpub derived at an index.
Definition: descriptor.cpp:1364
DescriptorCache::GetCachedDerivedExtPubKey
bool GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey &xpub) const
Retrieve a cached xpub derived at an index.
Definition: descriptor.cpp:1378
Descriptor::IsSolvable
virtual bool IsSolvable() const =0
Whether this descriptor has all information about signing ignoring lack of private keys.
Descriptor::IsRange
virtual bool IsRange() const =0
Whether the expansion of this descriptor depends on the position.
Descriptor::ToPrivateString
virtual bool ToPrivateString(const SigningProvider &provider, std::string &out) const =0
Convert the descriptor to a private string.
Descriptor
Interface for parsed descriptor objects.
Definition: descriptor.h:77
script.h
error
bool error(const char *fmt, const Args &... args)
Definition: system.h:49
Descriptor::ToString
virtual std::string ToString() const =0
Convert the descriptor back to a string, undoing parsing.
Descriptor::~Descriptor
virtual ~Descriptor()=default
GetDescriptorChecksum
std::string GetDescriptorChecksum(const std::string &descriptor)
Get the checksum for a descriptor.
Definition: descriptor.cpp:1345
DescriptorCache::GetCachedDerivedExtPubKeys
const std::unordered_map< uint32_t, ExtPubKeyMap > GetCachedDerivedExtPubKeys() const
Retrieve all cached derived xpubs.
Definition: descriptor.cpp:1393
CExtPubKey
Definition: pubkey.h:282
Descriptor::ExpandFromCache
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.
FlatSigningProvider
Definition: signingprovider.h:49