script__standard__tests_8cpp_source.html

// Copyright (c) 2017-2022 The Bitcoin Core developers

// Distributed under the MIT software license, see the accompanying

// file COPYING or http://www.opensource.org/licenses/mit-license.php.


#include <test/data/bip341_wallet_vectors.json.h>


#include <addresstype.h>

#include <key.h>

#include <key_io.h>

#include <script/script.h>

#include <script/signingprovider.h>

#include <script/solver.h>

#include <test/util/setup_common.h>

#include <util/strencodings.h>


#include <boost/test/unit_test.hpp>


#include <univalue.h>


using namespace util::hex_literals;


BOOST_FIXTURE_TEST_SUITE(script_standard_tests, BasicTestingSetup)


BOOST_AUTO_TEST_CASE(dest_default_is_no_dest)

{

    CTxDestination dest;

    BOOST_CHECK(!IsValidDestination(dest));

}


BOOST_AUTO_TEST_CASE(script_standard_Solver_success)

{

    CKey keys[3];

    CPubKey pubkeys[3];

    for (int i = 0; i < 3; i++) {

        keys[i].MakeNewKey(true);

        pubkeys[i] = keys[i].GetPubKey();

    }


    CScript s;

    std::vector<std::vector<unsigned char> > solutions;


    // TxoutType::PUBKEY

    s.clear();

    s << ToByteVector(pubkeys[0]) << OP_CHECKSIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::PUBKEY);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(pubkeys[0]));


    // TxoutType::PUBKEYHASH

    s.clear();

    s << OP_DUP << OP_HASH160 << ToByteVector(pubkeys[0].GetID()) << OP_EQUALVERIFY << OP_CHECKSIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::PUBKEYHASH);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(pubkeys[0].GetID()));


    // TxoutType::SCRIPTHASH

    CScript redeemScript(s); // initialize with leftover P2PKH script

    s.clear();

    s << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::SCRIPTHASH);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(CScriptID(redeemScript)));


    // TxoutType::MULTISIG

    s.clear();

    s << OP_1 <<

        ToByteVector(pubkeys[0]) <<

        ToByteVector(pubkeys[1]) <<

        OP_2 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::MULTISIG);

    BOOST_CHECK_EQUAL(solutions.size(), 4U);

    BOOST_CHECK(solutions[0] == std::vector<unsigned char>({1}));

    BOOST_CHECK(solutions[1] == ToByteVector(pubkeys[0]));

    BOOST_CHECK(solutions[2] == ToByteVector(pubkeys[1]));

    BOOST_CHECK(solutions[3] == std::vector<unsigned char>({2}));


    s.clear();

    s << OP_2 <<

        ToByteVector(pubkeys[0]) <<

        ToByteVector(pubkeys[1]) <<

        ToByteVector(pubkeys[2]) <<

        OP_3 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::MULTISIG);

    BOOST_CHECK_EQUAL(solutions.size(), 5U);

    BOOST_CHECK(solutions[0] == std::vector<unsigned char>({2}));

    BOOST_CHECK(solutions[1] == ToByteVector(pubkeys[0]));

    BOOST_CHECK(solutions[2] == ToByteVector(pubkeys[1]));

    BOOST_CHECK(solutions[3] == ToByteVector(pubkeys[2]));

    BOOST_CHECK(solutions[4] == std::vector<unsigned char>({3}));


    // TxoutType::NULL_DATA

    s.clear();

    s << OP_RETURN <<

        std::vector<unsigned char>({0}) <<

        std::vector<unsigned char>({75}) <<

        std::vector<unsigned char>({255});

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NULL_DATA);

    BOOST_CHECK_EQUAL(solutions.size(), 0U);


    // TxoutType::WITNESS_V0_KEYHASH

    s.clear();

    s << OP_0 << ToByteVector(pubkeys[0].GetID());

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_V0_KEYHASH);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(pubkeys[0].GetID()));


    // TxoutType::WITNESS_V0_SCRIPTHASH

    uint256 scriptHash;

    CSHA256().Write(redeemScript.data(), redeemScript.size())

        .Finalize(scriptHash.begin());


    s.clear();

    s << OP_0 << ToByteVector(scriptHash);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_V0_SCRIPTHASH);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(scriptHash));


    // TxoutType::WITNESS_V1_TAPROOT

    s.clear();

    s << OP_1 << ToByteVector(uint256::ZERO);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_V1_TAPROOT);

    BOOST_CHECK_EQUAL(solutions.size(), 1U);

    BOOST_CHECK(solutions[0] == ToByteVector(uint256::ZERO));


    // TxoutType::WITNESS_UNKNOWN

    s.clear();

    s << OP_16 << ToByteVector(uint256::ONE);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_UNKNOWN);

    BOOST_CHECK_EQUAL(solutions.size(), 2U);

    BOOST_CHECK(solutions[0] == std::vector<unsigned char>{16});

    BOOST_CHECK(solutions[1] == ToByteVector(uint256::ONE));


    // TxoutType::ANCHOR

    s.clear();

    s << OP_1 << ANCHOR_BYTES;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::ANCHOR);

    BOOST_CHECK(solutions.empty());


    // Sanity-check IsPayToAnchor

    int version{-1};

    std::vector<unsigned char> witness_program;

    BOOST_CHECK(s.IsPayToAnchor());

    BOOST_CHECK(s.IsWitnessProgram(version, witness_program));

    BOOST_CHECK(CScript::IsPayToAnchor(version, witness_program));


    // TxoutType::NONSTANDARD

    s.clear();

    s << OP_9 << OP_ADD << OP_11 << OP_EQUAL;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);

}


