Skip to content

backport: bitcoin#25494 (kernel 2) #7462

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

Open
knst wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

backport: bitcoin#25494 (kernel 2) #7462

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
9d3b80e
feat: make circular dependencies more conflict friendly for backports
knst Jun 15, 2026
b0ad438
Merge bitcoin/bitcoin#25494: indexes: Stop using node internal types
knst Jul 19, 2022
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
3 changes: 3 additions & 0 deletions src/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@ BITCOIN_CORE_H = \
interfaces/node.h \
interfaces/wallet.h \
kernel/blockmanager_opts.h \
kernel/chain.h \
kernel/chainstatemanager_opts.h \
kernel/checks.h \
kernel/coinstats.h \
Expand Down Expand Up @@ -562,6 +563,7 @@ libbitcoin_node_a_SOURCES = \
instantsend/lock.cpp \
instantsend/net_instantsend.cpp \
instantsend/signing.cpp \
kernel/chain.cpp \
kernel/checks.cpp \
kernel/coinstats.cpp \
kernel/context.cpp \
Expand Down Expand Up @@ -1285,6 +1287,7 @@ libdashkernel_la_SOURCES = \
init/common.cpp \
instantsend/db.cpp \
instantsend/instantsend.cpp \
kernel/chain.cpp \
kernel/checks.cpp \
kernel/coinstats.cpp \
kernel/context.cpp \
Expand Down
2 changes: 1 addition & 1 deletion src/core_write.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#include <util/strencodings.h>
#include <util/system.h>

#include <index/spentindex.h>
#include <index/spentindex_types.h>

#include <evo/assetlocktx.h>
#include <evo/cbtx.h>
Expand Down
43 changes: 25 additions & 18 deletions src/index/addressindex.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
#include <tinyformat.h>
#include <undo.h>
#include <util/system.h>
#include <validation.h>

constexpr uint8_t DB_ADDRESSINDEX{'a'};
constexpr uint8_t DB_ADDRESSUNSPENTINDEX{'u'};
Expand Down Expand Up @@ -159,39 +160,44 @@ bool AddressIndex::DB::RewindBatch(const std::vector<CAddressIndexEntry>& addres
return CDBWrapper::WriteBatch(batch);
}

AddressIndex::AddressIndex(size_t n_cache_size, bool f_memory, bool f_wipe) :
AddressIndex::AddressIndex(std::unique_ptr<interfaces::Chain> chain, size_t n_cache_size, bool f_memory, bool f_wipe) :
BaseIndex(std::move(chain)),
m_db(std::make_unique<AddressIndex::DB>(n_cache_size, f_memory, f_wipe))
{
}

AddressIndex::~AddressIndex() = default;

bool AddressIndex::WriteBlock(const CBlock& block, const CBlockIndex* pindex)
bool AddressIndex::CustomAppend(const interfaces::BlockInfo& block)
{
// Skip genesis block (no inputs to index)
if (pindex->nHeight == 0) {
if (block.height == 0) {
return true;
}

// pindex variable gives indexing code access to node internals. It
// will be removed in upcoming commit
const CBlockIndex* pindex = WITH_LOCK(cs_main, return m_chainstate->m_blockman.LookupBlockIndex(block.hash));

// Read undo data for this block to get information about spent outputs
CBlockUndo blockundo;
if (!node::UndoReadFromDisk(blockundo, pindex)) {
return error("%s: Failed to read undo data for block %s at height %d", __func__,
pindex->GetBlockHash().ToString(), pindex->nHeight);
block.hash.ToString(), block.height);
}

std::vector<CAddressIndexEntry> addressIndex;
std::vector<CAddressUnspentIndexEntry> addressUnspentIndex;

// Process each non-coinbase transaction
// blockundo.vtxundo[i] corresponds to block.vtx[i+1] (coinbase is skipped in undo data)
if (blockundo.vtxundo.size() != block.vtx.size() - 1) {
if (blockundo.vtxundo.size() != block.data->vtx.size() - 1) {
return error("%s: Undo data size mismatch for block %s (expected %zu, got %zu)", __func__,
pindex->GetBlockHash().ToString(), block.vtx.size() - 1, blockundo.vtxundo.size());
block.hash.ToString(), block.data->vtx.size() - 1, blockundo.vtxundo.size());
}

for (size_t i = 0; i < blockundo.vtxundo.size(); i++) {
const CTransactionRef& tx = block.vtx[i + 1]; // +1 to skip coinbase
const CTransactionRef& tx = block.data->vtx[i + 1]; // +1 to skip coinbase
const CTxUndo& txundo = blockundo.vtxundo[i];
const uint256 txhash = tx->GetHash();

Expand All @@ -213,7 +219,7 @@ bool AddressIndex::WriteBlock(const CBlock& block, const CBlockIndex* pindex)
}

// Record spending activity
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, pindex->nHeight, i + 1, txhash, j, true),
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, block.height, i + 1, txhash, j, true),
prevout.nValue * -1);

