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