BOOST_AUTO_TEST_CASE(script_standard_Solver_failure)

{

    CKey key = GenerateRandomKey();

    CPubKey pubkey = key.GetPubKey();


    CScript s;

    std::vector<std::vector<unsigned char> > solutions;


    // TxoutType::PUBKEY with incorrectly sized pubkey

    s.clear();

    s << std::vector<unsigned char>(30, 0x01) << OP_CHECKSIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::PUBKEYHASH with incorrectly sized key hash

    s.clear();

    s << OP_DUP << OP_HASH160 << ToByteVector(pubkey) << OP_EQUALVERIFY << OP_CHECKSIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::SCRIPTHASH with incorrectly sized script hash

    s.clear();

    s << OP_HASH160 << std::vector<unsigned char>(21, 0x01) << OP_EQUAL;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::MULTISIG 0/2

    s.clear();

    s << OP_0 << ToByteVector(pubkey) << OP_1 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::MULTISIG 2/1

    s.clear();

    s << OP_2 << ToByteVector(pubkey) << OP_1 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::MULTISIG n = 2 with 1 pubkey

    s.clear();

    s << OP_1 << ToByteVector(pubkey) << OP_2 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::MULTISIG n = 1 with 0 pubkeys

    s.clear();

    s << OP_1 << OP_1 << OP_CHECKMULTISIG;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::NULL_DATA with other opcodes

    s.clear();

    s << OP_RETURN << std::vector<unsigned char>({75}) << OP_ADD;

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::WITNESS_V0_{KEY,SCRIPT}HASH with incorrect program size (-> consensus-invalid, i.e. non-standard)

    s.clear();

    s << OP_0 << std::vector<unsigned char>(19, 0x01);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::NONSTANDARD);


    // TxoutType::WITNESS_V1_TAPROOT with incorrect program size (-> undefined, but still policy-valid)

    s.clear();

    s << OP_1 << std::vector<unsigned char>(31, 0x01);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_UNKNOWN);

    s.clear();

    s << OP_1 << std::vector<unsigned char>(33, 0x01);

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_UNKNOWN);


    // TxoutType::ANCHOR but wrong witness version

    s.clear();

    s << OP_2 << ANCHOR_BYTES;

    BOOST_CHECK(!s.IsPayToAnchor());

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_UNKNOWN);


    // TxoutType::ANCHOR but wrong 2-byte data push

    s.clear();

    s << OP_1 << std::vector<unsigned char>{0xff, 0xff};

    BOOST_CHECK(!s.IsPayToAnchor());

    BOOST_CHECK_EQUAL(Solver(s, solutions), TxoutType::WITNESS_UNKNOWN);

}


BOOST_AUTO_TEST_CASE(script_standard_ExtractDestination)

