Bitcoin ABC 0.33.11
P2P Digital Currency
validation.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-2018 The Bitcoin Core developers
3// Copyright (c) 2017-2020 The Bitcoin developers
4// Distributed under the MIT software license, see the accompanying
5// file COPYING or http://www.opensource.org/licenses/mit-license.php.
6
7#include <validation.h>
8
9#include <kernel/chain.h>
10#include <kernel/chainparams.h>
11#include <kernel/coinstats.h>
14
15#include <arith_uint256.h>
16#include <avalanche/avalanche.h>
17#include <avalanche/processor.h>
18#include <blockvalidity.h>
19#include <chainparams.h>
20#include <checkpoints.h>
21#include <checkqueue.h>
22#include <config.h>
24#include <consensus/amount.h>
25#include <consensus/merkle.h>
26#include <consensus/tx_check.h>
27#include <consensus/tx_verify.h>
29#include <hash.h>
31#include <logging.h>
32#include <logging/timer.h>
33#include <minerfund.h>
34#include <node/blockstorage.h>
35#include <node/utxo_snapshot.h>
38#include <policy/block/rtt.h>
40#include <policy/policy.h>
41#include <policy/settings.h>
42#include <pow/pow.h>
43#include <primitives/block.h>
45#include <random.h>
46#include <reverse_iterator.h>
47#include <script/script.h>
48#include <script/scriptcache.h>
49#include <script/sigcache.h>
50#include <tinyformat.h>
51#include <txdb.h>
52#include <txmempool.h>
53#include <undo.h>
54#include <util/check.h>
55#include <util/fs.h>
56#include <util/fs_helpers.h>
58#include <util/strencodings.h>
59#include <util/string.h>
60#include <util/time.h>
61#include <util/trace.h>
62#include <util/translation.h>
63#include <validationinterface.h>
64#include <warnings.h>
65
66#include <algorithm>
67#include <atomic>
68#include <cassert>
69#include <chrono>
70#include <deque>
71#include <numeric>
72#include <optional>
73#include <string>
74#include <thread>
75#include <tuple>
76
81
84using node::BlockMap;
86
93static constexpr auto DATABASE_WRITE_INTERVAL_MIN{50min};
94static constexpr auto DATABASE_WRITE_INTERVAL_MAX{70min};
95const std::vector<std::string> CHECKLEVEL_DOC{
96 "level 0 reads the blocks from disk",
97 "level 1 verifies block validity",
98 "level 2 verifies undo data",
99 "level 3 checks disconnection of tip blocks",
100 "level 4 tries to reconnect the blocks",
101 "each level includes the checks of the previous levels",
102};
109static constexpr int PRUNE_LOCK_BUFFER{10};
110
111static constexpr uint64_t HEADERS_TIME_VERSION{1};
112
114std::condition_variable g_best_block_cv;
116
118 : excessiveBlockSize(config.GetMaxBlockSize()), checkPoW(true),
119 checkMerkleRoot(true) {}
120
121const CBlockIndex *
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 BlockHash &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
141static uint32_t GetNextBlockScriptFlags(const CBlockIndex *pindex,
142 const ChainstateManager &chainman);
143
144namespace {
156std::optional<std::vector<int>> CalculatePrevHeights(const CBlockIndex &tip,
157 const CCoinsView &coins,
158 const CTransaction &tx) {
159 std::vector<int> prev_heights;
160 prev_heights.resize(tx.vin.size());
161 for (size_t i = 0; i < tx.vin.size(); ++i) {
162 if (auto coin{coins.GetCoin(tx.vin[i].prevout)}) {
163 // Assume all mempool transaction confirm in the next block.
164 prev_heights[i] = coin->GetHeight() == MEMPOOL_HEIGHT
165 ? tip.nHeight + 1
166 : coin->GetHeight();
167 } else {
168 LogPrintf("ERROR: %s: Missing input %d in transaction \'%s\'\n",
169 __func__, i, tx.GetHash().GetHex());
170 return std::nullopt;
171 }
172 }
173 return prev_heights;
174}
175} // namespace
176
177std::optional<LockPoints> CalculateLockPointsAtTip(CBlockIndex *tip,
178 const CCoinsView &coins_view,
179 const CTransaction &tx) {
180 assert(tip);
181
182 auto prev_heights{CalculatePrevHeights(*tip, coins_view, tx)};
183 if (!prev_heights.has_value()) {
184 return std::nullopt;
185 }
186
187 CBlockIndex next_tip;
188 next_tip.pprev = tip;
189 // When SequenceLocks() is called within ConnectBlock(), the height
190 // of the block *being* evaluated is what is used.
191 // Thus if we want to know if a transaction can be part of the
192 // *next* block, we need to use one more than
193 // active_chainstate.m_chain.Height()
194 next_tip.nHeight = tip->nHeight + 1;
195 const auto [min_height, min_time] = CalculateSequenceLocks(
196 tx, STANDARD_LOCKTIME_VERIFY_FLAGS, prev_heights.value(), next_tip);
197
198 return LockPoints{min_height, min_time};
199}
200
201bool CheckSequenceLocksAtTip(CBlockIndex *tip, const LockPoints &lock_points) {
202 assert(tip != nullptr);
203
204 CBlockIndex index;
205 index.pprev = tip;
206 // CheckSequenceLocksAtTip() uses active_chainstate.m_chain.Height()+1 to
207 // evaluate height based locks because when SequenceLocks() is called within
208 // ConnectBlock(), the height of the block *being* evaluated is what is
209 // used. Thus if we want to know if a transaction can be part of the *next*
210 // block, we need to use one more than active_chainstate.m_chain.Height()
211 index.nHeight = tip->nHeight + 1;
212
213 return EvaluateSequenceLocks(index, {lock_points.height, lock_points.time});
214}
215
216// Command-line argument "-replayprotectionactivationtime=<timestamp>" will
217// cause the node to switch to replay protected SigHash ForkID value when the
218// median timestamp of the previous 11 blocks is greater than or equal to
219// <timestamp>. Defaults to the pre-defined timestamp when not set.
220static bool
222 const CBlockIndex *pindexPrev,
223 const std::optional<int64_t> activation_time) {
224 if (pindexPrev == nullptr) {
225 return false;
226 }
227
228 return pindexPrev->GetMedianTimePast() >=
229 activation_time.value_or(params.mengerActivationTime);
230}
231
238 const CTransaction &tx, TxValidationState &state,
239 const CCoinsViewCache &view, const CTxMemPool &pool, const uint32_t flags,
240 PrecomputedTransactionData &txdata, ValidationCache &validation_cache,
241 int &nSigChecksOut, CCoinsViewCache &coins_tip)
245
246 assert(!tx.IsCoinBase());
247 for (const CTxIn &txin : tx.vin) {
248 const Coin &coin = view.AccessCoin(txin.prevout);
249
250 // This coin was checked in PreChecks and MemPoolAccept
251 // has been holding cs_main since then.
252 Assume(!coin.IsSpent());
253 if (coin.IsSpent()) {
254 return false;
255 }
256
257 // If the Coin is available, there are 2 possibilities:
258 // it is available in our current ChainstateActive UTXO set,
259 // or it's a UTXO provided by a transaction in our mempool.
260 // Ensure the scriptPubKeys in Coins from CoinsView are correct.
261 const CTransactionRef &txFrom = pool.get(txin.prevout.GetTxId());
262 if (txFrom) {
263 assert(txFrom->GetId() == txin.prevout.GetTxId());
264 assert(txFrom->vout.size() > txin.prevout.GetN());
265 assert(txFrom->vout[txin.prevout.GetN()] == coin.GetTxOut());
266 } else {
267 const Coin &coinFromUTXOSet = coins_tip.AccessCoin(txin.prevout);
268 assert(!coinFromUTXOSet.IsSpent());
269 assert(coinFromUTXOSet.GetTxOut() == coin.GetTxOut());
270 }
271 }
272
273 // Call CheckInputScripts() to cache signature and script validity against
274 // current tip consensus rules.
275 return CheckInputScripts(tx, state, view, flags, /*sigCacheStore=*/true,
276 /*scriptCacheStore=*/true, txdata,
277 validation_cache, nSigChecksOut);
278}
279
280namespace {
281
282class MemPoolAccept {
283public:
284 MemPoolAccept(CTxMemPool &mempool, Chainstate &active_chainstate)
285 : m_pool(mempool), m_view(&m_dummy),
286 m_viewmempool(&active_chainstate.CoinsTip(), m_pool),
287 m_active_chainstate(active_chainstate) {}
288
289 // We put the arguments we're handed into a struct, so we can pass them
290 // around easier.
291 struct ATMPArgs {
292 const Config &m_config;
293 const int64_t m_accept_time;
294 const bool m_bypass_limits;
295 /*
296 * Return any outpoints which were not previously present in the coins
297 * cache, but were added as a result of validating the tx for mempool
298 * acceptance. This allows the caller to optionally remove the cache
299 * additions if the associated transaction ends up being rejected by
300 * the mempool.
301 */
302 std::vector<COutPoint> &m_coins_to_uncache;
303 const bool m_test_accept;
304 const unsigned int m_heightOverride;
310 const bool m_package_submission;
316 const bool m_package_feerates;
317
319 static ATMPArgs SingleAccept(const Config &config, int64_t accept_time,
320 bool bypass_limits,
321 std::vector<COutPoint> &coins_to_uncache,
322 bool test_accept,
323 unsigned int heightOverride) {
324 return ATMPArgs{
325 config,
326 accept_time,
327 bypass_limits,
328 coins_to_uncache,
329 test_accept,
330 heightOverride,
331 /*package_submission=*/false,
332 /*package_feerates=*/false,
333 };
334 }
335
340 static ATMPArgs
341 PackageTestAccept(const Config &config, int64_t accept_time,
342 std::vector<COutPoint> &coins_to_uncache) {
343 return ATMPArgs{
344 config,
345 accept_time,
346 /*bypass_limits=*/false,
347 coins_to_uncache,
348 /*test_accept=*/true,
349 /*height_override=*/0,
350 // not submitting to mempool
351 /*package_submission=*/false,
352 /*package_feerates=*/false,
353 };
354 }
355
357 static ATMPArgs
358 PackageChildWithParents(const Config &config, int64_t accept_time,
359 std::vector<COutPoint> &coins_to_uncache) {
360 return ATMPArgs{
361 config,
362 accept_time,
363 /*bypass_limits=*/false,
364 coins_to_uncache,
365 /*test_accept=*/false,
366 /*height_override=*/0,
367 /*package_submission=*/true,
368 /*package_feerates=*/true,
369 };
370 }
371
373 static ATMPArgs SingleInPackageAccept(const ATMPArgs &package_args) {
374 return ATMPArgs{
375 /*config=*/package_args.m_config,
376 /*accept_time=*/package_args.m_accept_time,
377 /*bypass_limits=*/false,
378 /*coins_to_uncache=*/package_args.m_coins_to_uncache,
379 /*test_accept=*/package_args.m_test_accept,
380 /*height_override=*/package_args.m_heightOverride,
381 // do not LimitMempoolSize in Finalize()
382 /*package_submission=*/true,
383 // only 1 transaction
384 /*package_feerates=*/false,
385 };
386 }
387
388 private:
389 // Private ctor to avoid exposing details to clients and allowing the
390 // possibility of mixing up the order of the arguments. Use static
391 // functions above instead.
392 ATMPArgs(const Config &config, int64_t accept_time, bool bypass_limits,
393 std::vector<COutPoint> &coins_to_uncache, bool test_accept,
394 unsigned int height_override, bool package_submission,
395 bool package_feerates)
396 : m_config{config}, m_accept_time{accept_time},
397 m_bypass_limits{bypass_limits},
398 m_coins_to_uncache{coins_to_uncache}, m_test_accept{test_accept},
399 m_heightOverride{height_override},
400 m_package_submission{package_submission},
401 m_package_feerates(package_feerates) {}
402 };
403
404 // Single transaction acceptance
405 MempoolAcceptResult AcceptSingleTransaction(const CTransactionRef &ptx,
406 ATMPArgs &args)
408
416 AcceptMultipleTransactions(const std::vector<CTransactionRef> &txns,
417 ATMPArgs &args)
419
433 AcceptSubPackage(const std::vector<CTransactionRef> &subpackage,
434 ATMPArgs &args)
436
442 PackageMempoolAcceptResult AcceptPackage(const Package &package,
443 ATMPArgs &args)
445
446private:
447 // All the intermediate state that gets passed between the various levels
448 // of checking a given transaction.
449 struct Workspace {
450 Workspace(const CTransactionRef &ptx,
451 const uint32_t next_block_script_verify_flags)
452 : m_ptx(ptx),
453 m_next_block_script_verify_flags(next_block_script_verify_flags) {
454 }
460 std::unique_ptr<CTxMemPoolEntry> m_entry;
461
466 int64_t m_vsize;
471 Amount m_base_fees;
472
477 Amount m_modified_fees;
478
485 CFeeRate m_package_feerate{Amount::zero()};
486
487 const CTransactionRef &m_ptx;
488 TxValidationState m_state;
494 PrecomputedTransactionData m_precomputed_txdata;
495
496 // ABC specific flags that are used in both PreChecks and
497 // ConsensusScriptChecks
498 const uint32_t m_next_block_script_verify_flags;
499 int m_sig_checks_standard;
500 };
501
502 // Run the policy checks on a given transaction, excluding any script
503 // checks. Looks up inputs, calculates feerate, considers replacement,
504 // evaluates package limits, etc. As this function can be invoked for "free"
505 // by a peer, only tests that are fast should be done here (to avoid CPU
506 // DoS).
507 bool PreChecks(ATMPArgs &args, Workspace &ws)
509
510 // Re-run the script checks, using consensus flags, and try to cache the
511 // result in the scriptcache. This should be done after
512 // PolicyScriptChecks(). This requires that all inputs either be in our
513 // utxo set or in the mempool.
514 bool ConsensusScriptChecks(const ATMPArgs &args, Workspace &ws)
516
517 // Try to add the transaction to the mempool, removing any conflicts first.
518 // Returns true if the transaction is in the mempool after any size
519 // limiting is performed, false otherwise.
520 bool Finalize(const ATMPArgs &args, Workspace &ws)
522
523 // Submit all transactions to the mempool and call ConsensusScriptChecks to
524 // add to the script cache - should only be called after successful
525 // validation of all transactions in the package.
526 // Does not call LimitMempoolSize(), so mempool max_size_bytes may be
527 // temporarily exceeded.
528 bool SubmitPackage(const ATMPArgs &args, std::vector<Workspace> &workspaces,
529 PackageValidationState &package_state,
530 std::map<TxId, MempoolAcceptResult> &results)
532
533 // Compare a package's feerate against minimum allowed.
534 bool CheckFeeRate(size_t package_size, size_t package_vsize,
535 Amount package_fee, TxValidationState &state)
538 AssertLockHeld(m_pool.cs);
539
540 const Amount mempoolRejectFee =
541 m_pool.GetMinFee().GetFee(package_vsize);
542
543 if (mempoolRejectFee > Amount::zero() &&
544 package_fee < mempoolRejectFee) {
545 return state.Invalid(
547 "mempool min fee not met",
548 strprintf("%d < %d", package_fee, mempoolRejectFee));
549 }
550
551 // Do not change this to use virtualsize without coordinating a network
552 // policy upgrade.
553 if (package_fee <
554 m_pool.m_opts.min_relay_feerate.GetFee(package_size)) {
555 return state.Invalid(
557 "min relay fee not met",
558 strprintf(
559 "%d < %d", package_fee,
560 m_pool.m_opts.min_relay_feerate.GetFee(package_size)));
561 }
562
563 return true;
564 }
565
566 ValidationCache &GetValidationCache() {
567 return m_active_chainstate.m_chainman.m_validation_cache;
568 }
569
570private:
571 CTxMemPool &m_pool;
572 CCoinsViewCache m_view;
573 CCoinsViewMemPool m_viewmempool;
574 CCoinsView m_dummy;
575
576 Chainstate &m_active_chainstate;
577};
578
579bool MemPoolAccept::PreChecks(ATMPArgs &args, Workspace &ws) {
581 AssertLockHeld(m_pool.cs);
582 const CTransactionRef &ptx = ws.m_ptx;
583 const CTransaction &tx = *ws.m_ptx;
584 const TxId &txid = ws.m_ptx->GetId();
585
586 // Copy/alias what we need out of args
587 const int64_t nAcceptTime = args.m_accept_time;
588 const bool bypass_limits = args.m_bypass_limits;
589 std::vector<COutPoint> &coins_to_uncache = args.m_coins_to_uncache;
590 const unsigned int heightOverride = args.m_heightOverride;
591
592 // Alias what we need out of ws
593 TxValidationState &state = ws.m_state;
594 // Coinbase is only valid in a block, not as a loose transaction.
595 if (!CheckRegularTransaction(tx, state)) {
596 // state filled in by CheckRegularTransaction.
597 return false;
598 }
599
600 // Rather not work on nonstandard transactions (unless -testnet)
601 std::string reason;
602 if (m_pool.m_opts.require_standard &&
603 !IsStandardTx(tx, m_pool.m_opts.max_datacarrier_bytes,
604 m_pool.m_opts.permit_bare_multisig,
605 m_pool.m_opts.dust_relay_feerate, reason)) {
606 return state.Invalid(TxValidationResult::TX_NOT_STANDARD, reason);
607 }
608
609 // Only accept nLockTime-using transactions that can be mined in the next
610 // block; we don't want our mempool filled up with transactions that can't
611 // be mined yet.
612 TxValidationState ctxState;
614 *Assert(m_active_chainstate.m_chain.Tip()),
615 args.m_config.GetChainParams().GetConsensus(), tx, ctxState)) {
616 // We copy the state from a dummy to ensure we don't increase the
617 // ban score of peer for transaction that could be valid in the future.
619 ctxState.GetRejectReason(),
620 ctxState.GetDebugMessage());
621 }
622
623 // Is it already in the memory pool?
624 if (m_pool.exists(txid)) {
626 "txn-already-in-mempool");
627 }
628
629 // Check for conflicts with in-memory transactions
630 for (const CTxIn &txin : tx.vin) {
631 if (const auto ptxConflicting = m_pool.GetConflictTx(txin.prevout)) {
632 if (m_pool.isAvalancheFinalizedPreConsensus(
633 ptxConflicting->GetId())) {
635 "finalized-tx-conflict");
636 }
637
638 return state.Invalid(
640 "txn-mempool-conflict");
641 }
642 }
643
644 m_view.SetBackend(m_viewmempool);
645
646 const CCoinsViewCache &coins_cache = m_active_chainstate.CoinsTip();
647 // Do all inputs exist?
648 for (const CTxIn &txin : tx.vin) {
649 if (!coins_cache.HaveCoinInCache(txin.prevout)) {
650 coins_to_uncache.push_back(txin.prevout);
651 }
652
653 // Note: this call may add txin.prevout to the coins cache
654 // (coins_cache.cacheCoins) by way of FetchCoin(). It should be
655 // removed later (via coins_to_uncache) if this tx turns out to be
656 // invalid.
657 if (!m_view.HaveCoin(txin.prevout)) {
658 // Are inputs missing because we already have the tx?
659 for (size_t out = 0; out < tx.vout.size(); out++) {
660 // Optimistically just do efficient check of cache for
661 // outputs.
662 if (coins_cache.HaveCoinInCache(COutPoint(txid, out))) {
664 "txn-already-known");
665 }
666 }
667
668 // Otherwise assume this might be an orphan tx for which we just
669 // haven't seen parents yet.
671 "bad-txns-inputs-missingorspent");
672 }
673 }
674
675 // Are the actual inputs available?
676 if (!m_view.HaveInputs(tx)) {
678 "bad-txns-inputs-spent");
679 }
680
681 // Bring the best block into scope.
682 m_view.GetBestBlock();
683
684 // we have all inputs cached now, so switch back to dummy (to protect
685 // against bugs where we pull more inputs from disk that miss being
686 // added to coins_to_uncache)
687 m_view.SetBackend(m_dummy);
688
689 assert(m_active_chainstate.m_blockman.LookupBlockIndex(
690 m_view.GetBestBlock()) == m_active_chainstate.m_chain.Tip());
691
692 // Only accept BIP68 sequence locked transactions that can be mined in
693 // the next block; we don't want our mempool filled up with transactions
694 // that can't be mined yet.
695 // Pass in m_view which has all of the relevant inputs cached. Note that,
696 // since m_view's backend was removed, it no longer pulls coins from the
697 // mempool.
698 const std::optional<LockPoints> lock_points{CalculateLockPointsAtTip(
699 m_active_chainstate.m_chain.Tip(), m_view, tx)};
700 if (!lock_points.has_value() ||
701 !CheckSequenceLocksAtTip(m_active_chainstate.m_chain.Tip(),
702 *lock_points)) {
704 "non-BIP68-final");
705 }
706
707 // The mempool holds txs for the next block, so pass height+1 to
708 // CheckTxInputs
709 if (!Consensus::CheckTxInputs(tx, state, m_view,
710 m_active_chainstate.m_chain.Height() + 1,
711 ws.m_base_fees)) {
712 // state filled in by CheckTxInputs
713 return false;
714 }
715
716 // Check for non-standard pay-to-script-hash in inputs
717 if (m_pool.m_opts.require_standard &&
718 !AreInputsStandard(tx, m_view, ws.m_next_block_script_verify_flags)) {
720 "bad-txns-nonstandard-inputs");
721 }
722
723 // ws.m_modified_fess includes any fee deltas from PrioritiseTransaction
724 ws.m_modified_fees = ws.m_base_fees;
725 m_pool.ApplyDelta(txid, ws.m_modified_fees);
726
727 unsigned int nSize = tx.GetTotalSize();
728
729 // Validate input scripts against standard script flags.
730 const uint32_t scriptVerifyFlags =
731 ws.m_next_block_script_verify_flags | STANDARD_SCRIPT_VERIFY_FLAGS;
732 ws.m_precomputed_txdata = PrecomputedTransactionData{tx};
733 if (!CheckInputScripts(tx, state, m_view, scriptVerifyFlags, true, false,
734 ws.m_precomputed_txdata, GetValidationCache(),
735 ws.m_sig_checks_standard)) {
736 // State filled in by CheckInputScripts
737 return false;
738 }
739
740 ws.m_entry = std::make_unique<CTxMemPoolEntry>(
741 ptx, ws.m_base_fees, nAcceptTime,
742 heightOverride ? heightOverride : m_active_chainstate.m_chain.Height(),
743 ws.m_sig_checks_standard, lock_points.value());
744
745 ws.m_vsize = ws.m_entry->GetTxVirtualSize();
746
747 // No individual transactions are allowed below the min relay feerate except
748 // from disconnected blocks. This requirement, unlike CheckFeeRate, cannot
749 // be bypassed using m_package_feerates because, while a tx could be package
750 // CPFP'd when entering the mempool, we do not have a DoS-resistant method
751 // of ensuring the tx remains bumped. For example, the fee-bumping child
752 // could disappear due to a replacement.
753 if (!bypass_limits &&
754 ws.m_modified_fees <
755 m_pool.m_opts.min_relay_feerate.GetFee(ws.m_ptx->GetTotalSize())) {
756 // Even though this is a fee-related failure, this result is
757 // TX_MEMPOOL_POLICY, not TX_PACKAGE_RECONSIDERABLE, because it cannot
758 // be bypassed using package validation.
759 return state.Invalid(
760 TxValidationResult::TX_MEMPOOL_POLICY, "min relay fee not met",
761 strprintf("%d < %d", ws.m_modified_fees,
762 m_pool.m_opts.min_relay_feerate.GetFee(nSize)));
763 }
764 // No individual transactions are allowed below the mempool min feerate
765 // except from disconnected blocks and transactions in a package. Package
766 // transactions will be checked using package feerate later.
767 if (!bypass_limits && !args.m_package_feerates &&
768 !CheckFeeRate(nSize, ws.m_vsize, ws.m_modified_fees, state)) {
769 return false;
770 }
771
772 return true;
773}
774
775bool MemPoolAccept::ConsensusScriptChecks(const ATMPArgs &args, Workspace &ws) {
777 AssertLockHeld(m_pool.cs);
778 const CTransaction &tx = *ws.m_ptx;
779 const TxId &txid = tx.GetId();
780 TxValidationState &state = ws.m_state;
781
782 // Check again against the next block's script verification flags
783 // to cache our script execution flags.
784 //
785 // This is also useful in case of bugs in the standard flags that cause
786 // transactions to pass as valid when they're actually invalid. For
787 // instance the STRICTENC flag was incorrectly allowing certain CHECKSIG
788 // NOT scripts to pass, even though they were invalid.
789 //
790 // There is a similar check in CreateNewBlock() to prevent creating
791 // invalid blocks (using TestBlockValidity), however allowing such
792 // transactions into the mempool can be exploited as a DoS attack.
793 int nSigChecksConsensus;
795 tx, state, m_view, m_pool, ws.m_next_block_script_verify_flags,
796 ws.m_precomputed_txdata, GetValidationCache(), nSigChecksConsensus,
797 m_active_chainstate.CoinsTip())) {
798 // This can occur under some circumstances, if the node receives an
799 // unrequested tx which is invalid due to new consensus rules not
800 // being activated yet (during IBD).
801 LogPrintf("BUG! PLEASE REPORT THIS! CheckInputScripts failed against "
802 "latest-block but not STANDARD flags %s, %s\n",
803 txid.ToString(), state.ToString());
804 return Assume(false);
805 }
806
807 if (ws.m_sig_checks_standard != nSigChecksConsensus) {
808 // We can't accept this transaction as we've used the standard count
809 // for the mempool/mining, but the consensus count will be enforced
810 // in validation (we don't want to produce bad block templates).
811 LogError(
812 "%s: BUG! PLEASE REPORT THIS! SigChecks count differed between "
813 "standard and consensus flags in %s\n",
814 __func__, txid.ToString());
815 return false;
816 }
817 return true;
818}
819
820bool MemPoolAccept::Finalize(const ATMPArgs &args, Workspace &ws) {
822 AssertLockHeld(m_pool.cs);
823 const TxId &txid = ws.m_ptx->GetId();
824 TxValidationState &state = ws.m_state;
825 const bool bypass_limits = args.m_bypass_limits;
826
827 // Store transaction in memory
828 CTxMemPoolEntry *pentry = ws.m_entry.release();
829 auto entry = CTxMemPoolEntryRef::acquire(pentry);
830 m_pool.addUnchecked(entry);
831
832 auto spentCoins = GetSpentCoins(ws.m_ptx, m_view);
833 Assume(spentCoins.has_value());
834
835 if (m_pool.m_opts.signals) {
836 m_pool.m_opts.signals->TransactionAddedToMempool(
837 ws.m_ptx,
838 // Spent coins should never be null, but better be safe than sorry.
839 spentCoins.has_value() ? std::make_shared<const std::vector<Coin>>(
840 std::move(*spentCoins))
841 : nullptr,
842 m_pool.GetAndIncrementSequence());
843 }
844
845 // Trim mempool and check if tx was trimmed.
846 // If we are validating a package, don't trim here because we could evict a
847 // previous transaction in the package. LimitMempoolSize() should be called
848 // at the very end to make sure the mempool is still within limits and
849 // package submission happens atomically.
850 if (!args.m_package_submission && !bypass_limits) {
851 m_pool.LimitSize(m_active_chainstate.CoinsTip());
852 if (!m_pool.exists(txid)) {
853 // The tx no longer meets our (new) mempool minimum feerate but
854 // could be reconsidered in a package.
856 "mempool full");
857 }
858 }
859 return true;
860}
861
862bool MemPoolAccept::SubmitPackage(
863 const ATMPArgs &args, std::vector<Workspace> &workspaces,
864 PackageValidationState &package_state,
865 std::map<TxId, MempoolAcceptResult> &results) {
867 AssertLockHeld(m_pool.cs);
868 // Sanity check: none of the transactions should be in the mempool.
869 assert(std::all_of(
870 workspaces.cbegin(), workspaces.cend(),
871 [this](const auto &ws) { return !m_pool.exists(ws.m_ptx->GetId()); }));
872
873 bool all_submitted = true;
874 // ConsensusScriptChecks adds to the script cache and is therefore
875 // consensus-critical; CheckInputsFromMempoolAndCache asserts that
876 // transactions only spend coins available from the mempool or UTXO set.
877 // Submit each transaction to the mempool immediately after calling
878 // ConsensusScriptChecks to make the outputs available for subsequent
879 // transactions.
880 for (Workspace &ws : workspaces) {
881 if (!ConsensusScriptChecks(args, ws)) {
882 results.emplace(ws.m_ptx->GetId(),
883 MempoolAcceptResult::Failure(ws.m_state));
884 // Since PreChecks() passed, this should never fail.
885 all_submitted = false;
886 package_state.Invalid(
888 strprintf("BUG! PolicyScriptChecks succeeded but "
889 "ConsensusScriptChecks failed: %s",
890 ws.m_ptx->GetId().ToString()));
891 }
892
893 // If we call LimitMempoolSize() for each individual Finalize(), the
894 // mempool will not take the transaction's descendant feerate into
895 // account because it hasn't seen them yet. Also, we risk evicting a
896 // transaction that a subsequent package transaction depends on.
897 // Instead, allow the mempool to temporarily bypass limits, the maximum
898 // package size) while submitting transactions individually and then
899 // trim at the very end.
900 if (!Finalize(args, ws)) {
901 results.emplace(ws.m_ptx->GetId(),
902 MempoolAcceptResult::Failure(ws.m_state));
903 // Since LimitMempoolSize() won't be called, this should never fail.
904 all_submitted = false;
906 strprintf("BUG! Adding to mempool failed: %s",
907 ws.m_ptx->GetId().ToString()));
908 }
909 }
910
911 // It may or may not be the case that all the transactions made it into the
912 // mempool. Regardless, make sure we haven't exceeded max mempool size.
913 m_pool.LimitSize(m_active_chainstate.CoinsTip());
914
915 std::vector<TxId> all_package_txids;
916 all_package_txids.reserve(workspaces.size());
917 std::transform(workspaces.cbegin(), workspaces.cend(),
918 std::back_inserter(all_package_txids),
919 [](const auto &ws) { return ws.m_ptx->GetId(); });
920
921 // Add successful results. The returned results may change later if
922 // LimitMempoolSize() evicts them.
923 for (Workspace &ws : workspaces) {
924 const auto effective_feerate =
925 args.m_package_feerates
926 ? ws.m_package_feerate
927 : CFeeRate{ws.m_modified_fees,
928 static_cast<uint32_t>(ws.m_vsize)};
929 const auto effective_feerate_txids =
930 args.m_package_feerates ? all_package_txids
931 : std::vector<TxId>({ws.m_ptx->GetId()});
932 results.emplace(ws.m_ptx->GetId(),
933 MempoolAcceptResult::Success(ws.m_vsize, ws.m_base_fees,
934 effective_feerate,
935 effective_feerate_txids));
936 }
937 return all_submitted;
938}
939
941MemPoolAccept::AcceptSingleTransaction(const CTransactionRef &ptx,
942 ATMPArgs &args) {
944 // mempool "read lock" (held through
945 // m_pool.m_opts.signals->TransactionAddedToMempool())
946 LOCK(m_pool.cs);
947
948 const CBlockIndex *tip = m_active_chainstate.m_chain.Tip();
949
950 Workspace ws(ptx,
951 GetNextBlockScriptFlags(tip, m_active_chainstate.m_chainman));
952
953 const std::vector<TxId> single_txid{ws.m_ptx->GetId()};
954
955 // Perform the inexpensive checks first and avoid hashing and signature
956 // verification unless those checks pass, to mitigate CPU exhaustion
957 // denial-of-service attacks.
958 if (!PreChecks(args, ws)) {
959 if (ws.m_state.GetResult() ==
961 // Failed for fee reasons. Provide the effective feerate and which
962 // tx was included.
964 ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize),
965 single_txid);
966 }
967 return MempoolAcceptResult::Failure(ws.m_state);
968 }
969
970 if (!ConsensusScriptChecks(args, ws)) {
971 return MempoolAcceptResult::Failure(ws.m_state);
972 }
973
974 const TxId txid = ptx->GetId();
975
976 // Mempool sanity check -- in our new mempool no tx can be added if its
977 // outputs are already spent in the mempool (that is, no children before
978 // parents allowed; the mempool must be consistent at all times).
979 //
980 // This means that on reorg, the disconnectpool *must* always import
981 // the existing mempool tx's, clear the mempool, and then re-add
982 // remaining tx's in topological order via this function. Our new mempool
983 // has fast adds, so this is ok.
984 if (auto it = m_pool.mapNextTx.lower_bound(COutPoint{txid, 0});
985 it != m_pool.mapNextTx.end() && it->first->GetTxId() == txid) {
986 LogPrintf("%s: BUG! PLEASE REPORT THIS! Attempt to add txid %s, but "
987 "its outputs are already spent in the "
988 "mempool\n",
989 __func__, txid.ToString());
991 "txn-child-before-parent");
992 return MempoolAcceptResult::Failure(ws.m_state);
993 }
994
995 const CFeeRate effective_feerate{ws.m_modified_fees,
996 static_cast<uint32_t>(ws.m_vsize)};
997 // Tx was accepted, but not added
998 if (args.m_test_accept) {
999 return MempoolAcceptResult::Success(ws.m_vsize, ws.m_base_fees,
1000 effective_feerate, single_txid);
1001 }
1002
1003 if (!Finalize(args, ws)) {
1004 // The only possible failure reason is fee-related (mempool full).
1005 // Failed for fee reasons. Provide the effective feerate and which txns
1006 // were included.
1007 Assume(ws.m_state.GetResult() ==
1010 ws.m_state, CFeeRate(ws.m_modified_fees, ws.m_vsize), single_txid);
1011 }
1012
1013 return MempoolAcceptResult::Success(ws.m_vsize, ws.m_base_fees,
1014 effective_feerate, single_txid);
1015}
1016
1017PackageMempoolAcceptResult MemPoolAccept::AcceptMultipleTransactions(
1018 const std::vector<CTransactionRef> &txns, ATMPArgs &args) {
1020
1021 // These context-free package limits can be done before taking the mempool
1022 // lock.
1023 PackageValidationState package_state;
1024 if (!CheckPackage(txns, package_state)) {
1025 return PackageMempoolAcceptResult(package_state, {});
1026 }
1027
1028 std::vector<Workspace> workspaces{};
1029 workspaces.reserve(txns.size());
1030 std::transform(
1031 txns.cbegin(), txns.cend(), std::back_inserter(workspaces),
1032 [this](const auto &tx) {
1033 return Workspace(
1034 tx, GetNextBlockScriptFlags(m_active_chainstate.m_chain.Tip(),
1035 m_active_chainstate.m_chainman));
1036 });
1037 std::map<TxId, MempoolAcceptResult> results;
1038
1039 LOCK(m_pool.cs);
1040
1041 // Do all PreChecks first and fail fast to avoid running expensive script
1042 // checks when unnecessary.
1043 std::vector<TxId> valid_txids;
1044 for (Workspace &ws : workspaces) {
1045 if (!PreChecks(args, ws)) {
1047 "transaction failed");
1048 // Exit early to avoid doing pointless work. Update the failed tx
1049 // result; the rest are unfinished.
1050 results.emplace(ws.m_ptx->GetId(),
1051 MempoolAcceptResult::Failure(ws.m_state));
1052 return PackageMempoolAcceptResult(package_state,
1053 std::move(results));
1054 }
1055 // Make the coins created by this transaction available for subsequent
1056 // transactions in the package to spend.
1057 m_viewmempool.PackageAddTransaction(ws.m_ptx);
1058 valid_txids.push_back(ws.m_ptx->GetId());
1059 }
1060
1061 // Transactions must meet two minimum feerates: the mempool minimum fee and
1062 // min relay fee. For transactions consisting of exactly one child and its
1063 // parents, it suffices to use the package feerate
1064 // (total modified fees / total size or vsize) to check this requirement.
1065 // Note that this is an aggregate feerate; this function has not checked
1066 // that there are transactions too low feerate to pay for themselves, or
1067 // that the child transactions are higher feerate than their parents. Using
1068 // aggregate feerate may allow "parents pay for child" behavior and permit
1069 // a child that is below mempool minimum feerate. To avoid these behaviors,
1070 // callers of AcceptMultipleTransactions need to restrict txns topology
1071 // (e.g. to ancestor sets) and check the feerates of individuals and
1072 // subsets.
1073 const auto m_total_size = std::accumulate(
1074 workspaces.cbegin(), workspaces.cend(), int64_t{0},
1075 [](int64_t sum, auto &ws) { return sum + ws.m_ptx->GetTotalSize(); });
1076 const auto m_total_vsize =
1077 std::accumulate(workspaces.cbegin(), workspaces.cend(), int64_t{0},
1078 [](int64_t sum, auto &ws) { return sum + ws.m_vsize; });
1079 const auto m_total_modified_fees = std::accumulate(
1080 workspaces.cbegin(), workspaces.cend(), Amount::zero(),
1081 [](Amount sum, auto &ws) { return sum + ws.m_modified_fees; });
1082 const CFeeRate package_feerate(m_total_modified_fees, m_total_vsize);
1083 std::vector<TxId> all_package_txids;
1084 all_package_txids.reserve(workspaces.size());
1085 std::transform(workspaces.cbegin(), workspaces.cend(),
1086 std::back_inserter(all_package_txids),
1087 [](const auto &ws) { return ws.m_ptx->GetId(); });
1088 TxValidationState placeholder_state;
1089 if (args.m_package_feerates &&
1090 !CheckFeeRate(m_total_size, m_total_vsize, m_total_modified_fees,
1091 placeholder_state)) {
1093 "transaction failed");
1095 package_state, {{workspaces.back().m_ptx->GetId(),
1097 placeholder_state,
1098 CFeeRate(m_total_modified_fees, m_total_vsize),
1099 all_package_txids)}});
1100 }
1101
1102 for (Workspace &ws : workspaces) {
1103 ws.m_package_feerate = package_feerate;
1104 const TxId &ws_txid = ws.m_ptx->GetId();
1105 if (args.m_test_accept &&
1106 std::find(valid_txids.begin(), valid_txids.end(), ws_txid) !=
1107 valid_txids.end()) {
1108 const auto effective_feerate =
1109 args.m_package_feerates
1110 ? ws.m_package_feerate
1111 : CFeeRate{ws.m_modified_fees,
1112 static_cast<uint32_t>(ws.m_vsize)};
1113 const auto effective_feerate_txids =
1114 args.m_package_feerates ? all_package_txids
1115 : std::vector<TxId>{ws.m_ptx->GetId()};
1116 // When test_accept=true, transactions that pass PreChecks
1117 // are valid because there are no further mempool checks (passing
1118 // PreChecks implies passing ConsensusScriptChecks).
1119 results.emplace(ws_txid,
1121 ws.m_vsize, ws.m_base_fees, effective_feerate,
1122 effective_feerate_txids));
1123 }
1124 }
1125
1126 if (args.m_test_accept) {
1127 return PackageMempoolAcceptResult(package_state, std::move(results));
1128 }
1129
1130 if (!SubmitPackage(args, workspaces, package_state, results)) {
1131 // PackageValidationState filled in by SubmitPackage().
1132 return PackageMempoolAcceptResult(package_state, std::move(results));
1133 }
1134
1135 return PackageMempoolAcceptResult(package_state, std::move(results));
1136}
1137
1139MemPoolAccept::AcceptSubPackage(const std::vector<CTransactionRef> &subpackage,
1140 ATMPArgs &args) {
1142 AssertLockHeld(m_pool.cs);
1143
1144 auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main, m_pool.cs) {
1145 if (subpackage.size() > 1) {
1146 return AcceptMultipleTransactions(subpackage, args);
1147 }
1148 const auto &tx = subpackage.front();
1149 ATMPArgs single_args = ATMPArgs::SingleInPackageAccept(args);
1150 const auto single_res = AcceptSingleTransaction(tx, single_args);
1151 PackageValidationState package_state_wrapped;
1152 if (single_res.m_result_type !=
1154 package_state_wrapped.Invalid(PackageValidationResult::PCKG_TX,
1155 "transaction failed");
1156 }
1157 return PackageMempoolAcceptResult(package_state_wrapped,
1158 {{tx->GetId(), single_res}});
1159 }();
1160
1161 // Clean up m_view and m_viewmempool so that other subpackage evaluations
1162 // don't have access to coins they shouldn't. Keep some coins in order to
1163 // minimize re-fetching coins from the UTXO set.
1164 //
1165 // There are 3 kinds of coins in m_view:
1166 // (1) Temporary coins from the transactions in subpackage, constructed by
1167 // m_viewmempool.
1168 // (2) Mempool coins from transactions in the mempool, constructed by
1169 // m_viewmempool.
1170 // (3) Confirmed coins fetched from our current UTXO set.
1171 //
1172 // (1) Temporary coins need to be removed, regardless of whether the
1173 // transaction was submitted. If the transaction was submitted to the
1174 // mempool, m_viewmempool will be able to fetch them from there. If it
1175 // wasn't submitted to mempool, it is incorrect to keep them - future calls
1176 // may try to spend those coins that don't actually exist.
1177 // (2) Mempool coins also need to be removed. If the mempool contents have
1178 // changed as a result of submitting or replacing transactions, coins
1179 // previously fetched from mempool may now be spent or nonexistent. Those
1180 // coins need to be deleted from m_view.
1181 // (3) Confirmed coins don't need to be removed. The chainstate has not
1182 // changed (we are holding cs_main and no blocks have been processed) so the
1183 // confirmed tx cannot disappear like a mempool tx can. The coin may now be
1184 // spent after we submitted a tx to mempool, but we have already checked
1185 // that the package does not have 2 transactions spending the same coin.
1186 // Keeping them in m_view is an optimization to not re-fetch confirmed coins
1187 // if we later look up inputs for this transaction again.
1188 for (const auto &outpoint : m_viewmempool.GetNonBaseCoins()) {
1189 // In addition to resetting m_viewmempool, we also need to manually
1190 // delete these coins from m_view because it caches copies of the coins
1191 // it fetched from m_viewmempool previously.
1192 m_view.Uncache(outpoint);
1193 }
1194 // This deletes the temporary and mempool coins.
1195 m_viewmempool.Reset();
1196 return result;
1197}
1198
1199PackageMempoolAcceptResult MemPoolAccept::AcceptPackage(const Package &package,
1200 ATMPArgs &args) {
1202 // Used if returning a PackageMempoolAcceptResult directly from this
1203 // function.
1204 PackageValidationState package_state_quit_early;
1205
1206 // Check that the package is well-formed. If it isn't, we won't try to
1207 // validate any of the transactions and thus won't return any
1208 // MempoolAcceptResults, just a package-wide error.
1209
1210 // Context-free package checks.
1211 if (!CheckPackage(package, package_state_quit_early)) {
1212 return PackageMempoolAcceptResult(package_state_quit_early, {});
1213 }
1214
1215 // All transactions in the package must be a parent of the last transaction.
1216 // This is just an opportunity for us to fail fast on a context-free check
1217 // without taking the mempool lock.
1218 if (!IsChildWithParents(package)) {
1219 package_state_quit_early.Invalid(PackageValidationResult::PCKG_POLICY,
1220 "package-not-child-with-parents");
1221 return PackageMempoolAcceptResult(package_state_quit_early, {});
1222 }
1223
1224 // IsChildWithParents() guarantees the package is > 1 transactions.
1225 assert(package.size() > 1);
1226 // The package must be 1 child with all of its unconfirmed parents. The
1227 // package is expected to be sorted, so the last transaction is the child.
1228 const auto &child = package.back();
1229 std::unordered_set<TxId, SaltedTxIdHasher> unconfirmed_parent_txids;
1230 std::transform(
1231 package.cbegin(), package.cend() - 1,
1232 std::inserter(unconfirmed_parent_txids, unconfirmed_parent_txids.end()),
1233 [](const auto &tx) { return tx->GetId(); });
1234
1235 // All child inputs must refer to a preceding package transaction or a
1236 // confirmed UTXO. The only way to verify this is to look up the child's
1237 // inputs in our current coins view (not including mempool), and enforce
1238 // that all parents not present in the package be available at chain tip.
1239 // Since this check can bring new coins into the coins cache, keep track of
1240 // these coins and uncache them if we don't end up submitting this package
1241 // to the mempool.
1242 const CCoinsViewCache &coins_tip_cache = m_active_chainstate.CoinsTip();
1243 for (const auto &input : child->vin) {
1244 if (!coins_tip_cache.HaveCoinInCache(input.prevout)) {
1245 args.m_coins_to_uncache.push_back(input.prevout);
1246 }
1247 }
1248 // Using the MemPoolAccept m_view cache allows us to look up these same
1249 // coins faster later. This should be connecting directly to CoinsTip, not
1250 // to m_viewmempool, because we specifically require inputs to be confirmed
1251 // if they aren't in the package.
1252 m_view.SetBackend(m_active_chainstate.CoinsTip());
1253 const auto package_or_confirmed = [this, &unconfirmed_parent_txids](
1254 const auto &input) {
1255 return unconfirmed_parent_txids.count(input.prevout.GetTxId()) > 0 ||
1256 m_view.HaveCoin(input.prevout);
1257 };
1258 if (!std::all_of(child->vin.cbegin(), child->vin.cend(),
1259 package_or_confirmed)) {
1260 package_state_quit_early.Invalid(
1262 "package-not-child-with-unconfirmed-parents");
1263 return PackageMempoolAcceptResult(package_state_quit_early, {});
1264 }
1265 // Protect against bugs where we pull more inputs from disk that miss being
1266 // added to coins_to_uncache. The backend will be connected again when
1267 // needed in PreChecks.
1268 m_view.SetBackend(m_dummy);
1269
1270 LOCK(m_pool.cs);
1271 // Stores results from which we will create the returned
1272 // PackageMempoolAcceptResult. A result may be changed if a mempool
1273 // transaction is evicted later due to LimitMempoolSize().
1274 std::map<TxId, MempoolAcceptResult> results_final;
1275 // Results from individual validation which will be returned if no other
1276 // result is available for this transaction. "Nonfinal" because if a
1277 // transaction fails by itself but succeeds later (i.e. when evaluated with
1278 // a fee-bumping child), the result in this map may be discarded.
1279 std::map<TxId, MempoolAcceptResult> individual_results_nonfinal;
1280 bool quit_early{false};
1281 std::vector<CTransactionRef> txns_package_eval;
1282 for (const auto &tx : package) {
1283 const auto &txid = tx->GetId();
1284 // An already confirmed tx is treated as one not in mempool, because all
1285 // we know is that the inputs aren't available.
1286 if (m_pool.exists(txid)) {
1287 // Exact transaction already exists in the mempool.
1288 // Node operators are free to set their mempool policies however
1289 // they please, nodes may receive transactions in different orders,
1290 // and malicious counterparties may try to take advantage of policy
1291 // differences to pin or delay propagation of transactions. As such,
1292 // it's possible for some package transaction(s) to already be in
1293 // the mempool, and we don't want to reject the entire package in
1294 // that case (as that could be a censorship vector). De-duplicate
1295 // the transactions that are already in the mempool, and only call
1296 // AcceptMultipleTransactions() with the new transactions. This
1297 // ensures we don't double-count transaction counts and sizes when
1298 // checking ancestor/descendant limits, or double-count transaction
1299 // fees for fee-related policy.
1300 auto iter = m_pool.GetIter(txid);
1301 assert(iter != std::nullopt);
1302 results_final.emplace(txid, MempoolAcceptResult::MempoolTx(
1303 (*iter.value())->GetTxSize(),
1304 (*iter.value())->GetFee()));
1305 } else {
1306 // Transaction does not already exist in the mempool.
1307 // Try submitting the transaction on its own.
1308 const auto single_package_res = AcceptSubPackage({tx}, args);
1309 const auto &single_res = single_package_res.m_tx_results.at(txid);
1310 if (single_res.m_result_type ==
1312 // The transaction succeeded on its own and is now in the
1313 // mempool. Don't include it in package validation, because its
1314 // fees should only be "used" once.
1315 assert(m_pool.exists(txid));
1316 results_final.emplace(txid, single_res);
1317 } else if (single_res.m_state.GetResult() !=
1319 single_res.m_state.GetResult() !=
1321 // Package validation policy only differs from individual policy
1322 // in its evaluation of feerate. For example, if a transaction
1323 // fails here due to violation of a consensus rule, the result
1324 // will not change when it is submitted as part of a package. To
1325 // minimize the amount of repeated work, unless the transaction
1326 // fails due to feerate or missing inputs (its parent is a
1327 // previous transaction in the package that failed due to
1328 // feerate), don't run package validation. Note that this
1329 // decision might not make sense if different types of packages
1330 // are allowed in the future. Continue individually validating
1331 // the rest of the transactions, because some of them may still
1332 // be valid.
1333 quit_early = true;
1334 package_state_quit_early.Invalid(
1335 PackageValidationResult::PCKG_TX, "transaction failed");
1336 individual_results_nonfinal.emplace(txid, single_res);
1337 } else {
1338 individual_results_nonfinal.emplace(txid, single_res);
1339 txns_package_eval.push_back(tx);
1340 }
1341 }
1342 }
1343
1344 auto multi_submission_result =
1345 quit_early || txns_package_eval.empty()
1346 ? PackageMempoolAcceptResult(package_state_quit_early, {})
1347 : AcceptSubPackage(txns_package_eval, args);
1348 PackageValidationState &package_state_final =
1349 multi_submission_result.m_state;
1350
1351 // Make sure we haven't exceeded max mempool size.
1352 // Package transactions that were submitted to mempool or already in mempool
1353 // may be evicted.
1354 m_pool.LimitSize(m_active_chainstate.CoinsTip());
1355
1356 for (const auto &tx : package) {
1357 const auto &txid = tx->GetId();
1358 if (multi_submission_result.m_tx_results.count(txid) > 0) {
1359 // We shouldn't have re-submitted if the tx result was already in
1360 // results_final.
1361 Assume(results_final.count(txid) == 0);
1362 // If it was submitted, check to see if the tx is still in the
1363 // mempool. It could have been evicted due to LimitMempoolSize()
1364 // above.
1365 const auto &txresult =
1366 multi_submission_result.m_tx_results.at(txid);
1367 if (txresult.m_result_type ==
1369 !m_pool.exists(txid)) {
1370 package_state_final.Invalid(PackageValidationResult::PCKG_TX,
1371 "transaction failed");
1372 TxValidationState mempool_full_state;
1373 mempool_full_state.Invalid(
1375 results_final.emplace(
1376 txid, MempoolAcceptResult::Failure(mempool_full_state));
1377 } else {
1378 results_final.emplace(txid, txresult);
1379 }
1380 } else if (const auto final_it{results_final.find(txid)};
1381 final_it != results_final.end()) {
1382 // Already-in-mempool transaction. Check to see if it's still there,
1383 // as it could have been evicted when LimitMempoolSize() was called.
1384 Assume(final_it->second.m_result_type !=
1386 Assume(individual_results_nonfinal.count(txid) == 0);
1387 if (!m_pool.exists(tx->GetId())) {
1388 package_state_final.Invalid(PackageValidationResult::PCKG_TX,
1389 "transaction failed");
1390 TxValidationState mempool_full_state;
1391 mempool_full_state.Invalid(
1393 // Replace the previous result.
1394 results_final.erase(txid);
1395 results_final.emplace(
1396 txid, MempoolAcceptResult::Failure(mempool_full_state));
1397 }
1398 } else if (const auto non_final_it{
1399 individual_results_nonfinal.find(txid)};
1400 non_final_it != individual_results_nonfinal.end()) {
1401 Assume(non_final_it->second.m_result_type ==
1403 // Interesting result from previous processing.
1404 results_final.emplace(txid, non_final_it->second);
1405 }
1406 }
1407 Assume(results_final.size() == package.size());
1408 return PackageMempoolAcceptResult(package_state_final,
1409 std::move(results_final));
1410}
1411} // namespace
1412
1414 const CTransactionRef &tx,
1415 int64_t accept_time, bool bypass_limits,
1416 bool test_accept,
1417 unsigned int heightOverride) {
1419 assert(active_chainstate.GetMempool() != nullptr);
1420 CTxMemPool &pool{*active_chainstate.GetMempool()};
1421
1422 std::vector<COutPoint> coins_to_uncache;
1423 auto args = MemPoolAccept::ATMPArgs::SingleAccept(
1424 active_chainstate.m_chainman.GetConfig(), accept_time, bypass_limits,
1425 coins_to_uncache, test_accept, heightOverride);
1426 MempoolAcceptResult result = MemPoolAccept(pool, active_chainstate)
1427 .AcceptSingleTransaction(tx, args);
1429 // Remove coins that were not present in the coins cache before calling
1430 // ATMPW; this is to prevent memory DoS in case we receive a large
1431 // number of invalid transactions that attempt to overrun the in-memory
1432 // coins cache
1433 // (`CCoinsViewCache::cacheCoins`).
1434
1435 for (const COutPoint &outpoint : coins_to_uncache) {
1436 active_chainstate.CoinsTip().Uncache(outpoint);
1437 }
1438 }
1439
1440 // After we've (potentially) uncached entries, ensure our coins cache is
1441 // still within its size limits
1442 BlockValidationState stateDummy;
1443 active_chainstate.FlushStateToDisk(stateDummy, FlushStateMode::PERIODIC);
1444 return result;
1445}
1446
1448 CTxMemPool &pool,
1449 const Package &package,
1450 bool test_accept) {
1452 assert(!package.empty());
1453 assert(std::all_of(package.cbegin(), package.cend(),
1454 [](const auto &tx) { return tx != nullptr; }));
1455
1456 const Config &config = active_chainstate.m_chainman.GetConfig();
1457
1458 std::vector<COutPoint> coins_to_uncache;
1459 auto result = [&]() EXCLUSIVE_LOCKS_REQUIRED(cs_main) {
1461 if (test_accept) {
1462 auto args = MemPoolAccept::ATMPArgs::PackageTestAccept(
1463 config, GetTime(), coins_to_uncache);
1464 return MemPoolAccept(pool, active_chainstate)
1465 .AcceptMultipleTransactions(package, args);
1466 } else {
1467 auto args = MemPoolAccept::ATMPArgs::PackageChildWithParents(
1468 config, GetTime(), coins_to_uncache);
1469 return MemPoolAccept(pool, active_chainstate)
1470 .AcceptPackage(package, args);
1471 }
1472 }();
1473
1474 // Uncache coins pertaining to transactions that were not submitted to the
1475 // mempool.
1476 if (test_accept || result.m_state.IsInvalid()) {
1477 for (const COutPoint &hashTx : coins_to_uncache) {
1478 active_chainstate.CoinsTip().Uncache(hashTx);
1479 }
1480 }
1481 // Ensure the coins cache is still within limits.
1482 BlockValidationState state_dummy;
1483 active_chainstate.FlushStateToDisk(state_dummy, FlushStateMode::PERIODIC);
1484 return result;
1485}
1486
1487Amount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams) {
1488 int halvings = nHeight / consensusParams.nSubsidyHalvingInterval;
1489 // Force block reward to zero when right shift is undefined.
1490 if (halvings >= 64) {
1491 return Amount::zero();
1492 }
1493
1494 Amount nSubsidy = 50 * COIN;
1495 // Subsidy is cut in half every 210,000 blocks which will occur
1496 // approximately every 4 years.
1497 return ((nSubsidy / SATOSHI) >> halvings) * SATOSHI;
1498}
1499
1501 : m_dbview{std::move(db_params), std::move(options)},
1502 m_catcherview(&m_dbview) {}
1503
1504void CoinsViews::InitCache() {
1506 m_cacheview = std::make_unique<CCoinsViewCache>(&m_catcherview);
1507 m_connect_block_view = std::make_unique<CCoinsViewCache>(&*m_cacheview);
1508}
1509
1511 ChainstateManager &chainman,
1512 std::optional<BlockHash> from_snapshot_blockhash)
1513 : m_mempool(mempool), m_blockman(blockman), m_chainman(chainman),
1514 m_from_snapshot_blockhash(from_snapshot_blockhash) {}
1515
1516const CBlockIndex *Chainstate::SnapshotBase() {
1518 return nullptr;
1519 }
1520 if (!m_cached_snapshot_base) {
1521 m_cached_snapshot_base = Assert(
1523 }
1524 return m_cached_snapshot_base;
1525}
1526
1527void Chainstate::InitCoinsDB(size_t cache_size_bytes, bool in_memory,
1528 bool should_wipe, std::string leveldb_name) {
1530 leveldb_name += node::SNAPSHOT_CHAINSTATE_SUFFIX;
1531 }
1532
1533 m_coins_views = std::make_unique<CoinsViews>(
1534 DBParams{.path = m_chainman.m_options.datadir / leveldb_name,
1535 .cache_bytes = cache_size_bytes,
1536 .memory_only = in_memory,
1537 .wipe_data = should_wipe,
1538 .obfuscate = true,
1539 .options = m_chainman.m_options.coins_db},
1541}
1542
1543void Chainstate::InitCoinsCache(size_t cache_size_bytes) {
1545 assert(m_coins_views != nullptr);
1546 m_coinstip_cache_size_bytes = cache_size_bytes;
1547 m_coins_views->InitCache();
1548}
1549
1550// Note that though this is marked const, we may end up modifying
1551// `m_cached_finished_ibd`, which is a performance-related implementation
1552// detail. This function must be marked `const` so that `CValidationInterface`
1553// clients (which are given a `const Chainstate*`) can call it.
1554//
1556 // Optimization: pre-test latch before taking the lock.
1557 if (m_cached_finished_ibd.load(std::memory_order_relaxed)) {
1558 return false;
1559 }
1560
1561 LOCK(cs_main);
1562 if (m_cached_finished_ibd.load(std::memory_order_relaxed)) {
1563 return false;
1564 }
1565 if (m_blockman.LoadingBlocks()) {
1566 return true;
1567 }
1568 CChain &chain{ActiveChain()};
1569 if (chain.Tip() == nullptr) {
1570 return true;
1571 }
1572 if (chain.Tip()->nChainWork < MinimumChainWork()) {
1573 return true;
1574 }
1575 if (chain.Tip()->Time() < Now<NodeSeconds>() - m_options.max_tip_age) {
1576 return true;
1577 }
1578 LogPrintf("Leaving InitialBlockDownload (latching to false)\n");
1579 m_cached_finished_ibd.store(true, std::memory_order_relaxed);
1580 return false;
1581}
1582
1585
1586 // Before we get past initial download, we cannot reliably alert about forks
1587 // (we assume we don't get stuck on a fork before finishing our initial
1588 // sync)
1590 return;
1591 }
1592
1593 // If our best fork is no longer within 72 blocks (+/- 12 hours if no one
1594 // mines it) of our head, or if it is back on the active chain, drop it
1597 m_best_fork_tip = nullptr;
1598 }
1599
1600 if (m_best_fork_tip ||
1601 (m_chainman.m_best_invalid &&
1602 m_chainman.m_best_invalid->nChainWork >
1603 m_chain.Tip()->nChainWork + (GetBlockProof(*m_chain.Tip()) * 6))) {
1605 std::string warning =
1606 std::string("'Warning: Large-work fork detected, forking after "
1607 "block ") +
1608 m_best_fork_base->phashBlock->ToString() + std::string("'");
1610 }
1611
1613 LogPrintf("%s: Warning: Large fork found\n forking the "
1614 "chain at height %d (%s)\n lasting to height %d "
1615 "(%s).\nChain state database corruption likely.\n",
1616 __func__, m_best_fork_base->nHeight,
1621 } else {
1622 LogPrintf("%s: Warning: Found invalid chain at least ~6 blocks "
1623 "longer than our best chain.\nChain state database "
1624 "corruption likely.\n",
1625 __func__);
1627 }
1628 } else {
1631 }
1632}
1633
1635 CBlockIndex *pindexNewForkTip) {
1637
1638 // If we are on a fork that is sufficiently large, set a warning flag.
1639 const CBlockIndex *pfork = m_chain.FindFork(pindexNewForkTip);
1640
1641 // We define a condition where we should warn the user about as a fork of at
1642 // least 7 blocks with a tip within 72 blocks (+/- 12 hours if no one mines
1643 // it) of ours. We use 7 blocks rather arbitrarily as it represents just
1644 // under 10% of sustained network hash rate operating on the fork, or a
1645 // chain that is entirely longer than ours and invalid (note that this
1646 // should be detected by both). We define it this way because it allows us
1647 // to only store the highest fork tip (+ base) which meets the 7-block
1648 // condition and from this always have the most-likely-to-cause-warning fork
1649 if (pfork &&
1650 (!m_best_fork_tip ||
1651 pindexNewForkTip->nHeight > m_best_fork_tip->nHeight) &&
1652 pindexNewForkTip->nChainWork - pfork->nChainWork >
1653 (GetBlockProof(*pfork) * 7) &&
1654 m_chain.Height() - pindexNewForkTip->nHeight < 72) {
1655 m_best_fork_tip = pindexNewForkTip;
1656 m_best_fork_base = pfork;
1657 }
1658
1660}
1661
1662// Called both upon regular invalid block discovery *and* InvalidateBlock
1665 if (!m_chainman.m_best_invalid ||
1666 pindexNew->nChainWork > m_chainman.m_best_invalid->nChainWork) {
1667 m_chainman.m_best_invalid = pindexNew;
1668 }
1669 SetBlockFailureFlags(pindexNew);
1670 if (m_chainman.m_best_header != nullptr &&
1671 m_chainman.m_best_header->GetAncestor(pindexNew->nHeight) ==
1672 pindexNew) {
1673 m_chainman.RecalculateBestHeader();
1674 }
1675
1676 // If the invalid chain found is supposed to be finalized, we need to move
1677 // back the finalization point.
1678 if (IsBlockAvalancheFinalized(pindexNew)) {
1680 m_avalancheFinalizedBlockIndex = pindexNew->pprev;
1681 }
1682
1683 LogPrintf("%s: invalid block=%s height=%d log2_work=%f date=%s\n",
1684 __func__, pindexNew->GetBlockHash().ToString(),
1685 pindexNew->nHeight,
1686 log(pindexNew->nChainWork.getdouble()) / log(2.0),
1687 FormatISO8601DateTime(pindexNew->GetBlockTime()));
1688 CBlockIndex *tip = m_chain.Tip();
1689 assert(tip);
1690 LogPrintf("%s: current best=%s height=%d log2_work=%f date=%s\n",
1691 __func__, tip->GetBlockHash().ToString(), m_chain.Height(),
1692 log(tip->nChainWork.getdouble()) / log(2.0),
1694}
1695
1696// Same as InvalidChainFound, above, except not called directly from
1697// InvalidateBlock, which does its own setBlockIndexCandidates management.
1699 const BlockValidationState &state) {
1702 pindex->nStatus = pindex->nStatus.withFailed();
1703 m_chainman.m_failed_blocks.insert(pindex);
1704 m_blockman.m_dirty_blockindex.insert(pindex);
1705 InvalidChainFound(pindex);
1706 }
1707}
1708
1709void SpendCoins(CCoinsViewCache &view, const CTransaction &tx, CTxUndo &txundo,
1710 int nHeight) {
1711 // Mark inputs spent.
1712 if (tx.IsCoinBase()) {
1713 return;
1714 }
1715
1716 txundo.vprevout.reserve(tx.vin.size());
1717 for (const CTxIn &txin : tx.vin) {
1718 txundo.vprevout.emplace_back();
1719 bool is_spent = view.SpendCoin(txin.prevout, &txundo.vprevout.back());
1720 assert(is_spent);
1721 }
1722}
1723
1724void UpdateCoins(CCoinsViewCache &view, const CTransaction &tx, CTxUndo &txundo,
1725 int nHeight) {
1726 SpendCoins(view, tx, txundo, nHeight);
1727 AddCoins(view, tx, nHeight);
1728}
1729
1730std::optional<std::vector<Coin>>
1731GetSpentCoins(const CTransactionRef &ptx, const CCoinsViewCache &coins_view) {
1732 std::vector<Coin> spent_coins;
1733 spent_coins.reserve(ptx->vin.size());
1734 for (const CTxIn &input : ptx->vin) {
1735 auto coin{coins_view.GetCoin(input.prevout)};
1736 if (!coin.has_value()) {
1737 return std::nullopt;
1738 }
1739 spent_coins.push_back(std::move(*coin));
1740 }
1741 return spent_coins;
1742}
1743
1744std::optional<std::pair<ScriptError, std::string>> CScriptCheck::operator()() {
1745 const CScript &scriptSig = ptxTo->vin[nIn].scriptSig;
1747 auto debug_str = strprintf("input %i of %s, spending %s:%i", nIn,
1748 ptxTo->GetId().ToString(),
1749 ptxTo->vin[nIn].prevout.GetTxId().ToString(),
1750 ptxTo->vin[nIn].prevout.GetN());
1751 if (!VerifyScript(scriptSig, m_tx_out.scriptPubKey, nFlags,
1755 metrics, &error)) {
1756 return std::make_pair(error, std::move(debug_str));
1757 }
1758 if ((pTxLimitSigChecks &&
1762 // we can't assign a meaningful script error (since the script
1763 // succeeded), but remove the ScriptError::OK which could be
1764 // misinterpreted.
1765 return std::make_pair(ScriptError::SIGCHECKS_LIMIT_EXCEEDED,
1766 std::move(debug_str));
1767 }
1768 return std::nullopt;
1769}
1770
1771ValidationCache::ValidationCache(const size_t script_execution_cache_bytes,
1772 const size_t signature_cache_bytes)
1773 : m_signature_cache{signature_cache_bytes} {
1774 // Setup the salted hasher
1775 uint256 nonce = GetRandHash();
1776 // We want the nonce to be 64 bytes long to force the hasher to process
1777 // this chunk, which makes later hash computations more efficient. We
1778 // just write our 32-byte entropy twice to fill the 64 bytes.
1781
1782 const auto [num_elems, approx_size_bytes] =
1783 m_script_execution_cache.setup_bytes(script_execution_cache_bytes);
1784 LogPrintf("Using %zu MiB out of %zu MiB requested for script execution "
1785 "cache, able to store %zu elements\n",
1786 approx_size_bytes >> 20, script_execution_cache_bytes >> 20,
1787 num_elems);
1788}
1789
1790bool CheckInputScripts(const CTransaction &tx, TxValidationState &state,
1791 const CCoinsViewCache &inputs, const uint32_t flags,
1792 bool sigCacheStore, bool scriptCacheStore,
1793 const PrecomputedTransactionData &txdata,
1794 ValidationCache &validation_cache, int &nSigChecksOut,
1795 TxSigCheckLimiter &txLimitSigChecks,
1796 CheckInputsLimiter *pBlockLimitSigChecks,
1797 std::vector<CScriptCheck> *pvChecks) {
1799 assert(!tx.IsCoinBase());
1800
1801 if (pvChecks) {
1802 pvChecks->reserve(tx.vin.size());
1803 }
1804
1805 // First check if script executions have been cached with the same flags.
1806 // Note that this assumes that the inputs provided are correct (ie that the
1807 // transaction hash which is in tx's prevouts properly commits to the
1808 // scriptPubKey in the inputs view of that transaction).
1809 ScriptCacheKey hashCacheEntry(
1810 tx, flags, validation_cache.ScriptExecutionCacheHasher());
1811 ScriptCacheElement elem(hashCacheEntry, 0);
1812 bool found_in_cache = validation_cache.m_script_execution_cache.get(
1813 elem, /*erase=*/!scriptCacheStore);
1814 nSigChecksOut = elem.nSigChecks;
1815 if (found_in_cache) {
1816 if (!txLimitSigChecks.consume_and_check(nSigChecksOut) ||
1817 (pBlockLimitSigChecks &&
1818 !pBlockLimitSigChecks->consume_and_check(nSigChecksOut))) {
1820 "too-many-sigchecks");
1821 }
1822 return true;
1823 }
1824
1825 int nSigChecksTotal = 0;
1826
1827 for (size_t i = 0; i < tx.vin.size(); i++) {
1828 const COutPoint &prevout = tx.vin[i].prevout;
1829 const Coin &coin = inputs.AccessCoin(prevout);
1830 assert(!coin.IsSpent());
1831
1832 // We very carefully only pass in things to CScriptCheck which are
1833 // clearly committed to by tx's hash. This provides a sanity
1834 // check that our caching is not introducing consensus failures through
1835 // additional data in, eg, the coins being spent being checked as a part
1836 // of CScriptCheck.
1837
1838 // Verify signature
1839 CScriptCheck check(
1840 coin.GetTxOut(), tx, validation_cache.m_signature_cache, i, flags,
1841 sigCacheStore, txdata, &txLimitSigChecks, pBlockLimitSigChecks);
1842
1843 // If pvChecks is not null, defer the check execution to the caller.
1844 if (pvChecks) {
1845 pvChecks->push_back(std::move(check));
1846 continue;
1847 }
1848
1849 if (auto result = check(); result.has_value()) {
1850 // Compute flags without the optional standardness flags.
1851 // This differs from MANDATORY_SCRIPT_VERIFY_FLAGS as it contains
1852 // additional upgrade flags (see AcceptToMemoryPoolWorker variable
1853 // extraFlags).
1854 uint32_t mandatoryFlags =
1855 flags & ~STANDARD_NOT_MANDATORY_VERIFY_FLAGS;
1856 if (flags != mandatoryFlags) {
1857 // Check whether the failure was caused by a non-mandatory
1858 // script verification check. If so, ensure we return
1859 // NOT_STANDARD instead of CONSENSUS to avoid downstream users
1860 // splitting the network between upgraded and non-upgraded nodes
1861 // by banning CONSENSUS-failing data providers.
1862 CScriptCheck check2(coin.GetTxOut(), tx,
1863 validation_cache.m_signature_cache, i,
1864 mandatoryFlags, sigCacheStore, txdata);
1865 auto mandatory_result = check2();
1866 if (!mandatory_result.has_value()) {
1867 return state.Invalid(
1869 strprintf("non-mandatory-script-verify-flag (%s)",
1870 ScriptErrorString(result->first)),
1871 result->second);
1872 }
1873 // If the second check failed, it failed due to a mandatory
1874 // script verification flag, but the first check might have
1875 // failed on a non-mandatory script verification flag.
1876 //
1877 // Avoid reporting a mandatory script check failure with a
1878 // non-mandatory error string by reporting the error from the
1879 // second check.
1880 result = mandatory_result;
1881 }
1882
1883 // MANDATORY flag failures correspond to
1884 // TxValidationResult::TX_CONSENSUS. Because CONSENSUS failures are
1885 // the most serious case of validation failures, we may need to
1886 // consider using RECENT_CONSENSUS_CHANGE for any script failure
1887 // that could be due to non-upgraded nodes which we may want to
1888 // support, to avoid splitting the network (but this depends on the
1889 // details of how net_processing handles such errors).
1890 return state.Invalid(
1892 strprintf("mandatory-script-verify-flag-failed (%s)",
1893 ScriptErrorString(result->first)),
1894 result->second);
1895 }
1896
1897 nSigChecksTotal += check.GetScriptExecutionMetrics().nSigChecks;
1898 }
1899
1900 nSigChecksOut = nSigChecksTotal;
1901
1902 if (scriptCacheStore && !pvChecks) {
1903 // We executed all of the provided scripts, and were told to cache the
1904 // result. Do so now.
1905 validation_cache.m_script_execution_cache.insert(
1906 ScriptCacheElement{hashCacheEntry, nSigChecksTotal});
1907 }
1908
1909 return true;
1910}
1911
1913 const std::string &strMessage,
1914 const bilingual_str &userMessage) {
1915 notifications.fatalError(strMessage, userMessage);
1916 return state.Error(strMessage);
1917}
1918
1921 const COutPoint &out) {
1922 bool fClean = true;
1923
1924 if (view.HaveCoin(out)) {
1925 // Overwriting transaction output.
1926 fClean = false;
1927 }
1928
1929 if (undo.GetHeight() == 0) {
1930 // Missing undo metadata (height and coinbase). Older versions included
1931 // this information only in undo records for the last spend of a
1932 // transactions' outputs. This implies that it must be present for some
1933 // other output of the same tx.
1934 const Coin &alternate = AccessByTxid(view, out.GetTxId());
1935 if (alternate.IsSpent()) {
1936 // Adding output for transaction without known metadata
1938 }
1939
1940 // This is somewhat ugly, but hopefully utility is limited. This is only
1941 // useful when working from legacy on disck data. In any case, putting
1942 // the correct information in there doesn't hurt.
1943 const_cast<Coin &>(undo) = Coin(undo.GetTxOut(), alternate.GetHeight(),
1944 alternate.IsCoinBase());
1945 }
1946
1947 // If the coin already exists as an unspent coin in the cache, then the
1948 // possible_overwrite parameter to AddCoin must be set to true. We have
1949 // already checked whether an unspent coin exists above using HaveCoin, so
1950 // we don't need to guess. When fClean is false, an unspent coin already
1951 // existed and it is an overwrite.
1952 view.AddCoin(out, std::move(undo), !fClean);
1953
1955}
1956
1961DisconnectResult Chainstate::DisconnectBlock(const CBlock &block,
1962 const CBlockIndex *pindex,
1963 CCoinsViewCache &view) {
1965 CBlockUndo blockUndo;
1966 if (!m_blockman.ReadBlockUndo(blockUndo, *pindex)) {
1967 LogError("DisconnectBlock(): failure reading undo data\n");
1969 }
1970
1971 return ApplyBlockUndo(std::move(blockUndo), block, pindex, view);
1972}
1973
1975 const CBlockIndex *pindex,
1976 CCoinsViewCache &view) {
1977 bool fClean = true;
1978
1979 if (blockUndo.vtxundo.size() + 1 != block.vtx.size()) {
1980 LogError("DisconnectBlock(): block and undo data inconsistent\n");
1982 }
1983
1984 // First, restore inputs.
1985 for (size_t i = 1; i < block.vtx.size(); i++) {
1986 const CTransaction &tx = *(block.vtx[i]);
1987 CTxUndo &txundo = blockUndo.vtxundo[i - 1];
1988 if (txundo.vprevout.size() != tx.vin.size()) {
1989 LogError(
1990 "DisconnectBlock(): transaction and undo data inconsistent\n");
1992 }
1993
1994 for (size_t j = 0; j < tx.vin.size(); j++) {
1995 const COutPoint &out = tx.vin[j].prevout;
1996 DisconnectResult res =
1997 UndoCoinSpend(std::move(txundo.vprevout[j]), view, out);
1998 if (res == DisconnectResult::FAILED) {
2000 }
2001 fClean = fClean && res != DisconnectResult::UNCLEAN;
2002 }
2003 // At this point, all of txundo.vprevout should have been moved out.
2004 }
2005
2006 // Second, revert created outputs.
2007 for (const auto &ptx : block.vtx) {
2008 const CTransaction &tx = *ptx;
2009 const TxId &txid = tx.GetId();
2010 const bool is_coinbase = tx.IsCoinBase();
2011
2012 // Check that all outputs are available and match the outputs in the
2013 // block itself exactly.
2014 for (size_t o = 0; o < tx.vout.size(); o++) {
2015 if (tx.vout[o].scriptPubKey.IsUnspendable()) {
2016 continue;
2017 }
2018
2019 COutPoint out(txid, o);
2020 Coin coin;
2021 bool is_spent = view.SpendCoin(out, &coin);
2022 if (!is_spent || tx.vout[o] != coin.GetTxOut() ||
2023 uint32_t(pindex->nHeight) != coin.GetHeight() ||
2024 is_coinbase != coin.IsCoinBase()) {
2025 // transaction output mismatch
2026 fClean = false;
2027 }
2028 }
2029 }
2030
2031 // Move best block pointer to previous block.
2032 view.SetBestBlock(block.hashPrevBlock);
2033
2035}
2036
2037// Returns the script flags which should be checked for the block after
2038// the given block.
2039static uint32_t GetNextBlockScriptFlags(const CBlockIndex *pindex,
2040 const ChainstateManager &chainman) {
2041 const Consensus::Params &consensusparams = chainman.GetConsensus();
2042
2043 uint32_t flags = SCRIPT_VERIFY_NONE;
2044
2045 // Enforce P2SH (BIP16)
2046 if (DeploymentActiveAfter(pindex, chainman, Consensus::DEPLOYMENT_P2SH)) {
2048 }
2049
2050 // Enforce the DERSIG (BIP66) rule.
2051 if (DeploymentActiveAfter(pindex, chainman, Consensus::DEPLOYMENT_DERSIG)) {
2053 }
2054
2055 // Start enforcing CHECKLOCKTIMEVERIFY (BIP65) rule.
2056 if (DeploymentActiveAfter(pindex, chainman, Consensus::DEPLOYMENT_CLTV)) {
2058 }
2059
2060 // Start enforcing CSV (BIP68, BIP112 and BIP113) rule.
2061 if (DeploymentActiveAfter(pindex, chainman, Consensus::DEPLOYMENT_CSV)) {
2063 }
2064
2065 // If the UAHF is enabled, we start accepting replay protected txns
2066 if (IsUAHFenabled(consensusparams, pindex)) {
2069 }
2070
2071 // If the DAA HF is enabled, we start rejecting transaction that use a high
2072 // s in their signature. We also make sure that signature that are supposed
2073 // to fail (for instance in multisig or other forms of smart contracts) are
2074 // null.
2075 if (IsDAAEnabled(consensusparams, pindex)) {
2078 }
2079
2080 // When the magnetic anomaly fork is enabled, we start accepting
2081 // transactions using the OP_CHECKDATASIG opcode and it's verify
2082 // alternative. We also start enforcing push only signatures and
2083 // clean stack.
2084 if (IsMagneticAnomalyEnabled(consensusparams, pindex)) {
2087 }
2088
2089 if (IsGravitonEnabled(consensusparams, pindex)) {
2092 }
2093
2094 if (IsPhononEnabled(consensusparams, pindex)) {
2096 }
2097
2098 // We make sure this node will have replay protection during the next hard
2099 // fork.
2101 consensusparams, pindex,
2104 }
2105
2106 return flags;
2107}
2108
2109static SteadyClock::duration time_check{};
2110static SteadyClock::duration time_forks{};
2111static SteadyClock::duration time_connect{};
2112static SteadyClock::duration time_verify{};
2113static SteadyClock::duration time_index{};
2114static SteadyClock::duration time_total{};
2115static int64_t num_blocks_total = 0;
2116
2123bool Chainstate::ConnectBlock(const CBlock &block, BlockValidationState &state,
2124 CBlockIndex *pindex, CCoinsViewCache &view,
2125 BlockValidationOptions options, Amount *blockFees,
2126 bool fJustCheck) {
2128 assert(pindex);
2129
2130 const BlockHash block_hash{block.GetHash()};
2131 assert(*pindex->phashBlock == block_hash);
2132
2133 const auto time_start{SteadyClock::now()};
2134
2135 const CChainParams &params{m_chainman.GetParams()};
2136 const Consensus::Params &consensusParams = params.GetConsensus();
2137
2138 // Check it again in case a previous version let a bad block in
2139 // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2140 // ContextualCheckBlockHeader() here. This means that if we add a new
2141 // consensus rule that is enforced in one of those two functions, then we
2142 // may have let in a block that violates the rule prior to updating the
2143 // software, and we would NOT be enforcing the rule here. Fully solving
2144 // upgrade from one software version to the next after a consensus rule
2145 // change is potentially tricky and issue-specific.
2146 // Also, currently the rule against blocks more than 2 hours in the future
2147 // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2148 // re-enforce that rule here (at least until we make it impossible for
2149 // m_adjusted_time_callback() to go backward).
2150 if (!CheckBlock(block, state, consensusParams,
2151 options.withCheckPoW(!fJustCheck)
2152 .withCheckMerkleRoot(!fJustCheck))) {
2154 // We don't write down blocks to disk if they may have been
2155 // corrupted, so this should be impossible unless we're having
2156 // hardware problems.
2157 return FatalError(m_chainman.GetNotifications(), state,
2158 "Corrupt block found indicating potential "
2159 "hardware failure; shutting down");
2160 }
2161 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
2162 return false;
2163 }
2164
2165 // Verify that the view's current state corresponds to the previous block
2166 BlockHash hashPrevBlock =
2167 pindex->pprev == nullptr ? BlockHash() : pindex->pprev->GetBlockHash();
2168 assert(hashPrevBlock == view.GetBestBlock());
2169
2171
2172 // Special case for the genesis block, skipping connection of its
2173 // transactions (its coinbase is unspendable)
2174 if (block_hash == consensusParams.hashGenesisBlock) {
2175 if (!fJustCheck) {
2176 view.SetBestBlock(pindex->GetBlockHash());
2177 }
2178
2179 return true;
2180 }
2181
2182 bool fScriptChecks = true;
2184 // We've been configured with the hash of a block which has been
2185 // externally verified to have a valid history. A suitable default value
2186 // is included with the software and updated from time to time. Because
2187 // validity relative to a piece of software is an objective fact these
2188 // defaults can be easily reviewed. This setting doesn't force the
2189 // selection of any particular chain but makes validating some faster by
2190 // effectively caching the result of part of the verification.
2191 BlockMap::const_iterator it{
2192 m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2193 if (it != m_blockman.m_block_index.end()) {
2194 if (it->second.GetAncestor(pindex->nHeight) == pindex &&
2195 m_chainman.m_best_header->GetAncestor(pindex->nHeight) ==
2196 pindex &&
2197 m_chainman.m_best_header->nChainWork >=
2199 // This block is a member of the assumed verified chain and an
2200 // ancestor of the best header.
2201 // Script verification is skipped when connecting blocks under
2202 // the assumevalid block. Assuming the assumevalid block is
2203 // valid this is safe because block merkle hashes are still
2204 // computed and checked, Of course, if an assumed valid block is
2205 // invalid due to false scriptSigs this optimization would allow
2206 // an invalid chain to be accepted.
2207 // The equivalent time check discourages hash power from
2208 // extorting the network via DOS attack into accepting an
2209 // invalid block through telling users they must manually set
2210 // assumevalid. Requiring a software change or burying the
2211 // invalid block, regardless of the setting, makes it hard to
2212 // hide the implication of the demand. This also avoids having
2213 // release candidates that are hardly doing any signature
2214 // verification at all in testing without having to artificially
2215 // set the default assumed verified block further back. The test
2216 // against the minimum chain work prevents the skipping when
2217 // denied access to any chain at least as good as the expected
2218 // chain.
2219 fScriptChecks = (GetBlockProofEquivalentTime(
2220 *m_chainman.m_best_header, *pindex,
2221 *m_chainman.m_best_header,
2222 consensusParams) <= 60 * 60 * 24 * 7 * 2);
2223 }
2224 }
2225 }
2226
2227 const auto time_1{SteadyClock::now()};
2228 time_check += time_1 - time_start;
2229 LogPrint(BCLog::BENCH, " - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2230 Ticks<MillisecondsDouble>(time_1 - time_start),
2231 Ticks<SecondsDouble>(time_check),
2232 Ticks<MillisecondsDouble>(time_check) / num_blocks_total);
2233
2234 // Do not allow blocks that contain transactions which 'overwrite' older
2235 // transactions, unless those are already completely spent. If such
2236 // overwrites are allowed, coinbases and transactions depending upon those
2237 // can be duplicated to remove the ability to spend the first instance --
2238 // even after being sent to another address.
2239 // See BIP30, CVE-2012-1909, and http://r6.ca/blog/20120206T005236Z.html
2240 // for more information. This rule was originally applied to all blocks
2241 // with a timestamp after March 15, 2012, 0:00 UTC. Now that the whole
2242 // chain is irreversibly beyond that time it is applied to all blocks
2243 // except the two in the chain that violate it. This prevents exploiting
2244 // the issue against nodes during their initial block download.
2245 bool fEnforceBIP30 = !((pindex->nHeight == 91842 &&
2246 pindex->GetBlockHash() ==
2247 uint256S("0x00000000000a4d0a398161ffc163c503763"
2248 "b1f4360639393e0e4c8e300e0caec")) ||
2249 (pindex->nHeight == 91880 &&
2250 pindex->GetBlockHash() ==
2251 uint256S("0x00000000000743f190a18c5577a3c2d2a1f"
2252 "610ae9601ac046a38084ccb7cd721")));
2253
2254 // Once BIP34 activated it was not possible to create new duplicate
2255 // coinbases and thus other than starting with the 2 existing duplicate
2256 // coinbase pairs, not possible to create overwriting txs. But by the time
2257 // BIP34 activated, in each of the existing pairs the duplicate coinbase had
2258 // overwritten the first before the first had been spent. Since those
2259 // coinbases are sufficiently buried it's no longer possible to create
2260 // further duplicate transactions descending from the known pairs either. If
2261 // we're on the known chain at height greater than where BIP34 activated, we
2262 // can save the db accesses needed for the BIP30 check.
2263
2264 // BIP34 requires that a block at height X (block X) has its coinbase
2265 // scriptSig start with a CScriptNum of X (indicated height X). The above
2266 // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2267 // case that there is a block X before the BIP34 height of 227,931 which has
2268 // an indicated height Y where Y is greater than X. The coinbase for block
2269 // X would also be a valid coinbase for block Y, which could be a BIP30
2270 // violation. An exhaustive search of all mainnet coinbases before the
2271 // BIP34 height which have an indicated height greater than the block height
2272 // reveals many occurrences. The 3 lowest indicated heights found are
2273 // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2274 // heights would be the first opportunity for BIP30 to be violated.
2275
2276 // The search reveals a great many blocks which have an indicated height
2277 // greater than 1,983,702, so we simply remove the optimization to skip
2278 // BIP30 checking for blocks at height 1,983,702 or higher. Before we reach
2279 // that block in another 25 years or so, we should take advantage of a
2280 // future consensus change to do a new and improved version of BIP34 that
2281 // will actually prevent ever creating any duplicate coinbases in the
2282 // future.
2283 static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2284
2285 // There is no potential to create a duplicate coinbase at block 209,921
2286 // because this is still before the BIP34 height and so explicit BIP30
2287 // checking is still active.
2288
2289 // The final case is block 176,684 which has an indicated height of
2290 // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2291 // before block 490,897 so there was not much opportunity to address this
2292 // case other than to carefully analyze it and determine it would not be a
2293 // problem. Block 490,897 was, in fact, mined with a different coinbase than
2294 // block 176,684, but it is important to note that even if it hadn't been or
2295 // is remined on an alternate fork with a duplicate coinbase, we would still
2296 // not run into a BIP30 violation. This is because the coinbase for 176,684
2297 // is spent in block 185,956 in transaction
2298 // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781. This
2299 // spending transaction can't be duplicated because it also spends coinbase
2300 // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29. This
2301 // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2302 // duplicatable until that height, and it's currently impossible to create a
2303 // chain that long. Nevertheless we may wish to consider a future soft fork
2304 // which retroactively prevents block 490,897 from creating a duplicate
2305 // coinbase. The two historical BIP30 violations often provide a confusing
2306 // edge case when manipulating the UTXO and it would be simpler not to have
2307 // another edge case to deal with.
2308
2309 // testnet3 has no blocks before the BIP34 height with indicated heights
2310 // post BIP34 before approximately height 486,000,000 and presumably will
2311 // be reset before it reaches block 1,983,702 and starts doing unnecessary
2312 // BIP30 checking again.
2313 assert(pindex->pprev);
2314 CBlockIndex *pindexBIP34height =
2315 pindex->pprev->GetAncestor(consensusParams.BIP34Height);
2316 // Only continue to enforce if we're below BIP34 activation height or the
2317 // block hash at that height doesn't correspond.
2318 fEnforceBIP30 =
2319 fEnforceBIP30 &&
2320 (!pindexBIP34height ||
2321 !(pindexBIP34height->GetBlockHash() == consensusParams.BIP34Hash));
2322
2323 // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have
2324 // a consensus change that ensures coinbases at those heights can not
2325 // duplicate earlier coinbases.
2326 if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2327 for (const auto &tx : block.vtx) {
2328 for (size_t o = 0; o < tx->vout.size(); o++) {
2329 if (view.HaveCoin(COutPoint(tx->GetId(), o))) {
2331 "bad-txns-BIP30",
2332 "tried to overwrite transaction");
2333 }
2334 }
2335 }
2336 }
2337
2338 // Enforce BIP68 (sequence locks).
2339 int nLockTimeFlags = 0;
2340 if (DeploymentActiveAt(*pindex, consensusParams,
2342 nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2343 }
2344
2345 const uint32_t flags = GetNextBlockScriptFlags(pindex->pprev, m_chainman);
2346
2347 const auto time_2{SteadyClock::now()};
2348 time_forks += time_2 - time_1;
2349 LogPrint(BCLog::BENCH, " - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2350 Ticks<MillisecondsDouble>(time_2 - time_1),
2351 Ticks<SecondsDouble>(time_forks),
2352 Ticks<MillisecondsDouble>(time_forks) / num_blocks_total);
2353
2354 std::vector<int> prevheights;
2355 Amount nFees = Amount::zero();
2356 int nInputs = 0;
2357
2358 // Limit the total executed signature operations in the block, a consensus
2359 // rule. Tracking during the CPU-consuming part (validation of uncached
2360 // inputs) is per-input atomic and validation in each thread stops very
2361 // quickly after the limit is exceeded, so an adversary cannot cause us to
2362 // exceed the limit by much at all.
2363 CheckInputsLimiter nSigChecksBlockLimiter(
2365
2366 std::vector<TxSigCheckLimiter> nSigChecksTxLimiters;
2367 nSigChecksTxLimiters.resize(block.vtx.size() - 1);
2368
2369 CBlockUndo blockundo;
2370 blockundo.vtxundo.resize(block.vtx.size() - 1);
2371
2373 fScriptChecks ? &m_chainman.GetCheckQueue() : nullptr);
2374
2375 // Add all outputs
2376 try {
2377 for (const auto &ptx : block.vtx) {
2378 AddCoins(view, *ptx, pindex->nHeight);
2379 }
2380 } catch (const std::logic_error &e) {
2381 // This error will be thrown from AddCoin if we try to connect a block
2382 // containing duplicate transactions. Such a thing should normally be
2383 // caught early nowadays (due to ContextualCheckBlock's CTOR
2384 // enforcement) however some edge cases can escape that:
2385 // - ContextualCheckBlock does not get re-run after saving the block to
2386 // disk, and older versions may have saved a weird block.
2387 // - its checks are not applied to pre-CTOR chains, which we might visit
2388 // with checkpointing off.
2390 "tx-duplicate", "tried to overwrite transaction");
2391 }
2392
2393 size_t txIndex = 0;
2394 // nSigChecksRet may be accurate (found in cache) or 0 (checks were
2395 // deferred into vChecks).
2396 int nSigChecksRet;
2397 for (const auto &ptx : block.vtx) {
2398 const CTransaction &tx = *ptx;
2399 const bool isCoinBase = tx.IsCoinBase();
2400 nInputs += tx.vin.size();
2401
2402 {
2403 Amount txfee = Amount::zero();
2404 TxValidationState tx_state;
2405 if (!isCoinBase &&
2406 !Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight,
2407 txfee)) {
2408 // Any transaction validation failure in ConnectBlock is a block
2409 // consensus failure.
2411 tx_state.GetRejectReason(),
2412 tx_state.GetDebugMessage() + " in transaction " +
2413 tx.GetId().ToString());
2414 break;
2415 }
2416 nFees += txfee;
2417 }
2418
2419 if (!MoneyRange(nFees)) {
2421 "bad-txns-accumulated-fee-outofrange",
2422 "accumulated fee in the block out of range");
2423 break;
2424 }
2425
2426 // The following checks do not apply to the coinbase.
2427 if (isCoinBase) {
2428 continue;
2429 }
2430
2431 // Check that transaction is BIP68 final BIP68 lock checks (as
2432 // opposed to nLockTime checks) must be in ConnectBlock because they
2433 // require the UTXO set.
2434 prevheights.resize(tx.vin.size());
2435 for (size_t j = 0; j < tx.vin.size(); j++) {
2436 prevheights[j] = view.AccessCoin(tx.vin[j].prevout).GetHeight();
2437 }
2438
2439 if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2441 "bad-txns-nonfinal",
2442 "contains a non-BIP68-final transaction " +
2443 tx.GetHash().ToString());
2444 break;
2445 }
2446
2447 // Don't cache results if we're actually connecting blocks (still
2448 // consult the cache, though).
2449 bool fCacheResults = fJustCheck;
2450
2451 const bool fEnforceSigCheck = flags & SCRIPT_ENFORCE_SIGCHECKS;
2452 if (!fEnforceSigCheck) {
2453 // Historically, there has been transactions with a very high
2454 // sigcheck count, so we need to disable this check for such
2455 // transactions.
2456 nSigChecksTxLimiters[txIndex] = TxSigCheckLimiter::getDisabled();
2457 }
2458
2459 std::vector<CScriptCheck> vChecks;
2460 TxValidationState tx_state;
2461 if (fScriptChecks &&
2462 !CheckInputScripts(tx, tx_state, view, flags, fCacheResults,
2463 fCacheResults, PrecomputedTransactionData(tx),
2464 m_chainman.m_validation_cache, nSigChecksRet,
2465 nSigChecksTxLimiters[txIndex],
2466 &nSigChecksBlockLimiter, &vChecks)) {
2467 // Any transaction validation failure in ConnectBlock is a block
2468 // consensus failure
2470 tx_state.GetRejectReason(),
2471 tx_state.GetDebugMessage());
2472 break;
2473 }
2474
2475 control.Add(std::move(vChecks));
2476
2477 // Note: this must execute in the same iteration as CheckTxInputs (not
2478 // in a separate loop) in order to detect double spends. However,
2479 // this does not prevent double-spending by duplicated transaction
2480 // inputs in the same transaction (cf. CVE-2018-17144) -- that check is
2481 // done in CheckBlock (CheckRegularTransaction).
2482 SpendCoins(view, tx, blockundo.vtxundo.at(txIndex), pindex->nHeight);
2483 txIndex++;
2484 }
2485 const auto time_3{SteadyClock::now()};
2486 time_connect += time_3 - time_2;
2488 " - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) "
2489 "[%.2fs (%.2fms/blk)]\n",
2490 (unsigned)block.vtx.size(),
2491 Ticks<MillisecondsDouble>(time_3 - time_2),
2492 Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2493 nInputs <= 1
2494 ? 0
2495 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2496 Ticks<SecondsDouble>(time_connect),
2497 Ticks<MillisecondsDouble>(time_connect) / num_blocks_total);
2498
2499 const Amount blockReward =
2500 nFees + GetBlockSubsidy(pindex->nHeight, consensusParams);
2501 if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
2502 state.Invalid(
2504 strprintf("coinbase pays too much (actual=%d vs limit=%d)",
2505 block.vtx[0]->GetValueOut(), blockReward));
2506 }
2507
2508 if (blockFees) {
2509 *blockFees = nFees;
2510 }
2511
2512 auto parallel_result = control.Complete();
2513 if (parallel_result.has_value() && state.IsValid()) {
2515 strprintf("mandatory-script-verify-flag-failed (%s)",
2516 ScriptErrorString(parallel_result->first)),
2517 parallel_result->second);
2518 }
2519 if (!state.IsValid()) {
2520 LogInfo("Block validation error: %s\n", state.ToString());
2521 return false;
2522 }
2523 const auto time_4{SteadyClock::now()};
2524 time_verify += time_4 - time_2;
2525 LogPrint(
2527 " - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n",
2528 nInputs - 1, Ticks<MillisecondsDouble>(time_4 - time_2),
2529 nInputs <= 1
2530 ? 0
2531 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2532 Ticks<SecondsDouble>(time_verify),
2533 Ticks<MillisecondsDouble>(time_verify) / num_blocks_total);
2534
2535 if (fJustCheck) {
2536 return true;
2537 }
2538
2539 if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2540 return false;
2541 }
2542
2543 if (!pindex->IsValid(BlockValidity::SCRIPTS)) {
2545 m_blockman.m_dirty_blockindex.insert(pindex);
2546 }
2547
2548 // add this block to the view's block chain
2549 view.SetBestBlock(pindex->GetBlockHash());
2550
2551 const auto time_5{SteadyClock::now()};
2552 time_index += time_5 - time_4;
2553 LogPrint(BCLog::BENCH, " - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
2554 Ticks<MillisecondsDouble>(time_5 - time_4),
2555 Ticks<SecondsDouble>(time_index),
2556 Ticks<MillisecondsDouble>(time_index) / num_blocks_total);
2557
2558 TRACE6(validation, block_connected, block_hash.data(), pindex->nHeight,
2559 block.vtx.size(), nInputs, nSigChecksRet,
2560 // in microseconds (µs)
2561 time_5 - time_start);
2562
2563 return true;
2564}
2565
2566CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState() {
2568 return this->GetCoinsCacheSizeState(
2571}
2572
2574Chainstate::GetCoinsCacheSizeState(size_t max_coins_cache_size_bytes,
2575 size_t max_mempool_size_bytes) {
2577 int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2578 int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2579 int64_t nTotalSpace =
2580 max_coins_cache_size_bytes +
2581 std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2582
2584 static constexpr int64_t MAX_BLOCK_COINSDB_USAGE_BYTES =
2585 10 * 1024 * 1024; // 10MB
2586 int64_t large_threshold = std::max(
2587 (9 * nTotalSpace) / 10, nTotalSpace - MAX_BLOCK_COINSDB_USAGE_BYTES);
2588
2589 if (cacheSize > nTotalSpace) {
2590 LogPrintf("Cache size (%s) exceeds total space (%s)\n", cacheSize,
2591 nTotalSpace);
2593 } else if (cacheSize > large_threshold) {
2595 }
2597}
2598
2600 FlushStateMode mode, int nManualPruneHeight) {
2601 LOCK(cs_main);
2602 assert(this->CanFlushToDisk());
2603 std::set<int> setFilesToPrune;
2604 bool full_flush_completed = false;
2605
2606 [[maybe_unused]] const size_t coins_count{CoinsTip().GetCacheSize()};
2607 [[maybe_unused]] const size_t coins_mem_usage{
2609
2610 try {
2611 {
2612 bool fFlushForPrune = false;
2613
2614 CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2616 if (m_blockman.IsPruneMode() &&
2617 (m_blockman.m_check_for_pruning || nManualPruneHeight > 0) &&
2619 // Make sure we don't prune any of the prune locks bestblocks.
2620 // Pruning is height-based.
2621 int last_prune{m_chain.Height()};
2622 // prune lock that actually was the limiting factor, only used
2623 // for logging
2624 std::optional<std::string> limiting_lock;
2625
2626 for (const auto &prune_lock : m_blockman.m_prune_locks) {
2627 if (prune_lock.second.height_first ==
2628 std::numeric_limits<int>::max()) {
2629 continue;
2630 }
2631 // Remove the buffer and one additional block here to get
2632 // actual height that is outside of the buffer
2633 const int lock_height{prune_lock.second.height_first -
2634 PRUNE_LOCK_BUFFER - 1};
2635 last_prune = std::max(1, std::min(last_prune, lock_height));
2636 if (last_prune == lock_height) {
2637 limiting_lock = prune_lock.first;
2638 }
2639 }
2640
2641 if (limiting_lock) {
2642 LogPrint(BCLog::PRUNE, "%s limited pruning to height %d\n",
2643 limiting_lock.value(), last_prune);
2644 }
2645
2646 if (nManualPruneHeight > 0) {
2648 "find files to prune (manual)", BCLog::BENCH);
2650 setFilesToPrune,
2651 std::min(last_prune, nManualPruneHeight), *this,
2652 m_chainman);
2653 } else {
2654 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune",
2655 BCLog::BENCH);
2656 m_blockman.FindFilesToPrune(setFilesToPrune, last_prune,
2657 *this, m_chainman);
2659 }
2660 if (!setFilesToPrune.empty()) {
2661 fFlushForPrune = true;
2663 m_blockman.m_block_tree_db->WriteFlag(
2664 "prunedblockfiles", true);
2666 }
2667 }
2668 }
2669 const auto nNow{NodeClock::now()};
2670 // The cache is large and we're within 10% and 10 MiB of the limit,
2671 // but we have time now (not in the middle of a block processing).
2672 bool fCacheLarge = mode == FlushStateMode::PERIODIC &&
2673 cache_state >= CoinsCacheSizeState::LARGE;
2674 // The cache is over the limit, we have to write now.
2675 bool fCacheCritical = mode == FlushStateMode::IF_NEEDED &&
2676 cache_state >= CoinsCacheSizeState::CRITICAL;
2677 // It's been a while since we wrote the block index and chain
2678 // state to disk. Do this frequently, so we don't need to
2679 // redownload or reindex after a crash.
2680 bool fPeriodicWrite =
2681 mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2682 // Combine all conditions that result in a write to disk.
2683 bool should_write = (mode == FlushStateMode::ALWAYS) ||
2684 fCacheLarge || fCacheCritical ||
2685 fPeriodicWrite || fFlushForPrune;
2686 // Write blocks, block index and best chain related state to disk.
2687 if (should_write) {
2688 // Ensure we can write block index
2690 return FatalError(m_chainman.GetNotifications(), state,
2691 "Disk space is too low!",
2692 _("Disk space is too low!"));
2693 }
2694
2695 {
2697 "write block and undo data to disk", BCLog::BENCH);
2698
2699 // First make sure all block and undo data is flushed to
2700 // disk.
2701 // TODO: Handle return error, or add detailed comment why
2702 // it is safe to not return an error upon failure.
2704 m_chain.Height())) {
2706 "%s: Failed to flush block file.\n",
2707 __func__);
2708 }
2709 }
2710 // Then update all block file information (which may refer to
2711 // block and undo files).
2712 {
2713 LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk",
2714 BCLog::BENCH);
2715
2716 m_blockman.WriteBlockIndexDB();
2717 }
2718
2719 // Finally remove any pruned files
2720 if (fFlushForPrune) {
2721 LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files",
2722 BCLog::BENCH);
2723
2724 m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2725 }
2726
2727 if (!CoinsTip().GetBestBlock().IsNull()) {
2728 // Typical Coin structures on disk are around 48 bytes in
2729 // size. Pushing a new one to the database can cause it to
2730 // be written twice (once in the log, and once in the
2731 // tables). This is already an overestimation, as most will
2732 // delete an existing entry or overwrite one. Still, use a
2733 // conservative safety factor of 2.
2735 48 * 2 * 2 *
2736 CoinsTip().GetDirtyCount())) {
2737 return FatalError(m_chainman.GetNotifications(), state,
2738 "Disk space is too low!",
2739 _("Disk space is too low!"));
2740 }
2741
2742 // Flush the chainstate (which may refer to block index
2743 // entries).
2744 const auto empty_cache{(mode == FlushStateMode::ALWAYS) ||
2745 fCacheLarge || fCacheCritical};
2746 empty_cache ? CoinsTip().Flush() : CoinsTip().Sync();
2747 full_flush_completed = true;
2748 TRACE5(utxocache, flush,
2749 int64_t{Ticks<std::chrono::microseconds>(
2750 SteadyClock::now() - nNow)},
2751 uint32_t(mode), coins_count,
2752 uint64_t(coins_mem_usage), fFlushForPrune);
2753 }
2754 }
2755
2756 if (should_write || m_next_write == NodeClock::time_point::max()) {
2757 constexpr auto range{DATABASE_WRITE_INTERVAL_MAX -
2761 }
2762 }
2763
2764 if (full_flush_completed && m_chainman.m_options.signals) {
2765 // Update best block in wallet (so we can detect restored wallets).
2767 this->GetRole(), m_chain.GetLocator());
2768 }
2769 } catch (const std::runtime_error &e) {
2770 return FatalError(m_chainman.GetNotifications(), state,
2771 std::string("System error while flushing: ") +
2772 e.what());
2773 }
2774 return true;
2775}
2776
2779 if (!this->FlushStateToDisk(state, FlushStateMode::ALWAYS)) {
2780 LogPrintf("%s: failed to flush state (%s)\n", __func__,
2781 state.ToString());
2782 }
2783}
2784
2788 if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2789 LogPrintf("%s: failed to flush state (%s)\n", __func__,
2790 state.ToString());
2791 }
2792}
2793
2794static void UpdateTipLog(const CCoinsViewCache &coins_tip,
2795 const CBlockIndex *tip, const CChainParams &params,
2796 const std::string &func_name,
2797 const std::string &prefix)
2800
2801 // Disable rate limiting in LogPrintLevel_ so this source location may log
2802 // during IBD.
2804 BCLog::LogFlags::ALL, BCLog::Level::Info,
2805 /*should_ratelimit=*/false,
2806 "%s%s: new best=%s height=%d version=0x%08x log2_work=%f tx=%ld "
2807 "date='%s' progress=%f cache=%.1fMiB(%utxo)\n",
2808 prefix, func_name, tip->GetBlockHash().ToString(), tip->nHeight,
2809 tip->nVersion, log(tip->nChainWork.getdouble()) / log(2.0),
2811 GuessVerificationProgress(params.TxData(), tip),
2812 coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2813 coins_tip.GetCacheSize());
2814}
2815
2816void Chainstate::UpdateTip(const CBlockIndex *pindexNew) {
2818 const auto &coins_tip = CoinsTip();
2819
2820 const CChainParams &params{m_chainman.GetParams()};
2821
2822 // The remainder of the function isn't relevant if we are not acting on
2823 // the active chainstate, so return if need be.
2824 if (this != &m_chainman.ActiveChainstate()) {
2825 // Only log every so often so that we don't bury log messages at the
2826 // tip.
2827 constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2828 if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2829 UpdateTipLog(coins_tip, pindexNew, params, __func__,
2830 "[background validation] ");
2831 }
2832 return;
2833 }
2834
2835 // New best block
2836 if (m_mempool) {
2838 }
2839
2840 {
2842 g_best_block = pindexNew;
2843 g_best_block_cv.notify_all();
2844 }
2845
2846 UpdateTipLog(coins_tip, pindexNew, params, __func__, "");
2847}
2848
2861 DisconnectedBlockTransactions *disconnectpool) {
2863 if (m_mempool) {
2865 }
2866
2867 CBlockIndex *pindexDelete = m_chain.Tip();
2868
2869 assert(pindexDelete);
2870 assert(pindexDelete->pprev);
2871
2872 // Read block from disk.
2873 std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2874 CBlock &block = *pblock;
2875 if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2876 LogError("DisconnectTip(): Failed to read block\n");
2877 return false;
2878 }
2879
2880 // Apply the block atomically to the chain state.
2881 const auto time_start{SteadyClock::now()};
2882 {
2883 CCoinsViewCache view(&CoinsTip());
2884 assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2885 if (DisconnectBlock(block, pindexDelete, view) !=
2887 LogError("DisconnectTip(): DisconnectBlock %s failed\n",
2888 pindexDelete->GetBlockHash().ToString());
2889 return false;
2890 }
2891
2892 // local CCoinsViewCache goes out of scope
2893 view.Flush(/*reallocate_cache=*/false);
2894 }
2895 LogPrint(BCLog::BENCH, "- Disconnect block: %.2fms\n",
2896 Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2897
2898 {
2899 // Prune locks that began at or after the tip should be moved backward
2900 // so they get a chance to reorg
2901 const int max_height_first{pindexDelete->nHeight - 1};
2902 for (auto &prune_lock : m_blockman.m_prune_locks) {
2903 if (prune_lock.second.height_first <= max_height_first) {
2904 continue;
2905 }
2906
2907 prune_lock.second.height_first = max_height_first;
2908 LogPrint(BCLog::PRUNE, "%s prune lock moved back to %d\n",
2909 prune_lock.first, max_height_first);
2910 }
2911 }
2912
2913 // Write the chain state to disk, if necessary.
2915 return false;
2916 }
2917
2918 if (m_mempool) {
2919 // If this block is deactivating a fork, we move all mempool
2920 // transactions in front of disconnectpool for reprocessing in a future
2921 // updateMempoolForReorg call
2922 if (pindexDelete->pprev != nullptr &&
2923 GetNextBlockScriptFlags(pindexDelete, m_chainman) !=
2924 GetNextBlockScriptFlags(pindexDelete->pprev, m_chainman)) {
2926 "Disconnecting mempool due to rewind of upgrade block\n");
2927 if (disconnectpool) {
2928 disconnectpool->importMempool(*m_mempool);
2929 }
2930 m_mempool->clear();
2931 }
2932
2933 if (disconnectpool) {
2934 disconnectpool->addForBlock(block.vtx, *m_mempool);
2935 }
2936 }
2937
2938 m_chain.SetTip(*pindexDelete->pprev);
2939
2940 UpdateTip(pindexDelete->pprev);
2941 // Let wallets know transactions went from 1-confirmed to
2942 // 0-confirmed or conflicted:
2944 m_chainman.m_options.signals->BlockDisconnected(pblock, pindexDelete);
2945 }
2946 return true;
2947}
2948
2949static SteadyClock::duration time_connect_total{};
2950static SteadyClock::duration time_flush{};
2951static SteadyClock::duration time_chainstate{};
2952static SteadyClock::duration time_post_connect{};
2953
2959 BlockPolicyValidationState &blockPolicyState,
2960 CBlockIndex *pindexNew,
2961 const std::shared_ptr<const CBlock> &pblock,
2962 DisconnectedBlockTransactions &disconnectpool,
2963 const avalanche::Processor *const avalanche,
2964 const ChainstateRole chainstate_role) {
2966 if (m_mempool) {
2968 }
2969
2970 const Consensus::Params &consensusParams = m_chainman.GetConsensus();
2971
2972 assert(pindexNew->pprev == m_chain.Tip());
2973 // Read block from disk.
2974 const auto time_1{SteadyClock::now()};
2975 std::shared_ptr<const CBlock> pthisBlock;
2976 if (!pblock) {
2977 std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
2978 if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
2979 return FatalError(m_chainman.GetNotifications(), state,
2980 "Failed to read block");
2981 }
2982 pthisBlock = pblockNew;
2983 } else {
2984 pthisBlock = pblock;
2985 }
2986
2987 const CBlock &blockConnecting = *pthisBlock;
2988
2989 // Apply the block atomically to the chain state.
2990 const auto time_2{SteadyClock::now()};
2991 SteadyClock::time_point time_3;
2992 // When adding aggregate statistics in the future, keep in mind that
2993 // num_blocks_total may be zero until the ConnectBlock() call below.
2994 LogPrint(BCLog::BENCH, " - Load block from disk: %.2fms\n",
2995 Ticks<MillisecondsDouble>(time_2 - time_1));
2996 {
2997 Amount blockFees{Amount::zero()};
2998 CCoinsViewCache &view{*m_coins_views->m_connect_block_view};
2999 const auto reset_guard{view.CreateResetGuard()};
3000 bool rv = ConnectBlock(blockConnecting, state, pindexNew, view,
3002 &blockFees);
3004 m_chainman.m_options.signals->BlockChecked(blockConnecting, state);
3005 }
3006 if (!rv) {
3007 if (state.IsInvalid()) {
3008 InvalidBlockFound(pindexNew, state);
3009 }
3010
3011 LogError("%s: ConnectBlock %s failed, %s\n", __func__,
3012 pindexNew->GetBlockHash().ToString(), state.ToString());
3013 return false;
3014 }
3015
3027 const BlockHash blockhash = pindexNew->GetBlockHash();
3031
3032 const Amount blockReward =
3033 blockFees +
3034 GetBlockSubsidy(pindexNew->nHeight, consensusParams);
3035
3036 std::vector<std::unique_ptr<ParkingPolicy>> parkingPolicies;
3037 parkingPolicies.emplace_back(std::make_unique<MinerFundPolicy>(
3038 consensusParams, *pindexNew, blockConnecting, blockReward));
3039
3040 if (avalanche) {
3041 // Only enable the RTT policy if the node already finalized a
3042 // block. This is because it's very possible that new blocks
3043 // will be parked after a node restart (but after IBD) if the
3044 // node is behind by a few blocks. We want to make sure that the
3045 // node will be able to switch back to the right tip in this
3046 // case.
3047 if (avalanche->hasFinalizedTip()) {
3048 // Special case for testnet, don't reject blocks mined with
3049 // the min difficulty
3050 if (!consensusParams.fPowAllowMinDifficultyBlocks ||
3051 (blockConnecting.GetBlockTime() <=
3052 pindexNew->pprev->GetBlockTime() +
3053 2 * consensusParams.nPowTargetSpacing)) {
3054 parkingPolicies.emplace_back(
3055 std::make_unique<RTTPolicy>(consensusParams,
3056 *pindexNew));
3057 }
3058 }
3059
3060 parkingPolicies.emplace_back(
3061 std::make_unique<StakingRewardsPolicy>(
3062 *avalanche, consensusParams, *pindexNew,
3063 blockConnecting, blockReward));
3064
3065 if (m_mempool) {
3066 parkingPolicies.emplace_back(
3067 std::make_unique<PreConsensusPolicy>(
3068 *avalanche, *pindexNew, blockConnecting, m_mempool,
3069 &disconnectpool));
3070 }
3071 }
3072
3073 // If any block policy is violated, bail on the first one found
3074 if (std::find_if_not(parkingPolicies.begin(), parkingPolicies.end(),
3075 [&](const auto &policy) {
3076 bool ret = (*policy)(blockPolicyState);
3077 if (!ret) {
3078 LogPrintf(
3079 "Park block because it "
3080 "violated a block policy: %s\n",
3081 blockPolicyState.ToString());
3082 }
3083 return ret;
3084 }) != parkingPolicies.end()) {
3085 pindexNew->nStatus = pindexNew->nStatus.withParked();
3086 m_blockman.m_dirty_blockindex.insert(pindexNew);
3087 return false;
3088 }
3089 }
3090
3091 time_3 = SteadyClock::now();
3092 time_connect_total += time_3 - time_2;
3094 LogPrint(
3095 BCLog::BENCH, " - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
3096 Ticks<MillisecondsDouble>(time_3 - time_2),
3097 Ticks<SecondsDouble>(time_connect_total),
3098 Ticks<MillisecondsDouble>(time_connect_total) / num_blocks_total);
3099 // No need to reallocate since it only has capacity for 1 block
3100 view.Flush(/*reallocate_cache=*/false);
3101 }
3102
3103 const auto time_4{SteadyClock::now()};
3104 time_flush += time_4 - time_3;
3105 LogPrint(BCLog::BENCH, " - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
3106 Ticks<MillisecondsDouble>(time_4 - time_3),
3107 Ticks<SecondsDouble>(time_flush),
3108 Ticks<MillisecondsDouble>(time_flush) / num_blocks_total);
3109 // Write the chain state to disk, if necessary.
3110 if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
3111 return false;
3112 }
3113 const auto time_5{SteadyClock::now()};
3114 time_chainstate += time_5 - time_4;
3116 " - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
3117 Ticks<MillisecondsDouble>(time_5 - time_4),
3118 Ticks<SecondsDouble>(time_chainstate),
3119 Ticks<MillisecondsDouble>(time_chainstate) / num_blocks_total);
3120 // Remove conflicting transactions from the mempool.
3121 if (m_mempool) {
3122 disconnectpool.removeForBlock(blockConnecting.vtx, *m_mempool);
3123
3124 // If this block is activating a fork, we move all mempool transactions
3125 // in front of disconnectpool for reprocessing in a future
3126 // updateMempoolForReorg call
3127 if (pindexNew->pprev != nullptr &&
3128 GetNextBlockScriptFlags(pindexNew, m_chainman) !=
3129 GetNextBlockScriptFlags(pindexNew->pprev, m_chainman)) {
3130 LogPrint(
3132 "Disconnecting mempool due to acceptance of upgrade block\n");
3133 disconnectpool.importMempool(*m_mempool);
3134 }
3135 }
3136
3137 // Update m_chain & related variables.
3138 m_chain.SetTip(*pindexNew);
3139 UpdateTip(pindexNew);
3140
3141 const auto time_6{SteadyClock::now()};
3142 time_post_connect += time_6 - time_5;
3143 time_total += time_6 - time_1;
3145 " - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
3146 Ticks<MillisecondsDouble>(time_6 - time_5),
3147 Ticks<SecondsDouble>(time_post_connect),
3148 Ticks<MillisecondsDouble>(time_post_connect) / num_blocks_total);
3149 LogPrint(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
3150 Ticks<MillisecondsDouble>(time_6 - time_1),
3151 Ticks<SecondsDouble>(time_total),
3152 Ticks<MillisecondsDouble>(time_total) / num_blocks_total);
3153
3154 // If we are the background validation chainstate, check to see if we are
3155 // done validating the snapshot (i.e. our tip has reached the snapshot's
3156 // base block).
3157 if (this != &m_chainman.ActiveChainstate()) {
3158 // This call may set `m_disabled`, which is referenced immediately
3159 // afterwards in ActivateBestChain, so that we stop connecting blocks
3160 // past the snapshot base.
3161 m_chainman.MaybeCompleteSnapshotValidation();
3162 }
3163
3164 if (m_chainman.m_options.signals) {
3165 m_chainman.m_options.signals->BlockConnected(chainstate_role,
3166 pthisBlock, pindexNew);
3167 }
3168 return true;
3169}
3170
3176 std::vector<const CBlockIndex *> &blocksToReconcile, bool fAutoUnpark) {
3178 do {
3179 CBlockIndex *pindexNew = nullptr;
3180
3181 // Find the best candidate header.
3182 {
3183 std::set<CBlockIndex *, CBlockIndexWorkComparator>::reverse_iterator
3184 it = setBlockIndexCandidates.rbegin();
3185 if (it == setBlockIndexCandidates.rend()) {
3186 return nullptr;
3187 }
3188 pindexNew = *it;
3189 }
3190
3191 // If this block will cause an avalanche finalized block to be reorged,
3192 // then we park it.
3193 {
3195 if (m_avalancheFinalizedBlockIndex &&
3196 !AreOnTheSameFork(pindexNew, m_avalancheFinalizedBlockIndex)) {
3197 LogPrintf("Park block %s because it forks prior to the "
3198 "avalanche finalized chaintip.\n",
3199 pindexNew->GetBlockHash().ToString());
3200 pindexNew->nStatus = pindexNew->nStatus.withParked();
3201 m_blockman.m_dirty_blockindex.insert(pindexNew);
3202 }
3203 }
3204
3205 const CBlockIndex *pindexFork = m_chain.FindFork(pindexNew);
3206
3207 // Check whether all blocks on the path between the currently active
3208 // chain and the candidate are valid. Just going until the active chain
3209 // is an optimization, as we know all blocks in it are valid already.
3210 CBlockIndex *pindexTest = pindexNew;
3211 bool hasValidAncestor = true;
3212 while (hasValidAncestor && pindexTest && pindexTest != pindexFork) {
3213 assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3214
3215 // If this is a parked chain, but it has enough PoW, clear the park
3216 // state.
3217 bool fParkedChain = pindexTest->nStatus.isOnParkedChain();
3218 if (fAutoUnpark && fParkedChain) {
3219 const CBlockIndex *pindexTip = m_chain.Tip();
3220
3221 // During initialization, pindexTip and/or pindexFork may be
3222 // null. In this case, we just ignore the fact that the chain is
3223 // parked.
3224 if (!pindexTip || !pindexFork) {
3225 UnparkBlock(pindexTest);
3226 continue;
3227 }
3228
3229 // A parked chain can be unparked if it has twice as much PoW
3230 // accumulated as the main chain has since the fork block.
3231 CBlockIndex const *pindexExtraPow = pindexTip;
3232 arith_uint256 requiredWork = pindexTip->nChainWork;
3233 switch (pindexTip->nHeight - pindexFork->nHeight) {
3234 // Limit the penality for depth 1, 2 and 3 to half a block
3235 // worth of work to ensure we don't fork accidentally.
3236 case 3:
3237 case 2:
3238 pindexExtraPow = pindexExtraPow->pprev;
3239 // FALLTHROUGH
3240 case 1: {
3241 const arith_uint256 deltaWork =
3242 pindexExtraPow->nChainWork - pindexFork->nChainWork;
3243 requiredWork += (deltaWork >> 1);
3244 break;
3245 }
3246 default:
3247 requiredWork +=
3248 pindexExtraPow->nChainWork - pindexFork->nChainWork;
3249 break;
3250 }
3251
3252 if (pindexNew->nChainWork > requiredWork) {
3253 // We have enough, clear the parked state.
3254 LogPrintf("Unpark chain up to block %s as it has "
3255 "accumulated enough PoW.\n",
3256 pindexNew->GetBlockHash().ToString());
3257 fParkedChain = false;
3258 UnparkBlock(pindexTest);
3259 }
3260 }
3261
3262 // Pruned nodes may have entries in setBlockIndexCandidates for
3263 // which block files have been deleted. Remove those as candidates
3264 // for the most work chain if we come across them; we can't switch
3265 // to a chain unless we have all the non-active-chain parent blocks.
3266 bool fInvalidChain = pindexTest->nStatus.isInvalid();
3267 bool fMissingData = !pindexTest->nStatus.hasData();
3268 if (!(fInvalidChain || fParkedChain || fMissingData)) {
3269 // The current block is acceptable, move to the parent, up to
3270 // the fork point.
3271 pindexTest = pindexTest->pprev;
3272 continue;
3273 }
3274
3275 // Candidate chain is not usable (either invalid or parked or
3276 // missing data)
3277 hasValidAncestor = false;
3278 setBlockIndexCandidates.erase(pindexTest);
3279
3280 if (fInvalidChain && (m_chainman.m_best_invalid == nullptr ||
3281 pindexNew->nChainWork >
3282 m_chainman.m_best_invalid->nChainWork)) {
3283 m_chainman.m_best_invalid = pindexNew;
3284 }
3285
3286 if (fParkedChain && (m_chainman.m_best_parked == nullptr ||
3287 pindexNew->nChainWork >
3288 m_chainman.m_best_parked->nChainWork)) {
3289 m_chainman.m_best_parked = pindexNew;
3290 }
3291
3292 LogPrintf("Considered switching to better tip %s but that chain "
3293 "contains a%s%s%s block.\n",
3294 pindexNew->GetBlockHash().ToString(),
3295 fInvalidChain ? "n invalid" : "",
3296 fParkedChain ? " parked" : "",
3297 fMissingData ? " missing-data" : "");
3298
3299 CBlockIndex *pindexFailed = pindexNew;
3300 // Remove the entire chain from the set.
3301 while (pindexTest != pindexFailed) {
3302 if (fInvalidChain || fParkedChain) {
3303 pindexFailed->nStatus =
3304 pindexFailed->nStatus.withFailedParent(fInvalidChain)
3305 .withParkedParent(fParkedChain);
3306 m_blockman.m_dirty_blockindex.insert(pindexFailed);
3307 } else if (fMissingData) {
3308 // If we're missing data, then add back to
3309 // m_blocks_unlinked, so that if the block arrives in the
3310 // future we can try adding to setBlockIndexCandidates
3311 // again.
3313 std::make_pair(pindexFailed->pprev, pindexFailed));
3314 }
3315 setBlockIndexCandidates.erase(pindexFailed);
3316 pindexFailed = pindexFailed->pprev;
3317 }
3318
3319 if (fInvalidChain || fParkedChain) {
3320 // We discovered a new chain tip that is either parked or
3321 // invalid, we may want to warn.
3323 }
3324 }
3325
3326 blocksToReconcile.push_back(pindexNew);
3327
3328 // We found a candidate that has valid ancestors. This is our guy.
3329 if (hasValidAncestor) {
3330 return pindexNew;
3331 }
3332 } while (true);
3333}
3334
3340 // Note that we can't delete the current block itself, as we may need to
3341 // return to it later in case a reorganization to a better block fails.
3342 auto it = setBlockIndexCandidates.begin();
3343 while (it != setBlockIndexCandidates.end() &&
3344 setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
3345 setBlockIndexCandidates.erase(it++);
3346 }
3347
3348 // Either the current tip or a successor of it we're working towards is left
3349 // in setBlockIndexCandidates.
3351}
3352
3361 BlockValidationState &state, CBlockIndex *pindexMostWork,
3362 const std::shared_ptr<const CBlock> &pblock, bool &fInvalidFound,
3363 const avalanche::Processor *const avalanche,
3364 const ChainstateRole chainstate_role) {
3366 if (m_mempool) {
3368 }
3369
3370 const CBlockIndex *pindexOldTip = m_chain.Tip();
3371 const CBlockIndex *pindexFork = m_chain.FindFork(pindexMostWork);
3372
3373 // Disconnect active blocks which are no longer in the best chain.
3374 bool fBlocksDisconnected = false;
3375 DisconnectedBlockTransactions disconnectpool;
3376 while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
3377 if (m_mempool && !fBlocksDisconnected) {
3378 // Import and clear mempool; we must do this to preserve
3379 // topological ordering in the mempool index. This is ok since
3380 // inserts into the mempool are very fast now in our new
3381 // implementation.
3382 disconnectpool.importMempool(*m_mempool);
3383 }
3384
3385 if (!DisconnectTip(state, &disconnectpool)) {
3386 // This is likely a fatal error, but keep the mempool consistent,
3387 // just in case. Only remove from the mempool in this case.
3388 if (m_mempool) {
3389 disconnectpool.updateMempoolForReorg(*this, false, *m_mempool);
3390 }
3391
3392 // If we're unable to disconnect a block during normal operation,
3393 // then that is a failure of our local system -- we should abort
3394 // rather than stay on a less work chain.
3396 "Failed to disconnect block; see debug.log for details");
3397 return false;
3398 }
3399
3400 fBlocksDisconnected = true;
3401 }
3402
3403 // Build list of new blocks to connect.
3404 std::vector<CBlockIndex *> vpindexToConnect;
3405 bool fContinue = true;
3406 int nHeight = pindexFork ? pindexFork->nHeight : -1;
3407 while (fContinue && nHeight != pindexMostWork->nHeight) {
3408 // Don't iterate the entire list of potential improvements toward the
3409 // best tip, as we likely only need a few blocks along the way.
3410 int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3411 vpindexToConnect.clear();
3412 vpindexToConnect.reserve(nTargetHeight - nHeight);
3413 CBlockIndex *pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3414 while (pindexIter && pindexIter->nHeight != nHeight) {
3415 vpindexToConnect.push_back(pindexIter);
3416 pindexIter = pindexIter->pprev;
3417 }
3418
3419 nHeight = nTargetHeight;
3420
3421 // Connect new blocks.
3422 for (CBlockIndex *pindexConnect : reverse_iterate(vpindexToConnect)) {
3423 BlockPolicyValidationState blockPolicyState;
3424 if (!ConnectTip(state, blockPolicyState, pindexConnect,
3425 pindexConnect == pindexMostWork
3426 ? pblock
3427 : std::shared_ptr<const CBlock>(),
3428 disconnectpool, avalanche, chainstate_role)) {
3429 if (state.IsInvalid()) {
3430 // The block violates a consensus rule.
3431 if (state.GetResult() !=
3433 InvalidChainFound(vpindexToConnect.front());
3434 }
3435 state = BlockValidationState();
3436 fInvalidFound = true;
3437 fContinue = false;
3438 break;
3439 }
3440
3441 if (blockPolicyState.IsInvalid()) {
3442 // The block violates a policy rule.
3443 CBlockIndex *pindexParkedDescendant = pindexMostWork;
3444 while (pindexParkedDescendant &&
3445 pindexParkedDescendant != pindexConnect) {
3446 pindexParkedDescendant->nStatus =
3447 pindexParkedDescendant->nStatus.withParkedParent();
3449 pindexParkedDescendant);
3450 setBlockIndexCandidates.erase(pindexParkedDescendant);
3451 pindexParkedDescendant = pindexParkedDescendant->pprev;
3452 }
3453 fContinue = false;
3454 break;
3455 }
3456
3457 // A system error occurred (disk space, database error, ...).
3458 // Make the mempool consistent with the current tip, just in
3459 // case any observers try to use it before shutdown.
3460 if (m_mempool) {
3461 disconnectpool.updateMempoolForReorg(*this, false,
3462 *m_mempool);
3463 }
3464 return false;
3465 } else {
3467 if (!pindexOldTip ||
3468 m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
3469 // We're in a better position than we were. Return
3470 // temporarily to release the lock.
3471 fContinue = false;
3472 break;
3473 }
3474 }
3475 }
3476 }
3477
3478 if (m_mempool) {
3479 if (fBlocksDisconnected || !disconnectpool.isEmpty()) {
3480 // If any blocks were disconnected, we need to update the mempool
3481 // even if disconnectpool is empty. The disconnectpool may also be
3482 // non-empty if the mempool was imported due to new validation rules
3483 // being in effect.
3485 "Updating mempool due to reorganization or "
3486 "rules upgrade/downgrade\n");
3487 disconnectpool.updateMempoolForReorg(*this, true, *m_mempool);
3488 }
3489
3490 m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
3491 }
3492
3493 // Callbacks/notifications for a new best chain.
3494 if (fInvalidFound) {
3496 } else {
3498 }
3499
3500 return true;
3501}
3502
3504 bool reindexing) {
3505 if (!init) {
3507 }
3508 if (reindexing) {
3510 }
3512}
3513
3516 bool fNotify = false;
3517 bool fInitialBlockDownload = false;
3518 static CBlockIndex *pindexHeaderOld = nullptr;
3519 CBlockIndex *pindexHeader = nullptr;
3520 {
3521 LOCK(cs_main);
3522 pindexHeader = chainman.m_best_header;
3523
3524 if (pindexHeader != pindexHeaderOld) {
3525 fNotify = true;
3526 fInitialBlockDownload = chainman.IsInitialBlockDownload();
3527 pindexHeaderOld = pindexHeader;
3528 }
3529 }
3530
3531 // Send block tip changed notifications without cs_main
3532 if (fNotify) {
3533 chainman.GetNotifications().headerTip(
3534 GetSynchronizationState(fInitialBlockDownload,
3535 chainman.m_blockman.m_reindexing),
3536 pindexHeader->nHeight, pindexHeader->nTime, false);
3537 }
3538 return fNotify;
3539}
3540
3544
3545 if (signals.CallbacksPending() > 10) {
3546 signals.SyncWithValidationInterfaceQueue();
3547 }
3548}
3549
3551 std::shared_ptr<const CBlock> pblock,
3554
3555 // Note that while we're often called here from ProcessNewBlock, this is
3556 // far from a guarantee. Things in the P2P/RPC will often end up calling
3557 // us in the middle of ProcessNewBlock - do not assume pblock is set
3558 // sanely for performance or correctness!
3560
3561 // ABC maintains a fair degree of expensive-to-calculate internal state
3562 // because this function periodically releases cs_main so that it does not
3563 // lock up other threads for too long during large connects - and to allow
3564 // for e.g. the callback queue to drain we use m_chainstate_mutex to enforce
3565 // mutual exclusion so that only one caller may execute this function at a
3566 // time
3568
3569 // Belt-and-suspenders check that we aren't attempting to advance the
3570 // background chainstate past the snapshot base block.
3571 if (WITH_LOCK(::cs_main, return m_disabled)) {
3572 LogPrintf("m_disabled is set - this chainstate should not be in "
3573 "operation. Please report this as a bug. %s\n",
3574 PACKAGE_BUGREPORT);
3575 return false;
3576 }
3577
3578 CBlockIndex *pindexMostWork = nullptr;
3579 CBlockIndex *pindexNewTip = nullptr;
3580 bool exited_ibd{false};
3581 do {
3582 // Block until the validation queue drains. This should largely
3583 // never happen in normal operation, however may happen during
3584 // reindex, causing memory blowup if we run too far ahead.
3585 // Note that if a validationinterface callback ends up calling
3586 // ActivateBestChain this may lead to a deadlock! We should
3587 // probably have a DEBUG_LOCKORDER test for this in the future.
3590 }
3591
3592 std::vector<const CBlockIndex *> blocksToReconcile;
3593 bool blocks_connected = false;
3594
3595 {
3596 LOCK(cs_main);
3597 // Lock transaction pool for at least as long as it takes for
3598 // updateMempoolForReorg to be executed if needed
3599 LOCK(MempoolMutex());
3600 const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3601 CBlockIndex *starting_tip = m_chain.Tip();
3602 do {
3603 // We absolutely may not unlock cs_main until we've made forward
3604 // progress (with the exception of shutdown due to hardware
3605 // issues, low disk space, etc).
3606
3607 if (pindexMostWork == nullptr) {
3608 pindexMostWork = FindMostWorkChain(
3609 blocksToReconcile,
3611 }
3612
3613 // Whether we have anything to do at all.
3614 if (pindexMostWork == nullptr ||
3615 pindexMostWork == m_chain.Tip()) {
3616 break;
3617 }
3618
3619 bool fInvalidFound = false;
3620 std::shared_ptr<const CBlock> nullBlockPtr;
3621 // BlockConnected signals must be sent for the original role;
3622 // in case snapshot validation is completed during
3623 // ActivateBestChainStep, the result of GetRole() changes from
3624 // BACKGROUND to NORMAL.
3625 const ChainstateRole chainstate_role{this->GetRole()};
3627 state, pindexMostWork,
3628 pblock && pblock->GetHash() ==
3629 pindexMostWork->GetBlockHash()
3630 ? pblock
3631 : nullBlockPtr,
3632 fInvalidFound, avalanche, chainstate_role)) {
3633 // A system error occurred
3634 return false;
3635 }
3636 blocks_connected = true;
3637
3638 if (fInvalidFound ||
3639 (pindexMostWork &&
3640 pindexMostWork->nStatus.isOnParkedChain())) {
3641 // Wipe cache, we may need another branch now.
3642 pindexMostWork = nullptr;
3643 }
3644
3645 pindexNewTip = m_chain.Tip();
3646
3647 // This will have been toggled in
3648 // ActivateBestChainStep -> ConnectTip ->
3649 // MaybeCompleteSnapshotValidation, if at all, so we should
3650 // catch it here.
3651 //
3652 // Break this do-while to ensure we don't advance past the base
3653 // snapshot.
3654 if (m_disabled) {
3655 break;
3656 }
3657 } while (!m_chain.Tip() ||
3658 (starting_tip && CBlockIndexWorkComparator()(
3659 m_chain.Tip(), starting_tip)));
3660
3661 // Check the index once we're done with the above loop, since
3662 // we're going to release cs_main soon. If the index is in a bad
3663 // state now, then it's better to know immediately rather than
3664 // randomly have it cause a problem in a race.
3666
3667 if (blocks_connected) {
3668 const CBlockIndex *pindexFork = m_chain.FindFork(starting_tip);
3669 bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3670
3671 if (was_in_ibd && !still_in_ibd) {
3672 // Active chainstate has exited IBD
3673 exited_ibd = true;
3674 }
3675
3676 // Notify external listeners about the new tip.
3677 // Enqueue while holding cs_main to ensure that UpdatedBlockTip
3678 // is called in the order in which blocks are connected
3679 if (this == &m_chainman.ActiveChainstate() &&
3680 pindexFork != pindexNewTip) {
3681 // Notify ValidationInterface subscribers
3684 pindexNewTip, pindexFork, still_in_ibd);
3685 }
3686
3687 // Always notify the UI if a new block tip was connected
3691 still_in_ibd,
3693 *pindexNewTip))) {
3694 // Just breaking and returning success for now. This
3695 // could be changed to bubble up the kernel::Interrupted
3696 // value to the caller so the caller could distinguish
3697 // between completed and interrupted operations.
3698 break;
3699 }
3700 }
3701 }
3702 }
3703 // When we reach this point, we switched to a new tip (stored in
3704 // pindexNewTip).
3705 if (avalanche) {
3706 const CBlockIndex *pfinalized =
3708 return m_avalancheFinalizedBlockIndex);
3709 for (const CBlockIndex *pindex : blocksToReconcile) {
3710 avalanche->addToReconcile(pindex);
3711
3712 // Compute staking rewards for all blocks with more chainwork to
3713 // just after the finalized block. We could stop at the fork
3714 // point, but this is more robust.
3715 if (blocks_connected) {
3716 const CBlockIndex *pindexTest = pindex;
3717 while (pindexTest && pindexTest != pfinalized) {
3718 if (pindexTest->nHeight < pindex->nHeight - 3) {
3719 // Only compute up to some max depth
3720 break;
3721 }
3722 avalanche->computeStakingReward(pindexTest);
3723 pindexTest = pindexTest->pprev;
3724 }
3725 }
3726 }
3727 }
3728
3729 if (!blocks_connected) {
3730 return true;
3731 }
3732
3733 if (exited_ibd) {
3734 // If a background chainstate is in use, we may need to rebalance
3735 // our allocation of caches once a chainstate exits initial block
3736 // download.
3737 LOCK(::cs_main);
3738 m_chainman.MaybeRebalanceCaches();
3739 }
3740
3741 if (WITH_LOCK(::cs_main, return m_disabled)) {
3742 // Background chainstate has reached the snapshot base block, so
3743 // exit.
3744
3745 // Restart indexes to resume indexing for all blocks unique to the
3746 // snapshot chain. This resumes indexing "in order" from where the
3747 // indexing on the background validation chain left off.
3748 //
3749 // This cannot be done while holding cs_main (within
3750 // MaybeCompleteSnapshotValidation) or a cs_main deadlock will
3751 // occur.
3754 }
3755 break;
3756 }
3757
3758 // We check interrupt only after giving ActivateBestChainStep a chance
3759 // to run once so that we never interrupt before connecting the genesis
3760 // block during LoadChainTip(). Previously this caused an assert()
3761 // failure during interrupt in such cases as the UTXO DB flushing checks
3762 // that the best block hash is non-null.
3763 if (m_chainman.m_interrupt) {
3764 break;
3765 }
3766 } while (pindexNewTip != pindexMostWork);
3767
3768 // Write changes periodically to disk, after relay.
3770 return false;
3771 }
3772
3773 return true;
3774}
3775
3780 {
3781 LOCK(cs_main);
3782 if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
3783 // Nothing to do, this block is not at the tip.
3784 return true;
3785 }
3786
3788 // The chain has been extended since the last call, reset the
3789 // counter.
3791 }
3792
3794 setBlockIndexCandidates.erase(pindex);
3797 std::numeric_limits<int32_t>::min()) {
3798 // We can't keep reducing the counter if somebody really wants to
3799 // call preciousblock 2**31-1 times on the same set of tips...
3801 }
3802
3803 // In case this was parked, unpark it.
3804 UnparkBlock(pindex);
3805
3806 // Make sure it is added to the candidate list if appropriate.
3807 if (pindex->IsValid(BlockValidity::TRANSACTIONS) &&
3808 pindex->HaveNumChainTxs()) {
3809 setBlockIndexCandidates.insert(pindex);
3811 }
3812 }
3813
3814 return ActivateBestChain(state, /*pblock=*/nullptr, avalanche);
3815}
3816
3817namespace {
3818// Leverage RAII to run a functor at scope end
3819template <typename Func> struct Defer {
3820 Func func;
3821 Defer(Func &&f) : func(std::move(f)) {}
3822 ~Defer() { func(); }
3823};
3824} // namespace
3825
3827 bool invalidate) {
3828 // Genesis block can't be invalidated or parked
3829 assert(pindex);
3830 if (pindex->nHeight == 0) {
3831 return false;
3832 }
3833
3834 CBlockIndex *to_mark_failed_or_parked = pindex;
3835 bool pindex_was_in_chain = false;
3836 int disconnected = 0;
3837
3838 // We do not allow ActivateBestChain() to run while UnwindBlock() is
3839 // running, as that could cause the tip to change while we disconnect
3840 // blocks. (Note for backport of Core PR16849: we acquire
3841 // LOCK(m_chainstate_mutex) in the Park, Invalidate and FinalizeBlock
3842 // functions due to differences in our code)
3844
3845 // We'll be acquiring and releasing cs_main below, to allow the validation
3846 // callbacks to run. However, we should keep the block index in a
3847 // consistent state as we disconnect blocks -- in particular we need to
3848 // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3849 // To avoid walking the block index repeatedly in search of candidates,
3850 // build a map once so that we can look up candidate blocks by chain
3851 // work as we go.
3852 std::multimap<const arith_uint256, CBlockIndex *> candidate_blocks_by_work;
3853
3854 {
3855 LOCK(cs_main);
3856 for (auto &entry : m_blockman.m_block_index) {
3857 CBlockIndex *candidate = &entry.second;
3858 // We don't need to put anything in our active chain into the
3859 // multimap, because those candidates will be found and considered
3860 // as we disconnect.
3861 // Instead, consider only non-active-chain blocks that have at
3862 // least as much work as where we expect the new tip to end up.
3863 if (!m_chain.Contains(candidate) &&
3864 !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3866 candidate->HaveNumChainTxs()) {
3867 candidate_blocks_by_work.insert(
3868 std::make_pair(candidate->nChainWork, candidate));
3869 }
3870 }
3871 }
3872
3873 {
3874 LOCK(cs_main);
3875 // Lock for as long as disconnectpool is in scope to make sure
3876 // UpdateMempoolForReorg is called after DisconnectTip without unlocking
3877 // in between
3878 LOCK(MempoolMutex());
3879
3880 constexpr int maxDisconnectPoolBlocks = 10;
3881 bool ret = false;
3882 DisconnectedBlockTransactions disconnectpool;
3883 // After 10 blocks this becomes nullptr, so that DisconnectTip will
3884 // stop giving us unwound block txs if we are doing a deep unwind.
3885 DisconnectedBlockTransactions *optDisconnectPool = &disconnectpool;
3886
3887 // Disable thread safety analysis because we can't require m_mempool->cs
3888 // as m_mempool can be null. We keep the runtime analysis though.
3889 Defer deferred([&]() NO_THREAD_SAFETY_ANALYSIS {
3891 if (m_mempool && !disconnectpool.isEmpty()) {
3893 // DisconnectTip will add transactions to disconnectpool.
3894 // When all unwinding is done and we are on a new tip, we must
3895 // add all transactions back to the mempool against the new tip.
3896 disconnectpool.updateMempoolForReorg(*this,
3897 /* fAddToMempool = */ ret,
3898 *m_mempool);
3899 }
3900 });
3901
3902 // Disconnect (descendants of) pindex, and mark them invalid.
3903 while (true) {
3904 if (m_chainman.m_interrupt) {
3905 break;
3906 }
3907
3908 // Make sure the queue of validation callbacks doesn't grow
3909 // unboundedly.
3910 // FIXME this commented code is a regression and could cause OOM if
3911 // a very old block is invalidated via the invalidateblock RPC.
3912 // This can be uncommented if the main signals are moved away from
3913 // cs_main or this code is refactored so that cs_main can be
3914 // released at this point.
3915 //
3916 // LimitValidationInterfaceQueue();
3917
3918 if (!m_chain.Contains(pindex)) {
3919 break;
3920 }
3921
3922 if (m_mempool && disconnected == 0) {
3923 // On first iteration, we grab all the mempool txs to preserve
3924 // topological ordering. This has the side-effect of temporarily
3925 // clearing the mempool, but we will re-add later in
3926 // updateMempoolForReorg() (above). This technique guarantees
3927 // mempool consistency as well as ensures that our topological
3928 // entry_id index is always correct.
3929 disconnectpool.importMempool(*m_mempool);
3930 }
3931
3932 pindex_was_in_chain = true;
3933 CBlockIndex *invalid_walk_tip = m_chain.Tip();
3934
3935 // ActivateBestChain considers blocks already in m_chain
3936 // unconditionally valid already, so force disconnect away from it.
3937
3938 ret = DisconnectTip(state, optDisconnectPool);
3939 ++disconnected;
3940
3941 if (optDisconnectPool && disconnected > maxDisconnectPoolBlocks) {
3942 // Stop using the disconnect pool after 10 blocks. After 10
3943 // blocks we no longer add block tx's to the disconnectpool.
3944 // However, when this scope ends we will reconcile what's
3945 // in the pool with the new tip (in the deferred d'tor above).
3946 optDisconnectPool = nullptr;
3947 }
3948
3949 if (!ret) {
3950 return false;
3951 }
3952
3953 assert(invalid_walk_tip->pprev == m_chain.Tip());
3954
3955 // We immediately mark the disconnected blocks as invalid.
3956 // This prevents a case where pruned nodes may fail to
3957 // invalidateblock and be left unable to start as they have no tip
3958 // candidates (as there are no blocks that meet the "have data and
3959 // are not invalid per nStatus" criteria for inclusion in
3960 // setBlockIndexCandidates).
3961
3962 invalid_walk_tip->nStatus =
3963 invalidate ? invalid_walk_tip->nStatus.withFailed()
3964 : invalid_walk_tip->nStatus.withParked();
3965
3966 m_blockman.m_dirty_blockindex.insert(invalid_walk_tip);
3967 setBlockIndexCandidates.insert(invalid_walk_tip->pprev);
3968
3969 if (invalid_walk_tip == to_mark_failed_or_parked->pprev &&
3970 (invalidate ? to_mark_failed_or_parked->nStatus.hasFailed()
3971 : to_mark_failed_or_parked->nStatus.isParked())) {
3972 // We only want to mark the last disconnected block as
3973 // Failed (or Parked); its children need to be FailedParent (or
3974 // ParkedParent) instead.
3975 to_mark_failed_or_parked->nStatus =
3976 (invalidate
3977 ? to_mark_failed_or_parked->nStatus.withFailed(false)
3978 .withFailedParent()
3979 : to_mark_failed_or_parked->nStatus.withParked(false)
3980 .withParkedParent());
3981
3982 m_blockman.m_dirty_blockindex.insert(to_mark_failed_or_parked);
3983 }
3984
3985 // Add any equal or more work headers to setBlockIndexCandidates
3986 auto candidate_it = candidate_blocks_by_work.lower_bound(
3987 invalid_walk_tip->pprev->nChainWork);
3988 while (candidate_it != candidate_blocks_by_work.end()) {
3989 if (!CBlockIndexWorkComparator()(candidate_it->second,
3990 invalid_walk_tip->pprev)) {
3991 setBlockIndexCandidates.insert(candidate_it->second);
3992 candidate_it = candidate_blocks_by_work.erase(candidate_it);
3993 } else {
3994 ++candidate_it;
3995 }
3996 }
3997
3998 // Track the last disconnected block, so we can correct its
3999 // FailedParent (or ParkedParent) status in future iterations, or,
4000 // if it's the last one, call InvalidChainFound on it.
4001 to_mark_failed_or_parked = invalid_walk_tip;
4002 }
4003 }
4004
4006
4007 {
4008 LOCK(cs_main);
4009 if (m_chain.Contains(to_mark_failed_or_parked)) {
4010 // If the to-be-marked invalid block is in the active chain,
4011 // something is interfering and we can't proceed.
4012 return false;
4013 }
4014
4015 // Mark pindex (or the last disconnected block) as invalid (or parked),
4016 // even when it never was in the main chain.
4017 to_mark_failed_or_parked->nStatus =
4018 invalidate ? to_mark_failed_or_parked->nStatus.withFailed()
4019 : to_mark_failed_or_parked->nStatus.withParked();
4020 m_blockman.m_dirty_blockindex.insert(to_mark_failed_or_parked);
4021 if (invalidate) {
4022 m_chainman.m_failed_blocks.insert(to_mark_failed_or_parked);
4023 }
4024
4025 // If any new blocks somehow arrived while we were disconnecting
4026 // (above), then the pre-calculation of what should go into
4027 // setBlockIndexCandidates may have missed entries. This would
4028 // technically be an inconsistency in the block index, but if we clean
4029 // it up here, this should be an essentially unobservable error.
4030 // Loop back over all block index entries and add any missing entries
4031 // to setBlockIndexCandidates.
4032 for (auto &[_, block_index] : m_blockman.m_block_index) {
4033 if (block_index.IsValid(BlockValidity::TRANSACTIONS) &&
4034 block_index.HaveNumChainTxs() &&
4035 !setBlockIndexCandidates.value_comp()(&block_index,
4036 m_chain.Tip())) {
4037 setBlockIndexCandidates.insert(&block_index);
4038 }
4039 }
4040
4041 if (invalidate) {
4042 InvalidChainFound(to_mark_failed_or_parked);
4043 }
4044 }
4045
4046 // Only notify about a new block tip if the active chain was modified.
4047 if (pindex_was_in_chain) {
4048 // Ignoring return value for now, this could be changed to bubble up
4049 // kernel::Interrupted value to the caller so the caller could
4050 // distinguish between completed and interrupted operations. It might
4051 // also make sense for the blockTip notification to have an enum
4052 // parameter indicating the source of the tip change so hooks can
4053 // distinguish user-initiated invalidateblock changes from other
4054 // changes.
4058 *to_mark_failed_or_parked->pprev);
4059 }
4060 return true;
4061}
4062
4064 CBlockIndex *pindex) {
4067 // See 'Note for backport of Core PR16849' in Chainstate::UnwindBlock
4069
4070 return UnwindBlock(state, pindex, true);
4071}
4072
4076 // See 'Note for backport of Core PR16849' in Chainstate::UnwindBlock
4078
4079 return UnwindBlock(state, pindex, false);
4080}
4081
4082template <typename F>
4084 CBlockIndex *pindex, F f) {
4085 BlockStatus newStatus = f(pindex->nStatus);
4086 if (pindex->nStatus != newStatus &&
4087 (!pindexBase ||
4088 pindex->GetAncestor(pindexBase->nHeight) == pindexBase)) {
4089 pindex->nStatus = newStatus;
4090 m_blockman.m_dirty_blockindex.insert(pindex);
4091 if (newStatus.isValid()) {
4092 m_chainman.m_failed_blocks.erase(pindex);
4093 }
4094
4095 if (pindex->IsValid(BlockValidity::TRANSACTIONS) &&
4096 pindex->HaveNumChainTxs() &&
4097 setBlockIndexCandidates.value_comp()(m_chain.Tip(), pindex)) {
4098 setBlockIndexCandidates.insert(pindex);
4099 }
4100 return true;
4101 }
4102 return false;
4103}
4104
4105template <typename F, typename C, typename AC>
4107 F f, C fChild, AC fAncestorWasChanged) {
4109
4110 // Update the current block and ancestors; while we're doing this, identify
4111 // which was the deepest ancestor we changed.
4112 CBlockIndex *pindexDeepestChanged = pindex;
4113 for (auto pindexAncestor = pindex; pindexAncestor != nullptr;
4114 pindexAncestor = pindexAncestor->pprev) {
4115 if (UpdateFlagsForBlock(nullptr, pindexAncestor, f)) {
4116 pindexDeepestChanged = pindexAncestor;
4117 }
4118 }
4119
4120 if (pindexReset &&
4121 pindexReset->GetAncestor(pindexDeepestChanged->nHeight) ==
4122 pindexDeepestChanged) {
4123 // reset pindexReset if it had a modified ancestor.
4124 pindexReset = nullptr;
4125 }
4126
4127 // Update all blocks under modified blocks.
4128 for (auto &[_, block_index] : m_blockman.m_block_index) {
4129 UpdateFlagsForBlock(pindex, &block_index, fChild);
4130 UpdateFlagsForBlock(pindexDeepestChanged, &block_index,
4131 fAncestorWasChanged);
4132 }
4133}
4134
4135void Chainstate::SetBlockFailureFlags(CBlockIndex *invalid_block) {
4137
4138 for (auto &[_, block_index] : m_blockman.m_block_index) {
4139 if (block_index.GetAncestor(invalid_block->nHeight) == invalid_block &&
4140 !block_index.nStatus.isInvalid()) {
4141 block_index.nStatus = block_index.nStatus.withFailedParent();
4142 }
4143 }
4144}
4145
4148
4150 pindex, m_chainman.m_best_invalid,
4151 [](const BlockStatus status) {
4152 return status.withClearedFailureFlags();
4153 },
4154 [](const BlockStatus status) {
4155 return status.withClearedFailureFlags();
4156 },
4157 [](const BlockStatus status) {
4158 return status.withFailedParent(false);
4159 });
4160}
4161
4164 // The block only is a candidate for the most-work-chain if it has the same
4165 // or more work than our current tip.
4166 if (m_chain.Tip() != nullptr &&
4167 setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
4168 return;
4169 }
4170
4171 bool is_active_chainstate = this == &m_chainman.ActiveChainstate();
4172 if (is_active_chainstate) {
4173 // The active chainstate should always add entries that have more
4174 // work than the tip.
4175 setBlockIndexCandidates.insert(pindex);
4176 } else if (!m_disabled) {
4177 // For the background chainstate, we only consider connecting blocks
4178 // towards the snapshot base (which can't be nullptr or else we'll
4179 // never make progress).
4180 const CBlockIndex *snapshot_base{
4181 Assert(m_chainman.GetSnapshotBaseBlock())};
4182 if (snapshot_base->GetAncestor(pindex->nHeight) == pindex) {
4183 setBlockIndexCandidates.insert(pindex);
4184 }
4185 }
4186}
4187
4188void Chainstate::UnparkBlockImpl(CBlockIndex *pindex, bool fClearChildren) {
4190
4192 pindex, m_chainman.m_best_parked,
4193 [](const BlockStatus status) {
4194 return status.withClearedParkedFlags();
4195 },
4196 [fClearChildren](const BlockStatus status) {
4197 return fClearChildren ? status.withClearedParkedFlags()
4198 : status.withParkedParent(false);
4199 },
4200 [](const BlockStatus status) {
4201 return status.withParkedParent(false);
4202 });
4203}
4204
4206 return UnparkBlockImpl(pindex, true);
4207}
4208
4210 return UnparkBlockImpl(pindex, false);
4211}
4212
4213bool Chainstate::AvalancheFinalizeBlock(CBlockIndex *pindex,
4217
4218 if (!pindex) {
4219 return false;
4220 }
4221
4222 if (!m_chain.Contains(pindex)) {
4224 "The block to mark finalized by avalanche is not on the "
4225 "active chain: %s\n",
4226 pindex->GetBlockHash().ToString());
4227 return false;
4228 }
4229
4230 if (IsBlockAvalancheFinalized(pindex)) {
4231 return true;
4232 }
4233
4234 {
4236 m_avalancheFinalizedBlockIndex = pindex;
4237 }
4238
4241 }
4242
4243 return true;
4244}
4245
4248 m_avalancheFinalizedBlockIndex = nullptr;
4249}
4250
4253 return pindex && m_avalancheFinalizedBlockIndex &&
4254 m_avalancheFinalizedBlockIndex->GetAncestor(pindex->nHeight) ==
4255 pindex;
4256}
4257
4263 CBlockIndex *pindexNew,
4264 const FlatFilePos &pos) {
4265 pindexNew->nTx = block.vtx.size();
4266 // Typically nChainTX will be 0 at this point, but it can be nonzero if this
4267 // is a pruned block which is being downloaded again, or if this is an
4268 // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value
4269 // from the snapshot metadata. If the pindex is not the snapshot block and
4270 // the nChainTx value is not zero, assert that value is actually correct.
4271 auto prev_tx_sum = [](CBlockIndex &block) {
4272 return block.nTx + (block.pprev ? block.pprev->nChainTx : 0);
4273 };
4274 if (!Assume(pindexNew->nChainTx == 0 ||
4275 pindexNew->nChainTx == prev_tx_sum(*pindexNew) ||
4276 pindexNew == GetSnapshotBaseBlock())) {
4277 LogPrintf("Internal bug detected: block %d has unexpected nChainTx %i "
4278 "that should be %i. Please report this issue here: %s\n",
4279 pindexNew->nHeight, pindexNew->nChainTx,
4280 prev_tx_sum(*pindexNew), PACKAGE_BUGREPORT);
4281 pindexNew->nChainTx = 0;
4282 }
4283 pindexNew->nSize = ::GetSerializeSize(block);
4284 pindexNew->nFile = pos.nFile;
4285 pindexNew->nDataPos = pos.nPos;
4286 pindexNew->nUndoPos = 0;
4287 pindexNew->nStatus = pindexNew->nStatus.withData();
4289 m_blockman.m_dirty_blockindex.insert(pindexNew);
4290
4291 if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
4292 // If pindexNew is the genesis block or all parents are
4293 // BLOCK_VALID_TRANSACTIONS.
4294 std::deque<CBlockIndex *> queue;
4295 queue.push_back(pindexNew);
4296
4297 // Recursively process any descendant blocks that now may be eligible to
4298 // be connected.
4299 while (!queue.empty()) {
4300 CBlockIndex *pindex = queue.front();
4301 queue.pop_front();
4302 // Before setting nChainTx, assert that it is 0 or already set to
4303 // the correct value. This assert will fail after receiving the
4304 // assumeutxo snapshot block if assumeutxo snapshot metadata has an
4305 // incorrect hardcoded AssumeutxoData::nChainTx value.
4306 if (!Assume(pindex->nChainTx == 0 ||
4307 pindex->nChainTx == prev_tx_sum(*pindex))) {
4308 LogPrintf(
4309 "Internal bug detected: block %d has unexpected nChainTx "
4310 "%i that should be %i. Please report this issue here: %s\n",
4311 pindex->nHeight, pindex->nChainTx, prev_tx_sum(*pindex),
4312 PACKAGE_BUGREPORT);
4313 }
4314 pindex->nChainTx = prev_tx_sum(*pindex);
4315 if (pindex->nSequenceId == 0) {
4316 // We assign a sequence is when transaction are received to
4317 // prevent a miner from being able to broadcast a block but not
4318 // its content. However, a sequence id may have been set
4319 // manually, for instance via PreciousBlock, in which case, we
4320 // don't need to assign one.
4321 pindex->nSequenceId = nBlockSequenceId++;
4322 }
4323 for (Chainstate *c : GetAll()) {
4324 c->TryAddBlockIndexCandidate(pindex);
4325 }
4326
4327 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
4328 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
4329 range = m_blockman.m_blocks_unlinked.equal_range(pindex);
4330 while (range.first != range.second) {
4331 std::multimap<CBlockIndex *, CBlockIndex *>::iterator it =
4332 range.first;
4333 queue.push_back(it->second);
4334 range.first++;
4335 m_blockman.m_blocks_unlinked.erase(it);
4336 }
4337 }
4338 } else if (pindexNew->pprev &&
4339 pindexNew->pprev->IsValid(BlockValidity::TREE)) {
4341 std::make_pair(pindexNew->pprev, pindexNew));
4342 }
4343}
4344
4353static bool CheckBlockHeader(const CBlockHeader &block,
4354 BlockValidationState &state,
4355 const Consensus::Params &params,
4356 BlockValidationOptions validationOptions) {
4357 // Check proof of work matches claimed amount
4358 if (validationOptions.shouldValidatePoW() &&
4359 !CheckProofOfWork(block.GetHash(), block.nBits, params)) {
4361 "high-hash", "proof of work failed");
4362 }
4363
4364 return true;
4365}
4366
4367static bool CheckMerkleRoot(const CBlock &block, BlockValidationState &state) {
4368 if (block.m_checked_merkle_root) {
4369 return true;
4370 }
4371
4372 bool mutated;
4373 uint256 merkle_root = BlockMerkleRoot(block, &mutated);
4374 if (block.hashMerkleRoot != merkle_root) {
4375 return state.Invalid(
4377 /*reject_reason=*/"bad-txnmrklroot",
4378 /*debug_message=*/"hashMerkleRoot mismatch");
4379 }
4380
4381 // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
4382 // of transactions in a block without affecting the merkle root of a block,
4383 // while still invalidating it.
4384 if (mutated) {
4385 return state.Invalid(
4387 /*reject_reason=*/"bad-txns-duplicate",
4388 /*debug_message=*/"duplicate transaction");
4389 }
4390
4391 block.m_checked_merkle_root = true;
4392 return true;
4393}
4394
4395bool CheckBlock(const CBlock &block, BlockValidationState &state,
4396 const Consensus::Params &params,
4397 BlockValidationOptions validationOptions) {
4398 // These are checks that are independent of context.
4399 if (block.fChecked) {
4400 return true;
4401 }
4402
4403 // Check that the header is valid (particularly PoW). This is mostly
4404 // redundant with the call in AcceptBlockHeader.
4405 if (!CheckBlockHeader(block, state, params, validationOptions)) {
4406 return false;
4407 }
4408
4409 // Check the merkle root.
4410 if (validationOptions.shouldValidateMerkleRoot() &&
4411 !CheckMerkleRoot(block, state)) {
4412 return false;
4413 }
4414
4415 // All potential-corruption validation must be done before we do any
4416 // transaction validation, as otherwise we may mark the header as invalid
4417 // because we receive the wrong transactions for it.
4418
4419 // First transaction must be coinbase.
4420 if (block.vtx.empty()) {
4422 "bad-cb-missing", "first tx is not coinbase");
4423 }
4424
4425 // Size limits.
4426 auto nMaxBlockSize = validationOptions.getExcessiveBlockSize();
4427
4428 // Bail early if there is no way this block is of reasonable size.
4429 if ((block.vtx.size() * MIN_TRANSACTION_SIZE) > nMaxBlockSize) {
4431 "bad-blk-length", "size limits failed");
4432 }
4433
4434 auto currentBlockSize = ::GetSerializeSize(block);
4435 if (currentBlockSize > nMaxBlockSize) {
4437 "bad-blk-length", "size limits failed");
4438 }
4439
4440 // And a valid coinbase.
4441 TxValidationState tx_state;
4442 if (!CheckCoinbase(*block.vtx[0], tx_state)) {
4444 tx_state.GetRejectReason(),
4445 strprintf("Coinbase check failed (txid %s) %s",
4446 block.vtx[0]->GetId().ToString(),
4447 tx_state.GetDebugMessage()));
4448 }
4449
4450 // Check transactions for regularity, skipping the first. Note that this
4451 // is the first time we check that all after the first are !IsCoinBase.
4452 for (size_t i = 1; i < block.vtx.size(); i++) {
4453 auto *tx = block.vtx[i].get();
4454 if (!CheckRegularTransaction(*tx, tx_state)) {
4455 return state.Invalid(
4457 tx_state.GetRejectReason(),
4458 strprintf("Transaction check failed (txid %s) %s",
4459 tx->GetId().ToString(), tx_state.GetDebugMessage()));
4460 }
4461 }
4462
4463 if (validationOptions.shouldValidatePoW() &&
4464 validationOptions.shouldValidateMerkleRoot()) {
4465 block.fChecked = true;
4466 }
4467
4468 return true;
4469}
4470
4471bool HasValidProofOfWork(const std::vector<CBlockHeader> &headers,
4472 const Consensus::Params &consensusParams) {
4473 return std::all_of(headers.cbegin(), headers.cend(),
4474 [&](const auto &header) {
4475 return CheckProofOfWork(
4476 header.GetHash(), header.nBits, consensusParams);
4477 });
4478}
4479
4480bool IsBlockMutated(const CBlock &block) {
4482 if (!CheckMerkleRoot(block, state)) {
4484 "Block mutated: %s\n", state.ToString());
4485 return true;
4486 }
4487
4488 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4489 // Consider the block mutated if any transaction is 64 bytes in size
4490 // (see 3.1 in "Weaknesses in Bitcoin’s Merkle Root Construction":
4491 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4492 //
4493 // Note: This is not a consensus change as this only applies to blocks
4494 // that don't have a coinbase transaction and would therefore already be
4495 // invalid.
4496 return std::any_of(block.vtx.begin(), block.vtx.end(),
4497 [](auto &tx) { return GetSerializeSize(tx) == 64; });
4498 } else {
4499 // Theoretically it is still possible for a block with a 64 byte
4500 // coinbase transaction to be mutated but we neglect that possibility
4501 // here as it requires at least 224 bits of work.
4502 }
4503
4504 return false;
4505}
4506
4508CalculateClaimedHeadersWork(const std::vector<CBlockHeader> &headers) {
4509 arith_uint256 total_work{0};
4510 for (const CBlockHeader &header : headers) {
4511 CBlockIndex dummy(header);
4512 total_work += GetBlockProof(dummy);
4513 }
4514 return total_work;
4515}
4516
4528 const CBlockHeader &block, BlockValidationState &state,
4529 BlockManager &blockman, ChainstateManager &chainman,
4530 const CBlockIndex *pindexPrev, NodeClock::time_point now,
4531 const std::optional<CCheckpointData> &test_checkpoints = std::nullopt)
4534 assert(pindexPrev != nullptr);
4535 const int nHeight = pindexPrev->nHeight + 1;
4536
4537 const CChainParams &params = chainman.GetParams();
4538
4539 // Check proof of work
4540 if (block.nBits != GetNextWorkRequired(pindexPrev, &block, params)) {
4541 LogPrintf("bad bits after height: %d\n", pindexPrev->nHeight);
4543 "bad-diffbits", "incorrect proof of work");
4544 }
4545
4546 // Check against checkpoints
4547 if (chainman.m_options.checkpoints_enabled) {
4548 const CCheckpointData &checkpoints =
4549 test_checkpoints ? test_checkpoints.value() : params.Checkpoints();
4550
4551 // Check that the block chain matches the known block chain up to a
4552 // checkpoint.
4553 if (!Checkpoints::CheckBlock(checkpoints, nHeight, block.GetHash())) {
4555 "ERROR: %s: rejected by checkpoint lock-in at %d\n",
4556 __func__, nHeight);
4558 "checkpoint mismatch");
4559 }
4560
4561 // Don't accept any forks from the main chain prior to last checkpoint.
4562 // GetLastCheckpoint finds the last checkpoint in MapCheckpoints that's
4563 // in our BlockIndex().
4564
4565 const CBlockIndex *pcheckpoint =
4566 blockman.GetLastCheckpoint(checkpoints);
4567 if (pcheckpoint && nHeight < pcheckpoint->nHeight) {
4569 "ERROR: %s: forked chain older than last checkpoint "
4570 "(height %d)\n",
4571 __func__, nHeight);
4573 "bad-fork-prior-to-checkpoint");
4574 }
4575 }
4576
4577 // Check timestamp against prev
4578 if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast()) {
4580 "time-too-old", "block's timestamp is too early");
4581 }
4582
4583 // Check timestamp
4584 if (block.Time() > now + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4586 "time-too-new",
4587 "block timestamp too far in the future");
4588 }
4589
4590 // Reject blocks with outdated version
4591 if ((block.nVersion < 2 &&
4592 DeploymentActiveAfter(pindexPrev, chainman,
4594 (block.nVersion < 3 &&
4595 DeploymentActiveAfter(pindexPrev, chainman,
4597 (block.nVersion < 4 &&
4598 DeploymentActiveAfter(pindexPrev, chainman,
4600 return state.Invalid(
4602 strprintf("bad-version(0x%08x)", block.nVersion),
4603 strprintf("rejected nVersion=0x%08x block", block.nVersion));
4604 }
4605
4606 return true;
4607}
4608
4616static bool ContextualCheckBlock(const CBlock &block,
4617 BlockValidationState &state,
4618 const ChainstateManager &chainman,
4619 const CBlockIndex *pindexPrev) {
4620 const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4621
4622 // Enforce BIP113 (Median Time Past).
4623 bool enforce_locktime_median_time_past{false};
4624 if (DeploymentActiveAfter(pindexPrev, chainman,
4626 assert(pindexPrev != nullptr);
4627 enforce_locktime_median_time_past = true;
4628 }
4629
4630 const int64_t nMedianTimePast =
4631 pindexPrev == nullptr ? 0 : pindexPrev->GetMedianTimePast();
4632
4633 const int64_t nLockTimeCutoff{enforce_locktime_median_time_past
4634 ? nMedianTimePast
4635 : block.GetBlockTime()};
4636
4637 const Consensus::Params params = chainman.GetConsensus();
4638 const bool fIsMagneticAnomalyEnabled =
4639 IsMagneticAnomalyEnabled(params, pindexPrev);
4640
4641 // Check transactions:
4642 // - canonical ordering
4643 // - ensure they are finalized
4644 // - check they have the minimum size
4645 const CTransaction *prevTx = nullptr;
4646 for (const auto &ptx : block.vtx) {
4647 const CTransaction &tx = *ptx;
4648 if (fIsMagneticAnomalyEnabled) {
4649 if (prevTx && (tx.GetId() <= prevTx->GetId())) {
4650 if (tx.GetId() == prevTx->GetId()) {
4652 "tx-duplicate",
4653 strprintf("Duplicated transaction %s",
4654 tx.GetId().ToString()));
4655 }
4656
4657 return state.Invalid(
4659 strprintf("Transaction order is invalid (%s < %s)",
4660 tx.GetId().ToString(),
4661 prevTx->GetId().ToString()));
4662 }
4663
4664 if (prevTx || !tx.IsCoinBase()) {
4665 prevTx = &tx;
4666 }
4667 }
4668
4669 TxValidationState tx_state;
4670 if (!ContextualCheckTransaction(params, tx, tx_state, nHeight,
4671 nLockTimeCutoff)) {
4673 tx_state.GetRejectReason(),
4674 tx_state.GetDebugMessage());
4675 }
4676 }
4677
4678 // Enforce rule that the coinbase starts with serialized block height
4679 if (DeploymentActiveAfter(pindexPrev, chainman,
4681 CScript expect = CScript() << nHeight;
4682 if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
4683 !std::equal(expect.begin(), expect.end(),
4684 block.vtx[0]->vin[0].scriptSig.begin())) {
4686 "bad-cb-height",
4687 "block height mismatch in coinbase");
4688 }
4689 }
4690
4691 return true;
4692}
4693
4700 const CBlockHeader &block, BlockValidationState &state,
4701 CBlockIndex **ppindex, bool min_pow_checked,
4702 const std::optional<CCheckpointData> &test_checkpoints) {
4704 const Config &config = this->GetConfig();
4705 const CChainParams &chainparams = config.GetChainParams();
4706
4707 // Check for duplicate
4708 BlockHash hash = block.GetHash();
4709 BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4710 if (hash != chainparams.GetConsensus().hashGenesisBlock) {
4711 if (miSelf != m_blockman.m_block_index.end()) {
4712 // Block header is already known.
4713 CBlockIndex *pindex = &(miSelf->second);
4714 if (ppindex) {
4715 *ppindex = pindex;
4716 }
4717
4718 if (pindex->nStatus.isInvalid()) {
4719 LogPrint(BCLog::VALIDATION, "%s: block %s is marked invalid\n",
4720 __func__, hash.ToString());
4721 return state.Invalid(
4723 }
4724
4725 return true;
4726 }
4727
4728 if (!CheckBlockHeader(block, state, chainparams.GetConsensus(),
4729 BlockValidationOptions(config))) {
4731 "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__,
4732 hash.ToString(), state.ToString());
4733 return false;
4734 }
4735
4736 // Get prev block index
4737 BlockMap::iterator mi{
4738 m_blockman.m_block_index.find(block.hashPrevBlock)};
4739 if (mi == m_blockman.m_block_index.end()) {
4741 "header %s has prev block not found: %s\n",
4742 hash.ToString(), block.hashPrevBlock.ToString());
4744 "prev-blk-not-found");
4745 }
4746
4747 CBlockIndex *pindexPrev = &((*mi).second);
4748 assert(pindexPrev);
4749 if (pindexPrev->nStatus.isInvalid()) {
4751 "header %s has prev block invalid: %s\n", hash.ToString(),
4752 block.hashPrevBlock.ToString());
4754 "bad-prevblk");
4755 }
4756
4758 block, state, m_blockman, *this, pindexPrev,
4759 m_options.adjusted_time_callback(), test_checkpoints)) {
4761 "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n",
4762 __func__, hash.ToString(), state.ToString());
4763 return false;
4764 }
4765
4766 /* Determine if this block descends from any block which has been found
4767 * invalid (m_failed_blocks), then mark pindexPrev and any blocks
4768 * between them as failed. For example:
4769 *
4770 * D3
4771 * /
4772 * B2 - C2
4773 * / \
4774 * A D2 - E2 - F2
4775 * \
4776 * B1 - C1 - D1 - E1
4777 *
4778 * In the case that we attempted to reorg from E1 to F2, only to find
4779 * C2 to be invalid, we would mark D2, E2, and F2 as BLOCK_FAILED_CHILD
4780 * but NOT D3 (it was not in any of our candidate sets at the time).
4781 *
4782 * In any case D3 will also be marked as BLOCK_FAILED_CHILD at restart
4783 * in LoadBlockIndex.
4784 */
4785 if (!pindexPrev->IsValid(BlockValidity::SCRIPTS)) {
4786 // The above does not mean "invalid": it checks if the previous
4787 // block hasn't been validated up to BlockValidity::SCRIPTS. This is
4788 // a performance optimization, in the common case of adding a new
4789 // block to the tip, we don't need to iterate over the failed blocks
4790 // list.
4791 for (const CBlockIndex *failedit : m_failed_blocks) {
4792 if (pindexPrev->GetAncestor(failedit->nHeight) == failedit) {
4793 assert(failedit->nStatus.hasFailed());
4794 CBlockIndex *invalid_walk = pindexPrev;
4795 while (invalid_walk != failedit) {
4796 invalid_walk->nStatus =
4797 invalid_walk->nStatus.withFailedParent();
4798 m_blockman.m_dirty_blockindex.insert(invalid_walk);
4799 invalid_walk = invalid_walk->pprev;
4800 }
4802 "header %s has prev block invalid: %s\n",
4803 hash.ToString(), block.hashPrevBlock.ToString());
4804 return state.Invalid(
4806 "bad-prevblk");
4807 }
4808 }
4809 }
4810 }
4811 if (!min_pow_checked) {
4813 "%s: not adding new block header %s, missing anti-dos "
4814 "proof-of-work validation\n",
4815 __func__, hash.ToString());
4817 "too-little-chainwork");
4818 }
4819 CBlockIndex *pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4820
4821 if (ppindex) {
4822 *ppindex = pindex;
4823 }
4824
4825 // Since this is the earliest point at which we have determined that a
4826 // header is both new and valid, log here.
4827 //
4828 // These messages are valuable for detecting potential selfish mining
4829 // behavior; if multiple displacing headers are seen near simultaneously
4830 // across many nodes in the network, this might be an indication of selfish
4831 // mining. Having this log by default when not in IBD ensures broad
4832 // availability of this data in case investigation is merited.
4833 const auto msg = strprintf("Saw new header hash=%s height=%d",
4834 hash.ToString(), pindex->nHeight);
4835
4836 if (IsInitialBlockDownload()) {
4838 } else {
4839 LogPrintf("%s\n", msg);
4840 }
4841
4842 return true;
4843}
4844
4845// Exposed wrapper for AcceptBlockHeader
4847 const std::vector<CBlockHeader> &headers, bool min_pow_checked,
4848 BlockValidationState &state, const CBlockIndex **ppindex,
4849 const std::optional<CCheckpointData> &test_checkpoints) {
4851 {
4852 LOCK(cs_main);
4853 for (const CBlockHeader &header : headers) {
4854 // Use a temp pindex instead of ppindex to avoid a const_cast
4855 CBlockIndex *pindex = nullptr;
4856 bool accepted = AcceptBlockHeader(
4857 header, state, &pindex, min_pow_checked, test_checkpoints);
4859
4860 if (!accepted) {
4861 return false;
4862 }
4863
4864 if (ppindex) {
4865 *ppindex = pindex;
4866 }
4867 }
4868 }
4869
4870 if (NotifyHeaderTip(*this)) {
4871 if (IsInitialBlockDownload() && ppindex && *ppindex) {
4872 const CBlockIndex &last_accepted{**ppindex};
4873 int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) /
4875 blocks_left = std::max<int64_t>(0, blocks_left);
4876 const double progress{100.0 * last_accepted.nHeight /
4877 (last_accepted.nHeight + blocks_left)};
4878 LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n",
4879 last_accepted.nHeight, progress);
4880 }
4881 }
4882 return true;
4883}
4884
4886 int64_t height,
4887 int64_t timestamp) {
4889 {
4890 LOCK(cs_main);
4891 // Don't report headers presync progress if we already have a
4892 // post-minchainwork header chain.
4893 // This means we lose reporting for potentially legimate, but unlikely,
4894 // deep reorgs, but prevent attackers that spam low-work headers from
4895 // filling our logs.
4896 if (m_best_header->nChainWork >=
4897 UintToArith256(GetConsensus().nMinimumChainWork)) {
4898 return;
4899 }
4900 // Rate limit headers presync updates to 4 per second, as these are not
4901 // subject to DoS protection.
4902 auto now = Now<SteadyMilliseconds>();
4903 if (now < m_last_presync_update + 250ms) {
4904 return;
4905 }
4906 m_last_presync_update = now;
4907 }
4908 bool initial_download = IsInitialBlockDownload();
4911 height, timestamp, /*presync=*/true);
4912 if (initial_download) {
4913 int64_t blocks_left{
4914 (NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) /
4916 blocks_left = std::max<int64_t>(0, blocks_left);
4917 const double progress{100.0 * height / (height + blocks_left)};
4918 LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n",
4919 height, progress);
4920 }
4921}
4922
4923bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock> &pblock,
4924 BlockValidationState &state,
4925 bool fRequested, const FlatFilePos *dbp,
4926 bool *fNewBlock, bool min_pow_checked) {
4928
4929 const CBlock &block = *pblock;
4930 if (fNewBlock) {
4931 *fNewBlock = false;
4932 }
4933
4934 CBlockIndex *pindex = nullptr;
4935
4936 bool accepted_header{
4937 AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4939
4940 if (!accepted_header) {
4941 return false;
4942 }
4943
4944 // Check all requested blocks that we do not already have for validity and
4945 // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4946 // measure, unless the blocks have more work than the active chain tip, and
4947 // aren't too far ahead of it, so are likely to be attached soon.
4948 bool fAlreadyHave = pindex->nStatus.hasData();
4949
4950 // TODO: deal better with return value and error conditions for duplicate
4951 // and unrequested blocks.
4952 if (fAlreadyHave) {
4953 return true;
4954 }
4955
4956 // Compare block header timestamps and received times of the block and the
4957 // chaintip. If they have the same chain height, use these diffs as a
4958 // tie-breaker, attempting to pick the more honestly-mined block.
4959 int64_t newBlockTimeDiff = std::llabs(pindex->GetReceivedTimeDiff());
4960 int64_t chainTipTimeDiff =
4961 ActiveTip() ? std::llabs(ActiveTip()->GetReceivedTimeDiff()) : 0;
4962
4963 bool isSameHeight =
4964 ActiveTip() && (pindex->nChainWork == ActiveTip()->nChainWork);
4965 if (isSameHeight) {
4966 LogPrintf("Chain tip timestamp-to-received-time difference: hash=%s, "
4967 "diff=%d\n",
4968 ActiveTip()->GetBlockHash().ToString(), chainTipTimeDiff);
4969 LogPrintf("New block timestamp-to-received-time difference: hash=%s, "
4970 "diff=%d\n",
4971 pindex->GetBlockHash().ToString(), newBlockTimeDiff);
4972 }
4973
4974 bool fHasMoreOrSameWork =
4975 (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4976
4977 // Blocks that are too out-of-order needlessly limit the effectiveness of
4978 // pruning, because pruning will not delete block files that contain any
4979 // blocks which are too close in height to the tip. Apply this test
4980 // regardless of whether pruning is enabled; it should generally be safe to
4981 // not process unrequested blocks.
4982 bool fTooFarAhead{pindex->nHeight >
4984
4985 // TODO: Decouple this function from the block download logic by removing
4986 // fRequested
4987 // This requires some new chain data structure to efficiently look up if a
4988 // block is in a chain leading to a candidate for best tip, despite not
4989 // being such a candidate itself.
4990 // Note that this would break the getblockfrompeer RPC
4991
4992 // If we didn't ask for it:
4993 if (!fRequested) {
4994 // This is a previously-processed block that was pruned.
4995 if (pindex->nTx != 0) {
4996 return true;
4997 }
4998
4999 // Don't process less-work chains.
5000 if (!fHasMoreOrSameWork) {
5001 return true;
5002 }
5003
5004 // Block height is too high.
5005 if (fTooFarAhead) {
5006 return true;
5007 }
5008
5009 // Protect against DoS attacks from low-work chains.
5010 // If our tip is behind, a peer could try to send us
5011 // low-work blocks on a fake chain that we would never
5012 // request; don't process these.
5013 if (pindex->nChainWork < MinimumChainWork()) {
5014 return true;
5015 }
5016 }
5017
5018 if (!CheckBlock(block, state,
5021 !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
5022 if (state.IsInvalid() &&
5024 pindex->nStatus = pindex->nStatus.withFailed();
5025 m_blockman.m_dirty_blockindex.insert(pindex);
5026 }
5027
5028 LogError("%s: %s (block %s)\n", __func__, state.ToString(),
5029 block.GetHash().ToString());
5030 return false;
5031 }
5032
5033 // If connecting the new block would require rewinding more than one block
5034 // from the active chain (i.e., a "deep reorg"), then mark the new block as
5035 // parked. If it has enough work then it will be automatically unparked
5036 // later, during FindMostWorkChain. We mark the block as parked at the very
5037 // last minute so we can make sure everything is ready to be reorged if
5038 // needed.
5040 // Blocks that are below the snapshot height can't cause reorgs, as the
5041 // active tip is at least thousands of blocks higher. Don't park them,
5042 // they will most likely connect on the tip of the background chain.
5043 std::optional<int> snapshot_base_height = GetSnapshotBaseHeight();
5044 const bool is_background_block =
5045 snapshot_base_height && BackgroundSyncInProgress() &&
5046 pindex->nHeight <= snapshot_base_height;
5047 const CBlockIndex *pindexFork = ActiveChain().FindFork(pindex);
5048 if (!is_background_block && pindexFork &&
5049 pindexFork->nHeight + 1 < ActiveHeight()) {
5050 LogPrintf("Park block %s as it would cause a deep reorg.\n",
5051 pindex->GetBlockHash().ToString());
5052 pindex->nStatus = pindex->nStatus.withParked();
5053 m_blockman.m_dirty_blockindex.insert(pindex);
5054 }
5055 }
5056
5057 // Header is valid/has work and the merkle tree is good.
5058 // Relay now, but if it does not build on our best tip, let the
5059 // SendMessages loop relay it.
5060 if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev &&
5062 m_options.signals->NewPoWValidBlock(pindex, pblock);
5063 }
5064
5065 // Write block to history file
5066 if (fNewBlock) {
5067 *fNewBlock = true;
5068 }
5069 try {
5070 FlatFilePos blockPos{};
5071 if (dbp) {
5072 blockPos = *dbp;
5073 m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
5074 } else {
5075 blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
5076 if (blockPos.IsNull()) {
5077 state.Error(strprintf(
5078 "%s: Failed to find position to write new block to disk",
5079 __func__));
5080 return false;
5081 }
5082 }
5083 ReceivedBlockTransactions(block, pindex, blockPos);
5084 } catch (const std::runtime_error &e) {
5085 return FatalError(GetNotifications(), state,
5086 std::string("System error: ") + e.what());
5087 }
5088
5089 // TODO: FlushStateToDisk() handles flushing of both block and chainstate
5090 // data, so we should move this to ChainstateManager so that we can be more
5091 // intelligent about how we flush.
5092 // For now, since FlushStateMode::NONE is used, all that can happen is that
5093 // the block files may be pruned, so we can just call this on one
5094 // chainstate (particularly if we haven't implemented pruning with
5095 // background validation yet).
5096 ActiveChainstate().FlushStateToDisk(state, FlushStateMode::NONE);
5097
5099
5100 return true;
5101}
5102
5104 const std::shared_ptr<const CBlock> &block, bool force_processing,
5105 bool min_pow_checked, bool *new_block,
5108
5109 {
5110 if (new_block) {
5111 *new_block = false;
5112 }
5113
5115
5116 // CheckBlock() does not support multi-threaded block validation
5117 // because CBlock::fChecked can cause data race.
5118 // Therefore, the following critical section must include the
5119 // CheckBlock() call as well.
5120 LOCK(cs_main);
5121
5122 // Skipping AcceptBlock() for CheckBlock() failures means that we will
5123 // never mark a block as invalid if CheckBlock() fails. This is
5124 // protective against consensus failure if there are any unknown form
5125 // s of block malleability that cause CheckBlock() to fail; see e.g.
5126 // CVE-2012-2459 and
5127 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html.
5128 // Because CheckBlock() is not very expensive, the anti-DoS benefits of
5129 // caching failure (of a definitely-invalid block) are not substantial.
5130 bool ret = CheckBlock(*block, state, this->GetConsensus(),
5132 if (ret) {
5133 // Store to disk
5134 ret = AcceptBlock(block, state, force_processing, nullptr,
5135 new_block, min_pow_checked);
5136 }
5137
5138 if (!ret) {
5139 if (m_options.signals) {
5140 m_options.signals->BlockChecked(*block, state);
5141 }
5142 LogError("%s: AcceptBlock FAILED (%s)\n", __func__,
5143 state.ToString());
5144 return false;
5145 }
5146 }
5147
5148 NotifyHeaderTip(*this);
5149
5150 // Only used to report errors, not invalidity - ignore it
5152 if (!ActiveChainstate().ActivateBestChain(state, block, avalanche)) {
5153 LogError("%s: ActivateBestChain failed (%s)\n", __func__,
5154 state.ToString());
5155 return false;
5156 }
5157
5159 ? m_ibd_chainstate.get()
5160 : nullptr)};
5161 BlockValidationState bg_state;
5162 if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
5163 LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__,
5164 bg_state.ToString());
5165 return false;
5166 }
5167
5168 return true;
5169}
5170
5173 bool test_accept) {
5175 Chainstate &active_chainstate = ActiveChainstate();
5176 if (!active_chainstate.GetMempool()) {
5177 TxValidationState state;
5178 state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
5179 return MempoolAcceptResult::Failure(state);
5180 }
5181 auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(),
5182 /*bypass_limits=*/false, test_accept);
5183 active_chainstate.GetMempool()->check(
5184 active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
5185 return result;
5186}
5187
5189 BlockValidationState &state, const CChainParams &params,
5190 Chainstate &chainstate, const CBlock &block, CBlockIndex *pindexPrev,
5191 const std::function<NodeClock::time_point()> &adjusted_time_callback,
5192 BlockValidationOptions validationOptions) {
5194 assert(pindexPrev && pindexPrev == chainstate.m_chain.Tip());
5195 CCoinsViewCache viewNew(&chainstate.CoinsTip());
5196 BlockHash block_hash(block.GetHash());
5197 CBlockIndex indexDummy(block);
5198 indexDummy.pprev = pindexPrev;
5199 indexDummy.nHeight = pindexPrev->nHeight + 1;
5200 indexDummy.phashBlock = &block_hash;
5201
5202 // NOTE: CheckBlockHeader is called by CheckBlock
5203 if (!ContextualCheckBlockHeader(block, state, chainstate.m_blockman,
5204 chainstate.m_chainman, pindexPrev,
5205 adjusted_time_callback())) {
5206 LogError("%s: Consensus::ContextualCheckBlockHeader: %s\n", __func__,
5207 state.ToString());
5208 return false;
5209 }
5210
5211 if (!CheckBlock(block, state, params.GetConsensus(), validationOptions)) {
5212 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
5213 return false;
5214 }
5215
5216 if (!ContextualCheckBlock(block, state, chainstate.m_chainman,
5217 pindexPrev)) {
5218 LogError("%s: Consensus::ContextualCheckBlock: %s\n", __func__,
5219 state.ToString());
5220 return false;
5221 }
5222
5223 if (!chainstate.ConnectBlock(block, state, &indexDummy, viewNew,
5224 validationOptions, nullptr, true)) {
5225 return false;
5226 }
5227
5228 assert(state.IsValid());
5229 return true;
5230}
5231
5232/* This function is called from the RPC code for pruneblockchain */
5233void PruneBlockFilesManual(Chainstate &active_chainstate,
5234 int nManualPruneHeight) {
5236 if (active_chainstate.FlushStateToDisk(state, FlushStateMode::NONE,
5237 nManualPruneHeight)) {
5238 LogPrintf("%s: failed to flush state (%s)\n", __func__,
5239 state.ToString());
5240 }
5241}
5242
5245 const CCoinsViewCache &coins_cache = CoinsTip();
5246 // Never called when the coins view is empty
5247 assert(!coins_cache.GetBestBlock().IsNull());
5248 const CBlockIndex *tip = m_chain.Tip();
5249
5250 if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
5251 return true;
5252 }
5253
5254 // Load pointer to end of best chain
5255 CBlockIndex *pindex =
5257 if (!pindex) {
5258 return false;
5259 }
5260 m_chain.SetTip(*pindex);
5262
5263 tip = m_chain.Tip();
5264 LogPrintf(
5265 "Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f\n",
5266 tip->GetBlockHash().ToString(), m_chain.Height(),
5269 return true;
5270}
5271
5273 : m_notifications{notifications} {
5274 m_notifications.progress(_("Verifying blocks…"), 0, false);
5275}
5276
5278 m_notifications.progress(bilingual_str{}, 100, false);
5279}
5280
5282 CCoinsView &coinsview, int nCheckLevel,
5283 int nCheckDepth) {
5285
5286 const Config &config = chainstate.m_chainman.GetConfig();
5287 const CChainParams &params = config.GetChainParams();
5288 const Consensus::Params &consensusParams = params.GetConsensus();
5289
5290 if (chainstate.m_chain.Tip() == nullptr ||
5291 chainstate.m_chain.Tip()->pprev == nullptr) {
5293 }
5294
5295 // Verify blocks in the best chain
5296 if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
5297 nCheckDepth = chainstate.m_chain.Height();
5298 }
5299
5300 nCheckLevel = std::max(0, std::min(4, nCheckLevel));
5301 LogPrintf("Verifying last %i blocks at level %i\n", nCheckDepth,
5302 nCheckLevel);
5303
5304 CCoinsViewCache coins(&coinsview);
5305 CBlockIndex *pindex;
5306 CBlockIndex *pindexFailure = nullptr;
5307 int nGoodTransactions = 0;
5309 int reportDone = 0;
5310 bool skipped_no_block_data{false};
5311 bool skipped_l3_checks{false};
5312 LogPrintf("Verification progress: 0%%\n");
5313
5314 const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
5315
5316 for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev;
5317 pindex = pindex->pprev) {
5318 const int percentageDone = std::max(
5319 1, std::min(99, (int)(((double)(chainstate.m_chain.Height() -
5320 pindex->nHeight)) /
5321 (double)nCheckDepth *
5322 (nCheckLevel >= 4 ? 50 : 100))));
5323 if (reportDone < percentageDone / 10) {
5324 // report every 10% step
5325 LogPrintf("Verification progress: %d%%\n", percentageDone);
5326 reportDone = percentageDone / 10;
5327 }
5328
5329 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
5330 if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
5331 break;
5332 }
5333
5334 if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) &&
5335 !pindex->nStatus.hasData()) {
5336 // If pruning or running under an assumeutxo snapshot, only go
5337 // back as far as we have data.
5338 LogPrintf("VerifyDB(): block verification stopping at height %d "
5339 "(no data). This could be due to pruning or use of an "
5340 "assumeutxo snapshot.\n",
5341 pindex->nHeight);
5342 skipped_no_block_data = true;
5343 break;
5344 }
5345
5346 CBlock block;
5347
5348 // check level 0: read from disk
5349 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
5350 LogPrintf("Verification error: ReadBlock failed at %d, hash=%s\n",
5351 pindex->nHeight, pindex->GetBlockHash().ToString());
5353 }
5354
5355 // check level 1: verify block validity
5356 if (nCheckLevel >= 1 && !CheckBlock(block, state, consensusParams,
5357 BlockValidationOptions(config))) {
5358 LogPrintf(
5359 "Verification error: found bad block at %d, hash=%s (%s)\n",
5360 pindex->nHeight, pindex->GetBlockHash().ToString(),
5361 state.ToString());
5363 }
5364
5365 // check level 2: verify undo validity
5366 if (nCheckLevel >= 2 && pindex) {
5367 CBlockUndo undo;
5368 if (!pindex->GetUndoPos().IsNull()) {
5369 if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
5370 LogPrintf("Verification error: found bad undo data at %d, "
5371 "hash=%s\n",
5372 pindex->nHeight,
5373 pindex->GetBlockHash().ToString());
5375 }
5376 }
5377 }
5378 // check level 3: check for inconsistencies during memory-only
5379 // disconnect of tip blocks
5380 size_t curr_coins_usage = coins.DynamicMemoryUsage() +
5381 chainstate.CoinsTip().DynamicMemoryUsage();
5382
5383 if (nCheckLevel >= 3) {
5384 if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
5385 assert(coins.GetBestBlock() == pindex->GetBlockHash());
5386 DisconnectResult res =
5387 chainstate.DisconnectBlock(block, pindex, coins);
5388 if (res == DisconnectResult::FAILED) {
5389 LogPrintf("Verification error: irrecoverable inconsistency "
5390 "in block data at %d, hash=%s\n",
5391 pindex->nHeight,
5392 pindex->GetBlockHash().ToString());
5394 }
5395 if (res == DisconnectResult::UNCLEAN) {
5396 nGoodTransactions = 0;
5397 pindexFailure = pindex;
5398 } else {
5399 nGoodTransactions += block.vtx.size();
5400 }
5401 } else {
5402 skipped_l3_checks = true;
5403 }
5404 }
5405
5406 if (chainstate.m_chainman.m_interrupt) {
5408 }
5409 }
5410
5411 if (pindexFailure) {
5412 LogPrintf("Verification error: coin database inconsistencies found "
5413 "(last %i blocks, %i good transactions before that)\n",
5414 chainstate.m_chain.Height() - pindexFailure->nHeight + 1,
5415 nGoodTransactions);
5417 }
5418 if (skipped_l3_checks) {
5419 LogPrintf("Skipped verification of level >=3 (insufficient database "
5420 "cache size). Consider increasing -dbcache.\n");
5421 }
5422
5423 // store block count as we move pindex at check level >= 4
5424 int block_count = chainstate.m_chain.Height() - pindex->nHeight;
5425
5426 // check level 4: try reconnecting blocks
5427 if (nCheckLevel >= 4 && !skipped_l3_checks) {
5428 while (pindex != chainstate.m_chain.Tip()) {
5429 const int percentageDone = std::max(
5430 1, std::min(99, 100 - int(double(chainstate.m_chain.Height() -
5431 pindex->nHeight) /
5432 double(nCheckDepth) * 50)));
5433 if (reportDone < percentageDone / 10) {
5434 // report every 10% step
5435 LogPrintf("Verification progress: %d%%\n", percentageDone);
5436 reportDone = percentageDone / 10;
5437 }
5438 m_notifications.progress(_("Verifying blocks…"), percentageDone,
5439 false);
5440 pindex = chainstate.m_chain.Next(pindex);
5441 CBlock block;
5442 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
5443 LogPrintf("Verification error: ReadBlock failed at %d, "
5444 "hash=%s\n",
5445 pindex->nHeight, pindex->GetBlockHash().ToString());
5447 }
5448 if (!chainstate.ConnectBlock(block, state, pindex, coins,
5449 BlockValidationOptions(config))) {
5450 LogPrintf("Verification error: found unconnectable block at "
5451 "%d, hash=%s (%s)\n",
5452 pindex->nHeight, pindex->GetBlockHash().ToString(),
5453 state.ToString());
5455 }
5456 if (chainstate.m_chainman.m_interrupt) {
5458 }
5459 }
5460 }
5461
5462 LogPrintf("Verification: No coin database inconsistencies in last %i "
5463 "blocks (%i transactions)\n",
5464 block_count, nGoodTransactions);
5465
5466 if (skipped_l3_checks) {
5468 }
5469 if (skipped_no_block_data) {
5471 }
5473}
5474
5480 CCoinsViewCache &view) {
5482 // TODO: merge with ConnectBlock
5483 CBlock block;
5484 if (!m_blockman.ReadBlock(block, *pindex)) {
5485 LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n",
5486 pindex->nHeight, pindex->GetBlockHash().ToString());
5487 return false;
5488 }
5489
5490 for (const CTransactionRef &tx : block.vtx) {
5491 // Pass check = true as every addition may be an overwrite.
5492 AddCoins(view, *tx, pindex->nHeight, true);
5493 }
5494
5495 for (const CTransactionRef &tx : block.vtx) {
5496 if (tx->IsCoinBase()) {
5497 continue;
5498 }
5499
5500 for (const CTxIn &txin : tx->vin) {
5501 view.SpendCoin(txin.prevout);
5502 }
5503 }
5504
5505 return true;
5506}
5507
5509 LOCK(cs_main);
5510
5511 CCoinsView &db = this->CoinsDB();
5512 CCoinsViewCache cache(&db);
5513
5514 std::vector<BlockHash> hashHeads = db.GetHeadBlocks();
5515 if (hashHeads.empty()) {
5516 // We're already in a consistent state.
5517 return true;
5518 }
5519 if (hashHeads.size() != 2) {
5520 LogError("ReplayBlocks(): unknown inconsistent state\n");
5521 return false;
5522 }
5523
5524 m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
5525 LogPrintf("Replaying blocks\n");
5526
5527 // Old tip during the interrupted flush.
5528 const CBlockIndex *pindexOld = nullptr;
5529 // New tip during the interrupted flush.
5530 const CBlockIndex *pindexNew;
5531 // Latest block common to both the old and the new tip.
5532 const CBlockIndex *pindexFork = nullptr;
5533
5534 if (m_blockman.m_block_index.count(hashHeads[0]) == 0) {
5535 LogError("ReplayBlocks(): reorganization to unknown block requested\n");
5536 return false;
5537 }
5538
5539 pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
5540
5541 if (!hashHeads[1].IsNull()) {
5542 // The old tip is allowed to be 0, indicating it's the first flush.
5543 if (m_blockman.m_block_index.count(hashHeads[1]) == 0) {
5544 LogError("ReplayBlocks(): reorganization from unknown block "
5545 "requested\n");
5546 return false;
5547 }
5548
5549 pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
5550 pindexFork = LastCommonAncestor(pindexOld, pindexNew);
5551 assert(pindexFork != nullptr);
5552 }
5553
5554 // Rollback along the old branch.
5555 while (pindexOld != pindexFork) {
5556 if (pindexOld->nHeight > 0) {
5557 // Never disconnect the genesis block.
5558 CBlock block;
5559 if (!m_blockman.ReadBlock(block, *pindexOld)) {
5560 LogError("RollbackBlock(): ReadBlock() failed at "
5561 "%d, hash=%s\n",
5562 pindexOld->nHeight,
5563 pindexOld->GetBlockHash().ToString());
5564 return false;
5565 }
5566
5567 LogPrintf("Rolling back %s (%i)\n",
5568 pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
5569 DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
5570 if (res == DisconnectResult::FAILED) {
5571 LogError(
5572 "RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n",
5573 pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
5574 return false;
5575 }
5576
5577 // If DisconnectResult::UNCLEAN is returned, it means a non-existing
5578 // UTXO was deleted, or an existing UTXO was overwritten. It
5579 // corresponds to cases where the block-to-be-disconnect never had
5580 // all its operations applied to the UTXO set. However, as both
5581 // writing a UTXO and deleting a UTXO are idempotent operations, the
5582 // result is still a version of the UTXO set with the effects of
5583 // that block undone.
5584 }
5585 pindexOld = pindexOld->pprev;
5586 }
5587
5588 // Roll forward from the forking point to the new tip.
5589 int nForkHeight = pindexFork ? pindexFork->nHeight : 0;
5590 for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight;
5591 ++nHeight) {
5592 const CBlockIndex &pindex{*Assert(pindexNew->GetAncestor(nHeight))};
5593 LogPrintf("Rolling forward %s (%i)\n", pindex.GetBlockHash().ToString(),
5594 nHeight);
5596 _("Replaying blocks…"),
5597 (int)((nHeight - nForkHeight) * 100.0 /
5598 (pindexNew->nHeight - nForkHeight)),
5599 false);
5600 if (!RollforwardBlock(&pindex, cache)) {
5601 return false;
5602 }
5603 }
5604
5605 cache.SetBestBlock(pindexNew->GetBlockHash());
5606 // local CCoinsViewCache goes out of scope
5607 cache.Flush(/*reallocate_cache=*/false);
5609 return true;
5610}
5611
5612// May NOT be used after any connections are up as much of the peer-processing
5613// logic assumes a consistent block index state
5614void Chainstate::ClearBlockIndexCandidates() {
5616 m_best_fork_tip = nullptr;
5617 m_best_fork_base = nullptr;
5619}
5620
5623
5625 return false;
5626 }
5627
5628 // Dump enough headers for RTT computation, with a few extras in case a
5629 // reorg occurs.
5630 const uint64_t numHeaders{20};
5631
5632 try {
5633 const fs::path filePathTmp = filePath + ".new";
5634 FILE *filestr = fsbridge::fopen(filePathTmp, "wb");
5635 if (!filestr) {
5636 return false;
5637 }
5638
5639 AutoFile file{filestr};
5640 file << HEADERS_TIME_VERSION;
5641 file << numHeaders;
5642
5643 const CBlockIndex *index = ActiveTip();
5644 bool missingIndex{false};
5645 for (uint64_t i = 0; i < numHeaders; i++) {
5646 if (!index) {
5647 LogPrintf("Missing block index, stopping the headers time "
5648 "dumping after %d blocks.\n",
5649 i);
5650 missingIndex = true;
5651 break;
5652 }
5653
5654 file << index->GetBlockHash();
5655 file << index->GetHeaderReceivedTime();
5656
5657 index = index->pprev;
5658 }
5659
5660 if (!FileCommit(file.Get())) {
5661 throw std::runtime_error(strprintf("Failed to commit to file %s",
5662 PathToString(filePathTmp)));
5663 }
5664 file.fclose();
5665
5666 if (missingIndex) {
5667 fs::remove(filePathTmp);
5668 return false;
5669 }
5670
5671 if (!RenameOver(filePathTmp, filePath)) {
5672 throw std::runtime_error(strprintf("Rename failed from %s to %s",
5673 PathToString(filePathTmp),
5674 PathToString(filePath)));
5675 }
5676 } catch (const std::exception &e) {
5677 LogPrintf("Failed to dump the headers time: %s.\n", e.what());
5678 return false;
5679 }
5680
5681 LogPrintf("Successfully dumped the last %d headers time to %s.\n",
5682 numHeaders, PathToString(filePath));
5683
5684 return true;
5685}
5686
5689
5691 return false;
5692 }
5693
5694 FILE *filestr = fsbridge::fopen(filePath, "rb");
5695 AutoFile file{filestr};
5696 if (file.IsNull()) {
5697 LogPrintf("Failed to open header times from disk, skipping.\n");
5698 return false;
5699 }
5700
5701 try {
5702 uint64_t version;
5703 file >> version;
5704
5705 if (version != HEADERS_TIME_VERSION) {
5706 LogPrintf("Unsupported header times file version, skipping.\n");
5707 return false;
5708 }
5709
5710 uint64_t numBlocks;
5711 file >> numBlocks;
5712
5713 for (uint64_t i = 0; i < numBlocks; i++) {
5714 BlockHash blockHash;
5715 int64_t receiveTime;
5716
5717 file >> blockHash;
5718 file >> receiveTime;
5719
5720 CBlockIndex *index = m_blockman.LookupBlockIndex(blockHash);
5721 if (!index) {
5722 LogPrintf("Missing index for block %s, stopping the headers "
5723 "time loading after %d blocks.\n",
5724 blockHash.ToString(), i);
5725 return false;
5726 }
5727
5728 index->nTimeReceived = receiveTime;
5729 }
5730 } catch (const std::exception &e) {
5731 LogPrintf("Failed to read the headers time file data on disk: %s.\n",
5732 e.what());
5733 return false;
5734 }
5735
5736 return true;
5737}
5738
5741 // Load block index from databases
5742 bool needs_init = m_blockman.m_reindexing;
5743 if (!m_blockman.m_reindexing) {
5744 bool ret{m_blockman.LoadBlockIndexDB(SnapshotBlockhash())};
5745 if (!ret) {
5746 return false;
5747 }
5748
5749 m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
5750
5751 std::vector<CBlockIndex *> vSortedByHeight{
5752 m_blockman.GetAllBlockIndices()};
5753 std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
5755
5756 for (CBlockIndex *pindex : vSortedByHeight) {
5757 if (m_interrupt) {
5758 return false;
5759 }
5760 // If we have an assumeutxo-based chainstate, then the snapshot
5761 // block will be a candidate for the tip, but it may not be
5762 // VALID_TRANSACTIONS (eg if we haven't yet downloaded the block),
5763 // so we special-case the snapshot block as a potential candidate
5764 // here.
5765 if (pindex == GetSnapshotBaseBlock() ||
5767 (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
5768 for (Chainstate *chainstate : GetAll()) {
5769 chainstate->TryAddBlockIndexCandidate(pindex);
5770 }
5771 }
5772
5773 if (pindex->nStatus.isInvalid() &&
5774 (!m_best_invalid ||
5775 pindex->nChainWork > m_best_invalid->nChainWork)) {
5776 m_best_invalid = pindex;
5777 }
5778
5779 if (pindex->nStatus.isOnParkedChain() &&
5780 (!m_best_parked ||
5781 pindex->nChainWork > m_best_parked->nChainWork)) {
5782 m_best_parked = pindex;
5783 }
5784
5785 if (pindex->IsValid(BlockValidity::TREE) &&
5786 (m_best_header == nullptr ||
5787 CBlockIndexWorkComparator()(m_best_header, pindex))) {
5788 m_best_header = pindex;
5789 }
5790 }
5791
5792 needs_init = m_blockman.m_block_index.empty();
5793 }
5794
5795 if (needs_init) {
5796 // Everything here is for *new* reindex/DBs. Thus, though
5797 // LoadBlockIndexDB may have set m_reindexing if we shut down
5798 // mid-reindex previously, we don't check m_reindexing and
5799 // instead only check it prior to LoadBlockIndexDB to set
5800 // needs_init.
5801
5802 LogPrintf("Initializing databases...\n");
5803 }
5804 return true;
5805}
5806
5808 LOCK(cs_main);
5809
5810 const CChainParams &params{m_chainman.GetParams()};
5811
5812 // Check whether we're already initialized by checking for genesis in
5813 // m_blockman.m_block_index. Note that we can't use m_chain here, since it
5814 // is set based on the coins db, not the block index db, which is the only
5815 // thing loaded at this point.
5816 if (m_blockman.m_block_index.count(params.GenesisBlock().GetHash())) {
5817 return true;
5818 }
5819
5820 try {
5821 const CBlock &block = params.GenesisBlock();
5822 FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
5823 if (blockPos.IsNull()) {
5824 LogError("%s: writing genesis block to disk failed\n", __func__);
5825 return false;
5826 }
5827 CBlockIndex *pindex =
5828 m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
5829 m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
5830 } catch (const std::runtime_error &e) {
5831 LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
5832 return false;
5833 }
5834
5835 return true;
5836}
5837
5839 AutoFile &file_in, FlatFilePos *dbp,
5840 std::multimap<BlockHash, FlatFilePos> *blocks_with_unknown_parent,
5842 // Either both should be specified (-reindex), or neither (-loadblock).
5843 assert(!dbp == !blocks_with_unknown_parent);
5844
5845 int64_t nStart = GetTimeMillis();
5846 const CChainParams &params{GetParams()};
5847
5848 int nLoaded = 0;
5849 try {
5850 // Make sure we have at least 2*MAX_TX_SIZE space in the buffer
5851 // so any transaction can fit in there.
5852 BufferedFile blkdat{file_in, 2 * MAX_TX_SIZE, MAX_TX_SIZE + 8};
5853 // nRewind indicates where to resume scanning in case something goes
5854 // wrong, such as a block fails to deserialize.
5855 uint64_t nRewind = blkdat.GetPos();
5856 while (!blkdat.eof()) {
5857 if (m_interrupt) {
5858 return;
5859 }
5860
5861 blkdat.SetPos(nRewind);
5862 // Start one byte further next time, in case of failure.
5863 nRewind++;
5864 // Remove former limit.
5865 blkdat.SetLimit();
5866 unsigned int nSize = 0;
5867 try {
5868 // Locate a header.
5870 blkdat.FindByte(std::byte(params.DiskMagic()[0]));
5871 nRewind = blkdat.GetPos() + 1;
5872 blkdat >> buf;
5873 if (memcmp(buf, params.DiskMagic().data(),
5875 continue;
5876 }
5877
5878 // Read size.
5879 blkdat >> nSize;
5880 if (nSize < 80) {
5881 continue;
5882 }
5883 } catch (const std::exception &) {
5884 // No valid block header found; don't complain.
5885 // (this happens at the end of every blk.dat file)
5886 break;
5887 }
5888
5889 try {
5890 // read block header
5891 const uint64_t nBlockPos{blkdat.GetPos()};
5892 if (dbp) {
5893 dbp->nPos = nBlockPos;
5894 }
5895 blkdat.SetLimit(nBlockPos + nSize);
5896 CBlockHeader header;
5897 blkdat >> header;
5898 const BlockHash hash{header.GetHash()};
5899 // Skip the rest of this block (this may read from disk
5900 // into memory); position to the marker before the next block,
5901 // but it's still possible to rewind to the start of the
5902 // current block (without a disk read).
5903 nRewind = nBlockPos + nSize;
5904 blkdat.SkipTo(nRewind);
5905
5906 // needs to remain available after the cs_main lock is released
5907 // to avoid duplicate reads from disk
5908 std::shared_ptr<CBlock> pblock{};
5909
5910 {
5911 LOCK(cs_main);
5912 // detect out of order blocks, and store them for later
5913 if (hash != params.GetConsensus().hashGenesisBlock &&
5915 LogPrint(
5917 "%s: Out of order block %s, parent %s not known\n",
5918 __func__, hash.ToString(),
5919 header.hashPrevBlock.ToString());
5920 if (dbp && blocks_with_unknown_parent) {
5921 blocks_with_unknown_parent->emplace(
5922 header.hashPrevBlock, *dbp);
5923 }
5924 continue;
5925 }
5926
5927 // process in case the block isn't known yet
5928 const CBlockIndex *pindex =
5930 if (!pindex || !pindex->nStatus.hasData()) {
5931 // This block can be processed immediately; rewind to
5932 // its start, read and deserialize it.
5933 blkdat.SetPos(nBlockPos);
5934 pblock = std::make_shared<CBlock>();
5935 blkdat >> *pblock;
5936 nRewind = blkdat.GetPos();
5937
5939 if (AcceptBlock(pblock, state, true, dbp, nullptr,
5940 true)) {
5941 nLoaded++;
5942 }
5943 if (state.IsError()) {
5944 break;
5945 }
5946 } else if (hash != params.GetConsensus().hashGenesisBlock &&
5947 pindex->nHeight % 1000 == 0) {
5948 LogPrint(
5950 "Block Import: already had block %s at height %d\n",
5951 hash.ToString(), pindex->nHeight);
5952 }
5953 }
5954
5955 // Activate the genesis block so normal node progress can
5956 // continue
5957 if (hash == params.GetConsensus().hashGenesisBlock) {
5958 bool genesis_activation_failure = false;
5959 for (auto c : GetAll()) {
5961 if (!c->ActivateBestChain(state, nullptr, avalanche)) {
5962 genesis_activation_failure = true;
5963 break;
5964 }
5965 }
5966 if (genesis_activation_failure) {
5967 break;
5968 }
5969 }
5970
5972 pblock) {
5973 // Must update the tip for pruning to work while importing
5974 // with -loadblock. This is a tradeoff to conserve disk
5975 // space at the expense of time spent updating the tip to be
5976 // able to prune. Otherwise, ActivateBestChain won't be
5977 // called by the import process until after all of the block
5978 // files are loaded. ActivateBestChain can be called by
5979 // concurrent network message processing, but that is not
5980 // reliable for the purpose of pruning while importing.
5981 bool activation_failure = false;
5982 for (auto c : GetAll()) {
5984 if (!c->ActivateBestChain(state, pblock, avalanche)) {
5986 "failed to activate chain (%s)\n",
5987 state.ToString());
5988 activation_failure = true;
5989 break;
5990 }
5991 }
5992 if (activation_failure) {
5993 break;
5994 }
5995 }
5996
5997 NotifyHeaderTip(*this);
5998
5999 if (!blocks_with_unknown_parent) {
6000 continue;
6001 }
6002
6003 // Recursively process earlier encountered successors of this
6004 // block
6005 std::deque<BlockHash> queue;
6006 queue.push_back(hash);
6007 while (!queue.empty()) {
6008 BlockHash head = queue.front();
6009 queue.pop_front();
6010 auto range = blocks_with_unknown_parent->equal_range(head);
6011 while (range.first != range.second) {
6012 std::multimap<BlockHash, FlatFilePos>::iterator it =
6013 range.first;
6014 std::shared_ptr<CBlock> pblockrecursive =
6015 std::make_shared<CBlock>();
6016 if (m_blockman.ReadBlock(*pblockrecursive,
6017 it->second)) {
6018 LogPrint(
6020 "%s: Processing out of order child %s of %s\n",
6021 __func__, pblockrecursive->GetHash().ToString(),
6022 head.ToString());
6023 LOCK(cs_main);
6025 if (AcceptBlock(pblockrecursive, dummy, true,
6026 &it->second, nullptr, true)) {
6027 nLoaded++;
6028 queue.push_back(pblockrecursive->GetHash());
6029 }
6030 }
6031 range.first++;
6032 blocks_with_unknown_parent->erase(it);
6033 NotifyHeaderTip(*this);
6034 }
6035 }
6036 } catch (const std::exception &e) {
6037 // Historical bugs added extra data to the block files that does
6038 // not deserialize cleanly. Commonly this data is between
6039 // readable blocks, but it does not really matter. Such data is
6040 // not fatal to the import process. The code that reads the
6041 // block files deals with invalid data by simply ignoring it. It
6042 // continues to search for the next {4 byte magic message start
6043 // bytes + 4 byte length + block} that does deserialize cleanly
6044 // and passes all of the other block validation checks dealing
6045 // with POW and the merkle root, etc... We merely note with this
6046 // informational log message when unexpected data is
6047 // encountered. We could also be experiencing a storage system
6048 // read error, or a read of a previous bad write. These are
6049 // possible, but less likely scenarios. We don't have enough
6050 // information to tell a difference here. The reindex process is
6051 // not the place to attempt to clean and/or compact the block
6052 // files. If so desired, a studious node operator may use
6053 // knowledge of the fact that the block files are not entirely
6054 // pristine in order to prepare a set of pristine, and perhaps
6055 // ordered, block files for later reindexing.
6057 "%s: unexpected data at file offset 0x%x - %s. "
6058 "continuing\n",
6059 __func__, (nRewind - 1), e.what());
6060 }
6061 }
6062 } catch (const std::runtime_error &e) {
6063 GetNotifications().fatalError(std::string("System error: ") + e.what());
6064 }
6065
6066 LogPrintf("Loaded %i blocks from external file in %dms\n", nLoaded,
6067 GetTimeMillis() - nStart);
6068}
6069
6071 if (!ShouldCheckBlockIndex()) {
6072 return;
6073 }
6074
6075 LOCK(cs_main);
6076
6077 // During a reindex, we read the genesis block and call CheckBlockIndex
6078 // before ActivateBestChain, so we have the genesis block in
6079 // m_blockman.m_block_index but no active chain. (A few of the tests when
6080 // iterating the block tree require that m_chain has been initialized.)
6081 if (ActiveChain().Height() < 0) {
6082 assert(m_blockman.m_block_index.size() <= 1);
6083 return;
6084 }
6085
6086 // Build forward-pointing map of the entire block tree.
6087 std::multimap<CBlockIndex *, CBlockIndex *> forward;
6088 for (auto &[_, block_index] : m_blockman.m_block_index) {
6089 forward.emplace(block_index.pprev, &block_index);
6090 }
6091
6092 assert(forward.size() == m_blockman.m_block_index.size());
6093
6094 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6095 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6096 rangeGenesis = forward.equal_range(nullptr);
6097 CBlockIndex *pindex = rangeGenesis.first->second;
6098 rangeGenesis.first++;
6099 // There is only one index entry with parent nullptr.
6100 assert(rangeGenesis.first == rangeGenesis.second);
6101
6102 // Iterate over the entire block tree, using depth-first search.
6103 // Along the way, remember whether there are blocks on the path from genesis
6104 // block being explored which are the first to have certain properties.
6105 size_t nNodes = 0;
6106 int nHeight = 0;
6107 // Oldest ancestor of pindex which is invalid.
6108 CBlockIndex *pindexFirstInvalid = nullptr;
6109 // Oldest ancestor of pindex which is parked.
6110 CBlockIndex *pindexFirstParked = nullptr;
6111 // Oldest ancestor of pindex which does not have data available, since
6112 // assumeutxo snapshot if used.
6113 CBlockIndex *pindexFirstMissing = nullptr;
6114 // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot
6115 // if used..
6116 CBlockIndex *pindexFirstNeverProcessed = nullptr;
6117 // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE
6118 // (regardless of being valid or not).
6119 CBlockIndex *pindexFirstNotTreeValid = nullptr;
6120 // Oldest ancestor of pindex which does not have BLOCK_VALID_TRANSACTIONS
6121 // (regardless of being valid or not), since assumeutxo snapshot if used.
6122 CBlockIndex *pindexFirstNotTransactionsValid = nullptr;
6123 // Oldest ancestor of pindex which does not have BLOCK_VALID_CHAIN
6124 // (regardless of being valid or not), since assumeutxo snapshot if used.
6125 CBlockIndex *pindexFirstNotChainValid = nullptr;
6126 // Oldest ancestor of pindex which does not have BLOCK_VALID_SCRIPTS
6127 // (regardless of being valid or not), since assumeutxo snapshot if used.
6128 CBlockIndex *pindexFirstNotScriptsValid = nullptr;
6129
6130 // After checking an assumeutxo snapshot block, reset pindexFirst pointers
6131 // to earlier blocks that have not been downloaded or validated yet, so
6132 // checks for later blocks can assume the earlier blocks were validated and
6133 // be stricter, testing for more requirements.
6134 const CBlockIndex *snap_base{GetSnapshotBaseBlock()};
6135 CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{},
6136 *snap_first_nocv{}, *snap_first_nosv{};
6137 auto snap_update_firsts = [&] {
6138 if (pindex == snap_base) {
6139 std::swap(snap_first_missing, pindexFirstMissing);
6140 std::swap(snap_first_notx, pindexFirstNeverProcessed);
6141 std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
6142 std::swap(snap_first_nocv, pindexFirstNotChainValid);
6143 std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
6144 }
6145 };
6146
6147 while (pindex != nullptr) {
6148 nNodes++;
6149 if (pindexFirstInvalid == nullptr && pindex->nStatus.hasFailed()) {
6150 pindexFirstInvalid = pindex;
6151 }
6152 if (pindexFirstParked == nullptr && pindex->nStatus.isParked()) {
6153 pindexFirstParked = pindex;
6154 }
6155 if (pindexFirstMissing == nullptr && !pindex->nStatus.hasData()) {
6156 pindexFirstMissing = pindex;
6157 }
6158 if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) {
6159 pindexFirstNeverProcessed = pindex;
6160 }
6161 if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr &&
6162 pindex->nStatus.getValidity() < BlockValidity::TREE) {
6163 pindexFirstNotTreeValid = pindex;
6164 }
6165 if (pindex->pprev != nullptr) {
6166 if (pindexFirstNotTransactionsValid == nullptr &&
6167 pindex->nStatus.getValidity() < BlockValidity::TRANSACTIONS) {
6168 pindexFirstNotTransactionsValid = pindex;
6169 }
6170 if (pindexFirstNotChainValid == nullptr &&
6171 pindex->nStatus.getValidity() < BlockValidity::CHAIN) {
6172 pindexFirstNotChainValid = pindex;
6173 }
6174 if (pindexFirstNotScriptsValid == nullptr &&
6175 pindex->nStatus.getValidity() < BlockValidity::SCRIPTS) {
6176 pindexFirstNotScriptsValid = pindex;
6177 }
6178 }
6179
6180 // Begin: actual consistency checks.
6181 if (pindex->pprev == nullptr) {
6182 // Genesis block checks.
6183 // Genesis block's hash must match.
6184 assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock);
6185 for (auto c : GetAll()) {
6186 if (c->m_chain.Genesis() != nullptr) {
6187 // The chain's genesis block must be this block.
6188 assert(pindex == c->m_chain.Genesis());
6189 }
6190 }
6191 }
6192 if (!pindex->HaveNumChainTxs()) {
6193 // nSequenceId can't be set positive for blocks that aren't linked
6194 // (negative is used for preciousblock)
6195 assert(pindex->nSequenceId <= 0);
6196 }
6197 // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or
6198 // not pruning has occurred). HAVE_DATA is only equivalent to nTx > 0
6199 // (or VALID_TRANSACTIONS) if no pruning has occurred.
6201 // If we've never pruned, then HAVE_DATA should be equivalent to nTx
6202 // > 0
6203 assert(pindex->nStatus.hasData() == (pindex->nTx > 0));
6204 assert(pindexFirstMissing == pindexFirstNeverProcessed);
6205 } else if (pindex->nStatus.hasData()) {
6206 // If we have pruned, then we can only say that HAVE_DATA implies
6207 // nTx > 0
6208 assert(pindex->nTx > 0);
6209 }
6210 if (pindex->nStatus.hasUndo()) {
6211 assert(pindex->nStatus.hasData());
6212 }
6213 if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
6214 // Assumed-valid blocks should connect to the main chain.
6215 assert(pindex->nStatus.getValidity() >= BlockValidity::TREE);
6216 }
6217 // There should only be an nTx value if we have
6218 // actually seen a block's transactions.
6219 // This is pruning-independent.
6220 assert((pindex->nStatus.getValidity() >= BlockValidity::TRANSACTIONS) ==
6221 (pindex->nTx > 0));
6222 // All parents having had data (at some point) is equivalent to all
6223 // parents being VALID_TRANSACTIONS, which is equivalent to
6224 // HaveNumChainTxs().
6225 assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) ==
6226 (pindex->HaveNumChainTxs()));
6227 assert((pindexFirstNotTransactionsValid == nullptr ||
6228 pindex == snap_base) == (pindex->HaveNumChainTxs()));
6229 // nHeight must be consistent.
6230 assert(pindex->nHeight == nHeight);
6231 // For every block except the genesis block, the chainwork must be
6232 // larger than the parent's.
6233 assert(pindex->pprev == nullptr ||
6234 pindex->nChainWork >= pindex->pprev->nChainWork);
6235 // The pskip pointer must point back for all but the first 2 blocks.
6236 assert(nHeight < 2 ||
6237 (pindex->pskip && (pindex->pskip->nHeight < nHeight)));
6238 // All m_blockman.m_block_index entries must at least be TREE valid
6239 assert(pindexFirstNotTreeValid == nullptr);
6240 if (pindex->nStatus.getValidity() >= BlockValidity::TREE) {
6241 // TREE valid implies all parents are TREE valid
6242 assert(pindexFirstNotTreeValid == nullptr);
6243 }
6244 if (pindex->nStatus.getValidity() >= BlockValidity::CHAIN) {
6245 // CHAIN valid implies all parents are CHAIN valid
6246 assert(pindexFirstNotChainValid == nullptr);
6247 }
6248 if (pindex->nStatus.getValidity() >= BlockValidity::SCRIPTS) {
6249 // SCRIPTS valid implies all parents are SCRIPTS valid
6250 assert(pindexFirstNotScriptsValid == nullptr);
6251 }
6252 if (pindexFirstInvalid == nullptr) {
6253 // Checks for not-invalid blocks.
6254 // The failed mask cannot be set for blocks without invalid parents.
6255 assert(!pindex->nStatus.isInvalid());
6256 }
6257 if (pindexFirstParked == nullptr) {
6258 // Checks for not-parked blocks.
6259 // The parked mask cannot be set for blocks without parked parents.
6260 // (i.e., hasParkedParent only if an ancestor is properly parked).
6261 assert(!pindex->nStatus.isOnParkedChain());
6262 }
6263 // Make sure nChainTx sum is correctly computed.
6264 if (!pindex->pprev) {
6265 // If no previous block, nTx and nChainTx must be the same.
6266 assert(pindex->nChainTx == pindex->nTx);
6267 } else if (pindex->pprev->nChainTx > 0 && pindex->nTx > 0) {
6268 // If previous nChainTx is set and number of transactions in block
6269 // is known, sum must be set.
6270 assert(pindex->nChainTx == pindex->nTx + pindex->pprev->nChainTx);
6271 } else {
6272 // Otherwise nChainTx should only be set if this is a snapshot
6273 // block, and must be set if it is.
6274 assert((pindex->nChainTx != 0) == (pindex == snap_base));
6275 }
6276
6277 // Chainstate-specific checks on setBlockIndexCandidates
6278 for (auto c : GetAll()) {
6279 if (c->m_chain.Tip() == nullptr) {
6280 continue;
6281 }
6282 // Two main factors determine whether pindex is a candidate in
6283 // setBlockIndexCandidates:
6284 //
6285 // - If pindex has less work than the chain tip, it should not be a
6286 // candidate, and this will be asserted below. Otherwise it is a
6287 // potential candidate.
6288 //
6289 // - If pindex or one of its parent blocks back to the genesis block
6290 // or an assumeutxo snapshot never downloaded transactions
6291 // (pindexFirstNeverProcessed is non-null), it should not be a
6292 // candidate, and this will be asserted below. The only exception
6293 // is if pindex itself is an assumeutxo snapshot block. Then it is
6294 // also a potential candidate.
6295 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) &&
6296 (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
6297 // If pindex was detected as invalid (pindexFirstInvalid is
6298 // non-null), it is not required to be in
6299 // setBlockIndexCandidates.
6300 if (pindexFirstInvalid == nullptr) {
6301 // If this chainstate is the active chainstate, pindex
6302 // must be in setBlockIndexCandidates. Otherwise, this
6303 // chainstate is a background validation chainstate, and
6304 // pindex only needs to be added if it is an ancestor of
6305 // the snapshot that is being validated.
6306 if (c == &ActiveChainstate() ||
6307 GetSnapshotBaseBlock()->GetAncestor(pindex->nHeight) ==
6308 pindex) {
6309 // If pindex and all its parents back to the genesis
6310 // block or an assumeutxo snapshot block downloaded
6311 // transactions, transactions, and the transactions were
6312 // not pruned (pindexFirstMissing is null), it is a
6313 // potential candidate or was parked. The check excludes
6314 // pruned blocks, because if any blocks were pruned
6315 // between pindex the current chain tip, pindex will
6316 // only temporarily be added to setBlockIndexCandidates,
6317 // before being moved to m_blocks_unlinked. This check
6318 // could be improved to verify that if all blocks
6319 // between the chain tip and pindex have data, pindex
6320 // must be a candidate.
6321 if (pindexFirstMissing == nullptr) {
6322 assert(pindex->nStatus.isOnParkedChain() ||
6323 c->setBlockIndexCandidates.count(pindex));
6324 }
6325 // If pindex is the chain tip, it also is a potential
6326 // candidate.
6327 //
6328 // If the chainstate was loaded from a snapshot and
6329 // pindex is the base of the snapshot, pindex is also a
6330 // potential candidate.
6331 if (pindex == c->m_chain.Tip() ||
6332 pindex == c->SnapshotBase()) {
6333 assert(c->setBlockIndexCandidates.count(pindex));
6334 }
6335 }
6336 // If some parent is missing, then it could be that this
6337 // block was in setBlockIndexCandidates but had to be
6338 // removed because of the missing data. In this case it must
6339 // be in m_blocks_unlinked -- see test below.
6340 }
6341 } else {
6342 // If this block sorts worse than the current tip or some
6343 // ancestor's block has never been seen, it cannot be in
6344 // setBlockIndexCandidates.
6345 assert(c->setBlockIndexCandidates.count(pindex) == 0);
6346 }
6347 }
6348 // Check whether this block is in m_blocks_unlinked.
6349 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6350 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6351 rangeUnlinked =
6352 m_blockman.m_blocks_unlinked.equal_range(pindex->pprev);
6353 bool foundInUnlinked = false;
6354 while (rangeUnlinked.first != rangeUnlinked.second) {
6355 assert(rangeUnlinked.first->first == pindex->pprev);
6356 if (rangeUnlinked.first->second == pindex) {
6357 foundInUnlinked = true;
6358 break;
6359 }
6360 rangeUnlinked.first++;
6361 }
6362 if (pindex->pprev && pindex->nStatus.hasData() &&
6363 pindexFirstNeverProcessed != nullptr &&
6364 pindexFirstInvalid == nullptr) {
6365 // If this block has block data available, some parent was never
6366 // received, and has no invalid parents, it must be in
6367 // m_blocks_unlinked.
6368 assert(foundInUnlinked);
6369 }
6370 if (!pindex->nStatus.hasData()) {
6371 // Can't be in m_blocks_unlinked if we don't HAVE_DATA
6372 assert(!foundInUnlinked);
6373 }
6374 if (pindexFirstMissing == nullptr) {
6375 // We aren't missing data for any parent -- cannot be in
6376 // m_blocks_unlinked.
6377 assert(!foundInUnlinked);
6378 }
6379 if (pindex->pprev && pindex->nStatus.hasData() &&
6380 pindexFirstNeverProcessed == nullptr &&
6381 pindexFirstMissing != nullptr) {
6382 // We HAVE_DATA for this block, have received data for all parents
6383 // at some point, but we're currently missing data for some parent.
6385 // This block may have entered m_blocks_unlinked if:
6386 // - it has a descendant that at some point had more work than the
6387 // tip, and
6388 // - we tried switching to that descendant but were missing
6389 // data for some intermediate block between m_chain and the
6390 // tip.
6391 // So if this block is itself better than any m_chain.Tip() and it
6392 // wasn't in setBlockIndexCandidates, then it must be in
6393 // m_blocks_unlinked.
6394 for (auto c : GetAll()) {
6395 const bool is_active = c == &ActiveChainstate();
6396 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) &&
6397 c->setBlockIndexCandidates.count(pindex) == 0) {
6398 if (pindexFirstInvalid == nullptr) {
6399 if (is_active ||
6400 snap_base->GetAncestor(pindex->nHeight) == pindex) {
6401 assert(foundInUnlinked);
6402 }
6403 }
6404 }
6405 }
6406 }
6407 // Perhaps too slow
6408 // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash());
6409 // End: actual consistency checks.
6410
6411 // Try descending into the first subnode.
6412 snap_update_firsts();
6413 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6414 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6415 range = forward.equal_range(pindex);
6416 if (range.first != range.second) {
6417 // A subnode was found.
6418 pindex = range.first->second;
6419 nHeight++;
6420 continue;
6421 }
6422 // This is a leaf node. Move upwards until we reach a node of which we
6423 // have not yet visited the last child.
6424 while (pindex) {
6425 // We are going to either move to a parent or a sibling of pindex.
6426 snap_update_firsts();
6427 // If pindex was the first with a certain property, unset the
6428 // corresponding variable.
6429 if (pindex == pindexFirstInvalid) {
6430 pindexFirstInvalid = nullptr;
6431 }
6432 if (pindex == pindexFirstParked) {
6433 pindexFirstParked = nullptr;
6434 }
6435 if (pindex == pindexFirstMissing) {
6436 pindexFirstMissing = nullptr;
6437 }
6438 if (pindex == pindexFirstNeverProcessed) {
6439 pindexFirstNeverProcessed = nullptr;
6440 }
6441 if (pindex == pindexFirstNotTreeValid) {
6442 pindexFirstNotTreeValid = nullptr;
6443 }
6444 if (pindex == pindexFirstNotTransactionsValid) {
6445 pindexFirstNotTransactionsValid = nullptr;
6446 }
6447 if (pindex == pindexFirstNotChainValid) {
6448 pindexFirstNotChainValid = nullptr;
6449 }
6450 if (pindex == pindexFirstNotScriptsValid) {
6451 pindexFirstNotScriptsValid = nullptr;
6452 }
6453 // Find our parent.
6454 CBlockIndex *pindexPar = pindex->pprev;
6455 // Find which child we just visited.
6456 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6457 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6458 rangePar = forward.equal_range(pindexPar);
6459 while (rangePar.first->second != pindex) {
6460 // Our parent must have at least the node we're coming from as
6461 // child.
6462 assert(rangePar.first != rangePar.second);
6463 rangePar.first++;
6464 }
6465 // Proceed to the next one.
6466 rangePar.first++;
6467 if (rangePar.first != rangePar.second) {
6468 // Move to the sibling.
6469 pindex = rangePar.first->second;
6470 break;
6471 } else {
6472 // Move up further.
6473 pindex = pindexPar;
6474 nHeight--;
6475 continue;
6476 }
6477 }
6478 }
6479
6480 // Check that we actually traversed the entire map.
6481 assert(nNodes == forward.size());
6482}
6483
6484std::string Chainstate::ToString() {
6486 CBlockIndex *tip = m_chain.Tip();
6487 return strprintf("Chainstate [%s] @ height %d (%s)",
6488 m_from_snapshot_blockhash ? "snapshot" : "ibd",
6489 tip ? tip->nHeight : -1,
6490 tip ? tip->GetBlockHash().ToString() : "null");
6491}
6492
6493bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size) {
6495 if (coinstip_size == m_coinstip_cache_size_bytes &&
6496 coinsdb_size == m_coinsdb_cache_size_bytes) {
6497 // Cache sizes are unchanged, no need to continue.
6498 return true;
6499 }
6500 size_t old_coinstip_size = m_coinstip_cache_size_bytes;
6501 m_coinstip_cache_size_bytes = coinstip_size;
6502 m_coinsdb_cache_size_bytes = coinsdb_size;
6503 CoinsDB().ResizeCache(coinsdb_size);
6504
6505 LogPrintf("[%s] resized coinsdb cache to %.1f MiB\n", this->ToString(),
6506 coinsdb_size * (1.0 / 1024 / 1024));
6507 LogPrintf("[%s] resized coinstip cache to %.1f MiB\n", this->ToString(),
6508 coinstip_size * (1.0 / 1024 / 1024));
6509
6511 bool ret;
6512
6513 if (coinstip_size > old_coinstip_size) {
6514 // Likely no need to flush if cache sizes have grown.
6516 } else {
6517 // Otherwise, flush state to disk and deallocate the in-memory coins
6518 // map.
6520 }
6521 return ret;
6522}
6523
6529 const CBlockIndex *pindex) {
6530 if (pindex == nullptr) {
6531 return 0.0;
6532 }
6533 if (pindex->nChainTx == 0) {
6535 "Block %d has unset m_chain_tx_count. Unable to "
6536 "estimate verification progress.\n",
6537 pindex->nHeight);
6538 return 0.0;
6539 }
6540
6541 int64_t nNow = time(nullptr);
6542
6543 double fTxTotal;
6544 if (pindex->GetChainTxCount() <= data.nTxCount) {
6545 fTxTotal = data.nTxCount + (nNow - data.nTime) * data.dTxRate;
6546 } else {
6547 fTxTotal = pindex->GetChainTxCount() +
6548 (nNow - pindex->GetBlockTime()) * data.dTxRate;
6549 }
6550
6551 return std::min<double>(pindex->GetChainTxCount() / fTxTotal, 1.0);
6552}
6553
6554std::optional<BlockHash> ChainstateManager::SnapshotBlockhash() const {
6555 LOCK(::cs_main);
6556 if (m_active_chainstate && m_active_chainstate->m_from_snapshot_blockhash) {
6557 // If a snapshot chainstate exists, it will always be our active.
6558 return m_active_chainstate->m_from_snapshot_blockhash;
6559 }
6560 return std::nullopt;
6561}
6562
6563std::vector<Chainstate *> ChainstateManager::GetAll() {
6564 LOCK(::cs_main);
6565 std::vector<Chainstate *> out;
6566
6567 for (Chainstate *pchainstate :
6568 {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
6569 if (this->IsUsable(pchainstate)) {
6570 out.push_back(pchainstate);
6571 }
6572 }
6573
6574 return out;
6575}
6576
6577Chainstate &ChainstateManager::InitializeChainstate(CTxMemPool *mempool) {
6579 assert(!m_ibd_chainstate);
6580 assert(!m_active_chainstate);
6581
6582 m_ibd_chainstate = std::make_unique<Chainstate>(mempool, m_blockman, *this);
6583 m_active_chainstate = m_ibd_chainstate.get();
6584 return *m_active_chainstate;
6585}
6586
6587[[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path &db_path,
6588 bool is_snapshot)
6591
6592 if (is_snapshot) {
6593 fs::path base_blockhash_path =
6595
6596 try {
6597 const bool existed{fs::remove(base_blockhash_path)};
6598 if (!existed) {
6599 LogPrintf("[snapshot] snapshot chainstate dir being removed "
6600 "lacks %s file\n",
6602 }
6603 } catch (const fs::filesystem_error &e) {
6604 LogPrintf("[snapshot] failed to remove file %s: %s\n",
6605 fs::PathToString(base_blockhash_path),
6607 }
6608 }
6609
6610 std::string path_str = fs::PathToString(db_path);
6611 LogPrintf("Removing leveldb dir at %s\n", path_str);
6612
6613 // We have to destruct before this call leveldb::DB in order to release the
6614 // db lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
6615 const bool destroyed = dbwrapper::DestroyDB(path_str, {}).ok();
6616
6617 if (!destroyed) {
6618 LogPrintf("error: leveldb DestroyDB call failed on %s\n", path_str);
6619 }
6620
6621 // Datadir should be removed from filesystem; otherwise initialization may
6622 // detect it on subsequent statups and get confused.
6623 //
6624 // If the base_blockhash_path removal above fails in the case of snapshot
6625 // chainstates, this will return false since leveldb won't remove a
6626 // non-empty directory.
6627 return destroyed && !fs::exists(db_path);
6628}
6629
6631 AutoFile &coins_file, const SnapshotMetadata &metadata, bool in_memory) {
6632 BlockHash base_blockhash = metadata.m_base_blockhash;
6633
6634 if (this->SnapshotBlockhash()) {
6636 "Can't activate a snapshot-based chainstate more than once")};
6637 }
6638
6639 CBlockIndex *snapshot_start_block{};
6640
6641 {
6642 LOCK(::cs_main);
6643
6644 if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
6645 auto available_heights = GetParams().GetAvailableSnapshotHeights();
6646 std::string heights_formatted =
6647 util::Join(available_heights, ", ",
6648 [&](const auto &i) { return util::ToString(i); });
6649 return util::Error{strprintf(
6650 Untranslated("assumeutxo block hash in snapshot metadata not "
6651 "recognized (hash: %s). The following "
6652 "snapshot heights are available: %s."),
6653 base_blockhash.ToString(), heights_formatted)};
6654 }
6655
6656 snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
6657 if (!snapshot_start_block) {
6658 return util::Error{strprintf(
6659 Untranslated("The base block header (%s) must appear in the "
6660 "headers chain. Make sure all headers are "
6661 "syncing, and call loadtxoutset again."),
6662 base_blockhash.ToString())};
6663 }
6664
6665 if (snapshot_start_block->nStatus.isInvalid()) {
6666 return util::Error{strprintf(
6668 "The base block header (%s) is part of an invalid chain"),
6669 base_blockhash.ToString())};
6670 }
6671
6672 if (!m_best_header ||
6673 m_best_header->GetAncestor(snapshot_start_block->nHeight) !=
6674 snapshot_start_block) {
6676 "A forked headers-chain with more work than the chain with the "
6677 "snapshot base block header exists. Please proceed to sync "
6678 "without AssumeUtxo.")};
6679 }
6680
6681 if (Assert(m_active_chainstate->GetMempool())->size() > 0) {
6683 "Can't activate a snapshot when mempool not empty.")};
6684 }
6685 }
6686
6687 int64_t current_coinsdb_cache_size{0};
6688 int64_t current_coinstip_cache_size{0};
6689
6690 // Cache percentages to allocate to each chainstate.
6691 //
6692 // These particular percentages don't matter so much since they will only be
6693 // relevant during snapshot activation; caches are rebalanced at the
6694 // conclusion of this function. We want to give (essentially) all available
6695 // cache capacity to the snapshot to aid the bulk load later in this
6696 // function.
6697 static constexpr double IBD_CACHE_PERC = 0.01;
6698 static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
6699
6700 {
6701 LOCK(::cs_main);
6702 // Resize the coins caches to ensure we're not exceeding memory limits.
6703 //
6704 // Allocate the majority of the cache to the incoming snapshot
6705 // chainstate, since (optimistically) getting to its tip will be the top
6706 // priority. We'll need to call `MaybeRebalanceCaches()` once we're done
6707 // with this function to ensure the right allocation (including the
6708 // possibility that no snapshot was activated and that we should restore
6709 // the active chainstate caches to their original size).
6710 //
6711 current_coinsdb_cache_size =
6712 this->ActiveChainstate().m_coinsdb_cache_size_bytes;
6713 current_coinstip_cache_size =
6714 this->ActiveChainstate().m_coinstip_cache_size_bytes;
6715
6716 // Temporarily resize the active coins cache to make room for the
6717 // newly-created snapshot chain.
6718 this->ActiveChainstate().ResizeCoinsCaches(
6719 static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
6720 static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
6721 }
6722
6723 auto snapshot_chainstate =
6724 WITH_LOCK(::cs_main, return std::make_unique<Chainstate>(
6725 /* mempool */ nullptr, m_blockman, *this,
6726 base_blockhash));
6727
6728 {
6729 LOCK(::cs_main);
6730 snapshot_chainstate->InitCoinsDB(
6731 static_cast<size_t>(current_coinsdb_cache_size *
6732 SNAPSHOT_CACHE_PERC),
6733 in_memory, false, "chainstate");
6734 snapshot_chainstate->InitCoinsCache(static_cast<size_t>(
6735 current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
6736 }
6737
6738 auto cleanup_bad_snapshot =
6740 this->MaybeRebalanceCaches();
6741
6742 // PopulateAndValidateSnapshot can return (in error) before the
6743 // leveldb datadir has been created, so only attempt removal if we
6744 // got that far.
6745 if (auto snapshot_datadir =
6747 // We have to destruct leveldb::DB in order to release the db
6748 // lock, otherwise DestroyDB() (in DeleteCoinsDBFromDisk()) will
6749 // fail. See `leveldb::~DBImpl()`. Destructing the chainstate
6750 // (and so resetting the coinsviews object) does this.
6751 snapshot_chainstate.reset();
6752 bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir,
6753 /*is_snapshot=*/true);
6754 if (!removed) {
6756 "Failed to remove snapshot chainstate dir (%s). "
6757 "Manually remove it before restarting.\n",
6758 fs::PathToString(*snapshot_datadir)));
6759 }
6760 }
6761 return util::Error{std::move(reason)};
6762 };
6763
6764 if (!this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file,
6765 metadata)) {
6766 LOCK(::cs_main);
6767 return cleanup_bad_snapshot(Untranslated("population failed"));
6768 }
6769
6770 // cs_main required for rest of snapshot activation.
6771 LOCK(::cs_main);
6772
6773 // Do a final check to ensure that the snapshot chainstate is actually a
6774 // more work chain than the active chainstate; a user could have loaded a
6775 // snapshot very late in the IBD process, and we wouldn't want to load a
6776 // useless chainstate.
6778 snapshot_chainstate->m_chain.Tip())) {
6779 return cleanup_bad_snapshot(
6780 Untranslated("work does not exceed active chainstate"));
6781 }
6782 // If not in-memory, persist the base blockhash for use during subsequent
6783 // initialization.
6784 if (!in_memory) {
6785 if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
6786 return cleanup_bad_snapshot(
6787 Untranslated("could not write base blockhash"));
6788 }
6789 }
6790
6791 assert(!m_snapshot_chainstate);
6792 m_snapshot_chainstate.swap(snapshot_chainstate);
6793 const bool chaintip_loaded = m_snapshot_chainstate->LoadChainTip();
6794 assert(chaintip_loaded);
6795
6796 // Transfer possession of the mempool to the snapshot chainstate.
6797 // Mempool is empty at this point because we're still in IBD.
6798 Assert(m_active_chainstate->m_mempool->size() == 0);
6799 Assert(!m_snapshot_chainstate->m_mempool);
6800 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
6801 m_active_chainstate->m_mempool = nullptr;
6802 m_active_chainstate = m_snapshot_chainstate.get();
6803 m_blockman.m_snapshot_height = this->GetSnapshotBaseHeight();
6804
6805 LogPrintf("[snapshot] successfully activated snapshot %s\n",
6806 base_blockhash.ToString());
6807 LogPrintf("[snapshot] (%.2f MB)\n",
6808 m_snapshot_chainstate->CoinsTip().DynamicMemoryUsage() /
6809 (1000 * 1000));
6810
6811 this->MaybeRebalanceCaches();
6812 return snapshot_start_block;
6813}
6814
6815static void FlushSnapshotToDisk(CCoinsViewCache &coins_cache,
6816 bool snapshot_loaded) {
6818 strprintf("%s (%.2f MB)",
6819 snapshot_loaded ? "saving snapshot chainstate"
6820 : "flushing coins cache",
6821 coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
6822 BCLog::LogFlags::ALL);
6823
6824 coins_cache.Flush();
6825}
6826
6827struct StopHashingException : public std::exception {
6828 const char *what() const noexcept override {
6829 return "ComputeUTXOStats interrupted by shutdown.";
6830 }
6831};
6832
6834 if (interrupt) {
6835 throw StopHashingException();
6836 }
6837}
6838
6840 Chainstate &snapshot_chainstate, AutoFile &coins_file,
6841 const SnapshotMetadata &metadata) {
6842 // It's okay to release cs_main before we're done using `coins_cache`
6843 // because we know that nothing else will be referencing the newly created
6844 // snapshot_chainstate yet.
6845 CCoinsViewCache &coins_cache =
6846 *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
6847
6848 BlockHash base_blockhash = metadata.m_base_blockhash;
6849
6850 CBlockIndex *snapshot_start_block = WITH_LOCK(
6851 ::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
6852
6853 if (!snapshot_start_block) {
6854 // Needed for ComputeUTXOStats to determine the
6855 // height and to avoid a crash when base_blockhash.IsNull()
6856 LogPrintf("[snapshot] Did not find snapshot start blockheader %s\n",
6857 base_blockhash.ToString());
6858 return false;
6859 }
6860
6861 int base_height = snapshot_start_block->nHeight;
6862 const auto &maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
6863
6864 if (!maybe_au_data) {
6865 LogPrintf("[snapshot] assumeutxo height in snapshot metadata not "
6866 "recognized (%d) - refusing to load snapshot\n",
6867 base_height);
6868 return false;
6869 }
6870
6871 const AssumeutxoData &au_data = *maybe_au_data;
6872
6873 // This work comparison is a duplicate check with the one performed later in
6874 // ActivateSnapshot(), but is done so that we avoid doing the long work of
6875 // staging a snapshot that isn't actually usable.
6877 ActiveTip(), snapshot_start_block))) {
6878 LogPrintf("[snapshot] activation failed - work does not exceed active "
6879 "chainstate\n");
6880 return false;
6881 }
6882
6883 const uint64_t coins_count = metadata.m_coins_count;
6884 uint64_t coins_left = metadata.m_coins_count;
6885
6886 LogPrintf("[snapshot] loading %d coins from snapshot %s\n", coins_left,
6887 base_blockhash.ToString());
6888 int64_t coins_processed{0};
6889
6890 while (coins_left > 0) {
6891 try {
6892 TxId txid;
6893 coins_file >> txid;
6894 size_t coins_per_txid{0};
6895 coins_per_txid = ReadCompactSize(coins_file);
6896
6897 if (coins_per_txid > coins_left) {
6898 LogPrintf("[snapshot] mismatch in coins count in snapshot "
6899 "metadata and actual snapshot data\n");
6900 return false;
6901 }
6902
6903 for (size_t i = 0; i < coins_per_txid; i++) {
6904 Coin coin;
6905 COutPoint outpoint{
6906 txid, static_cast<uint32_t>(ReadCompactSize(coins_file))};
6907 coins_file >> coin;
6908 // Avoid integer wrap-around in coinstats.cpp:ApplyHash
6909 if (coin.GetHeight() > uint32_t(base_height) ||
6910 outpoint.GetN() >=
6911 std::numeric_limits<decltype(outpoint.GetN())>::max()) {
6912 LogPrintf("[snapshot] bad snapshot data after "
6913 "deserializing %d coins\n",
6914 coins_count - coins_left);
6915 return false;
6916 }
6917 if (!MoneyRange(coin.GetTxOut().nValue)) {
6918 LogPrintf("[snapshot] bad snapshot data after "
6919 "deserializing %d coins - bad tx out value\n",
6920 coins_count - coins_left);
6921 return false;
6922 }
6923 coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint),
6924 std::move(coin));
6925
6926 --coins_left;
6927 ++coins_processed;
6928
6929 if (coins_processed % 1000000 == 0) {
6930 LogPrintf("[snapshot] %d coins loaded (%.2f%%, %.2f MB)\n",
6931 coins_processed,
6932 static_cast<float>(coins_processed) * 100 /
6933 static_cast<float>(coins_count),
6934 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
6935 }
6936
6937 // Batch write and flush (if we need to) every so often.
6938 //
6939 // If our average Coin size is roughly 41 bytes, checking every
6940 // 120,000 coins means <5MB of memory imprecision.
6941 if (coins_processed % 120000 == 0) {
6942 if (m_interrupt) {
6943 return false;
6944 }
6945
6946 const auto snapshot_cache_state = WITH_LOCK(
6947 ::cs_main,
6948 return snapshot_chainstate.GetCoinsCacheSizeState());
6949
6950 if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
6951 // This is a hack - we don't know what the actual best
6952 // block is, but that doesn't matter for the purposes of
6953 // flushing the cache here. We'll set this to its
6954 // correct value (`base_blockhash`) below after the
6955 // coins are loaded.
6956 coins_cache.SetBestBlock(BlockHash{GetRandHash()});
6957
6958 // No need to acquire cs_main since this chainstate
6959 // isn't being used yet.
6960 FlushSnapshotToDisk(coins_cache,
6961 /*snapshot_loaded=*/false);
6962 }
6963 }
6964 }
6965 } catch (const std::ios_base::failure &) {
6966 LogPrintf("[snapshot] bad snapshot format or truncated snapshot "
6967 "after deserializing %d coins\n",
6968 coins_processed);
6969 return false;
6970 }
6971 }
6972
6973 // Important that we set this. This and the coins_cache accesses above are
6974 // sort of a layer violation, but either we reach into the innards of
6975 // CCoinsViewCache here or we have to invert some of the Chainstate to
6976 // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
6977 // method.
6978 coins_cache.SetBestBlock(base_blockhash);
6979
6980 bool out_of_coins{false};
6981 try {
6982 TxId txid;
6983 coins_file >> txid;
6984 } catch (const std::ios_base::failure &) {
6985 // We expect an exception since we should be out of coins.
6986 out_of_coins = true;
6987 }
6988 if (!out_of_coins) {
6989 LogPrintf("[snapshot] bad snapshot - coins left over after "
6990 "deserializing %d coins\n",
6991 coins_count);
6992 return false;
6993 }
6994
6995 LogPrintf("[snapshot] loaded %d (%.2f MB) coins from snapshot %s\n",
6996 coins_count, coins_cache.DynamicMemoryUsage() / (1000 * 1000),
6997 base_blockhash.ToString());
6998
6999 // No need to acquire cs_main since this chainstate isn't being used yet.
7000 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
7001
7002 assert(coins_cache.GetBestBlock() == base_blockhash);
7003
7004 // As above, okay to immediately release cs_main here since no other context
7005 // knows about the snapshot_chainstate.
7006 CCoinsViewDB *snapshot_coinsdb =
7007 WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
7008
7009 std::optional<CCoinsStats> maybe_stats;
7010
7011 try {
7012 maybe_stats = ComputeUTXOStats(
7013 CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman,
7014 [&interrupt = m_interrupt] {
7015 SnapshotUTXOHashBreakpoint(interrupt);
7016 });
7017 } catch (StopHashingException const &) {
7018 return false;
7019 }
7020 if (!maybe_stats.has_value()) {
7021 LogPrintf("[snapshot] failed to generate coins stats\n");
7022 return false;
7023 }
7024
7025 // Assert that the deserialized chainstate contents match the expected
7026 // assumeutxo value.
7027 if (AssumeutxoHash{maybe_stats->hashSerialized} !=
7028 au_data.hash_serialized) {
7029 LogPrintf("[snapshot] bad snapshot content hash: expected %s, got %s\n",
7030 au_data.hash_serialized.ToString(),
7031 maybe_stats->hashSerialized.ToString());
7032 return false;
7033 }
7034
7035 snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
7036
7037 // The remainder of this function requires modifying data protected by
7038 // cs_main.
7039 LOCK(::cs_main);
7040
7041 // Fake various pieces of CBlockIndex state:
7042 CBlockIndex *index = nullptr;
7043
7044 // Don't make any modifications to the genesis block since it shouldn't be
7045 // necessary, and since the genesis block doesn't have normal flags like
7046 // BLOCK_VALID_SCRIPTS set.
7047 constexpr int AFTER_GENESIS_START{1};
7048
7049 for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height();
7050 ++i) {
7051 index = snapshot_chainstate.m_chain[i];
7052
7053 m_blockman.m_dirty_blockindex.insert(index);
7054 // Changes to the block index will be flushed to disk after this call
7055 // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
7056 // called, since we've added a snapshot chainstate and therefore will
7057 // have to downsize the IBD chainstate, which will result in a call to
7058 // `FlushStateToDisk(ALWAYS)`.
7059 }
7060
7061 assert(index);
7062 assert(index == snapshot_start_block);
7063 index->nChainTx = au_data.nChainTx;
7064 snapshot_chainstate.setBlockIndexCandidates.insert(snapshot_start_block);
7065
7066 LogPrintf("[snapshot] validated snapshot (%.2f MB)\n",
7067 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
7068 return true;
7069}
7070
7071// Currently, this function holds cs_main for its duration, which could be for
7072// multiple minutes due to the ComputeUTXOStats call. This hold is necessary
7073// because we need to avoid advancing the background validation chainstate
7074// farther than the snapshot base block - and this function is also invoked
7075// from within ConnectTip, i.e. from within ActivateBestChain, so cs_main is
7076// held anyway.
7077//
7078// Eventually (TODO), we could somehow separate this function's runtime from
7079// maintenance of the active chain, but that will either require
7080//
7081// (i) setting `m_disabled` immediately and ensuring all chainstate accesses go
7082// through IsUsable() checks, or
7083//
7084// (ii) giving each chainstate its own lock instead of using cs_main for
7085// everything.
7086SnapshotCompletionResult ChainstateManager::MaybeCompleteSnapshotValidation() {
7088 if (m_ibd_chainstate.get() == &this->ActiveChainstate() ||
7089 !this->IsUsable(m_snapshot_chainstate.get()) ||
7090 !this->IsUsable(m_ibd_chainstate.get()) ||
7091 !m_ibd_chainstate->m_chain.Tip()) {
7092 // Nothing to do - this function only applies to the background
7093 // validation chainstate.
7095 }
7096 const int snapshot_tip_height = this->ActiveHeight();
7097 const int snapshot_base_height = *Assert(this->GetSnapshotBaseHeight());
7098 const CBlockIndex &index_new = *Assert(m_ibd_chainstate->m_chain.Tip());
7099
7100 if (index_new.nHeight < snapshot_base_height) {
7101 // Background IBD not complete yet.
7103 }
7104
7106 BlockHash snapshot_blockhash = *Assert(SnapshotBlockhash());
7107
7108 auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
7109 bilingual_str user_error = strprintf(
7110 _("%s failed to validate the -assumeutxo snapshot state. "
7111 "This indicates a hardware problem, or a bug in the software, or "
7112 "a bad software modification that allowed an invalid snapshot to "
7113 "be loaded. As a result of this, the node will shut down and "
7114 "stop using any state that was built on the snapshot, resetting "
7115 "the chain height from %d to %d. On the next restart, the node "
7116 "will resume syncing from %d without using any snapshot data. "
7117 "Please report this incident to %s, including how you obtained "
7118 "the snapshot. The invalid snapshot chainstate will be left on "
7119 "disk in case it is helpful in diagnosing the issue that caused "
7120 "this error."),
7121 PACKAGE_NAME, snapshot_tip_height, snapshot_base_height,
7122 snapshot_base_height, PACKAGE_BUGREPORT);
7123
7124 LogPrintf("[snapshot] !!! %s\n", user_error.original);
7125 LogPrintf("[snapshot] deleting snapshot, reverting to validated chain, "
7126 "and stopping node\n");
7127
7128 m_active_chainstate = m_ibd_chainstate.get();
7129 m_snapshot_chainstate->m_disabled = true;
7130 assert(!this->IsUsable(m_snapshot_chainstate.get()));
7131 assert(this->IsUsable(m_ibd_chainstate.get()));
7132
7133 auto rename_result = m_snapshot_chainstate->InvalidateCoinsDBOnDisk();
7134 if (!rename_result) {
7135 user_error = strprintf(Untranslated("%s\n%s"), user_error,
7136 util::ErrorString(rename_result));
7137 }
7138
7139 GetNotifications().fatalError(user_error.original, user_error);
7140 };
7141
7142 if (index_new.GetBlockHash() != snapshot_blockhash) {
7143 LogPrintf(
7144 "[snapshot] supposed base block %s does not match the "
7145 "snapshot base block %s (height %d). Snapshot is not valid.\n",
7146 index_new.ToString(), snapshot_blockhash.ToString(),
7147 snapshot_base_height);
7148 handle_invalid_snapshot();
7150 }
7151
7152 assert(index_new.nHeight == snapshot_base_height);
7153
7154 int curr_height = m_ibd_chainstate->m_chain.Height();
7155
7156 assert(snapshot_base_height == curr_height);
7157 assert(snapshot_base_height == index_new.nHeight);
7158 assert(this->IsUsable(m_snapshot_chainstate.get()));
7159 assert(this->GetAll().size() == 2);
7160
7161 CCoinsViewDB &ibd_coins_db = m_ibd_chainstate->CoinsDB();
7162 m_ibd_chainstate->ForceFlushStateToDisk();
7163
7164 const auto &maybe_au_data =
7165 this->GetParams().AssumeutxoForHeight(curr_height);
7166 if (!maybe_au_data) {
7167 LogPrintf("[snapshot] assumeutxo data not found for height "
7168 "(%d) - refusing to validate snapshot\n",
7169 curr_height);
7170 handle_invalid_snapshot();
7172 }
7173
7174 const AssumeutxoData &au_data = *maybe_au_data;
7175 std::optional<CCoinsStats> maybe_ibd_stats;
7176 LogPrintf(
7177 "[snapshot] computing UTXO stats for background chainstate to validate "
7178 "snapshot - this could take a few minutes\n");
7179 try {
7180 maybe_ibd_stats =
7181 ComputeUTXOStats(CoinStatsHashType::HASH_SERIALIZED, &ibd_coins_db,
7182 m_blockman, [&interrupt = m_interrupt] {
7183 SnapshotUTXOHashBreakpoint(interrupt);
7184 });
7185 } catch (StopHashingException const &) {
7187 }
7188
7189 if (!maybe_ibd_stats) {
7190 LogPrintf(
7191 "[snapshot] failed to generate stats for validation coins db\n");
7192 // While this isn't a problem with the snapshot per se, this condition
7193 // prevents us from validating the snapshot, so we should shut down and
7194 // let the user handle the issue manually.
7195 handle_invalid_snapshot();
7197 }
7198 const auto &ibd_stats = *maybe_ibd_stats;
7199
7200 // Compare the background validation chainstate's UTXO set hash against the
7201 // hard-coded assumeutxo hash we expect.
7202 //
7203 // TODO: For belt-and-suspenders, we could cache the UTXO set
7204 // hash for the snapshot when it's loaded in its chainstate's leveldb. We
7205 // could then reference that here for an additional check.
7206 if (AssumeutxoHash{ibd_stats.hashSerialized} != au_data.hash_serialized) {
7207 LogPrintf("[snapshot] hash mismatch: actual=%s, expected=%s\n",
7208 ibd_stats.hashSerialized.ToString(),
7209 au_data.hash_serialized.ToString());
7210 handle_invalid_snapshot();
7212 }
7213
7214 LogPrintf("[snapshot] snapshot beginning at %s has been fully validated\n",
7215 snapshot_blockhash.ToString());
7216
7217 m_ibd_chainstate->m_disabled = true;
7218 this->MaybeRebalanceCaches();
7219
7221}
7222
7224 LOCK(::cs_main);
7225 assert(m_active_chainstate);
7226 return *m_active_chainstate;
7227}
7228
7230 auto &active_chainstate = ActiveChainstate();
7231 LOCK(active_chainstate.cs_avalancheFinalizedBlockIndex);
7232 return active_chainstate.m_avalancheFinalizedBlockIndex;
7233}
7234
7236 LOCK(::cs_main);
7237 return m_snapshot_chainstate &&
7238 m_active_chainstate == m_snapshot_chainstate.get();
7239}
7240void ChainstateManager::MaybeRebalanceCaches() {
7242 bool ibd_usable = this->IsUsable(m_ibd_chainstate.get());
7243 bool snapshot_usable = this->IsUsable(m_snapshot_chainstate.get());
7244 assert(ibd_usable || snapshot_usable);
7245
7246 if (ibd_usable && !snapshot_usable) {
7247 // Allocate everything to the IBD chainstate. This will always happen
7248 // when we are not using a snapshot.
7249 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache,
7251 } else if (snapshot_usable && !ibd_usable) {
7252 // If background validation has completed and snapshot is our active
7253 // chain...
7254 LogPrintf(
7255 "[snapshot] allocating all cache to the snapshot chainstate\n");
7256 // Allocate everything to the snapshot chainstate.
7257 m_snapshot_chainstate->ResizeCoinsCaches(m_total_coinstip_cache,
7259 } else if (ibd_usable && snapshot_usable) {
7260 // If both chainstates exist, determine who needs more cache based on
7261 // IBD status.
7262 //
7263 // Note: shrink caches first so that we don't inadvertently overwhelm
7264 // available memory.
7265 if (IsInitialBlockDownload()) {
7266 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache * 0.05,
7267 m_total_coinsdb_cache * 0.05);
7268 m_snapshot_chainstate->ResizeCoinsCaches(
7270 } else {
7271 m_snapshot_chainstate->ResizeCoinsCaches(
7273 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache * 0.95,
7274 m_total_coinsdb_cache * 0.95);
7275 }
7276 }
7277}
7278
7279void ChainstateManager::ResetChainstates() {
7280 m_ibd_chainstate.reset();
7281 m_snapshot_chainstate.reset();
7282 m_active_chainstate = nullptr;
7283}
7284
7291 if (!opts.check_block_index.has_value()) {
7292 opts.check_block_index =
7293 opts.config.GetChainParams().DefaultConsistencyChecks();
7294 }
7295
7296 if (!opts.minimum_chain_work.has_value()) {
7297 opts.minimum_chain_work = UintToArith256(
7298 opts.config.GetChainParams().GetConsensus().nMinimumChainWork);
7299 }
7300 if (!opts.assumed_valid_block.has_value()) {
7301 opts.assumed_valid_block =
7302 opts.config.GetChainParams().GetConsensus().defaultAssumeValid;
7303 }
7304 Assert(opts.adjusted_time_callback);
7305 return std::move(opts);
7306}
7307
7309 const util::SignalInterrupt &interrupt, Options options,
7310 node::BlockManager::Options blockman_options)
7311 : m_script_check_queue{/*batch_size=*/128, options.worker_threads_num},
7312 m_interrupt{interrupt}, m_options{Flatten(std::move(options))},
7313 m_blockman{interrupt, std::move(blockman_options)},
7314 m_validation_cache{m_options.script_execution_cache_bytes,
7315 m_options.signature_cache_bytes} {}
7316
7317bool ChainstateManager::DetectSnapshotChainstate(CTxMemPool *mempool) {
7318 assert(!m_snapshot_chainstate);
7319 std::optional<fs::path> path =
7321 if (!path) {
7322 return false;
7323 }
7324 std::optional<BlockHash> base_blockhash =
7326 if (!base_blockhash) {
7327 return false;
7328 }
7329 LogPrintf("[snapshot] detected active snapshot chainstate (%s) - loading\n",
7330 fs::PathToString(*path));
7331
7332 this->ActivateExistingSnapshot(*base_blockhash);
7333 return true;
7334}
7335
7336Chainstate &
7337ChainstateManager::ActivateExistingSnapshot(BlockHash base_blockhash) {
7338 assert(!m_snapshot_chainstate);
7339 m_snapshot_chainstate = std::make_unique<Chainstate>(nullptr, m_blockman,
7340 *this, base_blockhash);
7341 LogPrintf("[snapshot] switching active chainstate to %s\n",
7342 m_snapshot_chainstate->ToString());
7343
7344 // Mempool is empty at this point because we're still in IBD.
7345 Assert(m_active_chainstate->m_mempool->size() == 0);
7346 Assert(!m_snapshot_chainstate->m_mempool);
7347 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
7348 m_active_chainstate->m_mempool = nullptr;
7349 m_active_chainstate = m_snapshot_chainstate.get();
7350 return *m_snapshot_chainstate;
7351}
7352
7356 // Should never be called on a non-snapshot chainstate.
7357 assert(cs.m_from_snapshot_blockhash);
7358 auto storage_path_maybe = cs.CoinsDB().StoragePath();
7359 // Should never be called with a non-existent storage path.
7360 assert(storage_path_maybe);
7361 return *storage_path_maybe;
7362}
7363
7364util::Result<void> Chainstate::InvalidateCoinsDBOnDisk() {
7365 fs::path snapshot_datadir = GetSnapshotCoinsDBPath(*this);
7366
7367 // Coins views no longer usable.
7368 m_coins_views.reset();
7369
7370 auto invalid_path = snapshot_datadir + "_INVALID";
7371 std::string dbpath = fs::PathToString(snapshot_datadir);
7372 std::string target = fs::PathToString(invalid_path);
7373 LogPrintf("[snapshot] renaming snapshot datadir %s to %s\n", dbpath,
7374 target);
7375
7376 // The invalid snapshot datadir is simply moved and not deleted because we
7377 // may want to do forensics later during issue investigation. The user is
7378 // instructed accordingly in MaybeCompleteSnapshotValidation().
7379 try {
7380 fs::rename(snapshot_datadir, invalid_path);
7381 } catch (const fs::filesystem_error &e) {
7382 auto src_str = fs::PathToString(snapshot_datadir);
7383 auto dest_str = fs::PathToString(invalid_path);
7384
7385 LogPrintf("%s: error renaming file '%s' -> '%s': %s\n", __func__,
7386 src_str, dest_str, e.what());
7387 return util::Error{strprintf(_("Rename of '%s' -> '%s' failed. "
7388 "You should resolve this by manually "
7389 "moving or deleting the invalid "
7390 "snapshot directory %s, otherwise you "
7391 "will encounter the same error again "
7392 "on the next startup."),
7393 src_str, dest_str, src_str)};
7394 }
7395 return {};
7396}
7397
7398bool ChainstateManager::DeleteSnapshotChainstate() {
7400 Assert(m_snapshot_chainstate);
7401 Assert(m_ibd_chainstate);
7402
7403 fs::path snapshot_datadir =
7405 if (!DeleteCoinsDBFromDisk(snapshot_datadir, /*is_snapshot=*/true)) {
7406 LogPrintf("Deletion of %s failed. Please remove it manually to "
7407 "continue reindexing.\n",
7408 fs::PathToString(snapshot_datadir));
7409 return false;
7410 }
7411 m_active_chainstate = m_ibd_chainstate.get();
7412 m_active_chainstate->m_mempool = m_snapshot_chainstate->m_mempool;
7413 m_snapshot_chainstate.reset();
7414 return true;
7415}
7416
7417ChainstateRole Chainstate::GetRole() const {
7418 if (m_chainman.GetAll().size() <= 1) {
7420 }
7421 return (this != &m_chainman.ActiveChainstate())
7424}
7425const CBlockIndex *ChainstateManager::GetSnapshotBaseBlock() const {
7426 return m_active_chainstate ? m_active_chainstate->SnapshotBase() : nullptr;
7427}
7428
7429std::optional<int> ChainstateManager::GetSnapshotBaseHeight() const {
7430 const CBlockIndex *base = this->GetSnapshotBaseBlock();
7431 return base ? std::make_optional(base->nHeight) : std::nullopt;
7432}
7433
7434void ChainstateManager::RecalculateBestHeader() {
7436 m_best_header = ActiveChain().Tip();
7437 for (auto &entry : m_blockman.m_block_index) {
7438 if (!(entry.second.nStatus.isInvalid()) &&
7439 m_best_header->nChainWork < entry.second.nChainWork) {
7440 m_best_header = &entry.second;
7441 }
7442 }
7443}
7444
7445bool ChainstateManager::ValidatedSnapshotCleanup() {
7447 auto get_storage_path = [](auto &chainstate) EXCLUSIVE_LOCKS_REQUIRED(
7448 ::cs_main) -> std::optional<fs::path> {
7449 if (!(chainstate && chainstate->HasCoinsViews())) {
7450 return {};
7451 }
7452 return chainstate->CoinsDB().StoragePath();
7453 };
7454 std::optional<fs::path> ibd_chainstate_path_maybe =
7455 get_storage_path(m_ibd_chainstate);
7456 std::optional<fs::path> snapshot_chainstate_path_maybe =
7457 get_storage_path(m_snapshot_chainstate);
7458
7459 if (!this->IsSnapshotValidated()) {
7460 // No need to clean up.
7461 return false;
7462 }
7463 // If either path doesn't exist, that means at least one of the chainstates
7464 // is in-memory, in which case we can't do on-disk cleanup. You'd better be
7465 // in a unittest!
7466 if (!ibd_chainstate_path_maybe || !snapshot_chainstate_path_maybe) {
7467 LogPrintf("[snapshot] snapshot chainstate cleanup cannot happen with "
7468 "in-memory chainstates. You are testing, right?\n");
7469 return false;
7470 }
7471
7472 const auto &snapshot_chainstate_path = *snapshot_chainstate_path_maybe;
7473 const auto &ibd_chainstate_path = *ibd_chainstate_path_maybe;
7474
7475 // Since we're going to be moving around the underlying leveldb filesystem
7476 // content for each chainstate, make sure that the chainstates (and their
7477 // constituent CoinsViews members) have been destructed first.
7478 //
7479 // The caller of this method will be responsible for reinitializing
7480 // chainstates if they want to continue operation.
7481 this->ResetChainstates();
7482
7483 // No chainstates should be considered usable.
7484 assert(this->GetAll().size() == 0);
7485
7486 LogPrintf("[snapshot] deleting background chainstate directory (now "
7487 "unnecessary) (%s)\n",
7488 fs::PathToString(ibd_chainstate_path));
7489
7490 fs::path tmp_old{ibd_chainstate_path + "_todelete"};
7491
7492 auto rename_failed_abort = [this](fs::path p_old, fs::path p_new,
7493 const fs::filesystem_error &err) {
7494 LogPrintf("Error renaming path (%s) -> (%s): %s\n",
7495 fs::PathToString(p_old), fs::PathToString(p_new), err.what());
7497 "Rename of '%s' -> '%s' failed. "
7498 "Cannot clean up the background chainstate leveldb directory.",
7499 fs::PathToString(p_old), fs::PathToString(p_new)));
7500 };
7501
7502 try {
7503 fs::rename(ibd_chainstate_path, tmp_old);
7504 } catch (const fs::filesystem_error &e) {
7505 rename_failed_abort(ibd_chainstate_path, tmp_old, e);
7506 throw;
7507 }
7508
7509 LogPrintf("[snapshot] moving snapshot chainstate (%s) to "
7510 "default chainstate directory (%s)\n",
7511 fs::PathToString(snapshot_chainstate_path),
7512 fs::PathToString(ibd_chainstate_path));
7513
7514 try {
7515 fs::rename(snapshot_chainstate_path, ibd_chainstate_path);
7516 } catch (const fs::filesystem_error &e) {
7517 rename_failed_abort(snapshot_chainstate_path, ibd_chainstate_path, e);
7518 throw;
7519 }
7520
7521 if (!DeleteCoinsDBFromDisk(tmp_old, /*is_snapshot=*/false)) {
7522 // No need to FatalError because once the unneeded bg chainstate data is
7523 // moved, it will not interfere with subsequent initialization.
7524 LogPrintf("Deletion of %s failed. Please remove it manually, as the "
7525 "directory is now unnecessary.\n",
7526 fs::PathToString(tmp_old));
7527 } else {
7528 LogPrintf("[snapshot] deleted background chainstate directory (%s)\n",
7529 fs::PathToString(ibd_chainstate_path));
7530 }
7531 return true;
7532}
7533
7534Chainstate &ChainstateManager::GetChainstateForIndexing() {
7535 // We can't always return `m_ibd_chainstate` because after background
7536 // validation has completed,
7537 // `m_snapshot_chainstate == m_active_chainstate`, but it can be indexed.
7538 return (this->GetAll().size() > 1) ? *m_ibd_chainstate
7539 : *m_active_chainstate;
7540}
7541
7542std::pair<int, int>
7543ChainstateManager::GetPruneRange(const Chainstate &chainstate,
7544 int last_height_can_prune) {
7545 if (chainstate.m_chain.Height() <= 0) {
7546 return {0, 0};
7547 }
7548 int prune_start{0};
7549
7550 if (this->GetAll().size() > 1 &&
7551 m_snapshot_chainstate.get() == &chainstate) {
7552 // Leave the blocks in the background IBD chain alone if we're pruning
7553 // the snapshot chain.
7554 prune_start = *Assert(GetSnapshotBaseHeight()) + 1;
7555 }
7556
7557 int max_prune = std::max<int>(0, chainstate.m_chain.Height() -
7558 static_cast<int>(MIN_BLOCKS_TO_KEEP));
7559
7560 // last block to prune is the lesser of (caller-specified height,
7561 // MIN_BLOCKS_TO_KEEP from the tip)
7562 //
7563 // While you might be tempted to prune the background chainstate more
7564 // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
7565 // building - specifically blockfilterindex requires undo data, and if
7566 // we don't maintain this trailing window, we hit indexing failures.
7567 int prune_end = std::min(last_height_can_prune, max_prune);
7568
7569 return {prune_start, prune_end};
7570}
bool IsDAAEnabled(const Consensus::Params &params, int nHeight)
Definition: activation.cpp:24
bool IsUAHFenabled(const Consensus::Params &params, int nHeight)
Definition: activation.cpp:11
static bool IsPhononEnabled(const Consensus::Params &params, int32_t nHeight)
Definition: activation.cpp:65
static bool IsGravitonEnabled(const Consensus::Params &params, int32_t nHeight)
Definition: activation.cpp:51
bool IsMagneticAnomalyEnabled(const Consensus::Params &params, int32_t nHeight)
Check if Nov 15, 2018 HF has activated using block height.
Definition: activation.cpp:37
bool MoneyRange(const Amount nValue)
Definition: amount.h:177
static constexpr Amount SATOSHI
Definition: amount.h:153
static constexpr Amount COIN
Definition: amount.h:154
arith_uint256 UintToArith256(const uint256 &a)
int flags
Definition: bitcoin-tx.cpp:546
@ CHAIN
Outputs do not overspend inputs, no double spends, coinbase output ok, no immature coinbase spends,...
@ TRANSACTIONS
Only first tx is coinbase, 2 <= coinbase input script length <= 100, transactions valid,...
@ SCRIPTS
Scripts & signatures ok.
@ TREE
All parent headers found, difficulty matches, timestamp >= median previous, checkpoint.
arith_uint256 GetBlockProof(const CBlockIndex &block)
Definition: chain.cpp:74
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:89
const CBlockIndex * LastCommonAncestor(const CBlockIndex *pa, const CBlockIndex *pb)
Find the last common ancestor two blocks have.
Definition: chain.cpp:112
bool AreOnTheSameFork(const CBlockIndex *pa, const CBlockIndex *pb)
Check if two block index are on the same fork.
Definition: chain.cpp:136
#define Assert(val)
Identity function.
Definition: check.h:87
#define Assume(val)
Assume is the identity function.
Definition: check.h:100
Non-refcounted RAII wrapper for FILE*.
Definition: streams.h:430
std::string ToString() const
Definition: hash_type.h:28
uint64_t getExcessiveBlockSize() const
Definition: validation.h:150
BlockValidationOptions withCheckPoW(bool _checkPoW=true) const
Definition: validation.h:135
BlockValidationOptions withCheckMerkleRoot(bool _checkMerkleRoot=true) const
Definition: validation.h:142
BlockValidationOptions(const Config &config)
Definition: validation.cpp:117
bool shouldValidatePoW() const
Definition: validation.h:148
bool shouldValidateMerkleRoot() const
Definition: validation.h:149
Wrapper around an AutoFile& that implements a ring buffer to deserialize from.
Definition: streams.h:502
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:23
BlockHash GetHash() const
Definition: block.cpp:11
NodeSeconds Time() const
Definition: block.h:53
uint32_t nBits
Definition: block.h:30
BlockHash hashPrevBlock
Definition: block.h:27
int64_t GetBlockTime() const
Definition: block.h:57
int32_t nVersion
Definition: block.h:26
uint256 hashMerkleRoot
Definition: block.h:28
Definition: block.h:60
bool m_checked_merkle_root
Definition: block.h:69
std::vector< CTransactionRef > vtx
Definition: block.h:63
bool fChecked
Definition: block.h:67
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: blockindex.h:25
bool IsValid(enum BlockValidity nUpTo=BlockValidity::TRANSACTIONS) const EXCLUSIVE_LOCKS_REQUIRED(
Check whether this block index entry is valid up to the passed validity level.
Definition: blockindex.h:191
std::string ToString() const
Definition: blockindex.cpp:30
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: blockindex.h:32
int64_t GetHeaderReceivedTime() const
Definition: blockindex.h:164
arith_uint256 nChainWork
(memory only) Total amount of work (expected number of hashes) in the chain up to and including this ...
Definition: blockindex.h:51
const BlockHash * phashBlock
pointer to the hash of the block, if any.
Definition: blockindex.h:29
int64_t GetChainTxCount() const
Get the number of transaction in the chain so far.
Definition: blockindex.h:138
bool HaveNumChainTxs() const
Check whether this block and all previous blocks back to the genesis block or an assumeutxo snapshot ...
Definition: blockindex.h:154
uint32_t nTime
Definition: blockindex.h:76
int32_t nSequenceId
(memory only) Sequential id assigned to distinguish order in which blocks are received.
Definition: blockindex.h:82
int64_t GetReceivedTimeDiff() const
Definition: blockindex.h:166
int64_t GetBlockTime() const
Definition: blockindex.h:160
int64_t GetMedianTimePast() const
Definition: blockindex.h:172
FlatFilePos GetUndoPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition: blockindex.h:107
CBlockIndex * pskip
pointer to the index of some further predecessor of this block
Definition: blockindex.h:35
unsigned int nTx
Number of transactions in this block.
Definition: blockindex.h:55
bool RaiseValidity(enum BlockValidity nUpTo) EXCLUSIVE_LOCKS_REQUIRED(
Raise the validity level of this block index entry.
Definition: blockindex.h:199
int32_t nVersion
block header
Definition: blockindex.h:74
int64_t nTimeReceived
(memory only) block header metadata
Definition: blockindex.h:85
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: blockindex.cpp:62
BlockHash GetBlockHash() const
Definition: blockindex.h:130
unsigned int nSize
Size of this block.
Definition: blockindex.h:60
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: blockindex.h:38
unsigned int nChainTx
(memory only) Number of transactions in the chain up to and including this block.
Definition: blockindex.h:68
Undo information for a CBlock.
Definition: undo.h:72
std::vector< CTxUndo > vtxundo
Definition: undo.h:75
An in-memory indexed chain of blocks.
Definition: chain.h:138
CBlockIndex * Tip() const
Returns the index entry for the tip of this chain, or nullptr if none.
Definition: chain.h:154
void SetTip(CBlockIndex &block)
Set/initialize a chain with a given tip.
Definition: chain.cpp:8
CBlockIndex * Genesis() const
Returns the index entry for the genesis block of this chain, or nullptr if none.
Definition: chain.h:147
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:178
int Height() const
Return the maximal height in the chain.
Definition: chain.h:190
const CBlockIndex * FindFork(const CBlockIndex *pindex) const
Find the last common block between this chain and a block index entry.
Definition: chain.cpp:49
bool Contains(const CBlockIndex *pindex) const
Efficiently check whether a block is present in this chain.
Definition: chain.h:170
CBlockLocator GetLocator() const
Return a CBlockLocator that refers to the tip of this chain.
Definition: chain.cpp:45
CChainParams defines various tweakable parameters of a given instance of the Bitcoin system.
Definition: chainparams.h:86
const CBlock & GenesisBlock() const
Definition: chainparams.h:112
std::vector< int > GetAvailableSnapshotHeights() const
const CMessageHeader::MessageMagic & DiskMagic() const
Definition: chainparams.h:99
const ChainTxData & TxData() const
Definition: chainparams.h:158
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:98
std::optional< AssumeutxoData > AssumeutxoForHeight(int height) const
Definition: chainparams.h:147
const CCheckpointData & Checkpoints() const
Definition: chainparams.h:145
RAII-style controller object for a CCheckQueue that guarantees the passed queue is finished before co...
Definition: checkqueue.h:208
std::optional< R > Complete()
Definition: checkqueue.h:225
void Add(std::vector< T > &&vChecks)
Definition: checkqueue.h:234
void SetBackend(CCoinsView &viewIn)
Definition: coins.cpp:48
CCoinsView that adds a memory cache for transactions to another CCoinsView.
Definition: coins.h:358
void Sync()
Push the modifications applied to this cache to its base while retaining the contents of this cache (...
Definition: coins.cpp:320
void AddCoin(const COutPoint &outpoint, Coin coin, bool possible_overwrite)
Add a coin.
Definition: coins.cpp:98
BlockHash GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: coins.cpp:218
bool SpendCoin(const COutPoint &outpoint, Coin *moveto=nullptr)
Spend a coin.
Definition: coins.cpp:174
ResetGuard CreateResetGuard() noexcept
Create a scoped guard that will call Reset() on this cache when it goes out of scope.
Definition: coins.h:516
void Uncache(const COutPoint &outpoint)
Removes the UTXO with the given outpoint from the cache, if it is not modified.
Definition: coins.cpp:338
void SetBestBlock(const BlockHash &hashBlock)
Definition: coins.cpp:225
void Flush(bool reallocate_cache=true)
Push the modifications applied to this cache to its base and wipe local state.
Definition: coins.cpp:308
unsigned int GetCacheSize() const
Size of the cache (in number of transaction outputs)
Definition: coins.cpp:350
bool HaveCoinInCache(const COutPoint &outpoint) const
Check if we have the given utxo already loaded in this cache.
Definition: coins.cpp:213
size_t DynamicMemoryUsage() const
Calculate the size of the cache (in bytes)
Definition: coins.cpp:70
void EmplaceCoinInternalDANGER(COutPoint &&outpoint, Coin &&coin)
Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty.
Definition: coins.cpp:146
bool HaveCoin(const COutPoint &outpoint) const override
Just check whether a given outpoint is unspent.
Definition: coins.cpp:208
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: coins.cpp:90
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Definition: coins.cpp:200
CCoinsView backed by the coin database (chainstate/)
Definition: txdb.h:49
std::optional< fs::path > StoragePath()
Definition: txdb.h:75
void ResizeCache(size_t new_cache_size) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Dynamically alter the underlying leveldb cache size.
Definition: txdb.cpp:89
Abstract view on the open txout dataset.
Definition: coins.h:304
virtual std::optional< Coin > GetCoin(const COutPoint &outpoint) const
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: coins.cpp:13
CCoinsView that brings transactions from a mempool into view.
Definition: txmempool.h:645
Fee rate in satoshis per kilobyte: Amount / kB.
Definition: feerate.h:21
static constexpr size_t MESSAGE_START_SIZE
Definition: protocol.h:36
void insert(Span< const uint8_t > vKey)
Definition: bloom.cpp:215
bool contains(Span< const uint8_t > vKey) const
Definition: bloom.cpp:249
CSHA256 & Write(const uint8_t *data, size_t len)
Definition: sha256.cpp:819
Closure representing one script verification.
Definition: validation.h:548
SignatureCache * m_signature_cache
Definition: validation.h:557
ScriptExecutionMetrics GetScriptExecutionMetrics() const
Definition: validation.h:581
uint32_t nFlags
Definition: validation.h:553
TxSigCheckLimiter * pTxLimitSigChecks
Definition: validation.h:558
ScriptExecutionMetrics metrics
Definition: validation.h:555
CTxOut m_tx_out
Definition: validation.h:550
bool cacheStore
Definition: validation.h:554
std::optional< std::pair< ScriptError, std::string > > operator()()
PrecomputedTransactionData txdata
Definition: validation.h:556
const CTransaction * ptxTo
Definition: validation.h:551
unsigned int nIn
Definition: validation.h:552
CheckInputsLimiter * pBlockLimitSigChecks
Definition: validation.h:559
CTxMemPoolEntry stores data about the corresponding transaction, as well as data about all in-mempool...
Definition: mempool_entry.h:65
CTxMemPool stores valid-according-to-the-current-best-chain transactions that may be included in the ...
Definition: txmempool.h:222
RecursiveMutex cs
This mutex needs to be locked when accessing mapTx or other members that are guarded by it.
Definition: txmempool.h:316
void AddTransactionsUpdated(unsigned int n)
Definition: txmempool.cpp:139
size_t DynamicMemoryUsage() const
Definition: txmempool.cpp:814
const Options m_opts
Definition: txmempool.h:353
CTransactionRef get(const TxId &txid) const
Definition: txmempool.cpp:676
void clear(bool include_finalized_txs=false)
Definition: txmempool.cpp:377
CScript scriptPubKey
Definition: transaction.h:131
Amount nValue
Definition: transaction.h:130
Restore the UTXO in a Coin at a given COutPoint.
Definition: undo.h:61
std::vector< Coin > vprevout
Definition: undo.h:64
VerifyDBResult VerifyDB(Chainstate &chainstate, CCoinsView &coinsview, int nCheckLevel, int nCheckDepth) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
kernel::Notifications & m_notifications
Definition: validation.h:643
Chainstate stores and provides an API to update our local knowledge of the current best chain.
Definition: validation.h:725
bool IsBlockAvalancheFinalized(const CBlockIndex *pindex) const EXCLUSIVE_LOCKS_REQUIRED(!cs_avalancheFinalizedBlockIndex)
Checks if a block is finalized by avalanche voting.
const std::optional< BlockHash > m_from_snapshot_blockhash
The blockhash which is the base of the snapshot this chainstate was created from.
Definition: validation.h:832
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:817
void CheckForkWarningConditionsOnNewFork(CBlockIndex *pindexNewForkTip) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ActivateBestChain(BlockValidationState &state, std::shared_ptr< const CBlock > pblock=nullptr, avalanche::Processor *const avalanche=nullptr) EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex
Find the best known block, and make it the tip of the block chain.
Mutex m_chainstate_mutex
The ChainState Mutex.
Definition: validation.h:731
bool ConnectTip(BlockValidationState &state, BlockPolicyValidationState &blockPolicyState, CBlockIndex *pindexNew, const std::shared_ptr< const CBlock > &pblock, DisconnectedBlockTransactions &disconnectpool, const avalanche::Processor *const avalanche=nullptr, ChainstateRole chainstate_role=ChainstateRole::NORMAL) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Connect a new block to m_chain.
void UpdateFlags(CBlockIndex *pindex, CBlockIndex *&pindexReset, F f, C fChild, AC fAncestorWasChanged) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
CChain m_chain
The current chain of blockheaders we consult and build on.
Definition: validation.h:824
bool HasCoinsViews() const
Does this chainstate have a UTXO set attached?
Definition: validation.h:878
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:1114
CTxMemPool * GetMempool()
Definition: validation.h:864
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:884
CCoinsViewCache & CoinsTip() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:851
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:881
void SetBlockFailureFlags(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(voi ResetBlockFailureFlags)(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Set invalidity status to all descendants of a block.
Definition: validation.h:1001
void UnparkBlockImpl(CBlockIndex *pindex, bool fClearChildren) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
void CheckForkWarningConditions() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Chainstate(CTxMemPool *mempool, node::BlockManager &blockman, ChainstateManager &chainman, std::optional< BlockHash > from_snapshot_blockhash=std::nullopt)
void InvalidBlockFound(CBlockIndex *pindex, const BlockValidationState &state) EXCLUSIVE_LOCKS_REQUIRED(cs_main
bool ActivateBestChainStep(BlockValidationState &state, CBlockIndex *pindexMostWork, const std::shared_ptr< const CBlock > &pblock, bool &fInvalidFound, const avalanche::Processor *const avalanche=nullptr, ChainstateRole=ChainstateRole::NORMAL) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Try to make some progress towards making pindexMostWork the active block.
Mutex cs_avalancheFinalizedBlockIndex
Definition: validation.h:755
void ForceFlushStateToDisk()
Unconditionally flush all changes to disk.
bool LoadGenesisBlock()
Ensures we have a genesis block in the block tree, possibly writing one to disk.
void UnparkBlockAndChildren(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Remove parked status from a block and its descendants.
CTxMemPool * m_mempool
Optional mempool that is kept in sync with the chain.
Definition: validation.h:735
CCoinsViewDB & CoinsDB() EXCLUSIVE_LOCKS_REQUIRED(
Definition: validation.h:858
bool DisconnectTip(BlockValidationState &state, DisconnectedBlockTransactions *disconnectpool) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Disconnect m_chain's tip.
bool UnwindBlock(BlockValidationState &state, CBlockIndex *pindex, bool invalidate) EXCLUSIVE_LOCKS_REQUIRED(m_chainstate_mutex
bool InvalidateBlock(BlockValidationState &state, CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex
Mark a block as invalid.
ChainstateManager & m_chainman
The chainstate manager that owns this chainstate.
Definition: validation.h:787
std::unique_ptr< CoinsViews > m_coins_views
Manages the UTXO set, which is a reflection of the contents of m_chain.
Definition: validation.h:739
const CBlockIndex *SnapshotBase() EXCLUSIVE_LOCKS_REQUIRED(std::set< CBlockIndex *, CBlockIndexWorkComparator > setBlockIndexCandidates
The base of the snapshot this chainstate was created from.
Definition: validation.h:839
CRollingBloomFilter m_filterParkingPoliciesApplied
Filter to prevent parking a block due to block policies more than once.
Definition: validation.h:770
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.
DisconnectResult DisconnectBlock(const CBlock &block, const CBlockIndex *pindex, CCoinsViewCache &view) EXCLUSIVE_LOCKS_REQUIRED(boo ConnectBlock)(const CBlock &block, BlockValidationState &state, CBlockIndex *pindex, CCoinsViewCache &view, BlockValidationOptions options, Amount *blockFees=nullptr, bool fJustCheck=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Apply the effects of this block (with given index) on the UTXO set represented by coins.
Definition: validation.h:944
CBlockIndex const * m_best_fork_tip
Definition: validation.h:773
void TryAddBlockIndexCandidate(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool AvalancheFinalizeBlock(CBlockIndex *pindex, avalanche::Processor &avalanche) EXCLUSIVE_LOCKS_REQUIRED(voi ClearAvalancheFinalizedBlock)() EXCLUSIVE_LOCKS_REQUIRED(!cs_avalancheFinalizedBlockIndex)
Mark a block as finalized by avalanche.
Definition: validation.h:987
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:782
ChainstateRole GetRole() const EXCLUSIVE_LOCKS_REQUIRED(void InitCoinsDB(size_t cache_size_bytes, bool in_memory, bool should_wipe, std::string leveldb_name="chainstate")
Return the current role of the chainstate.
CBlockIndex const * m_best_fork_base
Definition: validation.h:774
void InvalidChainFound(CBlockIndex *pindexNew) EXCLUSIVE_LOCKS_REQUIRED(cs_main
void UnparkBlock(CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Remove parked status from a block.
bool PreciousBlock(BlockValidationState &state, CBlockIndex *pindex, avalanche::Processor *const avalanche=nullptr) EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex
Mark a block as precious and reorganize.
void ClearBlockIndexCandidates() EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex * FindForkInGlobalIndex(const CBlockLocator &locator) const EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Find the last common block of this chain and a locator.
Definition: validation.cpp:122
CBlockIndex * FindMostWorkChain(std::vector< const CBlockIndex * > &blocksToReconcile, bool fAutoUnpark) 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...
bool UpdateFlagsForBlock(CBlockIndex *pindexBase, CBlockIndex *pindex, F f) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool ParkBlock(BlockValidationState &state, CBlockIndex *pindex) EXCLUSIVE_LOCKS_REQUIRED(!m_chainstate_mutex
Park a block.
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:1059
Provides an interface for creating and interacting with one or two chainstates: an IBD chainstate gen...
Definition: validation.h:1174
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:1428
ValidationCache m_validation_cache
Definition: validation.h:1320
std::atomic< int32_t > nBlockSequenceId
Every received block is assigned a unique and increasing identifier, so we know which one to give pri...
Definition: validation.h:1336
void RecalculateBestHeader() EXCLUSIVE_LOCKS_REQUIRED(bool DumpRecentHeadersTime(const fs::path &filePath) const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
If, due to invalidation / reconsideration of blocks, the previous best header is no longer valid / gu...
bool DetectSnapshotChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(void ResetChainstates() EXCLUSIVE_LOCKS_REQUIRED(bool DeleteSnapshotChainstate() EXCLUSIVE_LOCKS_REQUIRED(Chainstate &ActivateExistingSnapshot(BlockHash 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(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:1673
const Config & GetConfig() const
Definition: validation.h:1269
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:1380
MempoolAcceptResult ProcessTransaction(const CTransactionRef &tx, bool test_accept=false) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Try to add a transaction to the memory pool.
bool AcceptBlockHeader(const CBlockHeader &block, BlockValidationState &state, CBlockIndex **ppindex, bool min_pow_checked, const std::optional< CCheckpointData > &test_checkpoints=std::nullopt) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
If a block header hasn't already been seen, call CheckBlockHeader on it, ensure that it doesn't desce...
kernel::Notifications & GetNotifications() const
Definition: validation.h:1286
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
Definition: validation.h:1277
bool ProcessNewBlock(const std::shared_ptr< const CBlock > &block, bool force_processing, bool min_pow_checked, bool *new_block, avalanche::Processor *const avalanche=nullptr) LOCKS_EXCLUDED(cs_main)
Process an incoming block.
bool LoadRecentHeadersTime(const fs::path &filePath) EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Load the recent block headers reception time from a file.
std::optional< BlockHash > SnapshotBlockhash() const
bool IsSnapshotValidated() const EXCLUSIVE_LOCKS_REQUIRED(
Is there a snapshot in use and has it been fully validated?
Definition: validation.h:1466
bool IsUsable(const Chainstate *const pchainstate) const EXCLUSIVE_LOCKS_REQUIRED(
Return true if a chainstate is considered usable.
Definition: validation.h:1246
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1435
bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
The state of a background sync (for net processing)
Definition: validation.h:1442
size_t m_total_coinsdb_cache
The total number of bytes available for us to use across all leveldb coins databases.
Definition: validation.h:1384
std::atomic< bool > m_cached_finished_ibd
Whether initial block download has ended and IsInitialBlockDownload should return false from now on.
Definition: validation.h:1329
bool PopulateAndValidateSnapshot(Chainstate &snapshot_chainstate, AutoFile &coins_file, const node::SnapshotMetadata &metadata)
Internal helper for ActivateSnapshot().
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1313
int ActiveHeight() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1432
bool IsSnapshotActive() const
bool AcceptBlock(const std::shared_ptr< const CBlock > &pblock, BlockValidationState &state, 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).
std::function< void()> snapshot_download_completed
Function to restart active indexes; set dynamically to avoid a circular dependency on base/index....
Definition: validation.h:1267
const CChainParams & GetParams() const
Definition: validation.h:1271
bool ProcessNewBlockHeaders(const std::vector< CBlockHeader > &block, bool min_pow_checked, BlockValidationState &state, const CBlockIndex **ppindex=nullptr, const std::optional< CCheckpointData > &test_checkpoints=std::nullopt) LOCKS_EXCLUDED(cs_main)
Process incoming block headers.
const Consensus::Params & GetConsensus() const
Definition: validation.h:1274
ChainstateManager(const util::SignalInterrupt &interrupt, Options options, node::BlockManager::Options blockman_options)
const arith_uint256 & MinimumChainWork() const
Definition: validation.h:1280
void CheckBlockIndex()
Make various assertions about the state of the block index.
const CBlockIndex * GetAvalancheFinalizedTip() const
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:1314
bool LoadBlockIndex() EXCLUSIVE_LOCKS_REQUIRED(cs_main)
Load the block tree and coins database from disk, initializing state if we're running with -reindex.
CChain & ActiveChain() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1429
void MaybeRebalanceCaches() EXCLUSIVE_LOCKS_REQUIRED(void ReportHeadersPresync(const arith_uint256 &work, int64_t height, int64_t timestamp)
Check to see if caches are out of balance and if so, call ResizeCoinsCaches() as needed.
arith_uint256 nLastPreciousChainwork
chainwork for the last block that preciousblock has been applied to.
Definition: validation.h:1341
const BlockHash & AssumedValidBlock() const
Definition: validation.h:1283
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1394
std::set< CBlockIndex * > m_failed_blocks
In order to efficiently track invalidity of headers, we keep the set of blocks which we tried to conn...
Definition: validation.h:1370
void LoadExternalBlockFile(AutoFile &file_in, FlatFilePos *dbp=nullptr, std::multimap< BlockHash, FlatFilePos > *blocks_with_unknown_parent=nullptr, avalanche::Processor *const avalanche=nullptr)
Import blocks from an external file.
int32_t nBlockReverseSequenceId
Decreasing counter (used by subsequent preciousblock calls).
Definition: validation.h:1339
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1318
Simple class for regulating resource usage during CheckInputScripts (and CScriptCheck),...
Definition: validation.h:370
bool consume_and_check(int consumed)
Definition: validation.h:377
A UTXO entry.
Definition: coins.h:31
uint32_t GetHeight() const
Definition: coins.h:48
bool IsCoinBase() const
Definition: coins.h:49
CTxOut & GetTxOut()
Definition: coins.h:52
bool IsSpent() const
Definition: coins.h:50
CoinsViews(DBParams db_params, CoinsViewOptions options)
This constructor initializes CCoinsViewDB and CCoinsViewErrorCatcher instances, but it does not creat...
Definition: config.h:19
virtual const CChainParams & GetChainParams() const =0
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:386
bool get(Element &e, const bool erase) const
get is almost identical to contains(), with the difference that it obtains the found element (for Ele...
Definition: cuckoocache.h:523
void insert(Element e, bool replace=false)
insert loops at most depth_limit times trying to insert a hash at various locations in the table via ...
Definition: cuckoocache.h:421
void updateMempoolForReorg(Chainstate &active_chainstate, bool fAddToMempool, CTxMemPool &pool) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Make mempool consistent after a reorg, by re-adding or recursively erasing disconnected block transac...
void addForBlock(const std::vector< CTransactionRef > &vtx, CTxMemPool &pool) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
void importMempool(CTxMemPool &pool) EXCLUSIVE_LOCKS_REQUIRED(pool.cs)
Fast randomness source.
Definition: random.h:411
Different type to mark Mutex at global scope.
Definition: sync.h:144
static RCUPtr acquire(T *&ptrIn)
Acquire ownership of some pointer.
Definition: rcu.h:103
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:339
The script cache is a map using a key/value element, that caches the success of executing a specific ...
Definition: scriptcache.h:26
static TxSigCheckLimiter getDisabled()
Definition: validation.h:398
Convenience class for initializing and passing the script execution cache and signature cache.
Definition: validation.h:411
CuckooCache::cache< ScriptCacheElement, ScriptCacheHasher > m_script_execution_cache
Definition: validation.h:419
ValidationCache(size_t script_execution_cache_bytes, size_t signature_cache_bytes)
CSHA256 ScriptExecutionCacheHasher() const
Return a copy of the pre-initialized hasher.
Definition: validation.h:429
CSHA256 m_script_execution_cache_hasher
Pre-initialized hasher to avoid having to recreate it for every hash calculation.
Definition: validation.h:415
SignatureCache m_signature_cache
Definition: validation.h:420
void BlockFinalized(const CBlockIndex *pindex)
void BlockDisconnected(const std::shared_ptr< const CBlock > &, const CBlockIndex *pindex)
void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr< const CBlock > &)
void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)
void ChainStateFlushed(ChainstateRole, const CBlockLocator &)
void BlockChecked(const CBlock &, const BlockValidationState &)
bool IsValid() const
Definition: validation.h:119
std::string GetRejectReason() const
Definition: validation.h:123
std::string GetDebugMessage() const
Definition: validation.h:124
bool Error(const std::string &reject_reason)
Definition: validation.h:112
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:101
bool IsError() const
Definition: validation.h:121
Result GetResult() const
Definition: validation.h:122
std::string ToString() const
Definition: validation.h:125
bool IsInvalid() const
Definition: validation.h:120
256-bit unsigned big integer.
uint8_t * begin()
Definition: uint256.h:85
std::string ToString() const
Definition: uint256.h:80
bool IsNull() const
Definition: uint256.h:32
double getdouble() const
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:30
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 std::string &debug_message, const bilingual_str &user_message={})
The fatal error notification is sent to notify the user when an error occurs in kernel code that can'...
virtual void warning(const std::string &warning)
virtual void progress(const bilingual_str &title, int progress_percent, bool resume_possible)
virtual InterruptResult blockTip(SynchronizationState state, CBlockIndex &index)
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
Definition: blockstorage.h:114
const kernel::BlockManagerOpts m_opts
Definition: blockstorage.h:250
RecursiveMutex cs_LastBlockFile
Definition: blockstorage.h:195
bool CheckBlockDataAvailability(const CBlockIndex &upper_block LIFETIMEBOUND, const CBlockIndex &lower_block LIFETIMEBOUND) EXCLUSIVE_LOCKS_REQUIRED(const CBlockIndex *GetFirstBlock(const CBlockIndex &upper_block LIFETIMEBOUND, std::function< bool(BlockStatus)> status_test, 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:415
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 undo???.dat) so that the disk space used is less than a us...
void UpdateBlockInfo(const CBlock &block, unsigned int nHeight, const FlatFilePos &pos)
Update blockfile info while processing a block during reindex.
bool ReadBlockUndo(CBlockUndo &blockundo, const CBlockIndex &index) const
CBlockIndex * LookupBlockIndex(const BlockHash &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool LoadingBlocks() const
Definition: blockstorage.h:364
void UnlinkPrunedFiles(const std::set< int > &setFilesToPrune) const
Actually unlink the specified files.
void WriteBlockIndexDB() EXCLUSIVE_LOCKS_REQUIRED(bool LoadBlockIndexDB(const std::optional< BlockHash > &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:308
std::set< CBlockIndex * > m_dirty_blockindex
Dirty block index entries.
Definition: blockstorage.h:233
std::atomic_bool m_reindexing
Tracks if a reindex is currently in progress.
Definition: blockstorage.h:267
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:228
bool IsPruneMode() const
Whether running in -prune mode.
Definition: blockstorage.h:355
void FindFilesToPruneManual(std::set< int > &setFilesToPrune, int nManualPruneHeight, const Chainstate &chain, ChainstateManager &chainman)
Calculate the block/rev files to delete based on height specified by user with RPC command pruneblock...
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:341
bool ReadBlock(CBlock &block, const FlatFilePos &pos) const
Functions for disk access for blocks.
std::optional< int > m_snapshot_height
The height of the base block of an assumeutxo snapshot, if one is in use.
Definition: blockstorage.h:283
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:285
Metadata describing a serialized version of a UTXO set from which an assumeutxo Chainstate can be con...
Definition: utxo_snapshot.h:30
uint64_t m_coins_count
The number of coins in the UTXO set contained in this snapshot.
Definition: utxo_snapshot.h:41
BlockHash 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:37
256-bit opaque blob.
Definition: uint256.h:129
Helper class that manages an interrupt flag, and allows a thread or signal to interrupt another threa...
const Coin & AccessByTxid(const CCoinsViewCache &view, const TxId &txid)
Utility function to find any unspent output with a given txid.
Definition: coins.cpp:419
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:158
@ BLOCK_CHECKPOINT
the block failed to meet one of our checkpoints
@ 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)
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
@ TX_CHILD_BEFORE_PARENT
This tx outputs are already spent in the mempool.
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/etc limits
@ TX_PACKAGE_RECONSIDERABLE
fails some policy, but might be acceptable if submitted in a (different) package
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
@ TX_DUPLICATE
Tx already in mempool or in the chain.
@ TX_INPUTS_NOT_STANDARD
inputs failed policy rules
@ TX_CONFLICT
Tx conflicts with a finalized tx, i.e.
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
@ TX_AVALANCHE_RECONSIDERABLE
fails some policy, but might be reconsidered by avalanche voting
@ TX_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
@ TX_CONSENSUS
invalid by consensus rules
static constexpr unsigned int LOCKTIME_VERIFY_SEQUENCE
Flags for nSequence and nLockTime locks.
Definition: consensus.h:38
static const uint64_t MAX_TX_SIZE
The maximum allowed size for a transaction, in bytes.
Definition: consensus.h:14
uint64_t GetMaxBlockSigChecksCount(uint64_t maxBlockSize)
Compute the maximum number of sigchecks that can be contained in a block given the MAXIMUM block size...
Definition: consensus.h:47
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:7
bool DeploymentActiveAfter(const CBlockIndex *pindexPrev, const Consensus::Params &params, Consensus::BuriedDeployment dep)
Determine if a deployment is active for the next block.
bool DeploymentActiveAt(const CBlockIndex &index, const Consensus::Params &params, Consensus::BuriedDeployment dep)
Determine if a deployment is active for this block.
DisconnectResult
volatile double sum
Definition: examples.cpp:10
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
Definition: fs_helpers.cpp:258
bool CheckDiskSpace(const fs::path &dir, uint64_t additional_bytes)
Definition: fs_helpers.cpp:97
bool FileCommit(FILE *file)
Ensure file contents are fully committed to disk, using a platform-specific feature analogous to fsyn...
Definition: fs_helpers.cpp:111
bool VerifyScript(const CScript &scriptSig, const CScript &scriptPubKey, uint32_t flags, const BaseSignatureChecker &checker, ScriptExecutionMetrics &metricsOut, ScriptError *serror)
Execute an unlocking and locking script together.
ChainstateRole
This enum describes the various roles a specific Chainstate instance can take.
Definition: chain.h:14
#define LogPrintLevel(category, level,...)
Definition: logging.h:437
#define LogPrintLevel_(category, level, should_ratelimit,...)
Definition: logging.h:407
#define LogPrint(category,...)
Definition: logging.h:452
#define LogInfo(...)
Definition: logging.h:413
#define LogError(...)
Definition: logging.h:419
#define LogPrintf(...)
Definition: logging.h:424
unsigned int nHeight
uint256 BlockMerkleRoot(const CBlock &block, bool *mutated)
Compute the Merkle root of the transactions in a block.
Definition: merkle.cpp:69
@ AVALANCHE
Definition: logging.h:91
@ REINDEX
Definition: logging.h:80
@ VALIDATION
Definition: logging.h:90
@ PRUNE
Definition: logging.h:83
@ MEMPOOL
Definition: logging.h:71
@ BENCH
Definition: logging.h:73
bool CheckBlock(const CCheckpointData &data, int nHeight, const BlockHash &hash)
Returns true if block passes checkpoint checks.
Definition: checkpoints.cpp:11
@ DEPLOYMENT_DERSIG
Definition: params.h:23
@ DEPLOYMENT_P2SH
Definition: params.h:20
@ DEPLOYMENT_CSV
Definition: params.h:24
@ DEPLOYMENT_HEIGHTINCB
Definition: params.h:21
@ DEPLOYMENT_CLTV
Definition: params.h:22
bool CheckTxInputs(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &inputs, int nSpendHeight, Amount &txfee)
Check whether all inputs of this transaction are valid (no double spends and amounts).
Definition: tx_verify.cpp:194
static bool exists(const path &p)
Definition: fs.h:107
static std::string PathToString(const path &path)
Convert path object to byte string.
Definition: fs.h:147
FILE * fopen(const fs::path &p, const char *mode)
Definition: fs.cpp:30
std::string get_filesystem_error_message(const fs::filesystem_error &e)
Definition: fs.cpp:133
std::function< FILE *(const fs::path &, const char *)> FopenFn
Definition: fs.h:204
Definition: common.cpp:23
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:95
CoinStatsHashType
Definition: coinstats.h:24
const fs::path SNAPSHOT_BLOCKHASH_FILENAME
The file in the snapshot chainstate dir which stores the base blockhash.
bool WriteSnapshotBaseBlockhash(Chainstate &snapshot_chainstate)
std::unordered_map< BlockHash, CBlockIndex, BlockHasher > BlockMap
Definition: blockstorage.h:72
std::optional< BlockHash > ReadSnapshotBaseBlockhash(const fs::path &chaindir)
bool WriteSnapshotBaseBlockhash(Chainstate &snapshot_chainstate) EXCLUSIVE_LOCKS_REQUIRED(std::optional< BlockHash > ReadSnapshotBaseBlockhash(const 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::optional< fs::path > FindSnapshotChainstateDir(const fs::path &data_dir)
Return a path to the snapshot-based chainstate dir, if one exists.
bool Func(const std::string &str, Span< const char > &sp)
Parse a function call.
Definition: parsing.cpp:23
Implement std::hash so RCUPtr can be used as a key for maps or sets.
Definition: rcu.h:259
bilingual_str ErrorString(const Result< T > &result)
Definition: result.h:90
auto Join(const std::vector< T > &list, const BaseType &separator, UnaryOp unary_op) -> decltype(unary_op(list.at(0)))
Join a list of items.
Definition: string.h:105
std::string ToString(const T &t)
Locale-independent version of std::to_string.
Definition: string.h:150
std::shared_ptr< Chain::Notifications > m_notifications
Definition: interfaces.cpp:473
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:86
bool CheckPackage(const Package &txns, PackageValidationState &state)
Context-free package policy checks:
Definition: packages.cpp:14
std::vector< CTransactionRef > Package
A package is an ordered list of transactions.
Definition: packages.h:40
@ 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.
bool AreInputsStandard(const CTransaction &tx, const CCoinsViewCache &mapInputs, uint32_t flags)
Check transaction inputs to mitigate two potential denial-of-service attacks:
Definition: policy.cpp:145
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:66
static constexpr uint32_t STANDARD_SCRIPT_VERIFY_FLAGS
Standard script verification flags that standard transactions will comply with.
Definition: policy.h:91
static constexpr uint32_t STANDARD_LOCKTIME_VERIFY_FLAGS
Used as the flags parameter to sequence and nLocktime checks in non-consensus code.
Definition: policy.h:108
bool CheckProofOfWork(const BlockHash &hash, uint32_t nBits, const Consensus::Params &params)
Check whether a block hash satisfies the proof-of-work requirement specified by nBits.
Definition: pow.cpp:87
uint32_t GetNextWorkRequired(const CBlockIndex *pindexPrev, const CBlockHeader *pblock, const CChainParams &chainParams)
Definition: pow.cpp:21
std::shared_ptr< const CTransaction > CTransactionRef
Definition: transaction.h:315
uint256 GetRandHash() noexcept
========== CONVENIENCE FUNCTIONS FOR COMMONLY USED RANDOMNESS ==========
Definition: random.h:494
const char * prefix
Definition: rest.cpp:813
reverse_range< T > reverse_iterate(T &x)
std::string ScriptErrorString(const ScriptError serror)
ScriptError
Definition: script_error.h:11
@ SIGCHECKS_LIMIT_EXCEEDED
@ SCRIPT_VERIFY_P2SH
Definition: script_flags.h:16
@ SCRIPT_VERIFY_SIGPUSHONLY
Definition: script_flags.h:35
@ SCRIPT_VERIFY_LOW_S
Definition: script_flags.h:31
@ SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY
Definition: script_flags.h:68
@ SCRIPT_ENABLE_REPLAY_PROTECTION
Definition: script_flags.h:89
@ SCRIPT_ENABLE_SCHNORR_MULTISIG
Definition: script_flags.h:97
@ SCRIPT_VERIFY_STRICTENC
Definition: script_flags.h:22
@ SCRIPT_VERIFY_NULLFAIL
Definition: script_flags.h:81
@ SCRIPT_VERIFY_DERSIG
Definition: script_flags.h:26
@ SCRIPT_ENFORCE_SIGCHECKS
Definition: script_flags.h:106
@ SCRIPT_VERIFY_CLEANSTACK
Definition: script_flags.h:63
@ SCRIPT_VERIFY_NONE
Definition: script_flags.h:12
@ SCRIPT_VERIFY_MINIMALDATA
Definition: script_flags.h:43
@ SCRIPT_VERIFY_CHECKSEQUENCEVERIFY
Definition: script_flags.h:73
@ SCRIPT_ENABLE_SIGHASH_FORKID
Definition: script_flags.h:85
static std::string ToString(const CService &ip)
Definition: db.h:36
CAddrDb db
Definition: main.cpp:35
size_t GetSerializeSize(const T &t)
Definition: serialize.h:1262
uint64_t ReadCompactSize(Stream &is, bool range_check=true)
Decode a CompactSize-encoded variable-length integer.
Definition: serialize.h:469
Definition: amount.h:23
static constexpr Amount zero() noexcept
Definition: amount.h:36
Holds configuration for use during UTXO snapshot load and validation.
Definition: chainparams.h:48
AssumeutxoHash hash_serialized
The expected hash of the deserialized UTXO set.
Definition: chainparams.h:52
unsigned int nChainTx
Used to populate the nChainTx value, which is used during BlockManager::LoadBlockIndex().
Definition: chainparams.h:60
A BlockHash is a unqiue identifier for a block.
Definition: blockhash.h:13
bool isValid(enum BlockValidity nUpTo=BlockValidity::TRANSACTIONS) const
Check whether this block index entry is valid up to the passed validity level.
Definition: blockstatus.h:99
Describes a place in the block chain to another node such that if the other node doesn't have the sam...
Definition: block.h:108
std::vector< BlockHash > vHave
Definition: block.h:120
Holds various statistics on transactions within a chain.
Definition: chainparams.h:73
double dTxRate
Definition: chainparams.h:76
int64_t nTime
Definition: chainparams.h:74
int64_t nTxCount
Definition: chainparams.h:75
User-controlled performance and debug options.
Definition: txdb.h:40
Parameters that influence chain consensus.
Definition: params.h:34
BlockHash BIP34Hash
Definition: params.h:41
int BIP34Height
Block height and hash at which BIP34 becomes active.
Definition: params.h:40
int nSubsidyHalvingInterval
Definition: params.h:36
BlockHash hashGenesisBlock
Definition: params.h:35
int64_t nPowTargetSpacing
Definition: params.h:85
std::chrono::seconds PowTargetSpacing() const
Definition: params.h:87
int mengerActivationTime
Unix time used for MTP activation of 15 November 2026 12:00:00 UTC upgrade.
Definition: params.h:72
bool fPowAllowMinDifficultyBlocks
Definition: params.h:82
Application-specific storage settings.
Definition: dbwrapper.h:32
fs::path path
Location in the filesystem where leveldb data will be stored.
Definition: dbwrapper.h:34
int nFile
Definition: flatfile.h:15
unsigned int nPos
Definition: flatfile.h:16
bool IsNull() const
Definition: flatfile.h:40
int64_t time
Definition: mempool_entry.h:27
Validation result for a transaction evaluated by MemPoolAccept (single or package).
Definition: validation.h:194
const ResultType m_result_type
Result type.
Definition: validation.h:205
@ VALID
Fully validated, valid.
static MempoolAcceptResult Failure(TxValidationState state)
Definition: validation.h:233
static MempoolAcceptResult FeeFailure(TxValidationState state, CFeeRate effective_feerate, const std::vector< TxId > &txids_fee_calculations)
Definition: validation.h:238
static MempoolAcceptResult Success(int64_t vsize, Amount fees, CFeeRate effective_feerate, const std::vector< TxId > &txids_fee_calculations)
Constructor for success case.
Definition: validation.h:246
static MempoolAcceptResult MempoolTx(int64_t vsize, Amount fees)
Constructor for already-in-mempool case.
Definition: validation.h:256
static time_point now() noexcept
Return current system time or mocked time, if set.
Definition: time.cpp:29
std::chrono::time_point< NodeClock > time_point
Definition: time.h:21
Validation result for package mempool acceptance.
Definition: validation.h:297
Precompute sighash midstate to avoid quadratic hashing.
Definition: transaction.h:325
In future if many more values are added, it should be considered to expand the element size to 64 byt...
Definition: scriptcache.h:52
const char * what() const noexcept override
A TxId is the identifier of a transaction.
Definition: txid.h:14
Bilingual messages:
Definition: translation.h:17
std::string original
Definition: translation.h:18
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...
const std::function< NodeClock::time_point()> adjusted_time_callback
std::optional< bool > 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.
bool store_recent_headers_time
If set, store and load the last few block headers reception time to speed up RTT bootstraping.
std::optional< int64_t > replay_protection_activation_time
If set, this overwrites the timestamp at which replay protection activates.
#define AssertLockNotHeld(cs)
Definition: sync.h:163
#define LOCK(cs)
Definition: sync.h:306
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:357
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:56
#define LOCKS_EXCLUDED(...)
Definition: threadsafety.h:55
#define NO_THREAD_SAFETY_ANALYSIS
Definition: threadsafety.h:58
int64_t GetTimeMillis()
Returns the system time (not mockable)
Definition: time.cpp:76
int64_t GetTime()
DEPRECATED Use either ClockType::now() or Now<TimePointType>() if a cast is needed.
Definition: time.cpp:80
std::string FormatISO8601DateTime(int64_t nTime)
ISO 8601 formatting is preferred.
Definition: time.cpp:96
std::chrono::time_point< NodeClock, std::chrono::seconds > NodeSeconds
Definition: time.h:27
#define LOG_TIME_MILLIS_WITH_CATEGORY(end_msg, log_category)
Definition: timer.h:97
#define LOG_TIME_MILLIS_WITH_CATEGORY_MSG_ONCE(end_msg, log_category)
Definition: timer.h:100
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1202
#define TRACE6(context, event, a, b, c, d, e, f)
Definition: trace.h:45
#define TRACE5(context, event, a, b, c, d, e)
Definition: trace.h:44
bilingual_str _(const char *psz)
Translation function.
Definition: translation.h:68
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:36
bool CheckRegularTransaction(const CTransaction &tx, TxValidationState &state)
Context-independent validity checks for coinbase and non-coinbase transactions.
Definition: tx_check.cpp:74
bool CheckCoinbase(const CTransaction &tx, TxValidationState &state)
Definition: tx_check.cpp:55
bool ContextualCheckTransactionForCurrentBlock(const CBlockIndex &active_chain_tip, const Consensus::Params &params, const CTransaction &tx, TxValidationState &state)
Definition: tx_verify.cpp:72
bool EvaluateSequenceLocks(const CBlockIndex &block, std::pair< int, int64_t > lockPair)
Definition: tx_verify.cpp:176
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:187
bool ContextualCheckTransaction(const Consensus::Params &params, const CTransaction &tx, TxValidationState &state, int nHeight, int64_t nMedianTimePast)
Context dependent validity checks for non coinbase transactions.
Definition: tx_verify.cpp:41
bool ContextualCheckTransactionForCurrentBlock(const CBlockIndex &active_chain_tip, const Consensus::Params &params, const CTransaction &tx, TxValidationState &state) EXCLUSIVE_LOCKS_REQUIRED(std::pair< int, int64_t > CalculateSequenceLocks(const CTransaction &tx, int flags, std::vector< int > &prevHeights, const CBlockIndex &block)
This is a variant of ContextualCheckTransaction which computes the contextual check for a transaction...
Definition: tx_verify.h:62
static const uint32_t MEMPOOL_HEIGHT
Fake height value used in Coins to signify they are only in the memory pool(since 0....
Definition: txmempool.h:56
uint256 uint256S(const char *str)
uint256 from const char *.
Definition: uint256.h:143
#define expect(bit)
static bool DeleteCoinsDBFromDisk(const fs::path &db_path, bool is_snapshot) EXCLUSIVE_LOCKS_REQUIRED(
static bool NotifyHeaderTip(ChainstateManager &chainman) LOCKS_EXCLUDED(cs_main)
static int64_t num_blocks_total
bool FatalError(Notifications &notifications, BlockValidationState &state, const std::string &strMessage, const bilingual_str &userMessage)
GlobalMutex g_best_block_mutex
Definition: validation.cpp:113
static SteadyClock::duration time_connect_total
Amount GetBlockSubsidy(int nHeight, const Consensus::Params &consensusParams)
std::condition_variable g_best_block_cv
Definition: validation.cpp:114
std::optional< LockPoints > CalculateLockPointsAtTip(CBlockIndex *tip, const CCoinsView &coins_view, const CTransaction &tx)
Calculate LockPoints required to check if transaction will be BIP68 final in the next block to be cre...
Definition: validation.cpp:177
static bool pool cs
Definition: validation.cpp:242
return CheckInputScripts(tx, state, view, flags, true, true, txdata, validation_cache, nSigChecksOut)
DisconnectResult ApplyBlockUndo(CBlockUndo &&blockUndo, const CBlock &block, const CBlockIndex *pindex, CCoinsViewCache &view)
Undo a block from the block and the undoblock data.
double GuessVerificationProgress(const ChainTxData &data, const CBlockIndex *pindex)
Guess how far we are in the verification process at the given block index require cs_main if pindex h...
MempoolAcceptResult AcceptToMemoryPool(Chainstate &active_chainstate, const CTransactionRef &tx, int64_t accept_time, bool bypass_limits, bool test_accept, unsigned int heightOverride)
Try to add a transaction to the mempool.
static bool CheckBlockHeader(const CBlockHeader &block, BlockValidationState &state, const Consensus::Params &params, BlockValidationOptions validationOptions)
Return true if the provided block header is valid.
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 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:201
static SteadyClock::duration time_post_connect
static SteadyClock::duration time_chainstate
static uint32_t GetNextBlockScriptFlags(const CBlockIndex *pindex, const ChainstateManager &chainman)
const CBlockIndex * g_best_block
Used to notify getblocktemplate RPC of new tips.
Definition: validation.cpp:115
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.
PackageMempoolAcceptResult ProcessNewPackage(Chainstate &active_chainstate, CTxMemPool &pool, const Package &package, bool test_accept)
Validate (and maybe submit) a package to the mempool.
static SteadyClock::duration time_forks
static ChainstateManager::Options && Flatten(ChainstateManager::Options &&opts)
Apply default chain params to nullopt members.
static constexpr auto DATABASE_WRITE_INTERVAL_MAX
Definition: validation.cpp:94
static SteadyClock::duration time_verify
static bool CheckMerkleRoot(const CBlock &block, BlockValidationState &state)
static SynchronizationState GetSynchronizationState(bool init, bool reindexing)
static SteadyClock::duration time_check
static constexpr int PRUNE_LOCK_BUFFER
The number of blocks to keep below the deepest prune lock.
Definition: validation.cpp:109
static SteadyClock::duration time_index
void SpendCoins(CCoinsViewCache &view, const CTransaction &tx, CTxUndo &txundo, int nHeight)
Mark all the coins corresponding to a given transaction inputs as spent.
bool CheckBlock(const CBlock &block, BlockValidationState &state, const Consensus::Params &params, BlockValidationOptions validationOptions)
Functions for validating blocks and updating the block tree.
static SteadyClock::duration time_connect
const std::vector< std::string > CHECKLEVEL_DOC
Documentation for argument 'checklevel'.
Definition: validation.cpp:95
DisconnectResult UndoCoinSpend(Coin &&undo, CCoinsViewCache &view, const COutPoint &out)
Restore the UTXO in a Coin at a given COutPoint.
bool TestBlockValidity(BlockValidationState &state, const CChainParams &params, Chainstate &chainstate, const CBlock &block, CBlockIndex *pindexPrev, const std::function< NodeClock::time_point()> &adjusted_time_callback, BlockValidationOptions validationOptions)
Check a block is completely valid from start to finish (only works on top of our current best block)
void PruneBlockFilesManual(Chainstate &active_chainstate, int nManualPruneHeight)
Prune block files up to a given height.
static void FlushSnapshotToDisk(CCoinsViewCache &coins_cache, bool snapshot_loaded)
bool IsBlockMutated(const CBlock &block)
Check if a block has been mutated (with respect to its merkle root).
static constexpr auto DATABASE_WRITE_INTERVAL_MIN
Time window to wait between writing blocks/block index and chainstate to disk.
Definition: validation.cpp:93
AssertLockHeld(pool.cs)
static SteadyClock::duration time_total
static bool CheckInputsFromMempoolAndCache(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &view, const CTxMemPool &pool, const uint32_t flags, PrecomputedTransactionData &txdata, ValidationCache &validation_cache, int &nSigChecksOut, CCoinsViewCache &coins_tip) EXCLUSIVE_LOCKS_REQUIRED(cs_main
Checks to avoid mempool polluting consensus critical paths since cached signature and script validity...
std::optional< std::vector< Coin > > GetSpentCoins(const CTransactionRef &ptx, const CCoinsViewCache &coins_view)
Get the coins spent by ptx from the coins_view.
void UpdateCoins(CCoinsViewCache &view, const CTransaction &tx, CTxUndo &txundo, int nHeight)
Apply the effects of this transaction on the UTXO set represented by view.
static bool ContextualCheckBlockHeader(const CBlockHeader &block, BlockValidationState &state, BlockManager &blockman, ChainstateManager &chainman, const CBlockIndex *pindexPrev, NodeClock::time_point now, const std::optional< CCheckpointData > &test_checkpoints=std::nullopt) EXCLUSIVE_LOCKS_REQUIRED(
Context-dependent validity checks.
arith_uint256 CalculateClaimedHeadersWork(const std::vector< CBlockHeader > &headers)
Return the sum of the claimed work on a given set of headers.
static SteadyClock::duration time_flush
static void SnapshotUTXOHashBreakpoint(const util::SignalInterrupt &interrupt)
static constexpr uint64_t HEADERS_TIME_VERSION
Definition: validation.cpp:111
static fs::path GetSnapshotCoinsDBPath(Chainstate &cs) EXCLUSIVE_LOCKS_REQUIRED(
static bool IsReplayProtectionEnabled(const Consensus::Params &params, const CBlockIndex *pindexPrev, const std::optional< int64_t > activation_time)
Definition: validation.cpp:221
static void UpdateTipLog(const CCoinsViewCache &coins_tip, const CBlockIndex *tip, const CChainParams &params, const std::string &func_name, const std::string &prefix) EXCLUSIVE_LOCKS_REQUIRED(
static void LimitValidationInterfaceQueue(ValidationSignals &signals) LOCKS_EXCLUDED(cs_main)
assert(!tx.IsCoinBase())
#define MIN_TRANSACTION_SIZE
Definition: validation.h:83
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:91
SnapshotCompletionResult
Definition: validation.h:1126
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:110
VerifyDBResult
Definition: validation.h:629
CoinsCacheSizeState
Definition: validation.h:703
@ LARGE
The cache is at >= 90% capacity.
@ CRITICAL
The coins cache is in immediate need of a flush.
FlushStateMode
Definition: validation.h:659
void SetfLargeWorkInvalidChainFound(bool flag)
Definition: warnings.cpp:38
void SetfLargeWorkForkFound(bool flag)
Definition: warnings.cpp:28
bool GetfLargeWorkForkFound()
Definition: warnings.cpp:33