// Remove from unspent index
Expand All @@ -234,17 +240,17 @@ bool AddressIndex::WriteBlock(const CBlock& block, const CBlockIndex* pindex)
}

// Record receiving activity
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, pindex->nHeight, i + 1, txhash, k, false),
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, block.height, i + 1, txhash, k, false),
out.nValue);

// Add to unspent index
addressUnspentIndex.emplace_back(CAddressUnspentKey(address_type, address_bytes, txhash, k),
CAddressUnspentValue(out.nValue, out.scriptPubKey, pindex->nHeight));
CAddressUnspentValue(out.nValue, out.scriptPubKey, block.height));
}
}

// Also process coinbase outputs (receiving activity only)
const CTransactionRef& coinbase = block.vtx[0];
const CTransactionRef& coinbase = block.data->vtx[0];
const uint256 coinbase_hash = coinbase->GetHash();
for (size_t k = 0; k < coinbase->vout.size(); k++) {
const CTxOut& out = coinbase->vout[k];
Expand All @@ -256,24 +262,26 @@ bool AddressIndex::WriteBlock(const CBlock& block, const CBlockIndex* pindex)
}

// Record receiving activity for coinbase
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, pindex->nHeight, 0, coinbase_hash, k, false),
addressIndex.emplace_back(CAddressIndexKey(address_type, address_bytes, block.height, 0, coinbase_hash, k, false),
out.nValue);

// Add coinbase outputs to unspent index
addressUnspentIndex.emplace_back(CAddressUnspentKey(address_type, address_bytes, coinbase_hash, k),
CAddressUnspentValue(out.nValue, out.scriptPubKey, pindex->nHeight));
CAddressUnspentValue(out.nValue, out.scriptPubKey, block.height));
}

return m_db->WriteBatch(addressIndex, addressUnspentIndex);
}

