Skip to content

Add get_candidate_hashes tests, use constexpr block hashes. #729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evoskuil merged 2 commits into from
Mar 3, 2026
Merged

Add get_candidate_hashes tests, use constexpr block hashes. #729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2d652a
Style.
evoskuil Mar 2, 2026
747d8e6
Add get_candidate_hashes tests, use constexpr block hashes.
evoskuil Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/bitcoin/database/impl/query/height.ipp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,8 @@ header_links CLASS::get_confirmed_headers(size_t first,
return {};

// add1(top) cannot overflow, as indexed block maximum cannot exceed size_t.
limit = std::min(limit, add1(top) - first);
auto last = first + sub1(limit);
limit = std::min(limit, add1(top - first));
auto last = sub1(first + limit);

// Due to reorganization it is possible for this height to now be terminal.
auto link = to_confirmed(last);
Expand Down
138 changes: 106 additions & 32 deletions test/query/height.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ BOOST_AUTO_TEST_CASE(query_height__get_candidate_hashes__gapped__expected)
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block1.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block2.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block1_hash)));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block2_hash)));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3_hash)));
const auto locator = query.get_candidate_hashes({ 0, 1, 3, 4 });
BOOST_REQUIRE_EQUAL(locator.size(), 3u);
BOOST_REQUIRE_EQUAL(locator[0], test::genesis.hash());
BOOST_REQUIRE_EQUAL(locator[1], test::block1.hash());
BOOST_REQUIRE_EQUAL(locator[2], test::block3.hash());
BOOST_REQUIRE_EQUAL(locator[0], test::block0_hash);
BOOST_REQUIRE_EQUAL(locator[1], test::block1_hash);
BOOST_REQUIRE_EQUAL(locator[2], test::block3_hash);
}

// get_confirmed_hashes1
Expand All @@ -82,14 +82,14 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_hashes1__gapped__expected)
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3_hash), false));
const auto locator = query.get_confirmed_hashes({ 0, 1, 3, 4 });
BOOST_REQUIRE_EQUAL(locator.size(), 3u);
BOOST_REQUIRE_EQUAL(locator[0], test::genesis.hash());
BOOST_REQUIRE_EQUAL(locator[1], test::block1.hash());
BOOST_REQUIRE_EQUAL(locator[2], test::block3.hash());
BOOST_REQUIRE_EQUAL(locator[0], test::block0_hash);
BOOST_REQUIRE_EQUAL(locator[1], test::block1_hash);
BOOST_REQUIRE_EQUAL(locator[2], test::block3_hash);
}

// get_confirmed_hashes2
Expand All @@ -105,9 +105,9 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_hashes2__various__expected_size
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3_hash), false));
BOOST_REQUIRE_EQUAL(query.get_confirmed_hashes(0, 0).size(), 0u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_hashes(0, 1).size(), 1u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_hashes(0, 2).size(), 2u);
Expand Down Expand Up @@ -140,15 +140,15 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_hashes2__three__ascending_order
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3_hash), false));

const auto hashes = query.get_confirmed_hashes(0, 3);
BOOST_REQUIRE_EQUAL(hashes.size(), 3);
BOOST_REQUIRE_EQUAL(hashes[0], test::genesis.hash());
BOOST_REQUIRE_EQUAL(hashes[1], test::block1.hash());
BOOST_REQUIRE_EQUAL(hashes[2], test::block2.hash());
BOOST_REQUIRE_EQUAL(hashes[0], test::block0_hash);
BOOST_REQUIRE_EQUAL(hashes[1], test::block1_hash);
BOOST_REQUIRE_EQUAL(hashes[2], test::block2_hash);
}

// get_confirmed_headers
Expand Down Expand Up @@ -178,9 +178,9 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_headers__unconfirmeds__empty)
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block1.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block2.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3.hash())));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block1_hash)));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block2_hash)));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3_hash)));
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(0, 0).size(), 0u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(0, 42).size(), 1u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(42, 0).size(), 0u);
Expand All @@ -198,9 +198,9 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_headers__confirmeds__expected_s
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2.hash()), false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3.hash())));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3_hash)));
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(0, 0).size(), 0u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(0, 1).size(), 1u);
BOOST_REQUIRE_EQUAL(query.get_confirmed_headers(0, 2).size(), 2u);
Expand Down Expand Up @@ -229,14 +229,88 @@ BOOST_AUTO_TEST_CASE(query_height__get_confirmed_headers__confirmeds__expected_h
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1.hash()), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2.hash()), false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3.hash())));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_candidate(query.to_header(test::block3_hash)));

const auto headers = query.get_confirmed_headers(1, 3);
BOOST_REQUIRE_EQUAL(headers.size(), 2u);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[0]), test::block1.hash());
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[1]), test::block2.hash());
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[0]), test::block1_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[1]), test::block2_hash);
}

BOOST_AUTO_TEST_CASE(query_height__get_confirmed_headers__over_top__reduced_count)
{
settings settings{};
settings.path = TEST_DIRECTORY;
test::chunk_store store{ settings };
test::query_accessor query{ store };
BOOST_REQUIRE_EQUAL(store.create(events_handler), error::success);
BOOST_REQUIRE(query.initialize(test::genesis));
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.set(test::block4, test::context, false, false));
BOOST_REQUIRE(query.set(test::block5, test::context, false, false));
BOOST_REQUIRE(query.set(test::block6, test::context, false, false));
BOOST_REQUIRE(query.set(test::block7, test::context, false, false));
BOOST_REQUIRE(query.set(test::block8, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block4_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block5_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block6_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block7_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block8_hash), false));

// limit = min(1000, add1(8) - 3) = 6
// last = 3 + sub1(6) = 8
// first = 3
// count = add1(8 - 3) = 6
const auto headers = query.get_confirmed_headers(3, 1000);
BOOST_REQUIRE_EQUAL(headers.size(), 6u);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[0]), test::block3_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[1]), test::block4_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[2]), test::block5_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[3]), test::block6_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[4]), test::block7_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[5]), test::block8_hash);
}

BOOST_AUTO_TEST_CASE(query_height__get_confirmed_headers__under_top__full_count)
{
settings settings{};
settings.path = TEST_DIRECTORY;
test::chunk_store store{ settings };
test::query_accessor query{ store };
BOOST_REQUIRE_EQUAL(store.create(events_handler), error::success);
BOOST_REQUIRE(query.initialize(test::genesis));
BOOST_REQUIRE(query.set(test::block1, test::context, false, false));
BOOST_REQUIRE(query.set(test::block2, test::context, false, false));
BOOST_REQUIRE(query.set(test::block3, test::context, false, false));
BOOST_REQUIRE(query.set(test::block4, test::context, false, false));
BOOST_REQUIRE(query.set(test::block5, test::context, false, false));
BOOST_REQUIRE(query.set(test::block6, test::context, false, false));
BOOST_REQUIRE(query.set(test::block7, test::context, false, false));
BOOST_REQUIRE(query.set(test::block8, test::context, false, false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block1_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block2_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block3_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block4_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block5_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block6_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block7_hash), false));
BOOST_REQUIRE(query.push_confirmed(query.to_header(test::block8_hash), false));

const auto headers = query.get_confirmed_headers(2, 6);
BOOST_REQUIRE_EQUAL(headers.size(), 6u);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[0]), test::block2_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[1]), test::block3_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[2]), test::block4_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[3]), test::block5_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[4]), test::block6_hash);
BOOST_REQUIRE_EQUAL(query.get_header_key(headers[5]), test::block7_hash);
}

BOOST_AUTO_TEST_SUITE_END()
Loading