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