addresstype.h

Go to the documentation of this file.

// Copyright (c) 2023 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or https://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_ADDRESSTYPE_H
#define BITCOIN_ADDRESSTYPE_H
 
#include <pubkey.h>
#include <script/script.h>
#include <uint256.h>
#include <util/hash_type.h>
 
#include <variant>
 
enum class TxoutType;
 
class CNoDestination {
public:
    friend bool operator==(const CNoDestination &a, const CNoDestination &b) {
        return true;
    }
    friend bool operator<(const CNoDestination &a, const CNoDestination &b) {
        return true;
    }
};
 
struct PKHash : public BaseHash<uint160> {
    PKHash() : BaseHash() {}
    explicit PKHash(const uint160 &hash) : BaseHash(hash) {}
    explicit PKHash(const CPubKey &pubkey);
    explicit PKHash(const CKeyID &pubkey_id);
};
CKeyID ToKeyID(const PKHash &key_hash);
 
struct ScriptHash : public BaseHash<uint160> {
    ScriptHash() : BaseHash() {}
    // This doesn't do what you'd expect.
    // Use ScriptHash(GetScriptForDestination(...)) instead.
    explicit ScriptHash(const PKHash &hash) = delete;
 
    explicit ScriptHash(const uint160 &hash) : BaseHash(hash) {}
    explicit ScriptHash(const CScript &script);
    explicit ScriptHash(const CScriptID &script);
};
CScriptID ToScriptID(const ScriptHash &script_hash);
 
using CTxDestination = std::variant<CNoDestination, PKHash, ScriptHash>;
 
bool IsValidDestination(const CTxDestination &dest);
 
bool ExtractDestination(const CScript &scriptPubKey,
                        CTxDestination &addressRet);
 
bool ExtractDestinations(const CScript &scriptPubKey, TxoutType &typeRet,
                         std::vector<CTxDestination> &addressRet,
                         int &nRequiredRet);
 
CScript GetScriptForDestination(const CTxDestination &dest);
 
#endif // BITCOIN_ADDRESSTYPE_H