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