Skip to content

Commit d60ebea

Browse files
glozowglozow
committed
Merge bitcoin#28808: refactor: Miniminer package linearization followups
b4b01d3 [refactor] updating miniminer comments to be more accurate (kevkevin) 83933ef [refactor] Miniminer var cached_descendants to descendants (kevkevin) 43423fd [refactor] Change MiniMinerMempoolEntry order (kevkevin) Pull request description: ### Motivation In bitcoin#28762 there were some post merge comments which are being addressed in this PR with the following commits ### [8d4c46f](kevkevinpal@8d4c46f) Reorganizing `MiniMinerMempoolEntry` to match the order we have elsewhere * bitcoin#28762 (comment) ### [7505ec2](kevkevinpal@7505ec2) Renaming `cached_descendants` to `descendants` for simpler variable naming * bitcoin#28762 (comment) ### [b21f2f2](kevkevinpal@b21f2f2) Code comment modifications to be more accurate to what is actually happening * bitcoin#28762 (comment) and * bitcoin#28762 (comment) and * bitcoin#28762 (comment) ACKs for top commit: murchandamus: reACK b4b01d3 theStack: LGTM ACK b4b01d3 Tree-SHA512: 54f044a578fb203d8a3c1aa0bcd1fc4bcdff0bc9b024351925a4caf0ccece7c7736b0694ad1168c3cbb447bdb58a91f4cac365f46114da29a889fbc8ea595b82
2 parents 3d7544b + b4b01d3 commit d60ebea

File tree

3 files changed

+38
-39
lines changed

3 files changed

+38
-39
lines changed

