LCOV - code coverage report
Current view: top level - src/test/util - txmempool.cpp (source / functions) Coverage Total Hit
Test: test_bitcoin_coverage.info Lines: 56.8 % 88 50
Test Date: 2024-11-04 04:45:35 Functions: 80.0 % 5 4
Branches: 31.4 % 172 54

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2022 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 <test/util/txmempool.h>
       6                 :             : 
       7                 :             : #include <chainparams.h>
       8                 :             : #include <node/context.h>
       9                 :             : #include <node/mempool_args.h>
      10                 :             : #include <policy/rbf.h>
      11                 :             : #include <policy/truc_policy.h>
      12                 :             : #include <txmempool.h>
      13                 :             : #include <util/check.h>
      14                 :             : #include <util/time.h>
      15                 :             : #include <util/translation.h>
      16                 :             : #include <validation.h>
      17                 :             : 
      18                 :             : using node::NodeContext;
      19                 :             : 
      20                 :         180 : CTxMemPool::Options MemPoolOptionsForTest(const NodeContext& node)
      21                 :             : {
      22                 :         180 :     CTxMemPool::Options mempool_opts{
      23                 :             :         // Default to always checking mempool regardless of
      24                 :             :         // chainparams.DefaultConsistencyChecks for tests
      25                 :             :         .check_ratio = 1,
      26                 :         180 :         .signals = node.validation_signals.get(),
      27                 :         180 :     };
      28                 :         180 :     const auto result{ApplyArgsManOptions(*node.args, ::Params(), mempool_opts)};
      29         [ +  - ]:         180 :     Assert(result);
      30                 :         180 :     return mempool_opts;
      31                 :         180 : }
      32                 :             : 
      33                 :       26804 : CTxMemPoolEntry TestMemPoolEntryHelper::FromTx(const CMutableTransaction& tx) const
      34                 :             : {
      35         [ +  - ]:       53608 :     return FromTx(MakeTransactionRef(tx));
      36                 :             : }
      37                 :             : 
      38                 :       27589 : CTxMemPoolEntry TestMemPoolEntryHelper::FromTx(const CTransactionRef& tx) const
      39                 :             : {
      40                 :       27589 :     return CTxMemPoolEntry{tx, nFee, TicksSinceEpoch<std::chrono::seconds>(time), nHeight, m_sequence, spendsCoinbase, sigOpCost, lp};
      41                 :             : }
      42                 :             : 
      43                 :          19 : std::optional<std::string> CheckPackageMempoolAcceptResult(const Package& txns,
      44                 :             :                                                            const PackageMempoolAcceptResult& result,
      45                 :             :                                                            bool expect_valid,
      46                 :             :                                                            const CTxMemPool* mempool)
      47                 :             : {
      48         [ +  + ]:          19 :     if (expect_valid) {
      49         [ -  + ]:          14 :         if (result.m_state.IsInvalid()) {
      50         [ #  # ]:           0 :             return strprintf("Package validation unexpectedly failed: %s", result.m_state.ToString());
      51                 :             :         }
      52                 :             :     } else {
      53         [ -  + ]:           5 :         if (result.m_state.IsValid()) {
      54         [ #  # ]:           0 :             return strprintf("Package validation unexpectedly succeeded. %s", result.m_state.ToString());
      55                 :             :         }
      56                 :             :     }
      57   [ +  -  -  + ]:          19 :     if (result.m_state.GetResult() != PackageValidationResult::PCKG_POLICY && txns.size() != result.m_tx_results.size()) {
      58                 :           0 :         return strprintf("txns size %u does not match tx results size %u", txns.size(), result.m_tx_results.size());
      59                 :             :     }
      60         [ +  + ]:          58 :     for (const auto& tx : txns) {
      61                 :          39 :         const auto& wtxid = tx->GetWitnessHash();
      62         [ -  + ]:          39 :         if (result.m_tx_results.count(wtxid) == 0) {
      63         [ #  # ]:           0 :             return strprintf("result not found for tx %s", wtxid.ToString());
      64                 :             :         }
      65                 :             : 
      66                 :          39 :         const auto& atmp_result = result.m_tx_results.at(wtxid);
      67                 :          39 :         const bool valid{atmp_result.m_result_type == MempoolAcceptResult::ResultType::VALID};
      68   [ +  +  +  - ]:          39 :         if (expect_valid && atmp_result.m_state.IsInvalid()) {
      69   [ #  #  #  # ]:           0 :             return strprintf("tx %s unexpectedly failed: %s", wtxid.ToString(), atmp_result.m_state.ToString());
      70                 :             :         }
      71                 :             : 
      72                 :             :         // Each subpackage is allowed MAX_REPLACEMENT_CANDIDATES replacements (only checking individually here)
      73         [ -  + ]:          39 :         if (atmp_result.m_replaced_transactions.size() > MAX_REPLACEMENT_CANDIDATES) {
      74                 :           0 :             return strprintf("tx %s result replaced too many transactions",
      75         [ #  # ]:           0 :                                 wtxid.ToString());
      76                 :             :         }
      77                 :             : 
      78                 :             :         // Replacements can't happen for subpackages larger than 2
      79   [ +  +  +  - ]:          39 :         if (!atmp_result.m_replaced_transactions.empty() &&
      80   [ +  +  +  -  :          39 :             atmp_result.m_wtxids_fee_calculations.has_value() && atmp_result.m_wtxids_fee_calculations.value().size() > 2) {
                   +  - ]
      81                 :           0 :              return strprintf("tx %s was part of a too-large package RBF subpackage",
      82         [ #  # ]:           0 :                                 wtxid.ToString());
      83                 :             :         }
      84                 :             : 
      85   [ +  +  +  - ]:          39 :         if (!atmp_result.m_replaced_transactions.empty() && mempool) {
      86                 :           3 :             LOCK(mempool->cs);
      87                 :             :             // If replacements occurred and it used 2 transactions, this is a package RBF and should result in a cluster of size 2
      88   [ +  -  +  + ]:           3 :             if (atmp_result.m_wtxids_fee_calculations.has_value() && atmp_result.m_wtxids_fee_calculations.value().size() == 2) {
      89   [ +  -  +  -  :           2 :                 const auto cluster = mempool->GatherClusters({tx->GetHash()});
                   -  + ]
      90   [ -  +  -  -  :           1 :                 if (cluster.size() != 2) return strprintf("tx %s has too many ancestors or descendants for a package rbf", wtxid.ToString());
                   -  - ]
      91         [ -  - ]:           1 :             }
      92                 :           3 :         }
      93                 :             : 
      94                 :             :         // m_vsize and m_base_fees should exist iff the result was VALID or MEMPOOL_ENTRY
      95                 :          39 :         const bool mempool_entry{atmp_result.m_result_type == MempoolAcceptResult::ResultType::MEMPOOL_ENTRY};
      96         [ -  + ]:          39 :         if (atmp_result.m_base_fees.has_value() != (valid || mempool_entry)) {
      97   [ #  #  #  # ]:           0 :             return strprintf("tx %s result should %shave m_base_fees", wtxid.ToString(), valid || mempool_entry ? "" : "not ");
      98                 :             :         }
      99         [ -  + ]:          39 :         if (atmp_result.m_vsize.has_value() != (valid || mempool_entry)) {
     100   [ #  #  #  # ]:           0 :             return strprintf("tx %s result should %shave m_vsize", wtxid.ToString(), valid || mempool_entry ? "" : "not ");
     101                 :             :         }
     102                 :             : 
     103                 :             :         // m_other_wtxid should exist iff the result was DIFFERENT_WITNESS
     104                 :          39 :         const bool diff_witness{atmp_result.m_result_type == MempoolAcceptResult::ResultType::DIFFERENT_WITNESS};
     105         [ -  + ]:          39 :         if (atmp_result.m_other_wtxid.has_value() != diff_witness) {
     106   [ #  #  #  # ]:           0 :             return strprintf("tx %s result should %shave m_other_wtxid", wtxid.ToString(), diff_witness ? "" : "not ");
     107                 :             :         }
     108                 :             : 
     109                 :             :         // m_effective_feerate and m_wtxids_fee_calculations should exist iff the result was valid
     110                 :             :         // or if the failure was TX_RECONSIDERABLE
     111   [ +  +  +  + ]:          39 :         const bool valid_or_reconsiderable{atmp_result.m_result_type == MempoolAcceptResult::ResultType::VALID ||
     112         [ +  + ]:          18 :                     atmp_result.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE};
     113         [ -  + ]:          39 :         if (atmp_result.m_effective_feerate.has_value() != valid_or_reconsiderable) {
     114                 :           0 :             return strprintf("tx %s result should %shave m_effective_feerate",
     115   [ #  #  #  # ]:           0 :                                     wtxid.ToString(), valid ? "" : "not ");
     116                 :             :         }
     117         [ -  + ]:          39 :         if (atmp_result.m_wtxids_fee_calculations.has_value() != valid_or_reconsiderable) {
     118                 :           0 :             return strprintf("tx %s result should %shave m_effective_feerate",
     119   [ #  #  #  # ]:           0 :                                     wtxid.ToString(), valid ? "" : "not ");
     120                 :             :         }
     121                 :             : 
     122         [ +  + ]:          39 :         if (mempool) {
     123                 :             :             // The tx by txid should be in the mempool iff the result was not INVALID.
     124                 :          36 :             const bool txid_in_mempool{atmp_result.m_result_type != MempoolAcceptResult::ResultType::INVALID};
     125         [ -  + ]:          36 :             if (mempool->exists(GenTxid::Txid(tx->GetHash())) != txid_in_mempool) {
     126   [ #  #  #  # ]:           0 :                 return strprintf("tx %s should %sbe in mempool", wtxid.ToString(), txid_in_mempool ? "" : "not ");
     127                 :             :             }
     128                 :             :             // Additionally, if the result was DIFFERENT_WITNESS, we shouldn't be able to find the tx in mempool by wtxid.
     129   [ +  +  +  + ]:          36 :             if (tx->HasWitness() && atmp_result.m_result_type == MempoolAcceptResult::ResultType::DIFFERENT_WITNESS) {
     130         [ -  + ]:           3 :                 if (mempool->exists(GenTxid::Wtxid(wtxid))) {
     131         [ #  # ]:           0 :                     return strprintf("wtxid %s should not be in mempool", wtxid.ToString());
     132                 :             :                 }
     133                 :             :             }
     134         [ +  + ]:          41 :             for (const auto& tx_ref : atmp_result.m_replaced_transactions) {
     135         [ -  + ]:           5 :                 if (mempool->exists(GenTxid::Txid(tx_ref->GetHash()))) {
     136         [ #  # ]:           0 :                     return strprintf("tx %s should not be in mempool as it was replaced", tx_ref->GetWitnessHash().ToString());
     137                 :             :                 }
     138                 :             :             }
     139                 :             :         }
     140                 :             :     }
     141                 :          19 :     return std::nullopt;
     142                 :             : }
     143                 :             : 
     144                 :           0 : void CheckMempoolTRUCInvariants(const CTxMemPool& tx_pool)
     145                 :             : {
     146                 :           0 :     LOCK(tx_pool.cs);
     147   [ #  #  #  # ]:           0 :     for (const auto& tx_info : tx_pool.infoAll()) {
     148   [ #  #  #  # ]:           0 :         const auto& entry = *Assert(tx_pool.GetEntry(tx_info.tx->GetHash()));
     149         [ #  # ]:           0 :         if (tx_info.tx->version == TRUC_VERSION) {
     150                 :             :             // Check that special maximum virtual size is respected
     151   [ #  #  #  # ]:           0 :             Assert(entry.GetTxSize() <= TRUC_MAX_VSIZE);
     152                 :             : 
     153                 :             :             // Check that special TRUC ancestor/descendant limits and rules are always respected
     154         [ #  # ]:           0 :             Assert(entry.GetCountWithDescendants() <= TRUC_DESCENDANT_LIMIT);
     155         [ #  # ]:           0 :             Assert(entry.GetCountWithAncestors() <= TRUC_ANCESTOR_LIMIT);
     156         [ #  # ]:           0 :             Assert(entry.GetSizeWithDescendants() <= TRUC_MAX_VSIZE + TRUC_CHILD_MAX_VSIZE);
     157         [ #  # ]:           0 :             Assert(entry.GetSizeWithAncestors() <= TRUC_MAX_VSIZE + TRUC_CHILD_MAX_VSIZE);
     158                 :             : 
     159                 :             :             // If this transaction has at least 1 ancestor, it's a "child" and has restricted weight.
     160         [ #  # ]:           0 :             if (entry.GetCountWithAncestors() > 1) {
     161   [ #  #  #  # ]:           0 :                 Assert(entry.GetTxSize() <= TRUC_CHILD_MAX_VSIZE);
     162                 :             :                 // All TRUC transactions must only have TRUC unconfirmed parents.
     163         [ #  # ]:           0 :                 const auto& parents = entry.GetMemPoolParentsConst();
     164   [ #  #  #  # ]:           0 :                 Assert(parents.begin()->get().GetSharedTx()->version == TRUC_VERSION);
     165                 :             :             }
     166         [ #  # ]:           0 :         } else if (entry.GetCountWithAncestors() > 1) {
     167                 :             :             // All non-TRUC transactions must only have non-TRUC unconfirmed parents.
     168         [ #  # ]:           0 :             for (const auto& parent : entry.GetMemPoolParentsConst()) {
     169   [ #  #  #  # ]:           0 :                 Assert(parent.get().GetSharedTx()->version != TRUC_VERSION);
     170                 :             :             }
     171                 :             :         }
     172         [ #  # ]:           0 :     }
     173                 :           0 : }
        

Generated by: LCOV version 2.0-1