{

    CKey key = GenerateRandomKey();

    CPubKey pubkey = key.GetPubKey();


    CScript s;

    CTxDestination address;


    // TxoutType::PUBKEY

    s.clear();

    s << ToByteVector(pubkey) << OP_CHECKSIG;

    BOOST_CHECK(!ExtractDestination(s, address));

    BOOST_CHECK(std::get<PubKeyDestination>(address) == PubKeyDestination(pubkey));


    // TxoutType::PUBKEYHASH

    s.clear();

    s << OP_DUP << OP_HASH160 << ToByteVector(pubkey.GetID()) << OP_EQUALVERIFY << OP_CHECKSIG;

    BOOST_CHECK(ExtractDestination(s, address));

    BOOST_CHECK(std::get<PKHash>(address) == PKHash(pubkey));


    // TxoutType::SCRIPTHASH

    CScript redeemScript(s); // initialize with leftover P2PKH script

    s.clear();

    s << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL;

    BOOST_CHECK(ExtractDestination(s, address));

    BOOST_CHECK(std::get<ScriptHash>(address) == ScriptHash(redeemScript));


    // TxoutType::MULTISIG

    s.clear();

    s << OP_1 << ToByteVector(pubkey) << OP_1 << OP_CHECKMULTISIG;

    BOOST_CHECK(!ExtractDestination(s, address));


    // TxoutType::NULL_DATA

    s.clear();

    s << OP_RETURN << std::vector<unsigned char>({75});

    BOOST_CHECK(!ExtractDestination(s, address));


    // TxoutType::WITNESS_V0_KEYHASH

    s.clear();

    s << OP_0 << ToByteVector(pubkey.GetID());

    BOOST_CHECK(ExtractDestination(s, address));

    WitnessV0KeyHash keyhash;

    CHash160().Write(pubkey).Finalize(keyhash);

    BOOST_CHECK(std::get<WitnessV0KeyHash>(address) == keyhash);


    // TxoutType::WITNESS_V0_SCRIPTHASH

    s.clear();

    WitnessV0ScriptHash scripthash;

    CSHA256().Write(redeemScript.data(), redeemScript.size()).Finalize(scripthash.begin());

    s << OP_0 << ToByteVector(scripthash);

    BOOST_CHECK(ExtractDestination(s, address));

    BOOST_CHECK(std::get<WitnessV0ScriptHash>(address) == scripthash);


    // TxoutType::WITNESS_V1_TAPROOT

    s.clear();

    auto xpk = XOnlyPubKey(pubkey);

    s << OP_1 << ToByteVector(xpk);

    BOOST_CHECK(ExtractDestination(s, address));

    BOOST_CHECK(std::get<WitnessV1Taproot>(address) == WitnessV1Taproot(xpk));


    // TxoutType::ANCHOR

    s.clear();

    s << OP_1 << ANCHOR_BYTES;

    BOOST_CHECK(ExtractDestination(s, address));

    BOOST_CHECK(std::get<PayToAnchor>(address) == PayToAnchor());


    // TxoutType::WITNESS_UNKNOWN with unknown version

    // -> segwit version 1 with an undefined program size (33 bytes in this test case)

    s.clear();

    s << OP_1 << ToByteVector(pubkey);

    BOOST_CHECK(ExtractDestination(s, address));

    WitnessUnknown unk_v1{1, ToByteVector(pubkey)};

    BOOST_CHECK(std::get<WitnessUnknown>(address) == unk_v1);

    s.clear();

    // -> segwit versions 2+ are not specified yet

    s << OP_2 << ToByteVector(xpk);

    BOOST_CHECK(ExtractDestination(s, address));

    WitnessUnknown unk_v2{2, ToByteVector(xpk)};

    BOOST_CHECK(std::get<WitnessUnknown>(address) == unk_v2);

}


BOOST_AUTO_TEST_CASE(script_standard_GetScriptFor_)

