Bitcoin Core 30.99.0
P2P Digital Currency
validation.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <bitcoin-build-config.h> // IWYU pragma: keep
7
8#include <validation.h>
9
10#include <arith_uint256.h>
11#include <chain.h>
12#include <checkqueue.h>
13#include <clientversion.h>
14#include <consensus/amount.h>
15#include <consensus/consensus.h>
16#include <consensus/merkle.h>
17#include <consensus/tx_check.h>
18#include <consensus/tx_verify.h>
20#include <cuckoocache.h>
21#include <flatfile.h>
22#include <hash.h>
23#include <kernel/chain.h>
24#include <kernel/chainparams.h>
25#include <kernel/coinstats.h>
30#include <kernel/warning.h>
31#include <logging.h>
32#include <logging/timer.h>
33#include <node/blockstorage.h>
34#include <node/utxo_snapshot.h>
36#include <policy/policy.h>
37#include <policy/rbf.h>
38#include <policy/settings.h>
39#include <policy/truc_policy.h>
40#include <pow.h>
41#include <primitives/block.h>
43#include <random.h>
44#include <script/script.h>
45#include <script/sigcache.h>
46#include <signet.h>
47#include <tinyformat.h>
48#include <txdb.h>
49#include <txmempool.h>
50#include <uint256.h>
51#include <undo.h>
52#include <util/check.h>
53#include <util/fs.h>
54#include <util/fs_helpers.h>
55#include <util/hasher.h>
56#include <util/moneystr.h>
57#include <util/rbf.h>
58#include <util/result.h>
60#include <util/strencodings.h>
61#include <util/string.h>
62#include <util/time.h>
63#include <util/trace.h>
64#include <util/translation.h>
65#include <validationinterface.h>
66
67#include <algorithm>
68#include <cassert>
69#include <chrono>
70#include <deque>
71#include <numeric>
72#include <optional>
73#include <ranges>
74#include <span>
75#include <string>
76#include <tuple>
77#include <utility>
78
83
86using node::BlockMap;
90
92static constexpr size_t WARN_FLUSH_COINS_SIZE = 1 << 30; // 1 GiB
97static constexpr auto DATABASE_WRITE_INTERVAL_MIN{50min};
98static constexpr auto DATABASE_WRITE_INTERVAL_MAX{70min};
100static constexpr std::chrono::hours MAX_FEE_ESTIMATION_TIP_AGE{3};
101const std::vector<std::string> CHECKLEVEL_DOC {
102 "level 0 reads the blocks from disk",
103 "level 1 verifies block validity",
104 "level 2 verifies undo data",
105 "level 3 checks disconnection of tip blocks",
106 "level 4 tries to reconnect the blocks",
107 "each level includes the checks of the previous levels",
108};
114static constexpr int PRUNE_LOCK_BUFFER{10};
115
116TRACEPOINT_SEMAPHORE(validation, block_connected);
117TRACEPOINT_SEMAPHORE(utxocache, flush);
118TRACEPOINT_SEMAPHORE(mempool, replaced);
119TRACEPOINT_SEMAPHORE(mempool, rejected);
120
122{
124
125 // Find the latest block common to locator and chain - we expect that
126 // locator.vHave is sorted descending by height.
127 for (const uint256& hash : locator.vHave) {
128 const CBlockIndex* pindex{m_blockman.LookupBlockIndex(hash)};
129 if (pindex) {
130 if (m_chain.Contains(pindex)) {
131 return pindex;
132 }
133 if (pindex->GetAncestor(m_chain.Height()) == m_chain.Tip()) {
134 return m_chain.Tip();
135 }
136 }
137 }
138 return m_chain.Genesis();
139}
140
142 const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
143 bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
144 ValidationCache& validation_cache,
145 std::vector<CScriptCheck>* pvChecks = nullptr)
147
148bool CheckFinalTxAtTip(const CBlockIndex& active_chain_tip, const CTransaction& tx)
149{
151
152 // CheckFinalTxAtTip() uses active_chain_tip.Height()+1 to evaluate
153 // nLockTime because when IsFinalTx() is called within
154 // AcceptBlock(), the height of the block *being*
155 // evaluated is what is used. Thus if we want to know if a
156 // transaction can be part of the *next* block, we need to call
157 // IsFinalTx() with one more than active_chain_tip.Height().
158 const int nBlockHeight = active_chain_tip.nHeight + 1;
159
160 // BIP113 requires that time-locked transactions have nLockTime set to
161 // less than the median time of the previous block they're contained in.
162 // When the next block is created its previous block will be the current
163 // chain tip, so we use that to calculate the median time passed to
164 // IsFinalTx().
165 const int64_t nBlockTime{active_chain_tip.GetMedianTimePast()};
166
167 return IsFinalTx(tx, nBlockHeight, nBlockTime);
168}
169
170namespace {
181std::optional<std::vector<int>> CalculatePrevHeights(
182 const CBlockIndex& tip,
183 const CCoinsView& coins,
184 const CTransaction& tx)
185{
186 std::vector<int> prev_heights;
187 prev_heights.resize(tx.vin.size());
188 for (size_t i = 0; i < tx.vin.size(); ++i) {
189 if (auto coin{coins.GetCoin(tx.vin[i].prevout)}) {
190 prev_heights[i] = coin->nHeight == MEMPOOL_HEIGHT
191 ? tip.nHeight + 1 // Assume all mempool transaction confirm in the next block.
192 : coin->nHeight;
193 } else {
194 LogInfo("ERROR: %s: Missing input %d in transaction \'%s\'\n", __func__, i, tx.GetHash().GetHex());
195 return std::nullopt;
196 }
197 }
198 return prev_heights;
199}
200} // namespace
201
202std::optional<LockPoints> CalculateLockPointsAtTip(
203 CBlockIndex* tip,
204 const CCoinsView& coins_view,
205 const CTransaction& tx)
206{
207 assert(tip);
208
209 auto prev_heights{CalculatePrevHeights(*tip, coins_view, tx)};
210 if (!prev_heights.has_value()) return std::nullopt;
211
212 CBlockIndex next_tip;
213 next_tip.pprev = tip;
214 // When SequenceLocks() is called within ConnectBlock(), the height
215 // of the block *being* evaluated is what is used.
216 // Thus if we want to know if a transaction can be part of the
217 // *next* block, we need to use one more than active_chainstate.m_chain.Height()
218 next_tip.nHeight = tip->nHeight + 1;
219 const auto [min_height, min_time] = CalculateSequenceLocks(tx, STANDARD_LOCKTIME_VERIFY_FLAGS, prev_heights.value(), next_tip);
220
221 // Also store the hash of the block with the highest height of
222 // all the blocks which have sequence locked prevouts.
223 // This hash needs to still be on the chain
224 // for these LockPoint calculations to be valid
225 // Note: It is impossible to correctly calculate a maxInputBlock
226 // if any of the sequence locked inputs depend on unconfirmed txs,
227 // except in the special case where the relative lock time/height
228 // is 0, which is equivalent to no sequence lock. Since we assume
229 // input height of tip+1 for mempool txs and test the resulting
230 // min_height and min_time from CalculateSequenceLocks against tip+1.
231 int max_input_height{0};
232 for (const int height : prev_heights.value()) {
233 // Can ignore mempool inputs since we'll fail if they had non-zero locks
234 if (height != next_tip.nHeight) {
235 max_input_height = std::max(max_input_height, height);
236 }
237 }
238
239 // tip->GetAncestor(max_input_height) should never return a nullptr
240 // because max_input_height is always less than the tip height.
241 // It would, however, be a bad bug to continue execution, since a
242 // LockPoints object with the maxInputBlock member set to nullptr
243 // signifies no relative lock time.
244 return LockPoints{min_height, min_time, Assert(tip->GetAncestor(max_input_height))};
245}
246
248 const LockPoints& lock_points)
249{
250 assert(tip != nullptr);
251
252 CBlockIndex index;
253 index.pprev = tip;
254 // CheckSequenceLocksAtTip() uses active_chainstate.m_chain.Height()+1 to evaluate
255 // height based locks because when SequenceLocks() is called within
256 // ConnectBlock(), the height of the block *being*
257 // evaluated is what is used.
258 // Thus if we want to know if a transaction can be part of the
259 // *next* block, we need to use one more than active_chainstate.m_chain.Height()
260 index.nHeight = tip->nHeight + 1;
261
262 return EvaluateSequenceLocks(index, {lock_points.height, lock_points.time});
263}
264
265static void LimitMempoolSize(CTxMemPool& pool, CCoinsViewCache& coins_cache)
267{
269 AssertLockHeld(pool.cs);
270 int expired = pool.Expire(GetTime<std::chrono::seconds>() - pool.m_opts.expiry);
271 if (expired != 0) {
272 LogDebug(BCLog::MEMPOOL, "Expired %i transactions from the memory pool\n", expired);
273 }
274
275 std::vector<COutPoint> vNoSpendsRemaining;
276 pool.TrimToSize(pool.m_opts.max_size_bytes, &vNoSpendsRemaining);
277 for (const COutPoint& removed : vNoSpendsRemaining)
278 coins_cache.Uncache(removed);
279}
280
282{
284 if (active_chainstate.m_chainman.IsInitialBlockDownload()) {
285 return false;
286 }
287 if (active_chainstate.m_chain.Tip()->GetBlockTime() < count_seconds(GetTime<std::chrono::seconds>() - MAX_FEE_ESTIMATION_TIP_AGE))
288 return false;
289 if (active_chainstate.m_chain.Height() < active_chainstate.m_chainman.m_best_header->nHeight - 1) {
290 return false;
291 }
292 return true;
293}
294
296 DisconnectedBlockTransactions& disconnectpool,
297 bool fAddToMempool)
298{
299 if (!m_mempool) return;
300
303 std::vector<Txid> vHashUpdate;
304 {
305 // disconnectpool is ordered so that the front is the most recently-confirmed
306 // transaction (the last tx of the block at the tip) in the disconnected chain.
307 // Iterate disconnectpool in reverse, so that we add transactions
308 // back to the mempool starting with the earliest transaction that had
309 // been previously seen in a block.
310 const auto queuedTx = disconnectpool.take();
311 auto it = queuedTx.rbegin();
312 while (it != queuedTx.rend()) {
313 // ignore validation errors in resurrected transactions
314 if (!fAddToMempool || (*it)->IsCoinBase() ||
315 AcceptToMemoryPool(*this, *it, GetTime(),
316 /*bypass_limits=*/true, /*test_accept=*/false).m_result_type !=
318 // If the transaction doesn't make it in to the mempool, remove any
319 // transactions that depend on it (which would now be orphans).
321 } else if (m_mempool->exists((*it)->GetHash())) {
322 vHashUpdate.push_back((*it)->GetHash());
323 }
324 ++it;
325 }
326 }
327
328 // AcceptToMemoryPool/addNewTransaction all assume that new mempool entries have
329 // no in-mempool children, which is generally not true when adding
330 // previously-confirmed transactions back to the mempool.
331 // UpdateTransactionsFromBlock finds descendants of any transactions in
332 // the disconnectpool that were added back and cleans up the mempool state.
334
335 // Predicate to use for filtering transactions in removeForReorg.
336 // Checks whether the transaction is still final and, if it spends a coinbase output, mature.
337 // Also updates valid entries' cached LockPoints if needed.
338 // If false, the tx is still valid and its lockpoints are updated.
339 // If true, the tx would be invalid in the next block; remove this entry and all of its descendants.
340 // Note that TRUC rules are not applied here, so reorgs may cause violations of TRUC inheritance or
341 // topology restrictions.
342 const auto filter_final_and_mature = [&](CTxMemPool::txiter it)
346 const CTransaction& tx = it->GetTx();
347
348 // The transaction must be final.
349 if (!CheckFinalTxAtTip(*Assert(m_chain.Tip()), tx)) return true;
350
351 const LockPoints& lp = it->GetLockPoints();
352 // CheckSequenceLocksAtTip checks if the transaction will be final in the next block to be
353 // created on top of the new chain.
356 return true;
357 }
358 } else {
359 const CCoinsViewMemPool view_mempool{&CoinsTip(), *m_mempool};
360 const std::optional<LockPoints> new_lock_points{CalculateLockPointsAtTip(m_chain.Tip(), view_mempool, tx)};
361 if (new_lock_points.has_value() && CheckSequenceLocksAtTip(m_chain.Tip(), *new_lock_points)) {
362 // Now update the mempool entry lockpoints as well.
363 it->UpdateLockPoints(*new_lock_points);
364 } else {
365 return true;
366 }
367 }
368
369 // If the transaction spends any coinbase outputs, it must be mature.
370 if (it->GetSpendsCoinbase()) {
371 for (const CTxIn& txin : tx.vin) {
372 if (m_mempool->exists(txin.prevout.hash)) continue;
373 const Coin& coin{CoinsTip().AccessCoin(txin.prevout)};
374 assert(!coin.IsSpent());
375 const auto mempool_spend_height{m_chain.Tip()->nHeight + 1};
376 if (coin.IsCoinBase() && mempool_spend_height - coin.nHeight < COINBASE_MATURITY) {
377 return true;
378 }
379 }
380 }
381 // Transaction is still valid and cached LockPoints are updated.
382 return false;
383 };
384
385 // We also need to remove any now-immature transactions
386 m_mempool->removeForReorg(m_chain, filter_final_and_mature);
387 // Re-limit mempool size, in case we added any transactions
389}
390
397 const CCoinsViewCache& view, const CTxMemPool& pool,
399 ValidationCache& validation_cache)
401{
404
406 for (const CTxIn& txin : tx.vin) {
407 const Coin& coin = view.AccessCoin(txin.prevout);
408
409 // This coin was checked in PreChecks and MemPoolAccept
410 // has been holding cs_main since then.
411 Assume(!coin.IsSpent());
412 if (coin.IsSpent()) return false;
413
414 // If the Coin is available, there are 2 possibilities:
415 // it is available in our current ChainstateActive UTXO set,
416 // or it's a UTXO provided by a transaction in our mempool.
417 // Ensure the scriptPubKeys in Coins from CoinsView are correct.
418 const CTransactionRef& txFrom = pool.get(txin.prevout.hash);
419 if (txFrom) {
420 assert(txFrom->GetHash() == txin.prevout.hash);
421 assert(txFrom->vout.size() > txin.prevout.n);
422 assert(txFrom->vout[txin.prevout.n] == coin.out);
423 } else {
424 const Coin& coinFromUTXOSet = coins_tip.AccessCoin(txin.prevout);
425 assert(!coinFromUTXOSet.IsSpent());
426 assert(coinFromUTXOSet.out == coin.out);
427 }
428 }
429
430 // Call CheckInputScripts() to cache signature and script validity against current tip consensus rules.
431 return CheckInputScripts(tx, state, view, flags, /* cacheSigStore= */ true, /* cacheFullScriptStore= */ true, txdata, validation_cache);
432}
433
434namespace {
435
436class MemPoolAccept
437{
438public:
439 explicit MemPoolAccept(CTxMemPool& mempool, Chainstate& active_chainstate) :
440 m_pool(mempool),
441 m_view(&m_dummy),
442 m_viewmempool(&active_chainstate.CoinsTip(), m_pool),
443 m_active_chainstate(active_chainstate)
444 {
445 }
446
447 // We put the arguments we're handed into a struct, so we can pass them
448 // around easier.
449 struct ATMPArgs {
450 const CChainParams& m_chainparams;
451 const int64_t m_accept_time;
452 const bool m_bypass_limits;
453 /*
454 * Return any outpoints which were not previously present in the coins
455 * cache, but were added as a result of validating the tx for mempool
456 * acceptance. This allows the caller to optionally remove the cache
457 * additions if the associated transaction ends up being rejected by
458 * the mempool.
459 */
460 std::vector<COutPoint>& m_coins_to_uncache;
462 const bool m_test_accept;
466 const bool m_allow_replacement;
468 const bool m_allow_sibling_eviction;
471 const bool m_package_submission;
475 const bool m_package_feerates;
480 const std::optional<CFeeRate> m_client_maxfeerate;
481
483 static ATMPArgs SingleAccept(const CChainParams& chainparams, int64_t accept_time,
484 bool bypass_limits, std::vector<COutPoint>& coins_to_uncache,
485 bool test_accept) {
486 return ATMPArgs{/* m_chainparams */ chainparams,
487 /* m_accept_time */ accept_time,
488 /* m_bypass_limits */ bypass_limits,
489 /* m_coins_to_uncache */ coins_to_uncache,
490 /* m_test_accept */ test_accept,
491 /* m_allow_replacement */ true,
492 /* m_allow_sibling_eviction */ true,
493 /* m_package_submission */ false,
494 /* m_package_feerates */ false,
495 /* m_client_maxfeerate */ {}, // checked by caller
496 };
497 }
498
500 static ATMPArgs PackageTestAccept(const CChainParams& chainparams, int64_t accept_time,
501 std::vector<COutPoint>& coins_to_uncache) {
502 return ATMPArgs{/* m_chainparams */ chainparams,
503 /* m_accept_time */ accept_time,
504 /* m_bypass_limits */ false,
505 /* m_coins_to_uncache */ coins_to_uncache,
506 /* m_test_accept */ true,
507 /* m_allow_replacement */ false,
508 /* m_allow_sibling_eviction */ false,
509 /* m_package_submission */ false, // not submitting to mempool
510 /* m_package_feerates */ false,
511 /* m_client_maxfeerate */ {}, // checked by caller
512 };
513 }
514
516 static ATMPArgs PackageChildWithParents(const CChainParams& chainparams, int64_t accept_time,
517 std::vector<COutPoint>& coins_to_uncache, const std::optional<CFeeRate>& client_maxfeerate) {
518 return ATMPArgs{/* m_chainparams */ chainparams,
519 /* m_accept_time */ accept_time,
520 /* m_bypass_limits */ false,
521 /* m_coins_to_uncache */ coins_to_uncache,
522 /* m_test_accept */ false,
523 /* m_allow_replacement */ true,
524 /* m_allow_sibling_eviction */ false,
525 /* m_package_submission */ true,
526 /* m_package_feerates */ true,
527 /* m_client_maxfeerate */ client_maxfeerate,
528 };
529 }
530
532 static ATMPArgs SingleInPackageAccept(const ATMPArgs& package_args) {
533 return ATMPArgs{/* m_chainparams */ package_args.m_chainparams,
534 /* m_accept_time */ package_args.m_accept_time,
535 /* m_bypass_limits */ false,
536 /* m_coins_to_uncache */ package_args.m_coins_to_uncache,
537 /* m_test_accept */ package_args.m_test_accept,
538 /* m_allow_replacement */ true,
539 /* m_allow_sibling_eviction */ true,
540 /* m_package_submission */ true, // trim at the end of AcceptPackage()
541 /* m_package_feerates */ false, // only 1 transaction
542 /* m_client_maxfeerate */ package_args.m_client_maxfeerate,
543 };
544 }
545
546 private:
547 // Private ctor to avoid exposing details to clients and allowing the possibility of
548 // mixing up the order of the arguments. Use static functions above instead.
549 ATMPArgs(const CChainParams& chainparams,
550 int64_t accept_time,
551 bool bypass_limits,
552 std::vector<COutPoint>& coins_to_uncache,
553 bool test_accept,
554 bool allow_replacement,
555 bool allow_sibling_eviction,
556 bool package_submission,
557 bool package_feerates,
558 std::optional<CFeeRate> client_maxfeerate)
559 : m_chainparams{chainparams},
560 m_accept_time{accept_time},
561 m_bypass_limits{bypass_limits},
562 m_coins_to_uncache{coins_to_uncache},
563 m_test_accept{test_accept},
564 m_allow_replacement{allow_replacement},
565 m_allow_sibling_eviction{allow_sibling_eviction},
566 m_package_submission{package_submission},
567 m_package_feerates{package_feerates},
568 m_client_maxfeerate{client_maxfeerate}
569 {
570 // If we are using package feerates, we must be doing package submission.
571 // It also means sibling eviction is not permitted.
572 if (m_package_feerates) {
573 Assume(m_package_submission);
574 Assume(!m_allow_sibling_eviction);
575 }
576 if (m_allow_sibling_eviction) Assume(m_allow_replacement);
577 }
578 };
579
581 void CleanupTemporaryCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
582
583 // Single transaction acceptance
584 MempoolAcceptResult AcceptSingleTransactionAndCleanup(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
585 LOCK(m_pool.cs);
586 MempoolAcceptResult result = AcceptSingleTransactionInternal(ptx, args);
587 ClearSubPackageState();
588 return result;
589 }
590 MempoolAcceptResult AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
591
597 PackageMempoolAcceptResult AcceptMultipleTransactionsAndCleanup(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
598 LOCK(m_pool.cs);
599 PackageMempoolAcceptResult result = AcceptMultipleTransactionsInternal(txns, args);
600 ClearSubPackageState();
601 return result;
602 }
603 PackageMempoolAcceptResult AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
604
615 PackageMempoolAcceptResult AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
617
622 PackageMempoolAcceptResult AcceptPackage(const Package& package, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
623
624private:
625 // All the intermediate state that gets passed between the various levels
626 // of checking a given transaction.
627 struct Workspace {
628 explicit Workspace(const CTransactionRef& ptx) : m_ptx(ptx), m_hash(ptx->GetHash()) {}
631 std::set<Txid> m_conflicts;
634 CTxMemPool::setEntries m_iters_conflicting;
636 std::vector<CTxMemPoolEntry::CTxMemPoolEntryRef> m_parents;
637 /* Handle to the tx in the changeset */
641 bool m_sibling_eviction{false};
642
645 int64_t m_vsize;
647 CAmount m_base_fees;
649 CAmount m_modified_fees;
650
654 CFeeRate m_package_feerate{0};
655
656 const CTransactionRef& m_ptx;
658 const Txid& m_hash;
659 TxValidationState m_state;
662 PrecomputedTransactionData m_precomputed_txdata;
663 };
664
665 // Run the policy checks on a given transaction, excluding any script checks.
666 // Looks up inputs, calculates feerate, considers replacement, evaluates
667 // package limits, etc. As this function can be invoked for "free" by a peer,
668 // only tests that are fast should be done here (to avoid CPU DoS).
669 bool PreChecks(ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
670
671 // Run checks for mempool replace-by-fee, only used in AcceptSingleTransaction.
672 bool ReplacementChecks(Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
673
674 // Enforce package mempool ancestor/descendant limits (distinct from individual
675 // ancestor/descendant limits done in PreChecks) and run Package RBF checks.
676 bool PackageMempoolChecks(const std::vector<CTransactionRef>& txns,
677 std::vector<Workspace>& workspaces,
678 int64_t total_vsize,
679 PackageValidationState& package_state) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
680
681 // Run the script checks using our policy flags. As this can be slow, we should
682 // only invoke this on transactions that have otherwise passed policy checks.
683 bool PolicyScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
684
685 // Re-run the script checks, using consensus flags, and try to cache the
686 // result in the scriptcache. This should be done after
687 // PolicyScriptChecks(). This requires that all inputs either be in our
688 // utxo set or in the mempool.
689 bool ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
690
691 // Try to add the transaction to the mempool, removing any conflicts first.
692 void FinalizeSubpackage(const ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
693
694 // Submit all transactions to the mempool and call ConsensusScriptChecks to add to the script
695 // cache - should only be called after successful validation of all transactions in the package.
696 // Does not call LimitMempoolSize(), so mempool max_size_bytes may be temporarily exceeded.
697 bool SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces, PackageValidationState& package_state,
698 std::map<Wtxid, MempoolAcceptResult>& results)
700
701 // Compare a package's feerate against minimum allowed.
702 bool CheckFeeRate(size_t package_size, CAmount package_fee, TxValidationState& state) EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs)
703 {
705 AssertLockHeld(m_pool.cs);
706 CAmount mempoolRejectFee = m_pool.GetMinFee().GetFee(package_size);
707 if (mempoolRejectFee > 0 && package_fee < mempoolRejectFee) {
708 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool min fee not met", strprintf("%d < %d", package_fee, mempoolRejectFee));
709 }
710
711 if (package_fee < m_pool.m_opts.min_relay_feerate.GetFee(package_size)) {
712 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "min relay fee not met",
713 strprintf("%d < %d", package_fee, m_pool.m_opts.min_relay_feerate.GetFee(package_size)));
714 }
715 return true;
716 }
717
718 ValidationCache& GetValidationCache()
719 {
720 return m_active_chainstate.m_chainman.m_validation_cache;
721 }
722
723private:
724 CTxMemPool& m_pool;
725
737 CCoinsViewCache m_view;
738
739 // These are the two possible backends for m_view.
742 CCoinsViewMemPool m_viewmempool;
746 CCoinsView m_dummy;
747
748 Chainstate& m_active_chainstate;
749
750 // Fields below are per *sub*package state and must be reset prior to subsequent
751 // AcceptSingleTransaction and AcceptMultipleTransactions invocations
752 struct SubPackageState {
754 CAmount m_total_modified_fees{0};
756 int64_t m_total_vsize{0};
757
758 // RBF-related members
761 bool m_rbf{false};
763 std::list<CTransactionRef> m_replaced_transactions;
764 /* Changeset representing adding transactions and removing their conflicts. */
765 std::unique_ptr<CTxMemPool::ChangeSet> m_changeset;
766
768 CAmount m_conflicting_fees{0};
770 size_t m_conflicting_size{0};
771 };
772
773 struct SubPackageState m_subpackage;
774
776 void ClearSubPackageState() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs)
777 {
778 m_subpackage = SubPackageState{};
779
780 // And clean coins while at it
781 CleanupTemporaryCoins();
782 }
783};
784
785bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)
786{
788 AssertLockHeld(m_pool.cs);
789 const CTransactionRef& ptx = ws.m_ptx;
790 const CTransaction& tx = *ws.m_ptx;
791 const Txid& hash = ws.m_hash;
792
793 // Copy/alias what we need out of args
794 const int64_t nAcceptTime = args.m_accept_time;
795 const bool bypass_limits = args.m_bypass_limits;
796 std::vector<COutPoint>& coins_to_uncache = args.m_coins_to_uncache;
797
798 // Alias what we need out of ws
799 TxValidationState& state = ws.m_state;
800
801 if (!CheckTransaction(tx, state)) {
802 return false; // state filled in by CheckTransaction
803 }
804
805 // Coinbase is only valid in a block, not as a loose transaction
806 if (tx.IsCoinBase())
807 return state.Invalid(TxValidationResult::TX_CONSENSUS, "coinbase");
808
809 // Rather not work on nonstandard transactions (unless -testnet/-regtest)
810 std::string reason;
811 if (m_pool.m_opts.require_standard && !IsStandardTx(tx, m_pool.m_opts.max_datacarrier_bytes, m_pool.m_opts.permit_bare_multisig, m_pool.m_opts.dust_relay_feerate, reason)) {
812 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, reason);
813 }
814
815 // Transactions smaller than 65 non-witness bytes are not relayed to mitigate CVE-2017-12842.
817 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "tx-size-small");
818
819 // Only accept nLockTime-using transactions that can be mined in the next
820 // block; we don't want our mempool filled up with transactions that can't
821 // be mined yet.
822 if (!CheckFinalTxAtTip(*Assert(m_active_chainstate.m_chain.Tip()), tx)) {
823 return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-final");
824 }
825
826 if (m_pool.exists(tx.GetWitnessHash())) {
827 // Exact transaction already exists in the mempool.
828 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-in-mempool");
829 } else if (m_pool.exists(tx.GetHash())) {
830 // Transaction with the same non-witness data but different witness (same txid, different
831 // wtxid) already exists in the mempool.
832 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-same-nonwitness-data-in-mempool");
833 }
834
835 // Check for conflicts with in-memory transactions
836 for (const CTxIn &txin : tx.vin)
837 {
838 const CTransaction* ptxConflicting = m_pool.GetConflictTx(txin.prevout);
839 if (ptxConflicting) {
840 if (!args.m_allow_replacement) {
841 // Transaction conflicts with a mempool tx, but we're not allowing replacements in this context.
842 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "bip125-replacement-disallowed");
843 }
844 ws.m_conflicts.insert(ptxConflicting->GetHash());
845 }
846 }
847
848 m_view.SetBackend(m_viewmempool);
849
850 const CCoinsViewCache& coins_cache = m_active_chainstate.CoinsTip();
851 // do all inputs exist?
852 for (const CTxIn& txin : tx.vin) {
853 if (!coins_cache.HaveCoinInCache(txin.prevout)) {
854 coins_to_uncache.push_back(txin.prevout);
855 }
856
857 // Note: this call may add txin.prevout to the coins cache
858 // (coins_cache.cacheCoins) by way of FetchCoin(). It should be removed
859 // later (via coins_to_uncache) if this tx turns out to be invalid.
860 if (!m_view.HaveCoin(txin.prevout)) {
861 // Are inputs missing because we already have the tx?
862 for (size_t out = 0; out < tx.vout.size(); out++) {
863 // Optimistically just do efficient check of cache for outputs
864 if (coins_cache.HaveCoinInCache(COutPoint(hash, out))) {
865 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-known");
866 }
867 }
868 // Otherwise assume this might be an orphan tx for which we just haven't seen parents yet
869 return state.Invalid(TxValidationResult::TX_MISSING_INPUTS, "bad-txns-inputs-missingorspent");
870 }
871 }
872
873 // This is const, but calls into the back end CoinsViews. The CCoinsViewDB at the bottom of the
874 // hierarchy brings the best block into scope. See CCoinsViewDB::GetBestBlock().
875 m_view.GetBestBlock();
876
877 // we have all inputs cached now, so switch back to dummy (to protect
878 // against bugs where we pull more inputs from disk that miss being added
879 // to coins_to_uncache)
880 m_view.SetBackend(m_dummy);
881
882 assert(m_active_chainstate.m_blockman.LookupBlockIndex(m_view.GetBestBlock()) == m_active_chainstate.m_chain.Tip());
883
884 // Only accept BIP68 sequence locked transactions that can be mined in the next
885 // block; we don't want our mempool filled up with transactions that can't
886 // be mined yet.
887 // Pass in m_view which has all of the relevant inputs cached. Note that, since m_view's
888 // backend was removed, it no longer pulls coins from the mempool.
889 const std::optional<LockPoints> lock_points{CalculateLockPointsAtTip(m_active_chainstate.m_chain.Tip(), m_view, tx)};
890 if (!lock_points.has_value() || !CheckSequenceLocksAtTip(m_active_chainstate.m_chain.Tip(), *lock_points)) {
891 return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-BIP68-final");
892 }
893
894 // The mempool holds txs for the next block, so pass height+1 to CheckTxInputs
895 if (!Consensus::CheckTxInputs(tx, state, m_view, m_active_chainstate.m_chain.Height() + 1, ws.m_base_fees)) {
896 return false; // state filled in by CheckTxInputs
897 }
898
899 if (m_pool.m_opts.require_standard && !AreInputsStandard(tx, m_view)) {
900 return state.Invalid(TxValidationResult::TX_INPUTS_NOT_STANDARD, "bad-txns-nonstandard-inputs");
901 }
902
903 // Check for non-standard witnesses.
904 if (tx.HasWitness() && m_pool.m_opts.require_standard && !IsWitnessStandard(tx, m_view)) {
905 return state.Invalid(TxValidationResult::TX_WITNESS_MUTATED, "bad-witness-nonstandard");
906 }
907
908 int64_t nSigOpsCost = GetTransactionSigOpCost(tx, m_view, STANDARD_SCRIPT_VERIFY_FLAGS);
909
910 // Keep track of transactions that spend a coinbase, which we re-scan
911 // during reorgs to ensure COINBASE_MATURITY is still met.
912 bool fSpendsCoinbase = false;
913 for (const CTxIn &txin : tx.vin) {
914 const Coin &coin = m_view.AccessCoin(txin.prevout);
915 if (coin.IsCoinBase()) {
916 fSpendsCoinbase = true;
917 break;
918 }
919 }
920
921 // Set entry_sequence to 0 when bypass_limits is used; this allows txs from a block
922 // reorg to be marked earlier than any child txs that were already in the mempool.
923 const uint64_t entry_sequence = bypass_limits ? 0 : m_pool.GetSequence();
924 if (!m_subpackage.m_changeset) {
925 m_subpackage.m_changeset = m_pool.GetChangeSet();
926 }
927 ws.m_tx_handle = m_subpackage.m_changeset->StageAddition(ptx, ws.m_base_fees, nAcceptTime, m_active_chainstate.m_chain.Height(), entry_sequence, fSpendsCoinbase, nSigOpsCost, lock_points.value());
928
929 // ws.m_modified_fees includes any fee deltas from PrioritiseTransaction
930 ws.m_modified_fees = ws.m_tx_handle->GetModifiedFee();
931
932 ws.m_vsize = ws.m_tx_handle->GetTxSize();
933
934 // Enforces 0-fee for dust transactions, no incentive to be mined alone
935 if (m_pool.m_opts.require_standard) {
936 if (!PreCheckEphemeralTx(*ptx, m_pool.m_opts.dust_relay_feerate, ws.m_base_fees, ws.m_modified_fees, state)) {
937 return false; // state filled in by PreCheckEphemeralTx
938 }
939 }
940
941 if (nSigOpsCost > MAX_STANDARD_TX_SIGOPS_COST)
942 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "bad-txns-too-many-sigops",
943 strprintf("%d", nSigOpsCost));
944
945 // No individual transactions are allowed below the min relay feerate except from disconnected blocks.
946 // This requirement, unlike CheckFeeRate, cannot be bypassed using m_package_feerates because,
947 // while a tx could be package CPFP'd when entering the mempool, we do not have a DoS-resistant
948 // method of ensuring the tx remains bumped. For example, the fee-bumping child could disappear
949 // due to a replacement.
950 // The only exception is TRUC transactions.
951 if (!bypass_limits && ws.m_ptx->version != TRUC_VERSION && ws.m_modified_fees < m_pool.m_opts.min_relay_feerate.GetFee(ws.m_vsize)) {
952 // Even though this is a fee-related failure, this result is TX_MEMPOOL_POLICY, not
953 // TX_RECONSIDERABLE, because it cannot be bypassed using package validation.
954 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "min relay fee not met",
955 strprintf("%d < %d", ws.m_modified_fees, m_pool.m_opts.min_relay_feerate.GetFee(ws.m_vsize)));
956 }
957 // No individual transactions are allowed below the mempool min feerate except from disconnected
958 // blocks and transactions in a package. Package transactions will be checked using package
959 // feerate later.
960 if (!bypass_limits && !args.m_package_feerates && !CheckFeeRate(ws.m_vsize, ws.m_modified_fees, state)) return false;
961
962 ws.m_iters_conflicting = m_pool.GetIterSet(ws.m_conflicts);
963
964 ws.m_parents = m_pool.GetParents(*ws.m_tx_handle);
965
966 if (!args.m_bypass_limits) {
967 // Perform the TRUC checks, using the in-mempool parents.
968 if (const auto err{SingleTRUCChecks(m_pool, ws.m_ptx, ws.m_parents, ws.m_conflicts, ws.m_vsize)}) {
969 // Single transaction contexts only.
970 if (args.m_allow_sibling_eviction && err->second != nullptr) {
971 // We should only be considering where replacement is considered valid as well.
972 Assume(args.m_allow_replacement);
973 // Potential sibling eviction. Add the sibling to our list of mempool conflicts to be
974 // included in RBF checks.
975 ws.m_conflicts.insert(err->second->GetHash());
976 // Adding the sibling to m_iters_conflicting here means that it doesn't count towards
977 // RBF Carve Out above. This is correct, since removing to-be-replaced transactions from
978 // the descendant count is done separately in SingleTRUCChecks for TRUC transactions.
979 ws.m_iters_conflicting.insert(m_pool.GetIter(err->second->GetHash()).value());
980 ws.m_sibling_eviction = true;
981 // The sibling will be treated as part of the to-be-replaced set in ReplacementChecks.
982 // Note that we are not checking whether it opts in to replaceability via BIP125 or TRUC
983 // (which is normally done in PreChecks). However, the only way a TRUC transaction can
984 // have a non-TRUC and non-BIP125 descendant is due to a reorg.
985 } else {
986 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "TRUC-violation", err->first);
987 }
988 }
989 }
990
991 // We want to detect conflicts in any tx in a package to trigger package RBF logic
992 m_subpackage.m_rbf |= !ws.m_conflicts.empty();
993 return true;
994}
995
996bool MemPoolAccept::ReplacementChecks(Workspace& ws)
997{
999 AssertLockHeld(m_pool.cs);
1000
1001 const CTransaction& tx = *ws.m_ptx;
1002 const Txid& hash = ws.m_hash;
1003 TxValidationState& state = ws.m_state;
1004
1005 CFeeRate newFeeRate(ws.m_modified_fees, ws.m_vsize);
1006
1007 CTxMemPool::setEntries all_conflicts;
1008
1009 // Calculate all conflicting entries and enforce Rule #5.
1010 if (const auto err_string{GetEntriesForConflicts(tx, m_pool, ws.m_iters_conflicting, all_conflicts)}) {
1012 strprintf("too many potential replacements%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1013 }
1014
1015 // Check if it's economically rational to mine this transaction rather than the ones it
1016 // replaces and pays for its own relay fees. Enforce Rules #3 and #4.
1017 for (CTxMemPool::txiter it : all_conflicts) {
1018 m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1019 m_subpackage.m_conflicting_size += it->GetTxSize();
1020 }
1021
1022 if (const auto err_string{PaysForRBF(m_subpackage.m_conflicting_fees, ws.m_modified_fees, ws.m_vsize,
1023 m_pool.m_opts.incremental_relay_feerate, hash)}) {
1024 // Result may change in a package context
1026 strprintf("insufficient fee%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1027 }
1028
1029 // Add all the to-be-removed transactions to the changeset.
1030 for (auto it : all_conflicts) {
1031 m_subpackage.m_changeset->StageRemoval(it);
1032 }
1033
1034 // Run cluster size limit checks and fail if we exceed them.
1035 if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1036 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
1037 }
1038
1039 if (const auto err_string{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1040 // We checked above for the cluster size limits being respected, so a
1041 // failure here can only be due to an insufficient fee.
1042 Assume(err_string->first == DiagramCheckError::FAILURE);
1043 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "replacement-failed", err_string->second);
1044 }
1045
1046 return true;
1047}
1048
1049bool MemPoolAccept::PackageMempoolChecks(const std::vector<CTransactionRef>& txns,
1050 std::vector<Workspace>& workspaces,
1051 const int64_t total_vsize,
1052 PackageValidationState& package_state)
1053{
1055 AssertLockHeld(m_pool.cs);
1056
1057 assert(std::all_of(txns.cbegin(), txns.cend(), [this](const auto& tx)
1058 { return !m_pool.exists(tx->GetHash());}));
1059
1060 assert(txns.size() == workspaces.size());
1061
1062 // No conflicts means we're finished. Further checks are all RBF-only.
1063 if (!m_subpackage.m_rbf) return true;
1064
1065 // We're in package RBF context; replacement proposal must be size 2
1066 if (workspaces.size() != 2 || !Assume(IsChildWithParents(txns))) {
1067 return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: package must be 1-parent-1-child");
1068 }
1069
1070 // If the package has in-mempool parents, we won't consider a package RBF
1071 // since it would result in a cluster larger than 2.
1072 // N.B. To relax this constraint we will need to revisit how CCoinsViewMemPool::PackageAddTransaction
1073 // is being used inside AcceptMultipleTransactions to track available inputs while processing a package.
1074 // Specifically we would need to check that the ancestors of the new
1075 // transactions don't intersect with the set of transactions to be removed
1076 // due to RBF, which is not checked at all in the package acceptance
1077 // context.
1078 for (const auto& ws : workspaces) {
1079 if (!ws.m_parents.empty()) {
1080 return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "package RBF failed: new transaction cannot have mempool ancestors");
1081 }
1082 }
1083
1084 // Aggregate all conflicts into one set.
1085 CTxMemPool::setEntries direct_conflict_iters;
1086 for (Workspace& ws : workspaces) {
1087 // Aggregate all conflicts into one set.
1088 direct_conflict_iters.merge(ws.m_iters_conflicting);
1089 }
1090
1091 const auto& parent_ws = workspaces[0];
1092 const auto& child_ws = workspaces[1];
1093
1094 // Don't consider replacements that would cause us to remove a large number of mempool entries.
1095 // This limit is not increased in a package RBF. Use the aggregate number of transactions.
1096 CTxMemPool::setEntries all_conflicts;
1097 if (const auto err_string{GetEntriesForConflicts(*child_ws.m_ptx, m_pool, direct_conflict_iters,
1098 all_conflicts)}) {
1099 return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1100 "package RBF failed: too many potential replacements", *err_string);
1101 }
1102
1103 for (CTxMemPool::txiter it : all_conflicts) {
1104 m_subpackage.m_changeset->StageRemoval(it);
1105 m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1106 m_subpackage.m_conflicting_size += it->GetTxSize();
1107 }
1108
1109 // Use the child as the transaction for attributing errors to.
1110 const Txid& child_hash = child_ws.m_ptx->GetHash();
1111 if (const auto err_string{PaysForRBF(/*original_fees=*/m_subpackage.m_conflicting_fees,
1112 /*replacement_fees=*/m_subpackage.m_total_modified_fees,
1113 /*replacement_vsize=*/m_subpackage.m_total_vsize,
1114 m_pool.m_opts.incremental_relay_feerate, child_hash)}) {
1115 return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1116 "package RBF failed: insufficient anti-DoS fees", *err_string);
1117 }
1118
1119 // Ensure this two transaction package is a "chunk" on its own; we don't want the child
1120 // to be only paying anti-DoS fees
1121 const CFeeRate parent_feerate(parent_ws.m_modified_fees, parent_ws.m_vsize);
1122 const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1123 if (package_feerate <= parent_feerate) {
1124 return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1125 "package RBF failed: package feerate is less than or equal to parent feerate",
1126 strprintf("package feerate %s <= parent feerate is %s", package_feerate.ToString(), parent_feerate.ToString()));
1127 }
1128
1129 // Run cluster size limit checks and fail if we exceed them.
1130 if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1131 return package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
1132 }
1133
1134 // Check if it's economically rational to mine this package rather than the ones it replaces.
1135 if (const auto err_tup{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1136 Assume(err_tup->first == DiagramCheckError::FAILURE);
1137 return package_state.Invalid(PackageValidationResult::PCKG_POLICY,
1138 "package RBF failed: " + err_tup.value().second, "");
1139 }
1140
1141 LogDebug(BCLog::TXPACKAGES, "package RBF checks passed: parent %s (wtxid=%s), child %s (wtxid=%s), package hash (%s)\n",
1142 txns.front()->GetHash().ToString(), txns.front()->GetWitnessHash().ToString(),
1143 txns.back()->GetHash().ToString(), txns.back()->GetWitnessHash().ToString(),
1144 GetPackageHash(txns).ToString());
1145
1146
1147 return true;
1148}
1149
1150bool MemPoolAccept::PolicyScriptChecks(const ATMPArgs& args, Workspace& ws)
1151{
1153 AssertLockHeld(m_pool.cs);
1154 const CTransaction& tx = *ws.m_ptx;
1155 TxValidationState& state = ws.m_state;
1156
1157 constexpr script_verify_flags scriptVerifyFlags = STANDARD_SCRIPT_VERIFY_FLAGS;
1158
1159 // Check input scripts and signatures.
1160 // This is done last to help prevent CPU exhaustion denial-of-service attacks.
1161 if (!CheckInputScripts(tx, state, m_view, scriptVerifyFlags, true, false, ws.m_precomputed_txdata, GetValidationCache())) {
1162 // Detect a failure due to a missing witness so that p2p code can handle rejection caching appropriately.
1163 if (!tx.HasWitness() && SpendsNonAnchorWitnessProg(tx, m_view)) {
1165 state.GetRejectReason(), state.GetDebugMessage());
1166 }
1167 return false; // state filled in by CheckInputScripts
1168 }
1169
1170 return true;
1171}
1172
1173bool MemPoolAccept::ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws)
1174{
1176 AssertLockHeld(m_pool.cs);
1177 const CTransaction& tx = *ws.m_ptx;
1178 const Txid& hash = ws.m_hash;
1179 TxValidationState& state = ws.m_state;
1180
1181 // Check again against the current block tip's script verification
1182 // flags to cache our script execution flags. This is, of course,
1183 // useless if the next block has different script flags from the
1184 // previous one, but because the cache tracks script flags for us it
1185 // will auto-invalidate and we'll just have a few blocks of extra
1186 // misses on soft-fork activation.
1187 //
1188 // This is also useful in case of bugs in the standard flags that cause
1189 // transactions to pass as valid when they're actually invalid. For
1190 // instance the STRICTENC flag was incorrectly allowing certain
1191 // CHECKSIG NOT scripts to pass, even though they were invalid.
1192 //
1193 // There is a similar check in CreateNewBlock() to prevent creating
1194 // invalid blocks (using TestBlockValidity), however allowing such
1195 // transactions into the mempool can be exploited as a DoS attack.
1196 script_verify_flags currentBlockScriptVerifyFlags{GetBlockScriptFlags(*m_active_chainstate.m_chain.Tip(), m_active_chainstate.m_chainman)};
1197 if (!CheckInputsFromMempoolAndCache(tx, state, m_view, m_pool, currentBlockScriptVerifyFlags,
1198 ws.m_precomputed_txdata, m_active_chainstate.CoinsTip(), GetValidationCache())) {
1199 LogError("BUG! PLEASE REPORT THIS! CheckInputScripts failed against latest-block but not STANDARD flags %s, %s", hash.ToString(), state.ToString());
1200 return Assume(false);
1201 }
1202
1203 return true;
1204}
1205
1206void MemPoolAccept::FinalizeSubpackage(const ATMPArgs& args)
1207{
1209 AssertLockHeld(m_pool.cs);
1210
1211 if (!m_subpackage.m_changeset->GetRemovals().empty()) Assume(args.m_allow_replacement);
1212 // Remove conflicting transactions from the mempool
1213 for (CTxMemPool::txiter it : m_subpackage.m_changeset->GetRemovals())
1214 {
1215 std::string log_string = strprintf("replacing mempool tx %s (wtxid=%s, fees=%s, vsize=%s). ",
1216 it->GetTx().GetHash().ToString(),
1217 it->GetTx().GetWitnessHash().ToString(),
1218 it->GetFee(),
1219 it->GetTxSize());
1220 FeeFrac feerate{m_subpackage.m_total_modified_fees, int32_t(m_subpackage.m_total_vsize)};
1221 uint256 tx_or_package_hash{};
1222 const bool replaced_with_tx{m_subpackage.m_changeset->GetTxCount() == 1};
1223 if (replaced_with_tx) {
1224 const CTransaction& tx = m_subpackage.m_changeset->GetAddedTxn(0);
1225 tx_or_package_hash = tx.GetHash().ToUint256();
1226 log_string += strprintf("New tx %s (wtxid=%s, fees=%s, vsize=%s)",
1227 tx.GetHash().ToString(),
1228 tx.GetWitnessHash().ToString(),
1229 feerate.fee,
1230 feerate.size);
1231 } else {
1232 tx_or_package_hash = GetPackageHash(m_subpackage.m_changeset->GetAddedTxns());
1233 log_string += strprintf("New package %s with %lu txs, fees=%s, vsize=%s",
1234 tx_or_package_hash.ToString(),
1235 m_subpackage.m_changeset->GetTxCount(),
1236 feerate.fee,
1237 feerate.size);
1238
1239 }
1240 LogDebug(BCLog::MEMPOOL, "%s\n", log_string);
1241 TRACEPOINT(mempool, replaced,
1242 it->GetTx().GetHash().data(),
1243 it->GetTxSize(),
1244 it->GetFee(),
1245 std::chrono::duration_cast<std::chrono::duration<std::uint64_t>>(it->GetTime()).count(),
1246 tx_or_package_hash.data(),
1247 feerate.size,
1248 feerate.fee,
1249 replaced_with_tx
1250 );
1251 m_subpackage.m_replaced_transactions.push_back(it->GetSharedTx());
1252 }
1253 m_subpackage.m_changeset->Apply();
1254 m_subpackage.m_changeset.reset();
1255}
1256
1257bool MemPoolAccept::SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces,
1258 PackageValidationState& package_state,
1259 std::map<Wtxid, MempoolAcceptResult>& results)
1260{
1262 AssertLockHeld(m_pool.cs);
1263 // Sanity check: none of the transactions should be in the mempool, and none of the transactions
1264 // should have a same-txid-different-witness equivalent in the mempool.
1265 assert(std::all_of(workspaces.cbegin(), workspaces.cend(), [this](const auto& ws) { return !m_pool.exists(ws.m_ptx->GetHash()); }));
1266
1267 bool all_submitted = true;
1268 FinalizeSubpackage(args);
1269 // ConsensusScriptChecks adds to the script cache and is therefore consensus-critical;
1270 // CheckInputsFromMempoolAndCache asserts that transactions only spend coins available from the
1271 // mempool or UTXO set. Submit each transaction to the mempool immediately after calling
1272 // ConsensusScriptChecks to make the outputs available for subsequent transactions.
1273 for (Workspace& ws : workspaces) {
1274 if (!ConsensusScriptChecks(args, ws)) {
1275 results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1276 // Since PolicyScriptChecks() passed, this should never fail.
1277 Assume(false);
1278 all_submitted = false;
1280 strprintf("BUG! PolicyScriptChecks succeeded but ConsensusScriptChecks failed: %s",
1281 ws.m_ptx->GetHash().ToString()));
1282 // Remove the transaction from the mempool.
1283 if (!m_subpackage.m_changeset) m_subpackage.m_changeset = m_pool.GetChangeSet();
1284 m_subpackage.m_changeset->StageRemoval(m_pool.GetIter(ws.m_ptx->GetHash()).value());
1285 }
1286 }
1287 if (!all_submitted) {
1288 Assume(m_subpackage.m_changeset);
1289 // This code should be unreachable; it's here as belt-and-suspenders
1290 // to try to ensure we have no consensus-invalid transactions in the
1291 // mempool.
1292 m_subpackage.m_changeset->Apply();
1293 m_subpackage.m_changeset.reset();
1294 return false;
1295 }
1296
1297 std::vector<Wtxid> all_package_wtxids;
1298 all_package_wtxids.reserve(workspaces.size());
1299 std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1300 [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1301
1302 if (!m_subpackage.m_replaced_transactions.empty()) {
1303 LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with %u new one(s) for %s additional fees, %d delta bytes\n",
1304 m_subpackage.m_replaced_transactions.size(), workspaces.size(),
1305 m_subpackage.m_total_modified_fees - m_subpackage.m_conflicting_fees,
1306 m_subpackage.m_total_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1307 }
1308
1309 // Add successful results. The returned results may change later if LimitMempoolSize() evicts them.
1310 for (Workspace& ws : workspaces) {
1311 auto iter = m_pool.GetIter(ws.m_ptx->GetHash());
1312 Assume(iter.has_value());
1313 const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1314 CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1315 const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1316 std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1317 results.emplace(ws.m_ptx->GetWitnessHash(),
1318 MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1319 ws.m_base_fees, effective_feerate, effective_feerate_wtxids));
1320 if (!m_pool.m_opts.signals) continue;
1321 const CTransaction& tx = *ws.m_ptx;
1322 const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1323 ws.m_vsize, (*iter)->GetHeight(),
1324 args.m_bypass_limits, args.m_package_submission,
1325 IsCurrentForFeeEstimation(m_active_chainstate),
1326 m_pool.HasNoInputsOf(tx));
1327 m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1328 }
1329 return all_submitted;
1330}
1331
1332MempoolAcceptResult MemPoolAccept::AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args)
1333{
1335 AssertLockHeld(m_pool.cs);
1336
1337 Workspace ws(ptx);
1338 const std::vector<Wtxid> single_wtxid{ws.m_ptx->GetWitnessHash()};
1339
1340 if (!PreChecks(args, ws)) {
1341 if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1342 // Failed for fee reasons. Provide the effective feerate and which tx was included.
1343 return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1344 }
1345 return MempoolAcceptResult::Failure(ws.m_state);
1346 }
1347
1348 if (m_subpackage.m_rbf && !ReplacementChecks(ws)) {
1349 if (ws.m_state.GetResult() == TxValidationResult::TX_RECONSIDERABLE) {
1350 // Failed for incentives-based fee reasons. Provide the effective feerate and which tx was included.
1351 return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_wtxid);
1352 }
1353 return MempoolAcceptResult::Failure(ws.m_state);
1354 }
1355
1356 // Check if the transaction would exceed the cluster size limit.
1357 if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1358 ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
1359 return MempoolAcceptResult::Failure(ws.m_state);
1360 }
1361
1362 // Now that we've verified the cluster limit is respected, we can perform
1363 // calculations involving the full ancestors of the tx.
1364 if (ws.m_conflicts.size()) {
1365 auto ancestors = m_subpackage.m_changeset->CalculateMemPoolAncestors(ws.m_tx_handle);
1366
1367 // A transaction that spends outputs that would be replaced by it is invalid. Now
1368 // that we have the set of all ancestors we can detect this
1369 // pathological case by making sure ws.m_conflicts and this tx's ancestors don't
1370 // intersect.
1371 if (const auto err_string{EntriesAndTxidsDisjoint(ancestors, ws.m_conflicts, ptx->GetHash())}) {
1372 // We classify this as a consensus error because a transaction depending on something it
1373 // conflicts with would be inconsistent.
1374 ws.m_state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-spends-conflicting-tx", *err_string);
1375 return MempoolAcceptResult::Failure(ws.m_state);
1376 }
1377 }
1378
1379 m_subpackage.m_total_vsize = ws.m_vsize;
1380 m_subpackage.m_total_modified_fees = ws.m_modified_fees;
1381
1382 // Individual modified feerate exceeded caller-defined max; abort
1383 if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
1384 ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
1385 return MempoolAcceptResult::Failure(ws.m_state);
1386 }
1387
1388 if (m_pool.m_opts.require_standard) {
1389 Wtxid dummy_wtxid;
1390 if (!CheckEphemeralSpends(/*package=*/{ptx}, m_pool.m_opts.dust_relay_feerate, m_pool, ws.m_state, dummy_wtxid)) {
1391 return MempoolAcceptResult::Failure(ws.m_state);
1392 }
1393 }
1394
1395 // Perform the inexpensive checks first and avoid hashing and signature verification unless
1396 // those checks pass, to mitigate CPU exhaustion denial-of-service attacks.
1397 if (!PolicyScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
1398
1399 if (!ConsensusScriptChecks(args, ws)) return MempoolAcceptResult::Failure(ws.m_state);
1400
1401 const CFeeRate effective_feerate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1402 // Tx was accepted, but not added
1403 if (args.m_test_accept) {
1404 return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize,
1405 ws.m_base_fees, effective_feerate, single_wtxid);
1406 }
1407
1408 FinalizeSubpackage(args);
1409
1410 // Limit the mempool, if appropriate.
1411 if (!args.m_package_submission && !args.m_bypass_limits) {
1412 LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1413 // If mempool contents change, then the m_view cache is dirty. Given this isn't a package
1414 // submission, we won't be using the cache anymore, but clear it anyway for clarity.
1415 CleanupTemporaryCoins();
1416
1417 if (!m_pool.exists(ws.m_hash)) {
1418 // The tx no longer meets our (new) mempool minimum feerate but could be reconsidered in a package.
1419 ws.m_state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool full");
1420 return MempoolAcceptResult::FeeFailure(ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), {ws.m_ptx->GetWitnessHash()});
1421 }
1422 }
1423
1424 if (m_pool.m_opts.signals) {
1425 const CTransaction& tx = *ws.m_ptx;
1426 auto iter = m_pool.GetIter(tx.GetHash());
1427 Assume(iter.has_value());
1428 const auto tx_info = NewMempoolTransactionInfo(ws.m_ptx, ws.m_base_fees,
1429 ws.m_vsize, (*iter)->GetHeight(),
1430 args.m_bypass_limits, args.m_package_submission,
1431 IsCurrentForFeeEstimation(m_active_chainstate),
1432 m_pool.HasNoInputsOf(tx));
1433 m_pool.m_opts.signals->TransactionAddedToMempool(tx_info, m_pool.GetAndIncrementSequence());
1434 }
1435
1436 if (!m_subpackage.m_replaced_transactions.empty()) {
1437 LogDebug(BCLog::MEMPOOL, "replaced %u mempool transactions with 1 new transaction for %s additional fees, %d delta bytes\n",
1438 m_subpackage.m_replaced_transactions.size(),
1439 ws.m_modified_fees - m_subpackage.m_conflicting_fees,
1440 ws.m_vsize - static_cast<int>(m_subpackage.m_conflicting_size));
1441 }
1442
1443 return MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions), ws.m_vsize, ws.m_base_fees,
1444 effective_feerate, single_wtxid);
1445}
1446
1447PackageMempoolAcceptResult MemPoolAccept::AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args)
1448{
1450 AssertLockHeld(m_pool.cs);
1451
1452 // These context-free package limits can be done before taking the mempool lock.
1453 PackageValidationState package_state;
1454 if (!IsWellFormedPackage(txns, package_state, /*require_sorted=*/true)) return PackageMempoolAcceptResult(package_state, {});
1455
1456 std::vector<Workspace> workspaces{};
1457 workspaces.reserve(txns.size());
1458 std::transform(txns.cbegin(), txns.cend(), std::back_inserter(workspaces),
1459 [](const auto& tx) { return Workspace(tx); });
1460 std::map<Wtxid, MempoolAcceptResult> results;
1461
1462 // Do all PreChecks first and fail fast to avoid running expensive script checks when unnecessary.
1463 for (Workspace& ws : workspaces) {
1464 if (!PreChecks(args, ws)) {
1465 package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1466 // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1467 results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1468 return PackageMempoolAcceptResult(package_state, std::move(results));
1469 }
1470
1471 // Individual modified feerate exceeded caller-defined max; abort
1472 // N.B. this doesn't take into account CPFPs. Chunk-aware validation may be more robust.
1473 if (args.m_client_maxfeerate && CFeeRate(ws.m_modified_fees, ws.m_vsize) > args.m_client_maxfeerate.value()) {
1474 // Need to set failure here both individually and at package level
1475 ws.m_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "max feerate exceeded", "");
1476 package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1477 // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1478 results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1479 return PackageMempoolAcceptResult(package_state, std::move(results));
1480 }
1481
1482 // Make the coins created by this transaction available for subsequent transactions in the
1483 // package to spend. If there are no conflicts within the package, no transaction can spend a coin
1484 // needed by another transaction in the package. We also need to make sure that no package
1485 // tx replaces (or replaces the ancestor of) the parent of another package tx. As long as we
1486 // check these two things, we don't need to track the coins spent.
1487 // If a package tx conflicts with a mempool tx, PackageMempoolChecks() ensures later that any package RBF attempt
1488 // has *no* in-mempool ancestors, so we don't have to worry about subsequent transactions in
1489 // same package spending the same in-mempool outpoints. This needs to be revisited for general
1490 // package RBF.
1491 m_viewmempool.PackageAddTransaction(ws.m_ptx);
1492 }
1493
1494 // At this point we have all in-mempool parents, and we know every transaction's vsize.
1495 // Run the TRUC checks on the package.
1496 for (Workspace& ws : workspaces) {
1497 if (auto err{PackageTRUCChecks(m_pool, ws.m_ptx, ws.m_vsize, txns, ws.m_parents)}) {
1498 package_state.Invalid(PackageValidationResult::PCKG_POLICY, "TRUC-violation", err.value());
1499 return PackageMempoolAcceptResult(package_state, {});
1500 }
1501 }
1502
1503 // Transactions must meet two minimum feerates: the mempool minimum fee and min relay fee.
1504 // For transactions consisting of exactly one child and its parents, it suffices to use the
1505 // package feerate (total modified fees / total virtual size) to check this requirement.
1506 // Note that this is an aggregate feerate; this function has not checked that there are transactions
1507 // too low feerate to pay for themselves, or that the child transactions are higher feerate than
1508 // their parents. Using aggregate feerate may allow "parents pay for child" behavior and permit
1509 // a child that is below mempool minimum feerate. To avoid these behaviors, callers of
1510 // AcceptMultipleTransactions need to restrict txns topology (e.g. to ancestor sets) and check
1511 // the feerates of individuals and subsets.
1512 m_subpackage.m_total_vsize = std::accumulate(workspaces.cbegin(), workspaces.cend(), int64_t{0},
1513 [](int64_t sum, auto& ws) { return sum + ws.m_vsize; });
1514 m_subpackage.m_total_modified_fees = std::accumulate(workspaces.cbegin(), workspaces.cend(), CAmount{0},
1515 [](CAmount sum, auto& ws) { return sum + ws.m_modified_fees; });
1516 const CFeeRate package_feerate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize);
1517 std::vector<Wtxid> all_package_wtxids;
1518 all_package_wtxids.reserve(workspaces.size());
1519 std::transform(workspaces.cbegin(), workspaces.cend(), std::back_inserter(all_package_wtxids),
1520 [](const auto& ws) { return ws.m_ptx->GetWitnessHash(); });
1521 TxValidationState placeholder_state;
1522 if (args.m_package_feerates &&
1523 !CheckFeeRate(m_subpackage.m_total_vsize, m_subpackage.m_total_modified_fees, placeholder_state)) {
1524 package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1525 return PackageMempoolAcceptResult(package_state, {{workspaces.back().m_ptx->GetWitnessHash(),
1526 MempoolAcceptResult::FeeFailure(placeholder_state, CFeeRate(m_subpackage.m_total_modified_fees, m_subpackage.m_total_vsize), all_package_wtxids)}});
1527 }
1528
1529 // Apply package mempool RBF checks.
1530 if (!PackageMempoolChecks(txns, workspaces, m_subpackage.m_total_vsize, package_state)) {
1531 return PackageMempoolAcceptResult(package_state, std::move(results));
1532 }
1533
1534 // Check if the transactions would exceed the cluster size limit.
1535 if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1536 package_state.Invalid(PackageValidationResult::PCKG_POLICY, "too-large-cluster", "");
1537 return PackageMempoolAcceptResult(package_state, std::move(results));
1538 }
1539
1540 // Now that we've bounded the resulting possible ancestry count, check package for dust spends
1541 if (m_pool.m_opts.require_standard) {
1542 TxValidationState child_state;
1543 Wtxid child_wtxid;
1544 if (!CheckEphemeralSpends(txns, m_pool.m_opts.dust_relay_feerate, m_pool, child_state, child_wtxid)) {
1545 package_state.Invalid(PackageValidationResult::PCKG_TX, "unspent-dust");
1546 results.emplace(child_wtxid, MempoolAcceptResult::Failure(child_state));
1547 return PackageMempoolAcceptResult(package_state, std::move(results));
1548 }
1549 }
1550
1551 for (Workspace& ws : workspaces) {
1552 ws.m_package_feerate = package_feerate;
1553 if (!PolicyScriptChecks(args, ws)) {
1554 // Exit early to avoid doing pointless work. Update the failed tx result; the rest are unfinished.
1555 package_state.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1556 results.emplace(ws.m_ptx->GetWitnessHash(), MempoolAcceptResult::Failure(ws.m_state));
1557 return PackageMempoolAcceptResult(package_state, std::move(results));
1558 }
1559 if (args.m_test_accept) {
1560 const auto effective_feerate = args.m_package_feerates ? ws.m_package_feerate :
1561 CFeeRate{ws.m_modified_fees, static_cast<int32_t>(ws.m_vsize)};
1562 const auto effective_feerate_wtxids = args.m_package_feerates ? all_package_wtxids :
1563 std::vector<Wtxid>{ws.m_ptx->GetWitnessHash()};
1564 results.emplace(ws.m_ptx->GetWitnessHash(),
1565 MempoolAcceptResult::Success(std::move(m_subpackage.m_replaced_transactions),
1566 ws.m_vsize, ws.m_base_fees, effective_feerate,
1567 effective_feerate_wtxids));
1568 }
1569 }
1570
1571 if (args.m_test_accept) return PackageMempoolAcceptResult(package_state, std::move(results));
1572
1573 if (!SubmitPackage(args, workspaces, package_state, results)) {
1574 // PackageValidationState filled in by SubmitPackage().
1575 return PackageMempoolAcceptResult(package_state, std::move(results));
1576 }
1577
1578 return PackageMempoolAcceptResult(package_state, std::move(results));
1579}
1580
1581void MemPoolAccept::CleanupTemporaryCoins()
1582{
1583 // There are 3 kinds of coins in m_view:
1584 // (1) Temporary coins from the transactions in subpackage, constructed by m_viewmempool.
1585 // (2) Mempool coins from transactions in the mempool, constructed by m_viewmempool.
1586 // (3) Confirmed coins fetched from our current UTXO set.
1587 //
1588 // (1) Temporary coins need to be removed, regardless of whether the transaction was submitted.
1589 // If the transaction was submitted to the mempool, m_viewmempool will be able to fetch them from
1590 // there. If it wasn't submitted to mempool, it is incorrect to keep them - future calls may try
1591 // to spend those coins that don't actually exist.
1592 // (2) Mempool coins also need to be removed. If the mempool contents have changed as a result
1593 // of submitting or replacing transactions, coins previously fetched from mempool may now be
1594 // spent or nonexistent. Those coins need to be deleted from m_view.
1595 // (3) Confirmed coins don't need to be removed. The chainstate has not changed (we are
1596 // holding cs_main and no blocks have been processed) so the confirmed tx cannot disappear like
1597 // a mempool tx can. The coin may now be spent after we submitted a tx to mempool, but
1598 // we have already checked that the package does not have 2 transactions spending the same coin
1599 // and we check whether a mempool transaction spends conflicting coins (CTxMemPool::GetConflictTx).
1600 // Keeping them in m_view is an optimization to not re-fetch confirmed coins if we later look up
1601 // inputs for this transaction again.
1602 for (const auto& outpoint : m_viewmempool.GetNonBaseCoins()) {
1603 // In addition to resetting m_viewmempool, we also need to manually delete these coins from
1604 // m_view because it caches copies of the coins it fetched from m_viewmempool previously.
1605 m_view.Uncache(outpoint);
1606 }
1607 // This deletes the temporary and mempool coins.
1608 m_viewmempool.Reset();
1609}
1610
1611PackageMempoolAcceptResult MemPoolAccept::AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
1612{
1614 AssertLockHeld(m_pool.cs);
1615 auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs) {
1616 if (subpackage.size() > 1) {
1617 return AcceptMultipleTransactionsInternal(subpackage, args);
1618 }
1619 const auto& tx = subpackage.front();
1620 ATMPArgs single_args = ATMPArgs::SingleInPackageAccept(args);
1621 const auto single_res = AcceptSingleTransactionInternal(tx, single_args);
1622 PackageValidationState package_state_wrapped;
1623 if (single_res.m_result_type != MempoolAcceptResult::ResultType::VALID) {
1624 package_state_wrapped.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1625 }
1626 return PackageMempoolAcceptResult(package_state_wrapped, {{tx->GetWitnessHash(), single_res}});
1627 }();
1628
1629 // Clean up m_view and m_viewmempool so that other subpackage evaluations don't have access to
1630 // coins they shouldn't. Keep some coins in order to minimize re-fetching coins from the UTXO set.
1631 // Clean up package feerate and rbf calculations
1632 ClearSubPackageState();
1633
1634 return result;
1635}
1636
1637PackageMempoolAcceptResult MemPoolAccept::AcceptPackage(const Package& package, ATMPArgs& args)
1638{
1639 Assert(!package.empty());
1641 // Used if returning a PackageMempoolAcceptResult directly from this function.
1642 PackageValidationState package_state_quit_early;
1643
1644 // There are two topologies we are able to handle through this function:
1645 // (1) A single transaction
1646 // (2) A child-with-parents package.
1647 // Check that the package is well-formed. If it isn't, we won't try to validate any of the
1648 // transactions and thus won't return any MempoolAcceptResults, just a package-wide error.
1649
1650 // Context-free package checks.
1651 if (!IsWellFormedPackage(package, package_state_quit_early, /*require_sorted=*/true)) {
1652 return PackageMempoolAcceptResult(package_state_quit_early, {});
1653 }
1654
1655 if (package.size() > 1 && !IsChildWithParents(package)) {
1656 // All transactions in the package must be a parent of the last transaction. This is just an
1657 // opportunity for us to fail fast on a context-free check without taking the mempool lock.
1658 package_state_quit_early.Invalid(PackageValidationResult::PCKG_POLICY, "package-not-child-with-parents");
1659 return PackageMempoolAcceptResult(package_state_quit_early, {});
1660 }
1661
1662 LOCK(m_pool.cs);
1663 // Stores results from which we will create the returned PackageMempoolAcceptResult.
1664 // A result may be changed if a mempool transaction is evicted later due to LimitMempoolSize().
1665 std::map<Wtxid, MempoolAcceptResult> results_final;
1666 // Results from individual validation which will be returned if no other result is available for
1667 // this transaction. "Nonfinal" because if a transaction fails by itself but succeeds later
1668 // (i.e. when evaluated with a fee-bumping child), the result in this map may be discarded.
1669 std::map<Wtxid, MempoolAcceptResult> individual_results_nonfinal;
1670 // Tracks whether we think package submission could result in successful entry to the mempool
1671 bool quit_early{false};
1672 std::vector<CTransactionRef> txns_package_eval;
1673 for (const auto& tx : package) {
1674 const auto& wtxid = tx->GetWitnessHash();
1675 const auto& txid = tx->GetHash();
1676 // There are 3 possibilities: already in mempool, same-txid-diff-wtxid already in mempool,
1677 // or not in mempool. An already confirmed tx is treated as one not in mempool, because all
1678 // we know is that the inputs aren't available.
1679 if (m_pool.exists(wtxid)) {
1680 // Exact transaction already exists in the mempool.
1681 // Node operators are free to set their mempool policies however they please, nodes may receive
1682 // transactions in different orders, and malicious counterparties may try to take advantage of
1683 // policy differences to pin or delay propagation of transactions. As such, it's possible for
1684 // some package transaction(s) to already be in the mempool, and we don't want to reject the
1685 // entire package in that case (as that could be a censorship vector). De-duplicate the
1686 // transactions that are already in the mempool, and only call AcceptMultipleTransactions() with
1687 // the new transactions. This ensures we don't double-count transaction counts and sizes when
1688 // checking ancestor/descendant limits, or double-count transaction fees for fee-related policy.
1689 const auto& entry{*Assert(m_pool.GetEntry(txid))};
1690 results_final.emplace(wtxid, MempoolAcceptResult::MempoolTx(entry.GetTxSize(), entry.GetFee()));
1691 } else if (m_pool.exists(txid)) {
1692 // Transaction with the same non-witness data but different witness (same txid,
1693 // different wtxid) already exists in the mempool.
1694 //
1695 // We don't allow replacement transactions right now, so just swap the package
1696 // transaction for the mempool one. Note that we are ignoring the validity of the
1697 // package transaction passed in.
1698 // TODO: allow witness replacement in packages.
1699 const auto& entry{*Assert(m_pool.GetEntry(txid))};
1700 // Provide the wtxid of the mempool tx so that the caller can look it up in the mempool.
1701 results_final.emplace(wtxid, MempoolAcceptResult::MempoolTxDifferentWitness(entry.GetTx().GetWitnessHash()));
1702 } else {
1703 // Transaction does not already exist in the mempool.
1704 // Try submitting the transaction on its own.
1705 const auto single_package_res = AcceptSubPackage({tx}, args);
1706 const auto& single_res = single_package_res.m_tx_results.at(wtxid);
1707 if (single_res.m_result_type == MempoolAcceptResult::ResultType::VALID) {
1708 // The transaction succeeded on its own and is now in the mempool. Don't include it
1709 // in package validation, because its fees should only be "used" once.
1710 assert(m_pool.exists(wtxid));
1711 results_final.emplace(wtxid, single_res);
1712 } else if (package.size() == 1 || // If there is only one transaction, no need to retry it "as a package"
1713 (single_res.m_state.GetResult() != TxValidationResult::TX_RECONSIDERABLE &&
1714 single_res.m_state.GetResult() != TxValidationResult::TX_MISSING_INPUTS)) {
1715 // Package validation policy only differs from individual policy in its evaluation
1716 // of feerate. For example, if a transaction fails here due to violation of a
1717 // consensus rule, the result will not change when it is submitted as part of a
1718 // package. To minimize the amount of repeated work, unless the transaction fails
1719 // due to feerate or missing inputs (its parent is a previous transaction in the
1720 // package that failed due to feerate), don't run package validation. Note that this
1721 // decision might not make sense if different types of packages are allowed in the
1722 // future. Continue individually validating the rest of the transactions, because
1723 // some of them may still be valid.
1724 quit_early = true;
1725 package_state_quit_early.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1726 individual_results_nonfinal.emplace(wtxid, single_res);
1727 } else {
1728 individual_results_nonfinal.emplace(wtxid, single_res);
1729 txns_package_eval.push_back(tx);
1730 }
1731 }
1732 }
1733
1734 auto multi_submission_result = quit_early || txns_package_eval.empty() ? PackageMempoolAcceptResult(package_state_quit_early, {}) :
1735 AcceptSubPackage(txns_package_eval, args);
1736 PackageValidationState& package_state_final = multi_submission_result.m_state;
1737
1738 // This is invoked by AcceptSubPackage() already, so this is just here for
1739 // clarity (since it's not permitted to invoke LimitMempoolSize() while a
1740 // changeset is outstanding).
1741 ClearSubPackageState();
1742
1743 // Make sure we haven't exceeded max mempool size.
1744 // Package transactions that were submitted to mempool or already in mempool may be evicted.
1745 // If mempool contents change, then the m_view cache is dirty. It has already been cleared above.
1746 LimitMempoolSize(m_pool, m_active_chainstate.CoinsTip());
1747
1748 for (const auto& tx : package) {
1749 const auto& wtxid = tx->GetWitnessHash();
1750 if (multi_submission_result.m_tx_results.count(wtxid) > 0) {
1751 // We shouldn't have re-submitted if the tx result was already in results_final.
1752 Assume(results_final.count(wtxid) == 0);
1753 // If it was submitted, check to see if the tx is still in the mempool. It could have
1754 // been evicted due to LimitMempoolSize() above.
1755 const auto& txresult = multi_submission_result.m_tx_results.at(wtxid);
1756 if (txresult.m_result_type == MempoolAcceptResult::ResultType::VALID && !m_pool.exists(wtxid)) {
1757 package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1758 TxValidationState mempool_full_state;
1759 mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
1760 results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
1761 } else {
1762 results_final.emplace(wtxid, txresult);
1763 }
1764 } else if (const auto it{results_final.find(wtxid)}; it != results_final.end()) {
1765 // Already-in-mempool transaction. Check to see if it's still there, as it could have
1766 // been evicted when LimitMempoolSize() was called.
1767 Assume(it->second.m_result_type != MempoolAcceptResult::ResultType::INVALID);
1768 Assume(individual_results_nonfinal.count(wtxid) == 0);
1769 // Query by txid to include the same-txid-different-witness ones.
1770 if (!m_pool.exists(tx->GetHash())) {
1771 package_state_final.Invalid(PackageValidationResult::PCKG_TX, "transaction failed");
1772 TxValidationState mempool_full_state;
1773 mempool_full_state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "mempool full");
1774 // Replace the previous result.
1775 results_final.erase(wtxid);
1776 results_final.emplace(wtxid, MempoolAcceptResult::Failure(mempool_full_state));
1777 }
1778 } else if (const auto it{individual_results_nonfinal.find(wtxid)}; it != individual_results_nonfinal.end()) {
1779 Assume(it->second.m_result_type == MempoolAcceptResult::ResultType::INVALID);
1780 // Interesting result from previous processing.
1781 results_final.emplace(wtxid, it->second);
1782 }
1783 }
1784 Assume(results_final.size() == package.size());
1785 return PackageMempoolAcceptResult(package_state_final, std::move(results_final));
1786}
1787
1788} // anon namespace
1789
1791 int64_t accept_time, bool bypass_limits, bool test_accept)
1792{
1794 const CChainParams& chainparams{active_chainstate.m_chainman.GetParams()};
1795 assert(active_chainstate.GetMempool() != nullptr);
1796 CTxMemPool& pool{*active_chainstate.GetMempool()};
1797
1798 std::vector<COutPoint> coins_to_uncache;
1799
1800 auto args = MemPoolAccept::ATMPArgs::SingleAccept(chainparams, accept_time, bypass_limits, coins_to_uncache, test_accept);
1801 MempoolAcceptResult result = MemPoolAccept(pool, active_chainstate).AcceptSingleTransactionAndCleanup(tx, args);
1802
1804 // Remove coins that were not present in the coins cache before calling
1805 // AcceptSingleTransaction(); this is to prevent memory DoS in case we receive a large
1806 // number of invalid transactions that attempt to overrun the in-memory coins cache
1807 // (`CCoinsViewCache::cacheCoins`).
1808
1809 for (const COutPoint& hashTx : coins_to_uncache)
1810 active_chainstate.CoinsTip().Uncache(hashTx);
1811 TRACEPOINT(mempool, rejected,
1812 tx->GetHash().data(),
1813 result.m_state.GetRejectReason().c_str()
1814 );
1815 }
1816 // After we've (potentially) uncached entries, ensure our coins cache is still within its size limits
1817 BlockValidationState state_dummy;
1818 active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1819 return result;
1820}
1821
1823 const Package& package, bool test_accept, const std::optional<CFeeRate>& client_maxfeerate)
1824{
1826 assert(!package.empty());
1827 assert(std::all_of(package.cbegin(), package.cend(), [](const auto& tx){return tx != nullptr;}));
1828
1829 std::vector<COutPoint> coins_to_uncache;
1830 const CChainParams& chainparams = active_chainstate.m_chainman.GetParams();
1831 auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
1833 if (test_accept) {
1834 auto args = MemPoolAccept::ATMPArgs::PackageTestAccept(chainparams, GetTime(), coins_to_uncache);
1835 return MemPoolAccept(pool, active_chainstate).AcceptMultipleTransactionsAndCleanup(package, args);
1836 } else {
1837 auto args = MemPoolAccept::ATMPArgs::PackageChildWithParents(chainparams, GetTime(), coins_to_uncache, client_maxfeerate);
1838 return MemPoolAccept(pool, active_chainstate).AcceptPackage(package, args);
1839 }
1840 }();
1841
1842 // Uncache coins pertaining to transactions that were not submitted to the mempool.
1843 if (test_accept || result.m_state.IsInvalid()) {
1844 for (const COutPoint& hashTx : coins_to_uncache) {
1845 active_chainstate.CoinsTip().Uncache(hashTx);
1846 }
1847 }
1848 // Ensure the coins cache is still within limits.
1849 BlockValidationState state_dummy;
1850 active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1851 return result;
1852}
1853
1855{
1856 int halvings = nHeight / consensusParams.nSubsidyHalvingInterval;
1857 // Force block reward to zero when right shift is undefined.
1858 if (halvings >= 64)
1859 return 0;
1860
1861 CAmount nSubsidy = 50 * COIN;
1862 // Subsidy is cut in half every 210,000 blocks which will occur approximately every 4 years.
1863 nSubsidy >>= halvings;
1864 return nSubsidy;
1865}
1866
1868 : m_dbview{std::move(db_params), std::move(options)},
1869 m_catcherview(&m_dbview) {}
1870
1871void CoinsViews::InitCache()
1872{
1874 m_cacheview = std::make_unique<CCoinsViewCache>(&m_catcherview);
1875}
1876
1878 CTxMemPool* mempool,
1879 BlockManager& blockman,
1880 ChainstateManager& chainman,
1881 std::optional<uint256> from_snapshot_blockhash)
1882 : m_mempool(mempool),
1883 m_blockman(blockman),
1884 m_chainman(chainman),
1885 m_from_snapshot_blockhash(from_snapshot_blockhash) {}
1886
1887const CBlockIndex* Chainstate::SnapshotBase() const
1888{
1889 if (!m_from_snapshot_blockhash) return nullptr;
1890 if (!m_cached_snapshot_base) m_cached_snapshot_base = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_from_snapshot_blockhash));
1891 return m_cached_snapshot_base;
1892}
1893
1895 size_t cache_size_bytes,
1896 bool in_memory,
1897 bool should_wipe,
1898 fs::path leveldb_name)
1899{
1901 leveldb_name += node::SNAPSHOT_CHAINSTATE_SUFFIX;
1902 }
1903
1904 m_coins_views = std::make_unique<CoinsViews>(
1905 DBParams{
1906 .path = m_chainman.m_options.datadir / leveldb_name,
1907 .cache_bytes = cache_size_bytes,
1908 .memory_only = in_memory,
1909 .wipe_data = should_wipe,
1910 .obfuscate = true,
1911 .options = m_chainman.m_options.coins_db},
1913
1914 m_coinsdb_cache_size_bytes = cache_size_bytes;
1915}
1916
1917void Chainstate::InitCoinsCache(size_t cache_size_bytes)
1918{
1920 assert(m_coins_views != nullptr);
1921 m_coinstip_cache_size_bytes = cache_size_bytes;
1922 m_coins_views->InitCache();
1923}
1924
1925// Note that though this is marked const, we may end up modifying `m_cached_finished_ibd`, which
1926// is a performance-related implementation detail. This function must be marked
1927// `const` so that `CValidationInterface` clients (which are given a `const Chainstate*`)
1928// can call it.
1929//
1931{
1932 // Optimization: pre-test latch before taking the lock.
1933 if (m_cached_finished_ibd.load(std::memory_order_relaxed))
1934 return false;
1935
1936 LOCK(cs_main);
1937 if (m_cached_finished_ibd.load(std::memory_order_relaxed))
1938 return false;
1939 if (m_blockman.LoadingBlocks()) {
1940 return true;
1941 }
1942 CChain& chain{ActiveChain()};
1943 if (chain.Tip() == nullptr) {
1944 return true;
1945 }
1946 if (chain.Tip()->nChainWork < MinimumChainWork()) {
1947 return true;
1948 }
1949 if (chain.Tip()->Time() < Now<NodeSeconds>() - m_options.max_tip_age) {
1950 return true;
1951 }
1952 LogInfo("Leaving InitialBlockDownload (latching to false)");
1953 m_cached_finished_ibd.store(true, std::memory_order_relaxed);
1954 return false;
1955}
1956
1958{
1960
1961 if (this->GetRole() == ChainstateRole::BACKGROUND) {
1962 return;
1963 }
1964
1965 if (m_chainman.m_best_invalid && m_chainman.m_best_invalid->nChainWork > m_chain.Tip()->nChainWork + (GetBlockProof(*m_chain.Tip()) * 6)) {
1966 LogWarning("Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers.");
1969 _("Warning: Found invalid chain more than 6 blocks longer than our best chain. This could be due to database corruption or consensus incompatibility with peers."));
1970 } else {
1972 }
1973}
1974
1975// Called both upon regular invalid block discovery *and* InvalidateBlock
1977{
1979 if (!m_chainman.m_best_invalid || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork) {
1980 m_chainman.m_best_invalid = pindexNew;
1981 }
1982 SetBlockFailureFlags(pindexNew);
1983 if (m_chainman.m_best_header != nullptr && m_chainman.m_best_header->GetAncestor(pindexNew->nHeight) == pindexNew) {
1984 m_chainman.RecalculateBestHeader();
1985 }
1986
1987 LogInfo("%s: invalid block=%s height=%d log2_work=%f date=%s\n", __func__,
1988 pindexNew->GetBlockHash().ToString(), pindexNew->nHeight,
1989 log(pindexNew->nChainWork.getdouble())/log(2.0), FormatISO8601DateTime(pindexNew->GetBlockTime()));
1990 CBlockIndex *tip = m_chain.Tip();
1991 assert (tip);
1992 LogInfo("%s: current best=%s height=%d log2_work=%f date=%s\n", __func__,
1993 tip->GetBlockHash().ToString(), m_chain.Height(), log(tip->nChainWork.getdouble())/log(2.0),
1996}
1997
1998// Same as InvalidChainFound, above, except not called directly from InvalidateBlock,
1999// which does its own setBlockIndexCandidates management.
2001{
2004 pindex->nStatus |= BLOCK_FAILED_VALID;
2005 m_blockman.m_dirty_blockindex.insert(pindex);
2006 setBlockIndexCandidates.erase(pindex);
2007 InvalidChainFound(pindex);
2008 }
2009}
2010
2011void UpdateCoins(const CTransaction& tx, CCoinsViewCache& inputs, CTxUndo &txundo, int nHeight)
2012{
2013 // mark inputs spent
2014 if (!tx.IsCoinBase()) {
2015 txundo.vprevout.reserve(tx.vin.size());
2016 for (const CTxIn &txin : tx.vin) {
2017 txundo.vprevout.emplace_back();
2018 bool is_spent = inputs.SpendCoin(txin.prevout, &txundo.vprevout.back());
2019 assert(is_spent);
2020 }
2021 }
2022 // add outputs
2023 AddCoins(inputs, tx, nHeight);
2024}
2025
2026std::optional<std::pair<ScriptError, std::string>> CScriptCheck::operator()() {
2027 const CScript &scriptSig = ptxTo->vin[nIn].scriptSig;
2028 const CScriptWitness *witness = &ptxTo->vin[nIn].scriptWitness;
2031 return std::nullopt;
2032 } else {
2033 auto debug_str = strprintf("input %i of %s (wtxid %s), spending %s:%i", nIn, ptxTo->GetHash().ToString(), ptxTo->GetWitnessHash().ToString(), ptxTo->vin[nIn].prevout.hash.ToString(), ptxTo->vin[nIn].prevout.n);
2034 return std::make_pair(error, std::move(debug_str));
2035 }
2036}
2037
2038ValidationCache::ValidationCache(const size_t script_execution_cache_bytes, const size_t signature_cache_bytes)
2039 : m_signature_cache{signature_cache_bytes}
2040{
2041 // Setup the salted hasher
2043 // We want the nonce to be 64 bytes long to force the hasher to process
2044 // this chunk, which makes later hash computations more efficient. We
2045 // just write our 32-byte entropy twice to fill the 64 bytes.
2048
2049 const auto [num_elems, approx_size_bytes] = m_script_execution_cache.setup_bytes(script_execution_cache_bytes);
2050 LogInfo("Using %zu MiB out of %zu MiB requested for script execution cache, able to store %zu elements",
2051 approx_size_bytes >> 20, script_execution_cache_bytes >> 20, num_elems);
2052}
2053
2074 const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
2075 bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
2076 ValidationCache& validation_cache,
2077 std::vector<CScriptCheck>* pvChecks)
2078{
2079 if (tx.IsCoinBase()) return true;
2080
2081 if (pvChecks) {
2082 pvChecks->reserve(tx.vin.size());
2083 }
2084
2085 // First check if script executions have been cached with the same
2086 // flags. Note that this assumes that the inputs provided are
2087 // correct (ie that the transaction hash which is in tx's prevouts
2088 // properly commits to the scriptPubKey in the inputs view of that
2089 // transaction).
2090 uint256 hashCacheEntry;
2091 CSHA256 hasher = validation_cache.ScriptExecutionCacheHasher();
2092 hasher.Write(UCharCast(tx.GetWitnessHash().begin()), 32).Write((unsigned char*)&flags, sizeof(flags)).Finalize(hashCacheEntry.begin());
2093 AssertLockHeld(cs_main); //TODO: Remove this requirement by making CuckooCache not require external locks
2094 if (validation_cache.m_script_execution_cache.contains(hashCacheEntry, !cacheFullScriptStore)) {
2095 return true;
2096 }
2097
2098 if (!txdata.m_spent_outputs_ready) {
2099 std::vector<CTxOut> spent_outputs;
2100 spent_outputs.reserve(tx.vin.size());
2101
2102 for (const auto& txin : tx.vin) {
2103 const COutPoint& prevout = txin.prevout;
2104 const Coin& coin = inputs.AccessCoin(prevout);
2105 assert(!coin.IsSpent());
2106 spent_outputs.emplace_back(coin.out);
2107 }
2108 txdata.Init(tx, std::move(spent_outputs));
2109 }
2110 assert(txdata.m_spent_outputs.size() == tx.vin.size());
2111
2112 for (unsigned int i = 0; i < tx.vin.size(); i++) {
2113
2114 // We very carefully only pass in things to CScriptCheck which
2115 // are clearly committed to by tx' witness hash. This provides
2116 // a sanity check that our caching is not introducing consensus
2117 // failures through additional data in, eg, the coins being
2118 // spent being checked as a part of CScriptCheck.
2119
2120 // Verify signature
2121 CScriptCheck check(txdata.m_spent_outputs[i], tx, validation_cache.m_signature_cache, i, flags, cacheSigStore, &txdata);
2122 if (pvChecks) {
2123 pvChecks->emplace_back(std::move(check));
2124 } else if (auto result = check(); result.has_value()) {
2125 // Tx failures never trigger disconnections/bans.
2126 // This is so that network splits aren't triggered
2127 // either due to non-consensus relay policies (such as
2128 // non-standard DER encodings or non-null dummy
2129 // arguments) or due to new consensus rules introduced in
2130 // soft forks.
2132 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, strprintf("mempool-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
2133 } else {
2134 return state.Invalid(TxValidationResult::TX_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
2135 }
2136 }
2137 }
2138
2139 if (cacheFullScriptStore && !pvChecks) {
2140 // We executed all of the provided scripts, and were told to
2141 // cache the result. Do so now.
2142 validation_cache.m_script_execution_cache.insert(hashCacheEntry);
2143 }
2144
2145 return true;
2146}
2147
2148bool FatalError(Notifications& notifications, BlockValidationState& state, const bilingual_str& message)
2149{
2150 notifications.fatalError(message);
2151 return state.Error(message.original);
2152}
2153
2162{
2163 bool fClean = true;
2164
2165 if (view.HaveCoin(out)) fClean = false; // overwriting transaction output
2166
2167 if (undo.nHeight == 0) {
2168 // Missing undo metadata (height and coinbase). Older versions included this
2169 // information only in undo records for the last spend of a transactions'
2170 // outputs. This implies that it must be present for some other output of the same tx.
2171 const Coin& alternate = AccessByTxid(view, out.hash);
2172 if (!alternate.IsSpent()) {
2173 undo.nHeight = alternate.nHeight;
2174 undo.fCoinBase = alternate.fCoinBase;
2175 } else {
2176 return DISCONNECT_FAILED; // adding output for transaction without known metadata
2177 }
2178 }
2179 // If the coin already exists as an unspent coin in the cache, then the
2180 // possible_overwrite parameter to AddCoin must be set to true. We have
2181 // already checked whether an unspent coin exists above using HaveCoin, so
2182 // we don't need to guess. When fClean is false, an unspent coin already
2183 // existed and it is an overwrite.
2184 view.AddCoin(out, std::move(undo), !fClean);
2185
2186 return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2187}
2188
2191DisconnectResult Chainstate::DisconnectBlock(const CBlock& block, const CBlockIndex* pindex, CCoinsViewCache& view)
2192{
2194 bool fClean = true;
2195
2196 CBlockUndo blockUndo;
2197 if (!m_blockman.ReadBlockUndo(blockUndo, *pindex)) {
2198 LogError("DisconnectBlock(): failure reading undo data\n");
2199 return DISCONNECT_FAILED;
2200 }
2201
2202 if (blockUndo.vtxundo.size() + 1 != block.vtx.size()) {
2203 LogError("DisconnectBlock(): block and undo data inconsistent\n");
2204 return DISCONNECT_FAILED;
2205 }
2206
2207 // Ignore blocks that contain transactions which are 'overwritten' by later transactions,
2208 // unless those are already completely spent.
2209 // See https://github.com/bitcoin/bitcoin/issues/22596 for additional information.
2210 // Note: the blocks specified here are different than the ones used in ConnectBlock because DisconnectBlock
2211 // unwinds the blocks in reverse. As a result, the inconsistency is not discovered until the earlier
2212 // blocks with the duplicate coinbase transactions are disconnected.
2213 bool fEnforceBIP30 = !((pindex->nHeight==91722 && pindex->GetBlockHash() == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
2214 (pindex->nHeight==91812 && pindex->GetBlockHash() == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"}));
2215
2216 // undo transactions in reverse order
2217 for (int i = block.vtx.size() - 1; i >= 0; i--) {
2218 const CTransaction &tx = *(block.vtx[i]);
2219 Txid hash = tx.GetHash();
2220 bool is_coinbase = tx.IsCoinBase();
2221 bool is_bip30_exception = (is_coinbase && !fEnforceBIP30);
2222
2223 // Check that all outputs are available and match the outputs in the block itself
2224 // exactly.
2225 for (size_t o = 0; o < tx.vout.size(); o++) {
2226 if (!tx.vout[o].scriptPubKey.IsUnspendable()) {
2227 COutPoint out(hash, o);
2228 Coin coin;
2229 bool is_spent = view.SpendCoin(out, &coin);
2230 if (!is_spent || tx.vout[o] != coin.out || pindex->nHeight != coin.nHeight || is_coinbase != coin.fCoinBase) {
2231 if (!is_bip30_exception) {
2232 fClean = false; // transaction output mismatch
2233 }
2234 }
2235 }
2236 }
2237
2238 // restore inputs
2239 if (i > 0) { // not coinbases
2240 CTxUndo &txundo = blockUndo.vtxundo[i-1];
2241 if (txundo.vprevout.size() != tx.vin.size()) {
2242 LogError("DisconnectBlock(): transaction and undo data inconsistent\n");
2243 return DISCONNECT_FAILED;
2244 }
2245 for (unsigned int j = tx.vin.size(); j > 0;) {
2246 --j;
2247 const COutPoint& out = tx.vin[j].prevout;
2248 int res = ApplyTxInUndo(std::move(txundo.vprevout[j]), view, out);
2249 if (res == DISCONNECT_FAILED) return DISCONNECT_FAILED;
2250 fClean = fClean && res != DISCONNECT_UNCLEAN;
2251 }
2252 // At this point, all of txundo.vprevout should have been moved out.
2253 }
2254 }
2255
2256 // move best block pointer to prevout block
2257 view.SetBestBlock(pindex->pprev->GetBlockHash());
2258
2259 return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2260}
2261
2263{
2264 const Consensus::Params& consensusparams = chainman.GetConsensus();
2265
2266 // BIP16 didn't become active until Apr 1 2012 (on mainnet, and
2267 // retroactively applied to testnet)
2268 // However, only one historical block violated the P2SH rules (on both
2269 // mainnet and testnet).
2270 // Similarly, only one historical block violated the TAPROOT rules on
2271 // mainnet.
2272 // For simplicity, always leave P2SH+WITNESS+TAPROOT on except for the two
2273 // violating blocks.
2275 const auto it{consensusparams.script_flag_exceptions.find(*Assert(block_index.phashBlock))};
2276 if (it != consensusparams.script_flag_exceptions.end()) {
2277 flags = it->second;
2278 }
2279
2280 // Enforce the DERSIG (BIP66) rule
2281 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_DERSIG)) {
2283 }
2284
2285 // Enforce CHECKLOCKTIMEVERIFY (BIP65)
2286 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CLTV)) {
2288 }
2289
2290 // Enforce CHECKSEQUENCEVERIFY (BIP112)
2291 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CSV)) {
2293 }
2294
2295 // Enforce BIP147 NULLDUMMY (activated simultaneously with segwit)
2296 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_SEGWIT)) {
2298 }
2299
2300 return flags;
2301}
2302
2303
2307bool Chainstate::ConnectBlock(const CBlock& block, BlockValidationState& state, CBlockIndex* pindex,
2308 CCoinsViewCache& view, bool fJustCheck)
2309{
2311 assert(pindex);
2312
2313 uint256 block_hash{block.GetHash()};
2314 assert(*pindex->phashBlock == block_hash);
2315
2316 const auto time_start{SteadyClock::now()};
2317 const CChainParams& params{m_chainman.GetParams()};
2318
2319 // Check it again in case a previous version let a bad block in
2320 // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2321 // ContextualCheckBlockHeader() here. This means that if we add a new
2322 // consensus rule that is enforced in one of those two functions, then we
2323 // may have let in a block that violates the rule prior to updating the
2324 // software, and we would NOT be enforcing the rule here. Fully solving
2325 // upgrade from one software version to the next after a consensus rule
2326 // change is potentially tricky and issue-specific (see NeedsRedownload()
2327 // for one approach that was used for BIP 141 deployment).
2328 // Also, currently the rule against blocks more than 2 hours in the future
2329 // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2330 // re-enforce that rule here (at least until we make it impossible for
2331 // the clock to go backward).
2332 if (!CheckBlock(block, state, params.GetConsensus(), !fJustCheck, !fJustCheck)) {
2334 // We don't write down blocks to disk if they may have been
2335 // corrupted, so this should be impossible unless we're having hardware
2336 // problems.
2337 return FatalError(m_chainman.GetNotifications(), state, _("Corrupt block found indicating potential hardware failure."));
2338 }
2339 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
2340 return false;
2341 }
2342
2343 // verify that the view's current state corresponds to the previous block
2344 uint256 hashPrevBlock = pindex->pprev == nullptr ? uint256() : pindex->pprev->GetBlockHash();
2345 assert(hashPrevBlock == view.GetBestBlock());
2346
2347 m_chainman.num_blocks_total++;
2348
2349 // Special case for the genesis block, skipping connection of its transactions
2350 // (its coinbase is unspendable)
2351 if (block_hash == params.GetConsensus().hashGenesisBlock) {
2352 if (!fJustCheck)
2353 view.SetBestBlock(pindex->GetBlockHash());
2354 return true;
2355 }
2356
2357 const char* script_check_reason;
2359 script_check_reason = "assumevalid=0 (always verify)";
2360 } else {
2361 constexpr int64_t TWO_WEEKS_IN_SECONDS{60 * 60 * 24 * 7 * 2};
2362 // We've been configured with the hash of a block which has been externally verified to have a valid history.
2363 // A suitable default value is included with the software and updated from time to time. Because validity
2364 // relative to a piece of software is an objective fact these defaults can be easily reviewed.
2365 // This setting doesn't force the selection of any particular chain but makes validating some faster by
2366 // effectively caching the result of part of the verification.
2367 BlockMap::const_iterator it{m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2368 if (it == m_blockman.m_block_index.end()) {
2369 script_check_reason = "assumevalid hash not in headers";
2370 } else if (it->second.GetAncestor(pindex->nHeight) != pindex) {
2371 script_check_reason = (pindex->nHeight > it->second.nHeight) ? "block height above assumevalid height" : "block not in assumevalid chain";
2372 } else if (m_chainman.m_best_header->GetAncestor(pindex->nHeight) != pindex) {
2373 script_check_reason = "block not in best header chain";
2374 } else if (m_chainman.m_best_header->nChainWork < m_chainman.MinimumChainWork()) {
2375 script_check_reason = "best header chainwork below minimumchainwork";
2376 } else if (GetBlockProofEquivalentTime(*m_chainman.m_best_header, *pindex, *m_chainman.m_best_header, params.GetConsensus()) <= TWO_WEEKS_IN_SECONDS) {
2377 script_check_reason = "block too recent relative to best header";
2378 } else {
2379 // This block is a member of the assumed verified chain and an ancestor of the best header.
2380 // Script verification is skipped when connecting blocks under the
2381 // assumevalid block. Assuming the assumevalid block is valid this
2382 // is safe because block merkle hashes are still computed and checked,
2383 // Of course, if an assumed valid block is invalid due to false scriptSigs
2384 // this optimization would allow an invalid chain to be accepted.
2385 // The equivalent time check discourages hash power from extorting the network via DOS attack
2386 // into accepting an invalid block through telling users they must manually set assumevalid.
2387 // Requiring a software change or burying the invalid block, regardless of the setting, makes
2388 // it hard to hide the implication of the demand. This also avoids having release candidates
2389 // that are hardly doing any signature verification at all in testing without having to
2390 // artificially set the default assumed verified block further back.
2391 // The test against the minimum chain work prevents the skipping when denied access to any chain at
2392 // least as good as the expected chain.
2393 script_check_reason = nullptr;
2394 }
2395 }
2396
2397 const auto time_1{SteadyClock::now()};
2398 m_chainman.time_check += time_1 - time_start;
2399 LogDebug(BCLog::BENCH, " - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2400 Ticks<MillisecondsDouble>(time_1 - time_start),
2401 Ticks<SecondsDouble>(m_chainman.time_check),
2402 Ticks<MillisecondsDouble>(m_chainman.time_check) / m_chainman.num_blocks_total);
2403
2404 // Do not allow blocks that contain transactions which 'overwrite' older transactions,
2405 // unless those are already completely spent.
2406 // If such overwrites are allowed, coinbases and transactions depending upon those
2407 // can be duplicated to remove the ability to spend the first instance -- even after
2408 // being sent to another address.
2409 // See BIP30, CVE-2012-1909, and https://r6.ca/blog/20120206T005236Z.html for more information.
2410 // This rule was originally applied to all blocks with a timestamp after March 15, 2012, 0:00 UTC.
2411 // Now that the whole chain is irreversibly beyond that time it is applied to all blocks except the
2412 // two in the chain that violate it. This prevents exploiting the issue against nodes during their
2413 // initial block download.
2414 bool fEnforceBIP30 = !IsBIP30Repeat(*pindex);
2415
2416 // Once BIP34 activated it was not possible to create new duplicate coinbases and thus other than starting
2417 // with the 2 existing duplicate coinbase pairs, not possible to create overwriting txs. But by the
2418 // time BIP34 activated, in each of the existing pairs the duplicate coinbase had overwritten the first
2419 // before the first had been spent. Since those coinbases are sufficiently buried it's no longer possible to create further
2420 // duplicate transactions descending from the known pairs either.
2421 // If we're on the known chain at height greater than where BIP34 activated, we can save the db accesses needed for the BIP30 check.
2422
2423 // BIP34 requires that a block at height X (block X) has its coinbase
2424 // scriptSig start with a CScriptNum of X (indicated height X). The above
2425 // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2426 // case that there is a block X before the BIP34 height of 227,931 which has
2427 // an indicated height Y where Y is greater than X. The coinbase for block
2428 // X would also be a valid coinbase for block Y, which could be a BIP30
2429 // violation. An exhaustive search of all mainnet coinbases before the
2430 // BIP34 height which have an indicated height greater than the block height
2431 // reveals many occurrences. The 3 lowest indicated heights found are
2432 // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2433 // heights would be the first opportunity for BIP30 to be violated.
2434
2435 // The search reveals a great many blocks which have an indicated height
2436 // greater than 1,983,702, so we simply remove the optimization to skip
2437 // BIP30 checking for blocks at height 1,983,702 or higher. Before we reach
2438 // that block in another 25 years or so, we should take advantage of a
2439 // future consensus change to do a new and improved version of BIP34 that
2440 // will actually prevent ever creating any duplicate coinbases in the
2441 // future.
2442 static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2443
2444 // There is no potential to create a duplicate coinbase at block 209,921
2445 // because this is still before the BIP34 height and so explicit BIP30
2446 // checking is still active.
2447
2448 // The final case is block 176,684 which has an indicated height of
2449 // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2450 // before block 490,897 so there was not much opportunity to address this
2451 // case other than to carefully analyze it and determine it would not be a
2452 // problem. Block 490,897 was, in fact, mined with a different coinbase than
2453 // block 176,684, but it is important to note that even if it hadn't been or
2454 // is remined on an alternate fork with a duplicate coinbase, we would still
2455 // not run into a BIP30 violation. This is because the coinbase for 176,684
2456 // is spent in block 185,956 in transaction
2457 // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781. This
2458 // spending transaction can't be duplicated because it also spends coinbase
2459 // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29. This
2460 // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2461 // duplicatable until that height, and it's currently impossible to create a
2462 // chain that long. Nevertheless we may wish to consider a future soft fork
2463 // which retroactively prevents block 490,897 from creating a duplicate
2464 // coinbase. The two historical BIP30 violations often provide a confusing
2465 // edge case when manipulating the UTXO and it would be simpler not to have
2466 // another edge case to deal with.
2467
2468 // testnet3 has no blocks before the BIP34 height with indicated heights
2469 // post BIP34 before approximately height 486,000,000. After block
2470 // 1,983,702 testnet3 starts doing unnecessary BIP30 checking again.
2471 assert(pindex->pprev);
2472 CBlockIndex* pindexBIP34height = pindex->pprev->GetAncestor(params.GetConsensus().BIP34Height);
2473 //Only continue to enforce if we're below BIP34 activation height or the block hash at that height doesn't correspond.
2474 fEnforceBIP30 = fEnforceBIP30 && (!pindexBIP34height || !(pindexBIP34height->GetBlockHash() == params.GetConsensus().BIP34Hash));
2475
2476 // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have a
2477 // consensus change that ensures coinbases at those heights cannot
2478 // duplicate earlier coinbases.
2479 if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2480 for (const auto& tx : block.vtx) {
2481 for (size_t o = 0; o < tx->vout.size(); o++) {
2482 if (view.HaveCoin(COutPoint(tx->GetHash(), o))) {
2483 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-BIP30",
2484 "tried to overwrite transaction");
2485 }
2486 }
2487 }
2488 }
2489
2490 // Enforce BIP68 (sequence locks)
2491 int nLockTimeFlags = 0;
2493 nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2494 }
2495
2496 // Get the script flags for this block
2498
2499 const auto time_2{SteadyClock::now()};
2500 m_chainman.time_forks += time_2 - time_1;
2501 LogDebug(BCLog::BENCH, " - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2502 Ticks<MillisecondsDouble>(time_2 - time_1),
2503 Ticks<SecondsDouble>(m_chainman.time_forks),
2504 Ticks<MillisecondsDouble>(m_chainman.time_forks) / m_chainman.num_blocks_total);
2505
2506 const bool fScriptChecks{!!script_check_reason};
2507 if (script_check_reason != m_last_script_check_reason_logged && GetRole() == ChainstateRole::NORMAL) {
2508 if (fScriptChecks) {
2509 LogInfo("Enabling script verification at block #%d (%s): %s.",
2510 pindex->nHeight, block_hash.ToString(), script_check_reason);
2511 } else {
2512 LogInfo("Disabling script verification at block #%d (%s).",
2513 pindex->nHeight, block_hash.ToString());
2514 }
2515 m_last_script_check_reason_logged = script_check_reason;
2516 }
2517
2518 CBlockUndo blockundo;
2519
2520 // Precomputed transaction data pointers must not be invalidated
2521 // until after `control` has run the script checks (potentially
2522 // in multiple threads). Preallocate the vector size so a new allocation
2523 // doesn't invalidate pointers into the vector, and keep txsdata in scope
2524 // for as long as `control`.
2525 std::optional<CCheckQueueControl<CScriptCheck>> control;
2526 if (auto& queue = m_chainman.GetCheckQueue(); queue.HasThreads() && fScriptChecks) control.emplace(queue);
2527
2528 std::vector<PrecomputedTransactionData> txsdata(block.vtx.size());
2529
2530 std::vector<int> prevheights;
2531 CAmount nFees = 0;
2532 int nInputs = 0;
2533 int64_t nSigOpsCost = 0;
2534 blockundo.vtxundo.reserve(block.vtx.size() - 1);
2535 for (unsigned int i = 0; i < block.vtx.size(); i++)
2536 {
2537 if (!state.IsValid()) break;
2538 const CTransaction &tx = *(block.vtx[i]);
2539
2540 nInputs += tx.vin.size();
2541
2542 if (!tx.IsCoinBase())
2543 {
2544 CAmount txfee = 0;
2545 TxValidationState tx_state;
2546 if (!Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight, txfee)) {
2547 // Any transaction validation failure in ConnectBlock is a block consensus failure
2549 tx_state.GetRejectReason(),
2550 tx_state.GetDebugMessage() + " in transaction " + tx.GetHash().ToString());
2551 break;
2552 }
2553 nFees += txfee;
2554 if (!MoneyRange(nFees)) {
2555 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-accumulated-fee-outofrange",
2556 "accumulated fee in the block out of range");
2557 break;
2558 }
2559
2560 // Check that transaction is BIP68 final
2561 // BIP68 lock checks (as opposed to nLockTime checks) must
2562 // be in ConnectBlock because they require the UTXO set
2563 prevheights.resize(tx.vin.size());
2564 for (size_t j = 0; j < tx.vin.size(); j++) {
2565 prevheights[j] = view.AccessCoin(tx.vin[j].prevout).nHeight;
2566 }
2567
2568 if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2569 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal",
2570 "contains a non-BIP68-final transaction " + tx.GetHash().ToString());
2571 break;
2572 }
2573 }
2574
2575 // GetTransactionSigOpCost counts 3 types of sigops:
2576 // * legacy (always)
2577 // * p2sh (when P2SH enabled in flags and excludes coinbase)
2578 // * witness (when witness enabled in flags and excludes coinbase)
2579 nSigOpsCost += GetTransactionSigOpCost(tx, view, flags);
2580 if (nSigOpsCost > MAX_BLOCK_SIGOPS_COST) {
2581 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "too many sigops");
2582 break;
2583 }
2584
2585 if (!tx.IsCoinBase() && fScriptChecks)
2586 {
2587 bool fCacheResults = fJustCheck; /* Don't cache results if we're actually connecting blocks (still consult the cache, though) */
2588 bool tx_ok;
2589 TxValidationState tx_state;
2590 // If CheckInputScripts is called with a pointer to a checks vector, the resulting checks are appended to it. In that case
2591 // they need to be added to control which runs them asynchronously. Otherwise, CheckInputScripts runs the checks before returning.
2592 if (control) {
2593 std::vector<CScriptCheck> vChecks;
2594 tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache, &vChecks);
2595 if (tx_ok) control->Add(std::move(vChecks));
2596 } else {
2597 tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache);
2598 }
2599 if (!tx_ok) {
2600 // Any transaction validation failure in ConnectBlock is a block consensus failure
2602 tx_state.GetRejectReason(), tx_state.GetDebugMessage());
2603 break;
2604 }
2605 }
2606
2607 CTxUndo undoDummy;
2608 if (i > 0) {
2609 blockundo.vtxundo.emplace_back();
2610 }
2611 UpdateCoins(tx, view, i == 0 ? undoDummy : blockundo.vtxundo.back(), pindex->nHeight);
2612 }
2613 const auto time_3{SteadyClock::now()};
2614 m_chainman.time_connect += time_3 - time_2;
2615 LogDebug(BCLog::BENCH, " - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) [%.2fs (%.2fms/blk)]\n", (unsigned)block.vtx.size(),
2616 Ticks<MillisecondsDouble>(time_3 - time_2), Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2617 nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2618 Ticks<SecondsDouble>(m_chainman.time_connect),
2619 Ticks<MillisecondsDouble>(m_chainman.time_connect) / m_chainman.num_blocks_total);
2620
2621 CAmount blockReward = nFees + GetBlockSubsidy(pindex->nHeight, params.GetConsensus());
2622 if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
2623 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-amount",
2624 strprintf("coinbase pays too much (actual=%d vs limit=%d)", block.vtx[0]->GetValueOut(), blockReward));
2625 }
2626 if (control) {
2627 auto parallel_result = control->Complete();
2628 if (parallel_result.has_value() && state.IsValid()) {
2629 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(parallel_result->first)), parallel_result->second);
2630 }
2631 }
2632 if (!state.IsValid()) {
2633 LogInfo("Block validation error: %s", state.ToString());
2634 return false;
2635 }
2636 const auto time_4{SteadyClock::now()};
2637 m_chainman.time_verify += time_4 - time_2;
2638 LogDebug(BCLog::BENCH, " - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n", nInputs - 1,
2639 Ticks<MillisecondsDouble>(time_4 - time_2),
2640 nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2641 Ticks<SecondsDouble>(m_chainman.time_verify),
2642 Ticks<MillisecondsDouble>(m_chainman.time_verify) / m_chainman.num_blocks_total);
2643
2644 if (fJustCheck) {
2645 return true;
2646 }
2647
2648 if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2649 return false;
2650 }
2651
2652 const auto time_5{SteadyClock::now()};
2653 m_chainman.time_undo += time_5 - time_4;
2654 LogDebug(BCLog::BENCH, " - Write undo data: %.2fms [%.2fs (%.2fms/blk)]\n",
2655 Ticks<MillisecondsDouble>(time_5 - time_4),
2656 Ticks<SecondsDouble>(m_chainman.time_undo),
2657 Ticks<MillisecondsDouble>(m_chainman.time_undo) / m_chainman.num_blocks_total);
2658
2659 if (!pindex->IsValid(BLOCK_VALID_SCRIPTS)) {
2661 m_blockman.m_dirty_blockindex.insert(pindex);
2662 }
2663
2664 // add this block to the view's block chain
2665 view.SetBestBlock(pindex->GetBlockHash());
2666
2667 const auto time_6{SteadyClock::now()};
2668 m_chainman.time_index += time_6 - time_5;
2669 LogDebug(BCLog::BENCH, " - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
2670 Ticks<MillisecondsDouble>(time_6 - time_5),
2671 Ticks<SecondsDouble>(m_chainman.time_index),
2672 Ticks<MillisecondsDouble>(m_chainman.time_index) / m_chainman.num_blocks_total);
2673
2674 TRACEPOINT(validation, block_connected,
2675 block_hash.data(),
2676 pindex->nHeight,
2677 block.vtx.size(),
2678 nInputs,
2679 nSigOpsCost,
2680 Ticks<std::chrono::nanoseconds>(time_5 - time_start)
2681 );
2682
2683 return true;
2684}
2685
2686CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState()
2687{
2689 return this->GetCoinsCacheSizeState(
2692}
2693
2694CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState(
2695 size_t max_coins_cache_size_bytes,
2696 size_t max_mempool_size_bytes)
2697{
2699 const int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2700 int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2701 int64_t nTotalSpace =
2702 max_coins_cache_size_bytes + std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2703
2704 if (cacheSize > nTotalSpace) {
2705 LogInfo("Cache size (%s) exceeds total space (%s)\n", cacheSize, nTotalSpace);
2707 } else if (cacheSize > LargeCoinsCacheThreshold(nTotalSpace)) {
2709 }
2711}
2712
2714 BlockValidationState &state,
2715 FlushStateMode mode,
2716 int nManualPruneHeight)
2717{
2718 LOCK(cs_main);
2719 assert(this->CanFlushToDisk());
2720 std::set<int> setFilesToPrune;
2721 bool full_flush_completed = false;
2722
2723 const size_t coins_count = CoinsTip().GetCacheSize();
2724 const size_t coins_mem_usage = CoinsTip().DynamicMemoryUsage();
2725
2726 try {
2727 {
2728 bool fFlushForPrune = false;
2729
2730 CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2733 // make sure we don't prune above any of the prune locks bestblocks
2734 // pruning is height-based
2735 int last_prune{m_chain.Height()}; // last height we can prune
2736 std::optional<std::string> limiting_lock; // prune lock that actually was the limiting factor, only used for logging
2737
2738 for (const auto& prune_lock : m_blockman.m_prune_locks) {
2739 if (prune_lock.second.height_first == std::numeric_limits<int>::max()) continue;
2740 // Remove the buffer and one additional block here to get actual height that is outside of the buffer
2741 const int lock_height{prune_lock.second.height_first - PRUNE_LOCK_BUFFER - 1};
2742 last_prune = std::max(1, std::min(last_prune, lock_height));
2743 if (last_prune == lock_height) {
2744 limiting_lock = prune_lock.first;
2745 }
2746 }
2747
2748 if (limiting_lock) {
2749 LogDebug(BCLog::PRUNE, "%s limited pruning to height %d\n", limiting_lock.value(), last_prune);
2750 }
2751
2752 if (nManualPruneHeight > 0) {
2753 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune (manual)", BCLog::BENCH);
2754
2756 setFilesToPrune,
2757 std::min(last_prune, nManualPruneHeight),
2758 *this, m_chainman);
2759 } else {
2760 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune", BCLog::BENCH);
2761
2762 m_blockman.FindFilesToPrune(setFilesToPrune, last_prune, *this, m_chainman);
2764 }
2765 if (!setFilesToPrune.empty()) {
2766 fFlushForPrune = true;
2768 m_blockman.m_block_tree_db->WriteFlag("prunedblockfiles", true);
2770 }
2771 }
2772 }
2773 const auto nNow{NodeClock::now()};
2774 // The cache is large and we're within 10% and 10 MiB of the limit, but we have time now (not in the middle of a block processing).
2775 bool fCacheLarge = mode == FlushStateMode::PERIODIC && cache_state >= CoinsCacheSizeState::LARGE;
2776 // The cache is over the limit, we have to write now.
2777 bool fCacheCritical = mode == FlushStateMode::IF_NEEDED && cache_state >= CoinsCacheSizeState::CRITICAL;
2778 // It's been a while since we wrote the block index and chain state to disk. Do this frequently, so we don't need to redownload or reindex after a crash.
2779 bool fPeriodicWrite = mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2780 // Combine all conditions that result in a write to disk.
2781 bool should_write = (mode == FlushStateMode::ALWAYS) || fCacheLarge || fCacheCritical || fPeriodicWrite || fFlushForPrune;
2782 // Write blocks, block index and best chain related state to disk.
2783 if (should_write) {
2784 LogDebug(BCLog::COINDB, "Writing chainstate to disk: flush mode=%s, prune=%d, large=%d, critical=%d, periodic=%d",
2785 FlushStateModeNames[size_t(mode)], fFlushForPrune, fCacheLarge, fCacheCritical, fPeriodicWrite);
2786
2787 // Ensure we can write block index
2789 return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2790 }
2791 {
2792 LOG_TIME_MILLIS_WITH_CATEGORY("write block and undo data to disk", BCLog::BENCH);
2793
2794 // First make sure all block and undo data is flushed to disk.
2795 // TODO: Handle return error, or add detailed comment why it is
2796 // safe to not return an error upon failure.
2798 LogWarning("%s: Failed to flush block file.\n", __func__);
2799 }
2800 }
2801
2802 // Then update all block file information (which may refer to block and undo files).
2803 {
2804 LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk", BCLog::BENCH);
2805
2806 m_blockman.WriteBlockIndexDB();
2807 }
2808 // Finally remove any pruned files
2809 if (fFlushForPrune) {
2810 LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files", BCLog::BENCH);
2811
2812 m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2813 }
2814
2815 if (!CoinsTip().GetBestBlock().IsNull()) {
2816 if (coins_mem_usage >= WARN_FLUSH_COINS_SIZE) LogWarning("Flushing large (%d GiB) UTXO set to disk, it may take several minutes", coins_mem_usage >> 30);
2817 LOG_TIME_MILLIS_WITH_CATEGORY(strprintf("write coins cache to disk (%d coins, %.2fKiB)",
2818 coins_count, coins_mem_usage >> 10), BCLog::BENCH);
2819
2820 // Typical Coin structures on disk are around 48 bytes in size.
2821 // Pushing a new one to the database can cause it to be written
2822 // twice (once in the log, and once in the tables). This is already
2823 // an overestimation, as most will delete an existing entry or
2824 // overwrite one. Still, use a conservative safety factor of 2.
2825 if (!CheckDiskSpace(m_chainman.m_options.datadir, 48 * 2 * 2 * CoinsTip().GetCacheSize())) {
2826 return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2827 }
2828 // Flush the chainstate (which may refer to block index entries).
2829 const auto empty_cache{(mode == FlushStateMode::ALWAYS) || fCacheLarge || fCacheCritical};
2830 if (empty_cache ? !CoinsTip().Flush() : !CoinsTip().Sync()) {
2831 return FatalError(m_chainman.GetNotifications(), state, _("Failed to write to coin database."));
2832 }
2833 full_flush_completed = true;
2834 TRACEPOINT(utxocache, flush,
2835 int64_t{Ticks<std::chrono::microseconds>(NodeClock::now() - nNow)},
2836 (uint32_t)mode,
2837 (uint64_t)coins_count,
2838 (uint64_t)coins_mem_usage,
2839 (bool)fFlushForPrune);
2840 }
2841 }
2842
2843 if (should_write || m_next_write == NodeClock::time_point::max()) {
2846 }
2847 }
2848 if (full_flush_completed && m_chainman.m_options.signals) {
2849 // Update best block in wallet (so we can detect restored wallets).
2851 }
2852 } catch (const std::runtime_error& e) {
2853 return FatalError(m_chainman.GetNotifications(), state, strprintf(_("System error while flushing: %s"), e.what()));
2854 }
2855 return true;
2856}
2857
2859{
2861 if (!this->FlushStateToDisk(state, FlushStateMode::ALWAYS)) {
2862 LogWarning("Failed to force flush state (%s)", state.ToString());
2863 }
2864}
2865
2867{
2870 if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2871 LogWarning("Failed to flush state (%s)", state.ToString());
2872 }
2873}
2874
2875static void UpdateTipLog(
2876 const ChainstateManager& chainman,
2877 const CCoinsViewCache& coins_tip,
2878 const CBlockIndex* tip,
2879 const std::string& func_name,
2880 const std::string& prefix,
2881 const std::string& warning_messages) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
2882{
2883
2885
2886 // Disable rate limiting in LogPrintLevel_ so this source location may log during IBD.
2887 LogPrintLevel_(BCLog::LogFlags::ALL, BCLog::Level::Info, /*should_ratelimit=*/false, "%s%s: new best=%s height=%d version=0x%08x log2_work=%f tx=%lu date='%s' progress=%f cache=%.1fMiB(%utxo)%s\n",
2888 prefix, func_name,
2889 tip->GetBlockHash().ToString(), tip->nHeight, tip->nVersion,
2890 log(tip->nChainWork.getdouble()) / log(2.0), tip->m_chain_tx_count,
2892 chainman.GuessVerificationProgress(tip),
2893 coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2894 coins_tip.GetCacheSize(),
2895 !warning_messages.empty() ? strprintf(" warning='%s'", warning_messages) : "");
2896}
2897
2898void Chainstate::UpdateTip(const CBlockIndex* pindexNew)
2899{
2901 const auto& coins_tip = this->CoinsTip();
2902
2903 // The remainder of the function isn't relevant if we are not acting on
2904 // the active chainstate, so return if need be.
2905 if (this != &m_chainman.ActiveChainstate()) {
2906 // Only log every so often so that we don't bury log messages at the tip.
2907 constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2908 if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2909 UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "[background validation] ", "");
2910 }
2911 return;
2912 }
2913
2914 // New best block
2915 if (m_mempool) {
2917 }
2918
2919 std::vector<bilingual_str> warning_messages;
2922 for (auto [bit, active] : bits) {
2923 const bilingual_str warning = strprintf(_("Unknown new rules activated (versionbit %i)"), bit);
2924 if (active) {
2926 } else {
2927 warning_messages.push_back(warning);
2928 }
2929 }
2930 }
2931 UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "",
2932 util::Join(warning_messages, Untranslated(", ")).original);
2933}
2934
2946{
2949
2950 CBlockIndex *pindexDelete = m_chain.Tip();
2951 assert(pindexDelete);
2952 assert(pindexDelete->pprev);
2953 // Read block from disk.
2954 std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2955 CBlock& block = *pblock;
2956 if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2957 LogError("DisconnectTip(): Failed to read block\n");
2958 return false;
2959 }
2960 // Apply the block atomically to the chain state.
2961 const auto time_start{SteadyClock::now()};
2962 {
2963 CCoinsViewCache view(&CoinsTip());
2964 assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2965 if (DisconnectBlock(block, pindexDelete, view) != DISCONNECT_OK) {
2966 LogError("DisconnectTip(): DisconnectBlock %s failed\n", pindexDelete->GetBlockHash().ToString());
2967 return false;
2968 }
2969 bool flushed = view.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
2970 assert(flushed);
2971 }
2972 LogDebug(BCLog::BENCH, "- Disconnect block: %.2fms\n",
2973 Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2974
2975 {
2976 // Prune locks that began at or after the tip should be moved backward so they get a chance to reorg
2977 const int max_height_first{pindexDelete->nHeight - 1};
2978 for (auto& prune_lock : m_blockman.m_prune_locks) {
2979 if (prune_lock.second.height_first <= max_height_first) continue;
2980
2981 prune_lock.second.height_first = max_height_first;
2982 LogDebug(BCLog::PRUNE, "%s prune lock moved back to %d\n", prune_lock.first, max_height_first);
2983 }
2984 }
2985
2986 // Write the chain state to disk, if necessary.
2988 return false;
2989 }
2990
2991 if (disconnectpool && m_mempool) {
2992 // Save transactions to re-add to mempool at end of reorg. If any entries are evicted for
2993 // exceeding memory limits, remove them and their descendants from the mempool.
2994 for (auto&& evicted_tx : disconnectpool->AddTransactionsFromBlock(block.vtx)) {
2996 }
2997 }
2998
2999 m_chain.SetTip(*pindexDelete->pprev);
3000
3001 UpdateTip(pindexDelete->pprev);
3002 // Let wallets know transactions went from 1-confirmed to
3003 // 0-confirmed or conflicted:
3005 m_chainman.m_options.signals->BlockDisconnected(pblock, pindexDelete);
3006 }
3007 return true;
3008}
3009
3012 std::shared_ptr<const CBlock> pblock;
3014};
3023private:
3024 std::vector<PerBlockConnectTrace> blocksConnected;
3025
3026public:
3028
3029 void BlockConnected(CBlockIndex* pindex, std::shared_ptr<const CBlock> pblock) {
3030 assert(!blocksConnected.back().pindex);
3031 assert(pindex);
3032 assert(pblock);
3033 blocksConnected.back().pindex = pindex;
3034 blocksConnected.back().pblock = std::move(pblock);
3035 blocksConnected.emplace_back();
3036 }
3037
3038 std::vector<PerBlockConnectTrace>& GetBlocksConnected() {
3039 // We always keep one extra block at the end of our list because
3040 // blocks are added after all the conflicted transactions have
3041 // been filled in. Thus, the last entry should always be an empty
3042 // one waiting for the transactions from the next block. We pop
3043 // the last entry here to make sure the list we return is sane.
3044 assert(!blocksConnected.back().pindex);
3045 blocksConnected.pop_back();
3046 return blocksConnected;
3047 }
3048};
3049
3057 BlockValidationState& state,
3058 CBlockIndex* pindexNew,
3059 std::shared_ptr<const CBlock> block_to_connect,
3060 ConnectTrace& connectTrace,
3061 DisconnectedBlockTransactions& disconnectpool)
3062{
3065
3066 assert(pindexNew->pprev == m_chain.Tip());
3067 // Read block from disk.
3068 const auto time_1{SteadyClock::now()};
3069 if (!block_to_connect) {
3070 std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
3071 if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
3072 return FatalError(m_chainman.GetNotifications(), state, _("Failed to read block."));
3073 }
3074 block_to_connect = std::move(pblockNew);
3075 } else {
3076 LogDebug(BCLog::BENCH, " - Using cached block\n");
3077 }
3078 // Apply the block atomically to the chain state.
3079 const auto time_2{SteadyClock::now()};
3080 SteadyClock::time_point time_3;
3081 // When adding aggregate statistics in the future, keep in mind that
3082 // num_blocks_total may be zero until the ConnectBlock() call below.
3083 LogDebug(BCLog::BENCH, " - Load block from disk: %.2fms\n",
3084 Ticks<MillisecondsDouble>(time_2 - time_1));
3085 {
3086 CCoinsViewCache view(&CoinsTip());
3087 bool rv = ConnectBlock(*block_to_connect, state, pindexNew, view);
3089 m_chainman.m_options.signals->BlockChecked(block_to_connect, state);
3090 }
3091 if (!rv) {
3092 if (state.IsInvalid())
3093 InvalidBlockFound(pindexNew, state);
3094 LogError("%s: ConnectBlock %s failed, %s\n", __func__, pindexNew->GetBlockHash().ToString(), state.ToString());
3095 return false;
3096 }
3097 time_3 = SteadyClock::now();
3098 m_chainman.time_connect_total += time_3 - time_2;
3099 assert(m_chainman.num_blocks_total > 0);
3100 LogDebug(BCLog::BENCH, " - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
3101 Ticks<MillisecondsDouble>(time_3 - time_2),
3102 Ticks<SecondsDouble>(m_chainman.time_connect_total),
3103 Ticks<MillisecondsDouble>(m_chainman.time_connect_total) / m_chainman.num_blocks_total);
3104 bool flushed = view.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
3105 assert(flushed);
3106 }
3107 const auto time_4{SteadyClock::now()};
3108 m_chainman.time_flush += time_4 - time_3;
3109 LogDebug(BCLog::BENCH, " - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
3110 Ticks<MillisecondsDouble>(time_4 - time_3),
3111 Ticks<SecondsDouble>(m_chainman.time_flush),
3112 Ticks<MillisecondsDouble>(m_chainman.time_flush) / m_chainman.num_blocks_total);
3113 // Write the chain state to disk, if necessary.
3115 return false;
3116 }
3117 const auto time_5{SteadyClock::now()};
3118 m_chainman.time_chainstate += time_5 - time_4;
3119 LogDebug(BCLog::BENCH, " - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
3120 Ticks<MillisecondsDouble>(time_5 - time_4),
3121 Ticks<SecondsDouble>(m_chainman.time_chainstate),
3122 Ticks<MillisecondsDouble>(m_chainman.time_chainstate) / m_chainman.num_blocks_total);
3123 // Remove conflicting transactions from the mempool.;
3124 if (m_mempool) {
3125 m_mempool->removeForBlock(block_to_connect->vtx, pindexNew->nHeight);
3126 disconnectpool.removeForBlock(block_to_connect->vtx);
3127 }
3128 // Update m_chain & related variables.
3129 m_chain.SetTip(*pindexNew);
3130 UpdateTip(pindexNew);
3131
3132 const auto time_6{SteadyClock::now()};
3133 m_chainman.time_post_connect += time_6 - time_5;
3134 m_chainman.time_total += time_6 - time_1;
3135 LogDebug(BCLog::BENCH, " - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
3136 Ticks<MillisecondsDouble>(time_6 - time_5),
3137 Ticks<SecondsDouble>(m_chainman.time_post_connect),
3138 Ticks<MillisecondsDouble>(m_chainman.time_post_connect) / m_chainman.num_blocks_total);
3139 LogDebug(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
3140 Ticks<MillisecondsDouble>(time_6 - time_1),
3141 Ticks<SecondsDouble>(m_chainman.time_total),
3142 Ticks<MillisecondsDouble>(m_chainman.time_total) / m_chainman.num_blocks_total);
3143
3144 // If we are the background validation chainstate, check to see if we are done
3145 // validating the snapshot (i.e. our tip has reached the snapshot's base block).
3146 if (this != &m_chainman.ActiveChainstate()) {
3147 // This call may set `m_disabled`, which is referenced immediately afterwards in
3148 // ActivateBestChain, so that we stop connecting blocks past the snapshot base.
3149 m_chainman.MaybeCompleteSnapshotValidation();
3150 }
3151
3152 connectTrace.BlockConnected(pindexNew, std::move(block_to_connect));
3153 return true;
3154}
3155
3161{
3163 do {
3164 CBlockIndex *pindexNew = nullptr;
3165
3166 // Find the best candidate header.
3167 {
3168 std::set<CBlockIndex*, CBlockIndexWorkComparator>::reverse_iterator it = setBlockIndexCandidates.rbegin();
3169 if (it == setBlockIndexCandidates.rend())
3170 return nullptr;
3171 pindexNew = *it;
3172 }
3173
3174 // Check whether all blocks on the path between the currently active chain and the candidate are valid.
3175 // Just going until the active chain is an optimization, as we know all blocks in it are valid already.
3176 CBlockIndex *pindexTest = pindexNew;
3177 bool fInvalidAncestor = false;
3178 while (pindexTest && !m_chain.Contains(pindexTest)) {
3179 assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3180
3181 // Pruned nodes may have entries in setBlockIndexCandidates for
3182 // which block files have been deleted. Remove those as candidates
3183 // for the most work chain if we come across them; we can't switch
3184 // to a chain unless we have all the non-active-chain parent blocks.
3185 bool fFailedChain = pindexTest->nStatus & BLOCK_FAILED_MASK;
3186 bool fMissingData = !(pindexTest->nStatus & BLOCK_HAVE_DATA);
3187 if (fFailedChain || fMissingData) {
3188 // Candidate chain is not usable (either invalid or missing data)
3189 if (fFailedChain && (m_chainman.m_best_invalid == nullptr || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork)) {
3190 m_chainman.m_best_invalid = pindexNew;
3191 }
3192 CBlockIndex *pindexFailed = pindexNew;
3193 // Remove the entire chain from the set.
3194 while (pindexTest != pindexFailed) {
3195 if (fFailedChain) {
3196 pindexFailed->nStatus |= BLOCK_FAILED_CHILD;
3197 m_blockman.m_dirty_blockindex.insert(pindexFailed);
3198 } else if (fMissingData) {
3199 // If we're missing data, then add back to m_blocks_unlinked,
3200 // so that if the block arrives in the future we can try adding
3201 // to setBlockIndexCandidates again.
3203 std::make_pair(pindexFailed->pprev, pindexFailed));
3204 }
3205 setBlockIndexCandidates.erase(pindexFailed);
3206 pindexFailed = pindexFailed->pprev;
3207 }
3208 setBlockIndexCandidates.erase(pindexTest);
3209 fInvalidAncestor = true;
3210 break;
3211 }
3212 pindexTest = pindexTest->pprev;
3213 }
3214 if (!fInvalidAncestor)
3215 return pindexNew;
3216 } while(true);
3217}
3218
3221 // Note that we can't delete the current block itself, as we may need to return to it later in case a
3222 // reorganization to a better block fails.
3223 std::set<CBlockIndex*, CBlockIndexWorkComparator>::iterator it = setBlockIndexCandidates.begin();
3224 while (it != setBlockIndexCandidates.end() && setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
3225 setBlockIndexCandidates.erase(it++);
3226 }
3227 // Either the current tip or a successor of it we're working towards is left in setBlockIndexCandidates.
3229}
3230
3237bool Chainstate::ActivateBestChainStep(BlockValidationState& state, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, ConnectTrace& connectTrace)
3238{
3241
3242 const CBlockIndex* pindexOldTip = m_chain.Tip();
3243 const CBlockIndex* pindexFork = m_chain.FindFork(pindexMostWork);
3244
3245 // Disconnect active blocks which are no longer in the best chain.
3246 bool fBlocksDisconnected = false;
3248 while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
3249 if (!DisconnectTip(state, &disconnectpool)) {
3250 // This is likely a fatal error, but keep the mempool consistent,
3251 // just in case. Only remove from the mempool in this case.
3252 MaybeUpdateMempoolForReorg(disconnectpool, false);
3253
3254 // If we're unable to disconnect a block during normal operation,
3255 // then that is a failure of our local system -- we should abort
3256 // rather than stay on a less work chain.
3257 FatalError(m_chainman.GetNotifications(), state, _("Failed to disconnect block."));
3258 return false;
3259 }
3260 fBlocksDisconnected = true;
3261 }
3262
3263 // Build list of new blocks to connect (in descending height order).
3264 std::vector<CBlockIndex*> vpindexToConnect;
3265 bool fContinue = true;
3266 int nHeight = pindexFork ? pindexFork->nHeight : -1;
3267 while (fContinue && nHeight != pindexMostWork->nHeight) {
3268 // Don't iterate the entire list of potential improvements toward the best tip, as we likely only need
3269 // a few blocks along the way.
3270 int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3271 vpindexToConnect.clear();
3272 vpindexToConnect.reserve(nTargetHeight - nHeight);
3273 CBlockIndex* pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3274 while (pindexIter && pindexIter->nHeight != nHeight) {
3275 vpindexToConnect.push_back(pindexIter);
3276 pindexIter = pindexIter->pprev;
3277 }
3278 nHeight = nTargetHeight;
3279
3280 // Connect new blocks.
3281 for (CBlockIndex* pindexConnect : vpindexToConnect | std::views::reverse) {
3282 if (!ConnectTip(state, pindexConnect, pindexConnect == pindexMostWork ? pblock : std::shared_ptr<const CBlock>(), connectTrace, disconnectpool)) {
3283 if (state.IsInvalid()) {
3284 // The block violates a consensus rule.
3286 InvalidChainFound(vpindexToConnect.front());
3287 }
3288 state = BlockValidationState();
3289 fInvalidFound = true;
3290 fContinue = false;
3291 break;
3292 } else {
3293 // A system error occurred (disk space, database error, ...).
3294 // Make the mempool consistent with the current tip, just in case
3295 // any observers try to use it before shutdown.
3296 MaybeUpdateMempoolForReorg(disconnectpool, false);
3297 return false;
3298 }
3299 } else {
3301 if (!pindexOldTip || m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
3302 // We're in a better position than we were. Return temporarily to release the lock.
3303 fContinue = false;
3304 break;
3305 }
3306 }
3307 }
3308 }
3309
3310 if (fBlocksDisconnected) {
3311 // If any blocks were disconnected, disconnectpool may be non empty. Add
3312 // any disconnected transactions back to the mempool.
3313 MaybeUpdateMempoolForReorg(disconnectpool, true);
3314 }
3315 if (m_mempool) m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
3316
3318
3319 return true;
3320}
3321
3322static SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
3323{
3325 if (!blockfiles_indexed) return SynchronizationState::INIT_REINDEX;
3327}
3328
3330{
3331 bool fNotify = false;
3332 bool fInitialBlockDownload = false;
3333 CBlockIndex* pindexHeader = nullptr;
3334 {
3335 LOCK(GetMutex());
3336 pindexHeader = m_best_header;
3337
3338 if (pindexHeader != m_last_notified_header) {
3339 fNotify = true;
3340 fInitialBlockDownload = IsInitialBlockDownload();
3341 m_last_notified_header = pindexHeader;
3342 }
3343 }
3344 // Send block tip changed notifications without the lock held
3345 if (fNotify) {
3346 GetNotifications().headerTip(GetSynchronizationState(fInitialBlockDownload, m_blockman.m_blockfiles_indexed), pindexHeader->nHeight, pindexHeader->nTime, false);
3347 }
3348 return fNotify;
3349}
3350
3353
3354 if (signals.CallbacksPending() > 10) {
3355 signals.SyncWithValidationInterfaceQueue();
3356 }
3357}
3358
3359bool Chainstate::ActivateBestChain(BlockValidationState& state, std::shared_ptr<const CBlock> pblock)
3360{
3362
3363 // Note that while we're often called here from ProcessNewBlock, this is
3364 // far from a guarantee. Things in the P2P/RPC will often end up calling
3365 // us in the middle of ProcessNewBlock - do not assume pblock is set
3366 // sanely for performance or correctness!
3368
3369 // ABC maintains a fair degree of expensive-to-calculate internal state
3370 // because this function periodically releases cs_main so that it does not lock up other threads for too long
3371 // during large connects - and to allow for e.g. the callback queue to drain
3372 // we use m_chainstate_mutex to enforce mutual exclusion so that only one caller may execute this function at a time
3374
3375 // Belt-and-suspenders check that we aren't attempting to advance the background
3376 // chainstate past the snapshot base block.
3377 if (WITH_LOCK(::cs_main, return m_disabled)) {
3378 LogError("m_disabled is set - this chainstate should not be in operation. "
3379 "Please report this as a bug. %s", CLIENT_BUGREPORT);
3380 return false;
3381 }
3382
3383 CBlockIndex *pindexMostWork = nullptr;
3384 CBlockIndex *pindexNewTip = nullptr;
3385 bool exited_ibd{false};
3386 do {
3387 // Block until the validation queue drains. This should largely
3388 // never happen in normal operation, however may happen during
3389 // reindex, causing memory blowup if we run too far ahead.
3390 // Note that if a validationinterface callback ends up calling
3391 // ActivateBestChain this may lead to a deadlock! We should
3392 // probably have a DEBUG_LOCKORDER test for this in the future.
3394
3395 {
3396 LOCK(cs_main);
3397 {
3398 // Lock transaction pool for at least as long as it takes for connectTrace to be consumed
3399 LOCK(MempoolMutex());
3400 const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3401 CBlockIndex* starting_tip = m_chain.Tip();
3402 bool blocks_connected = false;
3403 do {
3404 // We absolutely may not unlock cs_main until we've made forward progress
3405 // (with the exception of shutdown due to hardware issues, low disk space, etc).
3406 ConnectTrace connectTrace; // Destructed before cs_main is unlocked
3407
3408 if (pindexMostWork == nullptr) {
3409 pindexMostWork = FindMostWorkChain();
3410 }
3411
3412 // Whether we have anything to do at all.
3413 if (pindexMostWork == nullptr || pindexMostWork == m_chain.Tip()) {
3414 break;
3415 }
3416
3417 bool fInvalidFound = false;
3418 std::shared_ptr<const CBlock> nullBlockPtr;
3419 // BlockConnected signals must be sent for the original role;
3420 // in case snapshot validation is completed during ActivateBestChainStep, the
3421 // result of GetRole() changes from BACKGROUND to NORMAL.
3422 const ChainstateRole chainstate_role{this->GetRole()};
3423 if (!ActivateBestChainStep(state, pindexMostWork, pblock && pblock->GetHash() == pindexMostWork->GetBlockHash() ? pblock : nullBlockPtr, fInvalidFound, connectTrace)) {
3424 // A system error occurred
3425 return false;
3426 }
3427 blocks_connected = true;
3428
3429 if (fInvalidFound) {
3430 // Wipe cache, we may need another branch now.
3431 pindexMostWork = nullptr;
3432 }
3433 pindexNewTip = m_chain.Tip();
3434
3435 for (const PerBlockConnectTrace& trace : connectTrace.GetBlocksConnected()) {
3436 assert(trace.pblock && trace.pindex);
3438 m_chainman.m_options.signals->BlockConnected(chainstate_role, trace.pblock, trace.pindex);
3439 }
3440 }
3441
3442 // This will have been toggled in
3443 // ActivateBestChainStep -> ConnectTip -> MaybeCompleteSnapshotValidation,
3444 // if at all, so we should catch it here.
3445 //
3446 // Break this do-while to ensure we don't advance past the base snapshot.
3447 if (m_disabled) {
3448 break;
3449 }
3450 } while (!m_chain.Tip() || (starting_tip && CBlockIndexWorkComparator()(m_chain.Tip(), starting_tip)));
3451 if (!blocks_connected) return true;
3452
3453 const CBlockIndex* pindexFork = m_chain.FindFork(starting_tip);
3454 bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3455
3456 if (was_in_ibd && !still_in_ibd) {
3457 // Active chainstate has exited IBD.
3458 exited_ibd = true;
3459 }
3460
3461 // Notify external listeners about the new tip.
3462 // Enqueue while holding cs_main to ensure that UpdatedBlockTip is called in the order in which blocks are connected
3463 if (this == &m_chainman.ActiveChainstate() && pindexFork != pindexNewTip) {
3464 // Notify ValidationInterface subscribers
3466 m_chainman.m_options.signals->UpdatedBlockTip(pindexNewTip, pindexFork, still_in_ibd);
3467 }
3468
3471 /*index=*/*pindexNewTip,
3472 /*verification_progress=*/m_chainman.GuessVerificationProgress(pindexNewTip))))
3473 {
3474 // Just breaking and returning success for now. This could
3475 // be changed to bubble up the kernel::Interrupted value to
3476 // the caller so the caller could distinguish between
3477 // completed and interrupted operations.
3478 break;
3479 }
3480 }
3481 } // release MempoolMutex
3482 // Notify external listeners about the new tip, even if pindexFork == pindexNewTip.
3485 }
3486 } // release cs_main
3487 // When we reach this point, we switched to a new tip (stored in pindexNewTip).
3488
3489 bool disabled{false};
3490 {
3492 if (exited_ibd) {
3493 // If a background chainstate is in use, we may need to rebalance our
3494 // allocation of caches once a chainstate exits initial block download.
3495 m_chainman.MaybeRebalanceCaches();
3496 }
3497
3498 // Write changes periodically to disk, after relay.
3500 return false;
3501 }
3502
3503 disabled = m_disabled;
3504 }
3505
3506 if (disabled) {
3507 // Background chainstate has reached the snapshot base block, so exit.
3508
3509 // Restart indexes to resume indexing for all blocks unique to the snapshot
3510 // chain. This resumes indexing "in order" from where the indexing on the
3511 // background validation chain left off.
3512 //
3513 // This cannot be done while holding cs_main (within
3514 // MaybeCompleteSnapshotValidation) or a cs_main deadlock will occur.
3517 }
3518 break;
3519 }
3520
3521 // We check interrupt only after giving ActivateBestChainStep a chance to run once so that we
3522 // never interrupt before connecting the genesis block during LoadChainTip(). Previously this
3523 // caused an assert() failure during interrupt in such cases as the UTXO DB flushing checks
3524 // that the best block hash is non-null.
3525 if (m_chainman.m_interrupt) break;
3526 } while (pindexNewTip != pindexMostWork);
3527
3529
3530 return true;
3531}
3532
3533bool Chainstate::PreciousBlock(BlockValidationState& state, CBlockIndex* pindex)
3534{
3537 {
3538 LOCK(cs_main);
3539 if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
3540 // Nothing to do, this block is not at the tip.
3541 return true;
3542 }
3544 // The chain has been extended since the last call, reset the counter.
3546 }
3548 setBlockIndexCandidates.erase(pindex);
3550 if (m_chainman.nBlockReverseSequenceId > std::numeric_limits<int32_t>::min()) {
3551 // We can't keep reducing the counter if somebody really wants to
3552 // call preciousblock 2**31-1 times on the same set of tips...
3554 }
3555 if (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) && pindex->HaveNumChainTxs()) {
3556 setBlockIndexCandidates.insert(pindex);
3558 }
3559 }
3560
3561 return ActivateBestChain(state, std::shared_ptr<const CBlock>());
3562}
3563
3565{
3568
3569 // Genesis block can't be invalidated
3570 assert(pindex);
3571 if (pindex->nHeight == 0) return false;
3572
3573 CBlockIndex* to_mark_failed = pindex;
3574 bool pindex_was_in_chain = false;
3575 int disconnected = 0;
3576
3577 // We do not allow ActivateBestChain() to run while InvalidateBlock() is
3578 // running, as that could cause the tip to change while we disconnect
3579 // blocks.
3581
3582 // We'll be acquiring and releasing cs_main below, to allow the validation
3583 // callbacks to run. However, we should keep the block index in a
3584 // consistent state as we disconnect blocks -- in particular we need to
3585 // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3586 // To avoid walking the block index repeatedly in search of candidates,
3587 // build a map once so that we can look up candidate blocks by chain
3588 // work as we go.
3589 std::multimap<const arith_uint256, CBlockIndex*> highpow_outofchain_headers;
3590
3591 {
3592 LOCK(cs_main);
3593 for (auto& entry : m_blockman.m_block_index) {
3594 CBlockIndex* candidate = &entry.second;
3595 // We don't need to put anything in our active chain into the
3596 // multimap, because those candidates will be found and considered
3597 // as we disconnect.
3598 // Instead, consider only non-active-chain blocks that score
3599 // at least as good with CBlockIndexWorkComparator as the new tip.
3600 if (!m_chain.Contains(candidate) &&
3601 !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3602 !(candidate->nStatus & BLOCK_FAILED_MASK)) {
3603 highpow_outofchain_headers.insert({candidate->nChainWork, candidate});
3604 }
3605 }
3606 }
3607
3608 // Disconnect (descendants of) pindex, and mark them invalid.
3609 while (true) {
3610 if (m_chainman.m_interrupt) break;
3611
3612 // Make sure the queue of validation callbacks doesn't grow unboundedly.
3614
3615 LOCK(cs_main);
3616 // Lock for as long as disconnectpool is in scope to make sure MaybeUpdateMempoolForReorg is
3617 // called after DisconnectTip without unlocking in between
3618 LOCK(MempoolMutex());
3619 if (!m_chain.Contains(pindex)) break;
3620 pindex_was_in_chain = true;
3621 CBlockIndex *invalid_walk_tip = m_chain.Tip();
3622
3623 // ActivateBestChain considers blocks already in m_chain
3624 // unconditionally valid already, so force disconnect away from it.
3626 bool ret = DisconnectTip(state, &disconnectpool);
3627 // DisconnectTip will add transactions to disconnectpool.
3628 // Adjust the mempool to be consistent with the new tip, adding
3629 // transactions back to the mempool if disconnecting was successful,
3630 // and we're not doing a very deep invalidation (in which case
3631 // keeping the mempool up to date is probably futile anyway).
3632 MaybeUpdateMempoolForReorg(disconnectpool, /* fAddToMempool = */ (++disconnected <= 10) && ret);
3633 if (!ret) return false;
3634 assert(invalid_walk_tip->pprev == m_chain.Tip());
3635
3636 // We immediately mark the disconnected blocks as invalid.
3637 // This prevents a case where pruned nodes may fail to invalidateblock
3638 // and be left unable to start as they have no tip candidates (as there
3639 // are no blocks that meet the "have data and are not invalid per
3640 // nStatus" criteria for inclusion in setBlockIndexCandidates).
3641 invalid_walk_tip->nStatus |= BLOCK_FAILED_VALID;
3642 m_blockman.m_dirty_blockindex.insert(invalid_walk_tip);
3643 setBlockIndexCandidates.erase(invalid_walk_tip);
3644 setBlockIndexCandidates.insert(invalid_walk_tip->pprev);
3645 if (invalid_walk_tip == to_mark_failed->pprev && (to_mark_failed->nStatus & BLOCK_FAILED_VALID)) {
3646 // We only want to mark the last disconnected block as BLOCK_FAILED_VALID; its children
3647 // need to be BLOCK_FAILED_CHILD instead.
3648 to_mark_failed->nStatus = (to_mark_failed->nStatus ^ BLOCK_FAILED_VALID) | BLOCK_FAILED_CHILD;
3649 m_blockman.m_dirty_blockindex.insert(to_mark_failed);
3650 }
3651
3652 // Mark out-of-chain descendants of the invalidated block as invalid
3653 // (possibly replacing a pre-existing BLOCK_FAILED_VALID with BLOCK_FAILED_CHILD)
3654 // Add any equal or more work headers that are not invalidated to setBlockIndexCandidates
3655 // Recalculate m_best_header if it became invalid.
3656 auto candidate_it = highpow_outofchain_headers.lower_bound(invalid_walk_tip->pprev->nChainWork);
3657
3658 const bool best_header_needs_update{m_chainman.m_best_header->GetAncestor(invalid_walk_tip->nHeight) == invalid_walk_tip};
3659 if (best_header_needs_update) {
3660 // pprev is definitely still valid at this point, but there may be better ones
3661 m_chainman.m_best_header = invalid_walk_tip->pprev;
3662 }
3663
3664 while (candidate_it != highpow_outofchain_headers.end()) {
3665 CBlockIndex* candidate{candidate_it->second};
3666 if (candidate->GetAncestor(invalid_walk_tip->nHeight) == invalid_walk_tip) {
3667 // Children of failed blocks should be marked as BLOCK_FAILED_CHILD instead.
3668 candidate->nStatus &= ~BLOCK_FAILED_VALID;
3669 candidate->nStatus |= BLOCK_FAILED_CHILD;
3670 m_blockman.m_dirty_blockindex.insert(candidate);
3671 // If invalidated, the block is irrelevant for setBlockIndexCandidates
3672 // and for m_best_header and can be removed from the cache.
3673 candidate_it = highpow_outofchain_headers.erase(candidate_it);
3674 continue;
3675 }
3676 if (!CBlockIndexWorkComparator()(candidate, invalid_walk_tip->pprev) &&
3677 candidate->IsValid(BLOCK_VALID_TRANSACTIONS) &&
3678 candidate->HaveNumChainTxs()) {
3679 setBlockIndexCandidates.insert(candidate);
3680 // Do not remove candidate from the highpow_outofchain_headers cache, because it might be a descendant of the block being invalidated
3681 // which needs to be marked failed later.
3682 }
3683 if (best_header_needs_update &&
3684 m_chainman.m_best_header->nChainWork < candidate->nChainWork) {
3685 m_chainman.m_best_header = candidate;
3686 }
3687 ++candidate_it;
3688 }
3689
3690 // Track the last disconnected block, so we can correct its BLOCK_FAILED_CHILD status in future
3691 // iterations, or, if it's the last one, call InvalidChainFound on it.
3692 to_mark_failed = invalid_walk_tip;
3693 }
3694
3696
3697 {
3698 LOCK(cs_main);
3699 if (m_chain.Contains(to_mark_failed)) {
3700 // If the to-be-marked invalid block is in the active chain, something is interfering and we can't proceed.
3701 return false;
3702 }
3703
3704 // Mark pindex as invalid if it never was in the main chain
3705 if (!pindex_was_in_chain && !(pindex->nStatus & BLOCK_FAILED_MASK)) {
3706 pindex->nStatus |= BLOCK_FAILED_VALID;
3707 m_blockman.m_dirty_blockindex.insert(pindex);
3708 setBlockIndexCandidates.erase(pindex);
3709 }
3710
3711 // If any new blocks somehow arrived while we were disconnecting
3712 // (above), then the pre-calculation of what should go into
3713 // setBlockIndexCandidates may have missed entries. This would
3714 // technically be an inconsistency in the block index, but if we clean
3715 // it up here, this should be an essentially unobservable error.
3716 // Loop back over all block index entries and add any missing entries
3717 // to setBlockIndexCandidates.
3718 for (auto& [_, block_index] : m_blockman.m_block_index) {
3719 if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && !setBlockIndexCandidates.value_comp()(&block_index, m_chain.Tip())) {
3720 setBlockIndexCandidates.insert(&block_index);
3721 }
3722 }
3723
3724 InvalidChainFound(to_mark_failed);
3725 }
3726
3727 // Only notify about a new block tip if the active chain was modified.
3728 if (pindex_was_in_chain) {
3729 // Ignoring return value for now, this could be changed to bubble up
3730 // kernel::Interrupted value to the caller so the caller could
3731 // distinguish between completed and interrupted operations. It might
3732 // also make sense for the blockTip notification to have an enum
3733 // parameter indicating the source of the tip change so hooks can
3734 // distinguish user-initiated invalidateblock changes from other
3735 // changes.
3738 /*index=*/*to_mark_failed->pprev,
3739 /*verification_progress=*/WITH_LOCK(m_chainman.GetMutex(), return m_chainman.GuessVerificationProgress(to_mark_failed->pprev)));
3740
3741 // Fire ActiveTipChange now for the current chain tip to make sure clients are notified.
3742 // ActivateBestChain may call this as well, but not necessarily.
3745 }
3746 }
3747 return true;
3748}
3749
3750void Chainstate::SetBlockFailureFlags(CBlockIndex* invalid_block)
3751{
3753
3754 for (auto& [_, block_index] : m_blockman.m_block_index) {
3755 if (invalid_block != &block_index && block_index.GetAncestor(invalid_block->nHeight) == invalid_block) {
3756 block_index.nStatus = (block_index.nStatus & ~BLOCK_FAILED_VALID) | BLOCK_FAILED_CHILD;
3757 m_blockman.m_dirty_blockindex.insert(&block_index);
3758 }
3759 }
3760}
3761
3764
3765 int nHeight = pindex->nHeight;
3766
3767 // Remove the invalidity flag from this block and all its descendants and ancestors.
3768 for (auto& [_, block_index] : m_blockman.m_block_index) {
3769 if ((block_index.nStatus & BLOCK_FAILED_MASK) && (block_index.GetAncestor(nHeight) == pindex || pindex->GetAncestor(block_index.nHeight) == &block_index)) {
3770 block_index.nStatus &= ~BLOCK_FAILED_MASK;
3771 m_blockman.m_dirty_blockindex.insert(&block_index);
3772 if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && setBlockIndexCandidates.value_comp()(m_chain.Tip(), &block_index)) {
3773 setBlockIndexCandidates.insert(&block_index);
3774 }
3775 if (&block_index == m_chainman.m_best_invalid) {
3776 // Reset invalid block marker if it was pointing to one of those.
3777 m_chainman.m_best_invalid = nullptr;
3778 }
3779 }
3780 }
3781}
3782
3784{
3786 // The block only is a candidate for the most-work-chain if it has the same
3787 // or more work than our current tip.
3788 if (m_chain.Tip() != nullptr && setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
3789 return;
3790 }
3791
3792 bool is_active_chainstate = this == &m_chainman.ActiveChainstate();
3793 if (is_active_chainstate) {
3794 // The active chainstate should always add entries that have more
3795 // work than the tip.
3796 setBlockIndexCandidates.insert(pindex);
3797 } else if (!m_disabled) {
3798 // For the background chainstate, we only consider connecting blocks
3799 // towards the snapshot base (which can't be nullptr or else we'll
3800 // never make progress).
3801 const CBlockIndex* snapshot_base{Assert(m_chainman.GetSnapshotBaseBlock())};
3802 if (snapshot_base->GetAncestor(pindex->nHeight) == pindex) {
3803 setBlockIndexCandidates.insert(pindex);
3804 }
3805 }
3806}
3807
3810{
3812 pindexNew->nTx = block.vtx.size();
3813 // Typically m_chain_tx_count will be 0 at this point, but it can be nonzero if this
3814 // is a pruned block which is being downloaded again, or if this is an
3815 // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value from the
3816 // snapshot metadata. If the pindex is not the snapshot block and the
3817 // m_chain_tx_count value is not zero, assert that value is actually correct.
3818 auto prev_tx_sum = [](CBlockIndex& block) { return block.nTx + (block.pprev ? block.pprev->m_chain_tx_count : 0); };
3819 if (!Assume(pindexNew->m_chain_tx_count == 0 || pindexNew->m_chain_tx_count == prev_tx_sum(*pindexNew) ||
3820 pindexNew == GetSnapshotBaseBlock())) {
3821 LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
3822 pindexNew->nHeight, pindexNew->m_chain_tx_count, prev_tx_sum(*pindexNew), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3823 pindexNew->m_chain_tx_count = 0;
3824 }
3825 pindexNew->nFile = pos.nFile;
3826 pindexNew->nDataPos = pos.nPos;
3827 pindexNew->nUndoPos = 0;
3828 pindexNew->nStatus |= BLOCK_HAVE_DATA;
3829 if (DeploymentActiveAt(*pindexNew, *this, Consensus::DEPLOYMENT_SEGWIT)) {
3830 pindexNew->nStatus |= BLOCK_OPT_WITNESS;
3831 }
3833 m_blockman.m_dirty_blockindex.insert(pindexNew);
3834
3835 if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
3836 // If pindexNew is the genesis block or all parents are BLOCK_VALID_TRANSACTIONS.
3837 std::deque<CBlockIndex*> queue;
3838 queue.push_back(pindexNew);
3839
3840 // Recursively process any descendant blocks that now may be eligible to be connected.
3841 while (!queue.empty()) {
3842 CBlockIndex *pindex = queue.front();
3843 queue.pop_front();
3844 // Before setting m_chain_tx_count, assert that it is 0 or already set to
3845 // the correct value. This assert will fail after receiving the
3846 // assumeutxo snapshot block if assumeutxo snapshot metadata has an
3847 // incorrect hardcoded AssumeutxoData::m_chain_tx_count value.
3848 if (!Assume(pindex->m_chain_tx_count == 0 || pindex->m_chain_tx_count == prev_tx_sum(*pindex))) {
3849 LogWarning("Internal bug detected: block %d has unexpected m_chain_tx_count %i that should be %i (%s %s). Please report this issue here: %s\n",
3850 pindex->nHeight, pindex->m_chain_tx_count, prev_tx_sum(*pindex), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3851 }
3852 pindex->m_chain_tx_count = prev_tx_sum(*pindex);
3853 pindex->nSequenceId = nBlockSequenceId++;
3854 for (Chainstate *c : GetAll()) {
3855 c->TryAddBlockIndexCandidate(pindex);
3856 }
3857 std::pair<std::multimap<CBlockIndex*, CBlockIndex*>::iterator, std::multimap<CBlockIndex*, CBlockIndex*>::iterator> range = m_blockman.m_blocks_unlinked.equal_range(pindex);
3858 while (range.first != range.second) {
3859 std::multimap<CBlockIndex*, CBlockIndex*>::iterator it = range.first;
3860 queue.push_back(it->second);
3861 range.first++;
3862 m_blockman.m_blocks_unlinked.erase(it);
3863 }
3864 }
3865 } else {
3866 if (pindexNew->pprev && pindexNew->pprev->IsValid(BLOCK_VALID_TREE)) {
3867 m_blockman.m_blocks_unlinked.insert(std::make_pair(pindexNew->pprev, pindexNew));
3868 }
3869 }
3870}
3871
3872static bool CheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW = true)
3873{
3874 // Check proof of work matches claimed amount
3875 if (fCheckPOW && !CheckProofOfWork(block.GetHash(), block.nBits, consensusParams))
3876 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "high-hash", "proof of work failed");
3877
3878 return true;
3879}
3880
3881static bool CheckMerkleRoot(const CBlock& block, BlockValidationState& state)
3882{
3883 if (block.m_checked_merkle_root) return true;
3884
3885 bool mutated;
3886 uint256 merkle_root = BlockMerkleRoot(block, &mutated);
3887 if (block.hashMerkleRoot != merkle_root) {
3888 return state.Invalid(
3890 /*reject_reason=*/"bad-txnmrklroot",
3891 /*debug_message=*/"hashMerkleRoot mismatch");
3892 }
3893
3894 // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
3895 // of transactions in a block without affecting the merkle root of a block,
3896 // while still invalidating it.
3897 if (mutated) {
3898 return state.Invalid(
3900 /*reject_reason=*/"bad-txns-duplicate",
3901 /*debug_message=*/"duplicate transaction");
3902 }
3903
3904 block.m_checked_merkle_root = true;
3905 return true;
3906}
3907
3914static bool CheckWitnessMalleation(const CBlock& block, bool expect_witness_commitment, BlockValidationState& state)
3915{
3916 if (expect_witness_commitment) {
3917 if (block.m_checked_witness_commitment) return true;
3918
3919 int commitpos = GetWitnessCommitmentIndex(block);
3920 if (commitpos != NO_WITNESS_COMMITMENT) {
3921 assert(!block.vtx.empty() && !block.vtx[0]->vin.empty());
3922 const auto& witness_stack{block.vtx[0]->vin[0].scriptWitness.stack};
3923
3924 if (witness_stack.size() != 1 || witness_stack[0].size() != 32) {
3925 return state.Invalid(
3927 /*reject_reason=*/"bad-witness-nonce-size",
3928 /*debug_message=*/strprintf("%s : invalid witness reserved value size", __func__));
3929 }
3930
3931 // The malleation check is ignored; as the transaction tree itself
3932 // already does not permit it, it is impossible to trigger in the
3933 // witness tree.
3934 uint256 hash_witness = BlockWitnessMerkleRoot(block);
3935
3936 CHash256().Write(hash_witness).Write(witness_stack[0]).Finalize(hash_witness);
3937 if (memcmp(hash_witness.begin(), &block.vtx[0]->vout[commitpos].scriptPubKey[6], 32)) {
3938 return state.Invalid(
3940 /*reject_reason=*/"bad-witness-merkle-match",
3941 /*debug_message=*/strprintf("%s : witness merkle commitment mismatch", __func__));
3942 }
3943
3944 block.m_checked_witness_commitment = true;
3945 return true;
3946 }
3947 }
3948
3949 // No witness data is allowed in blocks that don't commit to witness data, as this would otherwise leave room for spam
3950 for (const auto& tx : block.vtx) {
3951 if (tx->HasWitness()) {
3952 return state.Invalid(
3954 /*reject_reason=*/"unexpected-witness",
3955 /*debug_message=*/strprintf("%s : unexpected witness data found", __func__));
3956 }
3957 }
3958
3959 return true;
3960}
3961
3962bool CheckBlock(const CBlock& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
3963{
3964 // These are checks that are independent of context.
3965
3966 if (block.fChecked)
3967 return true;
3968
3969 // Check that the header is valid (particularly PoW). This is mostly
3970 // redundant with the call in AcceptBlockHeader.
3971 if (!CheckBlockHeader(block, state, consensusParams, fCheckPOW))
3972 return false;
3973
3974 // Signet only: check block solution
3975 if (consensusParams.signet_blocks && fCheckPOW && !CheckSignetBlockSolution(block, consensusParams)) {
3976 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-signet-blksig", "signet block signature validation failure");
3977 }
3978
3979 // Check the merkle root.
3980 if (fCheckMerkleRoot && !CheckMerkleRoot(block, state)) {
3981 return false;
3982 }
3983
3984 // All potential-corruption validation must be done before we do any
3985 // transaction validation, as otherwise we may mark the header as invalid
3986 // because we receive the wrong transactions for it.
3987 // Note that witness malleability is checked in ContextualCheckBlock, so no
3988 // checks that use witness data may be performed here.
3989
3990 // Size limits
3992 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-length", "size limits failed");
3993
3994 // First transaction must be coinbase, the rest must not be
3995 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase())
3996 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-missing", "first tx is not coinbase");
3997 for (unsigned int i = 1; i < block.vtx.size(); i++)
3998 if (block.vtx[i]->IsCoinBase())
3999 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-multiple", "more than one coinbase");
4000
4001 // Check transactions
4002 // Must check for duplicate inputs (see CVE-2018-17144)
4003 for (const auto& tx : block.vtx) {
4004 TxValidationState tx_state;
4005 if (!CheckTransaction(*tx, tx_state)) {
4006 // CheckBlock() does context-free validation checks. The only
4007 // possible failures are consensus failures.
4010 strprintf("Transaction check failed (tx hash %s) %s", tx->GetHash().ToString(), tx_state.GetDebugMessage()));
4011 }
4012 }
4013 // This underestimates the number of sigops, because unlike ConnectBlock it
4014 // does not count witness and p2sh sigops.
4015 unsigned int nSigOps = 0;
4016 for (const auto& tx : block.vtx)
4017 {
4018 nSigOps += GetLegacySigOpCount(*tx);
4019 }
4021 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "out-of-bounds SigOpCount");
4022
4023 if (fCheckPOW && fCheckMerkleRoot)
4024 block.fChecked = true;
4025
4026 return true;
4027}
4028
4030{
4031 int commitpos = GetWitnessCommitmentIndex(block);
4032 static const std::vector<unsigned char> nonce(32, 0x00);
4033 if (commitpos != NO_WITNESS_COMMITMENT && DeploymentActiveAfter(pindexPrev, *this, Consensus::DEPLOYMENT_SEGWIT) && !block.vtx[0]->HasWitness()) {
4034 CMutableTransaction tx(*block.vtx[0]);
4035 tx.vin[0].scriptWitness.stack.resize(1);
4036 tx.vin[0].scriptWitness.stack[0] = nonce;
4037 block.vtx[0] = MakeTransactionRef(std::move(tx));
4038 }
4039}
4040
4041std::vector<unsigned char> ChainstateManager::GenerateCoinbaseCommitment(CBlock& block, const CBlockIndex* pindexPrev) const
4042{
4043 std::vector<unsigned char> commitment;
4044 int commitpos = GetWitnessCommitmentIndex(block);
4045 std::vector<unsigned char> ret(32, 0x00);
4046 if (commitpos == NO_WITNESS_COMMITMENT) {
4047 uint256 witnessroot = BlockWitnessMerkleRoot(block);
4048 CHash256().Write(witnessroot).Write(ret).Finalize(witnessroot);
4049 CTxOut out;
4050 out.nValue = 0;
4051 out.scriptPubKey.resize(MINIMUM_WITNESS_COMMITMENT);
4052 out.scriptPubKey[0] = OP_RETURN;
4053 out.scriptPubKey[1] = 0x24;
4054 out.scriptPubKey[2] = 0xaa;
4055 out.scriptPubKey[3] = 0x21;
4056 out.scriptPubKey[4] = 0xa9;
4057 out.scriptPubKey[5] = 0xed;
4058 memcpy(&out.scriptPubKey[6], witnessroot.begin(), 32);
4059 commitment = std::vector<unsigned char>(out.scriptPubKey.begin(), out.scriptPubKey.end());
4060 CMutableTransaction tx(*block.vtx[0]);
4061 tx.vout.push_back(out);
4062 block.vtx[0] = MakeTransactionRef(std::move(tx));
4063 }
4064 UpdateUncommittedBlockStructures(block, pindexPrev);
4065 return commitment;
4066}
4067
4068bool HasValidProofOfWork(const std::vector<CBlockHeader>& headers, const Consensus::Params& consensusParams)
4069{
4070 return std::all_of(headers.cbegin(), headers.cend(),
4071 [&](const auto& header) { return CheckProofOfWork(header.GetHash(), header.nBits, consensusParams);});
4072}
4073
4074bool IsBlockMutated(const CBlock& block, bool check_witness_root)
4075{
4077 if (!CheckMerkleRoot(block, state)) {
4078 LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
4079 return true;
4080 }
4081
4082 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4083 // Consider the block mutated if any transaction is 64 bytes in size (see 3.1
4084 // in "Weaknesses in Bitcoin’s Merkle Root Construction":
4085 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4086 //
4087 // Note: This is not a consensus change as this only applies to blocks that
4088 // don't have a coinbase transaction and would therefore already be invalid.
4089 return std::any_of(block.vtx.begin(), block.vtx.end(),
4090 [](auto& tx) { return GetSerializeSize(TX_NO_WITNESS(tx)) == 64; });
4091 } else {
4092 // Theoretically it is still possible for a block with a 64 byte
4093 // coinbase transaction to be mutated but we neglect that possibility
4094 // here as it requires at least 224 bits of work.
4095 }
4096
4097 if (!CheckWitnessMalleation(block, check_witness_root, state)) {
4098 LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
4099 return true;
4100 }
4101
4102 return false;
4103}
4104
4105arith_uint256 CalculateClaimedHeadersWork(std::span<const CBlockHeader> headers)
4106{
4107 arith_uint256 total_work{0};
4108 for (const CBlockHeader& header : headers) {
4109 CBlockIndex dummy(header);
4110 total_work += GetBlockProof(dummy);
4111 }
4112 return total_work;
4113}
4114
4129{
4131 assert(pindexPrev != nullptr);
4132 const int nHeight = pindexPrev->nHeight + 1;
4133
4134 // Check proof of work
4135 const Consensus::Params& consensusParams = chainman.GetConsensus();
4136 if (block.nBits != GetNextWorkRequired(pindexPrev, &block, consensusParams))
4137 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "bad-diffbits", "incorrect proof of work");
4138
4139 // Check timestamp against prev
4140 if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast())
4141 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-too-old", "block's timestamp is too early");
4142
4143 // Testnet4 and regtest only: Check timestamp against prev for difficulty-adjustment
4144 // blocks to prevent timewarp attacks (see https://github.com/bitcoin/bitcoin/pull/15482).
4145 if (consensusParams.enforce_BIP94) {
4146 // Check timestamp for the first block of each difficulty adjustment
4147 // interval, except the genesis block.
4148 if (nHeight % consensusParams.DifficultyAdjustmentInterval() == 0) {
4149 if (block.GetBlockTime() < pindexPrev->GetBlockTime() - MAX_TIMEWARP) {
4150 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-timewarp-attack", "block's timestamp is too early on diff adjustment block");
4151 }
4152 }
4153 }
4154
4155 // Check timestamp
4156 if (block.Time() > NodeClock::now() + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4157 return state.Invalid(BlockValidationResult::BLOCK_TIME_FUTURE, "time-too-new", "block timestamp too far in the future");
4158 }
4159
4160 // Reject blocks with outdated version
4161 if ((block.nVersion < 2 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB)) ||
4162 (block.nVersion < 3 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_DERSIG)) ||
4163 (block.nVersion < 4 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CLTV))) {
4164 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, strprintf("bad-version(0x%08x)", block.nVersion),
4165 strprintf("rejected nVersion=0x%08x block", block.nVersion));
4166 }
4167
4168 return true;
4169}
4170
4177static bool ContextualCheckBlock(const CBlock& block, BlockValidationState& state, const ChainstateManager& chainman, const CBlockIndex* pindexPrev)
4178{
4179 const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4180
4181 // Enforce BIP113 (Median Time Past).
4182 bool enforce_locktime_median_time_past{false};
4183 if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CSV)) {
4184 assert(pindexPrev != nullptr);
4185 enforce_locktime_median_time_past = true;
4186 }
4187
4188 const int64_t nLockTimeCutoff{enforce_locktime_median_time_past ?
4189 pindexPrev->GetMedianTimePast() :
4190 block.GetBlockTime()};
4191
4192 // Check that all transactions are finalized
4193 for (const auto& tx : block.vtx) {
4194 if (!IsFinalTx(*tx, nHeight, nLockTimeCutoff)) {
4195 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal", "non-final transaction");
4196 }
4197 }
4198
4199 // Enforce rule that the coinbase starts with serialized block height
4201 {
4203 if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
4204 !std::equal(expect.begin(), expect.end(), block.vtx[0]->vin[0].scriptSig.begin())) {
4205 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-height", "block height mismatch in coinbase");
4206 }
4207 }
4208
4209 // Validation for witness commitments.
4210 // * We compute the witness hash (which is the hash including witnesses) of all the block's transactions, except the
4211 // coinbase (where 0x0000....0000 is used instead).
4212 // * The coinbase scriptWitness is a stack of a single 32-byte vector, containing a witness reserved value (unconstrained).
4213 // * We build a merkle tree with all those witness hashes as leaves (similar to the hashMerkleRoot in the block header).
4214 // * There must be at least one output whose scriptPubKey is a single 36-byte push, the first 4 bytes of which are
4215 // {0xaa, 0x21, 0xa9, 0xed}, and the following 32 bytes are SHA256^2(witness root, witness reserved value). In case there are
4216 // multiple, the last one is used.
4217 if (!CheckWitnessMalleation(block, DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_SEGWIT), state)) {
4218 return false;
4219 }
4220
4221 // After the coinbase witness reserved value and commitment are verified,
4222 // we can check if the block weight passes (before we've checked the
4223 // coinbase witness, it would be possible for the weight to be too
4224 // large by filling up the coinbase witness, which doesn't change
4225 // the block hash, so we couldn't mark the block as permanently
4226 // failed).
4227 if (GetBlockWeight(block) > MAX_BLOCK_WEIGHT) {
4228 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-weight", strprintf("%s : weight limit failed", __func__));
4229 }
4230
4231 return true;
4232}
4233
4234bool ChainstateManager::AcceptBlockHeader(const CBlockHeader& block, BlockValidationState& state, CBlockIndex** ppindex, bool min_pow_checked)
4235{
4237
4238 // Check for duplicate
4239 uint256 hash = block.GetHash();
4240 BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4241 if (hash != GetConsensus().hashGenesisBlock) {
4242 if (miSelf != m_blockman.m_block_index.end()) {
4243 // Block header is already known.
4244 CBlockIndex* pindex = &(miSelf->second);
4245 if (ppindex)
4246 *ppindex = pindex;
4247 if (pindex->nStatus & BLOCK_FAILED_MASK) {
4248 LogDebug(BCLog::VALIDATION, "%s: block %s is marked invalid\n", __func__, hash.ToString());
4249 return state.Invalid(BlockValidationResult::BLOCK_CACHED_INVALID, "duplicate-invalid",
4250 strprintf("block %s was previously marked invalid", hash.ToString()));
4251 }
4252 return true;
4253 }
4254
4255 if (!CheckBlockHeader(block, state, GetConsensus())) {
4256 LogDebug(BCLog::VALIDATION, "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
4257 return false;
4258 }
4259
4260 // Get prev block index
4261 CBlockIndex* pindexPrev = nullptr;
4262 BlockMap::iterator mi{m_blockman.m_block_index.find(block.hashPrevBlock)};
4263 if (mi == m_blockman.m_block_index.end()) {
4264 LogDebug(BCLog::VALIDATION, "header %s has prev block not found: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
4265 return state.Invalid(BlockValidationResult::BLOCK_MISSING_PREV, "prev-blk-not-found");
4266 }
4267 pindexPrev = &((*mi).second);
4268 if (pindexPrev->nStatus & BLOCK_FAILED_MASK) {
4269 LogDebug(BCLog::VALIDATION, "header %s has prev block invalid: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
4270 return state.Invalid(BlockValidationResult::BLOCK_INVALID_PREV, "bad-prevblk");
4271 }
4272 if (!ContextualCheckBlockHeader(block, state, m_blockman, *this, pindexPrev)) {
4273 LogDebug(BCLog::VALIDATION, "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
4274 return false;
4275 }
4276 }
4277 if (!min_pow_checked) {
4278 LogDebug(BCLog::VALIDATION, "%s: not adding new block header %s, missing anti-dos proof-of-work validation\n", __func__, hash.ToString());
4279 return state.Invalid(BlockValidationResult::BLOCK_HEADER_LOW_WORK, "too-little-chainwork");
4280 }
4281 CBlockIndex* pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4282
4283 if (ppindex)
4284 *ppindex = pindex;
4285
4286 return true;
4287}
4288
4289// Exposed wrapper for AcceptBlockHeader
4290bool ChainstateManager::ProcessNewBlockHeaders(std::span<const CBlockHeader> headers, bool min_pow_checked, BlockValidationState& state, const CBlockIndex** ppindex)
4291{
4293 {
4294 LOCK(cs_main);
4295 for (const CBlockHeader& header : headers) {
4296 CBlockIndex *pindex = nullptr; // Use a temp pindex instead of ppindex to avoid a const_cast
4297 bool accepted{AcceptBlockHeader(header, state, &pindex, min_pow_checked)};
4299
4300 if (!accepted) {
4301 return false;
4302 }
4303 if (ppindex) {
4304 *ppindex = pindex;
4305 }
4306 }
4307 }
4308 if (NotifyHeaderTip()) {
4309 if (IsInitialBlockDownload() && ppindex && *ppindex) {
4310 const CBlockIndex& last_accepted{**ppindex};
4311 int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) / GetConsensus().PowTargetSpacing()};
4312 blocks_left = std::max<int64_t>(0, blocks_left);
4313 const double progress{100.0 * last_accepted.nHeight / (last_accepted.nHeight + blocks_left)};
4314 LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n", last_accepted.nHeight, progress);
4315 }
4316 }
4317 return true;
4318}
4319
4320void ChainstateManager::ReportHeadersPresync(const arith_uint256& work, int64_t height, int64_t timestamp)
4321{
4323 {
4324 LOCK(GetMutex());
4325 // Don't report headers presync progress if we already have a post-minchainwork header chain.
4326 // This means we lose reporting for potentially legitimate, but unlikely, deep reorgs, but
4327 // prevent attackers that spam low-work headers from filling our logs.
4328 if (m_best_header->nChainWork >= UintToArith256(GetConsensus().nMinimumChainWork)) return;
4329 // Rate limit headers presync updates to 4 per second, as these are not subject to DoS
4330 // protection.
4331 auto now = MockableSteadyClock::now();
4332 if (now < m_last_presync_update + std::chrono::milliseconds{250}) return;
4333 m_last_presync_update = now;
4334 }
4335 bool initial_download = IsInitialBlockDownload();
4336 GetNotifications().headerTip(GetSynchronizationState(initial_download, m_blockman.m_blockfiles_indexed), height, timestamp, /*presync=*/true);
4337 if (initial_download) {
4338 int64_t blocks_left{(NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) / GetConsensus().PowTargetSpacing()};
4339 blocks_left = std::max<int64_t>(0, blocks_left);
4340 const double progress{100.0 * height / (height + blocks_left)};
4341 LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n", height, progress);
4342 }
4343}
4344
4346bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock>& pblock, BlockValidationState& state, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock, bool min_pow_checked)
4347{
4348 const CBlock& block = *pblock;
4349
4350 if (fNewBlock) *fNewBlock = false;
4352
4353 CBlockIndex *pindexDummy = nullptr;
4354 CBlockIndex *&pindex = ppindex ? *ppindex : pindexDummy;
4355
4356 bool accepted_header{AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4358
4359 if (!accepted_header)
4360 return false;
4361
4362 // Check all requested blocks that we do not already have for validity and
4363 // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4364 // measure, unless the blocks have more work than the active chain tip, and
4365 // aren't too far ahead of it, so are likely to be attached soon.
4366 bool fAlreadyHave = pindex->nStatus & BLOCK_HAVE_DATA;
4367 bool fHasMoreOrSameWork = (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4368 // Blocks that are too out-of-order needlessly limit the effectiveness of
4369 // pruning, because pruning will not delete block files that contain any
4370 // blocks which are too close in height to the tip. Apply this test
4371 // regardless of whether pruning is enabled; it should generally be safe to
4372 // not process unrequested blocks.
4373 bool fTooFarAhead{pindex->nHeight > ActiveHeight() + int(MIN_BLOCKS_TO_KEEP)};
4374
4375 // TODO: Decouple this function from the block download logic by removing fRequested
4376 // This requires some new chain data structure to efficiently look up if a
4377 // block is in a chain leading to a candidate for best tip, despite not
4378 // being such a candidate itself.
4379 // Note that this would break the getblockfrompeer RPC
4380
4381 // TODO: deal better with return value and error conditions for duplicate
4382 // and unrequested blocks.
4383 if (fAlreadyHave) return true;
4384 if (!fRequested) { // If we didn't ask for it:
4385 if (pindex->nTx != 0) return true; // This is a previously-processed block that was pruned
4386 if (!fHasMoreOrSameWork) return true; // Don't process less-work chains
4387 if (fTooFarAhead) return true; // Block height is too high
4388
4389 // Protect against DoS attacks from low-work chains.
4390 // If our tip is behind, a peer could try to send us
4391 // low-work blocks on a fake chain that we would never
4392 // request; don't process these.
4393 if (pindex->nChainWork < MinimumChainWork()) return true;
4394 }
4395
4396 const CChainParams& params{GetParams()};
4397
4398 if (!CheckBlock(block, state, params.GetConsensus()) ||
4399 !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
4400 if (Assume(state.IsInvalid())) {
4401 ActiveChainstate().InvalidBlockFound(pindex, state);
4402 }
4403 LogError("%s: %s\n", __func__, state.ToString());
4404 return false;
4405 }
4406
4407 // Header is valid/has work, merkle tree and segwit merkle tree are good...RELAY NOW
4408 // (but if it does not build on our best tip, let the SendMessages loop relay it)
4409 if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev && m_options.signals) {
4410 m_options.signals->NewPoWValidBlock(pindex, pblock);
4411 }
4412
4413 // Write block to history file
4414 if (fNewBlock) *fNewBlock = true;
4415 try {
4416 FlatFilePos blockPos{};
4417 if (dbp) {
4418 blockPos = *dbp;
4419 m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
4420 } else {
4421 blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
4422 if (blockPos.IsNull()) {
4423 state.Error(strprintf("%s: Failed to find position to write new block to disk", __func__));
4424 return false;
4425 }
4426 }
4427 ReceivedBlockTransactions(block, pindex, blockPos);
4428 } catch (const std::runtime_error& e) {
4429 return FatalError(GetNotifications(), state, strprintf(_("System error while saving block to disk: %s"), e.what()));
4430 }
4431
4432 // TODO: FlushStateToDisk() handles flushing of both block and chainstate
4433 // data, so we should move this to ChainstateManager so that we can be more
4434 // intelligent about how we flush.
4435 // For now, since FlushStateMode::NONE is used, all that can happen is that
4436 // the block files may be pruned, so we can just call this on one
4437 // chainstate (particularly if we haven't implemented pruning with
4438 // background validation yet).
4439 ActiveChainstate().FlushStateToDisk(state, FlushStateMode::NONE);
4440
4442
4443 return true;
4444}
4445
4446bool ChainstateManager::ProcessNewBlock(const std::shared_ptr<const CBlock>& block, bool force_processing, bool min_pow_checked, bool* new_block)
4447{
4449
4450 {
4451 CBlockIndex *pindex = nullptr;
4452 if (new_block) *new_block = false;
4454
4455 // CheckBlock() does not support multi-threaded block validation because CBlock::fChecked can cause data race.
4456 // Therefore, the following critical section must include the CheckBlock() call as well.
4457 LOCK(cs_main);
4458
4459 // Skipping AcceptBlock() for CheckBlock() failures means that we will never mark a block as invalid if
4460 // CheckBlock() fails. This is protective against consensus failure if there are any unknown forms of block
4461 // malleability that cause CheckBlock() to fail; see e.g. CVE-2012-2459 and
4462 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html. Because CheckBlock() is
4463 // not very expensive, the anti-DoS benefits of caching failure (of a definitely-invalid block) are not substantial.
4464 bool ret = CheckBlock(*block, state, GetConsensus());
4465 if (ret) {
4466 // Store to disk
4467 ret = AcceptBlock(block, state, &pindex, force_processing, nullptr, new_block, min_pow_checked);
4468 }
4469 if (!ret) {
4470 if (m_options.signals) {
4471 m_options.signals->BlockChecked(block, state);
4472 }
4473 LogError("%s: AcceptBlock FAILED (%s)\n", __func__, state.ToString());
4474 return false;
4475 }
4476 }
4477
4479
4480 BlockValidationState state; // Only used to report errors, not invalidity - ignore it
4481 if (!ActiveChainstate().ActivateBestChain(state, block)) {
4482 LogError("%s: ActivateBestChain failed (%s)\n", __func__, state.ToString());
4483 return false;
4484 }
4485
4486 Chainstate* bg_chain{WITH_LOCK(cs_main, return BackgroundSyncInProgress() ? m_ibd_chainstate.get() : nullptr)};
4487 BlockValidationState bg_state;
4488 if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
4489 LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__, bg_state.ToString());
4490 return false;
4491 }
4492
4493 return true;
4494}
4495
4497{
4499 Chainstate& active_chainstate = ActiveChainstate();
4500 if (!active_chainstate.GetMempool()) {
4501 TxValidationState state;
4502 state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
4503 return MempoolAcceptResult::Failure(state);
4504 }
4505 auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(), /*bypass_limits=*/ false, test_accept);
4506 active_chainstate.GetMempool()->check(active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
4507 return result;
4508}
4509
4510
4512 Chainstate& chainstate,
4513 const CBlock& block,
4514 const bool check_pow,
4515 const bool check_merkle_root)
4516{
4517 // Lock must be held throughout this function for two reasons:
4518 // 1. We don't want the tip to change during several of the validation steps
4519 // 2. To prevent a CheckBlock() race condition for fChecked, see ProcessNewBlock()
4520 AssertLockHeld(chainstate.m_chainman.GetMutex());
4521
4523 CBlockIndex* tip{Assert(chainstate.m_chain.Tip())};
4524
4525 if (block.hashPrevBlock != *Assert(tip->phashBlock)) {
4526 state.Invalid({}, "inconclusive-not-best-prevblk");
4527 return state;
4528 }
4529
4530 // For signets CheckBlock() verifies the challenge iff fCheckPow is set.
4531 if (!CheckBlock(block, state, chainstate.m_chainman.GetConsensus(), /*fCheckPow=*/check_pow, /*fCheckMerkleRoot=*/check_merkle_root)) {
4532 // This should never happen, but belt-and-suspenders don't approve the
4533 // block if it does.
4534 if (state.IsValid()) NONFATAL_UNREACHABLE();
4535 return state;
4536 }
4537
4553 if (!ContextualCheckBlockHeader(block, state, chainstate.m_blockman, chainstate.m_chainman, tip)) {
4554 if (state.IsValid()) NONFATAL_UNREACHABLE();
4555 return state;
4556 }
4557
4558 if (!ContextualCheckBlock(block, state, chainstate.m_chainman, tip)) {
4559 if (state.IsValid()) NONFATAL_UNREACHABLE();
4560 return state;
4561 }
4562
4563 // We don't want ConnectBlock to update the actual chainstate, so create
4564 // a cache on top of it, along with a dummy block index.
4565 CBlockIndex index_dummy{block};
4566 uint256 block_hash(block.GetHash());
4567 index_dummy.pprev = tip;
4568 index_dummy.nHeight = tip->nHeight + 1;
4569 index_dummy.phashBlock = &block_hash;
4570 CCoinsViewCache view_dummy(&chainstate.CoinsTip());
4571
4572 // Set fJustCheck to true in order to update, and not clear, validation caches.
4573 if(!chainstate.ConnectBlock(block, state, &index_dummy, view_dummy, /*fJustCheck=*/true)) {
4574 if (state.IsValid()) NONFATAL_UNREACHABLE();
4575 return state;
4576 }
4577
4578 // Ensure no check returned successfully while also setting an invalid state.
4579 if (!state.IsValid()) NONFATAL_UNREACHABLE();
4580
4581 return state;
4582}
4583
4584/* This function is called from the RPC code for pruneblockchain */
4585void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight)
4586{
4588 if (!active_chainstate.FlushStateToDisk(
4589 state, FlushStateMode::NONE, nManualPruneHeight)) {
4590 LogWarning("Failed to flush state after manual prune (%s)", state.ToString());
4591 }
4592}
4593
4595{
4597 const CCoinsViewCache& coins_cache = CoinsTip();
4598 assert(!coins_cache.GetBestBlock().IsNull()); // Never called when the coins view is empty
4599 CBlockIndex* tip = m_chain.Tip();
4600
4601 if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
4602 return true;
4603 }
4604
4605 // Load pointer to end of best chain
4606 CBlockIndex* pindex = m_blockman.LookupBlockIndex(coins_cache.GetBestBlock());
4607 if (!pindex) {
4608 return false;
4609 }
4610 m_chain.SetTip(*pindex);
4611 tip = m_chain.Tip();
4612
4613 // Make sure our chain tip before shutting down scores better than any other candidate
4614 // to maintain a consistent best tip over reboots in case of a tie.
4615 auto target = tip;
4616 while (target) {
4618 target = target->pprev;
4619 }
4620
4621 // Block index candidates are loaded before the chain tip, so we need to replace this entry
4622 // Otherwise the scoring will be based on the memory address location instead of the nSequenceId
4623 setBlockIndexCandidates.erase(tip);
4626
4627 tip = m_chain.Tip();
4628 LogInfo("Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f",
4629 tip->GetBlockHash().ToString(),
4630 m_chain.Height(),
4633
4634 // Ensure KernelNotifications m_tip_block is set even if no new block arrives.
4635 if (this->GetRole() != ChainstateRole::BACKGROUND) {
4636 // Ignoring return value for now.
4639 /*index=*/*pindex,
4640 /*verification_progress=*/m_chainman.GuessVerificationProgress(tip));
4641 }
4642
4644
4645 return true;
4646}
4647
4649 : m_notifications{notifications}
4650{
4651 m_notifications.progress(_("Verifying blocks…"), 0, false);
4652}
4653
4655{
4656 m_notifications.progress(bilingual_str{}, 100, false);
4657}
4658
4660 Chainstate& chainstate,
4661 const Consensus::Params& consensus_params,
4662 CCoinsView& coinsview,
4663 int nCheckLevel, int nCheckDepth)
4664{
4666
4667 if (chainstate.m_chain.Tip() == nullptr || chainstate.m_chain.Tip()->pprev == nullptr) {
4669 }
4670
4671 // Verify blocks in the best chain
4672 if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
4673 nCheckDepth = chainstate.m_chain.Height();
4674 }
4675 nCheckLevel = std::max(0, std::min(4, nCheckLevel));
4676 LogInfo("Verifying last %i blocks at level %i", nCheckDepth, nCheckLevel);
4677 CCoinsViewCache coins(&coinsview);
4678 CBlockIndex* pindex;
4679 CBlockIndex* pindexFailure = nullptr;
4680 int nGoodTransactions = 0;
4682 int reportDone = 0;
4683 bool skipped_no_block_data{false};
4684 bool skipped_l3_checks{false};
4685 LogInfo("Verification progress: 0%%");
4686
4687 const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
4688
4689 for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev; pindex = pindex->pprev) {
4690 const int percentageDone = std::max(1, std::min(99, (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * (nCheckLevel >= 4 ? 50 : 100))));
4691 if (reportDone < percentageDone / 10) {
4692 // report every 10% step
4693 LogInfo("Verification progress: %d%%", percentageDone);
4694 reportDone = percentageDone / 10;
4695 }
4696 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4697 if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
4698 break;
4699 }
4700 if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
4701 // If pruning or running under an assumeutxo snapshot, only go
4702 // back as far as we have data.
4703 LogInfo("Block verification stopping at height %d (no data). This could be due to pruning or use of an assumeutxo snapshot.", pindex->nHeight);
4704 skipped_no_block_data = true;
4705 break;
4706 }
4707 CBlock block;
4708 // check level 0: read from disk
4709 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4710 LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4712 }
4713 // check level 1: verify block validity
4714 if (nCheckLevel >= 1 && !CheckBlock(block, state, consensus_params)) {
4715 LogError("Verification error: found bad block at %d, hash=%s (%s)",
4716 pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4718 }
4719 // check level 2: verify undo validity
4720 if (nCheckLevel >= 2 && pindex) {
4721 CBlockUndo undo;
4722 if (!pindex->GetUndoPos().IsNull()) {
4723 if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
4724 LogError("Verification error: found bad undo data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4726 }
4727 }
4728 }
4729 // check level 3: check for inconsistencies during memory-only disconnect of tip blocks
4730 size_t curr_coins_usage = coins.DynamicMemoryUsage() + chainstate.CoinsTip().DynamicMemoryUsage();
4731
4732 if (nCheckLevel >= 3) {
4733 if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
4734 assert(coins.GetBestBlock() == pindex->GetBlockHash());
4735 DisconnectResult res = chainstate.DisconnectBlock(block, pindex, coins);
4736 if (res == DISCONNECT_FAILED) {
4737 LogError("Verification error: irrecoverable inconsistency in block data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4739 }
4740 if (res == DISCONNECT_UNCLEAN) {
4741 nGoodTransactions = 0;
4742 pindexFailure = pindex;
4743 } else {
4744 nGoodTransactions += block.vtx.size();
4745 }
4746 } else {
4747 skipped_l3_checks = true;
4748 }
4749 }
4750 if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4751 }
4752 if (pindexFailure) {
4753 LogError("Verification error: coin database inconsistencies found (last %i blocks, %i good transactions before that)", chainstate.m_chain.Height() - pindexFailure->nHeight + 1, nGoodTransactions);
4755 }
4756 if (skipped_l3_checks) {
4757 LogWarning("Skipped verification of level >=3 (insufficient database cache size). Consider increasing -dbcache.");
4758 }
4759
4760 // store block count as we move pindex at check level >= 4
4761 int block_count = chainstate.m_chain.Height() - pindex->nHeight;
4762
4763 // check level 4: try reconnecting blocks
4764 if (nCheckLevel >= 4 && !skipped_l3_checks) {
4765 while (pindex != chainstate.m_chain.Tip()) {
4766 const int percentageDone = std::max(1, std::min(99, 100 - (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * 50)));
4767 if (reportDone < percentageDone / 10) {
4768 // report every 10% step
4769 LogInfo("Verification progress: %d%%", percentageDone);
4770 reportDone = percentageDone / 10;
4771 }
4772 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4773 pindex = chainstate.m_chain.Next(pindex);
4774 CBlock block;
4775 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4776 LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4778 }
4779 if (!chainstate.ConnectBlock(block, state, pindex, coins)) {
4780 LogError("Verification error: found unconnectable block at %d, hash=%s (%s)", pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4782 }
4783 if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4784 }
4785 }
4786
4787 LogInfo("Verification: No coin database inconsistencies in last %i blocks (%i transactions)", block_count, nGoodTransactions);
4788
4789 if (skipped_l3_checks) {
4791 }
4792 if (skipped_no_block_data) {
4794 }
4796}
4797
4800{
4802 // TODO: merge with ConnectBlock
4803 CBlock block;
4804 if (!m_blockman.ReadBlock(block, *pindex)) {
4805 LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n", pindex->nHeight, pindex->GetBlockHash().ToString());
4806 return false;
4807 }
4808
4809 for (const CTransactionRef& tx : block.vtx) {
4810 if (!tx->IsCoinBase()) {
4811 for (const CTxIn &txin : tx->vin) {
4812 inputs.SpendCoin(txin.prevout);
4813 }
4814 }
4815 // Pass check = true as every addition may be an overwrite.
4816 AddCoins(inputs, *tx, pindex->nHeight, true);
4817 }
4818 return true;
4819}
4820
4822{
4823 LOCK(cs_main);
4824
4825 CCoinsView& db = this->CoinsDB();
4826 CCoinsViewCache cache(&db);
4827
4828 std::vector<uint256> hashHeads = db.GetHeadBlocks();
4829 if (hashHeads.empty()) return true; // We're already in a consistent state.
4830 if (hashHeads.size() != 2) {
4831 LogError("ReplayBlocks(): unknown inconsistent state\n");
4832 return false;
4833 }
4834
4835 m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
4836 LogInfo("Replaying blocks");
4837
4838 const CBlockIndex* pindexOld = nullptr; // Old tip during the interrupted flush.
4839 const CBlockIndex* pindexNew; // New tip during the interrupted flush.
4840 const CBlockIndex* pindexFork = nullptr; // Latest block common to both the old and the new tip.
4841
4842 if (m_blockman.m_block_index.count(hashHeads[0]) == 0) {
4843 LogError("ReplayBlocks(): reorganization to unknown block requested\n");
4844 return false;
4845 }
4846 pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
4847
4848 if (!hashHeads[1].IsNull()) { // The old tip is allowed to be 0, indicating it's the first flush.
4849 if (m_blockman.m_block_index.count(hashHeads[1]) == 0) {
4850 LogError("ReplayBlocks(): reorganization from unknown block requested\n");
4851 return false;
4852 }
4853 pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
4854 pindexFork = LastCommonAncestor(pindexOld, pindexNew);
4855 assert(pindexFork != nullptr);
4856 }
4857
4858 // Rollback along the old branch.
4859 const int nForkHeight{pindexFork ? pindexFork->nHeight : 0};
4860 if (pindexOld != pindexFork) {
4861 LogInfo("Rolling back from %s (%i to %i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight, nForkHeight);
4862 while (pindexOld != pindexFork) {
4863 if (pindexOld->nHeight > 0) { // Never disconnect the genesis block.
4864 CBlock block;
4865 if (!m_blockman.ReadBlock(block, *pindexOld)) {
4866 LogError("RollbackBlock(): ReadBlock() failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4867 return false;
4868 }
4869 if (pindexOld->nHeight % 10'000 == 0) {
4870 LogInfo("Rolling back %s (%i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
4871 }
4872 DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
4873 if (res == DISCONNECT_FAILED) {
4874 LogError("RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4875 return false;
4876 }
4877 // If DISCONNECT_UNCLEAN is returned, it means a non-existing UTXO was deleted, or an existing UTXO was
4878 // overwritten. It corresponds to cases where the block-to-be-disconnect never had all its operations
4879 // applied to the UTXO set. However, as both writing a UTXO and deleting a UTXO are idempotent operations,
4880 // the result is still a version of the UTXO set with the effects of that block undone.
4881 }
4882 pindexOld = pindexOld->pprev;
4883 }
4884 LogInfo("Rolled back to %s", pindexFork->GetBlockHash().ToString());
4885 }
4886
4887 // Roll forward from the forking point to the new tip.
4888 if (nForkHeight < pindexNew->nHeight) {
4889 LogInfo("Rolling forward to %s (%i to %i)", pindexNew->GetBlockHash().ToString(), nForkHeight, pindexNew->nHeight);
4890 for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight; ++nHeight) {
4891 const CBlockIndex& pindex{*Assert(pindexNew->GetAncestor(nHeight))};
4892
4893 if (nHeight % 10'000 == 0) {
4894 LogInfo("Rolling forward %s (%i)", pindex.GetBlockHash().ToString(), nHeight);
4895 }
4896 m_chainman.GetNotifications().progress(_("Replaying blocks…"), (int)((nHeight - nForkHeight) * 100.0 / (pindexNew->nHeight - nForkHeight)), false);
4897 if (!RollforwardBlock(&pindex, cache)) return false;
4898 }
4899 LogInfo("Rolled forward to %s", pindexNew->GetBlockHash().ToString());
4900 }
4901
4902 cache.SetBestBlock(pindexNew->GetBlockHash());
4903 cache.Flush(/*will_reuse_cache=*/false); // local CCoinsViewCache goes out of scope
4905 return true;
4906}
4907
4909{
4911
4912 // At and above m_params.SegwitHeight, segwit consensus rules must be validated
4913 CBlockIndex* block{m_chain.Tip()};
4914
4915 while (block != nullptr && DeploymentActiveAt(*block, m_chainman, Consensus::DEPLOYMENT_SEGWIT)) {
4916 if (!(block->nStatus & BLOCK_OPT_WITNESS)) {
4917 // block is insufficiently validated for a segwit client
4918 return true;
4919 }
4920 block = block->pprev;
4921 }
4922
4923 return false;
4924}
4925
4926void Chainstate::ClearBlockIndexCandidates()
4927{
4930}
4931
4933{
4935 // Load block index from databases
4937 bool ret{m_blockman.LoadBlockIndexDB(SnapshotBlockhash())};
4938 if (!ret) return false;
4939
4940 m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
4941
4942 std::vector<CBlockIndex*> vSortedByHeight{m_blockman.GetAllBlockIndices()};
4943 std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
4945
4946 for (CBlockIndex* pindex : vSortedByHeight) {
4947 if (m_interrupt) return false;
4948 // If we have an assumeutxo-based chainstate, then the snapshot
4949 // block will be a candidate for the tip, but it may not be
4950 // VALID_TRANSACTIONS (eg if we haven't yet downloaded the block),
4951 // so we special-case the snapshot block as a potential candidate
4952 // here.
4953 if (pindex == GetSnapshotBaseBlock() ||
4955 (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
4956
4957 for (Chainstate* chainstate : GetAll()) {
4958 chainstate->TryAddBlockIndexCandidate(pindex);
4959 }
4960 }
4961 if (pindex->nStatus & BLOCK_FAILED_MASK && (!m_best_invalid || pindex->nChainWork > m_best_invalid->nChainWork)) {
4962 m_best_invalid = pindex;
4963 }
4964 if (pindex->IsValid(BLOCK_VALID_TREE) && (m_best_header == nullptr || CBlockIndexWorkComparator()(m_best_header, pindex)))
4965 m_best_header = pindex;
4966 }
4967 }
4968 return true;
4969}
4970
4972{
4973 LOCK(cs_main);
4974
4975 const CChainParams& params{m_chainman.GetParams()};
4976
4977 // Check whether we're already initialized by checking for genesis in
4978 // m_blockman.m_block_index. Note that we can't use m_chain here, since it is
4979 // set based on the coins db, not the block index db, which is the only
4980 // thing loaded at this point.
4981 if (m_blockman.m_block_index.count(params.GenesisBlock().GetHash()))
4982 return true;
4983
4984 try {
4985 const CBlock& block = params.GenesisBlock();
4986 FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
4987 if (blockPos.IsNull()) {
4988 LogError("%s: writing genesis block to disk failed\n", __func__);
4989 return false;
4990 }
4991 CBlockIndex* pindex = m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
4992 m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
4993 } catch (const std::runtime_error& e) {
4994 LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
4995 return false;
4996 }
4997
4998 return true;
4999}
5000
5002 AutoFile& file_in,
5003 FlatFilePos* dbp,
5004 std::multimap<uint256, FlatFilePos>* blocks_with_unknown_parent)
5005{
5006 // Either both should be specified (-reindex), or neither (-loadblock).
5007 assert(!dbp == !blocks_with_unknown_parent);
5008
5009 const auto start{SteadyClock::now()};
5010 const CChainParams& params{GetParams()};
5011
5012 int nLoaded = 0;
5013 try {
5015 // nRewind indicates where to resume scanning in case something goes wrong,
5016 // such as a block fails to deserialize.
5017 uint64_t nRewind = blkdat.GetPos();
5018 while (!blkdat.eof()) {
5019 if (m_interrupt) return;
5020
5021 blkdat.SetPos(nRewind);
5022 nRewind++; // start one byte further next time, in case of failure
5023 blkdat.SetLimit(); // remove former limit
5024 unsigned int nSize = 0;
5025 try {
5026 // locate a header
5028 blkdat.FindByte(std::byte(params.MessageStart()[0]));
5029 nRewind = blkdat.GetPos() + 1;
5030 blkdat >> buf;
5031 if (buf != params.MessageStart()) {
5032 continue;
5033 }
5034 // read size
5035 blkdat >> nSize;
5036 if (nSize < 80 || nSize > MAX_BLOCK_SERIALIZED_SIZE)
5037 continue;
5038 } catch (const std::exception&) {
5039 // no valid block header found; don't complain
5040 // (this happens at the end of every blk.dat file)
5041 break;
5042 }
5043 try {
5044 // read block header
5045 const uint64_t nBlockPos{blkdat.GetPos()};
5046 if (dbp)
5047 dbp->nPos = nBlockPos;
5048 blkdat.SetLimit(nBlockPos + nSize);
5049 CBlockHeader header;
5050 blkdat >> header;
5051 const uint256 hash{header.GetHash()};
5052 // Skip the rest of this block (this may read from disk into memory); position to the marker before the
5053 // next block, but it's still possible to rewind to the start of the current block (without a disk read).
5054 nRewind = nBlockPos + nSize;
5055 blkdat.SkipTo(nRewind);
5056
5057 std::shared_ptr<CBlock> pblock{}; // needs to remain available after the cs_main lock is released to avoid duplicate reads from disk
5058
5059 {
5060 LOCK(cs_main);
5061 // detect out of order blocks, and store them for later
5062 if (hash != params.GetConsensus().hashGenesisBlock && !m_blockman.LookupBlockIndex(header.hashPrevBlock)) {
5063 LogDebug(BCLog::REINDEX, "%s: Out of order block %s, parent %s not known\n", __func__, hash.ToString(),
5064 header.hashPrevBlock.ToString());
5065 if (dbp && blocks_with_unknown_parent) {
5066 blocks_with_unknown_parent->emplace(header.hashPrevBlock, *dbp);
5067 }
5068 continue;
5069 }
5070
5071 // process in case the block isn't known yet
5072 const CBlockIndex* pindex = m_blockman.LookupBlockIndex(hash);
5073 if (!pindex || (pindex->nStatus & BLOCK_HAVE_DATA) == 0) {
5074 // This block can be processed immediately; rewind to its start, read and deserialize it.
5075 blkdat.SetPos(nBlockPos);
5076 pblock = std::make_shared<CBlock>();
5077 blkdat >> TX_WITH_WITNESS(*pblock);
5078 nRewind = blkdat.GetPos();
5079
5081 if (AcceptBlock(pblock, state, nullptr, true, dbp, nullptr, true)) {
5082 nLoaded++;
5083 }
5084 if (state.IsError()) {
5085 break;
5086 }
5087 } else if (hash != params.GetConsensus().hashGenesisBlock && pindex->nHeight % 1000 == 0) {
5088 LogDebug(BCLog::REINDEX, "Block Import: already had block %s at height %d\n", hash.ToString(), pindex->nHeight);
5089 }
5090 }
5091
5092 // Activate the genesis block so normal node progress can continue
5093 // During first -reindex, this will only connect Genesis since
5094 // ActivateBestChain only connects blocks which are in the block tree db,
5095 // which only contains blocks whose parents are in it.
5096 // But do this only if genesis isn't activated yet, to avoid connecting many blocks
5097 // without assumevalid in the case of a continuation of a reindex that
5098 // was interrupted by the user.
5099 if (hash == params.GetConsensus().hashGenesisBlock && WITH_LOCK(::cs_main, return ActiveHeight()) == -1) {
5101 if (!ActiveChainstate().ActivateBestChain(state, nullptr)) {
5102 break;
5103 }
5104 }
5105
5107 // must update the tip for pruning to work while importing with -loadblock.
5108 // this is a tradeoff to conserve disk space at the expense of time
5109 // spent updating the tip to be able to prune.
5110 // otherwise, ActivateBestChain won't be called by the import process
5111 // until after all of the block files are loaded. ActivateBestChain can be
5112 // called by concurrent network message processing. but, that is not
5113 // reliable for the purpose of pruning while importing.
5114 bool activation_failure = false;
5115 for (auto c : GetAll()) {
5117 if (!c->ActivateBestChain(state, pblock)) {
5118 LogDebug(BCLog::REINDEX, "failed to activate chain (%s)\n", state.ToString());
5119 activation_failure = true;
5120 break;
5121 }
5122 }
5123 if (activation_failure) {
5124 break;
5125 }
5126 }
5127
5129
5130 if (!blocks_with_unknown_parent) continue;
5131
5132 // Recursively process earlier encountered successors of this block
5133 std::deque<uint256> queue;
5134 queue.push_back(hash);
5135 while (!queue.empty()) {
5136 uint256 head = queue.front();
5137 queue.pop_front();
5138 auto range = blocks_with_unknown_parent->equal_range(head);
5139 while (range.first != range.second) {
5140 std::multimap<uint256, FlatFilePos>::iterator it = range.first;
5141 std::shared_ptr<CBlock> pblockrecursive = std::make_shared<CBlock>();
5142 if (m_blockman.ReadBlock(*pblockrecursive, it->second, {})) {
5143 const auto& block_hash{pblockrecursive->GetHash()};
5144 LogDebug(BCLog::REINDEX, "%s: Processing out of order child %s of %s", __func__, block_hash.ToString(), head.ToString());
5145 LOCK(cs_main);
5147 if (AcceptBlock(pblockrecursive, dummy, nullptr, true, &it->second, nullptr, true)) {
5148 nLoaded++;
5149 queue.push_back(block_hash);
5150 }
5151 }
5152 range.first++;
5153 blocks_with_unknown_parent->erase(it);
5155 }
5156 }
5157 } catch (const std::exception& e) {
5158 // historical bugs added extra data to the block files that does not deserialize cleanly.
5159 // commonly this data is between readable blocks, but it does not really matter. such data is not fatal to the import process.
5160 // the code that reads the block files deals with invalid data by simply ignoring it.
5161 // it continues to search for the next {4 byte magic message start bytes + 4 byte length + block} that does deserialize cleanly
5162 // and passes all of the other block validation checks dealing with POW and the merkle root, etc...
5163 // we merely note with this informational log message when unexpected data is encountered.
5164 // we could also be experiencing a storage system read error, or a read of a previous bad write. these are possible, but
5165 // less likely scenarios. we don't have enough information to tell a difference here.
5166 // the reindex process is not the place to attempt to clean and/or compact the block files. if so desired, a studious node operator
5167 // may use knowledge of the fact that the block files are not entirely pristine in order to prepare a set of pristine, and
5168 // perhaps ordered, block files for later reindexing.
5169 LogDebug(BCLog::REINDEX, "%s: unexpected data at file offset 0x%x - %s. continuing\n", __func__, (nRewind - 1), e.what());
5170 }
5171 }
5172 } catch (const std::runtime_error& e) {
5173 GetNotifications().fatalError(strprintf(_("System error while loading external block file: %s"), e.what()));
5174 }
5175 LogInfo("Loaded %i blocks from external file in %dms", nLoaded, Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
5176}
5177
5179{
5180 // Assert to verify Flatten() has been called.
5181 if (!*Assert(m_options.check_block_index)) return false;
5182 if (FastRandomContext().randrange(*m_options.check_block_index) >= 1) return false;
5183 return true;
5184}
5185
5187{
5188 if (!ShouldCheckBlockIndex()) {
5189 return;
5190 }
5191
5192 LOCK(cs_main);
5193
5194 // During a reindex, we read the genesis block and call CheckBlockIndex before ActivateBestChain,
5195 // so we have the genesis block in m_blockman.m_block_index but no active chain. (A few of the
5196 // tests when iterating the block tree require that m_chain has been initialized.)
5197 if (ActiveChain().Height() < 0) {
5198 assert(m_blockman.m_block_index.size() <= 1);
5199 return;
5200 }
5201
5202 // Build forward-pointing data structure for the entire block tree.
5203 // For performance reasons, indexes of the best header chain are stored in a vector (within CChain).
5204 // All remaining blocks are stored in a multimap.
5205 // The best header chain can differ from the active chain: E.g. its entries may belong to blocks that
5206 // are not yet validated.
5207 CChain best_hdr_chain;
5208 assert(m_best_header);
5209 assert(!(m_best_header->nStatus & BLOCK_FAILED_MASK));
5210 best_hdr_chain.SetTip(*m_best_header);
5211
5212 std::multimap<const CBlockIndex*, const CBlockIndex*> forward;
5213 for (auto& [_, block_index] : m_blockman.m_block_index) {
5214 // Only save indexes in forward that are not part of the best header chain.
5215 if (!best_hdr_chain.Contains(&block_index)) {
5216 // Only genesis, which must be part of the best header chain, can have a nullptr parent.
5217 assert(block_index.pprev);
5218 forward.emplace(block_index.pprev, &block_index);
5219 }
5220 }
5221 assert(forward.size() + best_hdr_chain.Height() + 1 == m_blockman.m_block_index.size());
5222
5223 const CBlockIndex* pindex = best_hdr_chain[0];
5224 assert(pindex);
5225 // Iterate over the entire block tree, using depth-first search.
5226 // Along the way, remember whether there are blocks on the path from genesis
5227 // block being explored which are the first to have certain properties.
5228 size_t nNodes = 0;
5229 int nHeight = 0;
5230 const CBlockIndex* pindexFirstInvalid = nullptr; // Oldest ancestor of pindex which is invalid.
5231 const CBlockIndex* pindexFirstMissing = nullptr; // Oldest ancestor of pindex which does not have BLOCK_HAVE_DATA, since assumeutxo snapshot if used.
5232 const CBlockIndex* pindexFirstNeverProcessed = nullptr; // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot if used.
5233 const CBlockIndex* pindexFirstNotTreeValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE (regardless of being valid or not).
5234 const CBlockIndex* pindexFirstNotTransactionsValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TRANSACTIONS (regardless of being valid or not), since assumeutxo snapshot if used.
5235 const CBlockIndex* pindexFirstNotChainValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_CHAIN (regardless of being valid or not), since assumeutxo snapshot if used.
5236 const CBlockIndex* pindexFirstNotScriptsValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_SCRIPTS (regardless of being valid or not), since assumeutxo snapshot if used.
5237
5238 // After checking an assumeutxo snapshot block, reset pindexFirst pointers
5239 // to earlier blocks that have not been downloaded or validated yet, so
5240 // checks for later blocks can assume the earlier blocks were validated and
5241 // be stricter, testing for more requirements.
5242 const CBlockIndex* snap_base{GetSnapshotBaseBlock()};
5243 const CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{}, *snap_first_nocv{}, *snap_first_nosv{};
5244 auto snap_update_firsts = [&] {
5245 if (pindex == snap_base) {
5246 std::swap(snap_first_missing, pindexFirstMissing);
5247 std::swap(snap_first_notx, pindexFirstNeverProcessed);
5248 std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
5249 std::swap(snap_first_nocv, pindexFirstNotChainValid);
5250 std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
5251 }
5252 };
5253
5254 while (pindex != nullptr) {
5255 nNodes++;
5256 if (pindexFirstInvalid == nullptr && pindex->nStatus & BLOCK_FAILED_VALID) pindexFirstInvalid = pindex;
5257 if (pindexFirstMissing == nullptr && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
5258 pindexFirstMissing = pindex;
5259 }
5260 if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) pindexFirstNeverProcessed = pindex;
5261 if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr && (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TREE) pindexFirstNotTreeValid = pindex;
5262
5263 if (pindex->pprev != nullptr) {
5264 if (pindexFirstNotTransactionsValid == nullptr &&
5265 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TRANSACTIONS) {
5266 pindexFirstNotTransactionsValid = pindex;
5267 }
5268
5269 if (pindexFirstNotChainValid == nullptr &&
5270 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_CHAIN) {
5271 pindexFirstNotChainValid = pindex;
5272 }
5273
5274 if (pindexFirstNotScriptsValid == nullptr &&
5275 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_SCRIPTS) {
5276 pindexFirstNotScriptsValid = pindex;
5277 }
5278 }
5279
5280 // Begin: actual consistency checks.
5281 if (pindex->pprev == nullptr) {
5282 // Genesis block checks.
5283 assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock); // Genesis block's hash must match.
5284 for (const Chainstate* c : {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
5285 if (c && c->m_chain.Genesis() != nullptr) {
5286 assert(pindex == c->m_chain.Genesis()); // The chain's genesis block must be this block.
5287 }
5288 }
5289 }
5290 // nSequenceId can't be set higher than SEQ_ID_INIT_FROM_DISK{1} for blocks that aren't linked
5291 // (negative is used for preciousblock, SEQ_ID_BEST_CHAIN_FROM_DISK{0} for active chain when loaded from disk)
5292 if (!pindex->HaveNumChainTxs()) assert(pindex->nSequenceId <= SEQ_ID_INIT_FROM_DISK);
5293 // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or not pruning has occurred).
5294 // HAVE_DATA is only equivalent to nTx > 0 (or VALID_TRANSACTIONS) if no pruning has occurred.
5296 // If we've never pruned, then HAVE_DATA should be equivalent to nTx > 0
5297 assert(!(pindex->nStatus & BLOCK_HAVE_DATA) == (pindex->nTx == 0));
5298 assert(pindexFirstMissing == pindexFirstNeverProcessed);
5299 } else {
5300 // If we have pruned, then we can only say that HAVE_DATA implies nTx > 0
5301 if (pindex->nStatus & BLOCK_HAVE_DATA) assert(pindex->nTx > 0);
5302 }
5303 if (pindex->nStatus & BLOCK_HAVE_UNDO) assert(pindex->nStatus & BLOCK_HAVE_DATA);
5304 if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
5305 // Assumed-valid blocks should connect to the main chain.
5306 assert((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE);
5307 }
5308 // There should only be an nTx value if we have
5309 // actually seen a block's transactions.
5310 assert(((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TRANSACTIONS) == (pindex->nTx > 0)); // This is pruning-independent.
5311 // All parents having had data (at some point) is equivalent to all parents being VALID_TRANSACTIONS, which is equivalent to HaveNumChainTxs().
5312 // HaveNumChainTxs will also be set in the assumeutxo snapshot block from snapshot metadata.
5313 assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5314 assert((pindexFirstNotTransactionsValid == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5315 assert(pindex->nHeight == nHeight); // nHeight must be consistent.
5316 assert(pindex->pprev == nullptr || pindex->nChainWork >= pindex->pprev->nChainWork); // For every block except the genesis block, the chainwork must be larger than the parent's.
5317 assert(nHeight < 2 || (pindex->pskip && (pindex->pskip->nHeight < nHeight))); // The pskip pointer must point back for all but the first 2 blocks.
5318 assert(pindexFirstNotTreeValid == nullptr); // All m_blockman.m_block_index entries must at least be TREE valid
5319 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE) assert(pindexFirstNotTreeValid == nullptr); // TREE valid implies all parents are TREE valid
5320 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_CHAIN) assert(pindexFirstNotChainValid == nullptr); // CHAIN valid implies all parents are CHAIN valid
5321 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_SCRIPTS) assert(pindexFirstNotScriptsValid == nullptr); // SCRIPTS valid implies all parents are SCRIPTS valid
5322 if (pindexFirstInvalid == nullptr) {
5323 // Checks for not-invalid blocks.
5324 assert((pindex->nStatus & BLOCK_FAILED_MASK) == 0); // The failed mask cannot be set for blocks without invalid parents.
5325 } else {
5326 assert(pindex->nStatus & BLOCK_FAILED_MASK); // Invalid blocks and their descendants must be marked as invalid
5327 }
5328 // Make sure m_chain_tx_count sum is correctly computed.
5329 if (!pindex->pprev) {
5330 // If no previous block, nTx and m_chain_tx_count must be the same.
5331 assert(pindex->m_chain_tx_count == pindex->nTx);
5332 } else if (pindex->pprev->m_chain_tx_count > 0 && pindex->nTx > 0) {
5333 // If previous m_chain_tx_count is set and number of transactions in block is known, sum must be set.
5334 assert(pindex->m_chain_tx_count == pindex->nTx + pindex->pprev->m_chain_tx_count);
5335 } else {
5336 // Otherwise m_chain_tx_count should only be set if this is a snapshot
5337 // block, and must be set if it is.
5338 assert((pindex->m_chain_tx_count != 0) == (pindex == snap_base));
5339 }
5340 // There should be no block with more work than m_best_header, unless it's known to be invalid
5341 assert((pindex->nStatus & BLOCK_FAILED_MASK) || pindex->nChainWork <= m_best_header->nChainWork);
5342
5343 // Chainstate-specific checks on setBlockIndexCandidates
5344 for (const Chainstate* c : {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
5345 if (!c || c->m_chain.Tip() == nullptr) continue;
5346 // Two main factors determine whether pindex is a candidate in
5347 // setBlockIndexCandidates:
5348 //
5349 // - If pindex has less work than the chain tip, it should not be a
5350 // candidate, and this will be asserted below. Otherwise it is a
5351 // potential candidate.
5352 //
5353 // - If pindex or one of its parent blocks back to the genesis block
5354 // or an assumeutxo snapshot never downloaded transactions
5355 // (pindexFirstNeverProcessed is non-null), it should not be a
5356 // candidate, and this will be asserted below. The only exception
5357 // is if pindex itself is an assumeutxo snapshot block. Then it is
5358 // also a potential candidate.
5359 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
5360 // If pindex was detected as invalid (pindexFirstInvalid is
5361 // non-null), it is not required to be in
5362 // setBlockIndexCandidates.
5363 if (pindexFirstInvalid == nullptr) {
5364 // If pindex and all its parents back to the genesis block
5365 // or an assumeutxo snapshot block downloaded transactions,
5366 // and the transactions were not pruned (pindexFirstMissing
5367 // is null), it is a potential candidate. The check
5368 // excludes pruned blocks, because if any blocks were
5369 // pruned between pindex and the current chain tip, pindex will
5370 // only temporarily be added to setBlockIndexCandidates,
5371 // before being moved to m_blocks_unlinked. This check
5372 // could be improved to verify that if all blocks between
5373 // the chain tip and pindex have data, pindex must be a
5374 // candidate.
5375 //
5376 // If pindex is the chain tip, it also is a potential
5377 // candidate.
5378 //
5379 // If the chainstate was loaded from a snapshot and pindex
5380 // is the base of the snapshot, pindex is also a potential
5381 // candidate.
5382 if (pindexFirstMissing == nullptr || pindex == c->m_chain.Tip() || pindex == c->SnapshotBase()) {
5383 // If this chainstate is the active chainstate, pindex
5384 // must be in setBlockIndexCandidates. Otherwise, this
5385 // chainstate is a background validation chainstate, and
5386 // pindex only needs to be added if it is an ancestor of
5387 // the snapshot that is being validated.
5388 if (c == &ActiveChainstate() || snap_base->GetAncestor(pindex->nHeight) == pindex) {
5389 assert(c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex)));
5390 }
5391 }
5392 // If some parent is missing, then it could be that this block was in
5393 // setBlockIndexCandidates but had to be removed because of the missing data.
5394 // In this case it must be in m_blocks_unlinked -- see test below.
5395 }
5396 } else { // If this block sorts worse than the current tip or some ancestor's block has never been seen, it cannot be in setBlockIndexCandidates.
5397 assert(!c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex)));
5398 }
5399 }
5400 // Check whether this block is in m_blocks_unlinked.
5401 auto rangeUnlinked{m_blockman.m_blocks_unlinked.equal_range(pindex->pprev)};
5402 bool foundInUnlinked = false;
5403 while (rangeUnlinked.first != rangeUnlinked.second) {
5404 assert(rangeUnlinked.first->first == pindex->pprev);
5405 if (rangeUnlinked.first->second == pindex) {
5406 foundInUnlinked = true;
5407 break;
5408 }
5409 rangeUnlinked.first++;
5410 }
5411 if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed != nullptr && pindexFirstInvalid == nullptr) {
5412 // If this block has block data available, some parent was never received, and has no invalid parents, it must be in m_blocks_unlinked.
5413 assert(foundInUnlinked);
5414 }
5415 if (!(pindex->nStatus & BLOCK_HAVE_DATA)) assert(!foundInUnlinked); // Can't be in m_blocks_unlinked if we don't HAVE_DATA
5416 if (pindexFirstMissing == nullptr) assert(!foundInUnlinked); // We aren't missing data for any parent -- cannot be in m_blocks_unlinked.
5417 if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed == nullptr && pindexFirstMissing != nullptr) {
5418 // We HAVE_DATA for this block, have received data for all parents at some point, but we're currently missing data for some parent.
5420 // This block may have entered m_blocks_unlinked if:
5421 // - it has a descendant that at some point had more work than the
5422 // tip, and
5423 // - we tried switching to that descendant but were missing
5424 // data for some intermediate block between m_chain and the
5425 // tip.
5426 // So if this block is itself better than any m_chain.Tip() and it wasn't in
5427 // setBlockIndexCandidates, then it must be in m_blocks_unlinked.
5428 for (const Chainstate* c : {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
5429 if (!c) continue;
5430 const bool is_active = c == &ActiveChainstate();
5431 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && !c->setBlockIndexCandidates.contains(const_cast<CBlockIndex*>(pindex))) {
5432 if (pindexFirstInvalid == nullptr) {
5433 if (is_active || snap_base->GetAncestor(pindex->nHeight) == pindex) {
5434 assert(foundInUnlinked);
5435 }
5436 }
5437 }
5438 }
5439 }
5440 // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash()); // Perhaps too slow
5441 // End: actual consistency checks.
5442
5443
5444 // Try descending into the first subnode. Always process forks first and the best header chain after.
5445 snap_update_firsts();
5446 auto range{forward.equal_range(pindex)};
5447 if (range.first != range.second) {
5448 // A subnode not part of the best header chain was found.
5449 pindex = range.first->second;
5450 nHeight++;
5451 continue;
5452 } else if (best_hdr_chain.Contains(pindex)) {
5453 // Descend further into best header chain.
5454 nHeight++;
5455 pindex = best_hdr_chain[nHeight];
5456 if (!pindex) break; // we are finished, since the best header chain is always processed last
5457 continue;
5458 }
5459 // This is a leaf node.
5460 // Move upwards until we reach a node of which we have not yet visited the last child.
5461 while (pindex) {
5462 // We are going to either move to a parent or a sibling of pindex.
5463 snap_update_firsts();
5464 // If pindex was the first with a certain property, unset the corresponding variable.
5465 if (pindex == pindexFirstInvalid) pindexFirstInvalid = nullptr;
5466 if (pindex == pindexFirstMissing) pindexFirstMissing = nullptr;
5467 if (pindex == pindexFirstNeverProcessed) pindexFirstNeverProcessed = nullptr;
5468 if (pindex == pindexFirstNotTreeValid) pindexFirstNotTreeValid = nullptr;
5469 if (pindex == pindexFirstNotTransactionsValid) pindexFirstNotTransactionsValid = nullptr;
5470 if (pindex == pindexFirstNotChainValid) pindexFirstNotChainValid = nullptr;
5471 if (pindex == pindexFirstNotScriptsValid) pindexFirstNotScriptsValid = nullptr;
5472 // Find our parent.
5473 CBlockIndex* pindexPar = pindex->pprev;
5474 // Find which child we just visited.
5475 auto rangePar{forward.equal_range(pindexPar)};
5476 while (rangePar.first->second != pindex) {
5477 assert(rangePar.first != rangePar.second); // Our parent must have at least the node we're coming from as child.
5478 rangePar.first++;
5479 }
5480 // Proceed to the next one.
5481 rangePar.first++;
5482 if (rangePar.first != rangePar.second) {
5483 // Move to a sibling not part of the best header chain.
5484 pindex = rangePar.first->second;
5485 break;
5486 } else if (pindexPar == best_hdr_chain[nHeight - 1]) {
5487 // Move to pindex's sibling on the best-chain, if it has one.
5488 pindex = best_hdr_chain[nHeight];
5489 // There will not be a next block if (and only if) parent block is the best header.
5490 assert((pindex == nullptr) == (pindexPar == best_hdr_chain.Tip()));
5491 break;
5492 } else {
5493 // Move up further.
5494 pindex = pindexPar;
5495 nHeight--;
5496 continue;
5497 }
5498 }
5499 }
5500
5501 // Check that we actually traversed the entire block index.
5502 assert(nNodes == forward.size() + best_hdr_chain.Height() + 1);
5503}
5504
5505std::string Chainstate::ToString()
5506{
5508 CBlockIndex* tip = m_chain.Tip();
5509 return strprintf("Chainstate [%s] @ height %d (%s)",
5510 m_from_snapshot_blockhash ? "snapshot" : "ibd",
5511 tip ? tip->nHeight : -1, tip ? tip->GetBlockHash().ToString() : "null");
5512}
5513
5514bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size)
5515{
5517 if (coinstip_size == m_coinstip_cache_size_bytes &&
5518 coinsdb_size == m_coinsdb_cache_size_bytes) {
5519 // Cache sizes are unchanged, no need to continue.
5520 return true;
5521 }
5522 size_t old_coinstip_size = m_coinstip_cache_size_bytes;
5523 m_coinstip_cache_size_bytes = coinstip_size;
5524 m_coinsdb_cache_size_bytes = coinsdb_size;
5525 CoinsDB().ResizeCache(coinsdb_size);
5526
5527 LogInfo("[%s] resized coinsdb cache to %.1f MiB",
5528 this->ToString(), coinsdb_size * (1.0 / 1024 / 1024));
5529 LogInfo("[%s] resized coinstip cache to %.1f MiB",
5530 this->ToString(), coinstip_size * (1.0 / 1024 / 1024));
5531
5533 bool ret;
5534
5535 if (coinstip_size > old_coinstip_size) {
5536 // Likely no need to flush if cache sizes have grown.
5538 } else {
5539 // Otherwise, flush state to disk and deallocate the in-memory coins map.
5541 }
5542 return ret;
5543}
5544
5546{
5548 const ChainTxData& data{GetParams().TxData()};
5549 if (pindex == nullptr) {
5550 return 0.0;
5551 }
5552
5553 if (pindex->m_chain_tx_count == 0) {
5554 LogDebug(BCLog::VALIDATION, "Block %d has unset m_chain_tx_count. Unable to estimate verification progress.\n", pindex->nHeight);
5555 return 0.0;
5556 }
5557
5558 const int64_t nNow{TicksSinceEpoch<std::chrono::seconds>(NodeClock::now())};
5559 const auto block_time{
5560 (Assume(m_best_header) && std::abs(nNow - pindex->GetBlockTime()) <= Ticks<std::chrono::seconds>(2h) &&
5561 Assume(m_best_header->nHeight >= pindex->nHeight)) ?
5562 // When the header is known to be recent, switch to a height-based
5563 // approach. This ensures the returned value is quantized when
5564 // close to "1.0", because some users expect it to be. This also
5565 // avoids relying too much on the exact miner-set timestamp, which
5566 // may be off.
5567 nNow - (m_best_header->nHeight - pindex->nHeight) * GetConsensus().nPowTargetSpacing :
5568 pindex->GetBlockTime(),
5569 };
5570
5571 double fTxTotal;
5572
5573 if (pindex->m_chain_tx_count <= data.tx_count) {
5574 fTxTotal = data.tx_count + (nNow - data.nTime) * data.dTxRate;
5575 } else {
5576 fTxTotal = pindex->m_chain_tx_count + (nNow - block_time) * data.dTxRate;
5577 }
5578
5579 return std::min<double>(pindex->m_chain_tx_count / fTxTotal, 1.0);
5580}
5581
5582std::optional<uint256> ChainstateManager::SnapshotBlockhash() const
5583{
5584 LOCK(::cs_main);
5585 if (m_active_chainstate && m_active_chainstate->m_from_snapshot_blockhash) {
5586 // If a snapshot chainstate exists, it will always be our active.
5587 return m_active_chainstate->m_from_snapshot_blockhash;
5588 }
5589 return std::nullopt;
5590}
5591
5592std::vector<Chainstate*> ChainstateManager::GetAll()
5593{
5594 LOCK(::cs_main);
5595 std::vector<Chainstate*> out;
5596
5597 for (Chainstate* cs : {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
5598 if (this->IsUsable(cs)) out.push_back(cs);
5599 }
5600
5601 return out;
5602}
5603
5604Chainstate& ChainstateManager::InitializeChainstate(CTxMemPool* mempool)
5605{
5607 assert(!m_ibd_chainstate);
5608 assert(!m_active_chainstate);
5609
5610 m_ibd_chainstate = std::make_unique<Chainstate>(mempool, m_blockman, *this);
5611 m_active_chainstate = m_ibd_chainstate.get();
5612 return *m_active_chainstate;
5613}
5614
5615[[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path db_path, bool is_snapshot)
5617{
5619
5620 if (is_snapshot) {
5621 fs::path base_blockhash_path = db_path / node::SNAPSHOT_BLOCKHASH_FILENAME;
5622
5623 try {
5624 bool existed = fs::remove(base_blockhash_path);
5625 if (!existed) {
5626 LogWarning("[snapshot] snapshot chainstate dir being removed lacks %s file",
5628 }
5629 } catch (const fs::filesystem_error& e) {
5630 LogWarning("[snapshot] failed to remove file %s: %s\n",
5631 fs::PathToString(base_blockhash_path), e.code().message());
5632 }
5633 }
5634
5635 std::string path_str = fs::PathToString(db_path);
5636 LogInfo("Removing leveldb dir at %s\n", path_str);
5637
5638 // We have to destruct before this call leveldb::DB in order to release the db
5639 // lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
5640 const bool destroyed = DestroyDB(path_str);
5641
5642 if (!destroyed) {
5643 LogError("leveldb DestroyDB call failed on %s", path_str);
5644 }
5645
5646 // Datadir should be removed from filesystem; otherwise initialization may detect
5647 // it on subsequent statups and get confused.
5648 //
5649 // If the base_blockhash_path removal above fails in the case of snapshot
5650 // chainstates, this will return false since leveldb won't remove a non-empty
5651 // directory.
5652 return destroyed && !fs::exists(db_path);
5653}
5654
5656 AutoFile& coins_file,
5657 const SnapshotMetadata& metadata,
5658 bool in_memory)
5659{
5660 uint256 base_blockhash = metadata.m_base_blockhash;
5661
5662 if (this->SnapshotBlockhash()) {
5663 return util::Error{Untranslated("Can't activate a snapshot-based chainstate more than once")};
5664 }
5665
5666 CBlockIndex* snapshot_start_block{};
5667
5668 {
5669 LOCK(::cs_main);
5670
5671 if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
5672 auto available_heights = GetParams().GetAvailableSnapshotHeights();
5673 std::string heights_formatted = util::Join(available_heights, ", ", [&](const auto& i) { return util::ToString(i); });
5674 return util::Error{Untranslated(strprintf("assumeutxo block hash in snapshot metadata not recognized (hash: %s). The following snapshot heights are available: %s",
5675 base_blockhash.ToString(),
5676 heights_formatted))};
5677 }
5678
5679 snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
5680 if (!snapshot_start_block) {
5681 return util::Error{Untranslated(strprintf("The base block header (%s) must appear in the headers chain. Make sure all headers are syncing, and call loadtxoutset again",
5682 base_blockhash.ToString()))};
5683 }
5684
5685 bool start_block_invalid = snapshot_start_block->nStatus & BLOCK_FAILED_MASK;
5686 if (start_block_invalid) {
5687 return util::Error{Untranslated(strprintf("The base block header (%s) is part of an invalid chain", base_blockhash.ToString()))};
5688 }
5689
5690 if (!m_best_header || m_best_header->GetAncestor(snapshot_start_block->nHeight) != snapshot_start_block) {
5691 return util::Error{Untranslated("A forked headers-chain with more work than the chain with the snapshot base block header exists. Please proceed to sync without AssumeUtxo.")};
5692 }
5693
5694 auto mempool{m_active_chainstate->GetMempool()};
5695 if (mempool && mempool->size() > 0) {
5696 return util::Error{Untranslated("Can't activate a snapshot when mempool not empty")};
5697 }
5698 }
5699
5700 int64_t current_coinsdb_cache_size{0};
5701 int64_t current_coinstip_cache_size{0};
5702
5703 // Cache percentages to allocate to each chainstate.
5704 //
5705 // These particular percentages don't matter so much since they will only be
5706 // relevant during snapshot activation; caches are rebalanced at the conclusion of
5707 // this function. We want to give (essentially) all available cache capacity to the
5708 // snapshot to aid the bulk load later in this function.
5709 static constexpr double IBD_CACHE_PERC = 0.01;
5710 static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
5711
5712 {
5713 LOCK(::cs_main);
5714 // Resize the coins caches to ensure we're not exceeding memory limits.
5715 //
5716 // Allocate the majority of the cache to the incoming snapshot chainstate, since
5717 // (optimistically) getting to its tip will be the top priority. We'll need to call
5718 // `MaybeRebalanceCaches()` once we're done with this function to ensure
5719 // the right allocation (including the possibility that no snapshot was activated
5720 // and that we should restore the active chainstate caches to their original size).
5721 //
5722 current_coinsdb_cache_size = this->ActiveChainstate().m_coinsdb_cache_size_bytes;
5723 current_coinstip_cache_size = this->ActiveChainstate().m_coinstip_cache_size_bytes;
5724
5725 // Temporarily resize the active coins cache to make room for the newly-created
5726 // snapshot chain.
5727 this->ActiveChainstate().ResizeCoinsCaches(
5728 static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
5729 static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
5730 }
5731
5732 auto snapshot_chainstate = WITH_LOCK(::cs_main,
5733 return std::make_unique<Chainstate>(
5734 /*mempool=*/nullptr, m_blockman, *this, base_blockhash));
5735
5736 {
5737 LOCK(::cs_main);
5738 snapshot_chainstate->InitCoinsDB(
5739 static_cast<size_t>(current_coinsdb_cache_size * SNAPSHOT_CACHE_PERC),
5740 in_memory, false, "chainstate");
5741 snapshot_chainstate->InitCoinsCache(
5742 static_cast<size_t>(current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
5743 }
5744
5745 auto cleanup_bad_snapshot = [&](bilingual_str reason) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
5746 this->MaybeRebalanceCaches();
5747
5748 // PopulateAndValidateSnapshot can return (in error) before the leveldb datadir
5749 // has been created, so only attempt removal if we got that far.
5750 if (auto snapshot_datadir = node::FindSnapshotChainstateDir(m_options.datadir)) {
5751 // We have to destruct leveldb::DB in order to release the db lock, otherwise
5752 // DestroyDB() (in DeleteCoinsDBFromDisk()) will fail. See `leveldb::~DBImpl()`.
5753 // Destructing the chainstate (and so resetting the coinsviews object) does this.
5754 snapshot_chainstate.reset();
5755 bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir, /*is_snapshot=*/true);
5756 if (!removed) {
5757 GetNotifications().fatalError(strprintf(_("Failed to remove snapshot chainstate dir (%s). "
5758 "Manually remove it before restarting.\n"), fs::PathToString(*snapshot_datadir)));
5759 }
5760 }
5761 return util::Error{std::move(reason)};
5762 };
5763
5764 if (auto res{this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file, metadata)}; !res) {
5765 LOCK(::cs_main);
5766 return cleanup_bad_snapshot(Untranslated(strprintf("Population failed: %s", util::ErrorString(res).original)));
5767 }
5768
5769 LOCK(::cs_main); // cs_main required for rest of snapshot activation.
5770
5771 // Do a final check to ensure that the snapshot chainstate is actually a more
5772 // work chain than the active chainstate; a user could have loaded a snapshot
5773 // very late in the IBD process, and we wouldn't want to load a useless chainstate.
5774 if (!CBlockIndexWorkComparator()(ActiveTip(), snapshot_chainstate->m_chain.Tip())) {
5775 return cleanup_bad_snapshot(Untranslated("work does not exceed active chainstate"));
5776 }
5777 // If not in-memory, persist the base blockhash for use during subsequent
5778 // initialization.
5779 if (!in_memory) {
5780 if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
5781 return cleanup_bad_snapshot(Untranslated("could not write base blockhash"));
5782 }
5783 }
5784
5785 assert(!m_snapshot_chainstate);
5786 m_snapshot_chainstate.swap(snapshot_chainstate);
5787 const bool chaintip_loaded = m_snapshot_chainstate->LoadChainTip();
5788 assert(chaintip_loaded);
5789
5790 // Transfer possession of the mempool to the snapshot chainstate.
5791 // Mempool is empty at this point because we're still in IBD.
5792 Assert(m_active_chainstate->m_mempool->size() == 0);
5793 Assert(!m_snapshot_chainstate->m_mempool);
5794 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
5795 m_active_chainstate->m_mempool = nullptr;
5796 m_active_chainstate = m_snapshot_chainstate.get();
5797 m_blockman.m_snapshot_height = this->GetSnapshotBaseHeight();
5798
5799 LogInfo("[snapshot] successfully activated snapshot %s", base_blockhash.ToString());
5800 LogInfo("[snapshot] (%.2f MB)",
5801 m_snapshot_chainstate->CoinsTip().DynamicMemoryUsage() / (1000 * 1000));
5802
5803 this->MaybeRebalanceCaches();
5804 return snapshot_start_block;
5805}
5806
5807static void FlushSnapshotToDisk(CCoinsViewCache& coins_cache, bool snapshot_loaded)
5808{
5810 strprintf("%s (%.2f MB)",
5811 snapshot_loaded ? "saving snapshot chainstate" : "flushing coins cache",
5812 coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
5814
5815 coins_cache.Flush();
5816}
5817
5818struct StopHashingException : public std::exception
5819{
5820 const char* what() const noexcept override
5821 {
5822 return "ComputeUTXOStats interrupted.";
5823 }
5824};
5825
5827{
5828 if (interrupt) throw StopHashingException();
5829}
5830
5832 Chainstate& snapshot_chainstate,
5833 AutoFile& coins_file,
5834 const SnapshotMetadata& metadata)
5835{
5836 // It's okay to release cs_main before we're done using `coins_cache` because we know
5837 // that nothing else will be referencing the newly created snapshot_chainstate yet.
5838 CCoinsViewCache& coins_cache = *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
5839
5840 uint256 base_blockhash = metadata.m_base_blockhash;
5841
5842 CBlockIndex* snapshot_start_block = WITH_LOCK(::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
5843
5844 if (!snapshot_start_block) {
5845 // Needed for ComputeUTXOStats to determine the
5846 // height and to avoid a crash when base_blockhash.IsNull()
5847 return util::Error{Untranslated(strprintf("Did not find snapshot start blockheader %s",
5848 base_blockhash.ToString()))};
5849 }
5850
5851 int base_height = snapshot_start_block->nHeight;
5852 const auto& maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
5853
5854 if (!maybe_au_data) {
5855 return util::Error{Untranslated(strprintf("Assumeutxo height in snapshot metadata not recognized "
5856 "(%d) - refusing to load snapshot", base_height))};
5857 }
5858
5859 const AssumeutxoData& au_data = *maybe_au_data;
5860
5861 // This work comparison is a duplicate check with the one performed later in
5862 // ActivateSnapshot(), but is done so that we avoid doing the long work of staging
5863 // a snapshot that isn't actually usable.
5864 if (WITH_LOCK(::cs_main, return !CBlockIndexWorkComparator()(ActiveTip(), snapshot_start_block))) {
5865 return util::Error{Untranslated("Work does not exceed active chainstate")};
5866 }
5867
5868 const uint64_t coins_count = metadata.m_coins_count;
5869 uint64_t coins_left = metadata.m_coins_count;
5870
5871 LogInfo("[snapshot] loading %d coins from snapshot %s", coins_left, base_blockhash.ToString());
5872 int64_t coins_processed{0};
5873
5874 while (coins_left > 0) {
5875 try {
5876 Txid txid;
5877 coins_file >> txid;
5878 size_t coins_per_txid{0};
5879 coins_per_txid = ReadCompactSize(coins_file);
5880
5881 if (coins_per_txid > coins_left) {
5882 return util::Error{Untranslated("Mismatch in coins count in snapshot metadata and actual snapshot data")};
5883 }
5884
5885 for (size_t i = 0; i < coins_per_txid; i++) {
5886 COutPoint outpoint;
5887 Coin coin;
5888 outpoint.n = static_cast<uint32_t>(ReadCompactSize(coins_file));
5889 outpoint.hash = txid;
5890 coins_file >> coin;
5891 if (coin.nHeight > base_height ||
5892 outpoint.n >= std::numeric_limits<decltype(outpoint.n)>::max() // Avoid integer wrap-around in coinstats.cpp:ApplyHash
5893 ) {
5894 return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins",
5895 coins_count - coins_left))};
5896 }
5897 if (!MoneyRange(coin.out.nValue)) {
5898 return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins - bad tx out value",
5899 coins_count - coins_left))};
5900 }
5901 coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint), std::move(coin));
5902
5903 --coins_left;
5904 ++coins_processed;
5905
5906 if (coins_processed % 1000000 == 0) {
5907 LogInfo("[snapshot] %d coins loaded (%.2f%%, %.2f MB)",
5908 coins_processed,
5909 static_cast<float>(coins_processed) * 100 / static_cast<float>(coins_count),
5910 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5911 }
5912
5913 // Batch write and flush (if we need to) every so often.
5914 //
5915 // If our average Coin size is roughly 41 bytes, checking every 120,000 coins
5916 // means <5MB of memory imprecision.
5917 if (coins_processed % 120000 == 0) {
5918 if (m_interrupt) {
5919 return util::Error{Untranslated("Aborting after an interrupt was requested")};
5920 }
5921
5922 const auto snapshot_cache_state = WITH_LOCK(::cs_main,
5923 return snapshot_chainstate.GetCoinsCacheSizeState());
5924
5925 if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
5926 // This is a hack - we don't know what the actual best block is, but that
5927 // doesn't matter for the purposes of flushing the cache here. We'll set this
5928 // to its correct value (`base_blockhash`) below after the coins are loaded.
5929 coins_cache.SetBestBlock(GetRandHash());
5930
5931 // No need to acquire cs_main since this chainstate isn't being used yet.
5932 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/false);
5933 }
5934 }
5935 }
5936 } catch (const std::ios_base::failure&) {
5937 return util::Error{Untranslated(strprintf("Bad snapshot format or truncated snapshot after deserializing %d coins",
5938 coins_processed))};
5939 }
5940 }
5941
5942 // Important that we set this. This and the coins_cache accesses above are
5943 // sort of a layer violation, but either we reach into the innards of
5944 // CCoinsViewCache here or we have to invert some of the Chainstate to
5945 // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
5946 // method.
5947 coins_cache.SetBestBlock(base_blockhash);
5948
5949 bool out_of_coins{false};
5950 try {
5951 std::byte left_over_byte;
5952 coins_file >> left_over_byte;
5953 } catch (const std::ios_base::failure&) {
5954 // We expect an exception since we should be out of coins.
5955 out_of_coins = true;
5956 }
5957 if (!out_of_coins) {
5958 return util::Error{Untranslated(strprintf("Bad snapshot - coins left over after deserializing %d coins",
5959 coins_count))};
5960 }
5961
5962 LogInfo("[snapshot] loaded %d (%.2f MB) coins from snapshot %s",
5963 coins_count,
5964 coins_cache.DynamicMemoryUsage() / (1000 * 1000),
5965 base_blockhash.ToString());
5966
5967 // No need to acquire cs_main since this chainstate isn't being used yet.
5968 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
5969
5970 assert(coins_cache.GetBestBlock() == base_blockhash);
5971
5972 // As above, okay to immediately release cs_main here since no other context knows
5973 // about the snapshot_chainstate.
5974 CCoinsViewDB* snapshot_coinsdb = WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
5975
5976 std::optional<CCoinsStats> maybe_stats;
5977
5978 try {
5979 maybe_stats = ComputeUTXOStats(
5980 CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman, [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
5981 } catch (StopHashingException const&) {
5982 return util::Error{Untranslated("Aborting after an interrupt was requested")};
5983 }
5984 if (!maybe_stats.has_value()) {
5985 return util::Error{Untranslated("Failed to generate coins stats")};
5986 }
5987
5988 // Assert that the deserialized chainstate contents match the expected assumeutxo value.
5989 if (AssumeutxoHash{maybe_stats->hashSerialized} != au_data.hash_serialized) {
5990 return util::Error{Untranslated(strprintf("Bad snapshot content hash: expected %s, got %s",
5991 au_data.hash_serialized.ToString(), maybe_stats->hashSerialized.ToString()))};
5992 }
5993
5994 snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
5995
5996 // The remainder of this function requires modifying data protected by cs_main.
5997 LOCK(::cs_main);
5998
5999 // Fake various pieces of CBlockIndex state:
6000 CBlockIndex* index = nullptr;
6001
6002 // Don't make any modifications to the genesis block since it shouldn't be
6003 // necessary, and since the genesis block doesn't have normal flags like
6004 // BLOCK_VALID_SCRIPTS set.
6005 constexpr int AFTER_GENESIS_START{1};
6006
6007 for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height(); ++i) {
6008 index = snapshot_chainstate.m_chain[i];
6009
6010 // Fake BLOCK_OPT_WITNESS so that Chainstate::NeedsRedownload()
6011 // won't ask for -reindex on startup.
6013 index->nStatus |= BLOCK_OPT_WITNESS;
6014 }
6015
6016 m_blockman.m_dirty_blockindex.insert(index);
6017 // Changes to the block index will be flushed to disk after this call
6018 // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
6019 // called, since we've added a snapshot chainstate and therefore will
6020 // have to downsize the IBD chainstate, which will result in a call to
6021 // `FlushStateToDisk(ALWAYS)`.
6022 }
6023
6024 assert(index);
6025 assert(index == snapshot_start_block);
6026 index->m_chain_tx_count = au_data.m_chain_tx_count;
6027 snapshot_chainstate.setBlockIndexCandidates.insert(snapshot_start_block);
6028
6029 LogInfo("[snapshot] validated snapshot (%.2f MB)",
6030 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
6031 return {};
6032}
6033
6034// Currently, this function holds cs_main for its duration, which could be for
6035// multiple minutes due to the ComputeUTXOStats call. This hold is necessary
6036// because we need to avoid advancing the background validation chainstate
6037// farther than the snapshot base block - and this function is also invoked
6038// from within ConnectTip, i.e. from within ActivateBestChain, so cs_main is
6039// held anyway.
6040//
6041// Eventually (TODO), we could somehow separate this function's runtime from
6042// maintenance of the active chain, but that will either require
6043//
6044// (i) setting `m_disabled` immediately and ensuring all chainstate accesses go
6045// through IsUsable() checks, or
6046//
6047// (ii) giving each chainstate its own lock instead of using cs_main for everything.
6048SnapshotCompletionResult ChainstateManager::MaybeCompleteSnapshotValidation()
6049{
6051 if (m_ibd_chainstate.get() == &this->ActiveChainstate() ||
6052 !this->IsUsable(m_snapshot_chainstate.get()) ||
6053 !this->IsUsable(m_ibd_chainstate.get()) ||
6054 !m_ibd_chainstate->m_chain.Tip()) {
6055 // Nothing to do - this function only applies to the background
6056 // validation chainstate.
6058 }
6059 const int snapshot_tip_height = this->ActiveHeight();
6060 const int snapshot_base_height = *Assert(this->GetSnapshotBaseHeight());
6061 const CBlockIndex& index_new = *Assert(m_ibd_chainstate->m_chain.Tip());
6062
6063 if (index_new.nHeight < snapshot_base_height) {
6064 // Background IBD not complete yet.
6066 }
6067
6069 uint256 snapshot_blockhash = *Assert(SnapshotBlockhash());
6070
6071 auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
6072 bilingual_str user_error = strprintf(_(
6073 "%s failed to validate the -assumeutxo snapshot state. "
6074 "This indicates a hardware problem, or a bug in the software, or a "
6075 "bad software modification that allowed an invalid snapshot to be "
6076 "loaded. As a result of this, the node will shut down and stop using any "
6077 "state that was built on the snapshot, resetting the chain height "
6078 "from %d to %d. On the next "
6079 "restart, the node will resume syncing from %d "
6080 "without using any snapshot data. "
6081 "Please report this incident to %s, including how you obtained the snapshot. "
6082 "The invalid snapshot chainstate will be left on disk in case it is "
6083 "helpful in diagnosing the issue that caused this error."),
6084 CLIENT_NAME, snapshot_tip_height, snapshot_base_height, snapshot_base_height, CLIENT_BUGREPORT
6085 );
6086
6087 LogError("[snapshot] !!! %s\n", user_error.original);
6088 LogError("[snapshot] deleting snapshot, reverting to validated chain, and stopping node\n");
6089
6090 m_active_chainstate = m_ibd_chainstate.get();
6091 m_snapshot_chainstate->m_disabled = true;
6092 assert(!this->IsUsable(m_snapshot_chainstate.get()));
6093 assert(this->IsUsable(m_ibd_chainstate.get()));
6094
6095 auto rename_result = m_snapshot_chainstate->InvalidateCoinsDBOnDisk();
6096 if (!rename_result) {
6097 user_error += Untranslated("\n") + util::ErrorString(rename_result);
6098 }
6099
6100 GetNotifications().fatalError(user_error);
6101 };
6102
6103 if (index_new.GetBlockHash() != snapshot_blockhash) {
6104 LogWarning("[snapshot] supposed base block %s does not match the "
6105 "snapshot base block %s (height %d). Snapshot is not valid.",
6106 index_new.ToString(), snapshot_blockhash.ToString(), snapshot_base_height);
6107 handle_invalid_snapshot();
6109 }
6110
6111 assert(index_new.nHeight == snapshot_base_height);
6112
6113 int curr_height = m_ibd_chainstate->m_chain.Height();
6114
6115 assert(snapshot_base_height == curr_height);
6116 assert(snapshot_base_height == index_new.nHeight);
6117 assert(this->IsUsable(m_snapshot_chainstate.get()));
6118 assert(this->GetAll().size() == 2);
6119
6120 CCoinsViewDB& ibd_coins_db = m_ibd_chainstate->CoinsDB();
6121 m_ibd_chainstate->ForceFlushStateToDisk();
6122
6123 const auto& maybe_au_data = m_options.chainparams.AssumeutxoForHeight(curr_height);
6124 if (!maybe_au_data) {
6125 LogWarning("[snapshot] assumeutxo data not found for height "
6126 "(%d) - refusing to validate snapshot", curr_height);
6127 handle_invalid_snapshot();
6129 }
6130
6131 const AssumeutxoData& au_data = *maybe_au_data;
6132 std::optional<CCoinsStats> maybe_ibd_stats;
6133 LogInfo("[snapshot] computing UTXO stats for background chainstate to validate "
6134 "snapshot - this could take a few minutes");
6135 try {
6136 maybe_ibd_stats = ComputeUTXOStats(
6137 CoinStatsHashType::HASH_SERIALIZED,
6138 &ibd_coins_db,
6139 m_blockman,
6140 [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
6141 } catch (StopHashingException const&) {
6143 }
6144
6145 // XXX note that this function is slow and will hold cs_main for potentially minutes.
6146 if (!maybe_ibd_stats) {
6147 LogWarning("[snapshot] failed to generate stats for validation coins db");
6148 // While this isn't a problem with the snapshot per se, this condition
6149 // prevents us from validating the snapshot, so we should shut down and let the
6150 // user handle the issue manually.
6151 handle_invalid_snapshot();
6153 }
6154 const auto& ibd_stats = *maybe_ibd_stats;
6155
6156 // Compare the background validation chainstate's UTXO set hash against the hard-coded
6157 // assumeutxo hash we expect.
6158 //
6159 // TODO: For belt-and-suspenders, we could cache the UTXO set
6160 // hash for the snapshot when it's loaded in its chainstate's leveldb. We could then
6161 // reference that here for an additional check.
6162 if (AssumeutxoHash{ibd_stats.hashSerialized} != au_data.hash_serialized) {
6163 LogWarning("[snapshot] hash mismatch: actual=%s, expected=%s",
6164 ibd_stats.hashSerialized.ToString(),
6165 au_data.hash_serialized.ToString());
6166 handle_invalid_snapshot();
6168 }
6169
6170 LogInfo("[snapshot] snapshot beginning at %s has been fully validated",
6171 snapshot_blockhash.ToString());
6172
6173 m_ibd_chainstate->m_disabled = true;
6174 this->MaybeRebalanceCaches();
6175
6177}
6178
6180{
6181 LOCK(::cs_main);
6182 assert(m_active_chainstate);
6183 return *m_active_chainstate;
6184}
6185
6187{
6188 LOCK(::cs_main);
6189 return m_snapshot_chainstate && m_active_chainstate == m_snapshot_chainstate.get();
6190}
6191
6192void ChainstateManager::MaybeRebalanceCaches()
6193{
6195 bool ibd_usable = this->IsUsable(m_ibd_chainstate.get());
6196 bool snapshot_usable = this->IsUsable(m_snapshot_chainstate.get());
6197 assert(ibd_usable || snapshot_usable);
6198
6199 if (ibd_usable && !snapshot_usable) {
6200 // Allocate everything to the IBD chainstate. This will always happen
6201 // when we are not using a snapshot.
6202 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6203 }
6204 else if (snapshot_usable && !ibd_usable) {
6205 // If background validation has completed and snapshot is our active chain...
6206 LogInfo("[snapshot] allocating all cache to the snapshot chainstate");
6207 // Allocate everything to the snapshot chainstate.
6208 m_snapshot_chainstate->ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6209 }
6210 else if (ibd_usable && snapshot_usable) {
6211 // If both chainstates exist, determine who needs more cache based on IBD status.
6212 //
6213 // Note: shrink caches first so that we don't inadvertently overwhelm available memory.
6214 if (IsInitialBlockDownload()) {
6215 m_ibd_chainstate->ResizeCoinsCaches(
6217 m_snapshot_chainstate->ResizeCoinsCaches(
6219 } else {
6220 m_snapshot_chainstate->ResizeCoinsCaches(
6222 m_ibd_chainstate->ResizeCoinsCaches(
6224 }
6225 }
6226}
6227
6228void ChainstateManager::ResetChainstates()
6229{
6230 m_ibd_chainstate.reset();
6231 m_snapshot_chainstate.reset();
6232 m_active_chainstate = nullptr;
6233}
6234
6241{
6242 if (!opts.check_block_index.has_value()) opts.check_block_index = opts.chainparams.DefaultConsistencyChecks();
6243 if (!opts.minimum_chain_work.has_value()) opts.minimum_chain_work = UintToArith256(opts.chainparams.GetConsensus().nMinimumChainWork);
6244 if (!opts.assumed_valid_block.has_value()) opts.assumed_valid_block = opts.chainparams.GetConsensus().defaultAssumeValid;
6245 return std::move(opts);
6246}
6247
6249 : m_script_check_queue{/*batch_size=*/128, std::clamp(options.worker_threads_num, 0, MAX_SCRIPTCHECK_THREADS)},
6250 m_interrupt{interrupt},
6251 m_options{Flatten(std::move(options))},
6252 m_blockman{interrupt, std::move(blockman_options)},
6253 m_validation_cache{m_options.script_execution_cache_bytes, m_options.signature_cache_bytes}
6254{
6255}
6256
6258{
6259 LOCK(::cs_main);
6260
6262}
6263
6264bool ChainstateManager::DetectSnapshotChainstate()
6265{
6266 assert(!m_snapshot_chainstate);
6267 std::optional<fs::path> path = node::FindSnapshotChainstateDir(m_options.datadir);
6268 if (!path) {
6269 return false;
6270 }
6271 std::optional<uint256> base_blockhash = node::ReadSnapshotBaseBlockhash(*path);
6272 if (!base_blockhash) {
6273 return false;
6274 }
6275 LogInfo("[snapshot] detected active snapshot chainstate (%s) - loading",
6276 fs::PathToString(*path));
6277
6278 this->ActivateExistingSnapshot(*base_blockhash);
6279 return true;
6280}
6281
6282Chainstate& ChainstateManager::ActivateExistingSnapshot(uint256 base_blockhash)
6283{
6284 assert(!m_snapshot_chainstate);
6285 m_snapshot_chainstate =
6286 std::make_unique<Chainstate>(nullptr, m_blockman, *this, base_blockhash);
6287 LogInfo("[snapshot] switching active chainstate to %s", m_snapshot_chainstate->ToString());
6288
6289 // Mempool is empty at this point because we're still in IBD.
6290 Assert(m_active_chainstate->m_mempool->size() == 0);
6291 Assert(!m_snapshot_chainstate->m_mempool);
6292 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
6293 m_active_chainstate->m_mempool = nullptr;
6294 m_active_chainstate = m_snapshot_chainstate.get();
6295 return *m_snapshot_chainstate;
6296}
6297
6298bool IsBIP30Repeat(const CBlockIndex& block_index)
6299{
6300 return (block_index.nHeight==91842 && block_index.GetBlockHash() == uint256{"00000000000a4d0a398161ffc163c503763b1f4360639393e0e4c8e300e0caec"}) ||
6301 (block_index.nHeight==91880 && block_index.GetBlockHash() == uint256{"00000000000743f190a18c5577a3c2d2a1f610ae9601ac046a38084ccb7cd721"});
6302}
6303
6304bool IsBIP30Unspendable(const uint256& block_hash, int block_height)
6305{
6306 return (block_height==91722 && block_hash == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
6307 (block_height==91812 && block_hash == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"});
6308}
6309
6311{
6313 // Should never be called on a non-snapshot chainstate.
6314 assert(cs.m_from_snapshot_blockhash);
6315 auto storage_path_maybe = cs.CoinsDB().StoragePath();
6316 // Should never be called with a non-existent storage path.
6317 assert(storage_path_maybe);
6318 return *storage_path_maybe;
6319}
6320
6321util::Result<void> Chainstate::InvalidateCoinsDBOnDisk()
6322{
6323 fs::path snapshot_datadir = GetSnapshotCoinsDBPath(*this);
6324
6325 // Coins views no longer usable.
6326 m_coins_views.reset();
6327
6328 auto invalid_path = snapshot_datadir + "_INVALID";
6329 std::string dbpath = fs::PathToString(snapshot_datadir);
6330 std::string target = fs::PathToString(invalid_path);
6331 LogInfo("[snapshot] renaming snapshot datadir %s to %s", dbpath, target);
6332
6333 // The invalid snapshot datadir is simply moved and not deleted because we may
6334 // want to do forensics later during issue investigation. The user is instructed
6335 // accordingly in MaybeCompleteSnapshotValidation().
6336 try {
6337 fs::rename(snapshot_datadir, invalid_path);
6338 } catch (const fs::filesystem_error& e) {
6339 auto src_str = fs::PathToString(snapshot_datadir);
6340 auto dest_str = fs::PathToString(invalid_path);
6341
6342 LogError("While invalidating the coins db: Error renaming file '%s' -> '%s': %s",
6343 src_str, dest_str, e.what());
6344 return util::Error{strprintf(_(
6345 "Rename of '%s' -> '%s' failed. "
6346 "You should resolve this by manually moving or deleting the invalid "
6347 "snapshot directory %s, otherwise you will encounter the same error again "
6348 "on the next startup."),
6349 src_str, dest_str, src_str)};
6350 }
6351 return {};
6352}
6353
6354bool ChainstateManager::DeleteSnapshotChainstate()
6355{
6357 Assert(m_snapshot_chainstate);
6358 Assert(m_ibd_chainstate);
6359
6360 fs::path snapshot_datadir = Assert(node::FindSnapshotChainstateDir(m_options.datadir)).value();
6361 if (!DeleteCoinsDBFromDisk(snapshot_datadir, /*is_snapshot=*/ true)) {
6362 LogError("Deletion of %s failed. Please remove it manually to continue reindexing.",
6363 fs::PathToString(snapshot_datadir));
6364 return false;
6365 }
6366 m_active_chainstate = m_ibd_chainstate.get();
6367 m_active_chainstate->m_mempool = m_snapshot_chainstate->m_mempool;
6368 m_snapshot_chainstate.reset();
6369 return true;
6370}
6371
6372ChainstateRole Chainstate::GetRole() const
6373{
6374 if (m_chainman.GetAll().size() <= 1) {
6376 }
6377 return (this != &m_chainman.ActiveChainstate()) ?
6380}
6381
6382const CBlockIndex* ChainstateManager::GetSnapshotBaseBlock() const
6383{
6384 return m_active_chainstate ? m_active_chainstate->SnapshotBase() : nullptr;
6385}
6386
6387std::optional<int> ChainstateManager::GetSnapshotBaseHeight() const
6388{
6389 const CBlockIndex* base = this->GetSnapshotBaseBlock();
6390 return base ? std::make_optional(base->nHeight) : std::nullopt;
6391}
6392
6393void ChainstateManager::RecalculateBestHeader()
6394{
6396 m_best_header = ActiveChain().Tip();
6397 for (auto& entry : m_blockman.m_block_index) {
6398 if (!(entry.second.nStatus & BLOCK_FAILED_MASK) && m_best_header->nChainWork < entry.second.nChainWork) {
6399 m_best_header = &entry.second;
6400 }
6401 }
6402}
6403
6404bool ChainstateManager::ValidatedSnapshotCleanup()
6405{
6407 auto get_storage_path = [](auto& chainstate) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) -> std::optional<fs::path> {
6408 if (!(chainstate && chainstate->HasCoinsViews())) {
6409 return {};
6410 }
6411 return chainstate->CoinsDB().StoragePath();
6412 };
6413 std::optional<fs::path> ibd_chainstate_path_maybe = get_storage_path(m_ibd_chainstate);
6414 std::optional<fs::path> snapshot_chainstate_path_maybe = get_storage_path(m_snapshot_chainstate);
6415
6416 if (!this->IsSnapshotValidated()) {
6417 // No need to clean up.
6418 return false;
6419 }
6420 // If either path doesn't exist, that means at least one of the chainstates
6421 // is in-memory, in which case we can't do on-disk cleanup. You'd better be
6422 // in a unittest!
6423 if (!ibd_chainstate_path_maybe || !snapshot_chainstate_path_maybe) {
6424 LogError("[snapshot] snapshot chainstate cleanup cannot happen with "
6425 "in-memory chainstates. You are testing, right?");
6426 return false;
6427 }
6428
6429 const auto& snapshot_chainstate_path = *snapshot_chainstate_path_maybe;
6430 const auto& ibd_chainstate_path = *ibd_chainstate_path_maybe;
6431
6432 // Since we're going to be moving around the underlying leveldb filesystem content
6433 // for each chainstate, make sure that the chainstates (and their constituent
6434 // CoinsViews members) have been destructed first.
6435 //
6436 // The caller of this method will be responsible for reinitializing chainstates
6437 // if they want to continue operation.
6438 this->ResetChainstates();
6439
6440 // No chainstates should be considered usable.
6441 assert(this->GetAll().size() == 0);
6442
6443 LogInfo("[snapshot] deleting background chainstate directory (now unnecessary) (%s)",
6444 fs::PathToString(ibd_chainstate_path));
6445
6446 fs::path tmp_old{ibd_chainstate_path + "_todelete"};
6447
6448 auto rename_failed_abort = [this](
6449 fs::path p_old,
6450 fs::path p_new,
6451 const fs::filesystem_error& err) {
6452 LogError("[snapshot] Error renaming path (%s) -> (%s): %s\n",
6453 fs::PathToString(p_old), fs::PathToString(p_new), err.what());
6455 "Rename of '%s' -> '%s' failed. "
6456 "Cannot clean up the background chainstate leveldb directory."),
6457 fs::PathToString(p_old), fs::PathToString(p_new)));
6458 };
6459
6460 try {
6461 fs::rename(ibd_chainstate_path, tmp_old);
6462 } catch (const fs::filesystem_error& e) {
6463 rename_failed_abort(ibd_chainstate_path, tmp_old, e);
6464 throw;
6465 }
6466
6467 LogInfo("[snapshot] moving snapshot chainstate (%s) to "
6468 "default chainstate directory (%s)",
6469 fs::PathToString(snapshot_chainstate_path), fs::PathToString(ibd_chainstate_path));
6470
6471 try {
6472 fs::rename(snapshot_chainstate_path, ibd_chainstate_path);
6473 } catch (const fs::filesystem_error& e) {
6474 rename_failed_abort(snapshot_chainstate_path, ibd_chainstate_path, e);
6475 throw;
6476 }
6477
6478 if (!DeleteCoinsDBFromDisk(tmp_old, /*is_snapshot=*/false)) {
6479 // No need to FatalError because once the unneeded bg chainstate data is
6480 // moved, it will not interfere with subsequent initialization.
6481 LogWarning("Deletion of %s failed. Please remove it manually, as the "
6482 "directory is now unnecessary.",
6483 fs::PathToString(tmp_old));
6484 } else {
6485 LogInfo("[snapshot] deleted background chainstate directory (%s)",
6486 fs::PathToString(ibd_chainstate_path));
6487 }
6488 return true;
6489}
6490
6491Chainstate& ChainstateManager::GetChainstateForIndexing()
6492{
6493 // We can't always return `m_ibd_chainstate` because after background validation
6494 // has completed, `m_snapshot_chainstate == m_active_chainstate`, but it can be
6495 // indexed.
6496 return (this->GetAll().size() > 1) ? *m_ibd_chainstate : *m_active_chainstate;
6497}
6498
6499std::pair<int, int> ChainstateManager::GetPruneRange(const Chainstate& chainstate, int last_height_can_prune)
6500{
6501 if (chainstate.m_chain.Height() <= 0) {
6502 return {0, 0};
6503 }
6504 int prune_start{0};
6505
6506 if (this->GetAll().size() > 1 && m_snapshot_chainstate.get() == &chainstate) {
6507 // Leave the blocks in the background IBD chain alone if we're pruning
6508 // the snapshot chain.
6509 prune_start = *Assert(GetSnapshotBaseHeight()) + 1;
6510 }
6511
6512 int max_prune = std::max<int>(
6513 0, chainstate.m_chain.Height() - static_cast<int>(MIN_BLOCKS_TO_KEEP));
6514
6515 // last block to prune is the lesser of (caller-specified height, MIN_BLOCKS_TO_KEEP from the tip)
6516 //
6517 // While you might be tempted to prune the background chainstate more
6518 // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
6519 // building - specifically blockfilterindex requires undo data, and if
6520 // we don't maintain this trailing window, we hit indexing failures.
6521 int prune_end = std::min(last_height_can_prune, max_prune);
6522
6523 return {prune_start, prune_end};
6524}
bool MoneyRange(const CAmount &nValue)
Definition: amount.h:27
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
static constexpr CAmount COIN
The amount of satoshis in one BTC.
Definition: amount.h:15
arith_uint256 UintToArith256(const uint256 &a)
int ret
int flags
Definition: bitcoin-tx.cpp:529
ArgsManager & args
Definition: bitcoind.cpp:277
void InvalidateBlock(ChainstateManager &chainman, const uint256 block_hash)
arith_uint256 GetBlockProof(const CBlockIndex &block)
Definition: chain.cpp:121
CBlockLocator GetLocator(const CBlockIndex *index)
Get a locator for a block index entry.
Definition: chain.cpp:45
int64_t GetBlockProofEquivalentTime(const CBlockIndex &to, const CBlockIndex &from, const CBlockIndex &tip, const Consensus::Params &params)
Return the time it would take to redo the work difference between from and to, assuming the current h...
Definition: chain.cpp:136
const CBlockIndex * LastCommonAncestor(const CBlockIndex *pa, const CBlockIndex *pb)
Find the last common ancestor two blocks have.
Definition: chain.cpp:155
@ BLOCK_VALID_CHAIN
Outputs do not overspend inputs, no double spends, coinbase output ok, no immature coinbase spends,...
Definition: chain.h:73
@ BLOCK_VALID_MASK
All validity bits.
Definition: chain.h:80
@ BLOCK_VALID_TRANSACTIONS
Only first tx is coinbase, 2 <= coinbase input script length <= 100, transactions valid,...
Definition: chain.h:69
@ BLOCK_VALID_SCRIPTS
Scripts & signatures ok.
Definition: chain.h:77
@ BLOCK_VALID_TREE
All parent headers found, difficulty matches, timestamp >= median previous.
Definition: chain.h:59
@ BLOCK_HAVE_UNDO
undo data available in rev*.dat
Definition: chain.h:84
@ BLOCK_HAVE_DATA
full block available in blk*.dat
Definition: chain.h:83
@ BLOCK_FAILED_CHILD
descends from failed block
Definition: chain.h:88
@ BLOCK_FAILED_MASK
Definition: chain.h:89
@ BLOCK_FAILED_VALID
stage after last reached validness failed
Definition: chain.h:87
@ BLOCK_OPT_WITNESS
block data in blk*.dat was received with a witness-enforcing client
Definition: chain.h:91
static constexpr int32_t SEQ_ID_BEST_CHAIN_FROM_DISK
Init values for CBlockIndex nSequenceId when loaded from disk.
Definition: chain.h:39
static constexpr int32_t SEQ_ID_INIT_FROM_DISK
Definition: chain.h:40
#define NONFATAL_UNREACHABLE()
NONFATAL_UNREACHABLE() is a macro that is used to mark unreachable code.
Definition: check.h:130
#define Assert(val)
Identity function.
Definition: check.h:113
#define Assume(val)
Assume is the identity function.
Definition: check.h:125
Non-refcounted RAII wrapper for FILE*.
Definition: streams.h:371
std::string ToString() const
Definition: hash_type.h:43
Wrapper around an AutoFile& that implements a ring buffer to deserialize from.
Definition: streams.h:481
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:22
NodeSeconds Time() const
Definition: block.h:56
uint32_t nBits
Definition: block.h:29
int64_t GetBlockTime() const
Definition: block.h:61
int32_t nVersion
Definition: block.h:25
uint256 hashPrevBlock
Definition: block.h:26
uint256 hashMerkleRoot
Definition: block.h:27
uint256 GetHash() const
Definition: block.cpp:11
Definition: block.h:69
bool m_checked_merkle_root
Definition: block.h:77
std::vector< CTransactionRef > vtx
Definition: block.h:72
bool m_checked_witness_commitment
Definition: block.h:76
bool fChecked
Definition: block.h:75
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:103
bool IsValid(enum BlockStatus nUpTo) const EXCLUSIVE_LOCKS_REQUIRED(
Check whether this block index entry is valid up to the passed validity level.
Definition: chain.h:259
std::string ToString() const
Definition: chain.cpp:10
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: chain.h:109
uint64_t m_chain_tx_count
(memory only) Number of transactions in the chain up to and including this block.
Definition: chain.h:138
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
Definition: chain.h:127
bool HaveNumChainTxs() const
Check whether this block and all previous blocks back to the genesis block or an assumeutxo snapshot ...
Definition: chain.h:223
uint32_t nTime
Definition: chain.h:151
int32_t nSequenceId
(memory only) Sequential id assigned to distinguish order in which blocks are received.
Definition: chain.h:158
uint256 GetBlockHash() const
Definition: chain.h:207
int64_t GetBlockTime() const
Definition: chain.h:230
int64_t GetMedianTimePast() const
Definition: chain.h:242
FlatFilePos GetUndoPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition: chain.h:183
bool RaiseValidity(enum BlockStatus nUpTo) EXCLUSIVE_LOCKS_REQUIRED(
Raise the validity level of this block index entry.
Definition: chain.h:271
CBlockIndex * pskip
pointer to the index of some further predecessor of this block
Definition: chain.h:112
unsigned int nTx
Number of transactions in this block.
Definition: chain.h:132
int32_t nVersion
block header
Definition: chain.h:149
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: chain.cpp:110
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:115
const uint256 * phashBlock
pointer to the hash of the block, if any. Memory is owned by this CBlockIndex
Definition: chain.h:106
Undo information for a CBlock.
Definition: undo.h:63
std::vector< CTxUndo > vtxundo
Definition: undo.h:65
An in-memory indexed chain of blocks.
Definition: chain.h:381
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:397
void SetTip(CBlockIndex &block)
Set/initialize a chain with a given tip.
Definition: chain.cpp:16
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:391
CBlockIndex * Next(const CBlockIndex *pindex) const
Find the successor of a block in this chain, or nullptr if the given index is not found or is the tip...
Definition: chain.h:417
int Height() const
Return the maximal height in the chain.
Definition: chain.h:426
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
Definition: chain.cpp:50
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
Definition: chain.h:411
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:78
std::vector< int > GetAvailableSnapshotHeights() const
const ChainTxData & TxData() const
Definition: chainparams.h:129
std::optional< AssumeutxoData > AssumeutxoForHeight(int height) const
Definition: chainparams.h:120
CCoinsView that adds a memory cache for transactions to another CCoinsView.
Definition: coins.h:361
bool Flush(bool will_reuse_cache=true)
Push the modifications applied to this cache to its base and wipe local state.
Definition: coins.cpp:252
bool SpendCoin(const COutPoint &outpoint, Coin *moveto=nullptr)
Spend a coin.
Definition: coins.cpp:133
void Uncache(const COutPoint &outpoint)
Removes the UTXO with the given outpoint from the cache, if it is not modified.
Definition: coins.cpp:278
void AddCoin(const COutPoint &outpoint, Coin &&coin, bool possible_overwrite)
Add a coin.
Definition: coins.cpp:72
unsigned int GetCacheSize() const
Calculate the size of the cache (in number of transaction outputs)
Definition: coins.cpp:293
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: coins.cpp:176
void SetBestBlock(const uint256 &hashBlock)
Definition: coins.cpp:182
bool HaveCoinInCache(const COutPoint &outpoint) const
Check if we have the given utxo already loaded in this cache.
Definition: coins.cpp:171
size_t DynamicMemoryUsage() const
Calculate the size of the cache (in bytes)
Definition: coins.cpp:44
bool Sync()
Push the modifications applied to this cache to its base while retaining the contents of this cache (...
Definition: coins.cpp:265
void EmplaceCoinInternalDANGER(COutPoint &&outpoint, Coin &&coin)
Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty.
Definition: coins.cpp:113
bool HaveCoin(const COutPoint &outpoint) const override
Just check whether a given outpoint is unspent.
Definition: coins.cpp:166
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Definition: coins.cpp:157
CCoinsView backed by the coin database (chainstate/)
Definition: txdb.h:35
void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Dynamically alter the underlying leveldb cache size.
Definition: txdb.cpp:54
Abstract view on the open txout dataset.
Definition: coins.h:308
virtual std::optional< Coin > GetCoin(const COutPoint &outpoint) const
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: coins.cpp:16
virtual std::vector< uint256 > GetHeadBlocks() const
Retrieve the range of blocks that may have been only partially written.
Definition: coins.cpp:18
CCoinsView that brings transactions from a mempool into view.
Definition: txmempool.h:782
Fee rate in satoshis per virtualbyte: CAmount / vB the feerate is represented internally as FeeFrac.
Definition: feerate.h:35
A hasher class for Bitcoin's 256-bit hash (double SHA-256).
Definition: hash.h:24
void Finalize(std::span< unsigned char > output)
Definition: hash.h:30
CHash256 & Write(std::span< const unsigned char > input)
Definition: hash.h:37
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:29
uint32_t n
Definition: transaction.h:32
Txid hash
Definition: transaction.h:31
A hasher class for SHA-256.
Definition: sha256.h:14
void Finalize(unsigned char hash[OUTPUT_SIZE])
Definition: sha256.cpp:725
CSHA256 & Write(const unsigned char *data, size_t len)
Definition: sha256.cpp:699
Closure representing one script verification Note that this stores references to the spending transac...
Definition: validation.h:335
SignatureCache * m_signature_cache
Definition: validation.h:343
PrecomputedTransactionData * txdata
Definition: validation.h:342
CTxOut m_tx_out
Definition: validation.h:337
script_verify_flags m_flags
Definition: validation.h:340
bool cacheStore
Definition: validation.h:341
std::optional< std::pair< ScriptError, std::string > > operator()()
const CTransaction * ptxTo
Definition: validation.h:338
unsigned int nIn
Definition: validation.h:339
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:405
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:281
bool HasWitness() const
Definition: transaction.h:353
const std::vector< CTxOut > vout
Definition: transaction.h:292
const Wtxid & GetWitnessHash() const LIFETIMEBOUND
Definition: transaction.h:329
bool IsCoinBase() const
Definition: transaction.h:341
const Txid & GetHash() const LIFETIMEBOUND
Definition: transaction.h:328
const std::vector< CTxIn > vin
Definition: transaction.h:291
An input of a transaction.
Definition: transaction.h:62
COutPoint prevout
Definition: transaction.h:64
CTxMemPool::txiter TxHandle
Definition: txmempool.h:663
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:189
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
Definition: txmempool.h:263
void check(const CCoinsViewCache &active_coins_tip, int64_t spendheight) const EXCLUSIVE_LOCKS_REQUIRED(void removeRecursive(const CTransaction &tx, MemPoolRemovalReason reason) EXCLUSIVE_LOCKS_REQUIRED(cs)
If sanity-checking is turned on, check makes sure the pool is consistent (does not contain two transa...
Definition: txmempool.h:328
void UpdateTransactionsFromBlock(const std::vector< Txid > &vHashesToUpdate) EXCLUSIVE_LOCKS_REQUIRED(cs
UpdateTransactionsFromBlock is called when adding transactions from a disconnected block back to the ...
Definition: txmempool.cpp:88
void AddTransactionsUpdated(unsigned int n)
Definition: txmempool.cpp:190
CTransactionRef get(const Txid &hash) const
Definition: txmempool.cpp:604
size_t DynamicMemoryUsage() const
Definition: txmempool.cpp:761
const Options m_opts
Definition: txmempool.h:306
void removeForReorg(CChain &chain, std::function< bool(txiter)> filter_final_and_mature) EXCLUSIVE_LOCKS_REQUIRED(cs
After reorg, filter the entries that would no longer be valid in the next block, and update the entri...
Definition: txmempool.cpp:347
bool exists(const Txid &txid) const
Definition: txmempool.h:506
std::set< txiter, CompareIteratorByHash > setEntries
Definition: txmempool.h:271
void removeForBlock(const std::vector< CTransactionRef > &vtx, unsigned int nBlockHeight) EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition: txmempool.cpp:390
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
Definition: txmempool.h:268
unsigned long size() const
Definition: txmempool.h:488
An output of a transaction.
Definition: transaction.h:140
CScript scriptPubKey
Definition: transaction.h:143
CAmount nValue
Definition: transaction.h:142
Undo information for a CTransaction.
Definition: undo.h:53
std::vector< Coin > vprevout
Definition: undo.h:56
VerifyDBResult VerifyDB(Chainstate &chainstate, const Consensus::Params &consensus_params, CCoinsView &coinsview, int nCheckLevel, int nCheckDepth) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
kernel::Notifications & m_notifications
Definition: validation.h:434
CVerifyDB(kernel::Notifications &notifications)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:532
void InitCoinsCache(size_t cache_size_bytes) EXCLUSIVE_LOCKS_REQUIRED(bool CanFlushToDisk() const EXCLUSIVE_LOCKS_REQUIRED(
Initialize the in-memory coins cache (to be done after the health of the on-disk database is verified...
Definition: validation.h:606
Mutex m_chainstate_mutex
The ChainState Mutex A lock that must be held when modifying this ChainState - held in ActivateBestCh...
Definition: validation.h:539
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:614
CTxMemPool * GetMempool()
Definition: validation.h:655
bool RollforwardBlock(const CBlockIndex *pindex, CCoinsViewCache &inputs) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Apply the effects of a block on the utxo cache, ignoring that it may already have been applied.
size_t m_coinstip_cache_size_bytes
The cache size of the in-memory coins view.
Definition: validation.h:678
void UpdateTip(const CBlockIndex *pindexNew) EXCLUSIVE_LOCKS_REQUIRED(NodeClock::time_poin m_next_write)
Check warning conditions and do some notifications on new chain tip set.
Definition: validation.h:839
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:640
bool LoadChainTip() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Update the chain tip based on database information, i.e.
size_t m_coinsdb_cache_size_bytes
The cache size of the on-disk coins view.
Definition: validation.h:675
bool PreciousBlock(BlockValidationState &state, CBlockIndex *pindex) LOCKS_EXCLUDED(bool InvalidateBlock(BlockValidationState &state, CBlockIndex *pindex) LOCKS_EXCLUDED(void SetBlockFailureFlags(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(voi ResetBlockFailureFlags)(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Mark a block as precious and reorganize.
Definition: validation.h:762
void InvalidBlockFound(CBlockIndex *pindex, const BlockValidationState &state) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
void CheckForkWarningConditions() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
void ForceFlushStateToDisk()
Unconditionally flush all changes to disk.
bool ConnectTip(BlockValidationState &state, CBlockIndex *pindexNew, std::shared_ptr< const CBlock > block_to_connect, ConnectTrace &connectTrace, DisconnectedBlockTransactions &disconnectpool) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Connect a new block to m_chain.
bool LoadGenesisBlock()
Ensures we have a genesis block in the block tree, possibly writing one to disk.
const std::optional< uint256 > m_from_snapshot_blockhash
The blockhash which is the base of the snapshot this chainstate was created from.
Definition: validation.h:621
bool ActivateBestChain(BlockValidationState &state, std::shared_ptr< const CBlock > pblock=nullptr) LOCKS_EXCLUDED(DisconnectResult DisconnectBlock(const CBlock &block, const CBlockIndex *pindex, CCoinsViewCache &view) EXCLUSIVE_LOCKS_REQUIRED(boo ConnectBlock)(const CBlock &block, BlockValidationState &state, CBlockIndex *pindex, CCoinsViewCache &view, bool fJustCheck=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Find the best known block, and make it the tip of the block chain.
Definition: validation.h:738
CTxMemPool * m_mempool
Optional mempool that is kept in sync with the chain.
Definition: validation.h:543
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:648
bool DisconnectTip(BlockValidationState &state, DisconnectedBlockTransactions *disconnectpool) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Disconnect m_chain's tip.
CBlockIndex * FindMostWorkChain() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Return the tip of the chain with the most work in it, that isn't known to be invalid (it's however fa...
ChainstateRole GetRole() const EXCLUSIVE_LOCKS_REQUIRED(void InitCoinsDB(size_t cache_size_bytes, bool in_memory, bool should_wipe, fs::path leveldb_name="chainstate")
Return the current role of the chainstate.
ChainstateManager & m_chainman
The chainstate manager that owns this chainstate.
Definition: validation.h:574
std::unique_ptr< CoinsViews > m_coins_views
Manages the UTXO set, which is a reflection of the contents of m_chain.
Definition: validation.h:546
bool ReplayBlocks()
Replay blocks that aren't fully applied to the database.
void PruneBlockIndexCandidates()
Delete all entries in setBlockIndexCandidates that are worse than the current tip.
const CBlockIndex *SnapshotBase() const EXCLUSIVE_LOCKS_REQUIRED(std::set< CBlockIndex *, node::CBlockIndexWorkComparator > setBlockIndexCandidates
The base of the snapshot this chainstate was created from.
Definition: validation.h:628
void TryAddBlockIndexCandidate(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
void PruneAndFlush()
Prune blockfiles from the disk if necessary and then flush chainstate changes if we pruned.
bool ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size) EXCLUSIVE_LOCKS_REQUIRED(bool FlushStateToDisk(BlockValidationState &state, FlushStateMode mode, int nManualPruneHeight=0)
Resize the CoinsViews caches dynamically and flush state to disk.
node::BlockManager & m_blockman
Reference to a BlockManager instance which itself is shared across all Chainstate instances.
Definition: validation.h:569
void MaybeUpdateMempoolForReorg(DisconnectedBlockTransactions &disconnectpool, bool fAddToMempool) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Make mempool consistent after a reorg, by re-adding or recursively erasing disconnected block transac...
Definition: validation.cpp:295
bool ActivateBestChainStep(BlockValidationState &state, CBlockIndex *pindexMostWork, const std::shared_ptr< const CBlock > &pblock, bool &fInvalidFound, ConnectTrace &connectTrace) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Try to make some progress towards making pindexMostWork the active block.
void ClearBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex * FindForkInGlobalIndex(const CBlockLocator &locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Find the last common block of this chain and a locator.
Definition: validation.cpp:121
void InvalidChainFound(CBlockIndex *pindexNew) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Chainstate(CTxMemPool *mempool, node::BlockManager &blockman, ChainstateManager &chainman, std::optional< uint256 > from_snapshot_blockhash=std::nullopt)
bool NeedsRedownload() const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Whether the chain state needs to be redownloaded due to lack of witness data.
CoinsCacheSizeState GetCoinsCacheSizeState() EXCLUSIVE_LOCKS_REQUIRED(CoinsCacheSizeState GetCoinsCacheSizeState(size_t max_coins_cache_size_bytes, size_t max_mempool_size_bytes) EXCLUSIVE_LOCKS_REQUIRED(std::string ToString() EXCLUSIVE_LOCKS_REQUIRED(RecursiveMutex * MempoolMutex() const LOCK_RETURNED(m_mempool -> cs)
Dictates whether we need to flush the cache to disk or not.
Definition: validation.h:796
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:899
util::Result< void > PopulateAndValidateSnapshot(Chainstate &snapshot_chainstate, AutoFile &coins_file, const node::SnapshotMetadata &metadata)
Internal helper for ActivateSnapshot().
const uint256 & AssumedValidBlock() const
Definition: validation.h:1011
SnapshotCompletionResult MaybeCompleteSnapshotValidation() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetSnapshotBaseBlock() const EXCLUSIVE_LOCKS_REQUIRED(Chainstate ActiveChainstate)() const
Once the background validation chainstate has reached the height which is the base of the UTXO snapsh...
Definition: validation.h:1125
ValidationCache m_validation_cache
Definition: validation.h:1040
double GuessVerificationProgress(const CBlockIndex *pindex) const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Guess verification progress (as a fraction between 0.0=genesis and 1.0=current tip).
size_t m_total_coinstip_cache
The total number of bytes available for us to use across all in-memory coins caches.
Definition: validation.h:1082
std::vector< unsigned char > GenerateCoinbaseCommitment(CBlock &block, const CBlockIndex *pindexPrev) const
Produce the necessary coinbase commitment for a block (modifies the hash, don't call for mined blocks...
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
kernel::Notifications & GetNotifications() const
Definition: validation.h:1012
bool IsInitialBlockDownload() const
Check whether we are doing an initial block download (synchronizing from disk or network)
void ReceivedBlockTransactions(const CBlock &block, CBlockIndex *pindexNew, const FlatFilePos &pos) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Mark a block as having its data received and checked (up to BLOCK_VALID_TRANSACTIONS).
bool ShouldCheckBlockIndex() const
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:1032
bool IsSnapshotValidated() const EXCLUSIVE_LOCKS_REQUIRED(
Is there a snapshot in use and has it been fully validated?
Definition: validation.h:1158
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1128
bool ProcessNewBlock(const std::shared_ptr< const CBlock > &block, bool force_processing, bool min_pow_checked, bool *new_block) LOCKS_EXCLUDED(cs_main)
Process an incoming block.
bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
The state of a background sync (for net processing)
Definition: validation.h:1131
size_t m_total_coinsdb_cache
The total number of bytes available for us to use across all leveldb coins databases.
Definition: validation.h:1086
std::atomic< bool > m_cached_finished_ibd
Whether initial block download has ended and IsInitialBlockDownload should return false from now on.
Definition: validation.h:1049
void CheckBlockIndex() const
Make various assertions about the state of the block index.
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1034
void LoadExternalBlockFile(AutoFile &file_in, FlatFilePos *dbp=nullptr, std::multimap< uint256, FlatFilePos > *blocks_with_unknown_parent=nullptr)
Import blocks from an external file.
int ActiveHeight() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1127
VersionBitsCache m_versionbitscache
Track versionbit status.
Definition: validation.h:1149
bool IsSnapshotActive() const
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
Definition: validation.h:1005
const CChainParams & GetParams() const
Definition: validation.h:1007
bool ProcessNewBlockHeaders(std::span< const CBlockHeader > headers, bool min_pow_checked, BlockValidationState &state, const CBlockIndex **ppindex=nullptr) LOCKS_EXCLUDED(cs_main)
Process incoming block headers.
const Consensus::Params & GetConsensus() const
Definition: validation.h:1008
ChainstateManager(const util::SignalInterrupt &interrupt, Options options, node::BlockManager::Options blockman_options)
const arith_uint256 & MinimumChainWork() const
Definition: validation.h:1010
util::Result< CBlockIndex * > ActivateSnapshot(AutoFile &coins_file, const node::SnapshotMetadata &metadata, bool in_memory)
Construct and activate a Chainstate on the basis of UTXO snapshot data.
const Options m_options
Definition: validation.h:1035
bool LoadBlockIndex() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Load the block tree and coins database from disk, initializing state if we're running with -reindex.
std::optional< uint256 > SnapshotBlockhash() const
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1126
bool AcceptBlockHeader(const CBlockHeader &block, BlockValidationState &state, CBlockIndex **ppindex, bool min_pow_checked) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
If a block header hasn't already been seen, call CheckBlockHeader on it, ensure that it doesn't desce...
void ReportHeadersPresync(const arith_uint256 &work, int64_t height, int64_t timestamp)
This is used by net_processing to report pre-synchronization progress of headers, as headers are not ...
arith_uint256 nLastPreciousChainwork
chainwork for the last block that preciousblock has been applied to.
Definition: validation.h:1062
bool NotifyHeaderTip() LOCKS_EXCLUDED(GetMutex())
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1095
void MaybeRebalanceCaches() EXCLUSIVE_LOCKS_REQUIRED(void UpdateUncommittedBlockStructures(CBlock &block, const CBlockIndex *pindexPrev) const
Check to see if caches are out of balance and if so, call ResizeCoinsCaches() as needed.
bool DetectSnapshotChainstate() EXCLUSIVE_LOCKS_REQUIRED(void ResetChainstates() EXCLUSIVE_LOCKS_REQUIRED(bool DeleteSnapshotChainstate() EXCLUSIVE_LOCKS_REQUIRED(Chainstate &ActivateExistingSnapshot(uint256 base_blockhash) EXCLUSIVE_LOCKS_REQUIRED(bool ValidatedSnapshotCleanup() EXCLUSIVE_LOCKS_REQUIRED(Chainstate &GetChainstateForIndexing() EXCLUSIVE_LOCKS_REQUIRED(std::pair< int, int > GetPruneRange(const Chainstate &chainstate, int last_height_can_prune) EXCLUSIVE_LOCKS_REQUIRED(std::optional< int > GetSnapshotBaseHeight() const EXCLUSIVE_LOCKS_REQUIRED(void RecalculateBestHeader() EXCLUSIVE_LOCKS_REQUIRED(CCheckQueue< CScriptCheck > & GetCheckQueue()
When starting up, search the datadir for a chainstate based on a UTXO snapshot that is in the process...
Definition: validation.h:1345
bool IsUsable(const Chainstate *const cs) const EXCLUSIVE_LOCKS_REQUIRED(
Return true if a chainstate is considered usable.
Definition: validation.h:976
int32_t nBlockReverseSequenceId
Decreasing counter (used by subsequent preciousblock calls).
Definition: validation.h:1060
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1038
bool AcceptBlock(const std::shared_ptr< const CBlock > &pblock, BlockValidationState &state, CBlockIndex **ppindex, bool fRequested, const FlatFilePos *dbp, bool *fNewBlock, bool min_pow_checked) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Sufficiently validate a block for disk storage (and store on disk).
A UTXO entry.
Definition: coins.h:33
bool IsCoinBase() const
Definition: coins.h:57
CTxOut out
unspent transaction output
Definition: coins.h:36
bool IsSpent() const
Either this coin never existed (see e.g.
Definition: coins.h:81
uint32_t nHeight
at which height this containing transaction was included in the active block chain
Definition: coins.h:42
unsigned int fCoinBase
whether containing transaction was a coinbase
Definition: coins.h:39
CoinsViews(DBParams db_params, CoinsViewOptions options)
This constructor initializes CCoinsViewDB and CCoinsViewErrorCatcher instances, but it does not creat...
Used to track blocks whose transactions were applied to the UTXO state as a part of a single Activate...
std::vector< PerBlockConnectTrace > & GetBlocksConnected()
std::vector< PerBlockConnectTrace > blocksConnected
void BlockConnected(CBlockIndex *pindex, std::shared_ptr< const CBlock > pblock)
std::pair< uint32_t, size_t > setup_bytes(size_t bytes)
setup_bytes is a convenience function which accounts for internal memory usage when deciding how many...
Definition: cuckoocache.h:364
void insert(Element e)
insert loops at most depth_limit times trying to insert a hash at various locations in the table via ...
Definition: cuckoocache.h:397
bool contains(const Element &e, const bool erase) const
contains iterates through the hash locations for a given element and checks to see if it is present.
Definition: cuckoocache.h:474
DisconnectedBlockTransactions.
std::list< CTransactionRef > take()
Clear all data structures and return the list of transactions.
void removeForBlock(const std::vector< CTransactionRef > &vtx)
Remove any entries that are in this block.
std::vector< CTransactionRef > AddTransactionsFromBlock(const std::vector< CTransactionRef > &vtx)
Add transactions from the block, iterating through vtx in reverse order.
Fast randomness source.
Definition: random.h:386
Tp rand_uniform_delay(const Tp &time, typename Tp::duration range) noexcept
Return the time point advanced by a uniform random duration.
Definition: random.h:329
Convenience class for initializing and passing the script execution cache and signature cache.
Definition: validation.h:367
ValidationCache(size_t script_execution_cache_bytes, size_t signature_cache_bytes)
CuckooCache::cache< uint256, SignatureCacheHasher > m_script_execution_cache
Definition: validation.h:373
CSHA256 ScriptExecutionCacheHasher() const
Return a copy of the pre-initialized hasher.
Definition: validation.h:382
CSHA256 m_script_execution_cache_hasher
Pre-initialized hasher to avoid having to recreate it for every hash calculation.
Definition: validation.h:370
SignatureCache m_signature_cache
Definition: validation.h:374
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void BlockChecked(const std::shared_ptr< const CBlock > &, const BlockValidationState &)
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
void ChainStateFlushed(ChainstateRole, const CBlockLocator &)
void ActiveTipChange(const CBlockIndex &, bool)
void BlockConnected(ChainstateRole, const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
bool IsValid() const
Definition: validation.h:105
std::string GetRejectReason() const
Definition: validation.h:109
std::string GetDebugMessage() const
Definition: validation.h:110
bool Error(const std::string &reject_reason)
Definition: validation.h:98
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:88
bool IsError() const
Definition: validation.h:107
Result GetResult() const
Definition: validation.h:108
std::string ToString() const
Definition: validation.h:111
bool IsInvalid() const
Definition: validation.h:106
std::vector< std::pair< int, bool > > CheckUnknownActivations(const CBlockIndex *pindex, const CChainParams &chainparams) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Check for unknown activations Returns a vector containing the bit number used for signalling and a bo...
void Clear() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
256-bit unsigned big integer.
constexpr bool IsNull() const
Definition: uint256.h:48
std::string ToString() const
Definition: uint256.cpp:21
constexpr unsigned char * begin()
Definition: uint256.h:100
double getdouble() const
A base class defining functions for notifying about certain kernel events.
virtual void headerTip(SynchronizationState state, int64_t height, int64_t timestamp, bool presync)
virtual void fatalError(const bilingual_str &message)
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
virtual void warningSet(Warning id, const bilingual_str &message)
virtual void progress(const bilingual_str &title, int progress_percent, bool resume_possible)
virtual InterruptResult blockTip(SynchronizationState state, const CBlockIndex &index, double verification_progress)
virtual void warningUnset(Warning id)
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
Definition: blockstorage.h:186
const kernel::BlockManagerOpts m_opts
Definition: blockstorage.h:303
RecursiveMutex cs_LastBlockFile
Definition: blockstorage.h:251
bool FlushChainstateBlockFile(int tip_height)
void FindFilesToPrune(std::set< int > &setFilesToPrune, int last_prune, const Chainstate &chain, ChainstateManager &chainman)
Prune block and undo files (blk???.dat and rev???.dat) so that the disk space used is less than a use...
void UpdateBlockInfo(const CBlock &block, unsigned int nHeight, const FlatFilePos &pos)
Update blockfile info while processing a block during reindex.
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
std::atomic_bool m_blockfiles_indexed
Whether all blockfiles have been added to the block tree database.
Definition: blockstorage.h:323
std::vector< CBlockIndex * > GetAllBlockIndices() EXCLUSIVE_LOCKS_REQUIRED(std::multimap< CBlockIndex *, CBlockIndex * > m_blocks_unlinked
All pairs A->B, where A (or one of its ancestors) misses transactions, but B has transactions.
Definition: blockstorage.h:341
std::set< CBlockIndex * > m_dirty_blockindex
Dirty block index entries.
Definition: blockstorage.h:288
bool LoadingBlocks() const
Definition: blockstorage.h:403
void UnlinkPrunedFiles(const std::set< int > &setFilesToPrune) const
Actually unlink the specified files.
void WriteBlockIndexDB() EXCLUSIVE_LOCKS_REQUIRED(bool LoadBlockIndexDB(const std::optional< uint256 > &snapshot_blockhash) EXCLUSIVE_LOCKS_REQUIRED(void ScanAndUnlinkAlreadyPrunedFiles() EXCLUSIVE_LOCKS_REQUIRED(CBlockIndex * AddToBlockIndex(const CBlockHeader &block, CBlockIndex *&best_header) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Remove any pruned block & undo files that are still on disk.
Definition: blockstorage.h:362
bool ReadBlock(CBlock &block, const FlatFilePos &pos, const std::optional< uint256 > &expected_hash) const
Functions for disk access for blocks.
bool m_check_for_pruning
Global flag to indicate we should check to see if there are block/undo files that should be deleted.
Definition: blockstorage.h:281
bool IsPruneMode() const
Whether running in -prune mode.
Definition: blockstorage.h:397
bool CheckBlockDataAvailability(const CBlockIndex &upper_block, const CBlockIndex &lower_block) EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex &GetFirstBlock(const CBlockIndex &upper_block LIFETIMEBOUND, uint32_t status_mask, const CBlockIndex *lower_block LIFETIMEBOUND=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(boo m_have_pruned)
Check if all blocks in the [upper_block, lower_block] range have data available.
Definition: blockstorage.h:442
void FindFilesToPruneManual(std::set< int > &setFilesToPrune, int nManualPruneHeight, const Chainstate &chain, ChainstateManager &chainman)
bool WriteBlockUndo(const CBlockUndo &blockundo, BlockValidationState &state, CBlockIndex &block) EXCLUSIVE_LOCKS_REQUIRED(FlatFilePos WriteBlock(const CBlock &block, int nHeight)
Store block on disk and update block file statistics.
Definition: blockstorage.h:386
std::optional< int > m_snapshot_height
The height of the base block of an assumeutxo snapshot, if one is in use.
Definition: blockstorage.h:339
Metadata describing a serialized version of a UTXO set from which an assumeutxo Chainstate can be con...
Definition: utxo_snapshot.h:34
uint256 m_base_blockhash
The hash of the block that reflects the tip of the chain for the UTXO set contained in this snapshot.
Definition: utxo_snapshot.h:41
uint64_t m_coins_count
The number of coins in the UTXO set contained in this snapshot.
Definition: utxo_snapshot.h:46
std::string ToString() const
constexpr const std::byte * begin() const
const uint256 & ToUint256() const LIFETIMEBOUND
std::string GetHex() const
256-bit opaque blob.
Definition: uint256.h:195
Helper class that manages an interrupt flag, and allows a thread or signal to interrupt another threa...
std::string FormatFullVersion()
const Coin & AccessByTxid(const CCoinsViewCache &view, const Txid &txid)
Utility function to find any unspent output with a given txid.
Definition: coins.cpp:355
void AddCoins(CCoinsViewCache &cache, const CTransaction &tx, int nHeight, bool check_for_overwrite)
Utility function to add all of a transaction's outputs to a cache.
Definition: coins.cpp:122
uint256 BlockMerkleRoot(const CBlock &block, bool *mutated)
Definition: merkle.cpp:66
uint256 BlockWitnessMerkleRoot(const CBlock &block)
Definition: merkle.cpp:76
static constexpr int NO_WITNESS_COMMITMENT
Index marker for when no witness commitment is present in a coinbase transaction.
Definition: validation.h:15
static constexpr size_t MINIMUM_WITNESS_COMMITMENT
Minimum size of a witness commitment structure.
Definition: validation.h:18
static int64_t GetBlockWeight(const CBlock &block)
Definition: validation.h:136
@ BLOCK_HEADER_LOW_WORK
the block header may be on a too-little-work chain
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
int GetWitnessCommitmentIndex(const CBlock &block)
Compute at which vout of the block's coinbase transaction the witness commitment occurs,...
Definition: validation.h:147
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/RBF/etc limits
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
@ TX_INPUTS_NOT_STANDARD
inputs (covered by txid) failed policy rules
@ TX_WITNESS_STRIPPED
Transaction is missing a witness.
@ TX_CONFLICT
Tx already in mempool or conflicts with a tx in the chain (if it conflicts with another tx in mempool...
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
@ TX_WITNESS_MUTATED
Transaction might have a witness prior to SegWit activation, or witness may have been malleated (whic...
@ TX_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
@ TX_CONSENSUS
invalid by consensus rules
@ TX_RECONSIDERABLE
fails some policy, but might be acceptable if submitted in a (different) package
static constexpr unsigned int LOCKTIME_VERIFY_SEQUENCE
Flags for nSequence and nLockTime locks.
Definition: consensus.h:28
static constexpr int64_t MAX_TIMEWARP
Maximum number of seconds that the timestamp of the first block of a difficulty adjustment period is ...
Definition: consensus.h:35
static const unsigned int MAX_BLOCK_WEIGHT
The maximum allowed weight for a block, see BIP 141 (network rule)
Definition: consensus.h:15
static const unsigned int MAX_BLOCK_SERIALIZED_SIZE
The maximum allowed size for a serialized block, in bytes (only for buffer size limits)
Definition: consensus.h:13
static const int64_t MAX_BLOCK_SIGOPS_COST
The maximum allowed number of signature check operations in a block (network rule)
Definition: consensus.h:17
static const int COINBASE_MATURITY
Coinbase transaction outputs can only be spent after this number of new blocks (network rule)
Definition: consensus.h:19
static const int WITNESS_SCALE_FACTOR
Definition: consensus.h:21
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
bool DestroyDB(const std::string &path_str)
Definition: dbwrapper.cpp:38
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const Consensus::Params &params, Consensus::BuriedDeployment dep, VersionBitsCache &versionbitscache)
Determine if a deployment is active for the next block.
bool DeploymentActiveAt(const CBlockIndex &index, const Consensus::Params &params, Consensus::BuriedDeployment dep, VersionBitsCache &versionbitscache)
Determine if a deployment is active for this block.
static const unsigned int MAX_DISCONNECTED_TX_POOL_BYTES
Maximum bytes for transactions to store for processing during reorg.
bool CheckEphemeralSpends(const Package &package, CFeeRate dust_relay_rate, const CTxMemPool &tx_pool, TxValidationState &out_child_state, Wtxid &out_child_wtxid)
Must be called for each transaction(package) if any dust is in the package.
bool PreCheckEphemeralTx(const CTransaction &tx, CFeeRate dust_relay_rate, CAmount base_fee, CAmount mod_fee, TxValidationState &state)
These utility functions ensure that ephemeral dust is safely created and spent without unduly risking...
volatile double sum
Definition: examples.cpp:10
static bool exists(const path &p)
Definition: fs.h:95
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:157
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: fs_helpers.cpp:87
bool VerifyScript(const CScript &scriptSig, const CScript &scriptPubKey, const CScriptWitness *witness, script_verify_flags flags, const BaseSignatureChecker &checker, ScriptError *serror)
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:25
#define LogPrintLevel_(category, level, should_ratelimit,...)
Definition: logging.h:362
#define LogWarning(...)
Definition: logging.h:369
#define LogInfo(...)
Definition: logging.h:368
#define LogError(...)
Definition: logging.h:370
#define LogDebug(category,...)
Definition: logging.h:390
unsigned int nHeight
LockPoints lp
@ REORG
Removed for reorganization.
std::array< uint8_t, 4 > MessageStartChars
unsigned int nonce
Definition: miner_tests.cpp:81
@ COINDB
Definition: logging.h:84
@ REINDEX
Definition: logging.h:77
@ TXPACKAGES
Definition: logging.h:96
@ ALL
Definition: logging.h:98
@ VALIDATION
Definition: logging.h:87
@ PRUNE
Definition: logging.h:80
@ MEMPOOL
Definition: logging.h:68
@ BENCH
Definition: logging.h:70
bool CheckTxInputs(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &inputs, int nSpendHeight, CAmount &txfee)
Check whether all inputs of this transaction are valid (no double spends and amounts) This does not m...
Definition: tx_verify.cpp:164
@ DEPLOYMENT_DERSIG
Definition: params.h:28
@ DEPLOYMENT_CSV
Definition: params.h:29
@ DEPLOYMENT_SEGWIT
Definition: params.h:30
@ DEPLOYMENT_HEIGHTINCB
Definition: params.h:26
@ DEPLOYMENT_CLTV
Definition: params.h:27
T check(T ptr)
std::function< FILE *(const fs::path &, const char *)> FopenFn
Definition: fs.h:192
bool IsInterrupted(const T &result)
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point)
Calculate statistics about the unspent transaction output set.
Definition: coinstats.cpp:116
CoinStatsHashType
Definition: coinstats.h:27
const fs::path SNAPSHOT_BLOCKHASH_FILENAME
The file in the snapshot chainstate dir which stores the base blockhash.
bool WriteSnapshotBaseBlockhash(Chainstate &snapshot_chainstate)
bool WriteSnapshotBaseBlockhash(Chainstate &snapshot_chainstate) EXCLUSIVE_LOCKS_REQUIRED(std::optional< uint256 > ReadSnapshotBaseBlockhash(fs::path chaindir) EXCLUSIVE_LOCKS_REQUIRED(constexpr std::string_view SNAPSHOT_CHAINSTATE_SUFFIX
Write out the blockhash of the snapshot base block that was used to construct this chainstate.
std::unordered_map< uint256, CBlockIndex, BlockHasher > BlockMap
Definition: blockstorage.h:130
std::optional< uint256 > ReadSnapshotBaseBlockhash(fs::path chaindir)
std::optional< fs::path > FindSnapshotChainstateDir(const fs::path &data_dir)
Return a path to the snapshot-based chainstate dir, if one exists.
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:93
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:245
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:204
static feebumper::Result CheckFeeRate(const CWallet &wallet, const CMutableTransaction &mtx, const CFeeRate &newFeerate, const int64_t maxTxSize, CAmount old_fee, std::vector< bilingual_str > &errors)
Check if the user provided a valid feeRate.
Definition: feebumper.cpp:60
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:479
bool IsChildWithParents(const Package &package)
Context-free check that a package is exactly one child and its parents; not all parents need to be pr...
Definition: packages.cpp:119
bool IsWellFormedPackage(const Package &txns, PackageValidationState &state, bool require_sorted)
Context-free package policy checks:
Definition: packages.cpp:79
uint256 GetPackageHash(const std::vector< CTransactionRef > &transactions)
Get the hash of the concatenated wtxids of transactions, with wtxids treated as a little-endian numbe...
Definition: packages.cpp:151
std::vector< CTransactionRef > Package
A package is an ordered list of transactions.
Definition: packages.h:45
@ PCKG_POLICY
The package itself is invalid (e.g. too many transactions).
@ PCKG_MEMPOOL_ERROR
Mempool logic error.
@ PCKG_TX
At least one tx is invalid.
std::optional< std::pair< DiagramCheckError, std::string > > ImprovesFeerateDiagram(CTxMemPool::ChangeSet &changeset)
The replacement transaction must improve the feerate diagram of the mempool.
Definition: rbf.cpp:127
std::optional< std::string > PaysForRBF(CAmount original_fees, CAmount replacement_fees, size_t replacement_vsize, CFeeRate relay_fee, const Txid &txid)
The replacement transaction must pay more fees than the original transactions.
Definition: rbf.cpp:100
std::optional< std::string > EntriesAndTxidsDisjoint(const CTxMemPool::setEntries &ancestors, const std::set< Txid > &direct_conflicts, const Txid &txid)
Check the intersection between two sets of transactions (a set of mempool entries and a set of txids)...
Definition: rbf.cpp:85
std::optional< std::string > GetEntriesForConflicts(const CTransaction &tx, CTxMemPool &pool, const CTxMemPool::setEntries &iters_conflicting, CTxMemPool::setEntries &all_conflicts)
Get all descendants of iters_conflicting.
Definition: rbf.cpp:58
@ FAILURE
New diagram wasn't strictly superior
bool SpendsNonAnchorWitnessProg(const CTransaction &tx, const CCoinsViewCache &prevouts)
Check whether this transaction spends any witness program but P2A, including not-yet-defined ones.
Definition: policy.cpp:340
bool AreInputsStandard(const CTransaction &tx, const CCoinsViewCache &mapInputs)
Check transaction inputs.
Definition: policy.cpp:213
bool IsWitnessStandard(const CTransaction &tx, const CCoinsViewCache &mapInputs)
Check if the transaction is over standard P2WSH resources limit: 3600bytes witnessScript size,...
Definition: policy.cpp:251
bool IsStandardTx(const CTransaction &tx, const std::optional< unsigned > &max_datacarrier_bytes, bool permit_bare_multisig, const CFeeRate &dust_relay_fee, std::string &reason)
Check for standard transaction types.
Definition: policy.cpp:99
static constexpr script_verify_flags STANDARD_SCRIPT_VERIFY_FLAGS
Standard script verification flags that standard transactions will comply with.
Definition: policy.h:116
static constexpr unsigned int STANDARD_LOCKTIME_VERIFY_FLAGS
Used as the flags parameter to sequence and nLocktime checks in non-consensus code.
Definition: policy.h:135
static constexpr unsigned int MAX_STANDARD_TX_SIGOPS_COST
The maximum number of sigops we're willing to relay/mine in a single tx.
Definition: policy.h:41
static constexpr unsigned int MIN_STANDARD_TX_NONWITNESS_SIZE
The minimum non-witness size for transactions we're willing to relay/mine: one larger than 64
Definition: policy.h:37
static constexpr script_verify_flags STANDARD_NOT_MANDATORY_VERIFY_FLAGS
For convenience, standard but not mandatory verify flags.
Definition: policy.h:132
unsigned int GetNextWorkRequired(const CBlockIndex *pindexLast, const CBlockHeader *pblock, const Consensus::Params &params)
Definition: pow.cpp:14
bool CheckProofOfWork(uint256 hash, unsigned int nBits, const Consensus::Params &params)
Check whether a block hash satisfies the proof-of-work requirement specified by nBits.
Definition: pow.cpp:140
static constexpr TransactionSerParams TX_NO_WITNESS
Definition: transaction.h:181
static constexpr TransactionSerParams TX_WITH_WITNESS
Definition: transaction.h:180
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:404
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:403
uint256 GetRandHash() noexcept
Generate a random uint256.
Definition: random.h:463
const char * prefix
Definition: rest.cpp:1142
@ OP_RETURN
Definition: script.h:111
std::string ScriptErrorString(const ScriptError serror)
enum ScriptError_t ScriptError
@ SCRIPT_ERR_UNKNOWN_ERROR
Definition: script_error.h:14
uint64_t ReadCompactSize(Stream &is, bool range_check=true)
Decode a CompactSize-encoded variable-length integer.
Definition: serialize.h:330
uint64_t GetSerializeSize(const T &t)
Definition: serialize.h:1095
bool CheckSignetBlockSolution(const CBlock &block, const Consensus::Params &consensusParams)
Extract signature and check whether a block has a valid solution.
Definition: signet.cpp:125
unsigned char * UCharCast(char *c)
Definition: span.h:95
Holds configuration for use during UTXO snapshot load and validation.
Definition: chainparams.h:35
AssumeutxoHash hash_serialized
The expected hash of the deserialized UTXO set.
Definition: chainparams.h:39
uint64_t m_chain_tx_count
Used to populate the m_chain_tx_count value, which is used during BlockManager::LoadBlockIndex().
Definition: chainparams.h:45
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:124
std::vector< uint256 > vHave
Definition: block.h:134
A mutable version of CTransaction.
Definition: transaction.h:358
std::vector< CTxOut > vout
Definition: transaction.h:360
std::vector< CTxIn > vin
Definition: transaction.h:359
Holds various statistics on transactions within a chain.
Definition: chainparams.h:58
User-controlled performance and debug options.
Definition: txdb.h:26
Parameters that influence chain consensus.
Definition: params.h:84
bool enforce_BIP94
Enforce BIP94 timewarp attack mitigation.
Definition: params.h:118
int64_t DifficultyAdjustmentInterval() const
Definition: params.h:126
bool signet_blocks
If true, witness commitments contain a payload equal to a Bitcoin Script solution to the signet chall...
Definition: params.h:136
int nSubsidyHalvingInterval
Definition: params.h:86
std::map< uint256, script_verify_flags > script_flag_exceptions
Hashes of blocks that.
Definition: params.h:93
int64_t nPowTargetSpacing
Definition: params.h:120
std::chrono::seconds PowTargetSpacing() const
Definition: params.h:122
Application-specific storage settings.
Definition: dbwrapper.h:33
fs::path path
Location in the filesystem where leveldb data will be stored.
Definition: dbwrapper.h:35
Data structure storing a fee and size, ordered by increasing fee/size.
Definition: feefrac.h:40
uint32_t nPos
Definition: flatfile.h:17
bool IsNull() const
Definition: flatfile.h:32
int32_t nFile
Definition: flatfile.h:16
int64_t time
Definition: mempool_entry.h:32
Validation result for a transaction evaluated by MemPoolAccept (single or package).
Definition: validation.h:127
const ResultType m_result_type
Result type.
Definition: validation.h:136
const TxValidationState m_state
Contains information about why the transaction failed.
Definition: validation.h:139
@ INVALID
‍Fully validated, valid.
static MempoolAcceptResult Failure(TxValidationState state)
Definition: validation.h:163
static MempoolAcceptResult FeeFailure(TxValidationState state, CFeeRate effective_feerate, const std::vector< Wtxid > &wtxids_fee_calculations)
Definition: validation.h:167
static MempoolAcceptResult MempoolTxDifferentWitness(const Wtxid &other_wtxid)
Definition: validation.h:186
static MempoolAcceptResult MempoolTx(int64_t vsize, CAmount fees)
Definition: validation.h:182
static MempoolAcceptResult Success(std::list< CTransactionRef > &&replaced_txns, int64_t vsize, CAmount fees, CFeeRate effective_feerate, const std::vector< Wtxid > &wtxids_fee_calculations)
Definition: validation.h:173
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:53
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:26
Validation result for package mempool acceptance.
Definition: validation.h:233
std::shared_ptr< const CBlock > pblock
PerBlockConnectTrace()=default
CBlockIndex * pindex
void Init(const T &tx, std::vector< CTxOut > &&spent_outputs, bool force=false)
Initialize this PrecomputedTransactionData with transaction data.
bool m_spent_outputs_ready
Whether m_spent_outputs is initialized.
Definition: interpreter.h:182
std::vector< CTxOut > m_spent_outputs
Definition: interpreter.h:180
const char * what() const noexcept override
Bilingual messages:
Definition: translation.h:24
std::string original
Definition: translation.h:25
An options struct for BlockManager, more ergonomically referred to as BlockManager::Options due to th...
An options struct for ChainstateManager, more ergonomically referred to as ChainstateManager::Options...
std::optional< int32_t > check_block_index
std::chrono::seconds max_tip_age
If the tip is older than this, the node is considered to be in initial block download.
#define AssertLockNotHeld(cs)
Definition: sync.h:142
#define LOCK(cs)
Definition: sync.h:259
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:290
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:51
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:50
#define LOG_TIME_MILLIS_WITH_CATEGORY(end_msg, log_category)
Definition: timer.h:103
#define LOG_TIME_MILLIS_WITH_CATEGORY_MSG_ONCE(end_msg, log_category)
Definition: timer.h:105
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
#define TRACEPOINT(context,...)
Definition: trace.h:56
consteval auto _(util::TranslatedLiteral str)
Definition: translation.h:79
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82
std::optional< std::pair< std::string, CTransactionRef > > SingleTRUCChecks(const CTxMemPool &pool, const CTransactionRef &ptx, const std::vector< CTxMemPoolEntry::CTxMemPoolEntryRef > &mempool_parents, const std::set< Txid > &direct_conflicts, int64_t vsize)
Must be called for every transaction, even if not TRUC.
std::optional< std::string > PackageTRUCChecks(const CTxMemPool &pool, const CTransactionRef &ptx, int64_t vsize, const Package &package, const std::vector< CTxMemPoolEntry::CTxMemPoolEntryRef > &mempool_parents)
Must be called for every transaction that is submitted within a package, even if not TRUC.
Definition: truc_policy.cpp:58
static constexpr decltype(CTransaction::version) TRUC_VERSION
Definition: truc_policy.h:20
bool CheckTransaction(const CTransaction &tx, TxValidationState &state)
Definition: tx_check.cpp:11
bool EvaluateSequenceLocks(const CBlockIndex &block, std::pair< int, int64_t > lockPair)
Definition: tx_verify.cpp:97
std::pair< int, int64_t > CalculateSequenceLocks(const CTransaction &tx, int flags, std::vector< int > &prevHeights, const CBlockIndex &block)
Calculates the block height and previous block's median time past at which the transaction will be co...
Definition: tx_verify.cpp:39
int64_t GetTransactionSigOpCost(const CTransaction &tx, const CCoinsViewCache &inputs, script_verify_flags flags)
Compute total signature operation cost of a transaction.
Definition: tx_verify.cpp:143
unsigned int GetLegacySigOpCount(const CTransaction &tx)
Auxiliary functions for transaction validation (ideally should not be exposed)
Definition: tx_verify.cpp:112
bool SequenceLocks(const CTransaction &tx, int flags, std::vector< int > &prevHeights, const CBlockIndex &block)
Check if transaction is final per BIP 68 sequence numbers and can be included in a block.
Definition: tx_verify.cpp:107
bool IsFinalTx(const CTransaction &tx, int nBlockHeight, int64_t nBlockTime)
Check if transaction is final and can be included in a block with the specified height and time.
Definition: tx_verify.cpp:17
bool TestLockPointValidity(CChain &active_chain, const LockPoints &lp)
Test whether the LockPoints height and time are still valid on the current chain.
Definition: txmempool.cpp:40
static const uint32_t MEMPOOL_HEIGHT
Fake height value used in Coin to signify they are only in the memory pool (since 0....
Definition: txmempool.h:51
#define expect(bit)
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.cpp:77
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:79
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition: time.h:82
std::chrono::time_point< NodeClock, std::chrono::seconds > NodeSeconds
Definition: time.h:25
PackageMempoolAcceptResult ProcessNewPackage(Chainstate &active_chainstate, CTxMemPool &pool, const Package &package, bool test_accept, const std::optional< CFeeRate > &client_maxfeerate)
Validate (and maybe submit) a package to the mempool.
static void LimitMempoolSize(CTxMemPool &pool, CCoinsViewCache &coins_cache) EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.cpp:265
bool IsBlockMutated(const CBlock &block, bool check_witness_root)
Check if a block has been mutated (with respect to its merkle root and witness commitments).
script_verify_flags GetBlockScriptFlags(const CBlockIndex &block_index, const ChainstateManager &chainman)
std::optional< LockPoints > CalculateLockPointsAtTip(CBlockIndex *tip, const CCoinsView &coins_view, const CTransaction &tx)
Definition: validation.cpp:202
static bool pool cs
Definition: validation.cpp:401
bool CheckInputScripts(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &inputs, script_verify_flags flags, bool cacheSigStore, bool cacheFullScriptStore, PrecomputedTransactionData &txdata, ValidationCache &validation_cache, std::vector< CScriptCheck > *pvChecks=nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Check whether all of this transaction's input scripts succeed.
static constexpr size_t WARN_FLUSH_COINS_SIZE
Size threshold for warning about slow UTXO set flush to disk.
Definition: validation.cpp:92
bool CheckFinalTxAtTip(const CBlockIndex &active_chain_tip, const CTransaction &tx)
Definition: validation.cpp:148
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
MempoolAcceptResult AcceptToMemoryPool(Chainstate &active_chainstate, const CTransactionRef &tx, int64_t accept_time, bool bypass_limits, bool test_accept)
Try to add a transaction to the mempool.
int ApplyTxInUndo(Coin &&undo, CCoinsViewCache &view, const COutPoint &out)
Restore the UTXO in a Coin at a given COutPoint.
static bool ContextualCheckBlock(const CBlock &block, BlockValidationState &state, const ChainstateManager &chainman, const CBlockIndex *pindexPrev)
NOTE: This function is not currently invoked by ConnectBlock(), so we should consider upgrade issues ...
bool FatalError(Notifications &notifications, BlockValidationState &state, const bilingual_str &message)
bool CheckSequenceLocksAtTip(CBlockIndex *tip, const LockPoints &lock_points)
Check if transaction will be BIP68 final in the next block to be created on top of tip.
Definition: validation.cpp:247
static void UpdateTipLog(const ChainstateManager &chainman, const CCoinsViewCache &coins_tip, const CBlockIndex *tip, const std::string &func_name, const std::string &prefix, const std::string &warning_messages) EXCLUSIVE_LOCKS_REQUIRED(
bool HasValidProofOfWork(const std::vector< CBlockHeader > &headers, const Consensus::Params &consensusParams)
Check with the proof of work on each blockheader matches the value in nBits.
static ChainstateManager::Options && Flatten(ChainstateManager::Options &&opts)
Apply default chain params to nullopt members.
static bool CheckInputsFromMempoolAndCache(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &view, const CTxMemPool &pool, script_verify_flags flags, PrecomputedTransactionData &txdata, CCoinsViewCache &coins_tip, ValidationCache &validation_cache) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Checks to avoid mempool polluting consensus critical paths since cached signature and script validity...
static constexpr auto DATABASE_WRITE_INTERVAL_MAX
Definition: validation.cpp:98
static bool CheckWitnessMalleation(const CBlock &block, bool expect_witness_commitment, BlockValidationState &state)
CheckWitnessMalleation performs checks for block malleation with regard to its witnesses.
void UpdateCoins(const CTransaction &tx, CCoinsViewCache &inputs, CTxUndo &txundo, int nHeight)
static bool DeleteCoinsDBFromDisk(const fs::path db_path, bool is_snapshot) EXCLUSIVE_LOCKS_REQUIRED(
static bool CheckMerkleRoot(const CBlock &block, BlockValidationState &state)
static constexpr int PRUNE_LOCK_BUFFER
The number of blocks to keep below the deepest prune lock.
Definition: validation.cpp:114
arith_uint256 CalculateClaimedHeadersWork(std::span< const CBlockHeader > headers)
Return the sum of the claimed work on a given set of headers.
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:101
bool CheckBlock(const CBlock &block, BlockValidationState &state, const Consensus::Params &consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
Functions for validating blocks and updating the block tree.
static constexpr std::chrono::hours MAX_FEE_ESTIMATION_TIP_AGE
Maximum age of our tip for us to be considered current for fee estimation.
Definition: validation.cpp:100
void PruneBlockFilesManual(Chainstate &active_chainstate, int nManualPruneHeight)
Prune block files up to a given height.
static void FlushSnapshotToDisk(CCoinsViewCache &coins_cache, bool snapshot_loaded)
static bool IsCurrentForFeeEstimation(Chainstate &active_chainstate) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Definition: validation.cpp:281
static constexpr auto DATABASE_WRITE_INTERVAL_MIN
Time window to wait between writing blocks/block index and chainstate to disk.
Definition: validation.cpp:97
AssertLockHeld(pool.cs)
BlockValidationState TestBlockValidity(Chainstate &chainstate, const CBlock &block, const bool check_pow, const bool check_merkle_root)
Verify a block, including transactions.
static bool CheckBlockHeader(const CBlockHeader &block, BlockValidationState &state, const Consensus::Params &consensusParams, bool fCheckPOW=true)
bool IsBIP30Repeat(const CBlockIndex &block_index)
Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30)
static void SnapshotUTXOHashBreakpoint(const util::SignalInterrupt &interrupt)
static fs::path GetSnapshotCoinsDBPath(Chainstate &cs) EXCLUSIVE_LOCKS_REQUIRED(
static SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
static bool ContextualCheckBlockHeader(const CBlockHeader &block, BlockValidationState &state, BlockManager &blockman, const ChainstateManager &chainman, const CBlockIndex *pindexPrev) EXCLUSIVE_LOCKS_REQUIRED(
Context-dependent validity checks.
bool IsBIP30Unspendable(const uint256 &block_hash, int block_height)
Identifies blocks which coinbase output was subsequently overwritten in the UTXO set (see BIP30)
TRACEPOINT_SEMAPHORE(validation, block_connected)
static void LimitValidationInterfaceQueue(ValidationSignals &signals) LOCKS_EXCLUDED(cs_main)
assert(!tx.IsCoinBase())
static constexpr int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
Definition: validation.h:86
static const unsigned int MIN_BLOCKS_TO_KEEP
Block files containing a block-height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pr...
Definition: validation.h:72
SnapshotCompletionResult
Definition: validation.h:850
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:89
constexpr std::array FlushStateModeNames
Definition: validation.h:457
constexpr int64_t LargeCoinsCacheThreshold(int64_t total_space) noexcept
Definition: validation.h:509
VerifyDBResult
Definition: validation.h:422
FlushStateMode
Definition: validation.h:458
CoinsCacheSizeState
Definition: validation.h:501
@ LARGE
The cache is at >= 90% capacity.
@ CRITICAL
The coins cache is in immediate need of a flush.
DisconnectResult
Definition: validation.h:448
@ DISCONNECT_FAILED
Definition: validation.h:451
@ DISCONNECT_UNCLEAN
Definition: validation.h:450
@ DISCONNECT_OK
Definition: validation.h:449