Bitcoin Core 31.1.0
P2P Digital Currency
Loading...
Searching...
No Matches
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/timer.h>
32#include <node/blockstorage.h>
33#include <node/utxo_snapshot.h>
35#include <policy/policy.h>
36#include <policy/rbf.h>
37#include <policy/settings.h>
38#include <policy/truc_policy.h>
39#include <pow.h>
40#include <primitives/block.h>
42#include <random.h>
43#include <script/script.h>
44#include <script/sigcache.h>
45#include <signet.h>
46#include <tinyformat.h>
47#include <txdb.h>
48#include <txmempool.h>
49#include <uint256.h>
50#include <undo.h>
51#include <util/check.h>
52#include <util/fs.h>
53#include <util/fs_helpers.h>
54#include <util/hasher.h>
55#include <util/log.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
96static constexpr auto DATABASE_WRITE_INTERVAL_MIN{50min};
97static constexpr auto DATABASE_WRITE_INTERVAL_MAX{70min};
99static constexpr std::chrono::hours MAX_FEE_ESTIMATION_TIP_AGE{3};
100const std::vector<std::string> CHECKLEVEL_DOC {
101 "level 0 reads the blocks from disk",
102 "level 1 verifies block validity",
103 "level 2 verifies undo data",
104 "level 3 checks disconnection of tip blocks",
105 "level 4 tries to reconnect the blocks",
106 "each level includes the checks of the previous levels",
107};
108
113static constexpr int PRUNE_LOCK_BUFFER{10};
114
115// Return whether the completed full flush should compact chainstate
116static bool ShouldCompactChainstate(bool in_ibd)
117{
118 static constexpr uint32_t flush_ratio{320}; // Roughly every 2 weeks with hourly flushes
119 return !in_ibd && FastRandomContext().randrange(flush_ratio) == 0;
120}
121
122TRACEPOINT_SEMAPHORE(validation, block_connected);
123TRACEPOINT_SEMAPHORE(utxocache, flush);
124TRACEPOINT_SEMAPHORE(mempool, replaced);
125TRACEPOINT_SEMAPHORE(mempool, rejected);
126
128{
130
131 // Find the latest block common to locator and chain - we expect that
132 // locator.vHave is sorted descending by height.
133 for (const uint256& hash : locator.vHave) {
134 const CBlockIndex* pindex{m_blockman.LookupBlockIndex(hash)};
135 if (pindex) {
136 if (m_chain.Contains(pindex)) {
137 return pindex;
138 }
139 if (pindex->GetAncestor(m_chain.Height()) == m_chain.Tip()) {
140 return m_chain.Tip();
141 }
142 }
143 }
144 return m_chain.Genesis();
145}
146
148 const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
149 bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
150 ValidationCache& validation_cache,
151 std::vector<CScriptCheck>* pvChecks = nullptr)
153
154bool CheckFinalTxAtTip(const CBlockIndex& active_chain_tip, const CTransaction& tx)
155{
157
158 // CheckFinalTxAtTip() uses active_chain_tip.Height()+1 to evaluate
159 // nLockTime because when IsFinalTx() is called within
160 // AcceptBlock(), the height of the block *being*
161 // evaluated is what is used. Thus if we want to know if a
162 // transaction can be part of the *next* block, we need to call
163 // IsFinalTx() with one more than active_chain_tip.Height().
164 const int nBlockHeight = active_chain_tip.nHeight + 1;
165
166 // BIP113 requires that time-locked transactions have nLockTime set to
167 // less than the median time of the previous block they're contained in.
168 // When the next block is created its previous block will be the current
169 // chain tip, so we use that to calculate the median time passed to
170 // IsFinalTx().
171 const int64_t nBlockTime{active_chain_tip.GetMedianTimePast()};
172
173 return IsFinalTx(tx, nBlockHeight, nBlockTime);
174}
175
176namespace {
187std::optional<std::vector<int>> CalculatePrevHeights(
188 const CBlockIndex& tip,
189 const CCoinsView& coins,
190 const CTransaction& tx)
191{
192 std::vector<int> prev_heights;
193 prev_heights.resize(tx.vin.size());
194 for (size_t i = 0; i < tx.vin.size(); ++i) {
195 if (auto coin{coins.GetCoin(tx.vin[i].prevout)}) {
196 prev_heights[i] = coin->nHeight == MEMPOOL_HEIGHT
197 ? tip.nHeight + 1 // Assume all mempool transaction confirm in the next block.
198 : coin->nHeight;
199 } else {
200 LogInfo("ERROR: %s: Missing input %d in transaction \'%s\'\n", __func__, i, tx.GetHash().GetHex());
201 return std::nullopt;
202 }
203 }
204 return prev_heights;
205}
206} // namespace
207
208std::optional<LockPoints> CalculateLockPointsAtTip(
209 CBlockIndex* tip,
210 const CCoinsView& coins_view,
211 const CTransaction& tx)
212{
213 assert(tip);
214
215 auto prev_heights{CalculatePrevHeights(*tip, coins_view, tx)};
216 if (!prev_heights.has_value()) return std::nullopt;
217
218 CBlockIndex next_tip;
219 next_tip.pprev = tip;
220 // When SequenceLocks() is called within ConnectBlock(), the height
221 // of the block *being* evaluated is what is used.
222 // Thus if we want to know if a transaction can be part of the
223 // *next* block, we need to use one more than active_chainstate.m_chain.Height()
224 next_tip.nHeight = tip->nHeight + 1;
225 const auto [min_height, min_time] = CalculateSequenceLocks(tx, STANDARD_LOCKTIME_VERIFY_FLAGS, prev_heights.value(), next_tip);
226
227 // Also store the hash of the block with the highest height of
228 // all the blocks which have sequence locked prevouts.
229 // This hash needs to still be on the chain
230 // for these LockPoint calculations to be valid
231 // Note: It is impossible to correctly calculate a maxInputBlock
232 // if any of the sequence locked inputs depend on unconfirmed txs,
233 // except in the special case where the relative lock time/height
234 // is 0, which is equivalent to no sequence lock. Since we assume
235 // input height of tip+1 for mempool txs and test the resulting
236 // min_height and min_time from CalculateSequenceLocks against tip+1.
237 int max_input_height{0};
238 for (const int height : prev_heights.value()) {
239 // Can ignore mempool inputs since we'll fail if they had non-zero locks
240 if (height != next_tip.nHeight) {
241 max_input_height = std::max(max_input_height, height);
242 }
243 }
244
245 // tip->GetAncestor(max_input_height) should never return a nullptr
246 // because max_input_height is always less than the tip height.
247 // It would, however, be a bad bug to continue execution, since a
248 // LockPoints object with the maxInputBlock member set to nullptr
249 // signifies no relative lock time.
250 return LockPoints{min_height, min_time, Assert(tip->GetAncestor(max_input_height))};
251}
252
254 const LockPoints& lock_points)
255{
256 assert(tip != nullptr);
257
258 CBlockIndex index;
259 index.pprev = tip;
260 // CheckSequenceLocksAtTip() uses active_chainstate.m_chain.Height()+1 to evaluate
261 // height based locks because when SequenceLocks() is called within
262 // ConnectBlock(), the height of the block *being*
263 // evaluated is what is used.
264 // Thus if we want to know if a transaction can be part of the
265 // *next* block, we need to use one more than active_chainstate.m_chain.Height()
266 index.nHeight = tip->nHeight + 1;
267
268 return EvaluateSequenceLocks(index, {lock_points.height, lock_points.time});
269}
270
271static void LimitMempoolSize(CTxMemPool& pool, CCoinsViewCache& coins_cache)
273{
275 AssertLockHeld(pool.cs);
276 int expired = pool.Expire(GetTime<std::chrono::seconds>() - pool.m_opts.expiry);
277 if (expired != 0) {
278 LogDebug(BCLog::MEMPOOL, "Expired %i transactions from the memory pool\n", expired);
279 }
280
281 std::vector<COutPoint> vNoSpendsRemaining;
282 pool.TrimToSize(pool.m_opts.max_size_bytes, &vNoSpendsRemaining);
283 for (const COutPoint& removed : vNoSpendsRemaining)
284 coins_cache.Uncache(removed);
285}
286
288{
290 if (active_chainstate.m_chainman.IsInitialBlockDownload()) {
291 return false;
292 }
293 if (active_chainstate.m_chain.Tip()->GetBlockTime() < count_seconds(GetTime<std::chrono::seconds>() - MAX_FEE_ESTIMATION_TIP_AGE))
294 return false;
295 if (active_chainstate.m_chain.Height() < active_chainstate.m_chainman.m_best_header->nHeight - 1) {
296 return false;
297 }
298 return true;
299}
300
302 DisconnectedBlockTransactions& disconnectpool,
303 bool fAddToMempool)
304{
305 if (!m_mempool) return;
306
309 std::vector<Txid> vHashUpdate;
310 {
311 // disconnectpool is ordered so that the front is the most recently-confirmed
312 // transaction (the last tx of the block at the tip) in the disconnected chain.
313 // Iterate disconnectpool in reverse, so that we add transactions
314 // back to the mempool starting with the earliest transaction that had
315 // been previously seen in a block.
316 const auto queuedTx = disconnectpool.take();
317 auto it = queuedTx.rbegin();
318 while (it != queuedTx.rend()) {
319 // ignore validation errors in resurrected transactions
320 if (!fAddToMempool || (*it)->IsCoinBase() ||
321 AcceptToMemoryPool(*this, *it, GetTime(),
322 /*bypass_limits=*/true, /*test_accept=*/false).m_result_type !=
324 // If the transaction doesn't make it in to the mempool, remove any
325 // transactions that depend on it (which would now be orphans).
326 m_mempool->removeRecursive(**it, MemPoolRemovalReason::REORG);
327 } else if (m_mempool->exists((*it)->GetHash())) {
328 vHashUpdate.push_back((*it)->GetHash());
329 }
330 ++it;
331 }
332 }
333
334 // AcceptToMemoryPool/addNewTransaction all assume that new mempool entries have
335 // no in-mempool children, which is generally not true when adding
336 // previously-confirmed transactions back to the mempool.
337 // UpdateTransactionsFromBlock finds descendants of any transactions in
338 // the disconnectpool that were added back and cleans up the mempool state.
339 m_mempool->UpdateTransactionsFromBlock(vHashUpdate);
340
341 // Predicate to use for filtering transactions in removeForReorg.
342 // Checks whether the transaction is still final and, if it spends a coinbase output, mature.
343 // Also updates valid entries' cached LockPoints if needed.
344 // If false, the tx is still valid and its lockpoints are updated.
345 // If true, the tx would be invalid in the next block; remove this entry and all of its descendants.
346 // Note that TRUC rules are not applied here, so reorgs may cause violations of TRUC inheritance or
347 // topology restrictions.
348 const auto filter_final_and_mature = [&](CTxMemPool::txiter it)
352 const CTransaction& tx = it->GetTx();
353
354 // The transaction must be final.
355 if (!CheckFinalTxAtTip(*Assert(m_chain.Tip()), tx)) return true;
356
357 const LockPoints& lp = it->GetLockPoints();
358 // CheckSequenceLocksAtTip checks if the transaction will be final in the next block to be
359 // created on top of the new chain.
361 if (!CheckSequenceLocksAtTip(m_chain.Tip(), lp)) {
362 return true;
363 }
364 } else {
365 const CCoinsViewMemPool view_mempool{&CoinsTip(), *m_mempool};
366 const std::optional<LockPoints> new_lock_points{CalculateLockPointsAtTip(m_chain.Tip(), view_mempool, tx)};
367 if (new_lock_points.has_value() && CheckSequenceLocksAtTip(m_chain.Tip(), *new_lock_points)) {
368 // Now update the mempool entry lockpoints as well.
369 it->UpdateLockPoints(*new_lock_points);
370 } else {
371 return true;
372 }
373 }
374
375 // If the transaction spends any coinbase outputs, it must be mature.
376 if (it->GetSpendsCoinbase()) {
377 for (const CTxIn& txin : tx.vin) {
378 if (m_mempool->exists(txin.prevout.hash)) continue;
379 const Coin& coin{CoinsTip().AccessCoin(txin.prevout)};
380 assert(!coin.IsSpent());
381 const auto mempool_spend_height{m_chain.Tip()->nHeight + 1};
382 if (coin.IsCoinBase() && mempool_spend_height - coin.nHeight < COINBASE_MATURITY) {
383 return true;
384 }
385 }
386 }
387 // Transaction is still valid and cached LockPoints are updated.
388 return false;
389 };
390
391 // We also need to remove any now-immature transactions
392 m_mempool->removeForReorg(m_chain, filter_final_and_mature);
393 // Re-limit mempool size, in case we added any transactions
395}
396
403 const CCoinsViewCache& view, const CTxMemPool& pool,
405 ValidationCache& validation_cache)
407{
410
412 for (const CTxIn& txin : tx.vin) {
413 const Coin& coin = view.AccessCoin(txin.prevout);
414
415 // This coin was checked in PreChecks and MemPoolAccept
416 // has been holding cs_main since then.
417 Assume(!coin.IsSpent());
418 if (coin.IsSpent()) return false;
419
420 // If the Coin is available, there are 2 possibilities:
421 // it is available in our current ChainstateActive UTXO set,
422 // or it's a UTXO provided by a transaction in our mempool.
423 // Ensure the scriptPubKeys in Coins from CoinsView are correct.
424 const CTransactionRef& txFrom = pool.get(txin.prevout.hash);
425 if (txFrom) {
426 assert(txFrom->GetHash() == txin.prevout.hash);
427 assert(txFrom->vout.size() > txin.prevout.n);
428 assert(txFrom->vout[txin.prevout.n] == coin.out);
429 } else {
430 const Coin& coinFromUTXOSet = coins_tip.AccessCoin(txin.prevout);
431 assert(!coinFromUTXOSet.IsSpent());
432 assert(coinFromUTXOSet.out == coin.out);
433 }
434 }
435
436 // Call CheckInputScripts() to cache signature and script validity against current tip consensus rules.
437 return CheckInputScripts(tx, state, view, flags, /* cacheSigStore= */ true, /* cacheFullScriptStore= */ true, txdata, validation_cache);
438}
439
440namespace {
441
442class MemPoolAccept
443{
444public:
445 explicit MemPoolAccept(CTxMemPool& mempool, Chainstate& active_chainstate) :
446 m_pool(mempool),
447 m_view(&m_dummy),
448 m_viewmempool(&active_chainstate.CoinsTip(), m_pool),
449 m_active_chainstate(active_chainstate)
450 {
451 }
452
453 // We put the arguments we're handed into a struct, so we can pass them
454 // around easier.
455 struct ATMPArgs {
456 const CChainParams& m_chainparams;
457 const int64_t m_accept_time;
458 const bool m_bypass_limits;
459 /*
460 * Return any outpoints which were not previously present in the coins
461 * cache, but were added as a result of validating the tx for mempool
462 * acceptance. This allows the caller to optionally remove the cache
463 * additions if the associated transaction ends up being rejected by
464 * the mempool.
465 */
466 std::vector<COutPoint>& m_coins_to_uncache;
468 const bool m_test_accept;
472 const bool m_allow_replacement;
474 const bool m_allow_sibling_eviction;
477 const bool m_package_submission;
481 const bool m_package_feerates;
486 const std::optional<CFeeRate> m_client_maxfeerate;
487
489 static ATMPArgs SingleAccept(const CChainParams& chainparams, int64_t accept_time,
490 bool bypass_limits, std::vector<COutPoint>& coins_to_uncache,
491 bool test_accept) {
492 return ATMPArgs{/*chainparams=*/ chainparams,
493 /*accept_time=*/ accept_time,
494 /*bypass_limits=*/ bypass_limits,
495 /*coins_to_uncache=*/ coins_to_uncache,
496 /*test_accept=*/ test_accept,
497 /*allow_replacement=*/ true,
498 /*allow_sibling_eviction=*/ true,
499 /*package_submission=*/ false,
500 /*package_feerates=*/ false,
501 /*client_maxfeerate=*/ {}, // checked by caller
502 };
503 }
504
506 static ATMPArgs PackageTestAccept(const CChainParams& chainparams, int64_t accept_time,
507 std::vector<COutPoint>& coins_to_uncache) {
508 return ATMPArgs{/*chainparams=*/ chainparams,
509 /*accept_time=*/ accept_time,
510 /*bypass_limits=*/ false,
511 /*coins_to_uncache=*/ coins_to_uncache,
512 /*test_accept=*/ true,
513 /*allow_replacement=*/ false,
514 /*allow_sibling_eviction=*/ false,
515 /*package_submission=*/ false, // not submitting to mempool
516 /*package_feerates=*/ false,
517 /*client_maxfeerate=*/ {}, // checked by caller
518 };
519 }
520
522 static ATMPArgs PackageChildWithParents(const CChainParams& chainparams, int64_t accept_time,
523 std::vector<COutPoint>& coins_to_uncache, const std::optional<CFeeRate>& client_maxfeerate) {
524 return ATMPArgs{/*chainparams=*/ chainparams,
525 /*accept_time=*/ accept_time,
526 /*bypass_limits=*/ false,
527 /*coins_to_uncache=*/ coins_to_uncache,
528 /*test_accept=*/ false,
529 /*allow_replacement=*/ true,
530 /*allow_sibling_eviction=*/ false,
531 /*package_submission=*/ true,
532 /*package_feerates=*/ true,
533 /*client_maxfeerate=*/ client_maxfeerate,
534 };
535 }
536
538 static ATMPArgs SingleInPackageAccept(const ATMPArgs& package_args) {
539 return ATMPArgs{/*chainparams=*/ package_args.m_chainparams,
540 /*accept_time=*/ package_args.m_accept_time,
541 /*bypass_limits=*/ false,
542 /*coins_to_uncache=*/ package_args.m_coins_to_uncache,
543 /*test_accept=*/ package_args.m_test_accept,
544 /*allow_replacement=*/ true,
545 /*allow_sibling_eviction=*/ true,
546 /*package_submission=*/ true, // trim at the end of AcceptPackage()
547 /*package_feerates=*/ false, // only 1 transaction
548 /*client_maxfeerate=*/ package_args.m_client_maxfeerate,
549 };
550 }
551
552 private:
553 // Private ctor to avoid exposing details to clients and allowing the possibility of
554 // mixing up the order of the arguments. Use static functions above instead.
555 ATMPArgs(const CChainParams& chainparams,
556 int64_t accept_time,
557 bool bypass_limits,
558 std::vector<COutPoint>& coins_to_uncache,
559 bool test_accept,
560 bool allow_replacement,
561 bool allow_sibling_eviction,
562 bool package_submission,
563 bool package_feerates,
564 std::optional<CFeeRate> client_maxfeerate)
565 : m_chainparams{chainparams},
566 m_accept_time{accept_time},
567 m_bypass_limits{bypass_limits},
568 m_coins_to_uncache{coins_to_uncache},
569 m_test_accept{test_accept},
570 m_allow_replacement{allow_replacement},
571 m_allow_sibling_eviction{allow_sibling_eviction},
572 m_package_submission{package_submission},
573 m_package_feerates{package_feerates},
574 m_client_maxfeerate{client_maxfeerate}
575 {
576 // If we are using package feerates, we must be doing package submission.
577 // It also means sibling eviction is not permitted.
578 if (m_package_feerates) {
579 Assume(m_package_submission);
580 Assume(!m_allow_sibling_eviction);
581 }
582 if (m_allow_sibling_eviction) Assume(m_allow_replacement);
583 }
584 };
585
587 void CleanupTemporaryCoins() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
588
589 // Single transaction acceptance
590 MempoolAcceptResult AcceptSingleTransactionAndCleanup(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
591 LOCK(m_pool.cs);
592 MempoolAcceptResult result = AcceptSingleTransactionInternal(ptx, args);
593 ClearSubPackageState();
594 return result;
595 }
596 MempoolAcceptResult AcceptSingleTransactionInternal(const CTransactionRef& ptx, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
597
603 PackageMempoolAcceptResult AcceptMultipleTransactionsAndCleanup(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
604 LOCK(m_pool.cs);
605 PackageMempoolAcceptResult result = AcceptMultipleTransactionsInternal(txns, args);
606 ClearSubPackageState();
607 return result;
608 }
609 PackageMempoolAcceptResult AcceptMultipleTransactionsInternal(const std::vector<CTransactionRef>& txns, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
610
621 PackageMempoolAcceptResult AcceptSubPackage(const std::vector<CTransactionRef>& subpackage, ATMPArgs& args)
623
628 PackageMempoolAcceptResult AcceptPackage(const Package& package, ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main);
629
630private:
631 // All the intermediate state that gets passed between the various levels
632 // of checking a given transaction.
633 struct Workspace {
634 explicit Workspace(const CTransactionRef& ptx) : m_ptx(ptx), m_hash(ptx->GetHash()) {}
637 std::set<Txid> m_conflicts;
640 CTxMemPool::setEntries m_iters_conflicting;
642 std::vector<CTxMemPoolEntry::CTxMemPoolEntryRef> m_parents;
643 /* Handle to the tx in the changeset */
647 bool m_sibling_eviction{false};
648
651 int64_t m_vsize;
653 CAmount m_base_fees;
655 CAmount m_modified_fees;
656
660 CFeeRate m_package_feerate{0};
661
662 const CTransactionRef& m_ptx;
664 const Txid& m_hash;
665 TxValidationState m_state;
668 PrecomputedTransactionData m_precomputed_txdata;
669 };
670
671 // Run the policy checks on a given transaction, excluding any script checks.
672 // Looks up inputs, calculates feerate, considers replacement, evaluates
673 // package limits, etc. As this function can be invoked for "free" by a peer,
674 // only tests that are fast should be done here (to avoid CPU DoS).
675 bool PreChecks(ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
676
677 // Run checks for mempool replace-by-fee, only used in AcceptSingleTransaction.
678 bool ReplacementChecks(Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
679
680 bool PackageRBFChecks(const std::vector<CTransactionRef>& txns,
681 std::vector<Workspace>& workspaces,
682 int64_t total_vsize,
683 PackageValidationState& package_state) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
684
685 // Run the script checks using our policy flags. As this can be slow, we should
686 // only invoke this on transactions that have otherwise passed policy checks.
687 bool PolicyScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
688
689 // Re-run the script checks, using consensus flags, and try to cache the
690 // result in the scriptcache. This should be done after
691 // PolicyScriptChecks(). This requires that all inputs either be in our
692 // utxo set or in the mempool.
693 bool ConsensusScriptChecks(const ATMPArgs& args, Workspace& ws) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
694
695 // Try to add the transaction to the mempool, removing any conflicts first.
696 void FinalizeSubpackage(const ATMPArgs& args) EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs);
697
698 // Submit all transactions to the mempool and call ConsensusScriptChecks to add to the script
699 // cache - should only be called after successful validation of all transactions in the package.
700 // Does not call LimitMempoolSize(), so mempool max_size_bytes may be temporarily exceeded.
701 bool SubmitPackage(const ATMPArgs& args, std::vector<Workspace>& workspaces, PackageValidationState& package_state,
702 std::map<Wtxid, MempoolAcceptResult>& results)
704
705 // Compare a package's feerate against minimum allowed.
706 bool CheckFeeRate(size_t package_size, CAmount package_fee, TxValidationState& state) EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs)
707 {
709 AssertLockHeld(m_pool.cs);
710 CAmount mempoolRejectFee = m_pool.GetMinFee().GetFee(package_size);
711 if (mempoolRejectFee > 0 && package_fee < mempoolRejectFee) {
712 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "mempool min fee not met", strprintf("%d < %d", package_fee, mempoolRejectFee));
713 }
714
715 if (package_fee < m_pool.m_opts.min_relay_feerate.GetFee(package_size)) {
716 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "min relay fee not met",
717 strprintf("%d < %d", package_fee, m_pool.m_opts.min_relay_feerate.GetFee(package_size)));
718 }
719 return true;
720 }
721
722 ValidationCache& GetValidationCache()
723 {
724 return m_active_chainstate.m_chainman.m_validation_cache;
725 }
726
727private:
728 CTxMemPool& m_pool;
729
741 CCoinsViewCache m_view;
742
743 // These are the two possible backends for m_view.
746 CCoinsViewMemPool m_viewmempool;
750 CCoinsView m_dummy;
751
752 Chainstate& m_active_chainstate;
753
754 // Fields below are per *sub*package state and must be reset prior to subsequent
755 // AcceptSingleTransaction and AcceptMultipleTransactions invocations
756 struct SubPackageState {
758 CAmount m_total_modified_fees{0};
760 int64_t m_total_vsize{0};
761
762 // RBF-related members
765 bool m_rbf{false};
767 std::list<CTransactionRef> m_replaced_transactions;
768 /* Changeset representing adding transactions and removing their conflicts. */
769 std::unique_ptr<CTxMemPool::ChangeSet> m_changeset;
770
772 CAmount m_conflicting_fees{0};
774 size_t m_conflicting_size{0};
775 };
776
777 struct SubPackageState m_subpackage;
778
780 void ClearSubPackageState() EXCLUSIVE_LOCKS_REQUIRED(cs_main, m_pool.cs)
781 {
782 m_subpackage = SubPackageState{};
783
784 // And clean coins while at it
785 CleanupTemporaryCoins();
786 }
787};
788
789bool MemPoolAccept::PreChecks(ATMPArgs& args, Workspace& ws)
790{
792 AssertLockHeld(m_pool.cs);
793 const CTransactionRef& ptx = ws.m_ptx;
794 const CTransaction& tx = *ws.m_ptx;
795 const Txid& hash = ws.m_hash;
796
797 // Copy/alias what we need out of args
798 const int64_t nAcceptTime = args.m_accept_time;
799 const bool bypass_limits = args.m_bypass_limits;
800 std::vector<COutPoint>& coins_to_uncache = args.m_coins_to_uncache;
801
802 // Alias what we need out of ws
803 TxValidationState& state = ws.m_state;
804
805 if (!CheckTransaction(tx, state)) {
806 return false; // state filled in by CheckTransaction
807 }
808
809 // Coinbase is only valid in a block, not as a loose transaction
810 if (tx.IsCoinBase())
811 return state.Invalid(TxValidationResult::TX_CONSENSUS, "coinbase");
812
813 // Rather not work on nonstandard transactions (unless -testnet/-regtest)
814 std::string reason;
816 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, reason);
817 }
818
819 // Transactions smaller than 65 non-witness bytes are not relayed to mitigate CVE-2017-12842.
821 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "tx-size-small");
822
823 // Only accept nLockTime-using transactions that can be mined in the next
824 // block; we don't want our mempool filled up with transactions that can't
825 // be mined yet.
826 if (!CheckFinalTxAtTip(*Assert(m_active_chainstate.m_chain.Tip()), tx)) {
827 return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-final");
828 }
829
830 if (m_pool.exists(tx.GetWitnessHash())) {
831 // Exact transaction already exists in the mempool.
832 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-in-mempool");
833 } else if (m_pool.exists(tx.GetHash())) {
834 // Transaction with the same non-witness data but different witness (same txid, different
835 // wtxid) already exists in the mempool.
836 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-same-nonwitness-data-in-mempool");
837 }
838
839 // Check for conflicts with in-memory transactions
840 for (const CTxIn &txin : tx.vin)
841 {
842 const CTransaction* ptxConflicting = m_pool.GetConflictTx(txin.prevout);
843 if (ptxConflicting) {
844 if (!args.m_allow_replacement) {
845 // Transaction conflicts with a mempool tx, but we're not allowing replacements in this context.
846 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "bip125-replacement-disallowed");
847 }
848 ws.m_conflicts.insert(ptxConflicting->GetHash());
849 }
850 }
851
852 m_view.SetBackend(m_viewmempool);
853
854 const CCoinsViewCache& coins_cache = m_active_chainstate.CoinsTip();
855 // do all inputs exist?
856 for (const CTxIn& txin : tx.vin) {
857 if (!coins_cache.HaveCoinInCache(txin.prevout)) {
858 coins_to_uncache.push_back(txin.prevout);
859 }
860
861 // Note: this call may add txin.prevout to the coins cache
862 // (coins_cache.cacheCoins) by way of FetchCoin(). It should be removed
863 // later (via coins_to_uncache) if this tx turns out to be invalid.
864 if (!m_view.HaveCoin(txin.prevout)) {
865 // Are inputs missing because we already have the tx?
866 for (size_t out = 0; out < tx.vout.size(); out++) {
867 // Optimistically just do efficient check of cache for outputs
868 if (coins_cache.HaveCoinInCache(COutPoint(hash, out))) {
869 return state.Invalid(TxValidationResult::TX_CONFLICT, "txn-already-known");
870 }
871 }
872 // Otherwise assume this might be an orphan tx for which we just haven't seen parents yet
873 return state.Invalid(TxValidationResult::TX_MISSING_INPUTS, "bad-txns-inputs-missingorspent");
874 }
875 }
876
877 // This is const, but calls into the back end CoinsViews. The CCoinsViewDB at the bottom of the
878 // hierarchy brings the best block into scope. See CCoinsViewDB::GetBestBlock().
879 m_view.GetBestBlock();
880
881 // we have all inputs cached now, so switch back to dummy (to protect
882 // against bugs where we pull more inputs from disk that miss being added
883 // to coins_to_uncache)
884 m_view.SetBackend(m_dummy);
885
886 assert(m_active_chainstate.m_blockman.LookupBlockIndex(m_view.GetBestBlock()) == m_active_chainstate.m_chain.Tip());
887
888 // Only accept BIP68 sequence locked transactions that can be mined in the next
889 // block; we don't want our mempool filled up with transactions that can't
890 // be mined yet.
891 // Pass in m_view which has all of the relevant inputs cached. Note that, since m_view's
892 // backend was removed, it no longer pulls coins from the mempool.
893 const std::optional<LockPoints> lock_points{CalculateLockPointsAtTip(m_active_chainstate.m_chain.Tip(), m_view, tx)};
894 if (!lock_points.has_value() || !CheckSequenceLocksAtTip(m_active_chainstate.m_chain.Tip(), *lock_points)) {
895 return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "non-BIP68-final");
896 }
897
898 // The mempool holds txs for the next block, so pass height+1 to CheckTxInputs
899 if (!Consensus::CheckTxInputs(tx, state, m_view, m_active_chainstate.m_chain.Height() + 1, ws.m_base_fees)) {
900 return false; // state filled in by CheckTxInputs
901 }
902
903 if (m_pool.m_opts.require_standard && !AreInputsStandard(tx, m_view)) {
904 return state.Invalid(TxValidationResult::TX_INPUTS_NOT_STANDARD, "bad-txns-nonstandard-inputs");
905 }
906
907 // Check for non-standard witnesses.
908 if (tx.HasWitness() && m_pool.m_opts.require_standard && !IsWitnessStandard(tx, m_view)) {
909 return state.Invalid(TxValidationResult::TX_WITNESS_MUTATED, "bad-witness-nonstandard");
910 }
911
912 int64_t nSigOpsCost = GetTransactionSigOpCost(tx, m_view, STANDARD_SCRIPT_VERIFY_FLAGS);
913
914 // Keep track of transactions that spend a coinbase, which we re-scan
915 // during reorgs to ensure COINBASE_MATURITY is still met.
916 bool fSpendsCoinbase = false;
917 for (const CTxIn &txin : tx.vin) {
918 const Coin &coin = m_view.AccessCoin(txin.prevout);
919 if (coin.IsCoinBase()) {
920 fSpendsCoinbase = true;
921 break;
922 }
923 }
924
925 // Set entry_sequence to 0 when bypass_limits is used; this allows txs from a block
926 // reorg to be marked earlier than any child txs that were already in the mempool.
927 const uint64_t entry_sequence = bypass_limits ? 0 : m_pool.GetSequence();
928 if (!m_subpackage.m_changeset) {
929 m_subpackage.m_changeset = m_pool.GetChangeSet();
930 }
931 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());
932
933 // ws.m_modified_fees includes any fee deltas from PrioritiseTransaction
934 ws.m_modified_fees = ws.m_tx_handle->GetModifiedFee();
935
936 ws.m_vsize = ws.m_tx_handle->GetTxSize();
937
938 // Enforces 0-fee for dust transactions, no incentive to be mined alone
939 if (m_pool.m_opts.require_standard) {
940 if (!PreCheckEphemeralTx(*ptx, m_pool.m_opts.dust_relay_feerate, ws.m_base_fees, ws.m_modified_fees, state)) {
941 return false; // state filled in by PreCheckEphemeralTx
942 }
943 }
944
945 if (nSigOpsCost > MAX_STANDARD_TX_SIGOPS_COST)
946 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, "bad-txns-too-many-sigops",
947 strprintf("%d", nSigOpsCost));
948
949 // No individual transactions are allowed below the mempool min feerate except from disconnected
950 // blocks and transactions in a package. Package transactions will be checked using package
951 // feerate later.
952 if (!bypass_limits && !args.m_package_feerates && !CheckFeeRate(ws.m_vsize, ws.m_modified_fees, state)) return false;
953
954 ws.m_iters_conflicting = m_pool.GetIterSet(ws.m_conflicts);
955
956 ws.m_parents = m_pool.GetParents(*ws.m_tx_handle);
957
958 if (!args.m_bypass_limits) {
959 // Perform the TRUC checks, using the in-mempool parents.
960 if (const auto err{SingleTRUCChecks(m_pool, ws.m_ptx, ws.m_parents, ws.m_conflicts, ws.m_vsize)}) {
961 // Single transaction contexts only.
962 if (args.m_allow_sibling_eviction && err->second != nullptr) {
963 // We should only be considering where replacement is considered valid as well.
964 Assume(args.m_allow_replacement);
965 // Potential sibling eviction. Add the sibling to our list of mempool conflicts to be
966 // included in RBF checks.
967 ws.m_conflicts.insert(err->second->GetHash());
968 // Adding the sibling to m_iters_conflicting here means that it doesn't count towards
969 // RBF Carve Out above. This is correct, since removing to-be-replaced transactions from
970 // the descendant count is done separately in SingleTRUCChecks for TRUC transactions.
971 ws.m_iters_conflicting.insert(m_pool.GetIter(err->second->GetHash()).value());
972 ws.m_sibling_eviction = true;
973 // The sibling will be treated as part of the to-be-replaced set in ReplacementChecks.
974 // Note that we are not checking whether it opts in to replaceability via BIP125 or TRUC
975 // (which is normally done in PreChecks). However, the only way a TRUC transaction can
976 // have a non-TRUC and non-BIP125 descendant is due to a reorg.
977 } else {
978 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "TRUC-violation", err->first);
979 }
980 }
981 }
982
983 // We want to detect conflicts in any tx in a package to trigger package RBF logic
984 m_subpackage.m_rbf |= !ws.m_conflicts.empty();
985 return true;
986}
987
988bool MemPoolAccept::ReplacementChecks(Workspace& ws)
989{
991 AssertLockHeld(m_pool.cs);
992
993 const CTransaction& tx = *ws.m_ptx;
994 const Txid& hash = ws.m_hash;
995 TxValidationState& state = ws.m_state;
996
997 CFeeRate newFeeRate(ws.m_modified_fees, ws.m_vsize);
998
999 CTxMemPool::setEntries all_conflicts;
1000
1001 // Calculate all conflicting entries and enforce Rule #5.
1002 if (const auto err_string{GetEntriesForConflicts(tx, m_pool, ws.m_iters_conflicting, all_conflicts)}) {
1004 strprintf("too many potential replacements%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1005 }
1006
1007 // Check if it's economically rational to mine this transaction rather than the ones it
1008 // replaces and pays for its own relay fees. Enforce Rules #3 and #4.
1009 for (CTxMemPool::txiter it : all_conflicts) {
1010 m_subpackage.m_conflicting_fees += it->GetModifiedFee();
1011 m_subpackage.m_conflicting_size += it->GetTxSize();
1012 }
1013
1014 if (const auto err_string{PaysForRBF(m_subpackage.m_conflicting_fees, ws.m_modified_fees, ws.m_vsize,
1015 m_pool.m_opts.incremental_relay_feerate, hash)}) {
1016 // Result may change in a package context
1018 strprintf("insufficient fee%s", ws.m_sibling_eviction ? " (including sibling eviction)" : ""), *err_string);
1019 }
1020
1021 // Add all the to-be-removed transactions to the changeset.
1022 for (auto it : all_conflicts) {
1023 m_subpackage.m_changeset->StageRemoval(it);
1024 }
1025
1026 // Run cluster size limit checks and fail if we exceed them.
1027 if (!m_subpackage.m_changeset->CheckMemPoolPolicyLimits()) {
1028 return state.Invalid(TxValidationResult::TX_MEMPOOL_POLICY, "too-large-cluster", "");
1029 }
1030
1031 if (const auto err_string{ImprovesFeerateDiagram(*m_subpackage.m_changeset)}) {
1032 // We checked above for the cluster size limits being respected, so a
1033 // failure here can only be due to an insufficient fee.
1034 Assume(err_string->first == DiagramCheckError::FAILURE);
1035 return state.Invalid(TxValidationResult::TX_RECONSIDERABLE, "replacement-failed", err_string->second);
1036 }
1037
1038 return true;
1039}
1040
1041bool MemPoolAccept::PackageRBFChecks(const std::vector<CTransactionRef>& txns,
1042 std::vector<Workspace>& workspaces,
1043 const int64_t total_vsize,
1044 PackageValidationState& package_state)
1045{
1047 AssertLockHeld(m_pool.cs);
1048
1049 assert(std::all_of(txns.cbegin(), txns.cend(), [this](const auto& tx)
1050 { return !m_pool.exists(tx->GetHash());}));
1051
1052 assert(txns.size() == workspaces.size());
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));
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 (!args.m_bypass_limits && 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));
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)) 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, PackageRBFChecks() 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 (m_subpackage.m_rbf && !PackageRBFChecks(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)) {
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 m_connect_block_view = std::make_unique<CoinsViewOverlay>(&*m_cacheview);
1865}
1866
1868 CTxMemPool* mempool,
1869 BlockManager& blockman,
1870 ChainstateManager& chainman,
1871 std::optional<uint256> from_snapshot_blockhash)
1872 : m_mempool(mempool),
1873 m_blockman(blockman),
1874 m_chainman(chainman),
1875 m_assumeutxo(from_snapshot_blockhash ? Assumeutxo::UNVALIDATED : Assumeutxo::VALIDATED),
1876 m_from_snapshot_blockhash(from_snapshot_blockhash) {}
1877
1879{
1880 fs::path path{m_chainman.m_options.datadir / "chainstate"};
1883 }
1884 return path;
1885}
1886
1887const CBlockIndex* Chainstate::SnapshotBase() const
1888{
1889 if (!m_from_snapshot_blockhash) return nullptr;
1890 if (!m_cached_snapshot_base) m_cached_snapshot_base = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_from_snapshot_blockhash));
1891 return m_cached_snapshot_base;
1892}
1893
1894const CBlockIndex* Chainstate::TargetBlock() const
1895{
1896 if (!m_target_blockhash) return nullptr;
1897 if (!m_cached_target_block) m_cached_target_block = Assert(m_chainman.m_blockman.LookupBlockIndex(*m_target_blockhash));
1898 return m_cached_target_block;
1899}
1900
1901void Chainstate::SetTargetBlock(CBlockIndex* block)
1902{
1903 if (block) {
1904 m_target_blockhash = block->GetBlockHash();
1905 } else {
1906 m_target_blockhash.reset();
1907 }
1908 m_cached_target_block = block;
1909}
1910
1911void Chainstate::SetTargetBlockHash(uint256 block_hash)
1912{
1913 m_target_blockhash = block_hash;
1914 m_cached_target_block = nullptr;
1915}
1916
1918 size_t cache_size_bytes,
1919 bool in_memory,
1920 bool should_wipe)
1921{
1922 m_coins_views = std::make_unique<CoinsViews>(
1923 DBParams{
1924 .path = StoragePath(),
1925 .cache_bytes = cache_size_bytes,
1926 .memory_only = in_memory,
1927 .wipe_data = should_wipe,
1928 .obfuscate = true,
1929 .options = m_chainman.m_options.coins_db},
1930 m_chainman.m_options.coins_view);
1931
1932 m_coinsdb_cache_size_bytes = cache_size_bytes;
1933}
1934
1935void Chainstate::InitCoinsCache(size_t cache_size_bytes)
1936{
1938 assert(m_coins_views != nullptr);
1939 m_coinstip_cache_size_bytes = cache_size_bytes;
1940 m_coins_views->InitCache();
1941}
1942
1943// Lock-free: depends on `m_cached_is_ibd`, which is latched by `UpdateIBDStatus()`.
1945{
1946 return m_cached_is_ibd.load(std::memory_order_relaxed);
1947}
1948
1950{
1952
1953 if (this->GetRole().historical) {
1954 return;
1955 }
1956
1957 if (m_chainman.m_best_invalid && m_chainman.m_best_invalid->nChainWork > m_chain.Tip()->nChainWork + (GetBlockProof(*m_chain.Tip()) * 6)) {
1958 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.");
1959 m_chainman.GetNotifications().warningSet(
1961 _("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."));
1962 } else {
1963 m_chainman.GetNotifications().warningUnset(kernel::Warning::LARGE_WORK_INVALID_CHAIN);
1964 }
1965}
1966
1967// Called both upon regular invalid block discovery *and* InvalidateBlock
1969{
1971 if (!m_chainman.m_best_invalid || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork) {
1972 m_chainman.m_best_invalid = pindexNew;
1973 }
1974 SetBlockFailureFlags(pindexNew);
1975 if (m_chainman.m_best_header != nullptr && m_chainman.m_best_header->GetAncestor(pindexNew->nHeight) == pindexNew) {
1976 m_chainman.RecalculateBestHeader();
1977 }
1978
1979 LogInfo("%s: invalid block=%s height=%d log2_work=%f date=%s\n", __func__,
1980 pindexNew->GetBlockHash().ToString(), pindexNew->nHeight,
1981 log(pindexNew->nChainWork.getdouble())/log(2.0), FormatISO8601DateTime(pindexNew->GetBlockTime()));
1982 CBlockIndex *tip = m_chain.Tip();
1983 assert (tip);
1984 LogInfo("%s: current best=%s height=%d log2_work=%f date=%s\n", __func__,
1985 tip->GetBlockHash().ToString(), m_chain.Height(), log(tip->nChainWork.getdouble())/log(2.0),
1988}
1989
1990// Same as InvalidChainFound, above, except not called directly from InvalidateBlock,
1991// which does its own setBlockIndexCandidates management.
1993{
1996 pindex->nStatus |= BLOCK_FAILED_VALID;
1997 m_blockman.m_dirty_blockindex.insert(pindex);
1998 setBlockIndexCandidates.erase(pindex);
1999 InvalidChainFound(pindex);
2000 }
2001}
2002
2003void UpdateCoins(const CTransaction& tx, CCoinsViewCache& inputs, CTxUndo &txundo, int nHeight)
2004{
2005 // mark inputs spent
2006 if (!tx.IsCoinBase()) {
2007 txundo.vprevout.reserve(tx.vin.size());
2008 for (const CTxIn &txin : tx.vin) {
2009 txundo.vprevout.emplace_back();
2010 bool is_spent = inputs.SpendCoin(txin.prevout, &txundo.vprevout.back());
2011 assert(is_spent);
2012 }
2013 }
2014 // add outputs
2015 AddCoins(inputs, tx, nHeight);
2016}
2017
2018std::optional<std::pair<ScriptError, std::string>> CScriptCheck::operator()() {
2019 const CScript &scriptSig = ptxTo->vin[nIn].scriptSig;
2020 const CScriptWitness *witness = &ptxTo->vin[nIn].scriptWitness;
2022 if (VerifyScript(scriptSig, m_tx_out.scriptPubKey, witness, m_flags, CachingTransactionSignatureChecker(ptxTo, nIn, m_tx_out.nValue, cacheStore, *m_signature_cache, *txdata), &error)) {
2023 return std::nullopt;
2024 } else {
2025 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);
2026 return std::make_pair(error, std::move(debug_str));
2027 }
2028}
2029
2030ValidationCache::ValidationCache(const size_t script_execution_cache_bytes, const size_t signature_cache_bytes)
2031 : m_signature_cache{signature_cache_bytes}
2032{
2033 // Setup the salted hasher
2035 // We want the nonce to be 64 bytes long to force the hasher to process
2036 // this chunk, which makes later hash computations more efficient. We
2037 // just write our 32-byte entropy twice to fill the 64 bytes.
2038 m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2039 m_script_execution_cache_hasher.Write(nonce.begin(), 32);
2040
2041 const auto [num_elems, approx_size_bytes] = m_script_execution_cache.setup_bytes(script_execution_cache_bytes);
2042 LogInfo("Using %zu MiB out of %zu MiB requested for script execution cache, able to store %zu elements",
2043 approx_size_bytes >> 20, script_execution_cache_bytes >> 20, num_elems);
2044}
2045
2066 const CCoinsViewCache& inputs, script_verify_flags flags, bool cacheSigStore,
2067 bool cacheFullScriptStore, PrecomputedTransactionData& txdata,
2068 ValidationCache& validation_cache,
2069 std::vector<CScriptCheck>* pvChecks)
2070{
2071 if (tx.IsCoinBase()) return true;
2072
2073 if (pvChecks) {
2074 pvChecks->reserve(tx.vin.size());
2075 }
2076
2077 // First check if script executions have been cached with the same
2078 // flags. Note that this assumes that the inputs provided are
2079 // correct (ie that the transaction hash which is in tx's prevouts
2080 // properly commits to the scriptPubKey in the inputs view of that
2081 // transaction).
2082 uint256 hashCacheEntry;
2083 CSHA256 hasher = validation_cache.ScriptExecutionCacheHasher();
2084 hasher.Write(UCharCast(tx.GetWitnessHash().begin()), 32).Write((unsigned char*)&flags, sizeof(flags)).Finalize(hashCacheEntry.begin());
2085 AssertLockHeld(cs_main); //TODO: Remove this requirement by making CuckooCache not require external locks
2086 if (validation_cache.m_script_execution_cache.contains(hashCacheEntry, !cacheFullScriptStore)) {
2087 return true;
2088 }
2089
2090 if (!txdata.m_spent_outputs_ready) {
2091 std::vector<CTxOut> spent_outputs;
2092 spent_outputs.reserve(tx.vin.size());
2093
2094 for (const auto& txin : tx.vin) {
2095 const COutPoint& prevout = txin.prevout;
2096 const Coin& coin = inputs.AccessCoin(prevout);
2097 assert(!coin.IsSpent());
2098 spent_outputs.emplace_back(coin.out);
2099 }
2100 txdata.Init(tx, std::move(spent_outputs));
2101 }
2102 assert(txdata.m_spent_outputs.size() == tx.vin.size());
2103
2104 for (unsigned int i = 0; i < tx.vin.size(); i++) {
2105
2106 // We very carefully only pass in things to CScriptCheck which
2107 // are clearly committed to by tx' witness hash. This provides
2108 // a sanity check that our caching is not introducing consensus
2109 // failures through additional data in, eg, the coins being
2110 // spent being checked as a part of CScriptCheck.
2111
2112 // Verify signature
2113 CScriptCheck check(txdata.m_spent_outputs[i], tx, validation_cache.m_signature_cache, i, flags, cacheSigStore, &txdata);
2114 if (pvChecks) {
2115 pvChecks->emplace_back(std::move(check));
2116 } else if (auto result = check(); result.has_value()) {
2117 // Tx failures never trigger disconnections/bans.
2118 // This is so that network splits aren't triggered
2119 // either due to non-consensus relay policies (such as
2120 // non-standard DER encodings or non-null dummy
2121 // arguments) or due to new consensus rules introduced in
2122 // soft forks.
2124 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, strprintf("mempool-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
2125 } else {
2126 return state.Invalid(TxValidationResult::TX_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(result->first)), result->second);
2127 }
2128 }
2129 }
2130
2131 if (cacheFullScriptStore && !pvChecks) {
2132 // We executed all of the provided scripts, and were told to
2133 // cache the result. Do so now.
2134 validation_cache.m_script_execution_cache.insert(hashCacheEntry);
2135 }
2136
2137 return true;
2138}
2139
2140bool FatalError(Notifications& notifications, BlockValidationState& state, const bilingual_str& message)
2141{
2142 notifications.fatalError(message);
2143 return state.Error(message.original);
2144}
2145
2153int ApplyTxInUndo(Coin&& undo, CCoinsViewCache& view, const COutPoint& out)
2154{
2155 bool fClean = true;
2156
2157 if (view.HaveCoin(out)) fClean = false; // overwriting transaction output
2158
2159 if (undo.nHeight == 0) {
2160 // Missing undo metadata (height and coinbase). Older versions included this
2161 // information only in undo records for the last spend of a transactions'
2162 // outputs. This implies that it must be present for some other output of the same tx.
2163 const Coin& alternate = AccessByTxid(view, out.hash);
2164 if (!alternate.IsSpent()) {
2165 undo.nHeight = alternate.nHeight;
2166 undo.fCoinBase = alternate.fCoinBase;
2167 } else {
2168 return DISCONNECT_FAILED; // adding output for transaction without known metadata
2169 }
2170 }
2171 // If the coin already exists as an unspent coin in the cache, then the
2172 // possible_overwrite parameter to AddCoin must be set to true. We have
2173 // already checked whether an unspent coin exists above using HaveCoin, so
2174 // we don't need to guess. When fClean is false, an unspent coin already
2175 // existed and it is an overwrite.
2176 view.AddCoin(out, std::move(undo), !fClean);
2177
2178 return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2179}
2180
2183DisconnectResult Chainstate::DisconnectBlock(const CBlock& block, const CBlockIndex* pindex, CCoinsViewCache& view)
2184{
2186 bool fClean = true;
2187
2188 CBlockUndo blockUndo;
2189 if (!m_blockman.ReadBlockUndo(blockUndo, *pindex)) {
2190 LogError("DisconnectBlock(): failure reading undo data\n");
2191 return DISCONNECT_FAILED;
2192 }
2193
2194 if (blockUndo.vtxundo.size() + 1 != block.vtx.size()) {
2195 LogError("DisconnectBlock(): block and undo data inconsistent\n");
2196 return DISCONNECT_FAILED;
2197 }
2198
2199 // Ignore blocks that contain transactions which are 'overwritten' by later transactions,
2200 // unless those are already completely spent.
2201 // See https://github.com/bitcoin/bitcoin/issues/22596 for additional information.
2202 // Note: the blocks specified here are different than the ones used in ConnectBlock because DisconnectBlock
2203 // unwinds the blocks in reverse. As a result, the inconsistency is not discovered until the earlier
2204 // blocks with the duplicate coinbase transactions are disconnected.
2205 bool fEnforceBIP30 = !((pindex->nHeight==91722 && pindex->GetBlockHash() == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
2206 (pindex->nHeight==91812 && pindex->GetBlockHash() == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"}));
2207
2208 // undo transactions in reverse order
2209 for (int i = block.vtx.size() - 1; i >= 0; i--) {
2210 const CTransaction &tx = *(block.vtx[i]);
2211 Txid hash = tx.GetHash();
2212 bool is_coinbase = tx.IsCoinBase();
2213 bool is_bip30_exception = (is_coinbase && !fEnforceBIP30);
2214
2215 // Check that all outputs are available and match the outputs in the block itself
2216 // exactly.
2217 for (size_t o = 0; o < tx.vout.size(); o++) {
2218 if (!tx.vout[o].scriptPubKey.IsUnspendable()) {
2219 COutPoint out(hash, o);
2220 Coin coin;
2221 bool is_spent = view.SpendCoin(out, &coin);
2222 if (!is_spent || tx.vout[o] != coin.out || pindex->nHeight != coin.nHeight || is_coinbase != coin.fCoinBase) {
2223 if (!is_bip30_exception) {
2224 fClean = false; // transaction output mismatch
2225 }
2226 }
2227 }
2228 }
2229
2230 // restore inputs
2231 if (i > 0) { // not coinbases
2232 CTxUndo &txundo = blockUndo.vtxundo[i-1];
2233 if (txundo.vprevout.size() != tx.vin.size()) {
2234 LogError("DisconnectBlock(): transaction and undo data inconsistent\n");
2235 return DISCONNECT_FAILED;
2236 }
2237 for (unsigned int j = tx.vin.size(); j > 0;) {
2238 --j;
2239 const COutPoint& out = tx.vin[j].prevout;
2240 int res = ApplyTxInUndo(std::move(txundo.vprevout[j]), view, out);
2241 if (res == DISCONNECT_FAILED) return DISCONNECT_FAILED;
2242 fClean = fClean && res != DISCONNECT_UNCLEAN;
2243 }
2244 // At this point, all of txundo.vprevout should have been moved out.
2245 }
2246 }
2247
2248 // move best block pointer to prevout block
2249 view.SetBestBlock(pindex->pprev->GetBlockHash());
2250
2251 return fClean ? DISCONNECT_OK : DISCONNECT_UNCLEAN;
2252}
2253
2255{
2256 const Consensus::Params& consensusparams = chainman.GetConsensus();
2257
2258 // BIP16 didn't become active until Apr 1 2012 (on mainnet, and
2259 // retroactively applied to testnet)
2260 // However, only one historical block violated the P2SH rules (on both
2261 // mainnet and testnet).
2262 // Similarly, only one historical block violated the TAPROOT rules on
2263 // mainnet.
2264 // For simplicity, always leave P2SH+WITNESS+TAPROOT on except for the two
2265 // violating blocks.
2267 const auto it{consensusparams.script_flag_exceptions.find(*Assert(block_index.phashBlock))};
2268 if (it != consensusparams.script_flag_exceptions.end()) {
2269 flags = it->second;
2270 }
2271
2272 // Enforce the DERSIG (BIP66) rule
2273 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_DERSIG)) {
2275 }
2276
2277 // Enforce CHECKLOCKTIMEVERIFY (BIP65)
2278 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CLTV)) {
2280 }
2281
2282 // Enforce CHECKSEQUENCEVERIFY (BIP112)
2283 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_CSV)) {
2285 }
2286
2287 // Enforce BIP147 NULLDUMMY (activated simultaneously with segwit)
2288 if (DeploymentActiveAt(block_index, chainman, Consensus::DEPLOYMENT_SEGWIT)) {
2290 }
2291
2292 return flags;
2293}
2294
2295
2299bool Chainstate::ConnectBlock(const CBlock& block, BlockValidationState& state, CBlockIndex* pindex,
2300 CCoinsViewCache& view, bool fJustCheck)
2301{
2303 assert(pindex);
2304
2305 uint256 block_hash{block.GetHash()};
2306 assert(*pindex->phashBlock == block_hash);
2307
2308 const auto time_start{SteadyClock::now()};
2309 const CChainParams& params{m_chainman.GetParams()};
2310
2311 // Check it again in case a previous version let a bad block in
2312 // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2313 // ContextualCheckBlockHeader() here. This means that if we add a new
2314 // consensus rule that is enforced in one of those two functions, then we
2315 // may have let in a block that violates the rule prior to updating the
2316 // software, and we would NOT be enforcing the rule here. Fully solving
2317 // upgrade from one software version to the next after a consensus rule
2318 // change is potentially tricky and issue-specific (see NeedsRedownload()
2319 // for one approach that was used for BIP 141 deployment).
2320 // Also, currently the rule against blocks more than 2 hours in the future
2321 // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2322 // re-enforce that rule here (at least until we make it impossible for
2323 // the clock to go backward).
2324 if (!CheckBlock(block, state, params.GetConsensus(), !fJustCheck, !fJustCheck)) {
2326 // We don't write down blocks to disk if they may have been
2327 // corrupted, so this should be impossible unless we're having hardware
2328 // problems.
2329 return FatalError(m_chainman.GetNotifications(), state, _("Corrupt block found indicating potential hardware failure."));
2330 }
2331 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
2332 return false;
2333 }
2334
2335 // verify that the view's current state corresponds to the previous block
2336 uint256 hashPrevBlock = pindex->pprev == nullptr ? uint256() : pindex->pprev->GetBlockHash();
2337 assert(hashPrevBlock == view.GetBestBlock());
2338
2339 m_chainman.num_blocks_total++;
2340
2341 // Special case for the genesis block, skipping connection of its transactions
2342 // (its coinbase is unspendable)
2343 if (block_hash == params.GetConsensus().hashGenesisBlock) {
2344 if (!fJustCheck)
2345 view.SetBestBlock(pindex->GetBlockHash());
2346 return true;
2347 }
2348
2349 const char* script_check_reason;
2350 if (m_chainman.AssumedValidBlock().IsNull()) {
2351 script_check_reason = "assumevalid=0 (always verify)";
2352 } else {
2353 constexpr int64_t TWO_WEEKS_IN_SECONDS{60 * 60 * 24 * 7 * 2};
2354 // We've been configured with the hash of a block which has been externally verified to have a valid history.
2355 // A suitable default value is included with the software and updated from time to time. Because validity
2356 // relative to a piece of software is an objective fact these defaults can be easily reviewed.
2357 // This setting doesn't force the selection of any particular chain but makes validating some faster by
2358 // effectively caching the result of part of the verification.
2359 BlockMap::const_iterator it{m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2360 if (it == m_blockman.m_block_index.end()) {
2361 script_check_reason = "assumevalid hash not in headers";
2362 } else if (it->second.GetAncestor(pindex->nHeight) != pindex) {
2363 script_check_reason = (pindex->nHeight > it->second.nHeight) ? "block height above assumevalid height" : "block not in assumevalid chain";
2364 } else if (m_chainman.m_best_header->GetAncestor(pindex->nHeight) != pindex) {
2365 script_check_reason = "block not in best header chain";
2366 } else if (m_chainman.m_best_header->nChainWork < m_chainman.MinimumChainWork()) {
2367 script_check_reason = "best header chainwork below minimumchainwork";
2368 } else if (GetBlockProofEquivalentTime(*m_chainman.m_best_header, *pindex, *m_chainman.m_best_header, params.GetConsensus()) <= TWO_WEEKS_IN_SECONDS) {
2369 script_check_reason = "block too recent relative to best header";
2370 } else {
2371 // This block is a member of the assumed verified chain and an ancestor of the best header.
2372 // Script verification is skipped when connecting blocks under the
2373 // assumevalid block. Assuming the assumevalid block is valid this
2374 // is safe because block merkle hashes are still computed and checked,
2375 // Of course, if an assumed valid block is invalid due to false scriptSigs
2376 // this optimization would allow an invalid chain to be accepted.
2377 // The equivalent time check discourages hash power from extorting the network via DOS attack
2378 // into accepting an invalid block through telling users they must manually set assumevalid.
2379 // Requiring a software change or burying the invalid block, regardless of the setting, makes
2380 // it hard to hide the implication of the demand. This also avoids having release candidates
2381 // that are hardly doing any signature verification at all in testing without having to
2382 // artificially set the default assumed verified block further back.
2383 // The test against the minimum chain work prevents the skipping when denied access to any chain at
2384 // least as good as the expected chain.
2385 script_check_reason = nullptr;
2386 }
2387 }
2388
2389 const auto time_1{SteadyClock::now()};
2390 m_chainman.time_check += time_1 - time_start;
2391 LogDebug(BCLog::BENCH, " - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2392 Ticks<MillisecondsDouble>(time_1 - time_start),
2393 Ticks<SecondsDouble>(m_chainman.time_check),
2394 Ticks<MillisecondsDouble>(m_chainman.time_check) / m_chainman.num_blocks_total);
2395
2396 // Do not allow blocks that contain transactions which 'overwrite' older transactions,
2397 // unless those are already completely spent.
2398 // If such overwrites are allowed, coinbases and transactions depending upon those
2399 // can be duplicated to remove the ability to spend the first instance -- even after
2400 // being sent to another address.
2401 // See BIP30, CVE-2012-1909, and https://r6.ca/blog/20120206T005236Z.html for more information.
2402 // This rule was originally applied to all blocks with a timestamp after March 15, 2012, 0:00 UTC.
2403 // Now that the whole chain is irreversibly beyond that time it is applied to all blocks except the
2404 // two in the chain that violate it. This prevents exploiting the issue against nodes during their
2405 // initial block download.
2406 bool fEnforceBIP30 = !IsBIP30Repeat(*pindex);
2407
2408 // Once BIP34 activated it was not possible to create new duplicate coinbases and thus other than starting
2409 // with the 2 existing duplicate coinbase pairs, not possible to create overwriting txs. But by the
2410 // time BIP34 activated, in each of the existing pairs the duplicate coinbase had overwritten the first
2411 // before the first had been spent. Since those coinbases are sufficiently buried it's no longer possible to create further
2412 // duplicate transactions descending from the known pairs either.
2413 // 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.
2414
2415 // BIP34 requires that a block at height X (block X) has its coinbase
2416 // scriptSig start with a CScriptNum of X (indicated height X). The above
2417 // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2418 // case that there is a block X before the BIP34 height of 227,931 which has
2419 // an indicated height Y where Y is greater than X. The coinbase for block
2420 // X would also be a valid coinbase for block Y, which could be a BIP30
2421 // violation. An exhaustive search of all mainnet coinbases before the
2422 // BIP34 height which have an indicated height greater than the block height
2423 // reveals many occurrences. The 3 lowest indicated heights found are
2424 // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2425 // heights would be the first opportunity for BIP30 to be violated.
2426
2427 // The search reveals a great many blocks which have an indicated height
2428 // greater than 1,983,702, so we simply remove the optimization to skip
2429 // BIP30 checking for blocks at height 1,983,702 or higher. Before we reach
2430 // that block in another 25 years or so, we should take advantage of a
2431 // future consensus change to do a new and improved version of BIP34 that
2432 // will actually prevent ever creating any duplicate coinbases in the
2433 // future.
2434 static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2435
2436 // There is no potential to create a duplicate coinbase at block 209,921
2437 // because this is still before the BIP34 height and so explicit BIP30
2438 // checking is still active.
2439
2440 // The final case is block 176,684 which has an indicated height of
2441 // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2442 // before block 490,897 so there was not much opportunity to address this
2443 // case other than to carefully analyze it and determine it would not be a
2444 // problem. Block 490,897 was, in fact, mined with a different coinbase than
2445 // block 176,684, but it is important to note that even if it hadn't been or
2446 // is remined on an alternate fork with a duplicate coinbase, we would still
2447 // not run into a BIP30 violation. This is because the coinbase for 176,684
2448 // is spent in block 185,956 in transaction
2449 // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781. This
2450 // spending transaction can't be duplicated because it also spends coinbase
2451 // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29. This
2452 // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2453 // duplicatable until that height, and it's currently impossible to create a
2454 // chain that long. Nevertheless we may wish to consider a future soft fork
2455 // which retroactively prevents block 490,897 from creating a duplicate
2456 // coinbase. The two historical BIP30 violations often provide a confusing
2457 // edge case when manipulating the UTXO and it would be simpler not to have
2458 // another edge case to deal with.
2459
2460 // testnet3 has no blocks before the BIP34 height with indicated heights
2461 // post BIP34 before approximately height 486,000,000. After block
2462 // 1,983,702 testnet3 starts doing unnecessary BIP30 checking again.
2463 assert(pindex->pprev);
2464 CBlockIndex* pindexBIP34height = pindex->pprev->GetAncestor(params.GetConsensus().BIP34Height);
2465 //Only continue to enforce if we're below BIP34 activation height or the block hash at that height doesn't correspond.
2466 fEnforceBIP30 = fEnforceBIP30 && (!pindexBIP34height || !(pindexBIP34height->GetBlockHash() == params.GetConsensus().BIP34Hash));
2467
2468 // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have a
2469 // consensus change that ensures coinbases at those heights cannot
2470 // duplicate earlier coinbases.
2471 if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2472 for (const auto& tx : block.vtx) {
2473 for (size_t o = 0; o < tx->vout.size(); o++) {
2474 if (view.HaveCoin(COutPoint(tx->GetHash(), o))) {
2475 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-BIP30",
2476 "tried to overwrite transaction");
2477 }
2478 }
2479 }
2480 }
2481
2482 // Enforce BIP68 (sequence locks)
2483 int nLockTimeFlags = 0;
2485 nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2486 }
2487
2488 // Get the script flags for this block
2489 script_verify_flags flags{GetBlockScriptFlags(*pindex, m_chainman)};
2490
2491 const auto time_2{SteadyClock::now()};
2492 m_chainman.time_forks += time_2 - time_1;
2493 LogDebug(BCLog::BENCH, " - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2494 Ticks<MillisecondsDouble>(time_2 - time_1),
2495 Ticks<SecondsDouble>(m_chainman.time_forks),
2496 Ticks<MillisecondsDouble>(m_chainman.time_forks) / m_chainman.num_blocks_total);
2497
2498 const bool fScriptChecks{!!script_check_reason};
2499 const kernel::ChainstateRole role{GetRole()};
2500 if (script_check_reason != m_last_script_check_reason_logged && role.validated && !role.historical) {
2501 if (fScriptChecks) {
2502 LogInfo("Enabling script verification at block #%d (%s): %s.",
2503 pindex->nHeight, block_hash.ToString(), script_check_reason);
2504 } else {
2505 LogInfo("Disabling script verification at block #%d (%s).",
2506 pindex->nHeight, block_hash.ToString());
2507 }
2508 m_last_script_check_reason_logged = script_check_reason;
2509 }
2510
2511 CBlockUndo blockundo;
2512
2513 // Precomputed transaction data pointers must not be invalidated
2514 // until after `control` has run the script checks (potentially
2515 // in multiple threads). Preallocate the vector size so a new allocation
2516 // doesn't invalidate pointers into the vector, and keep txsdata in scope
2517 // for as long as `control`.
2518 std::vector<PrecomputedTransactionData> txsdata(block.vtx.size());
2519 std::optional<CCheckQueueControl<CScriptCheck>> control;
2520 if (auto& queue = m_chainman.GetCheckQueue(); queue.HasThreads() && fScriptChecks) control.emplace(queue);
2521
2522 std::vector<int> prevheights;
2523 CAmount nFees = 0;
2524 int nInputs = 0;
2525 int64_t nSigOpsCost = 0;
2526 blockundo.vtxundo.reserve(block.vtx.size() - 1);
2527 for (unsigned int i = 0; i < block.vtx.size(); i++)
2528 {
2529 if (!state.IsValid()) break;
2530 const CTransaction &tx = *(block.vtx[i]);
2531
2532 nInputs += tx.vin.size();
2533
2534 if (!tx.IsCoinBase())
2535 {
2536 CAmount txfee = 0;
2537 TxValidationState tx_state;
2538 if (!Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight, txfee)) {
2539 // Any transaction validation failure in ConnectBlock is a block consensus failure
2541 tx_state.GetRejectReason(),
2542 tx_state.GetDebugMessage() + " in transaction " + tx.GetHash().ToString());
2543 break;
2544 }
2545 nFees += txfee;
2546 if (!MoneyRange(nFees)) {
2547 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-accumulated-fee-outofrange",
2548 "accumulated fee in the block out of range");
2549 break;
2550 }
2551
2552 // Check that transaction is BIP68 final
2553 // BIP68 lock checks (as opposed to nLockTime checks) must
2554 // be in ConnectBlock because they require the UTXO set
2555 prevheights.resize(tx.vin.size());
2556 for (size_t j = 0; j < tx.vin.size(); j++) {
2557 prevheights[j] = view.AccessCoin(tx.vin[j].prevout).nHeight;
2558 }
2559
2560 if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2561 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal",
2562 "contains a non-BIP68-final transaction " + tx.GetHash().ToString());
2563 break;
2564 }
2565 }
2566
2567 // GetTransactionSigOpCost counts 3 types of sigops:
2568 // * legacy (always)
2569 // * p2sh (when P2SH enabled in flags and excludes coinbase)
2570 // * witness (when witness enabled in flags and excludes coinbase)
2571 nSigOpsCost += GetTransactionSigOpCost(tx, view, flags);
2572 if (nSigOpsCost > MAX_BLOCK_SIGOPS_COST) {
2573 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "too many sigops");
2574 break;
2575 }
2576
2577 if (!tx.IsCoinBase() && fScriptChecks)
2578 {
2579 bool fCacheResults = fJustCheck; /* Don't cache results if we're actually connecting blocks (still consult the cache, though) */
2580 bool tx_ok;
2581 TxValidationState tx_state;
2582 // If CheckInputScripts is called with a pointer to a checks vector, the resulting checks are appended to it. In that case
2583 // they need to be added to control which runs them asynchronously. Otherwise, CheckInputScripts runs the checks before returning.
2584 if (control) {
2585 std::vector<CScriptCheck> vChecks;
2586 tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache, &vChecks);
2587 if (tx_ok) control->Add(std::move(vChecks));
2588 } else {
2589 tx_ok = CheckInputScripts(tx, tx_state, view, flags, fCacheResults, fCacheResults, txsdata[i], m_chainman.m_validation_cache);
2590 }
2591 if (!tx_ok) {
2592 // Any transaction validation failure in ConnectBlock is a block consensus failure
2594 tx_state.GetRejectReason(), tx_state.GetDebugMessage());
2595 break;
2596 }
2597 }
2598
2599 CTxUndo undoDummy;
2600 if (i > 0) {
2601 blockundo.vtxundo.emplace_back();
2602 }
2603 UpdateCoins(tx, view, i == 0 ? undoDummy : blockundo.vtxundo.back(), pindex->nHeight);
2604 }
2605 const auto time_3{SteadyClock::now()};
2606 m_chainman.time_connect += time_3 - time_2;
2607 LogDebug(BCLog::BENCH, " - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) [%.2fs (%.2fms/blk)]\n", (unsigned)block.vtx.size(),
2608 Ticks<MillisecondsDouble>(time_3 - time_2), Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2609 nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2610 Ticks<SecondsDouble>(m_chainman.time_connect),
2611 Ticks<MillisecondsDouble>(m_chainman.time_connect) / m_chainman.num_blocks_total);
2612
2613 CAmount blockReward = nFees + GetBlockSubsidy(pindex->nHeight, params.GetConsensus());
2614 if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
2615 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-amount",
2616 strprintf("coinbase pays too much (actual=%d vs limit=%d)", block.vtx[0]->GetValueOut(), blockReward));
2617 }
2618 if (control) {
2619 auto parallel_result = control->Complete();
2620 if (parallel_result.has_value() && state.IsValid()) {
2621 state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, strprintf("block-script-verify-flag-failed (%s)", ScriptErrorString(parallel_result->first)), parallel_result->second);
2622 }
2623 }
2624 if (!state.IsValid()) {
2625 LogInfo("Block validation error: %s", state.ToString());
2626 return false;
2627 }
2628 const auto time_4{SteadyClock::now()};
2629 m_chainman.time_verify += time_4 - time_2;
2630 LogDebug(BCLog::BENCH, " - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n", nInputs - 1,
2631 Ticks<MillisecondsDouble>(time_4 - time_2),
2632 nInputs <= 1 ? 0 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2633 Ticks<SecondsDouble>(m_chainman.time_verify),
2634 Ticks<MillisecondsDouble>(m_chainman.time_verify) / m_chainman.num_blocks_total);
2635
2636 if (fJustCheck) {
2637 return true;
2638 }
2639
2640 if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2641 return false;
2642 }
2643
2644 const auto time_5{SteadyClock::now()};
2645 m_chainman.time_undo += time_5 - time_4;
2646 LogDebug(BCLog::BENCH, " - Write undo data: %.2fms [%.2fs (%.2fms/blk)]\n",
2647 Ticks<MillisecondsDouble>(time_5 - time_4),
2649 Ticks<MillisecondsDouble>(m_chainman.time_undo) / m_chainman.num_blocks_total);
2650
2651 if (!pindex->IsValid(BLOCK_VALID_SCRIPTS)) {
2653 m_blockman.m_dirty_blockindex.insert(pindex);
2654 }
2655
2656 // add this block to the view's block chain
2657 view.SetBestBlock(pindex->GetBlockHash());
2658
2659 const auto time_6{SteadyClock::now()};
2660 m_chainman.time_index += time_6 - time_5;
2661 LogDebug(BCLog::BENCH, " - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
2662 Ticks<MillisecondsDouble>(time_6 - time_5),
2663 Ticks<SecondsDouble>(m_chainman.time_index),
2664 Ticks<MillisecondsDouble>(m_chainman.time_index) / m_chainman.num_blocks_total);
2665
2666 TRACEPOINT(validation, block_connected,
2667 block_hash.data(),
2668 pindex->nHeight,
2669 block.vtx.size(),
2670 nInputs,
2671 nSigOpsCost,
2672 Ticks<std::chrono::nanoseconds>(time_5 - time_start)
2673 );
2674
2675 return true;
2676}
2677
2678CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState()
2679{
2681 return this->GetCoinsCacheSizeState(
2683 m_mempool ? m_mempool->m_opts.max_size_bytes : 0);
2684}
2685
2686CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState(
2687 size_t max_coins_cache_size_bytes,
2688 size_t max_mempool_size_bytes)
2689{
2691 const int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2692 int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2693 int64_t nTotalSpace =
2694 max_coins_cache_size_bytes + std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2695
2696 if (cacheSize > nTotalSpace) {
2697 LogInfo("Cache size (%s) exceeds total space (%s)\n", cacheSize, nTotalSpace);
2699 } else if (cacheSize > LargeCoinsCacheThreshold(nTotalSpace)) {
2701 }
2703}
2704
2706 BlockValidationState &state,
2707 FlushStateMode mode,
2708 int nManualPruneHeight)
2709{
2710 LOCK(cs_main);
2711 assert(this->CanFlushToDisk());
2712 std::set<int> setFilesToPrune;
2713 bool full_flush_completed = false;
2714
2715 [[maybe_unused]] const size_t coins_count{CoinsTip().GetCacheSize()};
2716 [[maybe_unused]] const size_t coins_mem_usage{CoinsTip().DynamicMemoryUsage()};
2717
2718 try {
2719 {
2720 bool fFlushForPrune = false;
2721
2722 CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2723 LOCK(m_blockman.cs_LastBlockFile);
2724 if (m_blockman.IsPruneMode() && (m_blockman.m_check_for_pruning || nManualPruneHeight > 0) && m_chainman.m_blockman.m_blockfiles_indexed) {
2725 // make sure we don't prune above any of the prune locks bestblocks
2726 // pruning is height-based
2727 int last_prune{m_chain.Height()}; // last height we can prune
2728 std::optional<std::string> limiting_lock; // prune lock that actually was the limiting factor, only used for logging
2729
2730 for (const auto& prune_lock : m_blockman.m_prune_locks) {
2731 if (prune_lock.second.height_first == std::numeric_limits<int>::max()) continue;
2732 // Remove the buffer and one additional block here to get actual height that is outside of the buffer
2733 const int lock_height{prune_lock.second.height_first - PRUNE_LOCK_BUFFER - 1};
2734 last_prune = std::max(1, std::min(last_prune, lock_height));
2735 if (last_prune == lock_height) {
2736 limiting_lock = prune_lock.first;
2737 }
2738 }
2739
2740 if (limiting_lock) {
2741 LogDebug(BCLog::PRUNE, "%s limited pruning to height %d\n", limiting_lock.value(), last_prune);
2742 }
2743
2744 if (nManualPruneHeight > 0) {
2745 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune (manual)", BCLog::BENCH);
2746
2747 m_blockman.FindFilesToPruneManual(
2748 setFilesToPrune,
2749 std::min(last_prune, nManualPruneHeight),
2750 *this);
2751 } else {
2752 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune", BCLog::BENCH);
2753
2754 m_blockman.FindFilesToPrune(setFilesToPrune, last_prune, *this, m_chainman);
2755 m_blockman.m_check_for_pruning = false;
2756 }
2757 if (!setFilesToPrune.empty()) {
2758 fFlushForPrune = true;
2759 if (!m_blockman.m_have_pruned) {
2760 m_blockman.m_block_tree_db->WriteFlag("prunedblockfiles", true);
2761 m_blockman.m_have_pruned = true;
2762 }
2763 }
2764 }
2765 const auto nNow{NodeClock::now()};
2766 // 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).
2767 bool fCacheLarge = mode == FlushStateMode::PERIODIC && cache_state >= CoinsCacheSizeState::LARGE;
2768 // The cache is over the limit, we have to write now.
2769 bool fCacheCritical = mode == FlushStateMode::IF_NEEDED && cache_state >= CoinsCacheSizeState::CRITICAL;
2770 // 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.
2771 bool fPeriodicWrite = mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2772 const auto empty_cache{(mode == FlushStateMode::FORCE_FLUSH) || fCacheLarge || fCacheCritical};
2773 // Combine all conditions that result in a write to disk.
2774 bool should_write = (mode == FlushStateMode::FORCE_SYNC) || empty_cache || fPeriodicWrite || fFlushForPrune;
2775 // Write blocks, block index and best chain related state to disk.
2776 if (should_write) {
2777 LogDebug(BCLog::COINDB, "Writing chainstate to disk: flush mode=%s, prune=%d, large=%d, critical=%d, periodic=%d",
2778 FlushStateModeNames[size_t(mode)], fFlushForPrune, fCacheLarge, fCacheCritical, fPeriodicWrite);
2779
2780 // Ensure we can write block index
2781 if (!CheckDiskSpace(m_blockman.m_opts.blocks_dir)) {
2782 return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2783 }
2784 {
2785 LOG_TIME_MILLIS_WITH_CATEGORY("write block and undo data to disk", BCLog::BENCH);
2786
2787 // First make sure all block and undo data is flushed to disk.
2788 // TODO: Handle return error, or add detailed comment why it is
2789 // safe to not return an error upon failure.
2790 if (!m_blockman.FlushChainstateBlockFile(m_chain.Height())) {
2791 LogWarning("%s: Failed to flush block file.\n", __func__);
2792 }
2793 }
2794
2795 // Then update all block file information (which may refer to block and undo files).
2796 {
2797 LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk", BCLog::BENCH);
2798
2799 m_blockman.WriteBlockIndexDB();
2800 }
2801 // Finally remove any pruned files
2802 if (fFlushForPrune) {
2803 LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files", BCLog::BENCH);
2804
2805 m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2806 }
2807
2808 if (!CoinsTip().GetBestBlock().IsNull()) {
2809 // Typical Coin structures on disk are around 48 bytes in size.
2810 // Pushing a new one to the database can cause it to be written
2811 // twice (once in the log, and once in the tables). This is already
2812 // an overestimation, as most will delete an existing entry or
2813 // overwrite one. Still, use a conservative safety factor of 2.
2814 if (!CheckDiskSpace(m_chainman.m_options.datadir, 48 * 2 * 2 * CoinsTip().GetDirtyCount())) {
2815 return FatalError(m_chainman.GetNotifications(), state, _("Disk space is too low!"));
2816 }
2817 // Flush the chainstate (which may refer to block index entries).
2818 empty_cache ? CoinsTip().Flush() : CoinsTip().Sync();
2819 full_flush_completed = true;
2820 TRACEPOINT(utxocache, flush,
2822 (uint32_t)mode,
2823 (uint64_t)coins_count,
2824 (uint64_t)coins_mem_usage,
2825 (bool)fFlushForPrune);
2826 }
2827 }
2828
2829 if (should_write || m_next_write == NodeClock::time_point::max()) {
2832 }
2833 }
2834 if (full_flush_completed) {
2835 if (m_chainman.m_options.signals) {
2836 // Update best block in wallet (so we can detect restored wallets).
2837 m_chainman.m_options.signals->ChainStateFlushed(this->GetRole(), GetLocator(m_chain.Tip()));
2838 }
2839
2840 if (!m_chainman.m_interrupt && ShouldCompactChainstate(m_chainman.IsInitialBlockDownload())) {
2841 try {
2842 CoinsDB().CompactFull();
2843 } catch (const std::exception& e) {
2844 LogWarning("Failed to start chainstate compaction (%s)", e.what());
2845 }
2846 }
2847 }
2848 } catch (const std::runtime_error& e) {
2849 return FatalError(m_chainman.GetNotifications(), state, strprintf(_("System error while flushing: %s"), e.what()));
2850 }
2851 return true;
2852}
2853
2855{
2858 LogWarning("Failed to force flush state (%s)", state.ToString());
2859 }
2860}
2861
2863{
2865 m_blockman.m_check_for_pruning = true;
2866 if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2867 LogWarning("Failed to flush state (%s)", state.ToString());
2868 }
2869}
2870
2871static void UpdateTipLog(
2872 const ChainstateManager& chainman,
2873 const CCoinsViewCache& coins_tip,
2874 const CBlockIndex* tip,
2875 const std::string& func_name,
2876 const std::string& prefix,
2877 const std::string& warning_messages) EXCLUSIVE_LOCKS_REQUIRED(::cs_main)
2878{
2879
2881
2882 // Disable rate limiting in LogPrintLevel_ so this source location may log during IBD.
2883 LogPrintLevel_(BCLog::LogFlags::ALL, util::log::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",
2884 prefix, func_name,
2885 tip->GetBlockHash().ToString(), tip->nHeight, tip->nVersion,
2886 log(tip->nChainWork.getdouble()) / log(2.0), tip->m_chain_tx_count,
2888 chainman.GuessVerificationProgress(tip),
2889 coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2890 coins_tip.GetCacheSize(),
2891 !warning_messages.empty() ? strprintf(" warning='%s'", warning_messages) : "");
2892}
2893
2894void Chainstate::UpdateTip(const CBlockIndex* pindexNew)
2895{
2897 const auto& coins_tip = this->CoinsTip();
2898
2899 // The remainder of the function isn't relevant if we are not acting on
2900 // the active chainstate, so return if need be.
2901 if (this != &m_chainman.ActiveChainstate()) {
2902 // Only log every so often so that we don't bury log messages at the tip.
2903 constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2904 if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2905 UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "[background validation] ", "");
2906 }
2907 return;
2908 }
2909
2910 // New best block
2911 if (m_mempool) {
2912 m_mempool->AddTransactionsUpdated(1);
2913 }
2914
2915 std::vector<bilingual_str> warning_messages;
2916 if (!m_chainman.IsInitialBlockDownload()) {
2917 auto bits = m_chainman.m_versionbitscache.CheckUnknownActivations(pindexNew, m_chainman.GetParams());
2918 for (auto [bit, active] : bits) {
2919 const bilingual_str warning = strprintf(_("Unknown new rules activated (versionbit %i)"), bit);
2920 if (active) {
2921 m_chainman.GetNotifications().warningSet(kernel::Warning::UNKNOWN_NEW_RULES_ACTIVATED, warning);
2922 } else {
2923 warning_messages.push_back(warning);
2924 }
2925 }
2926 }
2927 UpdateTipLog(m_chainman, coins_tip, pindexNew, __func__, "",
2928 util::Join(warning_messages, Untranslated(", ")).original);
2929}
2930
2942{
2945
2946 CBlockIndex *pindexDelete = m_chain.Tip();
2947 assert(pindexDelete);
2948 assert(pindexDelete->pprev);
2949 // Read block from disk.
2950 std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2951 CBlock& block = *pblock;
2952 if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2953 LogError("DisconnectTip(): Failed to read block\n");
2954 return false;
2955 }
2956 // Apply the block atomically to the chain state.
2957 const auto time_start{SteadyClock::now()};
2958 {
2959 CCoinsViewCache view(&CoinsTip());
2960 assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2961 if (DisconnectBlock(block, pindexDelete, view) != DISCONNECT_OK) {
2962 LogError("DisconnectTip(): DisconnectBlock %s failed\n", pindexDelete->GetBlockHash().ToString());
2963 return false;
2964 }
2965 view.Flush(/*reallocate_cache=*/false); // local CCoinsViewCache goes out of scope
2966 }
2967 LogDebug(BCLog::BENCH, "- Disconnect block: %.2fms\n",
2968 Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2969
2970 {
2971 // Prune locks that began at or after the tip should be moved backward so they get a chance to reorg
2972 const int max_height_first{pindexDelete->nHeight - 1};
2973 for (auto& prune_lock : m_blockman.m_prune_locks) {
2974 if (prune_lock.second.height_first <= max_height_first) continue;
2975
2976 prune_lock.second.height_first = max_height_first;
2977 LogDebug(BCLog::PRUNE, "%s prune lock moved back to %d\n", prune_lock.first, max_height_first);
2978 }
2979 }
2980
2981 // Write the chain state to disk, if necessary.
2983 return false;
2984 }
2985
2986 if (disconnectpool && m_mempool) {
2987 // Save transactions to re-add to mempool at end of reorg. If any entries are evicted for
2988 // exceeding memory limits, remove them and their descendants from the mempool.
2989 for (auto&& evicted_tx : disconnectpool->AddTransactionsFromBlock(block.vtx)) {
2990 m_mempool->removeRecursive(*evicted_tx, MemPoolRemovalReason::REORG);
2991 }
2992 }
2993
2994 m_chain.SetTip(*pindexDelete->pprev);
2995 m_chainman.UpdateIBDStatus();
2996
2997 UpdateTip(pindexDelete->pprev);
2998 // Let wallets know transactions went from 1-confirmed to
2999 // 0-confirmed or conflicted:
3000 if (m_chainman.m_options.signals) {
3001 m_chainman.m_options.signals->BlockDisconnected(pblock, pindexDelete);
3002 }
3003 return true;
3004}
3005
3008 std::shared_ptr<const CBlock> pblock;
3010};
3011
3019private:
3020 std::vector<PerBlockConnectTrace> blocksConnected;
3021
3022public:
3024
3025 void BlockConnected(CBlockIndex* pindex, std::shared_ptr<const CBlock> pblock) {
3026 assert(!blocksConnected.back().pindex);
3027 assert(pindex);
3028 assert(pblock);
3029 blocksConnected.back().pindex = pindex;
3030 blocksConnected.back().pblock = std::move(pblock);
3031 blocksConnected.emplace_back();
3032 }
3033
3034 std::vector<PerBlockConnectTrace>& GetBlocksConnected() {
3035 // We always keep one extra block at the end of our list because
3036 // blocks are added after all the conflicted transactions have
3037 // been filled in. Thus, the last entry should always be an empty
3038 // one waiting for the transactions from the next block. We pop
3039 // the last entry here to make sure the list we return is sane.
3040 assert(!blocksConnected.back().pindex);
3041 blocksConnected.pop_back();
3042 return blocksConnected;
3043 }
3044};
3045
3053 BlockValidationState& state,
3054 CBlockIndex* pindexNew,
3055 std::shared_ptr<const CBlock> block_to_connect,
3056 ConnectTrace& connectTrace,
3057 DisconnectedBlockTransactions& disconnectpool)
3058{
3061
3062 assert(pindexNew->pprev == m_chain.Tip());
3063 // Read block from disk.
3064 const auto time_1{SteadyClock::now()};
3065 if (!block_to_connect) {
3066 std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
3067 if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
3068 return FatalError(m_chainman.GetNotifications(), state, _("Failed to read block."));
3069 }
3070 block_to_connect = std::move(pblockNew);
3071 } else {
3072 LogDebug(BCLog::BENCH, " - Using cached block\n");
3073 }
3074 // Apply the block atomically to the chain state.
3075 const auto time_2{SteadyClock::now()};
3076 SteadyClock::time_point time_3;
3077 // When adding aggregate statistics in the future, keep in mind that
3078 // num_blocks_total may be zero until the ConnectBlock() call below.
3079 LogDebug(BCLog::BENCH, " - Load block from disk: %.2fms\n",
3080 Ticks<MillisecondsDouble>(time_2 - time_1));
3081 {
3082 CCoinsViewCache& view{*m_coins_views->m_connect_block_view};
3083 const auto reset_guard{view.CreateResetGuard()};
3084 bool rv = ConnectBlock(*block_to_connect, state, pindexNew, view);
3085 if (m_chainman.m_options.signals) {
3086 m_chainman.m_options.signals->BlockChecked(block_to_connect, state);
3087 }
3088 if (!rv) {
3089 if (state.IsInvalid())
3090 InvalidBlockFound(pindexNew, state);
3091 LogError("%s: ConnectBlock %s failed, %s\n", __func__, pindexNew->GetBlockHash().ToString(), state.ToString());
3092 return false;
3093 }
3094 time_3 = SteadyClock::now();
3095 m_chainman.time_connect_total += time_3 - time_2;
3096 assert(m_chainman.num_blocks_total > 0);
3097 LogDebug(BCLog::BENCH, " - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
3098 Ticks<MillisecondsDouble>(time_3 - time_2),
3099 Ticks<SecondsDouble>(m_chainman.time_connect_total),
3100 Ticks<MillisecondsDouble>(m_chainman.time_connect_total) / m_chainman.num_blocks_total);
3101 view.Flush(/*reallocate_cache=*/false); // No need to reallocate since it only has capacity for 1 block
3102 }
3103 const auto time_4{SteadyClock::now()};
3104 m_chainman.time_flush += time_4 - time_3;
3105 LogDebug(BCLog::BENCH, " - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
3106 Ticks<MillisecondsDouble>(time_4 - time_3),
3107 Ticks<SecondsDouble>(m_chainman.time_flush),
3108 Ticks<MillisecondsDouble>(m_chainman.time_flush) / m_chainman.num_blocks_total);
3109 // Write the chain state to disk, if necessary.
3111 return false;
3112 }
3113 const auto time_5{SteadyClock::now()};
3114 m_chainman.time_chainstate += time_5 - time_4;
3115 LogDebug(BCLog::BENCH, " - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
3116 Ticks<MillisecondsDouble>(time_5 - time_4),
3117 Ticks<SecondsDouble>(m_chainman.time_chainstate),
3118 Ticks<MillisecondsDouble>(m_chainman.time_chainstate) / m_chainman.num_blocks_total);
3119 // Remove conflicting transactions from the mempool.;
3120 if (m_mempool) {
3121 m_mempool->removeForBlock(block_to_connect->vtx, pindexNew->nHeight);
3122 disconnectpool.removeForBlock(block_to_connect->vtx);
3123 }
3124 // Update m_chain & related variables.
3125 m_chain.SetTip(*pindexNew);
3126 m_chainman.UpdateIBDStatus();
3127 UpdateTip(pindexNew);
3128
3129 const auto time_6{SteadyClock::now()};
3130 m_chainman.time_post_connect += time_6 - time_5;
3131 m_chainman.time_total += time_6 - time_1;
3132 LogDebug(BCLog::BENCH, " - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
3133 Ticks<MillisecondsDouble>(time_6 - time_5),
3134 Ticks<SecondsDouble>(m_chainman.time_post_connect),
3135 Ticks<MillisecondsDouble>(m_chainman.time_post_connect) / m_chainman.num_blocks_total);
3136 LogDebug(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
3137 Ticks<MillisecondsDouble>(time_6 - time_1),
3138 Ticks<SecondsDouble>(m_chainman.time_total),
3139 Ticks<MillisecondsDouble>(m_chainman.time_total) / m_chainman.num_blocks_total);
3140
3141 // See if this chainstate has reached a target block and can be used to
3142 // validate an assumeutxo snapshot. If it can, hashing the UTXO database
3143 // will be slow, and cs_main could remain locked here for several minutes.
3144 // If the snapshot is validated, the UTXO hash will be saved to
3145 // this->m_target_utxohash, causing HistoricalChainstate() to return null
3146 // and this chainstate to no longer be used. ActivateBestChain() will also
3147 // stop connecting blocks to this chainstate because this->ReachedTarget()
3148 // will be true and this->setBlockIndexCandidates will not have additional
3149 // blocks.
3150 Chainstate& current_cs{m_chainman.CurrentChainstate()};
3151 m_chainman.MaybeValidateSnapshot(*this, current_cs);
3152
3153 connectTrace.BlockConnected(pindexNew, std::move(block_to_connect));
3154 return true;
3155}
3156
3162{
3164 do {
3165 CBlockIndex *pindexNew = nullptr;
3166
3167 // Find the best candidate header.
3168 {
3169 std::set<CBlockIndex*, CBlockIndexWorkComparator>::reverse_iterator it = setBlockIndexCandidates.rbegin();
3170 if (it == setBlockIndexCandidates.rend())
3171 return nullptr;
3172 pindexNew = *it;
3173 }
3174
3175 // Check whether all blocks on the path between the currently active chain and the candidate are valid.
3176 // Just going until the active chain is an optimization, as we know all blocks in it are valid already.
3177 CBlockIndex *pindexTest = pindexNew;
3178 bool fInvalidAncestor = false;
3179 while (pindexTest && !m_chain.Contains(pindexTest)) {
3180 assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3181
3182 // Pruned nodes may have entries in setBlockIndexCandidates for
3183 // which block files have been deleted. Remove those as candidates
3184 // for the most work chain if we come across them; we can't switch
3185 // to a chain unless we have all the non-active-chain parent blocks.
3186 bool fFailedChain = pindexTest->nStatus & BLOCK_FAILED_VALID;
3187 bool fMissingData = !(pindexTest->nStatus & BLOCK_HAVE_DATA);
3188 if (fFailedChain || fMissingData) {
3189 // Candidate chain is not usable (either invalid or missing data)
3190 if (fFailedChain && (m_chainman.m_best_invalid == nullptr || pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork)) {
3191 m_chainman.m_best_invalid = pindexNew;
3192 }
3193 CBlockIndex *pindexFailed = pindexNew;
3194 // Remove the entire chain from the set.
3195 while (pindexTest != pindexFailed) {
3196 if (fFailedChain) {
3197 pindexFailed->nStatus |= BLOCK_FAILED_VALID;
3198 m_blockman.m_dirty_blockindex.insert(pindexFailed);
3199 } else if (fMissingData) {
3200 // If we're missing data, then add back to m_blocks_unlinked,
3201 // so that if the block arrives in the future we can try adding
3202 // to setBlockIndexCandidates again.
3203 m_blockman.m_blocks_unlinked.insert(
3204 std::make_pair(pindexFailed->pprev, pindexFailed));
3205 }
3206 setBlockIndexCandidates.erase(pindexFailed);
3207 pindexFailed = pindexFailed->pprev;
3208 }
3209 setBlockIndexCandidates.erase(pindexTest);
3210 fInvalidAncestor = true;
3211 break;
3212 }
3213 pindexTest = pindexTest->pprev;
3214 }
3215 if (!fInvalidAncestor)
3216 return pindexNew;
3217 } while(true);
3218}
3219
3222 // Note that we can't delete the current block itself, as we may need to return to it later in case a
3223 // reorganization to a better block fails.
3224 std::set<CBlockIndex*, CBlockIndexWorkComparator>::iterator it = setBlockIndexCandidates.begin();
3225 while (it != setBlockIndexCandidates.end() && setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
3226 setBlockIndexCandidates.erase(it++);
3227 }
3228 // Either the current tip or a successor of it we're working towards is left in setBlockIndexCandidates.
3230}
3231
3238bool Chainstate::ActivateBestChainStep(BlockValidationState& state, CBlockIndex* pindexMostWork, const std::shared_ptr<const CBlock>& pblock, bool& fInvalidFound, ConnectTrace& connectTrace)
3239{
3242
3243 const CBlockIndex* pindexOldTip = m_chain.Tip();
3244 const CBlockIndex* pindexFork = m_chain.FindFork(pindexMostWork);
3245
3246 // Disconnect active blocks which are no longer in the best chain.
3247 bool fBlocksDisconnected = false;
3249 while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
3250 if (!DisconnectTip(state, &disconnectpool)) {
3251 // This is likely a fatal error, but keep the mempool consistent,
3252 // just in case. Only remove from the mempool in this case.
3253 MaybeUpdateMempoolForReorg(disconnectpool, false);
3254
3255 // If we're unable to disconnect a block during normal operation,
3256 // then that is a failure of our local system -- we should abort
3257 // rather than stay on a less work chain.
3258 FatalError(m_chainman.GetNotifications(), state, _("Failed to disconnect block."));
3259 return false;
3260 }
3261 fBlocksDisconnected = true;
3262 }
3263
3264 // Build list of new blocks to connect (in descending height order).
3265 std::vector<CBlockIndex*> vpindexToConnect;
3266 bool fContinue = true;
3267 int nHeight = pindexFork ? pindexFork->nHeight : -1;
3268 while (fContinue && nHeight != pindexMostWork->nHeight) {
3269 // Don't iterate the entire list of potential improvements toward the best tip, as we likely only need
3270 // a few blocks along the way.
3271 int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3272 vpindexToConnect.clear();
3273 vpindexToConnect.reserve(nTargetHeight - nHeight);
3274 CBlockIndex* pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3275 while (pindexIter && pindexIter->nHeight != nHeight) {
3276 vpindexToConnect.push_back(pindexIter);
3277 pindexIter = pindexIter->pprev;
3278 }
3279 nHeight = nTargetHeight;
3280
3281 // Connect new blocks.
3282 for (CBlockIndex* pindexConnect : vpindexToConnect | std::views::reverse) {
3283 if (!ConnectTip(state, pindexConnect, pindexConnect == pindexMostWork ? pblock : std::shared_ptr<const CBlock>(), connectTrace, disconnectpool)) {
3284 if (state.IsInvalid()) {
3285 // The block violates a consensus rule.
3287 InvalidChainFound(vpindexToConnect.front());
3288 }
3289 state = BlockValidationState();
3290 fInvalidFound = true;
3291 fContinue = false;
3292 break;
3293 } else {
3294 // A system error occurred (disk space, database error, ...).
3295 // Make the mempool consistent with the current tip, just in case
3296 // any observers try to use it before shutdown.
3297 MaybeUpdateMempoolForReorg(disconnectpool, false);
3298 return false;
3299 }
3300 } else {
3302 if (!pindexOldTip || m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
3303 // We're in a better position than we were. Return temporarily to release the lock.
3304 fContinue = false;
3305 break;
3306 }
3307 }
3308 }
3309 }
3310
3311 if (fBlocksDisconnected) {
3312 // If any blocks were disconnected, disconnectpool may be non empty. Add
3313 // any disconnected transactions back to the mempool.
3314 MaybeUpdateMempoolForReorg(disconnectpool, true);
3315 }
3316 if (m_mempool) m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
3317
3319
3320 return true;
3321}
3322
3323static SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
3324{
3326 if (!blockfiles_indexed) return SynchronizationState::INIT_REINDEX;
3328}
3329
3331{
3333 if (!m_cached_is_ibd.load(std::memory_order_relaxed)) return;
3334 if (m_blockman.LoadingBlocks()) return;
3335 if (!CurrentChainstate().m_chain.IsTipRecent(MinimumChainWork(), m_options.max_tip_age)) return;
3336 LogInfo("Leaving InitialBlockDownload (latching to false)");
3337 m_cached_is_ibd.store(false, std::memory_order_relaxed);
3338}
3339
3341{
3342 bool fNotify = false;
3343 bool fInitialBlockDownload = false;
3344 CBlockIndex* pindexHeader = nullptr;
3345 {
3346 LOCK(GetMutex());
3347 pindexHeader = m_best_header;
3348
3349 if (pindexHeader != m_last_notified_header) {
3350 fNotify = true;
3351 fInitialBlockDownload = IsInitialBlockDownload();
3352 m_last_notified_header = pindexHeader;
3353 }
3354 }
3355 // Send block tip changed notifications without the lock held
3356 if (fNotify) {
3357 GetNotifications().headerTip(GetSynchronizationState(fInitialBlockDownload, m_blockman.m_blockfiles_indexed), pindexHeader->nHeight, pindexHeader->nTime, false);
3358 }
3359 return fNotify;
3360}
3361
3364
3365 if (signals.CallbacksPending() > 10) {
3366 signals.SyncWithValidationInterfaceQueue();
3367 }
3368}
3369
3370bool Chainstate::ActivateBestChain(BlockValidationState& state, std::shared_ptr<const CBlock> pblock)
3371{
3373
3374 // Note that while we're often called here from ProcessNewBlock, this is
3375 // far from a guarantee. Things in the P2P/RPC will often end up calling
3376 // us in the middle of ProcessNewBlock - do not assume pblock is set
3377 // sanely for performance or correctness!
3379
3380 // ABC maintains a fair degree of expensive-to-calculate internal state
3381 // because this function periodically releases cs_main so that it does not lock up other threads for too long
3382 // during large connects - and to allow for e.g. the callback queue to drain
3383 // we use m_chainstate_mutex to enforce mutual exclusion so that only one caller may execute this function at a time
3385
3386 // Belt-and-suspenders check that we aren't attempting to advance the
3387 // chainstate past the target block.
3388 if (WITH_LOCK(::cs_main, return m_target_utxohash)) {
3389 LogError("%s", STR_INTERNAL_BUG("m_target_utxohash is set - this chainstate should not be in operation."));
3390 return Assume(false);
3391 }
3392
3393 CBlockIndex *pindexMostWork = nullptr;
3394 CBlockIndex *pindexNewTip = nullptr;
3395 bool exited_ibd{false};
3396 do {
3397 // Block until the validation queue drains. This should largely
3398 // never happen in normal operation, however may happen during
3399 // reindex, causing memory blowup if we run too far ahead.
3400 // Note that if a validationinterface callback ends up calling
3401 // ActivateBestChain this may lead to a deadlock! We should
3402 // probably have a DEBUG_LOCKORDER test for this in the future.
3403 if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3404
3405 {
3406 LOCK(cs_main);
3407 {
3408 // Lock transaction pool for at least as long as it takes for connectTrace to be consumed
3409 LOCK(MempoolMutex());
3410 const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3411 CBlockIndex* starting_tip = m_chain.Tip();
3412 bool blocks_connected = false;
3413 do {
3414 // We absolutely may not unlock cs_main until we've made forward progress
3415 // (with the exception of shutdown due to hardware issues, low disk space, etc).
3416 ConnectTrace connectTrace; // Destructed before cs_main is unlocked
3417
3418 if (pindexMostWork == nullptr) {
3419 pindexMostWork = FindMostWorkChain();
3420 }
3421
3422 // Whether we have anything to do at all.
3423 if (pindexMostWork == nullptr || pindexMostWork == m_chain.Tip()) {
3424 break;
3425 }
3426
3427 bool fInvalidFound = false;
3428 std::shared_ptr<const CBlock> nullBlockPtr;
3429 // BlockConnected signals must be sent for the original role;
3430 // in case snapshot validation is completed during ActivateBestChainStep, the
3431 // result of GetRole() changes from BACKGROUND to NORMAL.
3432 const ChainstateRole chainstate_role{this->GetRole()};
3433 if (!ActivateBestChainStep(state, pindexMostWork, pblock && pblock->GetHash() == pindexMostWork->GetBlockHash() ? pblock : nullBlockPtr, fInvalidFound, connectTrace)) {
3434 // A system error occurred
3435 return false;
3436 }
3437 blocks_connected = true;
3438
3439 if (fInvalidFound) {
3440 // Wipe cache, we may need another branch now.
3441 pindexMostWork = nullptr;
3442 }
3443 pindexNewTip = m_chain.Tip();
3444
3445 for (const PerBlockConnectTrace& trace : connectTrace.GetBlocksConnected()) {
3446 assert(trace.pblock && trace.pindex);
3447 if (m_chainman.m_options.signals) {
3448 m_chainman.m_options.signals->BlockConnected(chainstate_role, trace.pblock, trace.pindex);
3449 }
3450 }
3451
3452 // Break this do-while to ensure we don't advance past the target block.
3453 if (ReachedTarget()) {
3454 break;
3455 }
3456 } while (!m_chain.Tip() || (starting_tip && CBlockIndexWorkComparator()(m_chain.Tip(), starting_tip)));
3457 if (!blocks_connected) return true;
3458
3459 const CBlockIndex* pindexFork = m_chain.FindFork(starting_tip);
3460 bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3461
3462 if (was_in_ibd && !still_in_ibd) {
3463 // Active chainstate has exited IBD.
3464 exited_ibd = true;
3465 }
3466
3467 // Notify external listeners about the new tip.
3468 // Enqueue while holding cs_main to ensure that UpdatedBlockTip is called in the order in which blocks are connected
3469 if (this == &m_chainman.ActiveChainstate() && pindexFork != pindexNewTip) {
3470 // Notify ValidationInterface subscribers
3471 if (m_chainman.m_options.signals) {
3472 m_chainman.m_options.signals->UpdatedBlockTip(pindexNewTip, pindexFork, still_in_ibd);
3473 }
3474
3475 if (kernel::IsInterrupted(m_chainman.GetNotifications().blockTip(
3476 /*state=*/GetSynchronizationState(still_in_ibd, m_chainman.m_blockman.m_blockfiles_indexed),
3477 /*index=*/*pindexNewTip,
3478 /*verification_progress=*/m_chainman.GuessVerificationProgress(pindexNewTip))))
3479 {
3480 // Just breaking and returning success for now. This could
3481 // be changed to bubble up the kernel::Interrupted value to
3482 // the caller so the caller could distinguish between
3483 // completed and interrupted operations.
3484 break;
3485 }
3486 }
3487 } // release MempoolMutex
3488 // Notify external listeners about the new tip, even if pindexFork == pindexNewTip.
3489 if (m_chainman.m_options.signals && this == &m_chainman.ActiveChainstate()) {
3490 m_chainman.m_options.signals->ActiveTipChange(*Assert(pindexNewTip), m_chainman.IsInitialBlockDownload());
3491 }
3492 } // release cs_main
3493 // When we reach this point, we switched to a new tip (stored in pindexNewTip).
3494
3495 bool reached_target;
3496 {
3497 LOCK(m_chainman.GetMutex());
3498 if (exited_ibd) {
3499 // If a background chainstate is in use, we may need to rebalance our
3500 // allocation of caches once a chainstate exits initial block download.
3501 m_chainman.MaybeRebalanceCaches();
3502 }
3503
3504 // Write changes periodically to disk, after relay.
3506 return false;
3507 }
3508
3509 reached_target = ReachedTarget();
3510 }
3511
3512 if (reached_target) {
3513 // Chainstate has reached the target block, so exit.
3514 //
3515 // Restart indexes so indexes can resync and index new blocks after
3516 // the target block.
3517 //
3518 // This cannot be done while holding cs_main (within
3519 // MaybeValidateSnapshot) or a cs_main deadlock will occur.
3520 if (m_chainman.snapshot_download_completed) {
3521 m_chainman.snapshot_download_completed();
3522 }
3523 break;
3524 }
3525
3526 // We check interrupt only after giving ActivateBestChainStep a chance to run once so that we
3527 // never interrupt before connecting the genesis block during LoadChainTip(). Previously this
3528 // caused an assert() failure during interrupt in such cases as the UTXO DB flushing checks
3529 // that the best block hash is non-null.
3530 if (m_chainman.m_interrupt) break;
3531 } while (pindexNewTip != pindexMostWork);
3532
3533 m_chainman.CheckBlockIndex();
3534
3535 return true;
3536}
3537
3538bool Chainstate::PreciousBlock(BlockValidationState& state, CBlockIndex* pindex)
3539{
3542 {
3543 LOCK(cs_main);
3544 if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
3545 // Nothing to do, this block is not at the tip.
3546 return true;
3547 }
3548 if (m_chain.Tip()->nChainWork > m_chainman.nLastPreciousChainwork) {
3549 // The chain has been extended since the last call, reset the counter.
3550 m_chainman.nBlockReverseSequenceId = -1;
3551 }
3552 m_chainman.nLastPreciousChainwork = m_chain.Tip()->nChainWork;
3553 setBlockIndexCandidates.erase(pindex);
3554 pindex->nSequenceId = m_chainman.nBlockReverseSequenceId;
3555 if (m_chainman.nBlockReverseSequenceId > std::numeric_limits<int32_t>::min()) {
3556 // We can't keep reducing the counter if somebody really wants to
3557 // call preciousblock 2**31-1 times on the same set of tips...
3558 m_chainman.nBlockReverseSequenceId--;
3559 }
3560 if (pindex->IsValid(BLOCK_VALID_TRANSACTIONS) && pindex->HaveNumChainTxs()) {
3561 setBlockIndexCandidates.insert(pindex);
3563 }
3564 }
3565
3566 return ActivateBestChain(state, std::shared_ptr<const CBlock>());
3567}
3568
3569bool Chainstate::InvalidateBlock(BlockValidationState& state, CBlockIndex* pindex)
3570{
3573
3574 // Genesis block can't be invalidated
3575 assert(pindex);
3576 if (pindex->nHeight == 0) return false;
3577
3578 // We do not allow ActivateBestChain() to run while InvalidateBlock() is
3579 // running, as that could cause the tip to change while we disconnect
3580 // blocks.
3582
3583 // We'll be acquiring and releasing cs_main below, to allow the validation
3584 // callbacks to run. However, we should keep the block index in a
3585 // consistent state as we disconnect blocks -- in particular we need to
3586 // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3587 // To avoid walking the block index repeatedly in search of candidates,
3588 // build a map once so that we can look up candidate blocks by chain
3589 // work as we go.
3590 std::multimap<const arith_uint256, CBlockIndex*> highpow_outofchain_headers;
3591
3592 {
3593 LOCK(cs_main);
3594 for (auto& entry : m_blockman.m_block_index) {
3595 CBlockIndex* candidate = &entry.second;
3596 // We don't need to put anything in our active chain into the
3597 // multimap, because those candidates will be found and considered
3598 // as we disconnect.
3599 // Instead, consider only non-active-chain blocks that score
3600 // at least as good with CBlockIndexWorkComparator as the new tip.
3601 if (!m_chain.Contains(candidate) &&
3602 !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3603 !(candidate->nStatus & BLOCK_FAILED_VALID)) {
3604 highpow_outofchain_headers.insert({candidate->nChainWork, candidate});
3605 }
3606 }
3607 }
3608
3609 CBlockIndex* to_mark_failed = pindex;
3610 bool pindex_was_in_chain = false;
3611 int disconnected = 0;
3612
3613 // Disconnect (descendants of) pindex, and mark them invalid.
3614 while (true) {
3615 if (m_chainman.m_interrupt) break;
3616
3617 // Make sure the queue of validation callbacks doesn't grow unboundedly.
3618 if (m_chainman.m_options.signals) LimitValidationInterfaceQueue(*m_chainman.m_options.signals);
3619
3620 LOCK(cs_main);
3621 // Lock for as long as disconnectpool is in scope to make sure MaybeUpdateMempoolForReorg is
3622 // called after DisconnectTip without unlocking in between
3623 LOCK(MempoolMutex());
3624 if (!m_chain.Contains(pindex)) break;
3625 pindex_was_in_chain = true;
3626 CBlockIndex* disconnected_tip{m_chain.Tip()};
3627
3628 // ActivateBestChain considers blocks already in m_chain
3629 // unconditionally valid already, so force disconnect away from it.
3630 DisconnectedBlockTransactions disconnectpool{MAX_DISCONNECTED_TX_POOL_BYTES};
3631 bool ret = DisconnectTip(state, &disconnectpool);
3632 // DisconnectTip will add transactions to disconnectpool.
3633 // Adjust the mempool to be consistent with the new tip, adding
3634 // transactions back to the mempool if disconnecting was successful,
3635 // and we're not doing a very deep invalidation (in which case
3636 // keeping the mempool up to date is probably futile anyway).
3637 MaybeUpdateMempoolForReorg(disconnectpool, /* fAddToMempool = */ (++disconnected <= 10) && ret);
3638 if (!ret) return false;
3639 CBlockIndex* new_tip{m_chain.Tip()};
3640 assert(disconnected_tip->pprev == new_tip);
3641
3642 // We immediately mark the disconnected blocks as invalid.
3643 // This prevents a case where pruned nodes may fail to invalidateblock
3644 // and be left unable to start as they have no tip candidates (as there
3645 // are no blocks that meet the "have data and are not invalid per
3646 // nStatus" criteria for inclusion in setBlockIndexCandidates).
3647 disconnected_tip->nStatus |= BLOCK_FAILED_VALID;
3648 m_blockman.m_dirty_blockindex.insert(disconnected_tip);
3649 setBlockIndexCandidates.erase(disconnected_tip);
3650 setBlockIndexCandidates.insert(new_tip);
3651
3652 // Mark out-of-chain descendants of the invalidated block as invalid
3653 // Add any equal or more work headers that are not invalidated to setBlockIndexCandidates
3654 // Recalculate m_best_header if it became invalid.
3655 auto candidate_it = highpow_outofchain_headers.lower_bound(new_tip->nChainWork);
3656
3657 const bool best_header_needs_update{m_chainman.m_best_header->GetAncestor(disconnected_tip->nHeight) == disconnected_tip};
3658 if (best_header_needs_update) {
3659 // new_tip is definitely still valid at this point, but there may be better ones
3660 m_chainman.m_best_header = new_tip;
3661 }
3662
3663 while (candidate_it != highpow_outofchain_headers.end()) {
3664 CBlockIndex* candidate{candidate_it->second};
3665 if (candidate->GetAncestor(disconnected_tip->nHeight) == disconnected_tip) {
3666 // Children of failed blocks are marked as BLOCK_FAILED_VALID.
3667 candidate->nStatus |= BLOCK_FAILED_VALID;
3668 m_blockman.m_dirty_blockindex.insert(candidate);
3669 // If invalidated, the block is irrelevant for setBlockIndexCandidates
3670 // and for m_best_header and can be removed from the cache.
3671 candidate_it = highpow_outofchain_headers.erase(candidate_it);
3672 continue;
3673 }
3674 if (!CBlockIndexWorkComparator()(candidate, new_tip) &&
3675 candidate->IsValid(BLOCK_VALID_TRANSACTIONS) &&
3676 candidate->HaveNumChainTxs()) {
3677 setBlockIndexCandidates.insert(candidate);
3678 // Do not remove candidate from the highpow_outofchain_headers cache, because it might be a descendant of the block being invalidated
3679 // which needs to be marked failed later.
3680 }
3681 if (best_header_needs_update &&
3682 m_chainman.m_best_header->nChainWork < candidate->nChainWork) {
3683 m_chainman.m_best_header = candidate;
3684 }
3685 ++candidate_it;
3686 }
3687
3688 // Track the last disconnected block to call InvalidChainFound on it.
3689 to_mark_failed = disconnected_tip;
3690 }
3691
3692 m_chainman.CheckBlockIndex();
3693
3694 {
3695 LOCK(cs_main);
3696 if (m_chain.Contains(to_mark_failed)) {
3697 // If the to-be-marked invalid block is in the active chain, something is interfering and we can't proceed.
3698 return false;
3699 }
3700
3701 // Mark pindex as invalid if it never was in the main chain
3702 if (!pindex_was_in_chain && !(pindex->nStatus & BLOCK_FAILED_VALID)) {
3703 pindex->nStatus |= BLOCK_FAILED_VALID;
3704 m_blockman.m_dirty_blockindex.insert(pindex);
3705 setBlockIndexCandidates.erase(pindex);
3706 }
3707
3708 // If any new blocks somehow arrived while we were disconnecting
3709 // (above), then the pre-calculation of what should go into
3710 // setBlockIndexCandidates may have missed entries. This would
3711 // technically be an inconsistency in the block index, but if we clean
3712 // it up here, this should be an essentially unobservable error.
3713 // Loop back over all block index entries and add any missing entries
3714 // to setBlockIndexCandidates.
3715 for (auto& [_, block_index] : m_blockman.m_block_index) {
3716 if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && !setBlockIndexCandidates.value_comp()(&block_index, m_chain.Tip())) {
3717 setBlockIndexCandidates.insert(&block_index);
3718 }
3719 }
3720
3721 InvalidChainFound(to_mark_failed);
3722 }
3723
3724 // Only notify about a new block tip if the active chain was modified.
3725 if (pindex_was_in_chain) {
3726 // Ignoring return value for now, this could be changed to bubble up
3727 // kernel::Interrupted value to the caller so the caller could
3728 // distinguish between completed and interrupted operations. It might
3729 // also make sense for the blockTip notification to have an enum
3730 // parameter indicating the source of the tip change so hooks can
3731 // distinguish user-initiated invalidateblock changes from other
3732 // changes.
3733 (void)m_chainman.GetNotifications().blockTip(
3734 /*state=*/GetSynchronizationState(m_chainman.IsInitialBlockDownload(), m_chainman.m_blockman.m_blockfiles_indexed),
3735 /*index=*/*to_mark_failed->pprev,
3736 /*verification_progress=*/WITH_LOCK(m_chainman.GetMutex(), return m_chainman.GuessVerificationProgress(to_mark_failed->pprev)));
3737
3738 // Fire ActiveTipChange now for the current chain tip to make sure clients are notified.
3739 // ActivateBestChain may call this as well, but not necessarily.
3740 if (m_chainman.m_options.signals) {
3741 m_chainman.m_options.signals->ActiveTipChange(*Assert(m_chain.Tip()), m_chainman.IsInitialBlockDownload());
3742 }
3743 }
3744 return true;
3745}
3746
3747void Chainstate::SetBlockFailureFlags(CBlockIndex* invalid_block)
3748{
3750
3751 for (auto& [_, block_index] : m_blockman.m_block_index) {
3752 if (invalid_block != &block_index && block_index.GetAncestor(invalid_block->nHeight) == invalid_block) {
3753 block_index.nStatus |= BLOCK_FAILED_VALID;
3754 m_blockman.m_dirty_blockindex.insert(&block_index);
3755 }
3756 }
3757}
3758
3761
3762 int nHeight = pindex->nHeight;
3763
3764 // Remove the invalidity flag from this block and all its descendants and ancestors.
3765 for (auto& [_, block_index] : m_blockman.m_block_index) {
3766 if ((block_index.nStatus & BLOCK_FAILED_VALID) && (block_index.GetAncestor(nHeight) == pindex || pindex->GetAncestor(block_index.nHeight) == &block_index)) {
3767 block_index.nStatus &= ~BLOCK_FAILED_VALID;
3768 m_blockman.m_dirty_blockindex.insert(&block_index);
3769 if (block_index.IsValid(BLOCK_VALID_TRANSACTIONS) && block_index.HaveNumChainTxs() && setBlockIndexCandidates.value_comp()(m_chain.Tip(), &block_index)) {
3770 setBlockIndexCandidates.insert(&block_index);
3771 }
3772 if (&block_index == m_chainman.m_best_invalid) {
3773 // Reset invalid block marker if it was pointing to one of those.
3774 m_chainman.m_best_invalid = nullptr;
3775 }
3776 }
3777 }
3778}
3779
3781{
3783
3784 // Do not continue building a chainstate that is based on an invalid
3785 // snapshot. This is a belt-and-suspenders type of check because if an
3786 // invalid snapshot is loaded, the node will shut down to force a manual
3787 // intervention. But it is good to handle this case correctly regardless.
3788 if (m_assumeutxo == Assumeutxo::INVALID) {
3789 return;
3790 }
3791
3792 // The block only is a candidate for the most-work-chain if it has the same
3793 // or more work than our current tip.
3794 if (m_chain.Tip() != nullptr && setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
3795 return;
3796 }
3797
3798 const CBlockIndex* target_block{TargetBlock()};
3799 if (!target_block) {
3800 // If no specific target block, add all entries that have more
3801 // work than the tip.
3802 setBlockIndexCandidates.insert(pindex);
3803 } else {
3804 // If there is a target block, only consider connecting blocks
3805 // towards the target block.
3806 if (target_block->GetAncestor(pindex->nHeight) == pindex) {
3807 setBlockIndexCandidates.insert(pindex);
3808 }
3809 }
3810}
3811
3814{
3816 pindexNew->nTx = block.vtx.size();
3817 // Typically m_chain_tx_count will be 0 at this point, but it can be nonzero if this
3818 // is a pruned block which is being downloaded again, or if this is an
3819 // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value from the
3820 // snapshot metadata. If the pindex is not the snapshot block and the
3821 // m_chain_tx_count value is not zero, assert that value is actually correct.
3822 auto prev_tx_sum = [](CBlockIndex& block) { return block.nTx + (block.pprev ? block.pprev->m_chain_tx_count : 0); };
3823 if (!Assume(pindexNew->m_chain_tx_count == 0 || pindexNew->m_chain_tx_count == prev_tx_sum(*pindexNew) ||
3824 std::ranges::any_of(m_chainstates, [&](const auto& cs) EXCLUSIVE_LOCKS_REQUIRED(cs_main) { return cs->SnapshotBase() == pindexNew; }))) {
3825 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",
3826 pindexNew->nHeight, pindexNew->m_chain_tx_count, prev_tx_sum(*pindexNew), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3827 pindexNew->m_chain_tx_count = 0;
3828 }
3829 pindexNew->nFile = pos.nFile;
3830 pindexNew->nDataPos = pos.nPos;
3831 pindexNew->nUndoPos = 0;
3832 pindexNew->nStatus |= BLOCK_HAVE_DATA;
3833 if (DeploymentActiveAt(*pindexNew, *this, Consensus::DEPLOYMENT_SEGWIT)) {
3834 pindexNew->nStatus |= BLOCK_OPT_WITNESS;
3835 }
3837 m_blockman.m_dirty_blockindex.insert(pindexNew);
3838
3839 if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
3840 // If pindexNew is the genesis block or all parents are BLOCK_VALID_TRANSACTIONS.
3841 std::deque<CBlockIndex*> queue;
3842 queue.push_back(pindexNew);
3843
3844 // Recursively process any descendant blocks that now may be eligible to be connected.
3845 while (!queue.empty()) {
3846 CBlockIndex *pindex = queue.front();
3847 queue.pop_front();
3848 // Before setting m_chain_tx_count, assert that it is 0 or already set to
3849 // the correct value. This assert will fail after receiving the
3850 // assumeutxo snapshot block if assumeutxo snapshot metadata has an
3851 // incorrect hardcoded AssumeutxoData::m_chain_tx_count value.
3852 if (!Assume(pindex->m_chain_tx_count == 0 || pindex->m_chain_tx_count == prev_tx_sum(*pindex))) {
3853 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",
3854 pindex->nHeight, pindex->m_chain_tx_count, prev_tx_sum(*pindex), CLIENT_NAME, FormatFullVersion(), CLIENT_BUGREPORT);
3855 }
3856 pindex->m_chain_tx_count = prev_tx_sum(*pindex);
3857 pindex->nSequenceId = nBlockSequenceId++;
3858 for (const auto& c : m_chainstates) {
3859 c->TryAddBlockIndexCandidate(pindex);
3860 }
3861 std::pair<std::multimap<CBlockIndex*, CBlockIndex*>::iterator, std::multimap<CBlockIndex*, CBlockIndex*>::iterator> range = m_blockman.m_blocks_unlinked.equal_range(pindex);
3862 while (range.first != range.second) {
3863 std::multimap<CBlockIndex*, CBlockIndex*>::iterator it = range.first;
3864 queue.push_back(it->second);
3865 range.first++;
3866 m_blockman.m_blocks_unlinked.erase(it);
3867 }
3868 }
3869 } else {
3870 if (pindexNew->pprev && pindexNew->pprev->IsValid(BLOCK_VALID_TREE)) {
3871 m_blockman.m_blocks_unlinked.insert(std::make_pair(pindexNew->pprev, pindexNew));
3872 }
3873 }
3874}
3875
3876static bool CheckBlockHeader(const CBlockHeader& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW = true)
3877{
3878 // Check proof of work matches claimed amount
3879 if (fCheckPOW && !CheckProofOfWork(block.GetHash(), block.nBits, consensusParams))
3880 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "high-hash", "proof of work failed");
3881
3882 return true;
3883}
3884
3885static bool CheckMerkleRoot(const CBlock& block, BlockValidationState& state)
3886{
3887 if (block.m_checked_merkle_root) return true;
3888
3889 bool mutated;
3890 uint256 merkle_root = BlockMerkleRoot(block, &mutated);
3891 if (block.hashMerkleRoot != merkle_root) {
3892 return state.Invalid(
3894 /*reject_reason=*/"bad-txnmrklroot",
3895 /*debug_message=*/"hashMerkleRoot mismatch");
3896 }
3897
3898 // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
3899 // of transactions in a block without affecting the merkle root of a block,
3900 // while still invalidating it.
3901 if (mutated) {
3902 return state.Invalid(
3904 /*reject_reason=*/"bad-txns-duplicate",
3905 /*debug_message=*/"duplicate transaction");
3906 }
3907
3908 block.m_checked_merkle_root = true;
3909 return true;
3910}
3911
3918static bool CheckWitnessMalleation(const CBlock& block, bool expect_witness_commitment, BlockValidationState& state)
3919{
3920 if (expect_witness_commitment) {
3921 if (block.m_checked_witness_commitment) return true;
3922
3923 int commitpos = GetWitnessCommitmentIndex(block);
3924 if (commitpos != NO_WITNESS_COMMITMENT) {
3925 assert(!block.vtx.empty() && !block.vtx[0]->vin.empty());
3926 const auto& witness_stack{block.vtx[0]->vin[0].scriptWitness.stack};
3927
3928 if (witness_stack.size() != 1 || witness_stack[0].size() != 32) {
3929 return state.Invalid(
3931 /*reject_reason=*/"bad-witness-nonce-size",
3932 /*debug_message=*/strprintf("%s : invalid witness reserved value size", __func__));
3933 }
3934
3935 // The malleation check is ignored; as the transaction tree itself
3936 // already does not permit it, it is impossible to trigger in the
3937 // witness tree.
3938 uint256 hash_witness = BlockWitnessMerkleRoot(block);
3939
3940 CHash256().Write(hash_witness).Write(witness_stack[0]).Finalize(hash_witness);
3941 if (memcmp(hash_witness.begin(), &block.vtx[0]->vout[commitpos].scriptPubKey[6], 32)) {
3942 return state.Invalid(
3944 /*reject_reason=*/"bad-witness-merkle-match",
3945 /*debug_message=*/strprintf("%s : witness merkle commitment mismatch", __func__));
3946 }
3947
3948 block.m_checked_witness_commitment = true;
3949 return true;
3950 }
3951 }
3952
3953 // No witness data is allowed in blocks that don't commit to witness data, as this would otherwise leave room for spam
3954 for (const auto& tx : block.vtx) {
3955 if (tx->HasWitness()) {
3956 return state.Invalid(
3958 /*reject_reason=*/"unexpected-witness",
3959 /*debug_message=*/strprintf("%s : unexpected witness data found", __func__));
3960 }
3961 }
3962
3963 return true;
3964}
3965
3966bool CheckBlock(const CBlock& block, BlockValidationState& state, const Consensus::Params& consensusParams, bool fCheckPOW, bool fCheckMerkleRoot)
3967{
3968 // These are checks that are independent of context.
3969
3970 if (block.fChecked)
3971 return true;
3972
3973 // Check that the header is valid (particularly PoW). This is mostly
3974 // redundant with the call in AcceptBlockHeader.
3975 if (!CheckBlockHeader(block, state, consensusParams, fCheckPOW))
3976 return false;
3977
3978 // Signet only: check block solution
3979 if (consensusParams.signet_blocks && fCheckPOW && !CheckSignetBlockSolution(block, consensusParams)) {
3980 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-signet-blksig", "signet block signature validation failure");
3981 }
3982
3983 // Check the merkle root.
3984 if (fCheckMerkleRoot && !CheckMerkleRoot(block, state)) {
3985 return false;
3986 }
3987
3988 // All potential-corruption validation must be done before we do any
3989 // transaction validation, as otherwise we may mark the header as invalid
3990 // because we receive the wrong transactions for it.
3991 // Note that witness malleability is checked in ContextualCheckBlock, so no
3992 // checks that use witness data may be performed here.
3993
3994 // Size limits
3996 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-length", "size limits failed");
3997
3998 // First transaction must be coinbase, the rest must not be
3999 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase())
4000 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-missing", "first tx is not coinbase");
4001 for (unsigned int i = 1; i < block.vtx.size(); i++)
4002 if (block.vtx[i]->IsCoinBase())
4003 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-multiple", "more than one coinbase");
4004
4005 // Check transactions
4006 // Must check for duplicate inputs (see CVE-2018-17144)
4007 for (const auto& tx : block.vtx) {
4008 TxValidationState tx_state;
4009 if (!CheckTransaction(*tx, tx_state)) {
4010 // CheckBlock() does context-free validation checks. The only
4011 // possible failures are consensus failures.
4014 strprintf("Transaction check failed (tx hash %s) %s", tx->GetHash().ToString(), tx_state.GetDebugMessage()));
4015 }
4016 }
4017 // This underestimates the number of sigops, because unlike ConnectBlock it
4018 // does not count witness and p2sh sigops.
4019 unsigned int nSigOps = 0;
4020 for (const auto& tx : block.vtx)
4021 {
4022 nSigOps += GetLegacySigOpCount(*tx);
4023 }
4025 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-sigops", "out-of-bounds SigOpCount");
4026
4027 if (fCheckPOW && fCheckMerkleRoot)
4028 block.fChecked = true;
4029
4030 return true;
4031}
4032
4034{
4035 int commitpos = GetWitnessCommitmentIndex(block);
4036 static const std::vector<unsigned char> nonce(32, 0x00);
4037 if (commitpos != NO_WITNESS_COMMITMENT && DeploymentActiveAfter(pindexPrev, *this, Consensus::DEPLOYMENT_SEGWIT) && !block.vtx[0]->HasWitness()) {
4038 CMutableTransaction tx(*block.vtx[0]);
4039 tx.vin[0].scriptWitness.stack.resize(1);
4040 tx.vin[0].scriptWitness.stack[0] = nonce;
4041 block.vtx[0] = MakeTransactionRef(std::move(tx));
4042 }
4043}
4044
4046{
4047 int commitpos = GetWitnessCommitmentIndex(block);
4048 std::vector<unsigned char> ret(32, 0x00);
4049 if (commitpos == NO_WITNESS_COMMITMENT) {
4050 uint256 witnessroot = BlockWitnessMerkleRoot(block);
4051 CHash256().Write(witnessroot).Write(ret).Finalize(witnessroot);
4052 CTxOut out;
4053 out.nValue = 0;
4054 out.scriptPubKey.resize(MINIMUM_WITNESS_COMMITMENT);
4055 out.scriptPubKey[0] = OP_RETURN;
4056 out.scriptPubKey[1] = 0x24;
4057 out.scriptPubKey[2] = 0xaa;
4058 out.scriptPubKey[3] = 0x21;
4059 out.scriptPubKey[4] = 0xa9;
4060 out.scriptPubKey[5] = 0xed;
4061 memcpy(&out.scriptPubKey[6], witnessroot.begin(), 32);
4062 CMutableTransaction tx(*block.vtx[0]);
4063 tx.vout.push_back(out);
4064 block.vtx[0] = MakeTransactionRef(std::move(tx));
4065 }
4066 UpdateUncommittedBlockStructures(block, pindexPrev);
4067}
4068
4069bool HasValidProofOfWork(std::span<const CBlockHeader> headers, const Consensus::Params& consensusParams)
4070{
4071 return std::ranges::all_of(headers,
4072 [&](const auto& header) { return CheckProofOfWork(header.GetHash(), header.nBits, consensusParams); });
4073}
4074
4075bool IsBlockMutated(const CBlock& block, bool check_witness_root)
4076{
4078 if (!CheckMerkleRoot(block, state)) {
4079 LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
4080 return true;
4081 }
4082
4083 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4084 // Consider the block mutated if any transaction is 64 bytes in size (see 3.1
4085 // in "Weaknesses in Bitcoin’s Merkle Root Construction":
4086 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4087 //
4088 // Note: This is not a consensus change as this only applies to blocks that
4089 // don't have a coinbase transaction and would therefore already be invalid.
4090 return std::any_of(block.vtx.begin(), block.vtx.end(),
4091 [](auto& tx) { return GetSerializeSize(TX_NO_WITNESS(tx)) == 64; });
4092 } else {
4093 // Theoretically it is still possible for a block with a 64 byte
4094 // coinbase transaction to be mutated but we neglect that possibility
4095 // here as it requires at least 224 bits of work.
4096 }
4097
4098 if (!CheckWitnessMalleation(block, check_witness_root, state)) {
4099 LogDebug(BCLog::VALIDATION, "Block mutated: %s\n", state.ToString());
4100 return true;
4101 }
4102
4103 return false;
4104}
4105
4106arith_uint256 CalculateClaimedHeadersWork(std::span<const CBlockHeader> headers)
4107{
4108 arith_uint256 total_work{0};
4109 for (const CBlockHeader& header : headers) {
4110 total_work += GetBlockProof(header);
4111 }
4112 return total_work;
4113}
4114
4129{
4131 assert(pindexPrev != nullptr);
4132 const int nHeight = pindexPrev->nHeight + 1;
4133
4134 // Check proof of work
4135 const Consensus::Params& consensusParams = chainman.GetConsensus();
4136 if (block.nBits != GetNextWorkRequired(pindexPrev, &block, consensusParams))
4137 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "bad-diffbits", "incorrect proof of work");
4138
4139 // Check timestamp against prev
4140 if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast())
4141 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-too-old", "block's timestamp is too early");
4142
4143 // Testnet4 and regtest only: Check timestamp against prev for difficulty-adjustment
4144 // blocks to prevent timewarp attacks (see https://github.com/bitcoin/bitcoin/pull/15482).
4145 if (consensusParams.enforce_BIP94) {
4146 // Check timestamp for the first block of each difficulty adjustment
4147 // interval, except the genesis block.
4148 if (nHeight % consensusParams.DifficultyAdjustmentInterval() == 0) {
4149 if (block.GetBlockTime() < pindexPrev->GetBlockTime() - MAX_TIMEWARP) {
4150 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, "time-timewarp-attack", "block's timestamp is too early on diff adjustment block");
4151 }
4152 }
4153 }
4154
4155 // Check timestamp
4156 if (block.Time() > NodeClock::now() + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4157 return state.Invalid(BlockValidationResult::BLOCK_TIME_FUTURE, "time-too-new", "block timestamp too far in the future");
4158 }
4159
4160 // Reject blocks with outdated version
4161 if ((block.nVersion < 2 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_HEIGHTINCB)) ||
4162 (block.nVersion < 3 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_DERSIG)) ||
4163 (block.nVersion < 4 && DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CLTV))) {
4164 return state.Invalid(BlockValidationResult::BLOCK_INVALID_HEADER, strprintf("bad-version(0x%08x)", block.nVersion),
4165 strprintf("rejected nVersion=0x%08x block", block.nVersion));
4166 }
4167
4168 return true;
4169}
4170
4177static bool ContextualCheckBlock(const CBlock& block, BlockValidationState& state, const ChainstateManager& chainman, const CBlockIndex* pindexPrev)
4178{
4179 const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4180
4181 // Enforce BIP113 (Median Time Past).
4182 bool enforce_locktime_median_time_past{false};
4183 if (DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_CSV)) {
4184 assert(pindexPrev != nullptr);
4185 enforce_locktime_median_time_past = true;
4186 }
4187
4188 const int64_t nLockTimeCutoff{enforce_locktime_median_time_past ?
4189 pindexPrev->GetMedianTimePast() :
4190 block.GetBlockTime()};
4191
4192 // Check that all transactions are finalized
4193 for (const auto& tx : block.vtx) {
4194 if (!IsFinalTx(*tx, nHeight, nLockTimeCutoff)) {
4195 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-txns-nonfinal", "non-final transaction");
4196 }
4197 }
4198
4199 // Enforce rule that the coinbase starts with serialized block height
4201 {
4203 if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
4204 !std::equal(expect.begin(), expect.end(), block.vtx[0]->vin[0].scriptSig.begin())) {
4205 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-cb-height", "block height mismatch in coinbase");
4206 }
4207 }
4208
4209 // Validation for witness commitments.
4210 // * We compute the witness hash (which is the hash including witnesses) of all the block's transactions, except the
4211 // coinbase (where 0x0000....0000 is used instead).
4212 // * The coinbase scriptWitness is a stack of a single 32-byte vector, containing a witness reserved value (unconstrained).
4213 // * We build a merkle tree with all those witness hashes as leaves (similar to the hashMerkleRoot in the block header).
4214 // * There must be at least one output whose scriptPubKey is a single 36-byte push, the first 4 bytes of which are
4215 // {0xaa, 0x21, 0xa9, 0xed}, and the following 32 bytes are SHA256^2(witness root, witness reserved value). In case there are
4216 // multiple, the last one is used.
4217 if (!CheckWitnessMalleation(block, DeploymentActiveAfter(pindexPrev, chainman, Consensus::DEPLOYMENT_SEGWIT), state)) {
4218 return false;
4219 }
4220
4221 // After the coinbase witness reserved value and commitment are verified,
4222 // we can check if the block weight passes (before we've checked the
4223 // coinbase witness, it would be possible for the weight to be too
4224 // large by filling up the coinbase witness, which doesn't change
4225 // the block hash, so we couldn't mark the block as permanently
4226 // failed).
4227 if (GetBlockWeight(block) > MAX_BLOCK_WEIGHT) {
4228 return state.Invalid(BlockValidationResult::BLOCK_CONSENSUS, "bad-blk-weight", strprintf("%s : weight limit failed", __func__));
4229 }
4230
4231 return true;
4232}
4233
4234bool ChainstateManager::AcceptBlockHeader(const CBlockHeader& block, BlockValidationState& state, CBlockIndex** ppindex, bool min_pow_checked)
4235{
4237
4238 // Check for duplicate
4239 uint256 hash = block.GetHash();
4240 BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4241 if (hash != GetConsensus().hashGenesisBlock) {
4242 if (miSelf != m_blockman.m_block_index.end()) {
4243 // Block header is already known.
4244 CBlockIndex* pindex = &(miSelf->second);
4245 if (ppindex)
4246 *ppindex = pindex;
4247 if (pindex->nStatus & BLOCK_FAILED_VALID) {
4248 LogDebug(BCLog::VALIDATION, "%s: block %s is marked invalid\n", __func__, hash.ToString());
4249 return state.Invalid(BlockValidationResult::BLOCK_CACHED_INVALID, "duplicate-invalid",
4250 strprintf("block %s was previously marked invalid", hash.ToString()));
4251 }
4252 return true;
4253 }
4254
4255 if (!CheckBlockHeader(block, state, GetConsensus())) {
4256 LogDebug(BCLog::VALIDATION, "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
4257 return false;
4258 }
4259
4260 // Get prev block index
4261 CBlockIndex* pindexPrev = nullptr;
4262 BlockMap::iterator mi{m_blockman.m_block_index.find(block.hashPrevBlock)};
4263 if (mi == m_blockman.m_block_index.end()) {
4264 LogDebug(BCLog::VALIDATION, "header %s has prev block not found: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
4265 return state.Invalid(BlockValidationResult::BLOCK_MISSING_PREV, "prev-blk-not-found");
4266 }
4267 pindexPrev = &((*mi).second);
4268 if (pindexPrev->nStatus & BLOCK_FAILED_VALID) {
4269 LogDebug(BCLog::VALIDATION, "header %s has prev block invalid: %s\n", hash.ToString(), block.hashPrevBlock.ToString());
4270 return state.Invalid(BlockValidationResult::BLOCK_INVALID_PREV, "bad-prevblk");
4271 }
4272 if (!ContextualCheckBlockHeader(block, state, m_blockman, *this, pindexPrev)) {
4273 LogDebug(BCLog::VALIDATION, "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n", __func__, hash.ToString(), state.ToString());
4274 return false;
4275 }
4276 }
4277 if (!min_pow_checked) {
4278 LogDebug(BCLog::VALIDATION, "%s: not adding new block header %s, missing anti-dos proof-of-work validation\n", __func__, hash.ToString());
4279 return state.Invalid(BlockValidationResult::BLOCK_HEADER_LOW_WORK, "too-little-chainwork");
4280 }
4281 CBlockIndex* pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4282
4283 if (ppindex)
4284 *ppindex = pindex;
4285
4286 return true;
4287}
4288
4289// Exposed wrapper for AcceptBlockHeader
4290bool ChainstateManager::ProcessNewBlockHeaders(std::span<const CBlockHeader> headers, bool min_pow_checked, BlockValidationState& state, const CBlockIndex** ppindex)
4291{
4293 {
4294 LOCK(cs_main);
4295 for (const CBlockHeader& header : headers) {
4296 CBlockIndex *pindex = nullptr; // Use a temp pindex instead of ppindex to avoid a const_cast
4297 bool accepted{AcceptBlockHeader(header, state, &pindex, min_pow_checked)};
4299
4300 if (!accepted) {
4301 return false;
4302 }
4303 if (ppindex) {
4304 *ppindex = pindex;
4305 }
4306 }
4307 }
4308 if (NotifyHeaderTip()) {
4309 if (IsInitialBlockDownload() && ppindex && *ppindex) {
4310 const CBlockIndex& last_accepted{**ppindex};
4311 int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) / GetConsensus().PowTargetSpacing()};
4312 blocks_left = std::max<int64_t>(0, blocks_left);
4313 const double progress{100.0 * last_accepted.nHeight / (last_accepted.nHeight + blocks_left)};
4314 LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n", last_accepted.nHeight, progress);
4315 }
4316 }
4317 return true;
4318}
4319
4320void ChainstateManager::ReportHeadersPresync(int64_t height, int64_t timestamp)
4321{
4323 {
4324 LOCK(GetMutex());
4325 // Don't report headers presync progress if we already have a post-minchainwork header chain.
4326 // This means we lose reporting for potentially legitimate, but unlikely, deep reorgs, but
4327 // prevent attackers that spam low-work headers from filling our logs.
4328 if (m_best_header->nChainWork >= UintToArith256(GetConsensus().nMinimumChainWork)) return;
4329 // Rate limit headers presync updates to 4 per second, as these are not subject to DoS
4330 // protection.
4331 auto now = MockableSteadyClock::now();
4332 if (now < m_last_presync_update + std::chrono::milliseconds{250}) return;
4333 m_last_presync_update = now;
4334 }
4335 bool initial_download = IsInitialBlockDownload();
4336 GetNotifications().headerTip(GetSynchronizationState(initial_download, m_blockman.m_blockfiles_indexed), height, timestamp, /*presync=*/true);
4337 if (initial_download) {
4338 int64_t blocks_left{(NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) / GetConsensus().PowTargetSpacing()};
4339 blocks_left = std::max<int64_t>(0, blocks_left);
4340 const double progress{100.0 * height / (height + blocks_left)};
4341 LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n", height, progress);
4342 }
4343}
4344
4346bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock>& pblock, BlockValidationState& state, CBlockIndex** ppindex, bool fRequested, const FlatFilePos* dbp, bool* fNewBlock, bool min_pow_checked)
4347{
4348 const CBlock& block = *pblock;
4349
4350 if (fNewBlock) *fNewBlock = false;
4352
4353 CBlockIndex *pindexDummy = nullptr;
4354 CBlockIndex *&pindex = ppindex ? *ppindex : pindexDummy;
4355
4356 bool accepted_header{AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4358
4359 if (!accepted_header)
4360 return false;
4361
4362 // Check all requested blocks that we do not already have for validity and
4363 // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4364 // measure, unless the blocks have more work than the active chain tip, and
4365 // aren't too far ahead of it, so are likely to be attached soon.
4366 bool fAlreadyHave = pindex->nStatus & BLOCK_HAVE_DATA;
4367 bool fHasMoreOrSameWork = (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4368 // Blocks that are too out-of-order needlessly limit the effectiveness of
4369 // pruning, because pruning will not delete block files that contain any
4370 // blocks which are too close in height to the tip. Apply this test
4371 // regardless of whether pruning is enabled; it should generally be safe to
4372 // not process unrequested blocks.
4373 bool fTooFarAhead{pindex->nHeight > ActiveHeight() + int(MIN_BLOCKS_TO_KEEP)};
4374
4375 // TODO: Decouple this function from the block download logic by removing fRequested
4376 // This requires some new chain data structure to efficiently look up if a
4377 // block is in a chain leading to a candidate for best tip, despite not
4378 // being such a candidate itself.
4379 // Note that this would break the getblockfrompeer RPC
4380
4381 // TODO: deal better with return value and error conditions for duplicate
4382 // and unrequested blocks.
4383 if (fAlreadyHave) return true;
4384 if (!fRequested) { // If we didn't ask for it:
4385 if (pindex->nTx != 0) return true; // This is a previously-processed block that was pruned
4386 if (!fHasMoreOrSameWork) return true; // Don't process less-work chains
4387 if (fTooFarAhead) return true; // Block height is too high
4388
4389 // Protect against DoS attacks from low-work chains.
4390 // If our tip is behind, a peer could try to send us
4391 // low-work blocks on a fake chain that we would never
4392 // request; don't process these.
4393 if (pindex->nChainWork < MinimumChainWork()) return true;
4394 }
4395
4396 const CChainParams& params{GetParams()};
4397
4398 if (!CheckBlock(block, state, params.GetConsensus()) ||
4399 !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
4400 if (Assume(state.IsInvalid())) {
4401 ActiveChainstate().InvalidBlockFound(pindex, state);
4402 }
4403 LogError("%s: %s\n", __func__, state.ToString());
4404 return false;
4405 }
4406
4407 // Header is valid/has work, merkle tree and segwit merkle tree are good...RELAY NOW
4408 // (but if it does not build on our best tip, let the SendMessages loop relay it)
4409 if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev && m_options.signals) {
4410 m_options.signals->NewPoWValidBlock(pindex, pblock);
4411 }
4412
4413 // Write block to history file
4414 if (fNewBlock) *fNewBlock = true;
4415 try {
4416 FlatFilePos blockPos{};
4417 if (dbp) {
4418 blockPos = *dbp;
4419 m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
4420 } else {
4421 blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
4422 if (blockPos.IsNull()) {
4423 state.Error(strprintf("%s: Failed to find position to write new block to disk", __func__));
4424 return false;
4425 }
4426 }
4427 ReceivedBlockTransactions(block, pindex, blockPos);
4428 } catch (const std::runtime_error& e) {
4429 return FatalError(GetNotifications(), state, strprintf(_("System error while saving block to disk: %s"), e.what()));
4430 }
4431
4432 // TODO: FlushStateToDisk() handles flushing of both block and chainstate
4433 // data, so we should move this to ChainstateManager so that we can be more
4434 // intelligent about how we flush.
4435 // For now, since FlushStateMode::NONE is used, all that can happen is that
4436 // the block files may be pruned, so we can just call this on one
4437 // chainstate (particularly if we haven't implemented pruning with
4438 // background validation yet).
4440
4442
4443 return true;
4444}
4445
4446bool ChainstateManager::ProcessNewBlock(const std::shared_ptr<const CBlock>& block, bool force_processing, bool min_pow_checked, bool* new_block)
4447{
4449
4450 {
4451 CBlockIndex *pindex = nullptr;
4452 if (new_block) *new_block = false;
4454
4455 // CheckBlock() does not support multi-threaded block validation because CBlock::fChecked can cause data race.
4456 // Therefore, the following critical section must include the CheckBlock() call as well.
4457 LOCK(cs_main);
4458
4459 // Skipping AcceptBlock() for CheckBlock() failures means that we will never mark a block as invalid if
4460 // CheckBlock() fails. This is protective against consensus failure if there are any unknown forms of block
4461 // malleability that cause CheckBlock() to fail; see e.g. CVE-2012-2459 and
4462 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html. Because CheckBlock() is
4463 // not very expensive, the anti-DoS benefits of caching failure (of a definitely-invalid block) are not substantial.
4464 bool ret = CheckBlock(*block, state, GetConsensus());
4465 if (ret) {
4466 // Store to disk
4467 ret = AcceptBlock(block, state, &pindex, force_processing, nullptr, new_block, min_pow_checked);
4468 }
4469 if (!ret) {
4470 if (m_options.signals) {
4471 m_options.signals->BlockChecked(block, state);
4472 }
4473 LogError("%s: AcceptBlock FAILED (%s)\n", __func__, state.ToString());
4474 return false;
4475 }
4476 }
4477
4479
4480 BlockValidationState state; // Only used to report errors, not invalidity - ignore it
4481 if (!ActiveChainstate().ActivateBestChain(state, block)) {
4482 LogError("%s: ActivateBestChain failed (%s)\n", __func__, state.ToString());
4483 return false;
4484 }
4485
4486 Chainstate* bg_chain{WITH_LOCK(cs_main, return HistoricalChainstate())};
4487 BlockValidationState bg_state;
4488 if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
4489 LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__, bg_state.ToString());
4490 return false;
4491 }
4492
4493 return true;
4494}
4495
4497{
4499 Chainstate& active_chainstate = ActiveChainstate();
4500 if (!active_chainstate.GetMempool()) {
4501 TxValidationState state;
4502 state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
4503 return MempoolAcceptResult::Failure(state);
4504 }
4505 auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(), /*bypass_limits=*/ false, test_accept);
4506 active_chainstate.GetMempool()->check(active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
4507 return result;
4508}
4509
4510
4512 Chainstate& chainstate,
4513 const CBlock& block,
4514 const bool check_pow,
4515 const bool check_merkle_root)
4516{
4517 // Lock must be held throughout this function for two reasons:
4518 // 1. We don't want the tip to change during several of the validation steps
4519 // 2. To prevent a CheckBlock() race condition for fChecked, see ProcessNewBlock()
4520 AssertLockHeld(chainstate.m_chainman.GetMutex());
4521
4523 CBlockIndex* tip{Assert(chainstate.m_chain.Tip())};
4524
4525 if (block.hashPrevBlock != *Assert(tip->phashBlock)) {
4526 state.Invalid({}, "inconclusive-not-best-prevblk");
4527 return state;
4528 }
4529
4530 // For signets CheckBlock() verifies the challenge iff fCheckPow is set.
4531 if (!CheckBlock(block, state, chainstate.m_chainman.GetConsensus(), /*fCheckPow=*/check_pow, /*fCheckMerkleRoot=*/check_merkle_root)) {
4532 // This should never happen, but belt-and-suspenders don't approve the
4533 // block if it does.
4534 if (state.IsValid()) NONFATAL_UNREACHABLE();
4535 return state;
4536 }
4537
4552
4553 if (!ContextualCheckBlockHeader(block, state, chainstate.m_blockman, chainstate.m_chainman, tip)) {
4554 if (state.IsValid()) NONFATAL_UNREACHABLE();
4555 return state;
4556 }
4557
4558 if (!ContextualCheckBlock(block, state, chainstate.m_chainman, tip)) {
4559 if (state.IsValid()) NONFATAL_UNREACHABLE();
4560 return state;
4561 }
4562
4563 // We don't want ConnectBlock to update the actual chainstate, so create
4564 // a cache on top of it, along with a dummy block index.
4565 CBlockIndex index_dummy{block};
4566 uint256 block_hash(block.GetHash());
4567 index_dummy.pprev = tip;
4568 index_dummy.nHeight = tip->nHeight + 1;
4569 index_dummy.phashBlock = &block_hash;
4570 CCoinsViewCache view_dummy(&chainstate.CoinsTip());
4571
4572 // Set fJustCheck to true in order to update, and not clear, validation caches.
4573 if(!chainstate.ConnectBlock(block, state, &index_dummy, view_dummy, /*fJustCheck=*/true)) {
4574 if (state.IsValid()) NONFATAL_UNREACHABLE();
4575 return state;
4576 }
4577
4578 // Ensure no check returned successfully while also setting an invalid state.
4579 if (!state.IsValid()) NONFATAL_UNREACHABLE();
4580
4581 return state;
4582}
4583
4584/* This function is called from the RPC code for pruneblockchain */
4585void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight)
4586{
4588 if (!active_chainstate.FlushStateToDisk(
4589 state, FlushStateMode::NONE, nManualPruneHeight)) {
4590 LogWarning("Failed to flush state after manual prune (%s)", state.ToString());
4591 }
4592}
4593
4595{
4597 const CCoinsViewCache& coins_cache = CoinsTip();
4598 assert(!coins_cache.GetBestBlock().IsNull()); // Never called when the coins view is empty
4599 CBlockIndex* tip = m_chain.Tip();
4600
4601 if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
4602 return true;
4603 }
4604
4605 // Load pointer to end of best chain
4606 CBlockIndex* pindex = m_blockman.LookupBlockIndex(coins_cache.GetBestBlock());
4607 if (!pindex) {
4608 return false;
4609 }
4610 m_chain.SetTip(*pindex);
4611 m_chainman.UpdateIBDStatus();
4612 tip = m_chain.Tip();
4613
4614 // nSequenceId is one of the keys used to sort setBlockIndexCandidates. Ensure all
4615 // candidate sets are empty to avoid UB, as nSequenceId is about to be modified.
4616 for (const auto& cs : m_chainman.m_chainstates) {
4617 assert(cs->setBlockIndexCandidates.empty());
4618 }
4619
4620 // Make sure our chain tip before shutting down scores better than any other candidate
4621 // to maintain a consistent best tip over reboots in case of a tie.
4622 auto target = tip;
4623 while (target) {
4624 target->nSequenceId = SEQ_ID_BEST_CHAIN_FROM_DISK;
4625 target = target->pprev;
4626 }
4627
4628 LogInfo("Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f",
4629 tip->GetBlockHash().ToString(),
4630 m_chain.Height(),
4632 m_chainman.GuessVerificationProgress(tip));
4633
4634 // Ensure KernelNotifications m_tip_block is set even if no new block arrives.
4635 if (!this->GetRole().historical) {
4636 // Ignoring return value for now.
4637 (void)m_chainman.GetNotifications().blockTip(
4638 /*state=*/GetSynchronizationState(/*init=*/true, m_chainman.m_blockman.m_blockfiles_indexed),
4639 /*index=*/*pindex,
4640 /*verification_progress=*/m_chainman.GuessVerificationProgress(tip));
4641 }
4642
4644
4645 return true;
4646}
4647
4649 : m_notifications{notifications}
4650{
4651 m_notifications.progress(_("Verifying blocks…"), 0, false);
4652}
4653
4655{
4656 m_notifications.progress(bilingual_str{}, 100, false);
4657}
4658
4660 Chainstate& chainstate,
4661 const Consensus::Params& consensus_params,
4662 CCoinsView& coinsview,
4663 int nCheckLevel, int nCheckDepth)
4664{
4666
4667 if (chainstate.m_chain.Tip() == nullptr || chainstate.m_chain.Tip()->pprev == nullptr) {
4669 }
4670
4671 // Verify blocks in the best chain
4672 if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
4673 nCheckDepth = chainstate.m_chain.Height();
4674 }
4675 nCheckLevel = std::max(0, std::min(4, nCheckLevel));
4676 LogInfo("Verifying last %i blocks at level %i", nCheckDepth, nCheckLevel);
4677 CCoinsViewCache coins(&coinsview);
4678 CBlockIndex* pindex;
4679 CBlockIndex* pindexFailure = nullptr;
4680 int nGoodTransactions = 0;
4682 int reportDone = 0;
4683 bool skipped_no_block_data{false};
4684 bool skipped_l3_checks{false};
4685 LogInfo("Verification progress: 0%%");
4686
4687 const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
4688
4689 for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev; pindex = pindex->pprev) {
4690 const int percentageDone = std::max(1, std::min(99, (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * (nCheckLevel >= 4 ? 50 : 100))));
4691 if (reportDone < percentageDone / 10) {
4692 // report every 10% step
4693 LogInfo("Verification progress: %d%%", percentageDone);
4694 reportDone = percentageDone / 10;
4695 }
4696 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4697 if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
4698 break;
4699 }
4700 if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
4701 // If pruning or running under an assumeutxo snapshot, only go
4702 // back as far as we have data.
4703 LogInfo("Block verification stopping at height %d (no data). This could be due to pruning or use of an assumeutxo snapshot.", pindex->nHeight);
4704 skipped_no_block_data = true;
4705 break;
4706 }
4707 CBlock block;
4708 // check level 0: read from disk
4709 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4710 LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4712 }
4713 // check level 1: verify block validity
4714 if (nCheckLevel >= 1 && !CheckBlock(block, state, consensus_params)) {
4715 LogError("Verification error: found bad block at %d, hash=%s (%s)",
4716 pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4718 }
4719 // check level 2: verify undo validity
4720 if (nCheckLevel >= 2 && pindex) {
4721 CBlockUndo undo;
4722 if (!pindex->GetUndoPos().IsNull()) {
4723 if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
4724 LogError("Verification error: found bad undo data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4726 }
4727 }
4728 }
4729 // check level 3: check for inconsistencies during memory-only disconnect of tip blocks
4730 size_t curr_coins_usage = coins.DynamicMemoryUsage() + chainstate.CoinsTip().DynamicMemoryUsage();
4731
4732 if (nCheckLevel >= 3) {
4733 if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
4734 assert(coins.GetBestBlock() == pindex->GetBlockHash());
4735 DisconnectResult res = chainstate.DisconnectBlock(block, pindex, coins);
4736 if (res == DISCONNECT_FAILED) {
4737 LogError("Verification error: irrecoverable inconsistency in block data at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4739 }
4740 if (res == DISCONNECT_UNCLEAN) {
4741 nGoodTransactions = 0;
4742 pindexFailure = pindex;
4743 } else {
4744 nGoodTransactions += block.vtx.size();
4745 }
4746 } else {
4747 skipped_l3_checks = true;
4748 }
4749 }
4750 if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4751 }
4752 if (pindexFailure) {
4753 LogError("Verification error: coin database inconsistencies found (last %i blocks, %i good transactions before that)", chainstate.m_chain.Height() - pindexFailure->nHeight + 1, nGoodTransactions);
4755 }
4756 if (skipped_l3_checks) {
4757 LogWarning("Skipped verification of level >=3 (insufficient database cache size). Consider increasing -dbcache.");
4758 }
4759
4760 // store block count as we move pindex at check level >= 4
4761 int block_count = chainstate.m_chain.Height() - pindex->nHeight;
4762
4763 // check level 4: try reconnecting blocks
4764 if (nCheckLevel >= 4 && !skipped_l3_checks) {
4765 while (pindex != chainstate.m_chain.Tip()) {
4766 const int percentageDone = std::max(1, std::min(99, 100 - (int)(((double)(chainstate.m_chain.Height() - pindex->nHeight)) / (double)nCheckDepth * 50)));
4767 if (reportDone < percentageDone / 10) {
4768 // report every 10% step
4769 LogInfo("Verification progress: %d%%", percentageDone);
4770 reportDone = percentageDone / 10;
4771 }
4772 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
4773 pindex = chainstate.m_chain.Next(pindex);
4774 CBlock block;
4775 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
4776 LogError("Verification error: ReadBlock failed at %d, hash=%s", pindex->nHeight, pindex->GetBlockHash().ToString());
4778 }
4779 if (!chainstate.ConnectBlock(block, state, pindex, coins)) {
4780 LogError("Verification error: found unconnectable block at %d, hash=%s (%s)", pindex->nHeight, pindex->GetBlockHash().ToString(), state.ToString());
4782 }
4783 if (chainstate.m_chainman.m_interrupt) return VerifyDBResult::INTERRUPTED;
4784 }
4785 }
4786
4787 LogInfo("Verification: No coin database inconsistencies in last %i blocks (%i transactions)", block_count, nGoodTransactions);
4788
4789 if (skipped_l3_checks) {
4791 }
4792 if (skipped_no_block_data) {
4794 }
4796}
4797
4800{
4802 // TODO: merge with ConnectBlock
4803 CBlock block;
4804 if (!m_blockman.ReadBlock(block, *pindex)) {
4805 LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n", pindex->nHeight, pindex->GetBlockHash().ToString());
4806 return false;
4807 }
4808
4809 for (const CTransactionRef& tx : block.vtx) {
4810 if (!tx->IsCoinBase()) {
4811 for (const CTxIn &txin : tx->vin) {
4812 inputs.SpendCoin(txin.prevout);
4813 }
4814 }
4815 // Pass check = true as every addition may be an overwrite.
4816 AddCoins(inputs, *tx, pindex->nHeight, true);
4817 }
4818 return true;
4819}
4820
4822{
4823 LOCK(cs_main);
4824
4825 CCoinsView& db = this->CoinsDB();
4826 CCoinsViewCache cache(&db);
4827
4828 std::vector<uint256> hashHeads = db.GetHeadBlocks();
4829 if (hashHeads.empty()) return true; // We're already in a consistent state.
4830 if (hashHeads.size() != 2) {
4831 LogError("ReplayBlocks(): unknown inconsistent state\n");
4832 return false;
4833 }
4834
4835 m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
4836 LogInfo("Replaying blocks");
4837
4838 const CBlockIndex* pindexOld = nullptr; // Old tip during the interrupted flush.
4839 const CBlockIndex* pindexNew; // New tip during the interrupted flush.
4840 const CBlockIndex* pindexFork = nullptr; // Latest block common to both the old and the new tip.
4841
4842 if (!m_blockman.m_block_index.contains(hashHeads[0])) {
4843 LogError("ReplayBlocks(): reorganization to unknown block requested\n");
4844 return false;
4845 }
4846 pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
4847
4848 if (!hashHeads[1].IsNull()) { // The old tip is allowed to be 0, indicating it's the first flush.
4849 if (!m_blockman.m_block_index.contains(hashHeads[1])) {
4850 LogError("ReplayBlocks(): reorganization from unknown block requested\n");
4851 return false;
4852 }
4853 pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
4854 pindexFork = LastCommonAncestor(pindexOld, pindexNew);
4855 assert(pindexFork != nullptr);
4856 }
4857
4858 // Rollback along the old branch.
4859 const int nForkHeight{pindexFork ? pindexFork->nHeight : 0};
4860 if (pindexOld != pindexFork) {
4861 LogInfo("Rolling back from %s (%i to %i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight, nForkHeight);
4862 while (pindexOld != pindexFork) {
4863 if (pindexOld->nHeight > 0) { // Never disconnect the genesis block.
4864 CBlock block;
4865 if (!m_blockman.ReadBlock(block, *pindexOld)) {
4866 LogError("RollbackBlock(): ReadBlock() failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4867 return false;
4868 }
4869 if (pindexOld->nHeight % 10'000 == 0) {
4870 LogInfo("Rolling back %s (%i)", pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
4871 }
4872 DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
4873 if (res == DISCONNECT_FAILED) {
4874 LogError("RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n", pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
4875 return false;
4876 }
4877 // If DISCONNECT_UNCLEAN is returned, it means a non-existing UTXO was deleted, or an existing UTXO was
4878 // overwritten. It corresponds to cases where the block-to-be-disconnect never had all its operations
4879 // applied to the UTXO set. However, as both writing a UTXO and deleting a UTXO are idempotent operations,
4880 // the result is still a version of the UTXO set with the effects of that block undone.
4881 }
4882 pindexOld = pindexOld->pprev;
4883 }
4884 LogInfo("Rolled back to %s", pindexFork->GetBlockHash().ToString());
4885 }
4886
4887 // Roll forward from the forking point to the new tip.
4888 if (nForkHeight < pindexNew->nHeight) {
4889 LogInfo("Rolling forward to %s (%i to %i)", pindexNew->GetBlockHash().ToString(), nForkHeight, pindexNew->nHeight);
4890 for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight; ++nHeight) {
4891 const CBlockIndex& pindex{*Assert(pindexNew->GetAncestor(nHeight))};
4892
4893 if (nHeight % 10'000 == 0) {
4894 LogInfo("Rolling forward %s (%i)", pindex.GetBlockHash().ToString(), nHeight);
4895 }
4896 m_chainman.GetNotifications().progress(_("Replaying blocks…"), (int)((nHeight - nForkHeight) * 100.0 / (pindexNew->nHeight - nForkHeight)), false);
4897 if (!RollforwardBlock(&pindex, cache)) return false;
4898 }
4899 LogInfo("Rolled forward to %s", pindexNew->GetBlockHash().ToString());
4900 }
4901
4902 cache.SetBestBlock(pindexNew->GetBlockHash());
4903 cache.Flush(/*reallocate_cache=*/false); // local CCoinsViewCache goes out of scope
4904 m_chainman.GetNotifications().progress(bilingual_str{}, 100, false);
4905 return true;
4906}
4907
4909{
4911
4912 // At and above m_params.SegwitHeight, segwit consensus rules must be validated
4913 CBlockIndex* block{m_chain.Tip()};
4914
4915 while (block != nullptr && DeploymentActiveAt(*block, m_chainman, Consensus::DEPLOYMENT_SEGWIT)) {
4916 if (!(block->nStatus & BLOCK_OPT_WITNESS)) {
4917 // block is insufficiently validated for a segwit client
4918 return true;
4919 }
4920 block = block->pprev;
4921 }
4922
4923 return false;
4924}
4925
4926void Chainstate::ClearBlockIndexCandidates()
4927{
4930}
4931
4932void Chainstate::PopulateBlockIndexCandidates()
4933{
4935
4936 for (CBlockIndex* pindex : m_blockman.GetAllBlockIndices()) {
4937 // With assumeutxo, the snapshot block is a candidate for the tip, but it
4938 // may not have BLOCK_VALID_TRANSACTIONS (e.g. if we haven't yet downloaded
4939 // the block), so we special-case it here.
4940 if (pindex == SnapshotBase() || pindex == TargetBlock() ||
4942 (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
4944 }
4945 }
4946}
4947
4949{
4951 // Load block index from databases
4952 if (m_blockman.m_blockfiles_indexed) {
4953 bool ret{m_blockman.LoadBlockIndexDB(CurrentChainstate().m_from_snapshot_blockhash)};
4954 if (!ret) return false;
4955
4956 m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
4957
4958 std::vector<CBlockIndex*> vSortedByHeight{m_blockman.GetAllBlockIndices()};
4959 std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
4961
4962 for (CBlockIndex* pindex : vSortedByHeight) {
4963 if (m_interrupt) return false;
4964 if (pindex->nStatus & BLOCK_FAILED_VALID && (!m_best_invalid || pindex->nChainWork > m_best_invalid->nChainWork)) {
4965 m_best_invalid = pindex;
4966 }
4967 if (pindex->IsValid(BLOCK_VALID_TREE) && (m_best_header == nullptr || CBlockIndexWorkComparator()(m_best_header, pindex)))
4968 m_best_header = pindex;
4969 }
4970 }
4971 return true;
4972}
4973
4975{
4976 LOCK(cs_main);
4977
4978 const CChainParams& params{m_chainman.GetParams()};
4979
4980 // Check whether we're already initialized by checking for genesis in
4981 // m_blockman.m_block_index. Note that we can't use m_chain here, since it is
4982 // set based on the coins db, not the block index db, which is the only
4983 // thing loaded at this point.
4984 if (m_blockman.m_block_index.contains(params.GenesisBlock().GetHash()))
4985 return true;
4986
4987 try {
4988 const CBlock& block = params.GenesisBlock();
4989 FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
4990 if (blockPos.IsNull()) {
4991 LogError("%s: writing genesis block to disk failed\n", __func__);
4992 return false;
4993 }
4994 CBlockIndex* pindex = m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
4995 m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
4996 } catch (const std::runtime_error& e) {
4997 LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
4998 return false;
4999 }
5000
5001 return true;
5002}
5003
5005 AutoFile& file_in,
5006 FlatFilePos* dbp,
5007 std::multimap<uint256, FlatFilePos>* blocks_with_unknown_parent)
5008{
5009 // Either both should be specified (-reindex), or neither (-loadblock).
5010 assert(!dbp == !blocks_with_unknown_parent);
5011
5012 const auto start{SteadyClock::now()};
5013 const CChainParams& params{GetParams()};
5014
5015 int nLoaded = 0;
5016 try {
5018 // nRewind indicates where to resume scanning in case something goes wrong,
5019 // such as a block fails to deserialize.
5020 uint64_t nRewind = blkdat.GetPos();
5021 while (!blkdat.eof()) {
5022 if (m_interrupt) return;
5023
5024 blkdat.SetPos(nRewind);
5025 nRewind++; // start one byte further next time, in case of failure
5026 blkdat.SetLimit(); // remove former limit
5027 unsigned int nSize = 0;
5028 try {
5029 // locate a header
5031 blkdat.FindByte(std::byte(params.MessageStart()[0]));
5032 nRewind = blkdat.GetPos() + 1;
5033 blkdat >> buf;
5034 if (buf != params.MessageStart()) {
5035 continue;
5036 }
5037 // read size
5038 blkdat >> nSize;
5039 if (nSize < 80 || nSize > MAX_BLOCK_SERIALIZED_SIZE)
5040 continue;
5041 } catch (const std::exception&) {
5042 // no valid block header found; don't complain
5043 // (this happens at the end of every blk.dat file)
5044 break;
5045 }
5046 try {
5047 // read block header
5048 const uint64_t nBlockPos{blkdat.GetPos()};
5049 if (dbp)
5050 dbp->nPos = nBlockPos;
5051 blkdat.SetLimit(nBlockPos + nSize);
5052 CBlockHeader header;
5053 blkdat >> header;
5054 const uint256 hash{header.GetHash()};
5055 // Skip the rest of this block (this may read from disk into memory); position to the marker before the
5056 // next block, but it's still possible to rewind to the start of the current block (without a disk read).
5057 nRewind = nBlockPos + nSize;
5058 blkdat.SkipTo(nRewind);
5059
5060 std::shared_ptr<CBlock> pblock{}; // needs to remain available after the cs_main lock is released to avoid duplicate reads from disk
5061
5062 {
5063 LOCK(cs_main);
5064 // detect out of order blocks, and store them for later
5065 if (hash != params.GetConsensus().hashGenesisBlock && !m_blockman.LookupBlockIndex(header.hashPrevBlock)) {
5066 LogDebug(BCLog::REINDEX, "%s: Out of order block %s, parent %s not known\n", __func__, hash.ToString(),
5067 header.hashPrevBlock.ToString());
5068 if (dbp && blocks_with_unknown_parent) {
5069 blocks_with_unknown_parent->emplace(header.hashPrevBlock, *dbp);
5070 }
5071 continue;
5072 }
5073
5074 // process in case the block isn't known yet
5075 const CBlockIndex* pindex = m_blockman.LookupBlockIndex(hash);
5076 if (!pindex || (pindex->nStatus & BLOCK_HAVE_DATA) == 0) {
5077 // This block can be processed immediately; rewind to its start, read and deserialize it.
5078 blkdat.SetPos(nBlockPos);
5079 pblock = std::make_shared<CBlock>();
5080 blkdat >> TX_WITH_WITNESS(*pblock);
5081 nRewind = blkdat.GetPos();
5082
5084 if (AcceptBlock(pblock, state, nullptr, true, dbp, nullptr, true)) {
5085 nLoaded++;
5086 }
5087 if (state.IsError()) {
5088 break;
5089 }
5090 } else if (hash != params.GetConsensus().hashGenesisBlock && pindex->nHeight % 1000 == 0) {
5091 LogDebug(BCLog::REINDEX, "Block Import: already had block %s at height %d\n", hash.ToString(), pindex->nHeight);
5092 }
5093 }
5094
5095 // Activate the genesis block so normal node progress can continue
5096 // During first -reindex, this will only connect Genesis since
5097 // ActivateBestChain only connects blocks which are in the block tree db,
5098 // which only contains blocks whose parents are in it.
5099 // But do this only if genesis isn't activated yet, to avoid connecting many blocks
5100 // without assumevalid in the case of a continuation of a reindex that
5101 // was interrupted by the user.
5102 if (hash == params.GetConsensus().hashGenesisBlock && WITH_LOCK(::cs_main, return ActiveHeight()) == -1) {
5104 if (!ActiveChainstate().ActivateBestChain(state, nullptr)) {
5105 break;
5106 }
5107 }
5108
5109 if (m_blockman.IsPruneMode() && m_blockman.m_blockfiles_indexed && pblock) {
5110 // must update the tip for pruning to work while importing with -loadblock.
5111 // this is a tradeoff to conserve disk space at the expense of time
5112 // spent updating the tip to be able to prune.
5113 // otherwise, ActivateBestChain won't be called by the import process
5114 // until after all of the block files are loaded. ActivateBestChain can be
5115 // called by concurrent network message processing. but, that is not
5116 // reliable for the purpose of pruning while importing.
5117 if (auto result{ActivateBestChains()}; !result) {
5118 LogDebug(BCLog::REINDEX, "%s\n", util::ErrorString(result).original);
5119 break;
5120 }
5121 }
5122
5124
5125 if (!blocks_with_unknown_parent) continue;
5126
5127 // Recursively process earlier encountered successors of this block
5128 std::deque<uint256> queue;
5129 queue.push_back(hash);
5130 while (!queue.empty()) {
5131 uint256 head = queue.front();
5132 queue.pop_front();
5133 auto range = blocks_with_unknown_parent->equal_range(head);
5134 while (range.first != range.second) {
5135 std::multimap<uint256, FlatFilePos>::iterator it = range.first;
5136 std::shared_ptr<CBlock> pblockrecursive = std::make_shared<CBlock>();
5137 if (m_blockman.ReadBlock(*pblockrecursive, it->second, {})) {
5138 const auto& block_hash{pblockrecursive->GetHash()};
5139 LogDebug(BCLog::REINDEX, "%s: Processing out of order child %s of %s", __func__, block_hash.ToString(), head.ToString());
5140 LOCK(cs_main);
5142 if (AcceptBlock(pblockrecursive, dummy, nullptr, true, &it->second, nullptr, true)) {
5143 nLoaded++;
5144 queue.push_back(block_hash);
5145 }
5146 }
5147 range.first++;
5148 blocks_with_unknown_parent->erase(it);
5150 }
5151 }
5152 } catch (const std::exception& e) {
5153 // historical bugs added extra data to the block files that does not deserialize cleanly.
5154 // commonly this data is between readable blocks, but it does not really matter. such data is not fatal to the import process.
5155 // the code that reads the block files deals with invalid data by simply ignoring it.
5156 // it continues to search for the next {4 byte magic message start bytes + 4 byte length + block} that does deserialize cleanly
5157 // and passes all of the other block validation checks dealing with POW and the merkle root, etc...
5158 // we merely note with this informational log message when unexpected data is encountered.
5159 // we could also be experiencing a storage system read error, or a read of a previous bad write. these are possible, but
5160 // less likely scenarios. we don't have enough information to tell a difference here.
5161 // the reindex process is not the place to attempt to clean and/or compact the block files. if so desired, a studious node operator
5162 // may use knowledge of the fact that the block files are not entirely pristine in order to prepare a set of pristine, and
5163 // perhaps ordered, block files for later reindexing.
5164 LogDebug(BCLog::REINDEX, "%s: unexpected data at file offset 0x%x - %s. continuing\n", __func__, (nRewind - 1), e.what());
5165 }
5166 }
5167 } catch (const std::runtime_error& e) {
5168 GetNotifications().fatalError(strprintf(_("System error while loading external block file: %s"), e.what()));
5169 }
5170 LogInfo("Loaded %i blocks from external file in %dms", nLoaded, Ticks<std::chrono::milliseconds>(SteadyClock::now() - start));
5171}
5172
5174{
5175 // Assert to verify Flatten() has been called.
5176 if (!*Assert(m_options.check_block_index)) return false;
5177 if (FastRandomContext().randrange(*m_options.check_block_index) >= 1) return false;
5178 return true;
5179}
5180
5182{
5183 if (!ShouldCheckBlockIndex()) {
5184 return;
5185 }
5186
5187 LOCK(cs_main);
5188
5189 // During a reindex, we read the genesis block and call CheckBlockIndex before ActivateBestChain,
5190 // so we have the genesis block in m_blockman.m_block_index but no active chain. (A few of the
5191 // tests when iterating the block tree require that m_chain has been initialized.)
5192 if (ActiveChain().Height() < 0) {
5193 assert(m_blockman.m_block_index.size() <= 1);
5194 return;
5195 }
5196
5197 // Build forward-pointing data structure for the entire block tree.
5198 // For performance reasons, indexes of the best header chain are stored in a vector (within CChain).
5199 // All remaining blocks are stored in a multimap.
5200 // The best header chain can differ from the active chain: E.g. its entries may belong to blocks that
5201 // are not yet validated.
5202 CChain best_hdr_chain;
5203 assert(m_best_header);
5204 assert(!(m_best_header->nStatus & BLOCK_FAILED_VALID));
5205 best_hdr_chain.SetTip(*m_best_header);
5206
5207 std::multimap<const CBlockIndex*, const CBlockIndex*> forward;
5208 for (auto& [_, block_index] : m_blockman.m_block_index) {
5209 // Only save indexes in forward that are not part of the best header chain.
5210 if (!best_hdr_chain.Contains(&block_index)) {
5211 // Only genesis, which must be part of the best header chain, can have a nullptr parent.
5212 assert(block_index.pprev);
5213 forward.emplace(block_index.pprev, &block_index);
5214 }
5215 }
5216 assert(forward.size() + best_hdr_chain.Height() + 1 == m_blockman.m_block_index.size());
5217
5218 const CBlockIndex* pindex = best_hdr_chain[0];
5219 assert(pindex);
5220 // Iterate over the entire block tree, using depth-first search.
5221 // Along the way, remember whether there are blocks on the path from genesis
5222 // block being explored which are the first to have certain properties.
5223 size_t nNodes = 0;
5224 int nHeight = 0;
5225 const CBlockIndex* pindexFirstInvalid = nullptr; // Oldest ancestor of pindex which is invalid.
5226 const CBlockIndex* pindexFirstMissing = nullptr; // Oldest ancestor of pindex which does not have BLOCK_HAVE_DATA, since assumeutxo snapshot if used.
5227 const CBlockIndex* pindexFirstNeverProcessed = nullptr; // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot if used.
5228 const CBlockIndex* pindexFirstNotTreeValid = nullptr; // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE (regardless of being valid or not).
5229 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.
5230 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.
5231 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.
5232
5233 // After checking an assumeutxo snapshot block, reset pindexFirst pointers
5234 // to earlier blocks that have not been downloaded or validated yet, so
5235 // checks for later blocks can assume the earlier blocks were validated and
5236 // be stricter, testing for more requirements.
5237 const CBlockIndex* snap_base{CurrentChainstate().SnapshotBase()};
5238 const CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{}, *snap_first_nocv{}, *snap_first_nosv{};
5239 auto snap_update_firsts = [&] {
5240 if (pindex == snap_base) {
5241 std::swap(snap_first_missing, pindexFirstMissing);
5242 std::swap(snap_first_notx, pindexFirstNeverProcessed);
5243 std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
5244 std::swap(snap_first_nocv, pindexFirstNotChainValid);
5245 std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
5246 }
5247 };
5248
5249 while (pindex != nullptr) {
5250 nNodes++;
5251 if (pindexFirstInvalid == nullptr && pindex->nStatus & BLOCK_FAILED_VALID) pindexFirstInvalid = pindex;
5252 if (pindexFirstMissing == nullptr && !(pindex->nStatus & BLOCK_HAVE_DATA)) {
5253 pindexFirstMissing = pindex;
5254 }
5255 if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) pindexFirstNeverProcessed = pindex;
5256 if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr && (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TREE) pindexFirstNotTreeValid = pindex;
5257
5258 if (pindex->pprev != nullptr) {
5259 if (pindexFirstNotTransactionsValid == nullptr &&
5260 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_TRANSACTIONS) {
5261 pindexFirstNotTransactionsValid = pindex;
5262 }
5263
5264 if (pindexFirstNotChainValid == nullptr &&
5265 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_CHAIN) {
5266 pindexFirstNotChainValid = pindex;
5267 }
5268
5269 if (pindexFirstNotScriptsValid == nullptr &&
5270 (pindex->nStatus & BLOCK_VALID_MASK) < BLOCK_VALID_SCRIPTS) {
5271 pindexFirstNotScriptsValid = pindex;
5272 }
5273 }
5274
5275 // Begin: actual consistency checks.
5276 if (pindex->pprev == nullptr) {
5277 // Genesis block checks.
5278 assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock); // Genesis block's hash must match.
5279 for (const auto& c : m_chainstates) {
5280 if (c->m_chain.Genesis() != nullptr) {
5281 assert(pindex == c->m_chain.Genesis()); // The chain's genesis block must be this block.
5282 }
5283 }
5284 }
5285 // nSequenceId can't be set higher than SEQ_ID_INIT_FROM_DISK{1} for blocks that aren't linked
5286 // (negative is used for preciousblock, SEQ_ID_BEST_CHAIN_FROM_DISK{0} for active chain when loaded from disk)
5287 if (!pindex->HaveNumChainTxs()) assert(pindex->nSequenceId <= SEQ_ID_INIT_FROM_DISK);
5288 // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or not pruning has occurred).
5289 // HAVE_DATA is only equivalent to nTx > 0 (or VALID_TRANSACTIONS) if no pruning has occurred.
5290 if (!m_blockman.m_have_pruned) {
5291 // If we've never pruned, then HAVE_DATA should be equivalent to nTx > 0
5292 assert(!(pindex->nStatus & BLOCK_HAVE_DATA) == (pindex->nTx == 0));
5293 assert(pindexFirstMissing == pindexFirstNeverProcessed);
5294 } else {
5295 // If we have pruned, then we can only say that HAVE_DATA implies nTx > 0
5296 if (pindex->nStatus & BLOCK_HAVE_DATA) assert(pindex->nTx > 0);
5297 }
5298 if (pindex->nStatus & BLOCK_HAVE_UNDO) assert(pindex->nStatus & BLOCK_HAVE_DATA);
5299 if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
5300 // Assumed-valid blocks should connect to the main chain.
5301 assert((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE);
5302 }
5303 // There should only be an nTx value if we have
5304 // actually seen a block's transactions.
5305 assert(((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TRANSACTIONS) == (pindex->nTx > 0)); // This is pruning-independent.
5306 // All parents having had data (at some point) is equivalent to all parents being VALID_TRANSACTIONS, which is equivalent to HaveNumChainTxs().
5307 // HaveNumChainTxs will also be set in the assumeutxo snapshot block from snapshot metadata.
5308 assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5309 assert((pindexFirstNotTransactionsValid == nullptr || pindex == snap_base) == pindex->HaveNumChainTxs());
5310 assert(pindex->nHeight == nHeight); // nHeight must be consistent.
5311 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.
5312 assert(nHeight < 2 || (pindex->pskip && (pindex->pskip->nHeight < nHeight))); // The pskip pointer must point back for all but the first 2 blocks.
5313 assert(pindexFirstNotTreeValid == nullptr); // All m_blockman.m_block_index entries must at least be TREE valid
5314 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_TREE) assert(pindexFirstNotTreeValid == nullptr); // TREE valid implies all parents are TREE valid
5315 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_CHAIN) assert(pindexFirstNotChainValid == nullptr); // CHAIN valid implies all parents are CHAIN valid
5316 if ((pindex->nStatus & BLOCK_VALID_MASK) >= BLOCK_VALID_SCRIPTS) assert(pindexFirstNotScriptsValid == nullptr); // SCRIPTS valid implies all parents are SCRIPTS valid
5317 if (pindexFirstInvalid == nullptr) {
5318 // Checks for not-invalid blocks.
5319 assert((pindex->nStatus & BLOCK_FAILED_VALID) == 0); // The failed flag cannot be set for blocks without invalid parents.
5320 } else {
5321 assert(pindex->nStatus & BLOCK_FAILED_VALID); // Invalid blocks and their descendants must be marked as invalid
5322 }
5323 // Make sure m_chain_tx_count sum is correctly computed.
5324 if (!pindex->pprev) {
5325 // If no previous block, nTx and m_chain_tx_count must be the same.
5326 assert(pindex->m_chain_tx_count == pindex->nTx);
5327 } else if (pindex->pprev->m_chain_tx_count > 0 && pindex->nTx > 0) {
5328 // If previous m_chain_tx_count is set and number of transactions in block is known, sum must be set.
5329 assert(pindex->m_chain_tx_count == pindex->nTx + pindex->pprev->m_chain_tx_count);
5330 } else {
5331 // Otherwise m_chain_tx_count should only be set if this is a snapshot
5332 // block, and must be set if it is.
5333 assert((pindex->m_chain_tx_count != 0) == (pindex == snap_base));
5334 }
5335 // There should be no block with more work than m_best_header, unless it's known to be invalid
5336 assert((pindex->nStatus & BLOCK_FAILED_VALID) || pindex->nChainWork <= m_best_header->nChainWork);
5337
5338 // Chainstate-specific checks on setBlockIndexCandidates
5339 for (const auto& c : m_chainstates) {
5340 if (c->m_chain.Tip() == nullptr) continue;
5341 // Two main factors determine whether pindex is a candidate in
5342 // setBlockIndexCandidates:
5343 //
5344 // - If pindex has less work than the chain tip, it should not be a
5345 // candidate, and this will be asserted below. Otherwise it is a
5346 // potential candidate.
5347 //
5348 // - If pindex or one of its parent blocks back to the genesis block
5349 // or an assumeutxo snapshot never downloaded transactions
5350 // (pindexFirstNeverProcessed is non-null), it should not be a
5351 // candidate, and this will be asserted below. The only exception
5352 // is if pindex itself is an assumeutxo snapshot block. Then it is
5353 // also a potential candidate.
5354 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
5355 // If pindex was detected as invalid (pindexFirstInvalid is
5356 // non-null), it is not required to be in
5357 // setBlockIndexCandidates.
5358 if (pindexFirstInvalid == nullptr) {
5359 // If pindex and all its parents back to the genesis block
5360 // or an assumeutxo snapshot block downloaded transactions,
5361 // and the transactions were not pruned (pindexFirstMissing
5362 // is null), it is a potential candidate. The check
5363 // excludes pruned blocks, because if any blocks were
5364 // pruned between pindex and the current chain tip, pindex will
5365 // only temporarily be added to setBlockIndexCandidates,
5366 // before being moved to m_blocks_unlinked. This check
5367 // could be improved to verify that if all blocks between
5368 // the chain tip and pindex have data, pindex must be a
5369 // candidate.
5370 //
5371 // If pindex is the chain tip, it also is a potential
5372 // candidate.
5373 //
5374 // If the chainstate was loaded from a snapshot and pindex
5375 // is the base of the snapshot, pindex is also a potential
5376 // candidate.
5377 if (pindexFirstMissing == nullptr || pindex == c->m_chain.Tip() || pindex == c->SnapshotBase()) {
5378 // If this chainstate is not a historical chainstate
5379 // targeting a specific block, pindex must be in
5380 // setBlockIndexCandidates. Otherwise, pindex only
5381 // needs to be added if it is an ancestor of the target
5382 // block.
5383 if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
5384 assert(c->setBlockIndexCandidates.contains(pindex));
5385 }
5386 }
5387 // If some parent is missing, then it could be that this block was in
5388 // setBlockIndexCandidates but had to be removed because of the missing data.
5389 // In this case it must be in m_blocks_unlinked -- see test below.
5390 }
5391 } else { // If this block sorts worse than the current tip or some ancestor's block has never been seen, it cannot be in setBlockIndexCandidates.
5392 assert(!c->setBlockIndexCandidates.contains(pindex));
5393 }
5394 }
5395 // Check whether this block is in m_blocks_unlinked.
5396 auto rangeUnlinked{m_blockman.m_blocks_unlinked.equal_range(pindex->pprev)};
5397 bool foundInUnlinked = false;
5398 while (rangeUnlinked.first != rangeUnlinked.second) {
5399 assert(rangeUnlinked.first->first == pindex->pprev);
5400 if (rangeUnlinked.first->second == pindex) {
5401 foundInUnlinked = true;
5402 break;
5403 }
5404 rangeUnlinked.first++;
5405 }
5406 if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed != nullptr && pindexFirstInvalid == nullptr) {
5407 // If this block has block data available, some parent was never received, and has no invalid parents, it must be in m_blocks_unlinked.
5408 assert(foundInUnlinked);
5409 }
5410 if (!(pindex->nStatus & BLOCK_HAVE_DATA)) assert(!foundInUnlinked); // Can't be in m_blocks_unlinked if we don't HAVE_DATA
5411 if (pindexFirstMissing == nullptr) assert(!foundInUnlinked); // We aren't missing data for any parent -- cannot be in m_blocks_unlinked.
5412 if (pindex->pprev && (pindex->nStatus & BLOCK_HAVE_DATA) && pindexFirstNeverProcessed == nullptr && pindexFirstMissing != nullptr) {
5413 // We HAVE_DATA for this block, have received data for all parents at some point, but we're currently missing data for some parent.
5414 assert(m_blockman.m_have_pruned);
5415 // This block may have entered m_blocks_unlinked if:
5416 // - it has a descendant that at some point had more work than the
5417 // tip, and
5418 // - we tried switching to that descendant but were missing
5419 // data for some intermediate block between m_chain and the
5420 // tip.
5421 // So if this block is itself better than any m_chain.Tip() and it wasn't in
5422 // setBlockIndexCandidates, then it must be in m_blocks_unlinked.
5423 for (const auto& c : m_chainstates) {
5424 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) && !c->setBlockIndexCandidates.contains(pindex)) {
5425 if (pindexFirstInvalid == nullptr) {
5426 if (!c->TargetBlock() || c->TargetBlock()->GetAncestor(pindex->nHeight) == pindex) {
5427 assert(foundInUnlinked);
5428 }
5429 }
5430 }
5431 }
5432 }
5433 // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash()); // Perhaps too slow
5434 // End: actual consistency checks.
5435
5436
5437 // Try descending into the first subnode. Always process forks first and the best header chain after.
5438 snap_update_firsts();
5439 auto range{forward.equal_range(pindex)};
5440 if (range.first != range.second) {
5441 // A subnode not part of the best header chain was found.
5442 pindex = range.first->second;
5443 nHeight++;
5444 continue;
5445 } else if (best_hdr_chain.Contains(pindex)) {
5446 // Descend further into best header chain.
5447 nHeight++;
5448 pindex = best_hdr_chain[nHeight];
5449 if (!pindex) break; // we are finished, since the best header chain is always processed last
5450 continue;
5451 }
5452 // This is a leaf node.
5453 // Move upwards until we reach a node of which we have not yet visited the last child.
5454 while (pindex) {
5455 // We are going to either move to a parent or a sibling of pindex.
5456 snap_update_firsts();
5457 // If pindex was the first with a certain property, unset the corresponding variable.
5458 if (pindex == pindexFirstInvalid) pindexFirstInvalid = nullptr;
5459 if (pindex == pindexFirstMissing) pindexFirstMissing = nullptr;
5460 if (pindex == pindexFirstNeverProcessed) pindexFirstNeverProcessed = nullptr;
5461 if (pindex == pindexFirstNotTreeValid) pindexFirstNotTreeValid = nullptr;
5462 if (pindex == pindexFirstNotTransactionsValid) pindexFirstNotTransactionsValid = nullptr;
5463 if (pindex == pindexFirstNotChainValid) pindexFirstNotChainValid = nullptr;
5464 if (pindex == pindexFirstNotScriptsValid) pindexFirstNotScriptsValid = nullptr;
5465 // Find our parent.
5466 CBlockIndex* pindexPar = pindex->pprev;
5467 // Find which child we just visited.
5468 auto rangePar{forward.equal_range(pindexPar)};
5469 while (rangePar.first->second != pindex) {
5470 assert(rangePar.first != rangePar.second); // Our parent must have at least the node we're coming from as child.
5471 rangePar.first++;
5472 }
5473 // Proceed to the next one.
5474 rangePar.first++;
5475 if (rangePar.first != rangePar.second) {
5476 // Move to a sibling not part of the best header chain.
5477 pindex = rangePar.first->second;
5478 break;
5479 } else if (pindexPar == best_hdr_chain[nHeight - 1]) {
5480 // Move to pindex's sibling on the best-chain, if it has one.
5481 pindex = best_hdr_chain[nHeight];
5482 // There will not be a next block if (and only if) parent block is the best header.
5483 assert((pindex == nullptr) == (pindexPar == best_hdr_chain.Tip()));
5484 break;
5485 } else {
5486 // Move up further.
5487 pindex = pindexPar;
5488 nHeight--;
5489 continue;
5490 }
5491 }
5492 }
5493
5494 // Check that we actually traversed the entire block index.
5495 assert(nNodes == forward.size() + best_hdr_chain.Height() + 1);
5496}
5497
5498std::string Chainstate::ToString()
5499{
5501 CBlockIndex* tip = m_chain.Tip();
5502 return strprintf("Chainstate [%s] @ height %d (%s)",
5503 m_from_snapshot_blockhash ? "snapshot" : "ibd",
5504 tip ? tip->nHeight : -1, tip ? tip->GetBlockHash().ToString() : "null");
5505}
5506
5507bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size)
5508{
5510 if (coinstip_size == m_coinstip_cache_size_bytes &&
5511 coinsdb_size == m_coinsdb_cache_size_bytes) {
5512 // Cache sizes are unchanged, no need to continue.
5513 return true;
5514 }
5515 size_t old_coinstip_size = m_coinstip_cache_size_bytes;
5516 m_coinstip_cache_size_bytes = coinstip_size;
5517 m_coinsdb_cache_size_bytes = coinsdb_size;
5518 CoinsDB().ResizeCache(coinsdb_size);
5519
5520 LogInfo("[%s] resized coinsdb cache to %.1f MiB",
5521 this->ToString(), coinsdb_size * (1.0 / 1024 / 1024));
5522 LogInfo("[%s] resized coinstip cache to %.1f MiB",
5523 this->ToString(), coinstip_size * (1.0 / 1024 / 1024));
5524
5525 BlockValidationState state;
5526 bool ret;
5527
5528 if (coinstip_size > old_coinstip_size) {
5529 // Likely no need to flush if cache sizes have grown.
5531 } else {
5532 // Otherwise, flush state to disk and deallocate the in-memory coins map.
5534 }
5535 return ret;
5536}
5537
5539{
5541 const ChainTxData& data{GetParams().TxData()};
5542 if (pindex == nullptr) {
5543 return 0.0;
5544 }
5545
5546 if (pindex->m_chain_tx_count == 0) {
5547 LogDebug(BCLog::VALIDATION, "Block %d has unset m_chain_tx_count. Unable to estimate verification progress.\n", pindex->nHeight);
5548 return 0.0;
5549 }
5550
5552 const auto block_time{
5553 (Assume(m_best_header) && std::abs(nNow - pindex->GetBlockTime()) <= Ticks<std::chrono::seconds>(2h) &&
5554 Assume(m_best_header->nHeight >= pindex->nHeight)) ?
5555 // When the header is known to be recent, switch to a height-based
5556 // approach. This ensures the returned value is quantized when
5557 // close to "1.0", because some users expect it to be. This also
5558 // avoids relying too much on the exact miner-set timestamp, which
5559 // may be off.
5560 nNow - (m_best_header->nHeight - pindex->nHeight) * GetConsensus().nPowTargetSpacing :
5561 pindex->GetBlockTime(),
5562 };
5563
5564 double fTxTotal;
5565
5566 if (pindex->m_chain_tx_count <= data.tx_count) {
5567 fTxTotal = data.tx_count + (nNow - data.nTime) * data.dTxRate;
5568 } else {
5569 fTxTotal = pindex->m_chain_tx_count + (nNow - block_time) * data.dTxRate;
5570 }
5571
5572 return std::min<double>(pindex->m_chain_tx_count / fTxTotal, 1.0);
5573}
5574
5575Chainstate& ChainstateManager::InitializeChainstate(CTxMemPool* mempool)
5576{
5578 assert(m_chainstates.empty());
5579 m_chainstates.emplace_back(std::make_unique<Chainstate>(mempool, m_blockman, *this));
5580 return *m_chainstates.back();
5581}
5582
5583[[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path db_path, bool is_snapshot)
5585{
5587
5588 if (is_snapshot) {
5589 fs::path base_blockhash_path = db_path / node::SNAPSHOT_BLOCKHASH_FILENAME;
5590
5591 try {
5592 bool existed = fs::remove(base_blockhash_path);
5593 if (!existed) {
5594 LogWarning("[snapshot] snapshot chainstate dir being removed lacks %s file",
5595 fs::PathToString(node::SNAPSHOT_BLOCKHASH_FILENAME));
5596 }
5597 } catch (const fs::filesystem_error& e) {
5598 LogWarning("[snapshot] failed to remove file %s: %s\n",
5599 fs::PathToString(base_blockhash_path), e.code().message());
5600 }
5601 }
5602
5603 std::string path_str = fs::PathToString(db_path);
5604 LogInfo("Removing leveldb dir at %s\n", path_str);
5605
5606 // We have to destruct before this call leveldb::DB in order to release the db
5607 // lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
5608 const bool destroyed = DestroyDB(path_str);
5609
5610 if (!destroyed) {
5611 LogError("leveldb DestroyDB call failed on %s", path_str);
5612 }
5613
5614 // Datadir should be removed from filesystem; otherwise initialization may detect
5615 // it on subsequent statups and get confused.
5616 //
5617 // If the base_blockhash_path removal above fails in the case of snapshot
5618 // chainstates, this will return false since leveldb won't remove a non-empty
5619 // directory.
5620 return destroyed && !fs::exists(db_path);
5621}
5622
5624 AutoFile& coins_file,
5625 const SnapshotMetadata& metadata,
5626 bool in_memory)
5627{
5628 uint256 base_blockhash = metadata.m_base_blockhash;
5629
5630 CBlockIndex* snapshot_start_block{};
5631
5632 {
5633 LOCK(::cs_main);
5634
5635 if (this->CurrentChainstate().m_from_snapshot_blockhash) {
5636 return util::Error{Untranslated("Can't activate a snapshot-based chainstate more than once")};
5637 }
5638 if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
5639 auto available_heights = GetParams().GetAvailableSnapshotHeights();
5640 std::string heights_formatted = util::Join(available_heights, ", ", [&](const auto& i) { return util::ToString(i); });
5641 return util::Error{Untranslated(strprintf("assumeutxo block hash in snapshot metadata not recognized (hash: %s). The following snapshot heights are available: %s",
5642 base_blockhash.ToString(),
5643 heights_formatted))};
5644 }
5645
5646 snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
5647 if (!snapshot_start_block) {
5648 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",
5649 base_blockhash.ToString()))};
5650 }
5651
5652 bool start_block_invalid = snapshot_start_block->nStatus & BLOCK_FAILED_VALID;
5653 if (start_block_invalid) {
5654 return util::Error{Untranslated(strprintf("The base block header (%s) is part of an invalid chain", base_blockhash.ToString()))};
5655 }
5656
5657 if (!m_best_header || m_best_header->GetAncestor(snapshot_start_block->nHeight) != snapshot_start_block) {
5658 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.")};
5659 }
5660
5661 auto mempool{CurrentChainstate().GetMempool()};
5662 if (mempool && mempool->size() > 0) {
5663 return util::Error{Untranslated("Can't activate a snapshot when mempool not empty")};
5664 }
5665 }
5666
5667 int64_t current_coinsdb_cache_size{0};
5668 int64_t current_coinstip_cache_size{0};
5669
5670 // Cache percentages to allocate to each chainstate.
5671 //
5672 // These particular percentages don't matter so much since they will only be
5673 // relevant during snapshot activation; caches are rebalanced at the conclusion of
5674 // this function. We want to give (essentially) all available cache capacity to the
5675 // snapshot to aid the bulk load later in this function.
5676 static constexpr double IBD_CACHE_PERC = 0.01;
5677 static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
5678
5679 {
5680 LOCK(::cs_main);
5681 // Resize the coins caches to ensure we're not exceeding memory limits.
5682 //
5683 // Allocate the majority of the cache to the incoming snapshot chainstate, since
5684 // (optimistically) getting to its tip will be the top priority. We'll need to call
5685 // `MaybeRebalanceCaches()` once we're done with this function to ensure
5686 // the right allocation (including the possibility that no snapshot was activated
5687 // and that we should restore the active chainstate caches to their original size).
5688 //
5689 current_coinsdb_cache_size = this->ActiveChainstate().m_coinsdb_cache_size_bytes;
5690 current_coinstip_cache_size = this->ActiveChainstate().m_coinstip_cache_size_bytes;
5691
5692 // Temporarily resize the active coins cache to make room for the newly-created
5693 // snapshot chain.
5694 this->ActiveChainstate().ResizeCoinsCaches(
5695 static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
5696 static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
5697 }
5698
5699 auto snapshot_chainstate = WITH_LOCK(::cs_main,
5700 return std::make_unique<Chainstate>(
5701 /*mempool=*/nullptr, m_blockman, *this, base_blockhash));
5702
5703 {
5704 LOCK(::cs_main);
5705 snapshot_chainstate->InitCoinsDB(
5706 static_cast<size_t>(current_coinsdb_cache_size * SNAPSHOT_CACHE_PERC),
5707 in_memory, /*should_wipe=*/false);
5708 snapshot_chainstate->InitCoinsCache(
5709 static_cast<size_t>(current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
5710 }
5711
5712 auto cleanup_bad_snapshot = [&](bilingual_str reason) EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
5713 this->MaybeRebalanceCaches();
5714
5715 // PopulateAndValidateSnapshot can return (in error) before the leveldb datadir
5716 // has been created, so only attempt removal if we got that far.
5717 if (auto snapshot_datadir = node::FindAssumeutxoChainstateDir(m_options.datadir)) {
5718 // We have to destruct leveldb::DB in order to release the db lock, otherwise
5719 // DestroyDB() (in DeleteCoinsDBFromDisk()) will fail. See `leveldb::~DBImpl()`.
5720 // Destructing the chainstate (and so resetting the coinsviews object) does this.
5721 snapshot_chainstate.reset();
5722 bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir, /*is_snapshot=*/true);
5723 if (!removed) {
5724 GetNotifications().fatalError(strprintf(_("Failed to remove snapshot chainstate dir (%s). "
5725 "Manually remove it before restarting.\n"), fs::PathToString(*snapshot_datadir)));
5726 }
5727 }
5728 return util::Error{std::move(reason)};
5729 };
5730
5731 if (auto res{this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file, metadata)}; !res) {
5732 LOCK(::cs_main);
5733 return cleanup_bad_snapshot(Untranslated(strprintf("Population failed: %s", util::ErrorString(res).original)));
5734 }
5735
5736 LOCK(::cs_main); // cs_main required for rest of snapshot activation.
5737
5738 // Do a final check to ensure that the snapshot chainstate is actually a more
5739 // work chain than the active chainstate; a user could have loaded a snapshot
5740 // very late in the IBD process, and we wouldn't want to load a useless chainstate.
5741 if (!CBlockIndexWorkComparator()(ActiveTip(), snapshot_chainstate->m_chain.Tip())) {
5742 return cleanup_bad_snapshot(Untranslated("work does not exceed active chainstate"));
5743 }
5744 // If not in-memory, persist the base blockhash for use during subsequent
5745 // initialization.
5746 if (!in_memory) {
5747 if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
5748 return cleanup_bad_snapshot(Untranslated("could not write base blockhash"));
5749 }
5750 }
5751
5752 Chainstate& chainstate{AddChainstate(std::move(snapshot_chainstate))};
5753 m_blockman.m_snapshot_height = Assert(chainstate.SnapshotBase())->nHeight;
5754
5755 chainstate.PopulateBlockIndexCandidates();
5756
5757 LogInfo("[snapshot] successfully activated snapshot %s", base_blockhash.ToString());
5758 LogInfo("[snapshot] (%.2f MB)",
5759 chainstate.CoinsTip().DynamicMemoryUsage() / (1000 * 1000));
5760
5761 this->MaybeRebalanceCaches();
5762 return snapshot_start_block;
5763}
5764
5765static void FlushSnapshotToDisk(CCoinsViewCache& coins_cache, bool snapshot_loaded)
5766{
5768 strprintf("%s (%.2f MB)",
5769 snapshot_loaded ? "saving snapshot chainstate" : "flushing coins cache",
5770 coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
5772
5773 coins_cache.Flush();
5774}
5775
5776struct StopHashingException : public std::exception
5777{
5778 const char* what() const noexcept override
5779 {
5780 return "ComputeUTXOStats interrupted.";
5781 }
5782};
5783
5785{
5786 if (interrupt) throw StopHashingException();
5787}
5788
5790 Chainstate& snapshot_chainstate,
5791 AutoFile& coins_file,
5792 const SnapshotMetadata& metadata)
5793{
5794 // It's okay to release cs_main before we're done using `coins_cache` because we know
5795 // that nothing else will be referencing the newly created snapshot_chainstate yet.
5796 CCoinsViewCache& coins_cache = *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
5797
5798 uint256 base_blockhash = metadata.m_base_blockhash;
5799
5800 CBlockIndex* snapshot_start_block = WITH_LOCK(::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
5801
5802 if (!snapshot_start_block) {
5803 // Needed for ComputeUTXOStats to determine the
5804 // height and to avoid a crash when base_blockhash.IsNull()
5805 return util::Error{Untranslated(strprintf("Did not find snapshot start blockheader %s",
5806 base_blockhash.ToString()))};
5807 }
5808
5809 int base_height = snapshot_start_block->nHeight;
5810 const auto& maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
5811
5812 if (!maybe_au_data) {
5813 return util::Error{Untranslated(strprintf("Assumeutxo height in snapshot metadata not recognized "
5814 "(%d) - refusing to load snapshot", base_height))};
5815 }
5816
5817 const AssumeutxoData& au_data = *maybe_au_data;
5818
5819 // This work comparison is a duplicate check with the one performed later in
5820 // ActivateSnapshot(), but is done so that we avoid doing the long work of staging
5821 // a snapshot that isn't actually usable.
5822 if (WITH_LOCK(::cs_main, return !CBlockIndexWorkComparator()(ActiveTip(), snapshot_start_block))) {
5823 return util::Error{Untranslated("Work does not exceed active chainstate")};
5824 }
5825
5826 const uint64_t coins_count = metadata.m_coins_count;
5827 uint64_t coins_left = metadata.m_coins_count;
5828
5829 LogInfo("[snapshot] loading %d coins from snapshot %s", coins_left, base_blockhash.ToString());
5830 int64_t coins_processed{0};
5831
5832 while (coins_left > 0) {
5833 try {
5834 Txid txid;
5835 coins_file >> txid;
5836 size_t coins_per_txid{0};
5837 coins_per_txid = ReadCompactSize(coins_file);
5838
5839 if (coins_per_txid > coins_left) {
5840 return util::Error{Untranslated("Mismatch in coins count in snapshot metadata and actual snapshot data")};
5841 }
5842
5843 for (size_t i = 0; i < coins_per_txid; i++) {
5844 COutPoint outpoint;
5845 Coin coin;
5846 outpoint.n = static_cast<uint32_t>(ReadCompactSize(coins_file));
5847 outpoint.hash = txid;
5848 coins_file >> coin;
5849 if (coin.nHeight > base_height ||
5850 outpoint.n >= std::numeric_limits<decltype(outpoint.n)>::max() // Avoid integer wrap-around in coinstats.cpp:ApplyHash
5851 ) {
5852 return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins",
5853 coins_count - coins_left))};
5854 }
5855 if (!MoneyRange(coin.out.nValue)) {
5856 return util::Error{Untranslated(strprintf("Bad snapshot data after deserializing %d coins - bad tx out value",
5857 coins_count - coins_left))};
5858 }
5859 coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint), std::move(coin));
5860
5861 --coins_left;
5862 ++coins_processed;
5863
5864 if (coins_processed % 1000000 == 0) {
5865 LogInfo("[snapshot] %d coins loaded (%.2f%%, %.2f MB)",
5866 coins_processed,
5867 static_cast<float>(coins_processed) * 100 / static_cast<float>(coins_count),
5868 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5869 }
5870
5871 // Batch write and flush (if we need to) every so often.
5872 //
5873 // If our average Coin size is roughly 41 bytes, checking every 120,000 coins
5874 // means <5MB of memory imprecision.
5875 if (coins_processed % 120000 == 0) {
5876 if (m_interrupt) {
5877 return util::Error{Untranslated("Aborting after an interrupt was requested")};
5878 }
5879
5880 const auto snapshot_cache_state = WITH_LOCK(::cs_main,
5881 return snapshot_chainstate.GetCoinsCacheSizeState());
5882
5883 if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
5884 // This is a hack - we don't know what the actual best block is, but that
5885 // doesn't matter for the purposes of flushing the cache here. We'll set this
5886 // to its correct value (`base_blockhash`) below after the coins are loaded.
5887 coins_cache.SetBestBlock(GetRandHash());
5888
5889 // No need to acquire cs_main since this chainstate isn't being used yet.
5890 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/false);
5891 }
5892 }
5893 }
5894 } catch (const std::ios_base::failure&) {
5895 return util::Error{Untranslated(strprintf("Bad snapshot format or truncated snapshot after deserializing %d coins",
5896 coins_processed))};
5897 }
5898 }
5899
5900 // Important that we set this. This and the coins_cache accesses above are
5901 // sort of a layer violation, but either we reach into the innards of
5902 // CCoinsViewCache here or we have to invert some of the Chainstate to
5903 // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
5904 // method.
5905 coins_cache.SetBestBlock(base_blockhash);
5906
5907 bool out_of_coins{false};
5908 try {
5909 std::byte left_over_byte;
5910 coins_file >> left_over_byte;
5911 } catch (const std::ios_base::failure&) {
5912 // We expect an exception since we should be out of coins.
5913 out_of_coins = true;
5914 }
5915 if (!out_of_coins) {
5916 return util::Error{Untranslated(strprintf("Bad snapshot - coins left over after deserializing %d coins",
5917 coins_count))};
5918 }
5919
5920 LogInfo("[snapshot] loaded %d (%.2f MB) coins from snapshot %s",
5921 coins_count,
5922 coins_cache.DynamicMemoryUsage() / (1000 * 1000),
5923 base_blockhash.ToString());
5924
5925 // No need to acquire cs_main since this chainstate isn't being used yet.
5926 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
5927
5928 assert(coins_cache.GetBestBlock() == base_blockhash);
5929
5930 // As above, okay to immediately release cs_main here since no other context knows
5931 // about the snapshot_chainstate.
5932 CCoinsViewDB* snapshot_coinsdb = WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
5933
5934 std::optional<CCoinsStats> maybe_stats;
5935
5936 try {
5937 maybe_stats = ComputeUTXOStats(
5938 CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman, [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
5939 } catch (StopHashingException const&) {
5940 return util::Error{Untranslated("Aborting after an interrupt was requested")};
5941 }
5942 if (!maybe_stats.has_value()) {
5943 return util::Error{Untranslated("Failed to generate coins stats")};
5944 }
5945
5946 // Assert that the deserialized chainstate contents match the expected assumeutxo value.
5947 if (AssumeutxoHash{maybe_stats->hashSerialized} != au_data.hash_serialized) {
5948 return util::Error{Untranslated(strprintf("Bad snapshot content hash: expected %s, got %s",
5949 au_data.hash_serialized.ToString(), maybe_stats->hashSerialized.ToString()))};
5950 }
5951
5952 snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
5953
5954 // The remainder of this function requires modifying data protected by cs_main.
5955 LOCK(::cs_main);
5956
5957 // Fake various pieces of CBlockIndex state:
5958 CBlockIndex* index = nullptr;
5959
5960 // Don't make any modifications to the genesis block since it shouldn't be
5961 // necessary, and since the genesis block doesn't have normal flags like
5962 // BLOCK_VALID_SCRIPTS set.
5963 constexpr int AFTER_GENESIS_START{1};
5964
5965 for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height(); ++i) {
5966 index = snapshot_chainstate.m_chain[i];
5967
5968 // Fake BLOCK_OPT_WITNESS so that Chainstate::NeedsRedownload()
5969 // won't ask for -reindex on startup.
5971 index->nStatus |= BLOCK_OPT_WITNESS;
5972 }
5973
5974 m_blockman.m_dirty_blockindex.insert(index);
5975 // Changes to the block index will be flushed to disk after this call
5976 // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
5977 // called, since we've added a snapshot chainstate and therefore will
5978 // have to downsize the IBD chainstate, which will result in a call to
5979 // `FlushStateToDisk(FORCE_FLUSH)`.
5980 }
5981
5982 assert(index);
5983 assert(index == snapshot_start_block);
5984 index->m_chain_tx_count = au_data.m_chain_tx_count;
5985
5986 LogInfo("[snapshot] validated snapshot (%.2f MB)",
5987 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
5988 return {};
5989}
5990
5991// Currently, this function holds cs_main for its duration, which could be for
5992// multiple minutes due to the ComputeUTXOStats call. Holding cs_main used to be
5993// necessary (before d43a1f1a2fa3) to avoid advancing validated_cs farther than
5994// its target block. Now it should be possible to avoid this, but simply
5995// releasing cs_main here would not be possible because this function is invoked
5996// by ConnectTip within ActivateBestChain.
5997//
5998// Eventually (TODO) it would be better to call this function outside of
5999// ActivateBestChain, on a separate thread that should not require cs_main to
6000// hash, because the UTXO set is only hashed after the historical chainstate
6001// reaches its target block and is no longer changing.
6002SnapshotCompletionResult ChainstateManager::MaybeValidateSnapshot(Chainstate& validated_cs, Chainstate& unvalidated_cs)
6003{
6005
6006 // If the snapshot does not need to be validated...
6007 if (unvalidated_cs.m_assumeutxo != Assumeutxo::UNVALIDATED ||
6008 // Or if either chainstate is unusable...
6009 !unvalidated_cs.m_from_snapshot_blockhash ||
6010 validated_cs.m_assumeutxo != Assumeutxo::VALIDATED ||
6011 !validated_cs.m_chain.Tip() ||
6012 // Or the validated chainstate is not targeting the snapshot block...
6013 !validated_cs.m_target_blockhash ||
6014 *validated_cs.m_target_blockhash != *unvalidated_cs.m_from_snapshot_blockhash ||
6015 // Or the validated chainstate has not reached the snapshot block yet...
6016 !validated_cs.ReachedTarget()) {
6017 // Then the snapshot cannot be validated and there is nothing to do.
6019 }
6020 assert(validated_cs.TargetBlock() == validated_cs.m_chain.Tip());
6021
6022 auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
6023 bilingual_str user_error = strprintf(_(
6024 "%s failed to validate the -assumeutxo snapshot state. "
6025 "This indicates a hardware problem, or a bug in the software, or a "
6026 "bad software modification that allowed an invalid snapshot to be "
6027 "loaded. As a result of this, the node will shut down and stop using any "
6028 "state that was built on the snapshot, resetting the chain height "
6029 "from %d to %d. On the next "
6030 "restart, the node will resume syncing from %d "
6031 "without using any snapshot data. "
6032 "Please report this incident to %s, including how you obtained the snapshot. "
6033 "The invalid snapshot chainstate will be left on disk in case it is "
6034 "helpful in diagnosing the issue that caused this error."),
6035 CLIENT_NAME, unvalidated_cs.m_chain.Height(),
6036 validated_cs.m_chain.Height(),
6037 validated_cs.m_chain.Height(), CLIENT_BUGREPORT);
6038
6039 LogError("[snapshot] !!! %s\n", user_error.original);
6040 LogError("[snapshot] deleting snapshot, reverting to validated chain, and stopping node\n");
6041
6042 // Reset chainstate target to network tip instead of snapshot block.
6043 validated_cs.SetTargetBlock(nullptr);
6044
6045 unvalidated_cs.m_assumeutxo = Assumeutxo::INVALID;
6046
6047 auto rename_result = unvalidated_cs.InvalidateCoinsDBOnDisk();
6048 if (!rename_result) {
6049 user_error += Untranslated("\n") + util::ErrorString(rename_result);
6050 }
6051
6052 GetNotifications().fatalError(user_error);
6053 };
6054
6055 CCoinsViewDB& validated_coins_db = validated_cs.CoinsDB();
6056 validated_cs.ForceFlushStateToDisk();
6057
6058 const auto& maybe_au_data = m_options.chainparams.AssumeutxoForHeight(validated_cs.m_chain.Height());
6059 if (!maybe_au_data) {
6060 LogWarning("[snapshot] assumeutxo data not found for height "
6061 "(%d) - refusing to validate snapshot", validated_cs.m_chain.Height());
6062 handle_invalid_snapshot();
6064 }
6065
6066 const AssumeutxoData& au_data = *maybe_au_data;
6067 std::optional<CCoinsStats> validated_cs_stats;
6068 LogInfo("[snapshot] computing UTXO stats for background chainstate to validate "
6069 "snapshot - this could take a few minutes");
6070 try {
6071 validated_cs_stats = ComputeUTXOStats(
6073 &validated_coins_db,
6074 m_blockman,
6075 [&interrupt = m_interrupt] { SnapshotUTXOHashBreakpoint(interrupt); });
6076 } catch (StopHashingException const&) {
6078 }
6079
6080 // XXX note that this function is slow and will hold cs_main for potentially minutes.
6081 if (!validated_cs_stats) {
6082 LogWarning("[snapshot] failed to generate stats for validation coins db");
6083 // While this isn't a problem with the snapshot per se, this condition
6084 // prevents us from validating the snapshot, so we should shut down and let the
6085 // user handle the issue manually.
6086 handle_invalid_snapshot();
6088 }
6089
6090 // Compare the validated chainstate's UTXO set hash against the hard-coded
6091 // assumeutxo hash we expect.
6092 //
6093 // TODO: For belt-and-suspenders, we could cache the UTXO set
6094 // hash for the snapshot when it's loaded in its chainstate's leveldb. We could then
6095 // reference that here for an additional check.
6096 if (AssumeutxoHash{validated_cs_stats->hashSerialized} != au_data.hash_serialized) {
6097 LogWarning("[snapshot] hash mismatch: actual=%s, expected=%s",
6098 validated_cs_stats->hashSerialized.ToString(),
6099 au_data.hash_serialized.ToString());
6100 handle_invalid_snapshot();
6102 }
6103
6104 LogInfo("[snapshot] snapshot beginning at %s has been fully validated",
6105 unvalidated_cs.m_from_snapshot_blockhash->ToString());
6106
6107 unvalidated_cs.m_assumeutxo = Assumeutxo::VALIDATED;
6108 validated_cs.m_target_utxohash = AssumeutxoHash{validated_cs_stats->hashSerialized};
6109 this->MaybeRebalanceCaches();
6110
6112}
6113
6119
6120void ChainstateManager::MaybeRebalanceCaches()
6121{
6123 Chainstate& current_cs{CurrentChainstate()};
6124 Chainstate* historical_cs{HistoricalChainstate()};
6125 if (!historical_cs && !current_cs.m_from_snapshot_blockhash) {
6126 // Allocate everything to the IBD chainstate. This will always happen
6127 // when we are not using a snapshot.
6128 current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6129 } else if (!historical_cs) {
6130 // If background validation has completed and snapshot is our active chain...
6131 LogInfo("[snapshot] allocating all cache to the snapshot chainstate");
6132 // Allocate everything to the snapshot chainstate.
6133 current_cs.ResizeCoinsCaches(m_total_coinstip_cache, m_total_coinsdb_cache);
6134 } else {
6135 // If both chainstates exist, determine who needs more cache based on IBD status.
6136 //
6137 // Note: shrink caches first so that we don't inadvertently overwhelm available memory.
6138 if (IsInitialBlockDownload()) {
6139 historical_cs->ResizeCoinsCaches(
6141 current_cs.ResizeCoinsCaches(
6143 } else {
6144 current_cs.ResizeCoinsCaches(
6146 historical_cs->ResizeCoinsCaches(
6148 }
6149 }
6150}
6151
6152void ChainstateManager::ResetChainstates()
6153{
6154 m_chainstates.clear();
6155}
6156
6163{
6164 if (!opts.check_block_index.has_value()) opts.check_block_index = opts.chainparams.DefaultConsistencyChecks();
6165 if (!opts.minimum_chain_work.has_value()) opts.minimum_chain_work = UintToArith256(opts.chainparams.GetConsensus().nMinimumChainWork);
6166 if (!opts.assumed_valid_block.has_value()) opts.assumed_valid_block = opts.chainparams.GetConsensus().defaultAssumeValid;
6167 return std::move(opts);
6168}
6169
6171 : m_script_check_queue{/*batch_size=*/128, std::clamp(options.worker_threads_num, 0, MAX_SCRIPTCHECK_THREADS)},
6172 m_interrupt{interrupt},
6173 m_options{Flatten(std::move(options))},
6174 m_blockman{interrupt, std::move(blockman_options)},
6175 m_validation_cache{m_options.script_execution_cache_bytes, m_options.signature_cache_bytes}
6176{
6177}
6178
6185
6186Chainstate* ChainstateManager::LoadAssumeutxoChainstate()
6187{
6188 assert(!CurrentChainstate().m_from_snapshot_blockhash);
6189 std::optional<fs::path> path = node::FindAssumeutxoChainstateDir(m_options.datadir);
6190 if (!path) {
6191 return nullptr;
6192 }
6193 std::optional<uint256> base_blockhash = node::ReadSnapshotBaseBlockhash(*path);
6194 if (!base_blockhash) {
6195 return nullptr;
6196 }
6197 LogInfo("[snapshot] detected active snapshot chainstate (%s) - loading",
6198 fs::PathToString(*path));
6199
6200 auto snapshot_chainstate{std::make_unique<Chainstate>(nullptr, m_blockman, *this, base_blockhash)};
6201 LogInfo("[snapshot] switching active chainstate to %s", snapshot_chainstate->ToString());
6202 return &this->AddChainstate(std::move(snapshot_chainstate));
6203}
6204
6205Chainstate& ChainstateManager::AddChainstate(std::unique_ptr<Chainstate> chainstate)
6206{
6207 Chainstate& prev_chainstate{CurrentChainstate()};
6208 assert(prev_chainstate.m_assumeutxo == Assumeutxo::VALIDATED);
6209 // Set target block for historical chainstate to snapshot block.
6210 assert(!prev_chainstate.m_target_blockhash);
6211 prev_chainstate.m_target_blockhash = chainstate->m_from_snapshot_blockhash;
6212 m_chainstates.push_back(std::move(chainstate));
6213 Chainstate& curr_chainstate{CurrentChainstate()};
6214 assert(&curr_chainstate == m_chainstates.back().get());
6215
6216 // Transfer possession of the mempool to the chainstate.
6217 // Mempool is empty at this point because we're still in IBD.
6218 assert(!prev_chainstate.m_mempool || prev_chainstate.m_mempool->size() == 0);
6219 assert(!curr_chainstate.m_mempool);
6220 std::swap(curr_chainstate.m_mempool, prev_chainstate.m_mempool);
6221 return curr_chainstate;
6222}
6223
6224bool IsBIP30Repeat(const CBlockIndex& block_index)
6225{
6226 return (block_index.nHeight==91842 && block_index.GetBlockHash() == uint256{"00000000000a4d0a398161ffc163c503763b1f4360639393e0e4c8e300e0caec"}) ||
6227 (block_index.nHeight==91880 && block_index.GetBlockHash() == uint256{"00000000000743f190a18c5577a3c2d2a1f610ae9601ac046a38084ccb7cd721"});
6228}
6229
6230bool IsBIP30Unspendable(const uint256& block_hash, int block_height)
6231{
6232 return (block_height==91722 && block_hash == uint256{"00000000000271a2dc26e7667f8419f2e15416dc6955e5a6c6cdf3f2574dd08e"}) ||
6233 (block_height==91812 && block_hash == uint256{"00000000000af0aed4792b1acee3d966af36cf5def14935db8de83d6f9306f2f"});
6234}
6235
6236util::Result<void> Chainstate::InvalidateCoinsDBOnDisk()
6237{
6238 // Should never be called on a non-snapshot chainstate.
6240
6241 // Coins views no longer usable.
6242 m_coins_views.reset();
6243
6244 const fs::path db_path{StoragePath()};
6245 const fs::path invalid_path{db_path + "_INVALID"};
6246 const std::string db_path_str{fs::PathToString(db_path)};
6247 const std::string invalid_path_str{fs::PathToString(invalid_path)};
6248 LogInfo("[snapshot] renaming snapshot datadir %s to %s", db_path_str, invalid_path_str);
6249
6250 // The invalid storage directory is simply moved and not deleted because we may
6251 // want to do forensics later during issue investigation. The user is instructed
6252 // accordingly in MaybeValidateSnapshot().
6253 try {
6254 fs::rename(db_path, invalid_path);
6255 } catch (const fs::filesystem_error& e) {
6256 LogError("While invalidating the coins db: Error renaming file '%s' -> '%s': %s",
6257 db_path_str, invalid_path_str, e.what());
6258 return util::Error{strprintf(_(
6259 "Rename of '%s' -> '%s' failed. "
6260 "You should resolve this by manually moving or deleting the invalid "
6261 "snapshot directory %s, otherwise you will encounter the same error again "
6262 "on the next startup."),
6263 db_path_str, invalid_path_str, db_path_str)};
6264 }
6265 return {};
6266}
6267
6268bool ChainstateManager::DeleteChainstate(Chainstate& chainstate)
6269{
6271 assert(!chainstate.m_coins_views);
6272 const fs::path db_path{chainstate.StoragePath()};
6273 if (!DeleteCoinsDBFromDisk(db_path, /*is_snapshot=*/bool{chainstate.m_from_snapshot_blockhash})) {
6274 LogError("Deletion of %s failed. Please remove it manually to continue reindexing.",
6275 fs::PathToString(db_path));
6276 return false;
6277 }
6278 std::unique_ptr<Chainstate> prev_chainstate{Assert(RemoveChainstate(chainstate))};
6279 Chainstate& curr_chainstate{CurrentChainstate()};
6280 assert(prev_chainstate->m_mempool->size() == 0);
6281 assert(!curr_chainstate.m_mempool);
6282 std::swap(curr_chainstate.m_mempool, prev_chainstate->m_mempool);
6283 return true;
6284}
6285
6286ChainstateRole Chainstate::GetRole() const
6287{
6288 return ChainstateRole{.validated = m_assumeutxo == Assumeutxo::VALIDATED, .historical = bool{m_target_blockhash}};
6289}
6290
6291void ChainstateManager::RecalculateBestHeader()
6292{
6294 m_best_header = ActiveChain().Tip();
6295 for (auto& entry : m_blockman.m_block_index) {
6296 if (!(entry.second.nStatus & BLOCK_FAILED_VALID) && m_best_header->nChainWork < entry.second.nChainWork) {
6297 m_best_header = &entry.second;
6298 }
6299 }
6300}
6301
6302std::optional<int> ChainstateManager::BlocksAheadOfTip() const
6303{
6304 LOCK(::cs_main);
6305 const CBlockIndex* best_header{m_best_header};
6306 const CBlockIndex* tip{ActiveChain().Tip()};
6307 // Only consider headers that extend the active tip; ignore competing branches.
6308 if (best_header && tip && best_header->nChainWork > tip->nChainWork &&
6309 best_header->GetAncestor(tip->nHeight) == tip) {
6310 return best_header->nHeight - tip->nHeight;
6311 }
6312 return std::nullopt;
6313}
6314
6315bool ChainstateManager::ValidatedSnapshotCleanup(Chainstate& validated_cs, Chainstate& unvalidated_cs)
6316{
6318 if (unvalidated_cs.m_assumeutxo != Assumeutxo::VALIDATED) {
6319 // No need to clean up.
6320 return false;
6321 }
6322
6323 const fs::path validated_path{validated_cs.StoragePath()};
6324 const fs::path assumed_valid_path{unvalidated_cs.StoragePath()};
6325 const fs::path delete_path{validated_path + "_todelete"};
6326
6327 // Since we're going to be moving around the underlying leveldb filesystem content
6328 // for each chainstate, make sure that the chainstates (and their constituent
6329 // CoinsViews members) have been destructed first.
6330 //
6331 // The caller of this method will be responsible for reinitializing chainstates
6332 // if they want to continue operation.
6333 this->ResetChainstates();
6334 assert(this->m_chainstates.size() == 0);
6335
6336 LogInfo("[snapshot] deleting background chainstate directory (now unnecessary) (%s)",
6337 fs::PathToString(validated_path));
6338
6339 auto rename_failed_abort = [this](
6340 fs::path p_old,
6341 fs::path p_new,
6342 const fs::filesystem_error& err) {
6343 LogError("[snapshot] Error renaming path (%s) -> (%s): %s\n",
6344 fs::PathToString(p_old), fs::PathToString(p_new), err.what());
6346 "Rename of '%s' -> '%s' failed. "
6347 "Cannot clean up the background chainstate leveldb directory."),
6348 fs::PathToString(p_old), fs::PathToString(p_new)));
6349 };
6350
6351 try {
6352 fs::rename(validated_path, delete_path);
6353 } catch (const fs::filesystem_error& e) {
6354 rename_failed_abort(validated_path, delete_path, e);
6355 throw;
6356 }
6357
6358 LogInfo("[snapshot] moving snapshot chainstate (%s) to "
6359 "default chainstate directory (%s)",
6360 fs::PathToString(assumed_valid_path), fs::PathToString(validated_path));
6361
6362 try {
6363 fs::rename(assumed_valid_path, validated_path);
6364 } catch (const fs::filesystem_error& e) {
6365 rename_failed_abort(assumed_valid_path, validated_path, e);
6366 throw;
6367 }
6368
6369 if (!DeleteCoinsDBFromDisk(delete_path, /*is_snapshot=*/false)) {
6370 // No need to FatalError because once the unneeded bg chainstate data is
6371 // moved, it will not interfere with subsequent initialization.
6372 LogWarning("Deletion of %s failed. Please remove it manually, as the "
6373 "directory is now unnecessary.",
6374 fs::PathToString(delete_path));
6375 } else {
6376 LogInfo("[snapshot] deleted background chainstate directory (%s)",
6377 fs::PathToString(validated_path));
6378 }
6379 return true;
6380}
6381
6382std::pair<int, int> Chainstate::GetPruneRange(int last_height_can_prune) const
6383{
6384 if (m_chain.Height() <= 0) {
6385 return {0, 0};
6386 }
6387 int prune_start{0};
6388
6389 if (m_from_snapshot_blockhash && m_assumeutxo != Assumeutxo::VALIDATED) {
6390 // Only prune blocks _after_ the snapshot if this is a snapshot chain
6391 // that has not been fully validated yet. The earlier blocks need to be
6392 // kept to validate the snapshot
6393 prune_start = Assert(SnapshotBase())->nHeight + 1;
6394 }
6395
6396 int max_prune = std::max<int>(
6397 0, m_chain.Height() - static_cast<int>(MIN_BLOCKS_TO_KEEP));
6398
6399 // last block to prune is the lesser of (caller-specified height, MIN_BLOCKS_TO_KEEP from the tip)
6400 //
6401 // While you might be tempted to prune the background chainstate more
6402 // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
6403 // building - specifically blockfilterindex requires undo data, and if
6404 // we don't maintain this trailing window, we hit indexing failures.
6405 int prune_end = std::min(last_height_can_prune, max_prune);
6406
6407 return {prune_start, prune_end};
6408}
6409
6410std::optional<std::pair<const CBlockIndex*, const CBlockIndex*>> ChainstateManager::GetHistoricalBlockRange() const
6411{
6412 const Chainstate* chainstate{HistoricalChainstate()};
6413 if (!chainstate) return {};
6414 return std::make_pair(chainstate->m_chain.Tip(), chainstate->TargetBlock());
6415}
6416
6417util::Result<void> ChainstateManager::ActivateBestChains()
6418{
6419 // We can't hold cs_main during ActivateBestChain even though we're accessing
6420 // the chainman unique_ptrs since ABC requires us not to be holding cs_main, so retrieve
6421 // the relevant pointers before the ABC call.
6423 std::vector<Chainstate*> chainstates;
6424 {
6425 LOCK(GetMutex());
6426 chainstates.reserve(m_chainstates.size());
6427 for (const auto& chainstate : m_chainstates) {
6428 if (chainstate && chainstate->m_assumeutxo != Assumeutxo::INVALID && !chainstate->m_target_utxohash) {
6429 chainstates.push_back(chainstate.get());
6430 }
6431 }
6432 }
6433 for (Chainstate* chainstate : chainstates) {
6434 BlockValidationState state;
6435 if (!chainstate->ActivateBestChain(state, nullptr)) {
6436 LOCK(GetMutex());
6437 return util::Error{Untranslated(strprintf("%s Failed to connect best block (%s)", chainstate->ToString(), state.ToString()))};
6438 }
6439 }
6440 return {};
6441}
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)
static void pool cs
int ret
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition string.h:246
int flags
ArgsManager & args
Definition bitcoind.cpp:277
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
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
Definition chain.h:69
@ BLOCK_VALID_TREE
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_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:82
static constexpr int32_t SEQ_ID_BEST_CHAIN_FROM_DISK
Init values for CBlockIndex nSequenceId when loaded from disk.
Definition chain.h:39
arith_uint256 GetBlockProof(const CBlockIndex &block)
Compute how much work a block index entry corresponds to.
Definition chain.h:305
static constexpr int32_t SEQ_ID_INIT_FROM_DISK
Definition chain.h:40
static constexpr auto DATABASE_WRITE_INTERVAL_MAX
static constexpr auto DATABASE_WRITE_INTERVAL_MIN
#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:373
std::string ToString() const
Definition hash_type.h:43
Wrapper around an AutoFile& that implements a ring buffer to deserialize from.
Definition streams.h:483
bool eof() const
check whether we're at the end of the source file
Definition streams.h:540
bool SetLimit(uint64_t nPos=std::numeric_limits< uint64_t >::max())
Definition streams.h:586
uint64_t GetPos() const
return the current reading position
Definition streams.h:563
void SkipTo(const uint64_t file_pos)
Definition streams.h:556
void FindByte(std::byte byte)
search for a given byte in the stream, and remain positioned on it
Definition streams.h:600
bool SetPos(uint64_t nPos)
rewind to a given reading position
Definition streams.h:568
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition block.h:27
NodeSeconds Time() const
Definition block.h:61
uint32_t nBits
Definition block.h:34
int64_t GetBlockTime() const
Definition block.h:66
int32_t nVersion
Definition block.h:30
uint256 hashPrevBlock
Definition block.h:31
uint256 hashMerkleRoot
Definition block.h:32
uint256 GetHash() const
Definition block.cpp:15
Definition block.h:74
bool m_checked_merkle_root
Definition block.h:82
std::vector< CTransactionRef > vtx
Definition block.h:77
bool m_checked_witness_commitment
Definition block.h:81
bool fChecked
Definition block.h:80
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition chain.h:94
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:250
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition chain.h:100
uint64_t m_chain_tx_count
Definition chain.h:129
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
Definition chain.h:118
bool HaveNumChainTxs() const
Check whether this block and all previous blocks back to the genesis block or an assumeutxo snapshot ...
Definition chain.h:214
uint32_t nTime
Definition chain.h:142
int32_t nSequenceId
Definition chain.h:149
uint256 GetBlockHash() const
Definition chain.h:198
int64_t GetBlockTime() const
Definition chain.h:221
int64_t GetMedianTimePast() const
Definition chain.h:233
FlatFilePos GetUndoPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition chain.h:174
bool RaiseValidity(enum BlockStatus nUpTo) EXCLUSIVE_LOCKS_REQUIRED(
Definition chain.h:262
CBlockIndex * pskip
pointer to the index of some further predecessor of this block
Definition chain.h:103
unsigned int nTx
Definition chain.h:123
NodeSeconds Time() const
Definition chain.h:216
int32_t nVersion
block header
Definition chain.h:140
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:106
const uint256 * phashBlock
pointer to the hash of the block, if any. Memory is owned by this CBlockIndex
Definition chain.h:97
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:380
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition chain.h:396
void SetTip(CBlockIndex &block)
Set/initialize a chain with a given tip.
Definition chain.cpp:16
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:416
int Height() const
Return the maximal height in the chain.
Definition chain.h:425
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
Definition chain.h:410
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition chainparams.h:77
const MessageStartChars & MessageStart() const
Definition chainparams.h:90
const CBlock & GenesisBlock() const
Definition chainparams.h:94
std::vector< int > GetAvailableSnapshotHeights() const
const ChainTxData & TxData() const
const Consensus::Params & GetConsensus() const
Definition chainparams.h:89
std::optional< AssumeutxoData > AssumeutxoForHeight(int height) const
void SetBackend(CCoinsView &viewIn)
Definition coins.cpp:39
CCoinsView that adds a memory cache for transactions to another CCoinsView.
Definition coins.h:368
void Sync()
Push the modifications applied to this cache to its base while retaining the contents of this cache (...
Definition coins.cpp:291
bool SpendCoin(const COutPoint &outpoint, Coin *moveto=nullptr)
Spend a coin.
Definition coins.cpp:153
ResetGuard CreateResetGuard() noexcept
Create a scoped guard that will call Reset() on this cache when it goes out of scope.
Definition coins.h:519
void Uncache(const COutPoint &outpoint)
Removes the UTXO with the given outpoint from the cache, if it is not modified.
Definition coins.cpp:310
void AddCoin(const COutPoint &outpoint, Coin &&coin, bool possible_overwrite)
Add a coin.
Definition coins.cpp:89
void Flush(bool reallocate_cache=true)
Push the modifications applied to this cache to its base and wipe local state.
Definition coins.cpp:279
unsigned int GetCacheSize() const
Size of the cache (in number of transaction outputs).
Definition coins.cpp:325
uint256 GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition coins.cpp:198
void SetBestBlock(const uint256 &hashBlock)
Definition coins.cpp:204
bool HaveCoinInCache(const COutPoint &outpoint) const
Check if we have the given utxo already loaded in this cache.
Definition coins.cpp:193
size_t DynamicMemoryUsage() const
Calculate the size of the cache (in bytes).
Definition coins.cpp:59
void EmplaceCoinInternalDANGER(COutPoint &&outpoint, Coin &&coin)
Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty.
Definition coins.cpp:132
bool HaveCoin(const COutPoint &outpoint) const override
Definition coins.cpp:188
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Definition coins.cpp:179
CCoinsView backed by the coin database (chainstate/).
Definition txdb.h:37
void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Dynamically alter the underlying leveldb cache size.
Definition txdb.cpp:72
std::shared_future< void > CompactFull() EXCLUSIVE_LOCKS_REQUIRED(cs_main
Perform a full compaction of the underlying LevelDB on a one-shot background thread.
Definition txdb.cpp:191
Abstract view on the open txout dataset.
Definition coins.h:308
virtual std::optional< Coin > GetCoin(const COutPoint &outpoint) const
Definition coins.cpp:17
virtual std::vector< uint256 > GetHeadBlocks() const
Definition coins.cpp:20
CCoinsView that brings transactions from a mempool into view.
Definition txmempool.h:751
void Reset()
Clear m_temp_added and m_non_base_coins.
const std::unordered_set< COutPoint, SaltedOutpointHasher > & GetNonBaseCoins() const
Get all coins in m_non_base_coins.
Definition txmempool.h:775
void PackageAddTransaction(const CTransactionRef &tx)
Add the coins created by this transaction.
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
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:339
SignatureCache * m_signature_cache
Definition validation.h:347
PrecomputedTransactionData * txdata
Definition validation.h:346
CTxOut m_tx_out
Definition validation.h:341
script_verify_flags m_flags
Definition validation.h:344
std::optional< std::pair< ScriptError, std::string > > operator()()
const CTransaction * ptxTo
Definition validation.h:342
unsigned int nIn
Definition validation.h:343
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.
bool HasWitness() const
const std::vector< CTxOut > vout
const Wtxid & GetWitnessHash() const LIFETIMEBOUND
bool IsCoinBase() const
const Txid & GetHash() const LIFETIMEBOUND
const std::vector< CTxIn > vin
An input of a transaction.
Definition transaction.h:62
COutPoint prevout
Definition transaction.h:64
CTxMemPool::txiter TxHandle
Definition txmempool.h:632
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition txmempool.h:187
std::unique_ptr< ChangeSet > GetChangeSet() EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition txmempool.h:693
bool HasNoInputsOf(const CTransaction &tx) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Check that none of this transactions inputs are in the mempool, and thus the tx is not dependent on o...
setEntries GetIterSet(const std::set< Txid > &hashes) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Translate a set of hashes into a set of pool iterators to avoid repeated lookups.
std::optional< txiter > GetIter(const Txid &txid) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Returns an iterator to the given hash, if found.
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
Definition txmempool.h:258
CTransactionRef get(const Txid &hash) const
const Options m_opts
Definition txmempool.h:301
bool exists(const Txid &txid) const
Definition txmempool.h:501
std::set< txiter, CompareIteratorByHash > setEntries
Definition txmempool.h:266
std::vector< CTxMemPoolEntry::CTxMemPoolEntryRef > GetParents(const CTxMemPoolEntry &entry) const
Definition txmempool.cpp:74
uint64_t GetSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Definition txmempool.h:572
indexed_transaction_set::nth_index< 0 >::type::const_iterator txiter
Definition txmempool.h:263
uint64_t GetAndIncrementSequence() const EXCLUSIVE_LOCKS_REQUIRED(cs)
Guards this internal counter for external reporting.
Definition txmempool.h:568
const CTransaction * GetConflictTx(const COutPoint &prevout) const EXCLUSIVE_LOCKS_REQUIRED(cs)
Get the transaction in the pool that spends the same prevout.
unsigned long size() const
Definition txmempool.h:483
const CTxMemPoolEntry * GetEntry(const Txid &txid) const LIFETIMEBOUND EXCLUSIVE_LOCKS_REQUIRED(cs)
An output of a transaction.
CAmount nValue
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:438
CVerifyDB(kernel::Notifications &notifications)
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition validation.h:551
void InitCoinsCache(size_t cache_size_bytes) EXCLUSIVE_LOCKS_REQUIRED(bool CanFlushToDisk() const EXCLUSIVE_LOCKS_REQUIRED(
Definition validation.h:617
Mutex m_chainstate_mutex
The ChainState Mutex A lock that must be held when modifying this ChainState - held in ActivateBestCh...
Definition validation.h:558
CChain m_chain
Definition validation.h:625
CTxMemPool * GetMempool()
Definition validation.h:701
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:721
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:891
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
Definition validation.h:686
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:718
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:805
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:669
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)
Initialize the CoinsViews UTXO set database management data structures.
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:637
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:781
CTxMemPool * m_mempool
Definition validation.h:562
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
Definition validation.h:694
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:683
util::Result< void > InvalidateCoinsDBOnDisk() EXCLUSIVE_LOCKS_REQUIRED(friend ChainstateManager
In case of an invalid snapshot, rename the coins leveldb directory so that it can be examined for iss...
Definition validation.h:897
ChainstateManager & m_chainman
Definition validation.h:583
std::unique_ptr< CoinsViews > m_coins_views
Manages the UTXO set, which is a reflection of the contents of m_chain.
Definition validation.h:565
bool m_mempool cs
Definition validation.h:785
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)
Add a block to the candidate set if it has as much work as the current tip.
void PruneAndFlush()
bool ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size) EXCLUSIVE_LOCKS_REQUIRED(bool FlushStateToDisk(BlockValidationState &state, FlushStateMode mode, int nManualPruneHeight=0)
Update the on-disk chain state.
node::BlockManager & m_blockman
Definition validation.h:578
void ForceFlushStateToDisk(bool wipe_cache=true)
Flush all changes to disk.
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...
bool ActivateBestChainStep(BlockValidationState &state, CBlockIndex *pindexMostWork, const std::shared_ptr< const CBlock > &pblock, bool &fInvalidFound, ConnectTrace &connectTrace) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Try to make some progress towards making pindexMostWork the active block.
void ClearBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(void PopulateBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex * FindForkInGlobalIndex(const CBlockLocator &locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Populate the candidate set by calling TryAddBlockIndexCandidate on all valid block indices.
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)
Indirection necessary to make lock annotations work with an optional mempool.
Definition validation.h:843
Interface for managing multiple Chainstate objects, where each chainstate is associated with chainsta...
Definition validation.h:940
util::Result< void > PopulateAndValidateSnapshot(Chainstate &snapshot_chainstate, AutoFile &coins_file, const node::SnapshotMetadata &metadata)
kernel::ChainstateManagerOpts Options
Definition validation.h:999
Chainstate * HistoricalChainstate() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return historical chainstate targeting a specific block, if any.
ValidationCache m_validation_cache
SnapshotCompletionResult MaybeValidateSnapshot(Chainstate &validated_cs, Chainstate &unvalidated_cs) EXCLUSIVE_LOCKS_REQUIRED(Chainstate CurrentChainstate)() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Return current chainstate targeting the most-work, network tip.
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).
bool IsInitialBlockDownload() const noexcept
Check whether we are doing an initial block download (synchronizing from disk or network).
size_t m_total_coinstip_cache
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.
kernel::Notifications & GetNotifications() const
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.
CCheckQueue< CScriptCheck > m_script_check_queue
A queue for script verifications that have to be performed by worker threads.
Definition validation.h:978
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Chainstate & ActiveChainstate() const
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
void CheckBlockIndex() const
Make various assertions about the state of the block index.
const util::SignalInterrupt & m_interrupt
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())
VersionBitsCache m_versionbitscache
Track versionbit status.
const CChainParams & GetParams() const
void GenerateCoinbaseCommitment(CBlock &block, const CBlockIndex *pindexPrev) const
Produce the necessary coinbase commitment for a block (modifies the hash, don't call for mined blocks...
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
ChainstateManager(const util::SignalInterrupt &interrupt, Options options, node::BlockManager::Options blockman_options)
const arith_uint256 & MinimumChainWork() const
void UpdateIBDStatus() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Update and possibly latch the IBD status.
const Options m_options
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)
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
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(int64_t height, int64_t timestamp)
This is used by net_processing to report pre-synchronization progress of headers, as headers are not ...
std::atomic_bool m_cached_is_ibd
Whether initial block download (IBD) is ongoing.
bool NotifyHeaderTip() LOCKS_EXCLUDED(GetMutex())
void MaybeRebalanceCaches() EXCLUSIVE_LOCKS_REQUIRED(void UpdateUncommittedBlockStructures(CBlock &block, const CBlockIndex *pindexPrev) const
Update uncommitted block structures (currently: only the witness reserved value).
node::BlockManager m_blockman
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:35
bool IsCoinBase() const
Definition coins.h:59
CTxOut out
unspent transaction output
Definition coins.h:38
bool IsSpent() const
Either this coin never existed (see e.g.
Definition coins.h:83
uint32_t nHeight
at which height this containing transaction was included in the active block chain
Definition coins.h:44
unsigned int fCoinBase
whether containing transaction was a coinbase
Definition coins.h:41
CoinsViews(DBParams db_params, CoinsViewOptions options)
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)
void insert(Element e)
insert loops at most depth_limit times trying to insert a hash at various locations in the table via ...
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.
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
I randrange(I range) noexcept
Generate a random integer in the range [0..range), with range > 0.
Definition random.h:254
Convenience class for initializing and passing the script execution cache and signature cache.
Definition validation.h:371
ValidationCache(size_t script_execution_cache_bytes, size_t signature_cache_bytes)
CuckooCache::cache< uint256, SignatureCacheHasher > m_script_execution_cache
Definition validation.h:377
CSHA256 ScriptExecutionCacheHasher() const
Return a copy of the pre-initialized hasher.
Definition validation.h:386
CSHA256 m_script_execution_cache_hasher
Pre-initialized hasher to avoid having to recreate it for every hash calculation.
Definition validation.h:374
SignatureCache m_signature_cache
Definition validation.h:378
void TransactionAddedToMempool(const NewMempoolTransactionInfo &, uint64_t mempool_sequence)
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
256-bit unsigned big integer.
constexpr bool IsNull() const
Definition uint256.h:48
constexpr unsigned char * begin()
Definition uint256.h:100
std::string ToString() const
Definition uint256.cpp:21
constexpr const unsigned char * data() const
Definition uint256.h:97
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)
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
CBlockIndex * LookupBlockIndex(const uint256 &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
bool ReadBlock(CBlock &block, const FlatFilePos &pos, const std::optional< uint256 > &expected_hash) const
Functions for disk access for blocks.
bool IsPruneMode() const
Whether running in -prune mode.
kernel::BlockManagerOpts Options
constexpr const std::byte * begin() const
const uint256 & ToUint256() const LIFETIMEBOUND
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)
Definition coins.cpp:386
void AddCoins(CCoinsViewCache &cache, const CTransaction &tx, int nHeight, bool check_for_overwrite)
Definition coins.cpp:142
int ApplyTxInUndo(Coin &&undo, CCoinsViewCache &view, const COutPoint &out)
Restore the UTXO in a Coin at a given COutPoint.
void UpdateCoins(const CTransaction &tx, CCoinsViewCache &inputs, CTxUndo &txundo, int nHeight)
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
Definition validation.h:66
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
Definition validation.h:61
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
Definition validation.h:60
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
Definition validation.h:59
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
Definition validation.h:63
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
Definition validation.h:64
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
Definition validation.h:62
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
Definition validation.h:65
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
Definition validation.h:28
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/RBF/etc limits
Definition validation.h:46
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
Definition validation.h:29
@ TX_INPUTS_NOT_STANDARD
inputs (covered by txid) failed policy rules
Definition validation.h:26
@ TX_WITNESS_STRIPPED
Transaction is missing a witness.
Definition validation.h:39
@ TX_CONFLICT
Tx already in mempool or conflicts with a tx in the chain (if it conflicts with another tx in mempool...
Definition validation.h:45
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
Definition validation.h:27
@ TX_WITNESS_MUTATED
Transaction might have a witness prior to SegWit activation, or witness may have been malleated (whic...
Definition validation.h:35
@ TX_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
Definition validation.h:47
@ TX_CONSENSUS
invalid by consensus rules
Definition validation.h:25
@ TX_RECONSIDERABLE
fails some policy, but might be acceptable if submitted in a (different) package
Definition validation.h:48
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:39
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)
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
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
bool VerifyScript(const CScript &scriptSig, const CScript &scriptPubKey, const CScriptWitness *witness, script_verify_flags flags, const BaseSignatureChecker &checker, ScriptError *serror)
#define LogPrintLevel_(category, level, should_ratelimit,...)
Definition log.h:89
#define LogWarning(...)
Definition log.h:96
#define LogInfo(...)
Definition log.h:95
#define LogError(...)
Definition log.h:97
#define LogDebug(category,...)
Definition log.h:115
unsigned int nHeight
LockPoints lp
@ REORG
Removed for reorganization.
std::array< uint8_t, 4 > MessageStartChars
unsigned int nonce
@ COINDB
Definition categories.h:34
@ REINDEX
Definition categories.h:27
@ TXPACKAGES
Definition categories.h:46
@ VALIDATION
Definition categories.h:37
@ PRUNE
Definition categories.h:30
@ MEMPOOL
Definition categories.h:18
@ BENCH
Definition categories.h:20
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...
@ 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
std::function< FILE *(const fs::path &, const char *)> FopenFn
Definition fs.h:192
bool IsInterrupted(const T &result)
@ UNKNOWN_NEW_RULES_ACTIVATED
Definition warning.h:10
@ LARGE_WORK_INVALID_CHAIN
Definition warning.h:11
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point, std::unique_ptr< CCoinsViewCursor > pcursor)
Calculate statistics about the unspent transaction output set.
CoinStatsHashType
Definition coinstats.h:26
const fs::path SNAPSHOT_BLOCKHASH_FILENAME
std::unordered_map< uint256, CBlockIndex, BlockHasher > BlockMap
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_vie SNAPSHOT_CHAINSTATE_SUFFIX)
std::optional< uint256 > ReadSnapshotBaseBlockhash(fs::path chaindir)
Definition common.h:29
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:246
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition string.h:205
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)
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).
Definition packages.h:38
@ PCKG_MEMPOOL_ERROR
Mempool logic error.
Definition packages.h:40
@ PCKG_TX
At least one tx is invalid.
Definition packages.h:39
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.
Definition rbf.h:42
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:118
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:137
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:43
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:39
static constexpr script_verify_flags STANDARD_NOT_MANDATORY_VERIFY_FLAGS
For convenience, standard but not mandatory verify flags.
Definition policy.h:134
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
static constexpr TransactionSerParams TX_WITH_WITNESS
static CTransactionRef MakeTransactionRef(Tx &&txIn)
std::shared_ptr< const CTransaction > CTransactionRef
uint256 GetRandHash() noexcept
Generate a random uint256.
Definition random.h:463
const char * prefix
Definition rest.cpp:1141
@ OP_RETURN
Definition script.h:111
std::string ScriptErrorString(const ScriptError serror)
enum ScriptError_t ScriptError
@ SCRIPT_ERR_UNKNOWN_ERROR
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:34
AssumeutxoHash hash_serialized
The expected hash of the deserialized UTXO set.
Definition chainparams.h:38
uint64_t m_chain_tx_count
Definition chainparams.h:44
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition block.h:117
std::vector< uint256 > vHave
Definition block.h:127
A mutable version of CTransaction.
std::vector< CTxOut > vout
std::vector< CTxIn > vin
Holds various statistics on transactions within a chain.
Definition chainparams.h:57
User-controlled performance and debug options.
Definition txdb.h:28
Parameters that influence chain consensus.
Definition params.h:84
bool enforce_BIP94
Enforce BIP94 timewarp attack mitigation.
Definition params.h:118
uint256 BIP34Hash
Definition params.h:96
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 BIP34Height
Block height and hash at which BIP34 becomes active.
Definition params.h:95
int nSubsidyHalvingInterval
Definition params.h:86
std::map< uint256, script_verify_flags > script_flag_exceptions
Hashes of blocks that.
Definition params.h:93
uint256 hashGenesisBlock
Definition params.h:85
int64_t nPowTargetSpacing
Definition params.h:120
std::chrono::seconds PowTargetSpacing() const
Definition params.h:122
Application-specific storage settings.
Definition dbwrapper.h:33
int64_t fee
Definition feefrac.h:107
int32_t size
Definition feefrac.h:108
uint32_t nPos
Definition flatfile.h:17
bool IsNull() const
Definition flatfile.h:32
int32_t nFile
Definition flatfile.h:16
int64_t time
Validation result for a transaction evaluated by MemPoolAccept (single or package).
Definition validation.h:131
const ResultType m_result_type
Result type.
Definition validation.h:140
const TxValidationState m_state
Contains information about why the transaction failed.
Definition validation.h:143
static MempoolAcceptResult Failure(TxValidationState state)
Definition validation.h:167
static MempoolAcceptResult FeeFailure(TxValidationState state, CFeeRate effective_feerate, const std::vector< Wtxid > &wtxids_fee_calculations)
Definition validation.h:171
static MempoolAcceptResult MempoolTxDifferentWitness(const Wtxid &other_wtxid)
Definition validation.h:190
static MempoolAcceptResult MempoolTx(int64_t vsize, CAmount fees)
Definition validation.h:186
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:177
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition time.cpp:57
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition time.cpp:30
Validation result for package mempool acceptance.
Definition validation.h:237
std::shared_ptr< const CBlock > pblock
PerBlockConnectTrace()=default
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.
std::vector< CTxOut > m_spent_outputs
const char * what() const noexcept override
Bilingual messages:
Definition translation.h:24
std::string original
Definition translation.h:25
std::optional< int32_t > check_block_index
Information about chainstate that notifications are sent from.
Definition types.h:18
std::optional< unsigned > max_datacarrier_bytes
A data carrying output is an unspendable output containing data.
ValidationSignals * signals
#define AssertLockNotHeld(cs)
Definition sync.h:141
#define LOCK(cs)
Definition sync.h:258
#define WITH_LOCK(cs, code)
Definition sync.h:289
#define AssertLockHeld(cs)
Definition sync.h:136
#define EXCLUSIVE_LOCKS_REQUIRED(...)
#define LOCKS_EXCLUDED(...)
#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...
#define TRACEPOINT(context,...)
Definition trace.h:56
#define TRACEPOINT_SEMAPHORE(context, event)
Definition trace.h:54
transaction_identifier< true > Wtxid
Wtxid commits to all transaction fields including the witness.
transaction_identifier< false > Txid
Txid commits to all transaction fields except the witness.
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.
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.
unsigned int GetLegacySigOpCount(const CTransaction &tx)
Auxiliary functions for transaction validation (ideally should not be exposed).
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.
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
static CTxMemPool::Options && Flatten(CTxMemPool::Options &&opts, bilingual_str &error)
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:50
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) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Check whether all of this transaction's input scripts succeed.
#define expect(bit)
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition time.cpp:81
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition time.cpp:83
constexpr auto TicksSinceEpoch(Timepoint t)
Definition time.h:84
constexpr int64_t count_seconds(std::chrono::seconds t)
Definition time.h:88
std::chrono::time_point< NodeClock, std::chrono::seconds > NodeSeconds
Definition time.h:25
constexpr auto Ticks(Dur2 d)
Helper to count the seconds of a duration/time_point.
Definition time.h:73
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(
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)
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.
bool CheckFinalTxAtTip(const CBlockIndex &active_chain_tip, const CTransaction &tx)
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.
bool HasValidProofOfWork(std::span< const CBlockHeader > headers, const Consensus::Params &consensusParams)
Check that the proof of work on each blockheader matches the value in nBits.
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.
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(
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 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.
arith_uint256 CalculateClaimedHeadersWork(std::span< const CBlockHeader > headers)
Return the sum of the claimed work on a given set of headers.
static bool ComputeUTXOStats(CCoinsView *view, CCoinsStats &stats, T hash_obj, const std::function< void()> &interruption_point, std::unique_ptr< CCoinsViewCursor > pcursor)
Calculate statistics about the unspent transaction output set.
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
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.
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)
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 bool ShouldCompactChainstate(bool in_ibd)
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).
static void LimitValidationInterfaceQueue(ValidationSignals &signals) LOCKS_EXCLUDED(cs_main)
assert(!tx.IsCoinBase())
script_verify_flags GetBlockScriptFlags(const CBlockIndex &block_index, const ChainstateManager &chainman)
static constexpr int MAX_SCRIPTCHECK_THREADS
Maximum number of dedicated script-checking threads allowed.
Definition validation.h:90
bool CheckFinalTxAtTip(const CBlockIndex &active_chain_tip, const CTransaction &tx) EXCLUSIVE_LOCKS_REQUIRED(std::optional< LockPoints CalculateLockPointsAtTip)(CBlockIndex *tip, const CCoinsView &coins_view, const CTransaction &tx)
Check if transaction will be final in the next block to be created.
Definition validation.h:317
CAmount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
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.
bool FatalError(kernel::Notifications &notifications, BlockValidationState &state, const bilingual_str &message)
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:76
MempoolAcceptResult AcceptToMemoryPool(Chainstate &active_chainstate, const CTransactionRef &tx, int64_t accept_time, bool bypass_limits, bool test_accept) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the mempool.
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const ChainstateManager &chainman, DEP dep)
Deployment* info via ChainstateManager.
SnapshotCompletionResult
Definition validation.h:902
Assumeutxo
Chainstate assumeutxo validity.
Definition validation.h:527
@ VALIDATED
Every block in the chain has been validated.
Definition validation.h:529
@ UNVALIDATED
Blocks after an assumeutxo snapshot have been validated but the snapshot itself has not been validate...
Definition validation.h:531
@ INVALID
The assumeutxo snapshot failed validation.
Definition validation.h:533
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition validation.h:93
constexpr std::array FlushStateModeNames
Definition validation.h:461
constexpr int64_t LargeCoinsCacheThreshold(int64_t total_space) noexcept
Definition validation.h:518
VerifyDBResult
Definition validation.h:426
bool CheckBlock(const CBlock &block, BlockValidationState &state, const Consensus::Params &consensusParams, bool fCheckPOW=true, bool fCheckMerkleRoot=true)
Functions for validating blocks and updating the block tree.
FlushStateMode
Definition validation.h:462
CoinsCacheSizeState
Definition validation.h:510
@ LARGE
The cache is at >= 90% capacity.
Definition validation.h:514
@ CRITICAL
The coins cache is in immediate need of a flush.
Definition validation.h:512
bool DeploymentActiveAt(const CBlockIndex &index, const ChainstateManager &chainman, DEP dep)
bool IsBIP30Repeat(const CBlockIndex &block_index)
Identifies blocks that overwrote an existing coinbase output in the UTXO set (see BIP30).
DisconnectResult
Definition validation.h:452
@ DISCONNECT_FAILED
Definition validation.h:455
@ DISCONNECT_UNCLEAN
Definition validation.h:454
@ DISCONNECT_OK
Definition validation.h:453