standard.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 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_STANDARD_H
#define BITCOIN_SCRIPT_STANDARD_H
 
#include <pubkey.h>
#include <script/script_flags.h>
#include <uint256.h>
#include <util/hash_type.h>
 
#include <string>
#include <variant>
 
static const bool DEFAULT_ACCEPT_DATACARRIER = true;
 
class CKeyID;
class CScript;
struct ScriptHash;
 
class CScriptID : public BaseHash<uint160> {
public:
    CScriptID() : BaseHash() {}
    explicit CScriptID(const CScript &in);
    explicit CScriptID(const uint160 &in) : BaseHash(in) {}
    explicit CScriptID(const ScriptHash &in);
};
 
static const unsigned int MAX_OP_RETURN_RELAY = 223;
 
enum class TxoutType {
    NONSTANDARD,
    // 'standard' transaction types:
    PUBKEY,
    PUBKEYHASH,
    SCRIPTHASH,
    MULTISIG,
    // unspendable OP_RETURN script that carries data
    NULL_DATA,
};
 
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);
};
 
using CTxDestination = std::variant<CNoDestination, PKHash, ScriptHash>;
 
bool IsValidDestination(const CTxDestination &dest);
 
std::string GetTxnOutputType(TxoutType t);
 
TxoutType Solver(const CScript &scriptPubKey,
                 std::vector<std::vector<uint8_t>> &vSolutionsRet);
 
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);
 
CScript GetScriptForRawPubKey(const CPubKey &pubkey);
 
CScript GetScriptForMultisig(int nRequired, const std::vector<CPubKey> &keys);
 
#endif // BITCOIN_SCRIPT_STANDARD_H