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