‎src/node/mini_miner.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ MiniMiner::MiniMiner(const CTxMemPool& mempool, const std::vector<COutPoint>& ou
7878
for (const auto& txiter : cluster) {
7979
if (!m_to_be_replaced.count(txiter->GetTx().GetHash())) {
8080
auto [mapiter, success] = m_entries_by_txid.emplace(txiter->GetTx().GetHash(),
81-
MiniMinerMempoolEntry{/*fee_self=*/txiter->GetModifiedFee(),
82-
/*fee_ancestor=*/txiter->GetModFeesWithAncestors(),
81+
MiniMinerMempoolEntry{/*tx_in=*/txiter->GetSharedTx(),
8382
/*vsize_self=*/txiter->GetTxSize(),
8483
/*vsize_ancestor=*/txiter->GetSizeWithAncestors(),
85-
/*tx_in=*/txiter->GetSharedTx()});
84+
/*fee_self=*/txiter->GetModifiedFee(),
85+
/*fee_ancestor=*/txiter->GetModFeesWithAncestors()});
8686
m_entries.push_back(mapiter);
8787
} else {
8888
auto outpoints_it = m_requested_outpoints_by_txid.find(txiter->GetTx().GetHash());
@@ -154,18 +154,18 @@ MiniMiner::MiniMiner(const std::vector<MiniMinerMempoolEntry>& manual_entries,
154154
m_ready_to_calculate = false;
155155
return;
156156
}
157-
std::vector<MockEntryMap::iterator> cached_descendants;
157+
std::vector<MockEntryMap::iterator> descendants;
158158
for (const auto& desc_txid : desc_txids) {
159159
auto desc_it{m_entries_by_txid.find(desc_txid)};
160160
// Descendants should only include transactions with corresponding entries.
161161
if (!Assume(desc_it != m_entries_by_txid.end())) {
162162
m_ready_to_calculate = false;
163163
return;
164164
} else {
165-
cached_descendants.emplace_back(desc_it);
165+
descendants.emplace_back(desc_it);
166166
}
167167
}
168-
m_descendant_set_by_txid.emplace(txid, cached_descendants);
168+
m_descendant_set_by_txid.emplace(txid, descendants);
169169
}
170170
Assume(m_to_be_replaced.empty());
171171
Assume(m_requested_outpoints_by_txid.empty());

‎src/node/mini_miner.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ class MiniMinerMempoolEntry
3434
// methods can be called without holding that lock.
3535

3636
public:
37-
explicit MiniMinerMempoolEntry(CAmount fee_self,
38-
CAmount fee_ancestor,
37+
explicit MiniMinerMempoolEntry(const CTransactionRef& tx_in,
3938
int64_t vsize_self,
4039
int64_t vsize_ancestor,
41-
const CTransactionRef& tx_in):
40+
CAmount fee_self,
41+
CAmount fee_ancestor):
4242
tx{tx_in},
4343
vsize_individual{vsize_self},
4444
vsize_with_ancestors{vsize_ancestor},
@@ -137,10 +137,10 @@ class MiniMiner
137137
*/
138138
MiniMiner(const CTxMemPool& mempool, const std::vector<COutPoint>& outpoints);
139139

140-
/** Constructor in which the MiniMinerMempoolEntry entries have been constructed manually,
141-
* presumably because these transactions are not in the mempool (yet). It is assumed that all
142-
* entries are unique and their values are correct, otherwise results computed by MiniMiner may
143-
* be incorrect. Callers should check IsReadyToCalculate() after construction.
140+
/** Constructor in which the MiniMinerMempoolEntry entries have been constructed manually.
141+
* It is assumed that all entries are unique and their values are correct, otherwise results
142+
* computed by MiniMiner may be incorrect. Callers should check IsReadyToCalculate() after
143+
* construction.
144144
* @param[in] descendant_caches A map from each transaction to the set of txids of this
145145
* transaction's descendant set, including itself. Each tx in
146146
* manual_entries must have a corresponding entry in this map, and

‎src/test/miniminer_tests.cpp

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -325,14 +325,14 @@ BOOST_FIXTURE_TEST_CASE(miniminer_1p1c, TestChain100Setup)
325325
const int32_t tx6_vsize{tx_dims.at(tx6->GetHash()).vsize};
326326
const int32_t tx7_vsize{tx_dims.at(tx7->GetHash()).vsize};
327327

328-
miniminer_info.emplace_back(/*fee_self=*/med_fee,/*fee_ancestor=*/med_fee,/*vsize_self=*/tx0_vsize,/*vsize_ancestor=*/tx0_vsize, tx0);
329-
miniminer_info.emplace_back( med_fee, 2*med_fee, tx1_vsize, tx0_vsize + tx1_vsize, tx1);
330-
miniminer_info.emplace_back( low_fee, low_fee, tx2_vsize, tx2_vsize, tx2);
331-
miniminer_info.emplace_back( high_fee, low_fee + high_fee, tx3_vsize, tx2_vsize + tx3_vsize, tx3);
332-
miniminer_info.emplace_back( low_fee, low_fee, tx4_vsize, tx4_vsize, tx4);
333-
miniminer_info.emplace_back( tx5_mod_fee, low_fee + tx5_mod_fee, tx5_vsize, tx4_vsize + tx5_vsize, tx5);
334-
miniminer_info.emplace_back( high_fee, high_fee, tx6_vsize, tx6_vsize, tx6);
335-
miniminer_info.emplace_back( low_fee, high_fee + low_fee, tx7_vsize, tx6_vsize + tx7_vsize, tx7);
328+
miniminer_info.emplace_back(tx0,/*vsize_self=*/tx0_vsize,/*vsize_ancestor=*/tx0_vsize,/*fee_self=*/med_fee,/*fee_ancestor=*/med_fee);
329+
miniminer_info.emplace_back(tx1, tx1_vsize, tx0_vsize + tx1_vsize, med_fee, 2*med_fee);
330+
miniminer_info.emplace_back(tx2, tx2_vsize, tx2_vsize, low_fee, low_fee);
331+
miniminer_info.emplace_back(tx3, tx3_vsize, tx2_vsize + tx3_vsize, high_fee, low_fee + high_fee);
332+
miniminer_info.emplace_back(tx4, tx4_vsize, tx4_vsize, low_fee, low_fee);
333+
miniminer_info.emplace_back(tx5, tx5_vsize, tx4_vsize + tx5_vsize, tx5_mod_fee, low_fee + tx5_mod_fee);
334+
miniminer_info.emplace_back(tx6, tx6_vsize, tx6_vsize, high_fee, high_fee);
335+
miniminer_info.emplace_back(tx7, tx7_vsize, tx6_vsize + tx7_vsize, low_fee, high_fee + low_fee);
336336
}
337337
std::map<Txid, std::set<Txid>> descendant_caches;
338338
descendant_caches.emplace(tx0->GetHash(), std::set<Txid>{tx0->GetHash(), tx1->GetHash()});
@@ -543,15 +543,14 @@ BOOST_FIXTURE_TEST_CASE(miniminer_overlap, TestChain100Setup)
543543
}
544544
// Check linearization order
545545
std::vector<node::MiniMinerMempoolEntry> miniminer_info;
546-
miniminer_info.emplace_back(/*fee_self=*/low_fee, /*fee_ancestor=*/low_fee,/*vsize_self=*/tx_vsizes[0], /*vsize_ancestor=*/tx_vsizes[0], tx0);
547-
miniminer_info.emplace_back( med_fee, med_fee, tx_vsizes[1], tx_vsizes[1], tx1);
548-
miniminer_info.emplace_back( high_fee, high_fee, tx_vsizes[2], tx_vsizes[2], tx2);
549-
miniminer_info.emplace_back( high_fee, low_fee+med_fee+2*high_fee, tx_vsizes[3], tx_vsizes[0]+tx_vsizes[1]+tx_vsizes[2]+tx_vsizes[3], tx3);
550-
551-
miniminer_info.emplace_back( high_fee, high_fee, tx_vsizes[4], tx_vsizes[4], tx4);
552-
miniminer_info.emplace_back( low_fee, low_fee + high_fee, tx_vsizes[5], tx_vsizes[4]+tx_vsizes[5], tx5);
553-
miniminer_info.emplace_back( med_fee, high_fee+low_fee+med_fee, tx_vsizes[6], tx_vsizes[4]+tx_vsizes[5]+tx_vsizes[6], tx6);
554-
miniminer_info.emplace_back( high_fee, high_fee+low_fee+high_fee, tx_vsizes[7], tx_vsizes[4]+tx_vsizes[5]+tx_vsizes[7], tx7);
546+
miniminer_info.emplace_back(tx0,/*vsize_self=*/tx_vsizes[0], /*vsize_ancestor=*/tx_vsizes[0], /*fee_self=*/low_fee, /*fee_ancestor=*/low_fee);
547+
miniminer_info.emplace_back(tx1, tx_vsizes[1], tx_vsizes[1], med_fee, med_fee);
548+
miniminer_info.emplace_back(tx2, tx_vsizes[2], tx_vsizes[2], high_fee, high_fee);
549+
miniminer_info.emplace_back(tx3, tx_vsizes[3], tx_vsizes[0]+tx_vsizes[1]+tx_vsizes[2]+tx_vsizes[3], high_fee, low_fee+med_fee+2*high_fee);
550+
miniminer_info.emplace_back(tx4, tx_vsizes[4], tx_vsizes[4], high_fee, high_fee);
551+
miniminer_info.emplace_back(tx5, tx_vsizes[5], tx_vsizes[4]+tx_vsizes[5], low_fee, low_fee + high_fee);
552+
miniminer_info.emplace_back(tx6, tx_vsizes[6], tx_vsizes[4]+tx_vsizes[5]+tx_vsizes[6], med_fee, high_fee+low_fee+med_fee);
553+
miniminer_info.emplace_back(tx7, tx_vsizes[7], tx_vsizes[4]+tx_vsizes[5]+tx_vsizes[7], high_fee, high_fee+low_fee+high_fee);
555554

