Merge bitcoin/bitcoin#34057: test: add tests for cluster chunks

fe0b1513a7 test: add a test for txgraph staging (Hao Xu)
ef253a9d3d test: add block builder tests for txgraph (Hao Xu)
4a1ac31e97 test: add a chunk test for txgraph (Hao Xu)

Pull request description:

  Add tests for cluster chunks, including:
      - txgraph_chunk_chain test: test chunk implementation for a simple chain style graph .
      - txgraph_staging test: test the staging feature for a basic graph.

ACKs for top commit:
  instagibbs:
    reACK fe0b1513a7
  sipa:
    reACK fe0b1513a7

Tree-SHA512: 01010a3b4e4163849df2912d1393be74d26eb199d0544cfbef58a498aca5153463a118f55a2f1cad2995552b74210031e659de8df6b88cbcffdffd2a1b464990

src/test/txgraph_tests.cpp

@@ -291,4 +291,134 @@ BOOST_AUTO_TEST_CASE(txgraph_trim_big_singletons)
     }
 }
 
+BOOST_AUTO_TEST_CASE(txgraph_chunk_chain)
+{
+    // Create a new graph for the test.
+    auto graph = MakeTxGraph(50, 1000, NUM_ACCEPTABLE_ITERS);
+
+    auto block_builder_checker = [&graph](std::vector<std::vector<TxGraph::Ref*>> expected_chunks) {
+        std::vector<std::vector<TxGraph::Ref*>> chunks;
+        auto builder = graph->GetBlockBuilder();
+        FeePerWeight last_chunk_feerate;
+        while (auto chunk = builder->GetCurrentChunk()) {
+            FeePerWeight sum;
+            for (TxGraph::Ref* ref : chunk->first) {
+                // The reported chunk feerate must match the chunk feerate obtained by asking
+                // it for each of the chunk's transactions individually.
+                BOOST_CHECK(graph->GetMainChunkFeerate(*ref) == chunk->second);
+                // Verify the chunk feerate matches the sum of the reported individual feerates.
+                sum += graph->GetIndividualFeerate(*ref);
+            }
+            BOOST_CHECK(sum == chunk->second);
+            chunks.push_back(std::move(chunk->first));
+            last_chunk_feerate = chunk->second;
+            builder->Include();
+        }
+
+        BOOST_CHECK(chunks == expected_chunks);
+        auto& last_chunk = chunks.back();
+        // The last chunk returned by the BlockBuilder must match GetWorstMainChunk, in reverse.
+        std::reverse(last_chunk.begin(), last_chunk.end());
+        auto [worst_chunk, worst_chunk_feerate] = graph->GetWorstMainChunk();
+        BOOST_CHECK(last_chunk == worst_chunk);
+        BOOST_CHECK(last_chunk_feerate == worst_chunk_feerate);
+    };
+
+    std::vector<TxGraph::Ref> refs;
+    refs.reserve(4);
+
+    FeePerWeight feerateA{2, 10};
+    FeePerWeight feerateB{1, 10};
+    FeePerWeight feerateC{2, 10};
+    FeePerWeight feerateD{4, 10};
+
+    // everytime adding a transaction, test the chunk status
+    // [A]
+    refs.push_back(graph->AddTransaction(feerateA));
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 1);
+    block_builder_checker({{&refs[0]}});
+    // [A, B]
+    refs.push_back(graph->AddTransaction(feerateB));
+    graph->AddDependency(/*parent=*/refs[0], /*child=*/refs[1]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 2);
+    block_builder_checker({{&refs[0]}, {&refs[1]}});
+
+    // [A, BC]
+    refs.push_back(graph->AddTransaction(feerateC));
+    graph->AddDependency(/*parent=*/refs[1], /*child=*/refs[2]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 3);
+    block_builder_checker({{&refs[0]}, {&refs[1], &refs[2]}});
+
+    // [ABCD]
+    refs.push_back(graph->AddTransaction(feerateD));
+    graph->AddDependency(/*parent=*/refs[2], /*child=*/refs[3]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 4);
+    block_builder_checker({{&refs[0], &refs[1], &refs[2], &refs[3]}});
+
+    graph->SanityCheck();
+
+    // D->C->A
+    graph->RemoveTransaction(refs[1]);
+    // txgraph is not responsible for removing the descendants or ancestors
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 3);
+    // only A remains there
+    graph->RemoveTransaction(refs[2]);
+    graph->RemoveTransaction(refs[3]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 1);
+    block_builder_checker({{&refs[0]}});
+}
+
+BOOST_AUTO_TEST_CASE(txgraph_staging)
+{
+    /* Create a new graph for the test.
+     * The parameters are max_cluster_count, max_cluster_size, acceptable_iters
+     */
+    auto graph = MakeTxGraph(10, 1000, NUM_ACCEPTABLE_ITERS);
+
+    std::vector<TxGraph::Ref> refs;
+    refs.reserve(2);
+
+    FeePerWeight feerateA{2, 10};
+    FeePerWeight feerateB{1, 10};
+
+    // everytime adding a transaction, test the chunk status
+    // [A]
+    refs.push_back(graph->AddTransaction(feerateA));
+    BOOST_CHECK_EQUAL(graph->HaveStaging(), false);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 1);
+
+    graph->StartStaging();
+    BOOST_CHECK_EQUAL(graph->HaveStaging(), true);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 1);
+
+    // [A, B]
+    refs.push_back(graph->AddTransaction(feerateB));
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::MAIN), 1);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 2);
+    BOOST_CHECK_EQUAL(graph->Exists(refs[0], TxGraph::Level::TOP), true);
+    BOOST_CHECK_EQUAL(graph->Exists(refs[1], TxGraph::Level::TOP), true);
+
+    graph->AddDependency(/*parent=*/refs[0], /*child=*/refs[1]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::MAIN), 1);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 2);
+
+    graph->CommitStaging();
+    BOOST_CHECK_EQUAL(graph->HaveStaging(), false);
+
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::MAIN), 2);
+
+    graph->StartStaging();
+
+    // [A]
+    graph->RemoveTransaction(refs[1]);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::MAIN), 2);
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::TOP), 1);
+
+    graph->CommitStaging();
+
+    BOOST_CHECK_EQUAL(graph->GetTransactionCount(TxGraph::Level::MAIN), 1);
+
+    graph->SanityCheck();
+}
+
 BOOST_AUTO_TEST_SUITE_END()