descriptor.h

Go to the documentation of this file.

// Copyright (c) 2018-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_SCRIPT_DESCRIPTOR_H
#define BITCOIN_SCRIPT_DESCRIPTOR_H
 
#include <outputtype.h>
#include <pubkey.h>
#include <uint256.h>
#include <util/expected.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
class CScript;
class SigningProvider;
struct FlatSigningProvider;
 
using ExtPubKeyMap = std::unordered_map<uint32_t, CExtPubKey>;
 
class DescriptorCache {
private:
    std::unordered_map<uint32_t, ExtPubKeyMap> m_derived_xpubs;
    ExtPubKeyMap m_parent_xpubs;
    ExtPubKeyMap m_last_hardened_xpubs;
 
public:
    void CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub);
    bool GetCachedParentExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const;
    void CacheDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, const CExtPubKey& xpub);
    bool GetCachedDerivedExtPubKey(uint32_t key_exp_pos, uint32_t der_index, CExtPubKey& xpub) const;
    void CacheLastHardenedExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub);
    bool GetCachedLastHardenedExtPubKey(uint32_t key_exp_pos, CExtPubKey& xpub) const;
 
    ExtPubKeyMap GetCachedParentExtPubKeys() const;
    std::unordered_map<uint32_t, ExtPubKeyMap> GetCachedDerivedExtPubKeys() const;
    ExtPubKeyMap GetCachedLastHardenedExtPubKeys() const;
 
    DescriptorCache MergeAndDiff(const DescriptorCache& other);
};
 
struct Descriptor {
    virtual ~Descriptor() = default;
 
    virtual bool IsRange() const = 0;
 
    virtual bool IsSolvable() const = 0;
 
    virtual std::string ToString(bool compat_format=false) const = 0;
 
    virtual std::string ToCanonicalString() const = 0;
 
    virtual bool IsSingleType() const = 0;
 
    virtual bool HavePrivateKeys(const SigningProvider& provider) const = 0;
 
    virtual bool ToPrivateString(const SigningProvider& provider, std::string& out) const = 0;
 
    virtual bool ToNormalizedString(const SigningProvider& provider, std::string& out, const DescriptorCache* cache = nullptr) const = 0;
 
    virtual bool CanSelfExpand() const = 0;
 
    virtual bool Expand(int pos, const SigningProvider& provider, std::vector<CScript>& output_scripts, FlatSigningProvider& out, DescriptorCache* write_cache = nullptr) const = 0;
 
    virtual bool ExpandFromCache(int pos, const DescriptorCache& read_cache, std::vector<CScript>& output_scripts, FlatSigningProvider& out) const = 0;
 
    virtual void ExpandPrivate(int pos, const SigningProvider& provider, FlatSigningProvider& out) const = 0;
 
    virtual std::optional<OutputType> GetOutputType() const = 0;
 
    virtual std::optional<int64_t> ScriptSize() const = 0;
 
    virtual std::optional<int64_t> MaxSatisfactionWeight(bool use_max_sig) const = 0;
 
    virtual std::optional<int64_t> MaxSatisfactionElems() const = 0;
 
    virtual void GetPubKeys(std::set<CPubKey>& pubkeys, std::set<CExtPubKey>& ext_pubs) const = 0;
 
    virtual bool HasScripts() const = 0;
 
    virtual std::vector<std::string> Warnings() const = 0;
 
    virtual uint32_t GetMaxKeyExpr() const = 0;
 
    virtual size_t GetKeyCount() const = 0;
};
 
util::Expected<void, std::string> CheckDescriptorRangeBounds(int64_t low, int64_t high);
 
std::vector<std::unique_ptr<Descriptor>> Parse(std::string_view descriptor, FlatSigningProvider& out, std::string& error, bool require_checksum = false);
 
std::string GetDescriptorChecksum(const std::string& descriptor);
 
std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const SigningProvider& provider);
 
uint256 CompatDescriptorHash(const Descriptor& desc);
 
#endif // BITCOIN_SCRIPT_DESCRIPTOR_H