556555
std::map<Txid, std::set<Txid>> descendant_caches;
557556
descendant_caches.emplace(tx0->GetHash(), std::set<Txid>{tx0->GetHash(), tx3->GetHash()});
@@ -647,7 +646,7 @@ BOOST_FIXTURE_TEST_CASE(manual_ctor, TestChain100Setup)
647646
CTxMemPool& pool = *Assert(m_node.mempool);
648647
LOCK2(cs_main, pool.cs);
649648
{
650-
// 3 pairs of fee-bumping grandparent + parent, plus 1 low-feerate child.
649+
// 3 pairs of grandparent + fee-bumping parent, plus 1 low-feerate child.
651650
// 0 fee + high fee
652651
auto grandparent_zero_fee = make_tx({{m_coinbase_txns.at(0)->GetHash(), 0}}, 1);
653652
auto parent_high_feerate = make_tx({{grandparent_zero_fee->GetHash(), 0}}, 1);
@@ -665,13 +664,13 @@ BOOST_FIXTURE_TEST_CASE(manual_ctor, TestChain100Setup)
665664
const int64_t child_vsize{1000};
666665

667666
std::vector<node::MiniMinerMempoolEntry> miniminer_info;
668-
miniminer_info.emplace_back(/*fee_self=*/0, /*fee_ancestor=*/0,/*vsize_self=*/tx_vsize,/*vsize_ancestor=*/tx_vsize, grandparent_zero_fee);
669-
miniminer_info.emplace_back( high_fee, high_fee, tx_vsize, 2*tx_vsize, parent_high_feerate);
670-
miniminer_info.emplace_back( 2*low_fee, 2*low_fee, tx_vsize, tx_vsize, grandparent_double_low_feerate);
671-
miniminer_info.emplace_back( med_fee, 2*low_fee+med_fee, tx_vsize, 2*tx_vsize, parent_med_feerate);
672-
miniminer_info.emplace_back( low_fee, low_fee, tx_vsize, tx_vsize, grandparent_low_feerate);
673-
miniminer_info.emplace_back( 2*low_fee, 3*low_fee, tx_vsize, 2*tx_vsize, parent_double_low_feerate);
674-
miniminer_info.emplace_back( low_fee, high_fee+med_fee+6*low_fee, child_vsize, 6*tx_vsize+child_vsize, child);
667+
miniminer_info.emplace_back(grandparent_zero_fee, /*vsize_self=*/tx_vsize,/*vsize_ancestor=*/tx_vsize, /*fee_self=*/0,/*fee_ancestor=*/0);
668+
miniminer_info.emplace_back(parent_high_feerate, tx_vsize, 2*tx_vsize, high_fee, high_fee);
669+
miniminer_info.emplace_back(grandparent_double_low_feerate, tx_vsize, tx_vsize, 2*low_fee, 2*low_fee);
670+
miniminer_info.emplace_back(parent_med_feerate, tx_vsize, 2*tx_vsize, med_fee, 2*low_fee+med_fee);
671+
miniminer_info.emplace_back(grandparent_low_feerate, tx_vsize, tx_vsize, low_fee, low_fee);
672+
miniminer_info.emplace_back(parent_double_low_feerate, tx_vsize, 2*tx_vsize, 2*low_fee, 3*low_fee);
673+
miniminer_info.emplace_back(child, child_vsize, 6*tx_vsize+child_vsize, low_fee, high_fee+med_fee+6*low_fee);
675674
std::map<Txid, std::set<Txid>> descendant_caches;
676675
descendant_caches.emplace(grandparent_zero_fee->GetHash(), std::set<Txid>{grandparent_zero_fee->GetHash(), parent_high_feerate->GetHash(), child->GetHash()});
677676
descendant_caches.emplace(grandparent_low_feerate->GetHash(), std::set<Txid>{grandparent_low_feerate->GetHash(), parent_double_low_feerate->GetHash(), child->GetHash()});
@@ -693,7 +692,7 @@ BOOST_FIXTURE_TEST_CASE(manual_ctor, TestChain100Setup)
693692
BOOST_CHECK_EQUAL(sequences.at(grandparent_double_low_feerate->GetHash()), 1);
694693
BOOST_CHECK_EQUAL(sequences.at(parent_med_feerate->GetHash()), 1);
695694

696-
// CPFP low + med
695+
// CPFP low + double low
697696
BOOST_CHECK_EQUAL(sequences.at(grandparent_low_feerate->GetHash()), 2);
698697
BOOST_CHECK_EQUAL(sequences.at(parent_double_low_feerate->GetHash()), 2);
699698

0 commit comments

Comments
 (0)