LCOV - code coverage report
Current view: top level - src/node - mini_miner.cpp (source / functions) Coverage Total Hit
Test: fuzz_coverage.info Lines: 85.2 % 250 213
Test Date: 2024-09-01 05:20:30 Functions: 85.7 % 14 12
Branches: 51.3 % 396 203

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2023 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 <node/mini_miner.h>
       6                 :             : 
       7                 :             : #include <boost/multi_index/detail/hash_index_iterator.hpp>
       8                 :             : #include <boost/operators.hpp>
       9                 :             : #include <consensus/amount.h>
      10                 :             : #include <policy/feerate.h>
      11                 :             : #include <primitives/transaction.h>
      12                 :             : #include <sync.h>
      13                 :             : #include <txmempool.h>
      14                 :             : #include <uint256.h>
      15                 :             : #include <util/check.h>
      16                 :             : 
      17                 :             : #include <algorithm>
      18                 :             : #include <numeric>
      19                 :             : #include <utility>
      20                 :             : 
      21                 :             : namespace node {
      22                 :             : 
      23                 :      534005 : MiniMiner::MiniMiner(const CTxMemPool& mempool, const std::vector<COutPoint>& outpoints)
      24                 :             : {
      25   [ +  -  +  - ]:      534005 :     LOCK(mempool.cs);
      26                 :             :     // Find which outpoints to calculate bump fees for.
      27                 :             :     // Anything that's spent by the mempool is to-be-replaced
      28                 :             :     // Anything otherwise unavailable just has a bump fee of 0
      29         [ +  + ]:     7853321 :     for (const auto& outpoint : outpoints) {
      30   [ +  -  +  -  :     7319316 :         if (!mempool.exists(GenTxid::Txid(outpoint.hash))) {
             +  -  +  + ]
      31                 :             :             // This UTXO is either confirmed or not yet submitted to mempool.
      32                 :             :             // If it's confirmed, no bump fee is required.
      33                 :             :             // If it's not yet submitted, we have no information, so return 0.
      34         [ -  + ]:     7024885 :             m_bump_fees.emplace(outpoint, 0);
      35                 :     7024885 :             continue;
      36                 :             :         }
      37                 :             : 
      38                 :             :         // UXTO is created by transaction in mempool, add to map.
      39                 :             :         // Note: This will either create a missing entry or add the outpoint to an existing entry
      40   [ +  -  +  -  :      294431 :         m_requested_outpoints_by_txid[outpoint.hash].push_back(outpoint);
                   +  - ]
      41                 :             : 
      42   [ -  +  +  + ]:      324665 :         if (const auto ptx{mempool.GetConflictTx(outpoint)}) {
      43                 :             :             // This outpoint is already being spent by another transaction in the mempool. We
      44                 :             :             // assume that the caller wants to replace this transaction and its descendants. It
      45                 :             :             // would be unusual for the transaction to have descendants as the wallet won’t normally
      46                 :             :             // attempt to replace transactions with descendants. If the outpoint is from a mempool
      47                 :             :             // transaction, we still need to calculate its ancestors bump fees (added to
      48                 :             :             // m_requested_outpoints_by_txid below), but after removing the to-be-replaced entries.
      49                 :             :             //
      50                 :             :             // Note that the descendants of a transaction include the transaction itself. Also note,
      51                 :             :             // that this is only calculating bump fees. RBF fee rules should be handled separately.
      52                 :       30234 :             CTxMemPool::setEntries descendants;
      53   [ +  -  +  -  :       30234 :             mempool.CalculateDescendants(mempool.GetIter(ptx->GetHash()).value(), descendants);
          +  -  +  -  +  
                      - ]
      54         [ +  + ]:     3341482 :             for (const auto& desc_txiter : descendants) {
      55   [ +  -  +  -  :     3311248 :                 m_to_be_replaced.insert(desc_txiter->GetTx().GetHash());
          +  -  +  -  +  
                      - ]
      56                 :     3311248 :             }
      57                 :       30234 :         }
      58         [ +  + ]:     7319316 :     }
      59                 :             : 
      60                 :             :     // No unconfirmed UTXOs, so nothing mempool-related needs to be calculated.
      61         [ +  + ]:      534005 :     if (m_requested_outpoints_by_txid.empty()) return;
      62                 :             : 
      63                 :             :     // Calculate the cluster and construct the entry map.
      64                 :        2964 :     std::vector<uint256> txids_needed;
      65         [ +  - ]:        2964 :     txids_needed.reserve(m_requested_outpoints_by_txid.size());
      66         [ +  + ]:      241699 :     for (const auto& [txid, _]: m_requested_outpoints_by_txid) {
      67         [ +  - ]:      238735 :         txids_needed.push_back(txid);
      68                 :      238735 :     }
      69         [ +  - ]:        2964 :     const auto cluster = mempool.GatherClusters(txids_needed);
      70         [ -  + ]:        2964 :     if (cluster.empty()) {
      71                 :             :         // An empty cluster means that at least one of the transactions is missing from the mempool
      72                 :             :         // (should not be possible given processing above) or DoS limit was hit.
      73                 :           0 :         m_ready_to_calculate = false;
      74                 :           0 :         return;
      75                 :             :     }
      76                 :             : 
      77                 :             :     // Add every entry to m_entries_by_txid and m_entries, except the ones that will be replaced.
      78         [ +  + ]:      343155 :     for (const auto& txiter : cluster) {
      79   [ +  -  +  -  :      340191 :         if (!m_to_be_replaced.count(txiter->GetTx().GetHash())) {
          +  -  +  -  +  
                -  +  + ]
      80   [ +  -  +  -  :      480938 :             auto [mapiter, success] = m_entries_by_txid.emplace(txiter->GetTx().GetHash(),
             +  -  -  + ]
      81   [ +  -  +  -  :      480938 :                 MiniMinerMempoolEntry{/*tx_in=*/txiter->GetSharedTx(),
                   +  - ]
      82   [ +  -  +  - ]:      240469 :                                       /*vsize_self=*/txiter->GetTxSize(),
      83   [ +  -  +  - ]:      240469 :                                       /*vsize_ancestor=*/txiter->GetSizeWithAncestors(),
      84   [ +  -  +  - ]:      240469 :                                       /*fee_self=*/txiter->GetModifiedFee(),
      85   [ +  -  +  - ]:      240469 :                                       /*fee_ancestor=*/txiter->GetModFeesWithAncestors()});
      86   [ +  -  +  - ]:      480938 :             m_entries.push_back(mapiter);
      87                 :      240469 :         } else {
      88   [ +  -  +  -  :       99722 :             auto outpoints_it = m_requested_outpoints_by_txid.find(txiter->GetTx().GetHash());
          +  -  +  -  +  
                      - ]
      89         [ +  + ]:       99722 :             if (outpoints_it != m_requested_outpoints_by_txid.end()) {
      90                 :             :                 // This UTXO is the output of a to-be-replaced transaction. Bump fee is 0; spending
      91                 :             :                 // this UTXO is impossible as it will no longer exist after the replacement.
      92         [ +  + ]:      114786 :                 for (const auto& outpoint : outpoints_it->second) {
      93         [ +  - ]:       57420 :                     m_bump_fees.emplace(outpoint, 0);
      94                 :       57420 :                 }
      95         [ +  - ]:       57366 :                 m_requested_outpoints_by_txid.erase(outpoints_it);
      96                 :       57366 :             }
      97                 :       99722 :         }
      98                 :      340191 :     }
      99                 :             : 
     100                 :             :     // Build the m_descendant_set_by_txid cache.
     101         [ +  + ]:      343155 :     for (const auto& txiter : cluster) {
     102   [ +  -  +  -  :      340191 :         const auto& txid = txiter->GetTx().GetHash();
                   +  - ]
     103                 :             :         // Cache descendants for future use. Unlike the real mempool, a descendant MiniMinerMempoolEntry
     104                 :             :         // will not exist without its ancestor MiniMinerMempoolEntry, so these sets won't be invalidated.
     105                 :      340191 :         std::vector<MockEntryMap::iterator> cached_descendants;
     106   [ +  -  +  - ]:      340191 :         const bool remove{m_to_be_replaced.count(txid) > 0};
     107                 :      340191 :         CTxMemPool::setEntries descendants;
     108         [ +  - ]:      340191 :         mempool.CalculateDescendants(txiter, descendants);
     109   [ +  -  +  - ]:      340191 :         Assume(descendants.count(txiter) > 0);
     110         [ +  + ]:    31969492 :         for (const auto& desc_txiter : descendants) {
     111   [ +  -  +  -  :    31629301 :             const auto txid_desc = desc_txiter->GetTx().GetHash();
                   +  - ]
     112   [ +  -  +  - ]:    31629301 :             const bool remove_desc{m_to_be_replaced.count(txid_desc) > 0};
     113   [ +  -  +  - ]:    31629301 :             auto desc_it{m_entries_by_txid.find(txid_desc)};
     114         [ -  + ]:    31629301 :             Assume((desc_it == m_entries_by_txid.end()) == remove_desc);
     115   [ +  +  +  - ]:    31629301 :             if (remove) Assume(remove_desc);
     116                 :             :             // It's possible that remove=false but remove_desc=true.
     117   [ +  +  +  + ]:    31629301 :             if (!remove && !remove_desc) {
     118         [ +  - ]:    16266697 :                 cached_descendants.push_back(desc_it);
     119                 :    16266697 :             }
     120                 :    31629301 :         }
     121         [ +  + ]:      340191 :         if (remove) {
     122         [ -  + ]:       99722 :             Assume(cached_descendants.empty());
     123                 :       99722 :         } else {
     124         [ +  - ]:      240469 :             m_descendant_set_by_txid.emplace(txid, cached_descendants);
     125                 :             :         }
     126                 :      340191 :     }
     127                 :             : 
     128                 :             :     // Release the mempool lock; we now have all the information we need for a subset of the entries
     129                 :             :     // we care about. We will solely operate on the MiniMinerMempoolEntry map from now on.
     130         [ +  - ]:        2964 :     Assume(m_in_block.empty());
     131         [ +  - ]:        2964 :     Assume(m_requested_outpoints_by_txid.size() <= outpoints.size());
     132         [ +  - ]:        2964 :     SanityCheck();
     133                 :           0 : }
     134                 :             : 
     135                 :           0 : MiniMiner::MiniMiner(const std::vector<MiniMinerMempoolEntry>& manual_entries,
     136                 :             :                      const std::map<Txid, std::set<Txid>>& descendant_caches)
     137                 :             : {
     138   [ #  #  #  # ]:           0 :     for (const auto& entry : manual_entries) {
     139   [ #  #  #  # ]:           0 :         const auto& txid = entry.GetTx().GetHash();
     140                 :             :         // We need to know the descendant set of every transaction.
     141   [ #  #  #  #  :           0 :         if (!Assume(descendant_caches.count(txid) > 0)) {
                   #  # ]
     142                 :           0 :             m_ready_to_calculate = false;
     143                 :           0 :             return;
     144                 :             :         }
     145                 :             :         // Just forward these args onto MiniMinerMempoolEntry
     146         [ #  # ]:           0 :         auto [mapiter, success] = m_entries_by_txid.emplace(txid, entry);
     147                 :             :         // Txids must be unique; this txid shouldn't already be an entry in m_entries_by_txid
     148   [ #  #  #  #  :           0 :         if (Assume(success)) m_entries.push_back(mapiter);
             #  #  #  # ]
     149   [ #  #  #  # ]:           0 :     }
     150                 :             :     // Descendant cache is already built, but we need to translate them to m_entries_by_txid iters.
     151   [ #  #  #  # ]:           0 :     for (const auto& [txid, desc_txids] : descendant_caches) {
     152                 :             :         // Descendant cache should include at least the tx itself.
     153   [ #  #  #  #  :           0 :         if (!Assume(!desc_txids.empty())) {
                   #  # ]
     154                 :           0 :             m_ready_to_calculate = false;
     155                 :           0 :             return;
     156                 :             :         }
     157                 :           0 :         std::vector<MockEntryMap::iterator> descendants;
     158   [ #  #  #  # ]:           0 :         for (const auto& desc_txid : desc_txids) {
     159   [ #  #  #  # ]:           0 :             auto desc_it{m_entries_by_txid.find(desc_txid)};
     160                 :             :             // Descendants should only include transactions with corresponding entries.
     161   [ #  #  #  # ]:           0 :             if (!Assume(desc_it != m_entries_by_txid.end())) {
     162                 :           0 :                 m_ready_to_calculate = false;
     163                 :           0 :                 return;
     164                 :             :             } else {
     165         [ #  # ]:           0 :                 descendants.emplace_back(desc_it);
     166                 :             :             }
     167   [ #  #  #  # ]:           0 :         }
     168   [ #  #  #  # ]:           0 :         m_descendant_set_by_txid.emplace(txid, descendants);
     169   [ #  #  #  # ]:           0 :     }
     170         [ #  # ]:           0 :     Assume(m_to_be_replaced.empty());
     171         [ #  # ]:           0 :     Assume(m_requested_outpoints_by_txid.empty());
     172         [ #  # ]:           0 :     Assume(m_bump_fees.empty());
     173         [ #  # ]:           0 :     Assume(m_inclusion_order.empty());
     174         [ #  # ]:           0 :     SanityCheck();
     175                 :           0 : }
     176                 :             : 
     177                 :             : // Compare by min(ancestor feerate, individual feerate), then txid
     178                 :             : //
     179                 :             : // Under the ancestor-based mining approach, high-feerate children can pay for parents, but high-feerate
     180                 :             : // parents do not incentive inclusion of their children. Therefore the mining algorithm only considers
     181                 :             : // transactions for inclusion on basis of the minimum of their own feerate or their ancestor feerate.
     182                 :             : struct AncestorFeerateComparator
     183                 :             : {
     184                 :             :     template<typename I>
     185                 :    83811955 :     bool operator()(const I& a, const I& b) const {
     186                 :   251435865 :         auto min_feerate = [](const MiniMinerMempoolEntry& e) -> FeeFrac {
     187                 :   167623910 :             FeeFrac self_feerate(e.GetModifiedFee(), e.GetTxSize());
     188                 :   167623910 :             FeeFrac ancestor_feerate(e.GetModFeesWithAncestors(), e.GetSizeWithAncestors());
     189                 :   167623910 :             return std::min(ancestor_feerate, self_feerate);
     190                 :   167623910 :         };
     191                 :    83811955 :         FeeFrac a_feerate{min_feerate(a->second)};
     192                 :    83811955 :         FeeFrac b_feerate{min_feerate(b->second)};
     193         [ +  + ]:    83811955 :         if (a_feerate != b_feerate) {
     194                 :    29861170 :             return a_feerate > b_feerate;
     195                 :             :         }
     196                 :             :         // Use txid as tiebreaker for stable sorting
     197                 :    53950785 :         return a->first < b->first;
     198                 :    83811955 :     }
     199                 :             : };
     200                 :             : 
     201                 :       94408 : void MiniMiner::DeleteAncestorPackage(const std::set<MockEntryMap::iterator, IteratorComparator>& ancestors)
     202                 :             : {
     203                 :       94408 :     Assume(ancestors.size() >= 1);
     204                 :             :     // "Mine" all transactions in this ancestor set.
     205         [ +  + ]:      304731 :     for (auto& anc : ancestors) {
     206                 :      210323 :         Assume(m_in_block.count(anc->first) == 0);
     207                 :      210323 :         m_in_block.insert(anc->first);
     208                 :      210323 :         m_total_fees += anc->second.GetModifiedFee();
     209                 :      210323 :         m_total_vsize += anc->second.GetTxSize();
     210                 :      210323 :         auto it = m_descendant_set_by_txid.find(anc->first);
     211                 :             :         // Each entry’s descendant set includes itself
     212                 :      210323 :         Assume(it != m_descendant_set_by_txid.end());
     213         [ +  + ]:    13079183 :         for (auto& descendant : it->second) {
     214                 :             :             // If these fail, we must be double-deducting.
     215                 :    12868860 :             Assume(descendant->second.GetModFeesWithAncestors() >= anc->second.GetModifiedFee());
     216                 :    12868860 :             Assume(descendant->second.GetSizeWithAncestors() >= anc->second.GetTxSize());
     217                 :    12868860 :             descendant->second.UpdateAncestorState(-anc->second.GetTxSize(), -anc->second.GetModifiedFee());
     218                 :    12868860 :         }
     219                 :      210323 :     }
     220                 :             :     // Delete these entries.
     221         [ +  + ]:      304731 :     for (const auto& anc : ancestors) {
     222                 :      210323 :         m_descendant_set_by_txid.erase(anc->first);
     223                 :             :         // The above loop should have deducted each ancestor's size and fees from each of their
     224                 :             :         // respective descendants exactly once.
     225                 :      210323 :         Assume(anc->second.GetModFeesWithAncestors() == 0);
     226                 :      210323 :         Assume(anc->second.GetSizeWithAncestors() == 0);
     227                 :      210323 :         auto vec_it = std::find(m_entries.begin(), m_entries.end(), anc);
     228                 :      210323 :         Assume(vec_it != m_entries.end());
     229                 :      210323 :         m_entries.erase(vec_it);
     230                 :      210323 :         m_entries_by_txid.erase(anc);
     231                 :      210323 :     }
     232                 :       94408 : }
     233                 :             : 
     234                 :       97372 : void MiniMiner::SanityCheck() const
     235                 :             : {
     236                 :             :     // m_entries, m_entries_by_txid, and m_descendant_set_by_txid all same size
     237                 :       97372 :     Assume(m_entries.size() == m_entries_by_txid.size());
     238                 :       97372 :     Assume(m_entries.size() == m_descendant_set_by_txid.size());
     239                 :             :     // Cached ancestor values should be at least as large as the transaction's own fee and size
     240         [ -  + ]:    11078227 :     Assume(std::all_of(m_entries.begin(), m_entries.end(), [](const auto& entry) {
     241                 :             :         return entry->second.GetSizeWithAncestors() >= entry->second.GetTxSize() &&
     242                 :             :                entry->second.GetModFeesWithAncestors() >= entry->second.GetModifiedFee();}));
     243                 :             :     // None of the entries should be to-be-replaced transactions
     244                 :     3188282 :     Assume(std::all_of(m_to_be_replaced.begin(), m_to_be_replaced.end(),
     245                 :             :         [&](const auto& txid){return m_entries_by_txid.find(txid) == m_entries_by_txid.end();}));
     246                 :       97372 : }
     247                 :             : 
     248                 :      534005 : void MiniMiner::BuildMockTemplate(std::optional<CFeeRate> target_feerate)
     249                 :             : {
     250                 :      534005 :     const auto num_txns{m_entries_by_txid.size()};
     251                 :      534005 :     uint32_t sequence_num{0};
     252         [ +  + ]:      628413 :     while (!m_entries_by_txid.empty()) {
     253                 :             :         // Sort again, since transaction removal may change some m_entries' ancestor feerates.
     254                 :       95154 :         std::sort(m_entries.begin(), m_entries.end(), AncestorFeerateComparator());
     255                 :             : 
     256                 :             :         // Pick highest ancestor feerate entry.
     257                 :       95154 :         auto best_iter = m_entries.begin();
     258                 :       95154 :         Assume(best_iter != m_entries.end());
     259                 :       95154 :         const auto ancestor_package_size = (*best_iter)->second.GetSizeWithAncestors();
     260                 :       95154 :         const auto ancestor_package_fee = (*best_iter)->second.GetModFeesWithAncestors();
     261                 :             :         // Stop here. Everything that didn't "make it into the block" has bumpfee.
     262   [ +  -  +  + ]:       95154 :         if (target_feerate.has_value() &&
     263                 :       95154 :             ancestor_package_fee < target_feerate->GetFee(ancestor_package_size)) {
     264                 :         746 :             break;
     265                 :             :         }
     266                 :             : 
     267                 :             :         // Calculate ancestors on the fly. This lookup should be fairly cheap, and ancestor sets
     268                 :             :         // change at every iteration, so this is more efficient than maintaining a cache.
     269                 :       94408 :         std::set<MockEntryMap::iterator, IteratorComparator> ancestors;
     270                 :             :         {
     271                 :       94408 :             std::set<MockEntryMap::iterator, IteratorComparator> to_process;
     272         [ -  + ]:       94408 :             to_process.insert(*best_iter);
     273         [ +  + ]:      304731 :             while (!to_process.empty()) {
     274                 :      210323 :                 auto iter = to_process.begin();
     275         [ -  + ]:      210323 :                 Assume(iter != to_process.end());
     276         [ +  - ]:      210323 :                 ancestors.insert(*iter);
     277   [ -  +  +  + ]:     1133069 :                 for (const auto& input : (*iter)->second.GetTx().vin) {
     278   [ +  -  +  -  :     1547704 :                     if (auto parent_it{m_entries_by_txid.find(input.prevout.hash)}; parent_it != m_entries_by_txid.end()) {
                   +  + ]
     279   [ +  -  +  + ]:      624958 :                         if (ancestors.count(parent_it) == 0) {
     280         [ +  - ]:      497931 :                             to_process.insert(parent_it);
     281                 :      497931 :                         }
     282                 :      624958 :                     }
     283                 :      922746 :                 }
     284         [ +  - ]:      210323 :                 to_process.erase(iter);
     285                 :      210323 :             }
     286                 :       94408 :         }
     287                 :             :         // Track the order in which transactions were selected.
     288         [ +  + ]:      304731 :         for (const auto& ancestor : ancestors) {
     289   [ +  -  +  - ]:      210323 :             m_inclusion_order.emplace(Txid::FromUint256(ancestor->first), sequence_num);
     290                 :      210323 :         }
     291         [ +  - ]:       94408 :         DeleteAncestorPackage(ancestors);
     292         [ +  - ]:       94408 :         SanityCheck();
     293                 :       94408 :         ++sequence_num;
     294      [ -  +  + ]:       95154 :     }
     295         [ +  - ]:      534005 :     if (!target_feerate.has_value()) {
     296                 :           0 :         Assume(m_in_block.size() == num_txns);
     297                 :           0 :     } else {
     298         [ +  + ]:      534005 :         Assume(m_in_block.empty() || m_total_fees >= target_feerate->GetFee(m_total_vsize));
     299                 :             :     }
     300         [ +  + ]:      534005 :     Assume(m_in_block.empty() || sequence_num > 0);
     301                 :      534005 :     Assume(m_in_block.size() == m_inclusion_order.size());
     302                 :             :     // Do not try to continue building the block template with a different feerate.
     303                 :      534005 :     m_ready_to_calculate = false;
     304                 :      534005 : }
     305                 :             : 
     306                 :             : 
     307                 :           0 : std::map<Txid, uint32_t> MiniMiner::Linearize()
     308                 :             : {
     309                 :           0 :     BuildMockTemplate(std::nullopt);
     310                 :           0 :     return m_inclusion_order;
     311                 :             : }
     312                 :             : 
     313                 :      192107 : std::map<COutPoint, CAmount> MiniMiner::CalculateBumpFees(const CFeeRate& target_feerate)
     314                 :             : {
     315         [ -  + ]:      192107 :     if (!m_ready_to_calculate) return {};
     316                 :             :     // Build a block template until the target feerate is hit.
     317                 :      192107 :     BuildMockTemplate(target_feerate);
     318                 :             : 
     319                 :             :     // Each transaction that "made it into the block" has a bumpfee of 0, i.e. they are part of an
     320                 :             :     // ancestor package with at least the target feerate and don't need to be bumped.
     321         [ +  + ]:      267583 :     for (const auto& txid : m_in_block) {
     322                 :             :         // Not all of the block transactions were necessarily requested.
     323                 :       75476 :         auto it = m_requested_outpoints_by_txid.find(txid);
     324         [ +  + ]:       75476 :         if (it != m_requested_outpoints_by_txid.end()) {
     325         [ +  + ]:      100175 :             for (const auto& outpoint : it->second) {
     326                 :       50151 :                 m_bump_fees.emplace(outpoint, 0);
     327                 :       50151 :             }
     328                 :       50024 :             m_requested_outpoints_by_txid.erase(it);
     329                 :       50024 :         }
     330                 :       75476 :     }
     331                 :             : 
     332                 :             :     // A transactions and its ancestors will only be picked into a block when
     333                 :             :     // both the ancestor set feerate and the individual feerate meet the target
     334                 :             :     // feerate.
     335                 :             :     //
     336                 :             :     // We had to convince ourselves that after running the mini miner and
     337                 :             :     // picking all eligible transactions into our MockBlockTemplate, there
     338                 :             :     // could still be transactions remaining that have a lower individual
     339                 :             :     // feerate than their ancestor feerate. So here is an example:
     340                 :             :     //
     341                 :             :     //               ┌─────────────────┐
     342                 :             :     //               │                 │
     343                 :             :     //               │   Grandparent   │
     344                 :             :     //               │    1700 vB      │
     345                 :             :     //               │    1700 sats    │                    Target feerate: 10    s/vB
     346                 :             :     //               │       1 s/vB    │    GP Ancestor Set Feerate (ASFR):  1    s/vB
     347                 :             :     //               │                 │                           P1_ASFR:  9.84 s/vB
     348                 :             :     //               └──────▲───▲──────┘                           P2_ASFR:  2.47 s/vB
     349                 :             :     //                      │   │                                   C_ASFR: 10.27 s/vB
     350                 :             :     // ┌───────────────┐    │   │    ┌──────────────┐
     351                 :             :     // │               ├────┘   └────┤              │             ⇒ C_FR < TFR < C_ASFR
     352                 :             :     // │   Parent 1    │             │   Parent 2   │
     353                 :             :     // │    200 vB     │             │    200 vB    │
     354                 :             :     // │  17000 sats   │             │   3000 sats  │
     355                 :             :     // │     85 s/vB   │             │     15 s/vB  │
     356                 :             :     // │               │             │              │
     357                 :             :     // └───────────▲───┘             └───▲──────────┘
     358                 :             :     //             │                     │
     359                 :             :     //             │    ┌───────────┐    │
     360                 :             :     //             └────┤           ├────┘
     361                 :             :     //                  │   Child   │
     362                 :             :     //                  │  100 vB   │
     363                 :             :     //                  │  900 sats │
     364                 :             :     //                  │    9 s/vB │
     365                 :             :     //                  │           │
     366                 :             :     //                  └───────────┘
     367                 :             :     //
     368                 :             :     // We therefore calculate both the bump fee that is necessary to elevate
     369                 :             :     // the individual transaction to the target feerate:
     370                 :             :     //         target_feerate × tx_size - tx_fees
     371                 :             :     // and the bump fee that is necessary to bump the entire ancestor set to
     372                 :             :     // the target feerate:
     373                 :             :     //         target_feerate × ancestor_set_size - ancestor_set_fees
     374                 :             :     // By picking the maximum from the two, we ensure that a transaction meets
     375                 :             :     // both criteria.
     376         [ +  + ]:      202211 :     for (const auto& [txid, outpoints] : m_requested_outpoints_by_txid) {
     377                 :       20208 :         auto it = m_entries_by_txid.find(txid);
     378                 :       10104 :         Assume(it != m_entries_by_txid.end());
     379         [ +  - ]:       10104 :         if (it != m_entries_by_txid.end()) {
     380                 :       10104 :             Assume(target_feerate.GetFee(it->second.GetSizeWithAncestors()) > std::min(it->second.GetModifiedFee(), it->second.GetModFeesWithAncestors()));
     381                 :       10104 :             CAmount bump_fee_with_ancestors = target_feerate.GetFee(it->second.GetSizeWithAncestors()) - it->second.GetModFeesWithAncestors();
     382                 :       10104 :             CAmount bump_fee_individual = target_feerate.GetFee(it->second.GetTxSize()) - it->second.GetModifiedFee();
     383                 :       10104 :             const CAmount bump_fee{std::max(bump_fee_with_ancestors, bump_fee_individual)};
     384                 :       10104 :             Assume(bump_fee >= 0);
     385         [ +  + ]:       30502 :             for (const auto& outpoint : outpoints) {
     386                 :       10294 :                 m_bump_fees.emplace(outpoint, bump_fee);
     387                 :       10294 :             }
     388                 :       10104 :         }
     389                 :       10104 :     }
     390                 :      192107 :     return m_bump_fees;
     391                 :      192107 : }
     392                 :             : 
     393                 :      340837 : std::optional<CAmount> MiniMiner::CalculateTotalBumpFees(const CFeeRate& target_feerate)
     394                 :             : {
     395         [ -  + ]:      340837 :     if (!m_ready_to_calculate) return std::nullopt;
     396                 :             :     // Build a block template until the target feerate is hit.
     397                 :      340837 :     BuildMockTemplate(target_feerate);
     398                 :             : 
     399                 :             :     // All remaining ancestors that are not part of m_in_block must be bumped, but no other relatives
     400                 :      340837 :     std::set<MockEntryMap::iterator, IteratorComparator> ancestors;
     401                 :      340837 :     std::set<MockEntryMap::iterator, IteratorComparator> to_process;
     402         [ +  + ]:      411069 :     for (const auto& [txid, outpoints] : m_requested_outpoints_by_txid) {
     403                 :             :         // Skip any ancestors that already have a miner score higher than the target feerate
     404                 :             :         // (already "made it" into the block)
     405   [ +  -  +  -  :      120256 :         if (m_in_block.count(txid)) continue;
                   +  + ]
     406   [ +  -  +  - ]:       20208 :         auto iter = m_entries_by_txid.find(txid);
     407         [ +  - ]:       10104 :         if (iter == m_entries_by_txid.end()) continue;
     408         [ +  - ]:       10104 :         to_process.insert(iter);
     409         [ +  - ]:       10104 :         ancestors.insert(iter);
     410   [ -  +  -  +  :       60128 :     }
                      + ]
     411                 :             : 
     412                 :      340837 :     std::set<uint256> has_been_processed;
     413         [ +  + ]:      354599 :     while (!to_process.empty()) {
     414                 :       13762 :         auto iter = to_process.begin();
     415         [ +  - ]:       13762 :         const CTransaction& tx = (*iter)->second.GetTx();
     416         [ +  + ]:      215226 :         for (const auto& input : tx.vin) {
     417   [ +  -  +  -  :      382197 :             if (auto parent_it{m_entries_by_txid.find(input.prevout.hash)}; parent_it != m_entries_by_txid.end()) {
                   +  + ]
     418   [ +  -  +  -  :      180733 :                 if (!has_been_processed.count(input.prevout.hash)) {
                   +  + ]
     419         [ +  - ]:       97883 :                     to_process.insert(parent_it);
     420                 :       97883 :                 }
     421         [ +  - ]:      180733 :                 ancestors.insert(parent_it);
     422                 :      180733 :             }
     423                 :      201464 :         }
     424   [ +  -  +  -  :       13762 :         has_been_processed.insert(tx.GetHash());
                   +  - ]
     425         [ +  - ]:       13762 :         to_process.erase(iter);
     426                 :       13762 :     }
     427         [ +  - ]:      340837 :     const auto ancestor_package_size = std::accumulate(ancestors.cbegin(), ancestors.cend(), int64_t{0},
     428                 :       13762 :         [](int64_t sum, const auto it) {return sum + it->second.GetTxSize();});
     429         [ +  - ]:      340837 :     const auto ancestor_package_fee = std::accumulate(ancestors.cbegin(), ancestors.cend(), CAmount{0},
     430                 :       13762 :         [](CAmount sum, const auto it) {return sum + it->second.GetModifiedFee();});
     431         [ +  - ]:      340837 :     return target_feerate.GetFee(ancestor_package_size) - ancestor_package_fee;
     432                 :      340837 : }
     433                 :             : } // namespace node
        

Generated by: LCOV version 2.0-1