{

    CKey keys[3];

    CPubKey pubkeys[3];

    for (int i = 0; i < 3; i++) {

        keys[i].MakeNewKey(true);

        pubkeys[i] = keys[i].GetPubKey();

    }


    CScript expected, result;


    // PKHash

    expected.clear();

    expected << OP_DUP << OP_HASH160 << ToByteVector(pubkeys[0].GetID()) << OP_EQUALVERIFY << OP_CHECKSIG;

    result = GetScriptForDestination(PKHash(pubkeys[0]));

    BOOST_CHECK(result == expected);


    // CScriptID

    CScript redeemScript(result);

    expected.clear();

    expected << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL;

    result = GetScriptForDestination(ScriptHash(redeemScript));

    BOOST_CHECK(result == expected);


    // CNoDestination

    expected.clear();

    result = GetScriptForDestination(CNoDestination());

    BOOST_CHECK(result == expected);


    // GetScriptForRawPubKey

    expected.clear();

    expected << ToByteVector(pubkeys[0]) << OP_CHECKSIG;

    result = GetScriptForRawPubKey(pubkeys[0]);

    BOOST_CHECK(result == expected);


    // GetScriptForMultisig

    expected.clear();

    expected << OP_2 <<

        ToByteVector(pubkeys[0]) <<

        ToByteVector(pubkeys[1]) <<

        ToByteVector(pubkeys[2]) <<

        OP_3 << OP_CHECKMULTISIG;

    result = GetScriptForMultisig(2, std::vector<CPubKey>(pubkeys, pubkeys + 3));

    BOOST_CHECK(result == expected);


    // WitnessV0KeyHash

    expected.clear();

    expected << OP_0 << ToByteVector(pubkeys[0].GetID());

    result = GetScriptForDestination(WitnessV0KeyHash(Hash160(ToByteVector(pubkeys[0]))));

    BOOST_CHECK(result == expected);

    result = GetScriptForDestination(WitnessV0KeyHash(pubkeys[0].GetID()));

    BOOST_CHECK(result == expected);


    // WitnessV0ScriptHash (multisig)

    CScript witnessScript;

    witnessScript << OP_1 << ToByteVector(pubkeys[0]) << OP_1 << OP_CHECKMULTISIG;


    uint256 scriptHash;

    CSHA256().Write(witnessScript.data(), witnessScript.size())

        .Finalize(scriptHash.begin());


    expected.clear();

    expected << OP_0 << ToByteVector(scriptHash);

    result = GetScriptForDestination(WitnessV0ScriptHash(witnessScript));

    BOOST_CHECK(result == expected);


    // WitnessV1Taproot

    auto xpk = XOnlyPubKey(pubkeys[0]);

    expected.clear();

    expected << OP_1 << ToByteVector(xpk);

    result = GetScriptForDestination(WitnessV1Taproot(xpk));

    BOOST_CHECK(result == expected);


    // PayToAnchor

    expected.clear();

    expected << OP_1 << ANCHOR_BYTES;

    result = GetScriptForDestination(PayToAnchor());

    BOOST_CHECK(result == expected);

}


BOOST_AUTO_TEST_CASE(script_standard_taproot_builder)

{

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,1}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,0,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,0,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,0,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,1,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,1,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,1,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,2,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,2,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({0,2,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,0,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,0,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,0,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,1,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,1,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,1,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,2,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,2,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({1,2,2}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,0,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,0,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,0,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,1,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,1,1}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,1,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,2,0}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,2,1}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,2,2}), false);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({2,2,2,3,4,5,6,7,8,9,10,11,12,14,14,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,31,31,31,31,31,31,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,128}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({128,128,127,126,125,124,123,122,121,120,119,118,117,116,115,114,113,112,111,110,109,108,107,106,105,104,103,102,101,100,99,98,97,96,95,94,93,92,91,90,89,88,87,86,85,84,83,82,81,80,79,78,77,76,75,74,73,72,71,70,69,68,67,66,65,64,63,62,61,60,59,58,57,56,55,54,53,52,51,50,49,48,47,46,45,44,43,42,41,40,39,38,37,36,35,34,33,32,31,30,29,28,27,26,25,24,23,22,21,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1}), true);

    BOOST_CHECK_EQUAL(TaprootBuilder::ValidDepths({129,129,128,127,126,125,124,123,122,121,120,119,118,117,116,115,114,113,112,111,110,109,108,107,106,105,104,103,102,101,100,99,98,97,96,95,94,93,92,91,90,89,88,87,86,85,84,83,82,81,80,79,78,77,76,75,74,73,72,71,70,69,68,67,66,65,64,63,62,61,60,59,58,57,56,55,54,53,52,51,50,49,48,47,46,45,44,43,42,41,40,39,38,37,36,35,34,33,32,31,30,29,28,27,26,25,24,23,22,21,20,19,18,17,16,15,14,13,12,11,10,9,8,7,6,5,4,3,2,1}), false);


    XOnlyPubKey key_inner{"79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798"_hex_u8};

    XOnlyPubKey key_1{"c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5"_hex_u8};

    XOnlyPubKey key_2{"f9308a019258c31049344f85f89d5229b531c845836f99b08601f113bce036f9"_hex_u8};

    CScript script_1 = CScript() << ToByteVector(key_1) << OP_CHECKSIG;

    CScript script_2 = CScript() << ToByteVector(key_2) << OP_CHECKSIG;

    constexpr uint256 hash_3{"31fe7061656bea2a36aa60a2f7ef940578049273746935d296426dc0afd86b68"};


    TaprootBuilder builder;

    BOOST_CHECK(builder.IsValid() && builder.IsComplete());

    builder.Add(2, script_2, 0xc0);

    BOOST_CHECK(builder.IsValid() && !builder.IsComplete());

    builder.AddOmitted(2, hash_3);

    BOOST_CHECK(builder.IsValid() && !builder.IsComplete());

    builder.Add(1, script_1, 0xc0);

    BOOST_CHECK(builder.IsValid() && builder.IsComplete());

    builder.Finalize(key_inner);

    BOOST_CHECK(builder.IsValid() && builder.IsComplete());

    BOOST_CHECK_EQUAL(EncodeDestination(builder.GetOutput()), "bc1pj6gaw944fy0xpmzzu45ugqde4rz7mqj5kj0tg8kmr5f0pjq8vnaqgynnge");

}


