LCOV - code coverage report
Current view: top level - src - signet.cpp (source / functions) Coverage Total Hit
Test: test_bitcoin_coverage.info Lines: 97.5 % 80 78
Test Date: 2024-11-04 04:45:35 Functions: 100.0 % 4 4
Branches: 57.6 % 118 68

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

Generated by: LCOV version 2.0-1