bool AddressIndex::Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_tip)
bool AddressIndex::CustomRewind(const interfaces::BlockKey& current_tip, const interfaces::BlockKey& new_tip)
{
assert(current_tip->GetAncestor(new_tip->nHeight) == new_tip);
const CBlockIndex* current_tip_index = WITH_LOCK(cs_main, return m_chainstate->m_blockman.LookupBlockIndex(current_tip.hash));
const CBlockIndex* new_tip_index = WITH_LOCK(cs_main, return m_chainstate->m_blockman.LookupBlockIndex(new_tip.hash));
assert(current_tip_index->GetAncestor(new_tip_index->nHeight) == new_tip_index);

// Rewind the unspent index by processing blocks in reverse
// We need to undo all operations from current_tip back to (but not including) new_tip
for (const CBlockIndex* pindex = current_tip; pindex != new_tip; pindex = pindex->pprev) {
for (const CBlockIndex* pindex = current_tip_index; pindex != new_tip_index; pindex = pindex->pprev) {
CBlock block;
if (!node::ReadBlockFromDisk(block, pindex, Params().GetConsensus())) {
return error("%s: Failed to read block %s from disk during rewind", __func__,
Expand Down Expand Up @@ -387,8 +395,7 @@ bool AddressIndex::Rewind(const CBlockIndex* current_tip, const CBlockIndex* new
}
}

// Call base class Rewind to update the best block pointer
return BaseIndex::Rewind(current_tip, new_tip);
return true;
}

BaseIndex::DB& AddressIndex::GetDB() const { return *m_db; }
Expand Down
6 changes: 3 additions & 3 deletions src/index/addressindex.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,18 @@ class AddressIndex final : public BaseIndex
bool AllowPrune() const override { return false; }

/// Write block data to the index databases
bool WriteBlock(const CBlock& block, const CBlockIndex* pindex) override;
bool CustomAppend(const interfaces::BlockInfo& block) override;

/// Custom rewind to handle both transaction history and unspent index
bool Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_tip) override;
bool CustomRewind(const interfaces::BlockKey& current_tip, const interfaces::BlockKey& new_tip) override;

BaseIndex::DB& GetDB() const override;

const char* GetName() const override { return "addressindex"; }

public:
/// Constructs the index, which becomes available to be queried
explicit AddressIndex(size_t n_cache_size, bool f_memory = false, bool f_wipe = false);
explicit AddressIndex(std::unique_ptr<interfaces::Chain> chain, size_t n_cache_size, bool f_memory = false, bool f_wipe = false);

/// Destructor
virtual ~AddressIndex() override;
Expand Down
63 changes: 44 additions & 19 deletions src/index/base.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@

#include <chainparams.h>
#include <index/base.h>
#include <interfaces/chain.h>
#include <kernel/chain.h>
#include <node/blockstorage.h>
#include <node/context.h>
#include <node/interface_ui.h>
#include <shutdown.h>
#include <tinyformat.h>
Expand All @@ -31,6 +34,15 @@ void BaseIndex::FatalErrorImpl(const std::string& message)
StartShutdown();
}

CBlockLocator GetLocator(interfaces::Chain& chain, const uint256& block_hash)
{
CBlockLocator locator;
bool found = chain.findBlock(block_hash, interfaces::FoundBlock().locator(locator));
assert(found);
assert(!locator.IsNull());
return locator;
}

BaseIndex::DB::DB(const fs::path& path, size_t n_cache_size, bool f_memory, bool f_wipe, bool f_obfuscate) :
CDBWrapper(path, n_cache_size, f_memory, f_wipe, f_obfuscate)
{}
Expand All @@ -49,6 +61,9 @@ void BaseIndex::DB::WriteBestBlock(CDBBatch& batch, const CBlockLocator& locator
batch.Write(DB_BEST_BLOCK, locator);
}

BaseIndex::BaseIndex(std::unique_ptr<interfaces::Chain> chain)
: m_chain{std::move(chain)} {}

BaseIndex::~BaseIndex()
{
Interrupt();
Expand Down Expand Up @@ -164,12 +179,15 @@ void BaseIndex::ThreadSync()
}

CBlock block;
interfaces::BlockInfo block_info = kernel::MakeBlockInfo(pindex);
if (!ReadBlockFromDisk(block, pindex, consensus_params)) {
FatalError("%s: Failed to read block %s from disk",
__func__, pindex->GetBlockHash().ToString());
return;
} else {
block_info.data = &block;
}
if (!WriteBlock(block, pindex)) {
if (!CustomAppend(block_info)) {
FatalError("%s: Failed to write block %s to index database",
__func__, pindex->GetBlockHash().ToString());
return;
Expand Down Expand Up @@ -200,22 +218,20 @@ void BaseIndex::ThreadSync()

bool BaseIndex::Commit()
{
CDBBatch batch(GetDB());
if (!CommitInternal(batch) || !GetDB().WriteBatch(batch)) {
return error("%s: Failed to commit latest %s state", __func__, GetName());
}
return true;
}

bool BaseIndex::CommitInternal(CDBBatch& batch)
{
LOCK(cs_main);
// Don't commit anything if we haven't indexed any block yet
// (this could happen if init is interrupted).
if (m_best_block_index == nullptr) {
return false;
bool ok = m_best_block_index != nullptr;
if (ok) {
CDBBatch batch(GetDB());
ok = CustomCommit(batch);
if (ok) {
GetDB().WriteBestBlock(batch, GetLocator(*m_chain, m_best_block_index.load()->GetBlockHash()));
ok = GetDB().WriteBatch(batch);
}
}
if (!ok) {
return error("%s: Failed to commit latest %s state", __func__, GetName());
}
GetDB().WriteBestBlock(batch, m_chainstate->m_chain.GetLocator(m_best_block_index));
return true;
}

Expand All @@ -224,6 +240,10 @@ bool BaseIndex::Rewind(const CBlockIndex* current_tip, const CBlockIndex* new_ti
assert(current_tip == m_best_block_index);
assert(current_tip->GetAncestor(new_tip->nHeight) == new_tip);

if (!CustomRewind({current_tip->GetBlockHash(), current_tip->nHeight}, {new_tip->GetBlockHash(), new_tip->nHeight})) {
return false;
}

// In the case of a reorg, ensure persisted block locator is not stale.
// Pruning has a minimum of 288 blocks-to-keep and getting the index
// out of sync may be possible but a users fault.
Expand Down Expand Up @@ -271,8 +291,8 @@ void BaseIndex::BlockConnected(const std::shared_ptr<const CBlock>& block, const
return;
}
}

if (WriteBlock(*block, pindex)) {
interfaces::BlockInfo block_info = kernel::MakeBlockInfo(pindex, block.get());
if (CustomAppend(block_info)) {
// Setting the best block index is intentionally the last step of this
// function, so BlockUntilSyncedToCurrentChain callers waiting for the
// best block index to be updated can rely on the block being fully
Expand Down Expand Up @@ -377,13 +397,18 @@ void BaseIndex::Interrupt()
m_interrupt();
}

bool BaseIndex::Start(Chainstate& active_chainstate)
bool BaseIndex::Start()
{
m_chainstate = &active_chainstate;
// m_chainstate member gives indexing code access to node internals. It is
// removed in followup https://github.com/bitcoin/bitcoin/pull/24230
m_chainstate = &m_chain->context()->chainman->ActiveChainstate();
// Need to register this ValidationInterface before running Init(), so that
// callbacks are not missed if Init sets m_synced to true.
RegisterValidationInterface(this);
if (!Init()) {
if (!Init()) return false;

const CBlockIndex* index = m_best_block_index.load();
if (!CustomInit(index ? std::make_optional(interfaces::BlockKey{index->GetBlockHash(), index->nHeight}) : std::nullopt)) {
Comment on lines +408 to +411

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Initialize custom index state before syncing callbacks

Because the validation interface is registered before Init(), queued/background validation events can reach this index as soon as Init() latches m_synced true, but CustomInit() has not loaded subclass state yet. When starting an already-synced index while callbacks are pending, a BlockConnected in this window can append using uninitialized blockfilter file position or zeroed coinstats MuHash/totals, corrupting the index; keep callbacks gated until after CustomInit() completes or initialize custom state before setting m_synced.

Useful? React with 👍 / 👎.

@thepastaclaw thepastaclaw Jul 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not actionable for this backport. The merged bitcoin#25494 implementation has this exact RegisterValidationInterface → Init() → CustomInit() ordering, including the comment explaining why registration precedes Init() (upstream lines 369–386). The backport is faithful here, and this finding does not identify a Dash-specific interaction. Any remaining lifecycle concern would need to be handled upstream or as a separate follow-up, not as a bitcoin#25494 backport fix.

return false;
}

Expand Down
Loading
Loading