BOOST_AUTO_TEST_CASE(bip341_spk_test_vectors)

{

    using control_set = decltype(TaprootSpendData::scripts)::mapped_type;


    UniValue tests;

    tests.read(json_tests::bip341_wallet_vectors);


    const auto& vectors = tests["scriptPubKey"];


    for (const auto& vec : vectors.getValues()) {

        TaprootBuilder spktest;

        std::map<std::pair<std::vector<unsigned char>, int>, int> scriptposes;

        std::function<void (const UniValue&, int)> parse_tree = [&](const UniValue& node, int depth) {

            if (node.isNull()) return;

            if (node.isObject()) {

                auto script = ParseHex(node["script"].get_str());

                int idx = node["id"].getInt<int>();

                int leaf_version = node["leafVersion"].getInt<int>();

                scriptposes[{script, leaf_version}] = idx;

                spktest.Add(depth, script, leaf_version);

            } else {

                parse_tree(node[0], depth + 1);

                parse_tree(node[1], depth + 1);

            }

        };

        parse_tree(vec["given"]["scriptTree"], 0);

        spktest.Finalize(XOnlyPubKey(ParseHex(vec["given"]["internalPubkey"].get_str())));

        BOOST_CHECK_EQUAL(HexStr(GetScriptForDestination(spktest.GetOutput())), vec["expected"]["scriptPubKey"].get_str());

        BOOST_CHECK_EQUAL(EncodeDestination(spktest.GetOutput()), vec["expected"]["bip350Address"].get_str());

        auto spend_data = spktest.GetSpendData();

        BOOST_CHECK_EQUAL(vec["intermediary"]["merkleRoot"].isNull(), spend_data.merkle_root.IsNull());

        if (!spend_data.merkle_root.IsNull()) {

            BOOST_CHECK_EQUAL(vec["intermediary"]["merkleRoot"].get_str(), HexStr(spend_data.merkle_root));

        }

        BOOST_CHECK_EQUAL(spend_data.scripts.size(), scriptposes.size());

        for (const auto& scriptpos : scriptposes) {

            BOOST_CHECK(spend_data.scripts[scriptpos.first] == control_set{ParseHex(vec["expected"]["scriptPathControlBlocks"][scriptpos.second].get_str())});

        }

    }

}


BOOST_AUTO_TEST_SUITE_END()

ExtractDestination
bool ExtractDestination(const CScript &scriptPubKey, CTxDestination &addressRet)
Parse a scriptPubKey for the destination.
Definition: addresstype.cpp:49

IsValidDestination
bool IsValidDestination(const CTxDestination &dest)
Check whether a CTxDestination corresponds to one with an address.
Definition: addresstype.cpp:171

GetScriptForDestination
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
Definition: addresstype.cpp:166

addresstype.h

CTxDestination
std::variant< CNoDestination, PubKeyDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, PayToAnchor, WitnessUnknown > CTxDestination
A txout script categorized into standard templates.
Definition: addresstype.h:143

ANCHOR_BYTES
static const std::vector< unsigned char > ANCHOR_BYTES
Witness program for Pay-to-Anchor output script type.
Definition: addresstype.h:121

BaseHash::begin
unsigned char * begin()
Definition: hash_type.h:18

