Coverage Report

Created: 2026-04-29 19:21

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/signet.cpp
Line
Count
Source
1
// Copyright (c) 2019-present 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
#include <signet.h>
6
7
#include <consensus/merkle.h>
8
#include <consensus/params.h>
9
#include <consensus/validation.h>
10
#include <primitives/block.h>
11
#include <primitives/transaction.h>
12
#include <script/interpreter.h>
13
#include <script/script.h>
14
#include <streams.h>
15
#include <uint256.h>
16
#include <util/check.h>
17
#include <util/log.h>
18
19
#include <algorithm>
20
#include <cstddef>
21
#include <cstdint>
22
#include <exception>
23
#include <memory>
24
#include <span>
25
#include <utility>
26
#include <vector>
27
28
static constexpr uint8_t SIGNET_HEADER[4] = {0xec, 0xc7, 0xda, 0xa2};
29
30
static constexpr script_verify_flags BLOCK_SCRIPT_VERIFY_FLAGS = SCRIPT_VERIFY_P2SH | SCRIPT_VERIFY_WITNESS | SCRIPT_VERIFY_DERSIG | SCRIPT_VERIFY_NULLDUMMY;
31
32
static bool FetchAndClearCommitmentSection(const std::span<const uint8_t> header, CScript& witness_commitment, std::vector<uint8_t>& result)
33
27
{
34
27
    CScript replacement;
35
27
    bool found_header = false;
36
27
    result.clear();
37
38
27
    opcodetype opcode;
39
27
    CScript::const_iterator pc = witness_commitment.begin();
40
27
    std::vector<uint8_t> pushdata;
41
102
    while (witness_commitment.GetOp(pc, opcode, pushdata)) {
42
75
        if (pushdata.size() > 0) {
43
48
            if (!found_header && pushdata.size() > header.size() && std::ranges::equal(std::span{pushdata}.first(header.size()), header)) {
44
                // pushdata only counts if it has the header _and_ some data
45
19
                result.insert(result.end(), pushdata.begin() + header.size(), pushdata.end());
46
19
                pushdata.erase(pushdata.begin() + header.size(), pushdata.end());
47
19
                found_header = true;
48
19
            }
49
48
            replacement << pushdata;
50
48
        } else {
51
27
            replacement << opcode;
52
27
        }
53
75
    }
54
55
27
    if (found_header) witness_commitment = replacement;
56
27
    return found_header;
57
27
}
58
59
static uint256 ComputeModifiedMerkleRoot(const CMutableTransaction& cb, const CBlock& block)
60
23
{
61
23
    std::vector<uint256> leaves;
62
23
    leaves.reserve((block.vtx.size() + 1) & ~1ULL); // capacity rounded up to even
63
23
    leaves.push_back(cb.GetHash().ToUint256());
64
29
    for (size_t s = 1; s < block.vtx.size(); ++s) {
65
6
        leaves.push_back(block.vtx[s]->GetHash().ToUint256());
66
6
    }
67
23
    return ComputeMerkleRoot(std::move(leaves));
68
23
}
69
70
std::optional<SignetTxs> SignetTxs::Create(const CBlock& block, const CScript& challenge)
71
31
{
72
31
    CMutableTransaction tx_to_spend;
73
31
    tx_to_spend.version = 0;
74
31
    tx_to_spend.nLockTime = 0;
75
31
    tx_to_spend.vin.emplace_back(COutPoint(), CScript(OP_0), 0);
76
31
    tx_to_spend.vout.emplace_back(0, challenge);
77
78
31
    CMutableTransaction tx_spending;
79
31
    tx_spending.version = 0;
80
31
    tx_spending.nLockTime = 0;
81
31
    tx_spending.vin.emplace_back(COutPoint(), CScript(), 0);
82
31
    tx_spending.vout.emplace_back(0, CScript(OP_RETURN));
83
84
    // can't fill any other fields before extracting signet
85
    // responses from block coinbase tx
86
87
    // find and delete signet signature
88
31
    if (block.vtx.empty()) return std::nullopt; // no coinbase tx in block; invalid
89
29
    CMutableTransaction modified_cb(*block.vtx.at(0));
90
91
29
    const int cidx = GetWitnessCommitmentIndex(block);
92
29
    if (cidx == NO_WITNESS_COMMITMENT) {
93
2
        return std::nullopt; // require a witness commitment
94
2
    }
95
96
27
    CScript& witness_commitment = modified_cb.vout.at(cidx).scriptPubKey;
97
98
27
    std::vector<uint8_t> signet_solution;
99
27
    if (!FetchAndClearCommitmentSection(SIGNET_HEADER, witness_commitment, signet_solution)) {
100
        // no signet solution -- allow this to support OP_TRUE as trivial block challenge
101
19
    } else {
102
19
        try {
103
19
            SpanReader v{signet_solution};
104
19
            v >> tx_spending.vin[0].scriptSig;
105
19
            v >> tx_spending.vin[0].scriptWitness.stack;
106
19
            if (!v.empty()) return std::nullopt; // extraneous data encountered
107
19
        } catch (const std::exception&) {
108
2
            return std::nullopt; // parsing error
109
2
        }
110
19
    }
111
23
    uint256 signet_merkle = ComputeModifiedMerkleRoot(modified_cb, block);
112
113
23
    std::vector<uint8_t> block_data;
114
23
    VectorWriter writer{block_data, 0};
115
23
    writer << block.nVersion;
116
23
    writer << block.hashPrevBlock;
117
23
    writer << signet_merkle;
118
23
    writer << block.nTime;
119
23
    tx_to_spend.vin[0].scriptSig << block_data;
120
23
    tx_spending.vin[0].prevout = COutPoint(tx_to_spend.GetHash(), 0);
121
122
23
    return SignetTxs{tx_to_spend, tx_spending};
123
27
}
124
125
// Signet block solution checker
126
bool CheckSignetBlockSolution(const CBlock& block, const Consensus::Params& consensusParams)
127
51
{
128
51
    if (block.GetHash() == consensusParams.hashGenesisBlock) {
129
        // genesis block solution is always valid
130
27
        return true;
131
27
    }
132
133
24
    const CScript challenge(consensusParams.signet_challenge.begin(), consensusParams.signet_challenge.end());
134
24
    const std::optional<SignetTxs> signet_txs = SignetTxs::Create(block, challenge);
135
136
24
    if (!signet_txs) {
137
4
        LogDebug(BCLog::VALIDATION, "CheckSignetBlockSolution: Errors in block (block solution parse failure)\n");
138
4
        return false;
139
4
    }
140
141
20
    const CScript& scriptSig = signet_txs->m_to_sign.vin[0].scriptSig;
142
20
    const CScriptWitness& witness = signet_txs->m_to_sign.vin[0].scriptWitness;
143
144
20
    PrecomputedTransactionData txdata;
145
20
    txdata.Init(signet_txs->m_to_sign, {signet_txs->m_to_spend.vout[0]});
146
20
    TransactionSignatureChecker sigcheck(&signet_txs->m_to_sign, /* nInIn= */ 0, /* amountIn= */ signet_txs->m_to_spend.vout[0].nValue, txdata, MissingDataBehavior::ASSERT_FAIL);
147
148
20
    if (!VerifyScript(scriptSig, signet_txs->m_to_spend.vout[0].scriptPubKey, &witness, BLOCK_SCRIPT_VERIFY_FLAGS, sigcheck)) {
149
1
        LogDebug(BCLog::VALIDATION, "CheckSignetBlockSolution: Errors in block (block solution invalid)\n");
150
1
        return false;
151
1
    }
152
19
    return true;
153
20
}