CHash160
A hasher class for Bitcoin's 160-bit hash (SHA-256 + RIPEMD-160).
Definition: hash.h:49

CHash160::Write
CHash160 & Write(std::span< const unsigned char > input)
Definition: hash.h:62

CHash160::Finalize
void Finalize(std::span< unsigned char > output)
Definition: hash.h:55

CKey
An encapsulated private key.
Definition: key.h:35

CKey::MakeNewKey
void MakeNewKey(bool fCompressed)
Generate a new private key using a cryptographic PRNG.
Definition: key.cpp:161

CKey::GetPubKey
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:182

CNoDestination
Definition: addresstype.h:20

CPubKey
An encapsulated public key.
Definition: pubkey.h:34

CPubKey::GetID
CKeyID GetID() const
Get the KeyID of this public key (hash of its serialization)
Definition: pubkey.h:164

CSHA256
A hasher class for SHA-256.
Definition: sha256.h:14

CSHA256::Finalize
void Finalize(unsigned char hash[OUTPUT_SIZE])
Definition: sha256.cpp:727

CSHA256::Write
CSHA256 & Write(const unsigned char *data, size_t len)
Definition: sha256.cpp:701

CScript
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:415

CScript::clear
void clear()
Definition: script.h:576

CScript::IsPayToAnchor
bool IsPayToAnchor() const
Definition: script.cpp:207

CScriptID
A reference to a CScript: the Hash160 of its serialization.
Definition: script.h:602

TaprootBuilder
Utility class to construct Taproot outputs from internal key and script tree.
Definition: signingprovider.h:46

TaprootBuilder::GetOutput
WitnessV1Taproot GetOutput()
Compute scriptPubKey (after Finalize()).
Definition: signingprovider.cpp:405

TaprootBuilder::GetSpendData
TaprootSpendData GetSpendData() const
Compute spending data (after Finalize()).
Definition: signingprovider.cpp:407

TaprootBuilder::IsComplete
bool IsComplete() const
Return whether there were either no leaves, or the leaves form a Huffman tree.
Definition: signingprovider.h:128

TaprootBuilder::Add
TaprootBuilder & Add(int depth, std::span< const unsigned char > script, int leaf_version, bool track=true)
Add a new script at a certain depth in the tree.
Definition: signingprovider.cpp:371

TaprootBuilder::ValidDepths
static bool ValidDepths(const std::vector< int > &depths)
Check if a list of depths is legal (will lead to IsComplete()).
Definition: signingprovider.cpp:348

TaprootBuilder::IsValid
bool IsValid() const
Return true if so far all input was valid.
Definition: signingprovider.h:126

TaprootBuilder::AddOmitted
TaprootBuilder & AddOmitted(int depth, const uint256 &hash)
Like Add(), but for a Merkle node with a given hash to the tree.
Definition: signingprovider.cpp:384

TaprootBuilder::Finalize
TaprootBuilder & Finalize(const XOnlyPubKey &internal_key)
Finalize the construction.
Definition: signingprovider.cpp:394

UniValue
Definition: univalue.h:22

XOnlyPubKey
Definition: pubkey.h:231

base_blob::begin
constexpr unsigned char * begin()
Definition: uint256.h:101

prevector::size
size_type size() const
Definition: prevector.h:294

prevector::data
value_type * data()
Definition: prevector.h:533

uint256
256-bit opaque blob.
Definition: uint256.h:196

uint256::ONE
static const uint256 ONE
Definition: uint256.h:205

uint256::ZERO
static const uint256 ZERO
Definition: uint256.h:204

BOOST_FIXTURE_TEST_SUITE
BOOST_FIXTURE_TEST_SUITE(cuckoocache_tests, BasicTestingSetup)
Test Suite for CuckooCache.

BOOST_AUTO_TEST_SUITE_END
BOOST_AUTO_TEST_SUITE_END()

Hash160
uint160 Hash160(const T1 &in1)
Compute the 160-bit hash an object.
Definition: hash.h:92

HexStr
std::string HexStr(const std::span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
Definition: hex_base.cpp:29

GenerateRandomKey
CKey GenerateRandomKey(bool compressed) noexcept
Definition: key.cpp:352

key.h

EncodeDestination
std::string EncodeDestination(const CTxDestination &dest)
Definition: key_io.cpp:294

key_io.h

node
Definition: messages.h:20

script
Definition: parsing.cpp:13

test_vectors_musig2_generate.s
tuple s
Definition: test_vectors_musig2_generate.py:72

util::hex_literals
""_hex is a compile-time user-defined literal returning a std::array<std::byte>, equivalent to ParseH...
Definition: strencodings.h:427

BOOST_CHECK_EQUAL
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18

BOOST_CHECK
#define BOOST_CHECK(expr)
Definition: object.cpp:17

script.h

OP_2
@ OP_2
Definition: script.h:85

OP_CHECKMULTISIG
@ OP_CHECKMULTISIG
Definition: script.h:192

OP_CHECKSIG
@ OP_CHECKSIG
Definition: script.h:190

OP_16
@ OP_16
Definition: script.h:99

OP_EQUAL
@ OP_EQUAL
Definition: script.h:146

OP_DUP
@ OP_DUP
Definition: script.h:125

OP_HASH160
@ OP_HASH160
Definition: script.h:187

OP_1
@ OP_1
Definition: script.h:83

OP_ADD
@ OP_ADD
Definition: script.h:161

OP_9
@ OP_9
Definition: script.h:92

OP_3
@ OP_3
Definition: script.h:86

OP_11
@ OP_11
Definition: script.h:94

OP_0
@ OP_0
Definition: script.h:76

OP_RETURN
@ OP_RETURN
Definition: script.h:111

OP_EQUALVERIFY
@ OP_EQUALVERIFY
Definition: script.h:147

ToByteVector
std::vector< unsigned char > ToByteVector(const T &in)
Definition: script.h:67

BOOST_AUTO_TEST_CASE
BOOST_AUTO_TEST_CASE(dest_default_is_no_dest)
Definition: script_standard_tests.cpp:24

setup_common.h

signingprovider.h

Solver
TxoutType Solver(const CScript &scriptPubKey, std::vector< std::vector< unsigned char > > &vSolutionsRet)
Parse a scriptPubKey and identify script type for standard scripts.
Definition: solver.cpp:141

GetScriptForMultisig
CScript GetScriptForMultisig(int nRequired, const std::vector< CPubKey > &keys)
Generate a multisig script.
Definition: solver.cpp:218

GetScriptForRawPubKey
CScript GetScriptForRawPubKey(const CPubKey &pubKey)
Generate a P2PK script for the given pubkey.
Definition: solver.cpp:213

solver.h

TxoutType::WITNESS_V1_TAPROOT
@ WITNESS_V1_TAPROOT

TxoutType::WITNESS_UNKNOWN
@ WITNESS_UNKNOWN
Only for Witness versions not already defined above.

TxoutType::ANCHOR
@ ANCHOR
anyone can spend script

TxoutType::WITNESS_V0_SCRIPTHASH
@ WITNESS_V0_SCRIPTHASH

TxoutType::SCRIPTHASH
@ SCRIPTHASH

TxoutType::PUBKEYHASH
@ PUBKEYHASH

TxoutType::NULL_DATA
@ NULL_DATA
unspendable OP_RETURN script that carries data

TxoutType::NONSTANDARD
@ NONSTANDARD

TxoutType::MULTISIG
@ MULTISIG

TxoutType::WITNESS_V0_KEYHASH
@ WITNESS_V0_KEYHASH

TxoutType::PUBKEY
@ PUBKEY

strencodings.h

ParseHex
std::vector< Byte > ParseHex(std::string_view hex_str)
Like TryParseHex, but returns an empty vector on invalid input.
Definition: strencodings.h:68

BasicTestingSetup
Basic testing setup.
Definition: setup_common.h:64

PKHash
Definition: addresstype.h:48

PayToAnchor
Definition: addresstype.h:124

PubKeyDestination
Definition: addresstype.h:34

ScriptHash
Definition: addresstype.h:59

TaprootSpendData::scripts
std::map< std::pair< std::vector< unsigned char >, int >, std::set< std::vector< unsigned char >, ShortestVectorFirstComparator > > scripts
Map from (script, leaf_version) to (sets of) control blocks.
Definition: signingprovider.h:39

WitnessUnknown
CTxDestination subtype to encode any future Witness version.
Definition: addresstype.h:96

WitnessV0KeyHash
Definition: addresstype.h:80

WitnessV0ScriptHash
Definition: addresstype.h:73

WitnessV1Taproot
Definition: addresstype.h:89

tests
constexpr std::array tests
Definition: unitester.cpp:100

univalue.h