Bitcoin ABC 0.33.12
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
2115bool Chainstate::ConnectBlock(const CBlock &block, BlockValidationState &state,
2116 CBlockIndex *pindex, CCoinsViewCache &view,
2117 BlockValidationOptions options, Amount *blockFees,
2118 bool fJustCheck) {
2120 assert(pindex);
2121
2122 const BlockHash block_hash{block.GetHash()};
2123 assert(*pindex->phashBlock == block_hash);
2124
2125 const auto time_start{SteadyClock::now()};
2126
2127 const CChainParams &params{m_chainman.GetParams()};
2128 const Consensus::Params &consensusParams = params.GetConsensus();
2129
2130 // Check it again in case a previous version let a bad block in
2131 // NOTE: We don't currently (re-)invoke ContextualCheckBlock() or
2132 // ContextualCheckBlockHeader() here. This means that if we add a new
2133 // consensus rule that is enforced in one of those two functions, then we
2134 // may have let in a block that violates the rule prior to updating the
2135 // software, and we would NOT be enforcing the rule here. Fully solving
2136 // upgrade from one software version to the next after a consensus rule
2137 // change is potentially tricky and issue-specific.
2138 // Also, currently the rule against blocks more than 2 hours in the future
2139 // is enforced in ContextualCheckBlockHeader(); we wouldn't want to
2140 // re-enforce that rule here (at least until we make it impossible for
2141 // m_adjusted_time_callback() to go backward).
2142 if (!CheckBlock(block, state, consensusParams,
2143 options.withCheckPoW(!fJustCheck)
2144 .withCheckMerkleRoot(!fJustCheck))) {
2146 // We don't write down blocks to disk if they may have been
2147 // corrupted, so this should be impossible unless we're having
2148 // hardware problems.
2149 return FatalError(m_chainman.GetNotifications(), state,
2150 "Corrupt block found indicating potential "
2151 "hardware failure; shutting down");
2152 }
2153 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
2154 return false;
2155 }
2156
2157 // Verify that the view's current state corresponds to the previous block
2158 BlockHash hashPrevBlock =
2159 pindex->pprev == nullptr ? BlockHash() : pindex->pprev->GetBlockHash();
2160 assert(hashPrevBlock == view.GetBestBlock());
2161
2162 m_chainman.num_blocks_total++;
2163
2164 // Special case for the genesis block, skipping connection of its
2165 // transactions (its coinbase is unspendable)
2166 if (block_hash == consensusParams.hashGenesisBlock) {
2167 if (!fJustCheck) {
2168 view.SetBestBlock(pindex->GetBlockHash());
2169 }
2170
2171 return true;
2172 }
2173
2174 bool fScriptChecks = true;
2176 // We've been configured with the hash of a block which has been
2177 // externally verified to have a valid history. A suitable default value
2178 // is included with the software and updated from time to time. Because
2179 // validity relative to a piece of software is an objective fact these
2180 // defaults can be easily reviewed. This setting doesn't force the
2181 // selection of any particular chain but makes validating some faster by
2182 // effectively caching the result of part of the verification.
2183 BlockMap::const_iterator it{
2184 m_blockman.m_block_index.find(m_chainman.AssumedValidBlock())};
2185 if (it != m_blockman.m_block_index.end()) {
2186 if (it->second.GetAncestor(pindex->nHeight) == pindex &&
2187 m_chainman.m_best_header->GetAncestor(pindex->nHeight) ==
2188 pindex &&
2189 m_chainman.m_best_header->nChainWork >=
2191 // This block is a member of the assumed verified chain and an
2192 // ancestor of the best header.
2193 // Script verification is skipped when connecting blocks under
2194 // the assumevalid block. Assuming the assumevalid block is
2195 // valid this is safe because block merkle hashes are still
2196 // computed and checked, Of course, if an assumed valid block is
2197 // invalid due to false scriptSigs this optimization would allow
2198 // an invalid chain to be accepted.
2199 // The equivalent time check discourages hash power from
2200 // extorting the network via DOS attack into accepting an
2201 // invalid block through telling users they must manually set
2202 // assumevalid. Requiring a software change or burying the
2203 // invalid block, regardless of the setting, makes it hard to
2204 // hide the implication of the demand. This also avoids having
2205 // release candidates that are hardly doing any signature
2206 // verification at all in testing without having to artificially
2207 // set the default assumed verified block further back. The test
2208 // against the minimum chain work prevents the skipping when
2209 // denied access to any chain at least as good as the expected
2210 // chain.
2211 fScriptChecks = (GetBlockProofEquivalentTime(
2212 *m_chainman.m_best_header, *pindex,
2213 *m_chainman.m_best_header,
2214 consensusParams) <= 60 * 60 * 24 * 7 * 2);
2215 }
2216 }
2217 }
2218
2219 const auto time_1{SteadyClock::now()};
2220 m_chainman.time_check += time_1 - time_start;
2221 LogPrint(BCLog::BENCH, " - Sanity checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2222 Ticks<MillisecondsDouble>(time_1 - time_start),
2223 Ticks<SecondsDouble>(m_chainman.time_check),
2224 Ticks<MillisecondsDouble>(m_chainman.time_check) /
2225 m_chainman.num_blocks_total);
2226
2227 // Do not allow blocks that contain transactions which 'overwrite' older
2228 // transactions, unless those are already completely spent. If such
2229 // overwrites are allowed, coinbases and transactions depending upon those
2230 // can be duplicated to remove the ability to spend the first instance --
2231 // even after being sent to another address.
2232 // See BIP30, CVE-2012-1909, and http://r6.ca/blog/20120206T005236Z.html
2233 // for more information. This rule was originally applied to all blocks
2234 // with a timestamp after March 15, 2012, 0:00 UTC. Now that the whole
2235 // chain is irreversibly beyond that time it is applied to all blocks
2236 // except the two in the chain that violate it. This prevents exploiting
2237 // the issue against nodes during their initial block download.
2238 bool fEnforceBIP30 = !((pindex->nHeight == 91842 &&
2239 pindex->GetBlockHash() ==
2240 uint256S("0x00000000000a4d0a398161ffc163c503763"
2241 "b1f4360639393e0e4c8e300e0caec")) ||
2242 (pindex->nHeight == 91880 &&
2243 pindex->GetBlockHash() ==
2244 uint256S("0x00000000000743f190a18c5577a3c2d2a1f"
2245 "610ae9601ac046a38084ccb7cd721")));
2246
2247 // Once BIP34 activated it was not possible to create new duplicate
2248 // coinbases and thus other than starting with the 2 existing duplicate
2249 // coinbase pairs, not possible to create overwriting txs. But by the time
2250 // BIP34 activated, in each of the existing pairs the duplicate coinbase had
2251 // overwritten the first before the first had been spent. Since those
2252 // coinbases are sufficiently buried it's no longer possible to create
2253 // further duplicate transactions descending from the known pairs either. If
2254 // we're on the known chain at height greater than where BIP34 activated, we
2255 // can save the db accesses needed for the BIP30 check.
2256
2257 // BIP34 requires that a block at height X (block X) has its coinbase
2258 // scriptSig start with a CScriptNum of X (indicated height X). The above
2259 // logic of no longer requiring BIP30 once BIP34 activates is flawed in the
2260 // case that there is a block X before the BIP34 height of 227,931 which has
2261 // an indicated height Y where Y is greater than X. The coinbase for block
2262 // X would also be a valid coinbase for block Y, which could be a BIP30
2263 // violation. An exhaustive search of all mainnet coinbases before the
2264 // BIP34 height which have an indicated height greater than the block height
2265 // reveals many occurrences. The 3 lowest indicated heights found are
2266 // 209,921, 490,897, and 1,983,702 and thus coinbases for blocks at these 3
2267 // heights would be the first opportunity for BIP30 to be violated.
2268
2269 // The search reveals a great many blocks which have an indicated height
2270 // greater than 1,983,702, so we simply remove the optimization to skip
2271 // BIP30 checking for blocks at height 1,983,702 or higher. Before we reach
2272 // that block in another 25 years or so, we should take advantage of a
2273 // future consensus change to do a new and improved version of BIP34 that
2274 // will actually prevent ever creating any duplicate coinbases in the
2275 // future.
2276 static constexpr int BIP34_IMPLIES_BIP30_LIMIT = 1983702;
2277
2278 // There is no potential to create a duplicate coinbase at block 209,921
2279 // because this is still before the BIP34 height and so explicit BIP30
2280 // checking is still active.
2281
2282 // The final case is block 176,684 which has an indicated height of
2283 // 490,897. Unfortunately, this issue was not discovered until about 2 weeks
2284 // before block 490,897 so there was not much opportunity to address this
2285 // case other than to carefully analyze it and determine it would not be a
2286 // problem. Block 490,897 was, in fact, mined with a different coinbase than
2287 // block 176,684, but it is important to note that even if it hadn't been or
2288 // is remined on an alternate fork with a duplicate coinbase, we would still
2289 // not run into a BIP30 violation. This is because the coinbase for 176,684
2290 // is spent in block 185,956 in transaction
2291 // d4f7fbbf92f4a3014a230b2dc70b8058d02eb36ac06b4a0736d9d60eaa9e8781. This
2292 // spending transaction can't be duplicated because it also spends coinbase
2293 // 0328dd85c331237f18e781d692c92de57649529bd5edf1d01036daea32ffde29. This
2294 // coinbase has an indicated height of over 4.2 billion, and wouldn't be
2295 // duplicatable until that height, and it's currently impossible to create a
2296 // chain that long. Nevertheless we may wish to consider a future soft fork
2297 // which retroactively prevents block 490,897 from creating a duplicate
2298 // coinbase. The two historical BIP30 violations often provide a confusing
2299 // edge case when manipulating the UTXO and it would be simpler not to have
2300 // another edge case to deal with.
2301
2302 // testnet3 has no blocks before the BIP34 height with indicated heights
2303 // post BIP34 before approximately height 486,000,000 and presumably will
2304 // be reset before it reaches block 1,983,702 and starts doing unnecessary
2305 // BIP30 checking again.
2306 assert(pindex->pprev);
2307 CBlockIndex *pindexBIP34height =
2308 pindex->pprev->GetAncestor(consensusParams.BIP34Height);
2309 // Only continue to enforce if we're below BIP34 activation height or the
2310 // block hash at that height doesn't correspond.
2311 fEnforceBIP30 =
2312 fEnforceBIP30 &&
2313 (!pindexBIP34height ||
2314 !(pindexBIP34height->GetBlockHash() == consensusParams.BIP34Hash));
2315
2316 // TODO: Remove BIP30 checking from block height 1,983,702 on, once we have
2317 // a consensus change that ensures coinbases at those heights can not
2318 // duplicate earlier coinbases.
2319 if (fEnforceBIP30 || pindex->nHeight >= BIP34_IMPLIES_BIP30_LIMIT) {
2320 for (const auto &tx : block.vtx) {
2321 for (size_t o = 0; o < tx->vout.size(); o++) {
2322 if (view.HaveCoin(COutPoint(tx->GetId(), o))) {
2324 "bad-txns-BIP30",
2325 "tried to overwrite transaction");
2326 }
2327 }
2328 }
2329 }
2330
2331 // Enforce BIP68 (sequence locks).
2332 int nLockTimeFlags = 0;
2333 if (DeploymentActiveAt(*pindex, consensusParams,
2335 nLockTimeFlags |= LOCKTIME_VERIFY_SEQUENCE;
2336 }
2337
2338 const uint32_t flags = GetNextBlockScriptFlags(pindex->pprev, m_chainman);
2339
2340 const auto time_2{SteadyClock::now()};
2341 m_chainman.time_forks += time_2 - time_1;
2342 LogPrint(BCLog::BENCH, " - Fork checks: %.2fms [%.2fs (%.2fms/blk)]\n",
2343 Ticks<MillisecondsDouble>(time_2 - time_1),
2344 Ticks<SecondsDouble>(m_chainman.time_forks),
2345 Ticks<MillisecondsDouble>(m_chainman.time_forks) /
2346 m_chainman.num_blocks_total);
2347
2348 std::vector<int> prevheights;
2349 Amount nFees = Amount::zero();
2350 int nInputs = 0;
2351
2352 // Limit the total executed signature operations in the block, a consensus
2353 // rule. Tracking during the CPU-consuming part (validation of uncached
2354 // inputs) is per-input atomic and validation in each thread stops very
2355 // quickly after the limit is exceeded, so an adversary cannot cause us to
2356 // exceed the limit by much at all.
2357 CheckInputsLimiter nSigChecksBlockLimiter(
2359
2360 std::vector<TxSigCheckLimiter> nSigChecksTxLimiters;
2361 nSigChecksTxLimiters.resize(block.vtx.size() - 1);
2362
2363 CBlockUndo blockundo;
2364 blockundo.vtxundo.resize(block.vtx.size() - 1);
2365
2367 fScriptChecks ? &m_chainman.GetCheckQueue() : nullptr);
2368
2369 // Add all outputs
2370 try {
2371 for (const auto &ptx : block.vtx) {
2372 AddCoins(view, *ptx, pindex->nHeight);
2373 }
2374 } catch (const std::logic_error &e) {
2375 // This error will be thrown from AddCoin if we try to connect a block
2376 // containing duplicate transactions. Such a thing should normally be
2377 // caught early nowadays (due to ContextualCheckBlock's CTOR
2378 // enforcement) however some edge cases can escape that:
2379 // - ContextualCheckBlock does not get re-run after saving the block to
2380 // disk, and older versions may have saved a weird block.
2381 // - its checks are not applied to pre-CTOR chains, which we might visit
2382 // with checkpointing off.
2384 "tx-duplicate", "tried to overwrite transaction");
2385 }
2386
2387 size_t txIndex = 0;
2388 // nSigChecksRet may be accurate (found in cache) or 0 (checks were
2389 // deferred into vChecks).
2390 int nSigChecksRet;
2391 for (const auto &ptx : block.vtx) {
2392 const CTransaction &tx = *ptx;
2393 const bool isCoinBase = tx.IsCoinBase();
2394 nInputs += tx.vin.size();
2395
2396 {
2397 Amount txfee = Amount::zero();
2398 TxValidationState tx_state;
2399 if (!isCoinBase &&
2400 !Consensus::CheckTxInputs(tx, tx_state, view, pindex->nHeight,
2401 txfee)) {
2402 // Any transaction validation failure in ConnectBlock is a block
2403 // consensus failure.
2405 tx_state.GetRejectReason(),
2406 tx_state.GetDebugMessage() + " in transaction " +
2407 tx.GetId().ToString());
2408 break;
2409 }
2410 nFees += txfee;
2411 }
2412
2413 if (!MoneyRange(nFees)) {
2415 "bad-txns-accumulated-fee-outofrange",
2416 "accumulated fee in the block out of range");
2417 break;
2418 }
2419
2420 // The following checks do not apply to the coinbase.
2421 if (isCoinBase) {
2422 continue;
2423 }
2424
2425 // Check that transaction is BIP68 final BIP68 lock checks (as
2426 // opposed to nLockTime checks) must be in ConnectBlock because they
2427 // require the UTXO set.
2428 prevheights.resize(tx.vin.size());
2429 for (size_t j = 0; j < tx.vin.size(); j++) {
2430 prevheights[j] = view.AccessCoin(tx.vin[j].prevout).GetHeight();
2431 }
2432
2433 if (!SequenceLocks(tx, nLockTimeFlags, prevheights, *pindex)) {
2435 "bad-txns-nonfinal",
2436 "contains a non-BIP68-final transaction " +
2437 tx.GetHash().ToString());
2438 break;
2439 }
2440
2441 // Don't cache results if we're actually connecting blocks (still
2442 // consult the cache, though).
2443 bool fCacheResults = fJustCheck;
2444
2445 const bool fEnforceSigCheck = flags & SCRIPT_ENFORCE_SIGCHECKS;
2446 if (!fEnforceSigCheck) {
2447 // Historically, there has been transactions with a very high
2448 // sigcheck count, so we need to disable this check for such
2449 // transactions.
2450 nSigChecksTxLimiters[txIndex] = TxSigCheckLimiter::getDisabled();
2451 }
2452
2453 std::vector<CScriptCheck> vChecks;
2454 TxValidationState tx_state;
2455 if (fScriptChecks &&
2456 !CheckInputScripts(tx, tx_state, view, flags, fCacheResults,
2457 fCacheResults, PrecomputedTransactionData(tx),
2458 m_chainman.m_validation_cache, nSigChecksRet,
2459 nSigChecksTxLimiters[txIndex],
2460 &nSigChecksBlockLimiter, &vChecks)) {
2461 // Any transaction validation failure in ConnectBlock is a block
2462 // consensus failure
2464 tx_state.GetRejectReason(),
2465 tx_state.GetDebugMessage());
2466 break;
2467 }
2468
2469 control.Add(std::move(vChecks));
2470
2471 // Note: this must execute in the same iteration as CheckTxInputs (not
2472 // in a separate loop) in order to detect double spends. However,
2473 // this does not prevent double-spending by duplicated transaction
2474 // inputs in the same transaction (cf. CVE-2018-17144) -- that check is
2475 // done in CheckBlock (CheckRegularTransaction).
2476 SpendCoins(view, tx, blockundo.vtxundo.at(txIndex), pindex->nHeight);
2477 txIndex++;
2478 }
2479 const auto time_3{SteadyClock::now()};
2480 m_chainman.time_connect += time_3 - time_2;
2482 " - Connect %u transactions: %.2fms (%.3fms/tx, %.3fms/txin) "
2483 "[%.2fs (%.2fms/blk)]\n",
2484 (unsigned)block.vtx.size(),
2485 Ticks<MillisecondsDouble>(time_3 - time_2),
2486 Ticks<MillisecondsDouble>(time_3 - time_2) / block.vtx.size(),
2487 nInputs <= 1
2488 ? 0
2489 : Ticks<MillisecondsDouble>(time_3 - time_2) / (nInputs - 1),
2490 Ticks<SecondsDouble>(m_chainman.time_connect),
2491 Ticks<MillisecondsDouble>(m_chainman.time_connect) /
2492 m_chainman.num_blocks_total);
2493
2494 const Amount blockReward =
2495 nFees + GetBlockSubsidy(pindex->nHeight, consensusParams);
2496 if (block.vtx[0]->GetValueOut() > blockReward && state.IsValid()) {
2497 state.Invalid(
2499 strprintf("coinbase pays too much (actual=%d vs limit=%d)",
2500 block.vtx[0]->GetValueOut(), blockReward));
2501 }
2502
2503 if (blockFees) {
2504 *blockFees = nFees;
2505 }
2506
2507 auto parallel_result = control.Complete();
2508 if (parallel_result.has_value() && state.IsValid()) {
2510 strprintf("mandatory-script-verify-flag-failed (%s)",
2511 ScriptErrorString(parallel_result->first)),
2512 parallel_result->second);
2513 }
2514 if (!state.IsValid()) {
2515 LogInfo("Block validation error: %s\n", state.ToString());
2516 return false;
2517 }
2518 const auto time_4{SteadyClock::now()};
2519 m_chainman.time_verify += time_4 - time_2;
2520 LogPrint(
2522 " - Verify %u txins: %.2fms (%.3fms/txin) [%.2fs (%.2fms/blk)]\n",
2523 nInputs - 1, Ticks<MillisecondsDouble>(time_4 - time_2),
2524 nInputs <= 1
2525 ? 0
2526 : Ticks<MillisecondsDouble>(time_4 - time_2) / (nInputs - 1),
2527 Ticks<SecondsDouble>(m_chainman.time_verify),
2528 Ticks<MillisecondsDouble>(m_chainman.time_verify) /
2529 m_chainman.num_blocks_total);
2530
2531 if (fJustCheck) {
2532 return true;
2533 }
2534
2535 if (!m_blockman.WriteBlockUndo(blockundo, state, *pindex)) {
2536 return false;
2537 }
2538
2539 if (!pindex->IsValid(BlockValidity::SCRIPTS)) {
2541 m_blockman.m_dirty_blockindex.insert(pindex);
2542 }
2543
2544 // add this block to the view's block chain
2545 view.SetBestBlock(pindex->GetBlockHash());
2546
2547 const auto time_5{SteadyClock::now()};
2548 m_chainman.time_index += time_5 - time_4;
2549 LogPrint(BCLog::BENCH, " - Index writing: %.2fms [%.2fs (%.2fms/blk)]\n",
2550 Ticks<MillisecondsDouble>(time_5 - time_4),
2551 Ticks<SecondsDouble>(m_chainman.time_index),
2552 Ticks<MillisecondsDouble>(m_chainman.time_index) /
2553 m_chainman.num_blocks_total);
2554
2555 TRACE6(validation, block_connected, block_hash.data(), pindex->nHeight,
2556 block.vtx.size(), nInputs, nSigChecksRet,
2557 // in microseconds (µs)
2558 time_5 - time_start);
2559
2560 return true;
2561}
2562
2563CoinsCacheSizeState Chainstate::GetCoinsCacheSizeState() {
2565 return this->GetCoinsCacheSizeState(
2568}
2569
2571Chainstate::GetCoinsCacheSizeState(size_t max_coins_cache_size_bytes,
2572 size_t max_mempool_size_bytes) {
2574 int64_t nMempoolUsage = m_mempool ? m_mempool->DynamicMemoryUsage() : 0;
2575 int64_t cacheSize = CoinsTip().DynamicMemoryUsage();
2576 int64_t nTotalSpace =
2577 max_coins_cache_size_bytes +
2578 std::max<int64_t>(int64_t(max_mempool_size_bytes) - nMempoolUsage, 0);
2579
2581 static constexpr int64_t MAX_BLOCK_COINSDB_USAGE_BYTES =
2582 10 * 1024 * 1024; // 10MB
2583 int64_t large_threshold = std::max(
2584 (9 * nTotalSpace) / 10, nTotalSpace - MAX_BLOCK_COINSDB_USAGE_BYTES);
2585
2586 if (cacheSize > nTotalSpace) {
2587 LogPrintf("Cache size (%s) exceeds total space (%s)\n", cacheSize,
2588 nTotalSpace);
2590 } else if (cacheSize > large_threshold) {
2592 }
2594}
2595
2597 FlushStateMode mode, int nManualPruneHeight) {
2598 LOCK(cs_main);
2599 assert(this->CanFlushToDisk());
2600 std::set<int> setFilesToPrune;
2601 bool full_flush_completed = false;
2602
2603 [[maybe_unused]] const size_t coins_count{CoinsTip().GetCacheSize()};
2604 [[maybe_unused]] const size_t coins_mem_usage{
2606
2607 try {
2608 {
2609 bool fFlushForPrune = false;
2610
2611 CoinsCacheSizeState cache_state = GetCoinsCacheSizeState();
2613 if (m_blockman.IsPruneMode() &&
2614 (m_blockman.m_check_for_pruning || nManualPruneHeight > 0) &&
2616 // Make sure we don't prune any of the prune locks bestblocks.
2617 // Pruning is height-based.
2618 int last_prune{m_chain.Height()};
2619 // prune lock that actually was the limiting factor, only used
2620 // for logging
2621 std::optional<std::string> limiting_lock;
2622
2623 for (const auto &prune_lock : m_blockman.m_prune_locks) {
2624 if (prune_lock.second.height_first ==
2625 std::numeric_limits<int>::max()) {
2626 continue;
2627 }
2628 // Remove the buffer and one additional block here to get
2629 // actual height that is outside of the buffer
2630 const int lock_height{prune_lock.second.height_first -
2631 PRUNE_LOCK_BUFFER - 1};
2632 last_prune = std::max(1, std::min(last_prune, lock_height));
2633 if (last_prune == lock_height) {
2634 limiting_lock = prune_lock.first;
2635 }
2636 }
2637
2638 if (limiting_lock) {
2639 LogPrint(BCLog::PRUNE, "%s limited pruning to height %d\n",
2640 limiting_lock.value(), last_prune);
2641 }
2642
2643 if (nManualPruneHeight > 0) {
2645 "find files to prune (manual)", BCLog::BENCH);
2647 setFilesToPrune,
2648 std::min(last_prune, nManualPruneHeight), *this,
2649 m_chainman);
2650 } else {
2651 LOG_TIME_MILLIS_WITH_CATEGORY("find files to prune",
2652 BCLog::BENCH);
2653 m_blockman.FindFilesToPrune(setFilesToPrune, last_prune,
2654 *this, m_chainman);
2656 }
2657 if (!setFilesToPrune.empty()) {
2658 fFlushForPrune = true;
2660 m_blockman.m_block_tree_db->WriteFlag(
2661 "prunedblockfiles", true);
2663 }
2664 }
2665 }
2666 const auto nNow{NodeClock::now()};
2667 // The cache is large and we're within 10% and 10 MiB of the limit,
2668 // but we have time now (not in the middle of a block processing).
2669 bool fCacheLarge = mode == FlushStateMode::PERIODIC &&
2670 cache_state >= CoinsCacheSizeState::LARGE;
2671 // The cache is over the limit, we have to write now.
2672 bool fCacheCritical = mode == FlushStateMode::IF_NEEDED &&
2673 cache_state >= CoinsCacheSizeState::CRITICAL;
2674 // It's been a while since we wrote the block index and chain
2675 // state to disk. Do this frequently, so we don't need to
2676 // redownload or reindex after a crash.
2677 bool fPeriodicWrite =
2678 mode == FlushStateMode::PERIODIC && nNow >= m_next_write;
2679 // Combine all conditions that result in a write to disk.
2680 bool should_write = (mode == FlushStateMode::ALWAYS) ||
2681 fCacheLarge || fCacheCritical ||
2682 fPeriodicWrite || fFlushForPrune;
2683 // Write blocks, block index and best chain related state to disk.
2684 if (should_write) {
2685 // Ensure we can write block index
2687 return FatalError(m_chainman.GetNotifications(), state,
2688 "Disk space is too low!",
2689 _("Disk space is too low!"));
2690 }
2691
2692 {
2694 "write block and undo data to disk", BCLog::BENCH);
2695
2696 // First make sure all block and undo data is flushed to
2697 // disk.
2698 // TODO: Handle return error, or add detailed comment why
2699 // it is safe to not return an error upon failure.
2701 m_chain.Height())) {
2703 "%s: Failed to flush block file.\n",
2704 __func__);
2705 }
2706 }
2707 // Then update all block file information (which may refer to
2708 // block and undo files).
2709 {
2710 LOG_TIME_MILLIS_WITH_CATEGORY("write block index to disk",
2711 BCLog::BENCH);
2712
2713 m_blockman.WriteBlockIndexDB();
2714 }
2715
2716 // Finally remove any pruned files
2717 if (fFlushForPrune) {
2718 LOG_TIME_MILLIS_WITH_CATEGORY("unlink pruned files",
2719 BCLog::BENCH);
2720
2721 m_blockman.UnlinkPrunedFiles(setFilesToPrune);
2722 }
2723
2724 if (!CoinsTip().GetBestBlock().IsNull()) {
2725 // Typical Coin structures on disk are around 48 bytes in
2726 // size. Pushing a new one to the database can cause it to
2727 // be written twice (once in the log, and once in the
2728 // tables). This is already an overestimation, as most will
2729 // delete an existing entry or overwrite one. Still, use a
2730 // conservative safety factor of 2.
2732 48 * 2 * 2 *
2733 CoinsTip().GetDirtyCount())) {
2734 return FatalError(m_chainman.GetNotifications(), state,
2735 "Disk space is too low!",
2736 _("Disk space is too low!"));
2737 }
2738
2739 // Flush the chainstate (which may refer to block index
2740 // entries).
2741 const auto empty_cache{(mode == FlushStateMode::ALWAYS) ||
2742 fCacheLarge || fCacheCritical};
2743 empty_cache ? CoinsTip().Flush() : CoinsTip().Sync();
2744 full_flush_completed = true;
2745 TRACE5(utxocache, flush,
2746 int64_t{Ticks<std::chrono::microseconds>(
2747 SteadyClock::now() - nNow)},
2748 uint32_t(mode), coins_count,
2749 uint64_t(coins_mem_usage), fFlushForPrune);
2750 }
2751 }
2752
2753 if (should_write || m_next_write == NodeClock::time_point::max()) {
2754 constexpr auto range{DATABASE_WRITE_INTERVAL_MAX -
2758 }
2759 }
2760
2761 if (full_flush_completed && m_chainman.m_options.signals) {
2762 // Update best block in wallet (so we can detect restored wallets).
2764 this->GetRole(), m_chain.GetLocator());
2765 }
2766 } catch (const std::runtime_error &e) {
2767 return FatalError(m_chainman.GetNotifications(), state,
2768 std::string("System error while flushing: ") +
2769 e.what());
2770 }
2771 return true;
2772}
2773
2776 if (!this->FlushStateToDisk(state, FlushStateMode::ALWAYS)) {
2777 LogPrintf("%s: failed to flush state (%s)\n", __func__,
2778 state.ToString());
2779 }
2780}
2781
2785 if (!this->FlushStateToDisk(state, FlushStateMode::NONE)) {
2786 LogPrintf("%s: failed to flush state (%s)\n", __func__,
2787 state.ToString());
2788 }
2789}
2790
2791static void UpdateTipLog(const CCoinsViewCache &coins_tip,
2792 const CBlockIndex *tip, const CChainParams &params,
2793 const std::string &func_name,
2794 const std::string &prefix)
2797
2798 // Disable rate limiting in LogPrintLevel_ so this source location may log
2799 // during IBD.
2801 BCLog::LogFlags::ALL, BCLog::Level::Info,
2802 /*should_ratelimit=*/false,
2803 "%s%s: new best=%s height=%d version=0x%08x log2_work=%f tx=%lu "
2804 "date='%s' progress=%f cache=%.1fMiB(%utxo)\n",
2805 prefix, func_name, tip->GetBlockHash().ToString(), tip->nHeight,
2806 tip->nVersion, log(tip->nChainWork.getdouble()) / log(2.0),
2808 GuessVerificationProgress(params.TxData(), tip),
2809 coins_tip.DynamicMemoryUsage() * (1.0 / (1 << 20)),
2810 coins_tip.GetCacheSize());
2811}
2812
2813void Chainstate::UpdateTip(const CBlockIndex *pindexNew) {
2815 const auto &coins_tip = CoinsTip();
2816
2817 const CChainParams &params{m_chainman.GetParams()};
2818
2819 // The remainder of the function isn't relevant if we are not acting on
2820 // the active chainstate, so return if need be.
2821 if (this != &m_chainman.ActiveChainstate()) {
2822 // Only log every so often so that we don't bury log messages at the
2823 // tip.
2824 constexpr int BACKGROUND_LOG_INTERVAL = 2000;
2825 if (pindexNew->nHeight % BACKGROUND_LOG_INTERVAL == 0) {
2826 UpdateTipLog(coins_tip, pindexNew, params, __func__,
2827 "[background validation] ");
2828 }
2829 return;
2830 }
2831
2832 // New best block
2833 if (m_mempool) {
2835 }
2836
2837 {
2839 g_best_block = pindexNew;
2840 g_best_block_cv.notify_all();
2841 }
2842
2843 UpdateTipLog(coins_tip, pindexNew, params, __func__, "");
2844}
2845
2858 DisconnectedBlockTransactions *disconnectpool) {
2860 if (m_mempool) {
2862 }
2863
2864 CBlockIndex *pindexDelete = m_chain.Tip();
2865
2866 assert(pindexDelete);
2867 assert(pindexDelete->pprev);
2868
2869 // Read block from disk.
2870 std::shared_ptr<CBlock> pblock = std::make_shared<CBlock>();
2871 CBlock &block = *pblock;
2872 if (!m_blockman.ReadBlock(block, *pindexDelete)) {
2873 LogError("DisconnectTip(): Failed to read block\n");
2874 return false;
2875 }
2876
2877 // Apply the block atomically to the chain state.
2878 const auto time_start{SteadyClock::now()};
2879 {
2880 CCoinsViewCache view(&CoinsTip());
2881 assert(view.GetBestBlock() == pindexDelete->GetBlockHash());
2882 if (DisconnectBlock(block, pindexDelete, view) !=
2884 LogError("DisconnectTip(): DisconnectBlock %s failed\n",
2885 pindexDelete->GetBlockHash().ToString());
2886 return false;
2887 }
2888
2889 // local CCoinsViewCache goes out of scope
2890 view.Flush(/*reallocate_cache=*/false);
2891 }
2892 LogPrint(BCLog::BENCH, "- Disconnect block: %.2fms\n",
2893 Ticks<MillisecondsDouble>(SteadyClock::now() - time_start));
2894
2895 {
2896 // Prune locks that began at or after the tip should be moved backward
2897 // so they get a chance to reorg
2898 const int max_height_first{pindexDelete->nHeight - 1};
2899 for (auto &prune_lock : m_blockman.m_prune_locks) {
2900 if (prune_lock.second.height_first <= max_height_first) {
2901 continue;
2902 }
2903
2904 prune_lock.second.height_first = max_height_first;
2905 LogPrint(BCLog::PRUNE, "%s prune lock moved back to %d\n",
2906 prune_lock.first, max_height_first);
2907 }
2908 }
2909
2910 // Write the chain state to disk, if necessary.
2912 return false;
2913 }
2914
2915 if (m_mempool) {
2916 // If this block is deactivating a fork, we move all mempool
2917 // transactions in front of disconnectpool for reprocessing in a future
2918 // updateMempoolForReorg call
2919 if (pindexDelete->pprev != nullptr &&
2920 GetNextBlockScriptFlags(pindexDelete, m_chainman) !=
2921 GetNextBlockScriptFlags(pindexDelete->pprev, m_chainman)) {
2923 "Disconnecting mempool due to rewind of upgrade block\n");
2924 if (disconnectpool) {
2925 disconnectpool->importMempool(*m_mempool);
2926 }
2927 m_mempool->clear();
2928 }
2929
2930 if (disconnectpool) {
2931 disconnectpool->addForBlock(block.vtx, *m_mempool);
2932 }
2933 }
2934
2935 m_chain.SetTip(*pindexDelete->pprev);
2936
2937 UpdateTip(pindexDelete->pprev);
2938 // Let wallets know transactions went from 1-confirmed to
2939 // 0-confirmed or conflicted:
2941 m_chainman.m_options.signals->BlockDisconnected(pblock, pindexDelete);
2942 }
2943 return true;
2944}
2945
2951 BlockPolicyValidationState &blockPolicyState,
2952 CBlockIndex *pindexNew,
2953 const std::shared_ptr<const CBlock> &pblock,
2954 DisconnectedBlockTransactions &disconnectpool,
2955 const avalanche::Processor *const avalanche,
2956 const ChainstateRole chainstate_role) {
2958 if (m_mempool) {
2960 }
2961
2962 const Consensus::Params &consensusParams = m_chainman.GetConsensus();
2963
2964 assert(pindexNew->pprev == m_chain.Tip());
2965 // Read block from disk.
2966 const auto time_1{SteadyClock::now()};
2967 std::shared_ptr<const CBlock> pthisBlock;
2968 if (!pblock) {
2969 std::shared_ptr<CBlock> pblockNew = std::make_shared<CBlock>();
2970 if (!m_blockman.ReadBlock(*pblockNew, *pindexNew)) {
2971 return FatalError(m_chainman.GetNotifications(), state,
2972 "Failed to read block");
2973 }
2974 pthisBlock = pblockNew;
2975 } else {
2976 pthisBlock = pblock;
2977 }
2978
2979 const CBlock &blockConnecting = *pthisBlock;
2980
2981 // Apply the block atomically to the chain state.
2982 const auto time_2{SteadyClock::now()};
2983 SteadyClock::time_point time_3;
2984 // When adding aggregate statistics in the future, keep in mind that
2985 // num_blocks_total may be zero until the ConnectBlock() call below.
2986 LogPrint(BCLog::BENCH, " - Load block from disk: %.2fms\n",
2987 Ticks<MillisecondsDouble>(time_2 - time_1));
2988 {
2989 Amount blockFees{Amount::zero()};
2990 CCoinsViewCache &view{*m_coins_views->m_connect_block_view};
2991 const auto reset_guard{view.CreateResetGuard()};
2992 bool rv = ConnectBlock(blockConnecting, state, pindexNew, view,
2994 &blockFees);
2996 m_chainman.m_options.signals->BlockChecked(blockConnecting, state);
2997 }
2998 if (!rv) {
2999 if (state.IsInvalid()) {
3000 InvalidBlockFound(pindexNew, state);
3001 }
3002
3003 LogError("%s: ConnectBlock %s failed, %s\n", __func__,
3004 pindexNew->GetBlockHash().ToString(), state.ToString());
3005 return false;
3006 }
3007
3019 const BlockHash blockhash = pindexNew->GetBlockHash();
3023
3024 const Amount blockReward =
3025 blockFees +
3026 GetBlockSubsidy(pindexNew->nHeight, consensusParams);
3027
3028 std::vector<std::unique_ptr<ParkingPolicy>> parkingPolicies;
3029 parkingPolicies.emplace_back(std::make_unique<MinerFundPolicy>(
3030 consensusParams, *pindexNew, blockConnecting, blockReward));
3031
3032 if (avalanche) {
3033 // Only enable the RTT policy if the node already finalized a
3034 // block. This is because it's very possible that new blocks
3035 // will be parked after a node restart (but after IBD) if the
3036 // node is behind by a few blocks. We want to make sure that the
3037 // node will be able to switch back to the right tip in this
3038 // case.
3039 if (avalanche->hasFinalizedTip()) {
3040 // Special case for testnet, don't reject blocks mined with
3041 // the min difficulty
3042 if (!consensusParams.fPowAllowMinDifficultyBlocks ||
3043 (blockConnecting.GetBlockTime() <=
3044 pindexNew->pprev->GetBlockTime() +
3045 2 * consensusParams.nPowTargetSpacing)) {
3046 parkingPolicies.emplace_back(
3047 std::make_unique<RTTPolicy>(consensusParams,
3048 *pindexNew));
3049 }
3050 }
3051
3052 parkingPolicies.emplace_back(
3053 std::make_unique<StakingRewardsPolicy>(
3054 *avalanche, consensusParams, *pindexNew,
3055 blockConnecting, blockReward));
3056
3057 if (m_mempool) {
3058 parkingPolicies.emplace_back(
3059 std::make_unique<PreConsensusPolicy>(
3060 *avalanche, *pindexNew, blockConnecting, m_mempool,
3061 &disconnectpool));
3062 }
3063 }
3064
3065 // If any block policy is violated, bail on the first one found
3066 if (std::find_if_not(parkingPolicies.begin(), parkingPolicies.end(),
3067 [&](const auto &policy) {
3068 bool ret = (*policy)(blockPolicyState);
3069 if (!ret) {
3070 LogPrintf(
3071 "Park block because it "
3072 "violated a block policy: %s\n",
3073 blockPolicyState.ToString());
3074 }
3075 return ret;
3076 }) != parkingPolicies.end()) {
3077 pindexNew->nStatus = pindexNew->nStatus.withParked();
3078 m_blockman.m_dirty_blockindex.insert(pindexNew);
3079 return false;
3080 }
3081 }
3082
3083 time_3 = SteadyClock::now();
3084 m_chainman.time_connect_total += time_3 - time_2;
3085 assert(m_chainman.num_blocks_total > 0);
3087 " - Connect total: %.2fms [%.2fs (%.2fms/blk)]\n",
3088 Ticks<MillisecondsDouble>(time_3 - time_2),
3089 Ticks<SecondsDouble>(m_chainman.time_connect_total),
3090 Ticks<MillisecondsDouble>(m_chainman.time_connect_total) /
3091 m_chainman.num_blocks_total);
3092 // No need to reallocate since it only has capacity for 1 block
3093 view.Flush(/*reallocate_cache=*/false);
3094 }
3095
3096 const auto time_4{SteadyClock::now()};
3097 m_chainman.time_flush += time_4 - time_3;
3098 LogPrint(BCLog::BENCH, " - Flush: %.2fms [%.2fs (%.2fms/blk)]\n",
3099 Ticks<MillisecondsDouble>(time_4 - time_3),
3100 Ticks<SecondsDouble>(m_chainman.time_flush),
3101 Ticks<MillisecondsDouble>(m_chainman.time_flush) /
3102 m_chainman.num_blocks_total);
3103 // Write the chain state to disk, if necessary.
3104 if (!FlushStateToDisk(state, FlushStateMode::IF_NEEDED)) {
3105 return false;
3106 }
3107 const auto time_5{SteadyClock::now()};
3108 m_chainman.time_chainstate += time_5 - time_4;
3110 " - Writing chainstate: %.2fms [%.2fs (%.2fms/blk)]\n",
3111 Ticks<MillisecondsDouble>(time_5 - time_4),
3112 Ticks<SecondsDouble>(m_chainman.time_chainstate),
3113 Ticks<MillisecondsDouble>(m_chainman.time_chainstate) /
3114 m_chainman.num_blocks_total);
3115 // Remove conflicting transactions from the mempool.
3116 if (m_mempool) {
3117 disconnectpool.removeForBlock(blockConnecting.vtx, *m_mempool);
3118
3119 // If this block is activating a fork, we move all mempool transactions
3120 // in front of disconnectpool for reprocessing in a future
3121 // updateMempoolForReorg call
3122 if (pindexNew->pprev != nullptr &&
3123 GetNextBlockScriptFlags(pindexNew, m_chainman) !=
3124 GetNextBlockScriptFlags(pindexNew->pprev, m_chainman)) {
3125 LogPrint(
3127 "Disconnecting mempool due to acceptance of upgrade block\n");
3128 disconnectpool.importMempool(*m_mempool);
3129 }
3130 }
3131
3132 // Update m_chain & related variables.
3133 m_chain.SetTip(*pindexNew);
3134 UpdateTip(pindexNew);
3135
3136 const auto time_6{SteadyClock::now()};
3137 m_chainman.time_post_connect += time_6 - time_5;
3138 m_chainman.time_total += time_6 - time_1;
3140 " - Connect postprocess: %.2fms [%.2fs (%.2fms/blk)]\n",
3141 Ticks<MillisecondsDouble>(time_6 - time_5),
3142 Ticks<SecondsDouble>(m_chainman.time_post_connect),
3143 Ticks<MillisecondsDouble>(m_chainman.time_post_connect) /
3144 m_chainman.num_blocks_total);
3145 LogPrint(BCLog::BENCH, "- Connect block: %.2fms [%.2fs (%.2fms/blk)]\n",
3146 Ticks<MillisecondsDouble>(time_6 - time_1),
3147 Ticks<SecondsDouble>(m_chainman.time_total),
3148 Ticks<MillisecondsDouble>(m_chainman.time_total) /
3149 m_chainman.num_blocks_total);
3150
3151 // If we are the background validation chainstate, check to see if we are
3152 // done validating the snapshot (i.e. our tip has reached the snapshot's
3153 // base block).
3154 if (this != &m_chainman.ActiveChainstate()) {
3155 // This call may set `m_disabled`, which is referenced immediately
3156 // afterwards in ActivateBestChain, so that we stop connecting blocks
3157 // past the snapshot base.
3158 m_chainman.MaybeCompleteSnapshotValidation();
3159 }
3160
3161 if (m_chainman.m_options.signals) {
3162 m_chainman.m_options.signals->BlockConnected(chainstate_role,
3163 pthisBlock, pindexNew);
3164 }
3165 return true;
3166}
3167
3173 std::vector<const CBlockIndex *> &blocksToReconcile, bool fAutoUnpark) {
3175 do {
3176 CBlockIndex *pindexNew = nullptr;
3177
3178 // Find the best candidate header.
3179 {
3180 std::set<CBlockIndex *, CBlockIndexWorkComparator>::reverse_iterator
3181 it = setBlockIndexCandidates.rbegin();
3182 if (it == setBlockIndexCandidates.rend()) {
3183 return nullptr;
3184 }
3185 pindexNew = *it;
3186 }
3187
3188 // If this block will cause an avalanche finalized block to be reorged,
3189 // then we park it.
3190 {
3192 if (m_avalancheFinalizedBlockIndex &&
3193 !AreOnTheSameFork(pindexNew, m_avalancheFinalizedBlockIndex)) {
3194 LogPrintf("Park block %s because it forks prior to the "
3195 "avalanche finalized chaintip.\n",
3196 pindexNew->GetBlockHash().ToString());
3197 pindexNew->nStatus = pindexNew->nStatus.withParked();
3198 m_blockman.m_dirty_blockindex.insert(pindexNew);
3199 }
3200 }
3201
3202 const CBlockIndex *pindexFork = m_chain.FindFork(pindexNew);
3203
3204 // Check whether all blocks on the path between the currently active
3205 // chain and the candidate are valid. Just going until the active chain
3206 // is an optimization, as we know all blocks in it are valid already.
3207 CBlockIndex *pindexTest = pindexNew;
3208 bool hasValidAncestor = true;
3209 while (hasValidAncestor && pindexTest && pindexTest != pindexFork) {
3210 assert(pindexTest->HaveNumChainTxs() || pindexTest->nHeight == 0);
3211
3212 // If this is a parked chain, but it has enough PoW, clear the park
3213 // state.
3214 bool fParkedChain = pindexTest->nStatus.isOnParkedChain();
3215 if (fAutoUnpark && fParkedChain) {
3216 const CBlockIndex *pindexTip = m_chain.Tip();
3217
3218 // During initialization, pindexTip and/or pindexFork may be
3219 // null. In this case, we just ignore the fact that the chain is
3220 // parked.
3221 if (!pindexTip || !pindexFork) {
3222 UnparkBlock(pindexTest);
3223 continue;
3224 }
3225
3226 // A parked chain can be unparked if it has twice as much PoW
3227 // accumulated as the main chain has since the fork block.
3228 CBlockIndex const *pindexExtraPow = pindexTip;
3229 arith_uint256 requiredWork = pindexTip->nChainWork;
3230 switch (pindexTip->nHeight - pindexFork->nHeight) {
3231 // Limit the penality for depth 1, 2 and 3 to half a block
3232 // worth of work to ensure we don't fork accidentally.
3233 case 3:
3234 case 2:
3235 pindexExtraPow = pindexExtraPow->pprev;
3236 // FALLTHROUGH
3237 case 1: {
3238 const arith_uint256 deltaWork =
3239 pindexExtraPow->nChainWork - pindexFork->nChainWork;
3240 requiredWork += (deltaWork >> 1);
3241 break;
3242 }
3243 default:
3244 requiredWork +=
3245 pindexExtraPow->nChainWork - pindexFork->nChainWork;
3246 break;
3247 }
3248
3249 if (pindexNew->nChainWork > requiredWork) {
3250 // We have enough, clear the parked state.
3251 LogPrintf("Unpark chain up to block %s as it has "
3252 "accumulated enough PoW.\n",
3253 pindexNew->GetBlockHash().ToString());
3254 fParkedChain = false;
3255 UnparkBlock(pindexTest);
3256 }
3257 }
3258
3259 // Pruned nodes may have entries in setBlockIndexCandidates for
3260 // which block files have been deleted. Remove those as candidates
3261 // for the most work chain if we come across them; we can't switch
3262 // to a chain unless we have all the non-active-chain parent blocks.
3263 bool fInvalidChain = pindexTest->nStatus.isInvalid();
3264 bool fMissingData = !pindexTest->nStatus.hasData();
3265 if (!(fInvalidChain || fParkedChain || fMissingData)) {
3266 // The current block is acceptable, move to the parent, up to
3267 // the fork point.
3268 pindexTest = pindexTest->pprev;
3269 continue;
3270 }
3271
3272 // Candidate chain is not usable (either invalid or parked or
3273 // missing data)
3274 hasValidAncestor = false;
3275 setBlockIndexCandidates.erase(pindexTest);
3276
3277 if (fInvalidChain && (m_chainman.m_best_invalid == nullptr ||
3278 pindexNew->nChainWork >
3279 m_chainman.m_best_invalid->nChainWork)) {
3280 m_chainman.m_best_invalid = pindexNew;
3281 }
3282
3283 if (fParkedChain && (m_chainman.m_best_parked == nullptr ||
3284 pindexNew->nChainWork >
3285 m_chainman.m_best_parked->nChainWork)) {
3286 m_chainman.m_best_parked = pindexNew;
3287 }
3288
3289 LogPrintf("Considered switching to better tip %s but that chain "
3290 "contains a%s%s%s block.\n",
3291 pindexNew->GetBlockHash().ToString(),
3292 fInvalidChain ? "n invalid" : "",
3293 fParkedChain ? " parked" : "",
3294 fMissingData ? " missing-data" : "");
3295
3296 CBlockIndex *pindexFailed = pindexNew;
3297 // Remove the entire chain from the set.
3298 while (pindexTest != pindexFailed) {
3299 if (fInvalidChain || fParkedChain) {
3300 pindexFailed->nStatus =
3301 pindexFailed->nStatus.withFailedParent(fInvalidChain)
3302 .withParkedParent(fParkedChain);
3303 m_blockman.m_dirty_blockindex.insert(pindexFailed);
3304 } else if (fMissingData) {
3305 // If we're missing data, then add back to
3306 // m_blocks_unlinked, so that if the block arrives in the
3307 // future we can try adding to setBlockIndexCandidates
3308 // again.
3310 std::make_pair(pindexFailed->pprev, pindexFailed));
3311 }
3312 setBlockIndexCandidates.erase(pindexFailed);
3313 pindexFailed = pindexFailed->pprev;
3314 }
3315
3316 if (fInvalidChain || fParkedChain) {
3317 // We discovered a new chain tip that is either parked or
3318 // invalid, we may want to warn.
3320 }
3321 }
3322
3323 blocksToReconcile.push_back(pindexNew);
3324
3325 // We found a candidate that has valid ancestors. This is our guy.
3326 if (hasValidAncestor) {
3327 return pindexNew;
3328 }
3329 } while (true);
3330}
3331
3337 // Note that we can't delete the current block itself, as we may need to
3338 // return to it later in case a reorganization to a better block fails.
3339 auto it = setBlockIndexCandidates.begin();
3340 while (it != setBlockIndexCandidates.end() &&
3341 setBlockIndexCandidates.value_comp()(*it, m_chain.Tip())) {
3342 setBlockIndexCandidates.erase(it++);
3343 }
3344
3345 // Either the current tip or a successor of it we're working towards is left
3346 // in setBlockIndexCandidates.
3348}
3349
3358 BlockValidationState &state, CBlockIndex *pindexMostWork,
3359 const std::shared_ptr<const CBlock> &pblock, bool &fInvalidFound,
3360 const avalanche::Processor *const avalanche,
3361 const ChainstateRole chainstate_role) {
3363 if (m_mempool) {
3365 }
3366
3367 const CBlockIndex *pindexOldTip = m_chain.Tip();
3368 const CBlockIndex *pindexFork = m_chain.FindFork(pindexMostWork);
3369
3370 // Disconnect active blocks which are no longer in the best chain.
3371 bool fBlocksDisconnected = false;
3372 DisconnectedBlockTransactions disconnectpool;
3373 while (m_chain.Tip() && m_chain.Tip() != pindexFork) {
3374 if (m_mempool && !fBlocksDisconnected) {
3375 // Import and clear mempool; we must do this to preserve
3376 // topological ordering in the mempool index. This is ok since
3377 // inserts into the mempool are very fast now in our new
3378 // implementation.
3379 disconnectpool.importMempool(*m_mempool);
3380 }
3381
3382 if (!DisconnectTip(state, &disconnectpool)) {
3383 // This is likely a fatal error, but keep the mempool consistent,
3384 // just in case. Only remove from the mempool in this case.
3385 if (m_mempool) {
3386 disconnectpool.updateMempoolForReorg(*this, false, *m_mempool);
3387 }
3388
3389 // If we're unable to disconnect a block during normal operation,
3390 // then that is a failure of our local system -- we should abort
3391 // rather than stay on a less work chain.
3393 "Failed to disconnect block; see debug.log for details");
3394 return false;
3395 }
3396
3397 fBlocksDisconnected = true;
3398 }
3399
3400 // Build list of new blocks to connect.
3401 std::vector<CBlockIndex *> vpindexToConnect;
3402 bool fContinue = true;
3403 int nHeight = pindexFork ? pindexFork->nHeight : -1;
3404 while (fContinue && nHeight != pindexMostWork->nHeight) {
3405 // Don't iterate the entire list of potential improvements toward the
3406 // best tip, as we likely only need a few blocks along the way.
3407 int nTargetHeight = std::min(nHeight + 32, pindexMostWork->nHeight);
3408 vpindexToConnect.clear();
3409 vpindexToConnect.reserve(nTargetHeight - nHeight);
3410 CBlockIndex *pindexIter = pindexMostWork->GetAncestor(nTargetHeight);
3411 while (pindexIter && pindexIter->nHeight != nHeight) {
3412 vpindexToConnect.push_back(pindexIter);
3413 pindexIter = pindexIter->pprev;
3414 }
3415
3416 nHeight = nTargetHeight;
3417
3418 // Connect new blocks.
3419 for (CBlockIndex *pindexConnect : reverse_iterate(vpindexToConnect)) {
3420 BlockPolicyValidationState blockPolicyState;
3421 if (!ConnectTip(state, blockPolicyState, pindexConnect,
3422 pindexConnect == pindexMostWork
3423 ? pblock
3424 : std::shared_ptr<const CBlock>(),
3425 disconnectpool, avalanche, chainstate_role)) {
3426 if (state.IsInvalid()) {
3427 // The block violates a consensus rule.
3428 if (state.GetResult() !=
3430 InvalidChainFound(vpindexToConnect.front());
3431 }
3432 state = BlockValidationState();
3433 fInvalidFound = true;
3434 fContinue = false;
3435 break;
3436 }
3437
3438 if (blockPolicyState.IsInvalid()) {
3439 // The block violates a policy rule.
3440 CBlockIndex *pindexParkedDescendant = pindexMostWork;
3441 while (pindexParkedDescendant &&
3442 pindexParkedDescendant != pindexConnect) {
3443 pindexParkedDescendant->nStatus =
3444 pindexParkedDescendant->nStatus.withParkedParent();
3446 pindexParkedDescendant);
3447 setBlockIndexCandidates.erase(pindexParkedDescendant);
3448 pindexParkedDescendant = pindexParkedDescendant->pprev;
3449 }
3450 fContinue = false;
3451 break;
3452 }
3453
3454 // A system error occurred (disk space, database error, ...).
3455 // Make the mempool consistent with the current tip, just in
3456 // case any observers try to use it before shutdown.
3457 if (m_mempool) {
3458 disconnectpool.updateMempoolForReorg(*this, false,
3459 *m_mempool);
3460 }
3461 return false;
3462 } else {
3464 if (!pindexOldTip ||
3465 m_chain.Tip()->nChainWork > pindexOldTip->nChainWork) {
3466 // We're in a better position than we were. Return
3467 // temporarily to release the lock.
3468 fContinue = false;
3469 break;
3470 }
3471 }
3472 }
3473 }
3474
3475 if (m_mempool) {
3476 if (fBlocksDisconnected || !disconnectpool.isEmpty()) {
3477 // If any blocks were disconnected, we need to update the mempool
3478 // even if disconnectpool is empty. The disconnectpool may also be
3479 // non-empty if the mempool was imported due to new validation rules
3480 // being in effect.
3482 "Updating mempool due to reorganization or "
3483 "rules upgrade/downgrade\n");
3484 disconnectpool.updateMempoolForReorg(*this, true, *m_mempool);
3485 }
3486
3487 m_mempool->check(this->CoinsTip(), this->m_chain.Height() + 1);
3488 }
3489
3490 // Callbacks/notifications for a new best chain.
3491 if (fInvalidFound) {
3493 } else {
3495 }
3496
3497 return true;
3498}
3499
3501 bool blockfiles_indexed) {
3502 if (!init) {
3504 }
3505 if (!blockfiles_indexed) {
3507 }
3509}
3510
3512 bool fNotify = false;
3513 bool fInitialBlockDownload = false;
3514 CBlockIndex *pindexHeader = nullptr;
3515 {
3516 LOCK(GetMutex());
3517 pindexHeader = m_best_header;
3518
3519 if (pindexHeader != m_last_notified_header) {
3520 fNotify = true;
3521 fInitialBlockDownload = IsInitialBlockDownload();
3522 m_last_notified_header = pindexHeader;
3523 }
3524 }
3525
3526 // Send block tip changed notifications without the lock held
3527 if (fNotify) {
3529 GetSynchronizationState(fInitialBlockDownload,
3531 pindexHeader->nHeight, pindexHeader->nTime, false);
3532 }
3533 return fNotify;
3534}
3535
3539
3540 if (signals.CallbacksPending() > 10) {
3541 signals.SyncWithValidationInterfaceQueue();
3542 }
3543}
3544
3546 std::shared_ptr<const CBlock> pblock,
3549
3550 // Note that while we're often called here from ProcessNewBlock, this is
3551 // far from a guarantee. Things in the P2P/RPC will often end up calling
3552 // us in the middle of ProcessNewBlock - do not assume pblock is set
3553 // sanely for performance or correctness!
3555
3556 // ABC maintains a fair degree of expensive-to-calculate internal state
3557 // because this function periodically releases cs_main so that it does not
3558 // lock up other threads for too long during large connects - and to allow
3559 // for e.g. the callback queue to drain we use m_chainstate_mutex to enforce
3560 // mutual exclusion so that only one caller may execute this function at a
3561 // time
3563
3564 // Belt-and-suspenders check that we aren't attempting to advance the
3565 // background chainstate past the snapshot base block.
3566 if (WITH_LOCK(::cs_main, return m_disabled)) {
3567 LogPrintf("m_disabled is set - this chainstate should not be in "
3568 "operation. Please report this as a bug. %s\n",
3569 PACKAGE_BUGREPORT);
3570 return false;
3571 }
3572
3573 CBlockIndex *pindexMostWork = nullptr;
3574 CBlockIndex *pindexNewTip = nullptr;
3575 bool exited_ibd{false};
3576 do {
3577 // Block until the validation queue drains. This should largely
3578 // never happen in normal operation, however may happen during
3579 // reindex, causing memory blowup if we run too far ahead.
3580 // Note that if a validationinterface callback ends up calling
3581 // ActivateBestChain this may lead to a deadlock! We should
3582 // probably have a DEBUG_LOCKORDER test for this in the future.
3585 }
3586
3587 std::vector<const CBlockIndex *> blocksToReconcile;
3588 bool blocks_connected = false;
3589
3590 {
3591 LOCK(cs_main);
3592 // Lock transaction pool for at least as long as it takes for
3593 // updateMempoolForReorg to be executed if needed
3594 LOCK(MempoolMutex());
3595 const bool was_in_ibd = m_chainman.IsInitialBlockDownload();
3596 CBlockIndex *starting_tip = m_chain.Tip();
3597 do {
3598 // We absolutely may not unlock cs_main until we've made forward
3599 // progress (with the exception of shutdown due to hardware
3600 // issues, low disk space, etc).
3601
3602 if (pindexMostWork == nullptr) {
3603 pindexMostWork = FindMostWorkChain(
3604 blocksToReconcile,
3606 }
3607
3608 // Whether we have anything to do at all.
3609 if (pindexMostWork == nullptr ||
3610 pindexMostWork == m_chain.Tip()) {
3611 break;
3612 }
3613
3614 bool fInvalidFound = false;
3615 std::shared_ptr<const CBlock> nullBlockPtr;
3616 // BlockConnected signals must be sent for the original role;
3617 // in case snapshot validation is completed during
3618 // ActivateBestChainStep, the result of GetRole() changes from
3619 // BACKGROUND to NORMAL.
3620 const ChainstateRole chainstate_role{this->GetRole()};
3622 state, pindexMostWork,
3623 pblock && pblock->GetHash() ==
3624 pindexMostWork->GetBlockHash()
3625 ? pblock
3626 : nullBlockPtr,
3627 fInvalidFound, avalanche, chainstate_role)) {
3628 // A system error occurred
3629 return false;
3630 }
3631 blocks_connected = true;
3632
3633 if (fInvalidFound ||
3634 (pindexMostWork &&
3635 pindexMostWork->nStatus.isOnParkedChain())) {
3636 // Wipe cache, we may need another branch now.
3637 pindexMostWork = nullptr;
3638 }
3639
3640 pindexNewTip = m_chain.Tip();
3641
3642 // This will have been toggled in
3643 // ActivateBestChainStep -> ConnectTip ->
3644 // MaybeCompleteSnapshotValidation, if at all, so we should
3645 // catch it here.
3646 //
3647 // Break this do-while to ensure we don't advance past the base
3648 // snapshot.
3649 if (m_disabled) {
3650 break;
3651 }
3652 } while (!m_chain.Tip() ||
3653 (starting_tip && CBlockIndexWorkComparator()(
3654 m_chain.Tip(), starting_tip)));
3655
3656 // Check the index once we're done with the above loop, since
3657 // we're going to release cs_main soon. If the index is in a bad
3658 // state now, then it's better to know immediately rather than
3659 // randomly have it cause a problem in a race.
3661
3662 if (blocks_connected) {
3663 const CBlockIndex *pindexFork = m_chain.FindFork(starting_tip);
3664 bool still_in_ibd = m_chainman.IsInitialBlockDownload();
3665
3666 if (was_in_ibd && !still_in_ibd) {
3667 // Active chainstate has exited IBD
3668 exited_ibd = true;
3669 }
3670
3671 // Notify external listeners about the new tip.
3672 // Enqueue while holding cs_main to ensure that UpdatedBlockTip
3673 // is called in the order in which blocks are connected
3674 if (this == &m_chainman.ActiveChainstate() &&
3675 pindexFork != pindexNewTip) {
3676 // Notify ValidationInterface subscribers
3679 pindexNewTip, pindexFork, still_in_ibd);
3680 }
3681
3682 // Always notify the UI if a new block tip was connected
3686 still_in_ibd,
3688 *pindexNewTip))) {
3689 // Just breaking and returning success for now. This
3690 // could be changed to bubble up the kernel::Interrupted
3691 // value to the caller so the caller could distinguish
3692 // between completed and interrupted operations.
3693 break;
3694 }
3695 }
3696 }
3697 }
3698 // When we reach this point, we switched to a new tip (stored in
3699 // pindexNewTip).
3700 if (avalanche) {
3701 const CBlockIndex *pfinalized =
3703 return m_avalancheFinalizedBlockIndex);
3704 for (const CBlockIndex *pindex : blocksToReconcile) {
3705 avalanche->addToReconcile(pindex);
3706
3707 // Compute staking rewards for all blocks with more chainwork to
3708 // just after the finalized block. We could stop at the fork
3709 // point, but this is more robust.
3710 if (blocks_connected) {
3711 const CBlockIndex *pindexTest = pindex;
3712 while (pindexTest && pindexTest != pfinalized) {
3713 if (pindexTest->nHeight < pindex->nHeight - 3) {
3714 // Only compute up to some max depth
3715 break;
3716 }
3717 avalanche->computeStakingReward(pindexTest);
3718 pindexTest = pindexTest->pprev;
3719 }
3720 }
3721 }
3722 }
3723
3724 if (!blocks_connected) {
3725 return true;
3726 }
3727
3728 if (exited_ibd) {
3729 // If a background chainstate is in use, we may need to rebalance
3730 // our allocation of caches once a chainstate exits initial block
3731 // download.
3732 LOCK(::cs_main);
3733 m_chainman.MaybeRebalanceCaches();
3734 }
3735
3736 if (WITH_LOCK(::cs_main, return m_disabled)) {
3737 // Background chainstate has reached the snapshot base block, so
3738 // exit.
3739
3740 // Restart indexes to resume indexing for all blocks unique to the
3741 // snapshot chain. This resumes indexing "in order" from where the
3742 // indexing on the background validation chain left off.
3743 //
3744 // This cannot be done while holding cs_main (within
3745 // MaybeCompleteSnapshotValidation) or a cs_main deadlock will
3746 // occur.
3749 }
3750 break;
3751 }
3752
3753 // We check interrupt only after giving ActivateBestChainStep a chance
3754 // to run once so that we never interrupt before connecting the genesis
3755 // block during LoadChainTip(). Previously this caused an assert()
3756 // failure during interrupt in such cases as the UTXO DB flushing checks
3757 // that the best block hash is non-null.
3758 if (m_chainman.m_interrupt) {
3759 break;
3760 }
3761 } while (pindexNewTip != pindexMostWork);
3762
3763 // Write changes periodically to disk, after relay.
3765 return false;
3766 }
3767
3768 return true;
3769}
3770
3775 {
3776 LOCK(cs_main);
3777 if (pindex->nChainWork < m_chain.Tip()->nChainWork) {
3778 // Nothing to do, this block is not at the tip.
3779 return true;
3780 }
3781
3783 // The chain has been extended since the last call, reset the
3784 // counter.
3786 }
3787
3789 setBlockIndexCandidates.erase(pindex);
3792 std::numeric_limits<int32_t>::min()) {
3793 // We can't keep reducing the counter if somebody really wants to
3794 // call preciousblock 2**31-1 times on the same set of tips...
3796 }
3797
3798 // In case this was parked, unpark it.
3799 UnparkBlock(pindex);
3800
3801 // Make sure it is added to the candidate list if appropriate.
3802 if (pindex->IsValid(BlockValidity::TRANSACTIONS) &&
3803 pindex->HaveNumChainTxs()) {
3804 setBlockIndexCandidates.insert(pindex);
3806 }
3807 }
3808
3809 return ActivateBestChain(state, /*pblock=*/nullptr, avalanche);
3810}
3811
3812namespace {
3813// Leverage RAII to run a functor at scope end
3814template <typename Func> struct Defer {
3815 Func func;
3816 Defer(Func &&f) : func(std::move(f)) {}
3817 ~Defer() { func(); }
3818};
3819} // namespace
3820
3822 bool invalidate) {
3823 // Genesis block can't be invalidated or parked
3824 assert(pindex);
3825 if (pindex->nHeight == 0) {
3826 return false;
3827 }
3828
3829 CBlockIndex *to_mark_failed_or_parked = pindex;
3830 bool pindex_was_in_chain = false;
3831 int disconnected = 0;
3832
3833 // We do not allow ActivateBestChain() to run while UnwindBlock() is
3834 // running, as that could cause the tip to change while we disconnect
3835 // blocks. (Note for backport of Core PR16849: we acquire
3836 // LOCK(m_chainstate_mutex) in the Park, Invalidate and FinalizeBlock
3837 // functions due to differences in our code)
3839
3840 // We'll be acquiring and releasing cs_main below, to allow the validation
3841 // callbacks to run. However, we should keep the block index in a
3842 // consistent state as we disconnect blocks -- in particular we need to
3843 // add equal-work blocks to setBlockIndexCandidates as we disconnect.
3844 // To avoid walking the block index repeatedly in search of candidates,
3845 // build a map once so that we can look up candidate blocks by chain
3846 // work as we go.
3847 std::multimap<const arith_uint256, CBlockIndex *> candidate_blocks_by_work;
3848
3849 {
3850 LOCK(cs_main);
3851 for (auto &entry : m_blockman.m_block_index) {
3852 CBlockIndex *candidate = &entry.second;
3853 // We don't need to put anything in our active chain into the
3854 // multimap, because those candidates will be found and considered
3855 // as we disconnect.
3856 // Instead, consider only non-active-chain blocks that have at
3857 // least as much work as where we expect the new tip to end up.
3858 if (!m_chain.Contains(candidate) &&
3859 !CBlockIndexWorkComparator()(candidate, pindex->pprev) &&
3861 candidate->HaveNumChainTxs()) {
3862 candidate_blocks_by_work.insert(
3863 std::make_pair(candidate->nChainWork, candidate));
3864 }
3865 }
3866 }
3867
3868 {
3869 LOCK(cs_main);
3870 // Lock for as long as disconnectpool is in scope to make sure
3871 // UpdateMempoolForReorg is called after DisconnectTip without unlocking
3872 // in between
3873 LOCK(MempoolMutex());
3874
3875 constexpr int maxDisconnectPoolBlocks = 10;
3876 bool ret = false;
3877 DisconnectedBlockTransactions disconnectpool;
3878 // After 10 blocks this becomes nullptr, so that DisconnectTip will
3879 // stop giving us unwound block txs if we are doing a deep unwind.
3880 DisconnectedBlockTransactions *optDisconnectPool = &disconnectpool;
3881
3882 // Disable thread safety analysis because we can't require m_mempool->cs
3883 // as m_mempool can be null. We keep the runtime analysis though.
3884 Defer deferred([&]() NO_THREAD_SAFETY_ANALYSIS {
3886 if (m_mempool && !disconnectpool.isEmpty()) {
3888 // DisconnectTip will add transactions to disconnectpool.
3889 // When all unwinding is done and we are on a new tip, we must
3890 // add all transactions back to the mempool against the new tip.
3891 disconnectpool.updateMempoolForReorg(*this,
3892 /* fAddToMempool = */ ret,
3893 *m_mempool);
3894 }
3895 });
3896
3897 // Disconnect (descendants of) pindex, and mark them invalid.
3898 while (true) {
3899 if (m_chainman.m_interrupt) {
3900 break;
3901 }
3902
3903 // Make sure the queue of validation callbacks doesn't grow
3904 // unboundedly.
3905 // FIXME this commented code is a regression and could cause OOM if
3906 // a very old block is invalidated via the invalidateblock RPC.
3907 // This can be uncommented if the main signals are moved away from
3908 // cs_main or this code is refactored so that cs_main can be
3909 // released at this point.
3910 //
3911 // LimitValidationInterfaceQueue();
3912
3913 if (!m_chain.Contains(pindex)) {
3914 break;
3915 }
3916
3917 if (m_mempool && disconnected == 0) {
3918 // On first iteration, we grab all the mempool txs to preserve
3919 // topological ordering. This has the side-effect of temporarily
3920 // clearing the mempool, but we will re-add later in
3921 // updateMempoolForReorg() (above). This technique guarantees
3922 // mempool consistency as well as ensures that our topological
3923 // entry_id index is always correct.
3924 disconnectpool.importMempool(*m_mempool);
3925 }
3926
3927 pindex_was_in_chain = true;
3928 CBlockIndex *invalid_walk_tip = m_chain.Tip();
3929
3930 // ActivateBestChain considers blocks already in m_chain
3931 // unconditionally valid already, so force disconnect away from it.
3932
3933 ret = DisconnectTip(state, optDisconnectPool);
3934 ++disconnected;
3935
3936 if (optDisconnectPool && disconnected > maxDisconnectPoolBlocks) {
3937 // Stop using the disconnect pool after 10 blocks. After 10
3938 // blocks we no longer add block tx's to the disconnectpool.
3939 // However, when this scope ends we will reconcile what's
3940 // in the pool with the new tip (in the deferred d'tor above).
3941 optDisconnectPool = nullptr;
3942 }
3943
3944 if (!ret) {
3945 return false;
3946 }
3947
3948 assert(invalid_walk_tip->pprev == m_chain.Tip());
3949
3950 // We immediately mark the disconnected blocks as invalid.
3951 // This prevents a case where pruned nodes may fail to
3952 // invalidateblock and be left unable to start as they have no tip
3953 // candidates (as there are no blocks that meet the "have data and
3954 // are not invalid per nStatus" criteria for inclusion in
3955 // setBlockIndexCandidates).
3956
3957 invalid_walk_tip->nStatus =
3958 invalidate ? invalid_walk_tip->nStatus.withFailed()
3959 : invalid_walk_tip->nStatus.withParked();
3960
3961 m_blockman.m_dirty_blockindex.insert(invalid_walk_tip);
3962 setBlockIndexCandidates.insert(invalid_walk_tip->pprev);
3963
3964 if (invalid_walk_tip == to_mark_failed_or_parked->pprev &&
3965 (invalidate ? to_mark_failed_or_parked->nStatus.hasFailed()
3966 : to_mark_failed_or_parked->nStatus.isParked())) {
3967 // We only want to mark the last disconnected block as
3968 // Failed (or Parked); its children need to be FailedParent (or
3969 // ParkedParent) instead.
3970 to_mark_failed_or_parked->nStatus =
3971 (invalidate
3972 ? to_mark_failed_or_parked->nStatus.withFailed(false)
3973 .withFailedParent()
3974 : to_mark_failed_or_parked->nStatus.withParked(false)
3975 .withParkedParent());
3976
3977 m_blockman.m_dirty_blockindex.insert(to_mark_failed_or_parked);
3978 }
3979
3980 // Add any equal or more work headers to setBlockIndexCandidates
3981 auto candidate_it = candidate_blocks_by_work.lower_bound(
3982 invalid_walk_tip->pprev->nChainWork);
3983 while (candidate_it != candidate_blocks_by_work.end()) {
3984 if (!CBlockIndexWorkComparator()(candidate_it->second,
3985 invalid_walk_tip->pprev)) {
3986 setBlockIndexCandidates.insert(candidate_it->second);
3987 candidate_it = candidate_blocks_by_work.erase(candidate_it);
3988 } else {
3989 ++candidate_it;
3990 }
3991 }
3992
3993 // Track the last disconnected block, so we can correct its
3994 // FailedParent (or ParkedParent) status in future iterations, or,
3995 // if it's the last one, call InvalidChainFound on it.
3996 to_mark_failed_or_parked = invalid_walk_tip;
3997 }
3998 }
3999
4001
4002 {
4003 LOCK(cs_main);
4004 if (m_chain.Contains(to_mark_failed_or_parked)) {
4005 // If the to-be-marked invalid block is in the active chain,
4006 // something is interfering and we can't proceed.
4007 return false;
4008 }
4009
4010 // Mark pindex (or the last disconnected block) as invalid (or parked),
4011 // even when it never was in the main chain.
4012 to_mark_failed_or_parked->nStatus =
4013 invalidate ? to_mark_failed_or_parked->nStatus.withFailed()
4014 : to_mark_failed_or_parked->nStatus.withParked();
4015 m_blockman.m_dirty_blockindex.insert(to_mark_failed_or_parked);
4016 if (invalidate) {
4017 m_chainman.m_failed_blocks.insert(to_mark_failed_or_parked);
4018 }
4019
4020 // If any new blocks somehow arrived while we were disconnecting
4021 // (above), then the pre-calculation of what should go into
4022 // setBlockIndexCandidates may have missed entries. This would
4023 // technically be an inconsistency in the block index, but if we clean
4024 // it up here, this should be an essentially unobservable error.
4025 // Loop back over all block index entries and add any missing entries
4026 // to setBlockIndexCandidates.
4027 for (auto &[_, block_index] : m_blockman.m_block_index) {
4028 if (block_index.IsValid(BlockValidity::TRANSACTIONS) &&
4029 block_index.HaveNumChainTxs() &&
4030 !setBlockIndexCandidates.value_comp()(&block_index,
4031 m_chain.Tip())) {
4032 setBlockIndexCandidates.insert(&block_index);
4033 }
4034 }
4035
4036 if (invalidate) {
4037 InvalidChainFound(to_mark_failed_or_parked);
4038 }
4039 }
4040
4041 // Only notify about a new block tip if the active chain was modified.
4042 if (pindex_was_in_chain) {
4043 // Ignoring return value for now, this could be changed to bubble up
4044 // kernel::Interrupted value to the caller so the caller could
4045 // distinguish between completed and interrupted operations. It might
4046 // also make sense for the blockTip notification to have an enum
4047 // parameter indicating the source of the tip change so hooks can
4048 // distinguish user-initiated invalidateblock changes from other
4049 // changes.
4053 *to_mark_failed_or_parked->pprev);
4054 }
4055 return true;
4056}
4057
4059 CBlockIndex *pindex) {
4062 // See 'Note for backport of Core PR16849' in Chainstate::UnwindBlock
4064
4065 return UnwindBlock(state, pindex, true);
4066}
4067
4071 // See 'Note for backport of Core PR16849' in Chainstate::UnwindBlock
4073
4074 return UnwindBlock(state, pindex, false);
4075}
4076
4077template <typename F>
4079 CBlockIndex *pindex, F f) {
4080 BlockStatus newStatus = f(pindex->nStatus);
4081 if (pindex->nStatus != newStatus &&
4082 (!pindexBase ||
4083 pindex->GetAncestor(pindexBase->nHeight) == pindexBase)) {
4084 pindex->nStatus = newStatus;
4085 m_blockman.m_dirty_blockindex.insert(pindex);
4086 if (newStatus.isValid()) {
4087 m_chainman.m_failed_blocks.erase(pindex);
4088 }
4089
4090 if (pindex->IsValid(BlockValidity::TRANSACTIONS) &&
4091 pindex->HaveNumChainTxs() &&
4092 setBlockIndexCandidates.value_comp()(m_chain.Tip(), pindex)) {
4093 setBlockIndexCandidates.insert(pindex);
4094 }
4095 return true;
4096 }
4097 return false;
4098}
4099
4100template <typename F, typename C, typename AC>
4102 F f, C fChild, AC fAncestorWasChanged) {
4104
4105 // Update the current block and ancestors; while we're doing this, identify
4106 // which was the deepest ancestor we changed.
4107 CBlockIndex *pindexDeepestChanged = pindex;
4108 for (auto pindexAncestor = pindex; pindexAncestor != nullptr;
4109 pindexAncestor = pindexAncestor->pprev) {
4110 if (UpdateFlagsForBlock(nullptr, pindexAncestor, f)) {
4111 pindexDeepestChanged = pindexAncestor;
4112 }
4113 }
4114
4115 if (pindexReset &&
4116 pindexReset->GetAncestor(pindexDeepestChanged->nHeight) ==
4117 pindexDeepestChanged) {
4118 // reset pindexReset if it had a modified ancestor.
4119 pindexReset = nullptr;
4120 }
4121
4122 // Update all blocks under modified blocks.
4123 for (auto &[_, block_index] : m_blockman.m_block_index) {
4124 UpdateFlagsForBlock(pindex, &block_index, fChild);
4125 UpdateFlagsForBlock(pindexDeepestChanged, &block_index,
4126 fAncestorWasChanged);
4127 }
4128}
4129
4130void Chainstate::SetBlockFailureFlags(CBlockIndex *invalid_block) {
4132
4133 for (auto &[_, block_index] : m_blockman.m_block_index) {
4134 if (block_index.GetAncestor(invalid_block->nHeight) == invalid_block &&
4135 !block_index.nStatus.isInvalid()) {
4136 block_index.nStatus = block_index.nStatus.withFailedParent();
4137 }
4138 }
4139}
4140
4143
4145 pindex, m_chainman.m_best_invalid,
4146 [](const BlockStatus status) {
4147 return status.withClearedFailureFlags();
4148 },
4149 [](const BlockStatus status) {
4150 return status.withClearedFailureFlags();
4151 },
4152 [](const BlockStatus status) {
4153 return status.withFailedParent(false);
4154 });
4155}
4156
4159 // The block only is a candidate for the most-work-chain if it has the same
4160 // or more work than our current tip.
4161 if (m_chain.Tip() != nullptr &&
4162 setBlockIndexCandidates.value_comp()(pindex, m_chain.Tip())) {
4163 return;
4164 }
4165
4166 bool is_active_chainstate = this == &m_chainman.ActiveChainstate();
4167 if (is_active_chainstate) {
4168 // The active chainstate should always add entries that have more
4169 // work than the tip.
4170 setBlockIndexCandidates.insert(pindex);
4171 } else if (!m_disabled) {
4172 // For the background chainstate, we only consider connecting blocks
4173 // towards the snapshot base (which can't be nullptr or else we'll
4174 // never make progress).
4175 const CBlockIndex *snapshot_base{
4176 Assert(m_chainman.GetSnapshotBaseBlock())};
4177 if (snapshot_base->GetAncestor(pindex->nHeight) == pindex) {
4178 setBlockIndexCandidates.insert(pindex);
4179 }
4180 }
4181}
4182
4183void Chainstate::UnparkBlockImpl(CBlockIndex *pindex, bool fClearChildren) {
4185
4187 pindex, m_chainman.m_best_parked,
4188 [](const BlockStatus status) {
4189 return status.withClearedParkedFlags();
4190 },
4191 [fClearChildren](const BlockStatus status) {
4192 return fClearChildren ? status.withClearedParkedFlags()
4193 : status.withParkedParent(false);
4194 },
4195 [](const BlockStatus status) {
4196 return status.withParkedParent(false);
4197 });
4198}
4199
4201 return UnparkBlockImpl(pindex, true);
4202}
4203
4205 return UnparkBlockImpl(pindex, false);
4206}
4207
4208bool Chainstate::AvalancheFinalizeBlock(CBlockIndex *pindex,
4212
4213 if (!pindex) {
4214 return false;
4215 }
4216
4217 if (!m_chain.Contains(pindex)) {
4219 "The block to mark finalized by avalanche is not on the "
4220 "active chain: %s\n",
4221 pindex->GetBlockHash().ToString());
4222 return false;
4223 }
4224
4225 if (IsBlockAvalancheFinalized(pindex)) {
4226 return true;
4227 }
4228
4229 {
4231 m_avalancheFinalizedBlockIndex = pindex;
4232 }
4233
4236 }
4237
4238 return true;
4239}
4240
4243 m_avalancheFinalizedBlockIndex = nullptr;
4244}
4245
4248 return pindex && m_avalancheFinalizedBlockIndex &&
4249 m_avalancheFinalizedBlockIndex->GetAncestor(pindex->nHeight) ==
4250 pindex;
4251}
4252
4258 CBlockIndex *pindexNew,
4259 const FlatFilePos &pos) {
4260 pindexNew->nTx = block.vtx.size();
4261 // Typically nChainTX will be 0 at this point, but it can be nonzero if this
4262 // is a pruned block which is being downloaded again, or if this is an
4263 // assumeutxo snapshot block which has a hardcoded m_chain_tx_count value
4264 // from the snapshot metadata. If the pindex is not the snapshot block and
4265 // the m_chain_tx_count value is not zero, assert that value is actually
4266 // correct.
4267 auto prev_tx_sum = [](CBlockIndex &block) {
4268 return block.nTx + (block.pprev ? block.pprev->m_chain_tx_count : 0);
4269 };
4270 if (!Assume(pindexNew->m_chain_tx_count == 0 ||
4271 pindexNew->m_chain_tx_count == prev_tx_sum(*pindexNew) ||
4272 pindexNew == GetSnapshotBaseBlock())) {
4273 LogPrintf("Internal bug detected: block %d has unexpected "
4274 "m_chain_tx_count %lu that should be %lu. Please report "
4275 "this issue here: %s\n",
4276 pindexNew->nHeight, pindexNew->m_chain_tx_count,
4277 prev_tx_sum(*pindexNew), PACKAGE_BUGREPORT);
4278 pindexNew->m_chain_tx_count = 0;
4279 }
4280 pindexNew->nSize = ::GetSerializeSize(block);
4281 pindexNew->nFile = pos.nFile;
4282 pindexNew->nDataPos = pos.nPos;
4283 pindexNew->nUndoPos = 0;
4284 pindexNew->nStatus = pindexNew->nStatus.withData();
4286 m_blockman.m_dirty_blockindex.insert(pindexNew);
4287
4288 if (pindexNew->pprev == nullptr || pindexNew->pprev->HaveNumChainTxs()) {
4289 // If pindexNew is the genesis block or all parents are
4290 // BLOCK_VALID_TRANSACTIONS.
4291 std::deque<CBlockIndex *> queue;
4292 queue.push_back(pindexNew);
4293
4294 // Recursively process any descendant blocks that now may be eligible to
4295 // be connected.
4296 while (!queue.empty()) {
4297 CBlockIndex *pindex = queue.front();
4298 queue.pop_front();
4299 // Before setting m_chain_tx_count, assert that it is 0 or already
4300 // set to the correct value. This assert will fail after receiving
4301 // the assumeutxo snapshot block if assumeutxo snapshot metadata has
4302 // an incorrect hardcoded AssumeutxoData::m_chain_tx_count value.
4303 if (!Assume(pindex->m_chain_tx_count == 0 ||
4304 pindex->m_chain_tx_count == prev_tx_sum(*pindex))) {
4305 LogPrintf("Internal bug detected: block %d has unexpected "
4306 "m_chain_tx_count %lu that should be %lu. Please "
4307 "report this issue here: %s\n",
4308 pindex->nHeight, pindex->m_chain_tx_count,
4309 prev_tx_sum(*pindex), PACKAGE_BUGREPORT);
4310 }
4311 pindex->m_chain_tx_count = prev_tx_sum(*pindex);
4312 if (pindex->nSequenceId == 0) {
4313 // We assign a sequence is when transaction are received to
4314 // prevent a miner from being able to broadcast a block but not
4315 // its content. However, a sequence id may have been set
4316 // manually, for instance via PreciousBlock, in which case, we
4317 // don't need to assign one.
4318 pindex->nSequenceId = nBlockSequenceId++;
4319 }
4320 for (Chainstate *c : GetAll()) {
4321 c->TryAddBlockIndexCandidate(pindex);
4322 }
4323
4324 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
4325 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
4326 range = m_blockman.m_blocks_unlinked.equal_range(pindex);
4327 while (range.first != range.second) {
4328 std::multimap<CBlockIndex *, CBlockIndex *>::iterator it =
4329 range.first;
4330 queue.push_back(it->second);
4331 range.first++;
4332 m_blockman.m_blocks_unlinked.erase(it);
4333 }
4334 }
4335 } else if (pindexNew->pprev &&
4336 pindexNew->pprev->IsValid(BlockValidity::TREE)) {
4338 std::make_pair(pindexNew->pprev, pindexNew));
4339 }
4340}
4341
4350static bool CheckBlockHeader(const CBlockHeader &block,
4351 BlockValidationState &state,
4352 const Consensus::Params &params,
4353 BlockValidationOptions validationOptions) {
4354 // Check proof of work matches claimed amount
4355 if (validationOptions.shouldValidatePoW() &&
4356 !CheckProofOfWork(block.GetHash(), block.nBits, params)) {
4358 "high-hash", "proof of work failed");
4359 }
4360
4361 return true;
4362}
4363
4364static bool CheckMerkleRoot(const CBlock &block, BlockValidationState &state) {
4365 if (block.m_checked_merkle_root) {
4366 return true;
4367 }
4368
4369 bool mutated;
4370 uint256 merkle_root = BlockMerkleRoot(block, &mutated);
4371 if (block.hashMerkleRoot != merkle_root) {
4372 return state.Invalid(
4374 /*reject_reason=*/"bad-txnmrklroot",
4375 /*debug_message=*/"hashMerkleRoot mismatch");
4376 }
4377
4378 // Check for merkle tree malleability (CVE-2012-2459): repeating sequences
4379 // of transactions in a block without affecting the merkle root of a block,
4380 // while still invalidating it.
4381 if (mutated) {
4382 return state.Invalid(
4384 /*reject_reason=*/"bad-txns-duplicate",
4385 /*debug_message=*/"duplicate transaction");
4386 }
4387
4388 block.m_checked_merkle_root = true;
4389 return true;
4390}
4391
4392bool CheckBlock(const CBlock &block, BlockValidationState &state,
4393 const Consensus::Params &params,
4394 BlockValidationOptions validationOptions) {
4395 // These are checks that are independent of context.
4396 if (block.fChecked) {
4397 return true;
4398 }
4399
4400 // Check that the header is valid (particularly PoW). This is mostly
4401 // redundant with the call in AcceptBlockHeader.
4402 if (!CheckBlockHeader(block, state, params, validationOptions)) {
4403 return false;
4404 }
4405
4406 // Check the merkle root.
4407 if (validationOptions.shouldValidateMerkleRoot() &&
4408 !CheckMerkleRoot(block, state)) {
4409 return false;
4410 }
4411
4412 // All potential-corruption validation must be done before we do any
4413 // transaction validation, as otherwise we may mark the header as invalid
4414 // because we receive the wrong transactions for it.
4415
4416 // First transaction must be coinbase.
4417 if (block.vtx.empty()) {
4419 "bad-cb-missing", "first tx is not coinbase");
4420 }
4421
4422 // Size limits.
4423 auto nMaxBlockSize = validationOptions.getExcessiveBlockSize();
4424
4425 // Bail early if there is no way this block is of reasonable size.
4426 if ((block.vtx.size() * MIN_TRANSACTION_SIZE) > nMaxBlockSize) {
4428 "bad-blk-length", "size limits failed");
4429 }
4430
4431 auto currentBlockSize = ::GetSerializeSize(block);
4432 if (currentBlockSize > nMaxBlockSize) {
4434 "bad-blk-length", "size limits failed");
4435 }
4436
4437 // And a valid coinbase.
4438 TxValidationState tx_state;
4439 if (!CheckCoinbase(*block.vtx[0], tx_state)) {
4441 tx_state.GetRejectReason(),
4442 strprintf("Coinbase check failed (txid %s) %s",
4443 block.vtx[0]->GetId().ToString(),
4444 tx_state.GetDebugMessage()));
4445 }
4446
4447 // Check transactions for regularity, skipping the first. Note that this
4448 // is the first time we check that all after the first are !IsCoinBase.
4449 for (size_t i = 1; i < block.vtx.size(); i++) {
4450 auto *tx = block.vtx[i].get();
4451 if (!CheckRegularTransaction(*tx, tx_state)) {
4452 return state.Invalid(
4454 tx_state.GetRejectReason(),
4455 strprintf("Transaction check failed (txid %s) %s",
4456 tx->GetId().ToString(), tx_state.GetDebugMessage()));
4457 }
4458 }
4459
4460 if (validationOptions.shouldValidatePoW() &&
4461 validationOptions.shouldValidateMerkleRoot()) {
4462 block.fChecked = true;
4463 }
4464
4465 return true;
4466}
4467
4468bool HasValidProofOfWork(const std::vector<CBlockHeader> &headers,
4469 const Consensus::Params &consensusParams) {
4470 return std::all_of(headers.cbegin(), headers.cend(),
4471 [&](const auto &header) {
4472 return CheckProofOfWork(
4473 header.GetHash(), header.nBits, consensusParams);
4474 });
4475}
4476
4477bool IsBlockMutated(const CBlock &block) {
4479 if (!CheckMerkleRoot(block, state)) {
4481 "Block mutated: %s\n", state.ToString());
4482 return true;
4483 }
4484
4485 if (block.vtx.empty() || !block.vtx[0]->IsCoinBase()) {
4486 // Consider the block mutated if any transaction is 64 bytes in size
4487 // (see 3.1 in "Weaknesses in Bitcoin’s Merkle Root Construction":
4488 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/attachments/20190225/a27d8837/attachment-0001.pdf).
4489 //
4490 // Note: This is not a consensus change as this only applies to blocks
4491 // that don't have a coinbase transaction and would therefore already be
4492 // invalid.
4493 return std::any_of(block.vtx.begin(), block.vtx.end(),
4494 [](auto &tx) { return GetSerializeSize(tx) == 64; });
4495 } else {
4496 // Theoretically it is still possible for a block with a 64 byte
4497 // coinbase transaction to be mutated but we neglect that possibility
4498 // here as it requires at least 224 bits of work.
4499 }
4500
4501 return false;
4502}
4503
4505CalculateClaimedHeadersWork(const std::vector<CBlockHeader> &headers) {
4506 arith_uint256 total_work{0};
4507 for (const CBlockHeader &header : headers) {
4508 CBlockIndex dummy(header);
4509 total_work += GetBlockProof(dummy);
4510 }
4511 return total_work;
4512}
4513
4525 const CBlockHeader &block, BlockValidationState &state,
4526 BlockManager &blockman, ChainstateManager &chainman,
4527 const CBlockIndex *pindexPrev, NodeClock::time_point now,
4528 const std::optional<CCheckpointData> &test_checkpoints = std::nullopt)
4531 assert(pindexPrev != nullptr);
4532 const int nHeight = pindexPrev->nHeight + 1;
4533
4534 const CChainParams &params = chainman.GetParams();
4535
4536 // Check proof of work
4537 if (block.nBits != GetNextWorkRequired(pindexPrev, &block, params)) {
4538 LogPrintf("bad bits after height: %d\n", pindexPrev->nHeight);
4540 "bad-diffbits", "incorrect proof of work");
4541 }
4542
4543 // Check against checkpoints
4544 if (chainman.m_options.checkpoints_enabled) {
4545 const CCheckpointData &checkpoints =
4546 test_checkpoints ? test_checkpoints.value() : params.Checkpoints();
4547
4548 // Check that the block chain matches the known block chain up to a
4549 // checkpoint.
4550 if (!Checkpoints::CheckBlock(checkpoints, nHeight, block.GetHash())) {
4552 "ERROR: %s: rejected by checkpoint lock-in at %d\n",
4553 __func__, nHeight);
4555 "checkpoint mismatch");
4556 }
4557
4558 // Don't accept any forks from the main chain prior to last checkpoint.
4559 // GetLastCheckpoint finds the last checkpoint in MapCheckpoints that's
4560 // in our BlockIndex().
4561
4562 const CBlockIndex *pcheckpoint =
4563 blockman.GetLastCheckpoint(checkpoints);
4564 if (pcheckpoint && nHeight < pcheckpoint->nHeight) {
4566 "ERROR: %s: forked chain older than last checkpoint "
4567 "(height %d)\n",
4568 __func__, nHeight);
4570 "bad-fork-prior-to-checkpoint");
4571 }
4572 }
4573
4574 // Check timestamp against prev
4575 if (block.GetBlockTime() <= pindexPrev->GetMedianTimePast()) {
4577 "time-too-old", "block's timestamp is too early");
4578 }
4579
4580 // Check timestamp
4581 if (block.Time() > now + std::chrono::seconds{MAX_FUTURE_BLOCK_TIME}) {
4583 "time-too-new",
4584 "block timestamp too far in the future");
4585 }
4586
4587 // Reject blocks with outdated version
4588 if ((block.nVersion < 2 &&
4589 DeploymentActiveAfter(pindexPrev, chainman,
4591 (block.nVersion < 3 &&
4592 DeploymentActiveAfter(pindexPrev, chainman,
4594 (block.nVersion < 4 &&
4595 DeploymentActiveAfter(pindexPrev, chainman,
4597 return state.Invalid(
4599 strprintf("bad-version(0x%08x)", block.nVersion),
4600 strprintf("rejected nVersion=0x%08x block", block.nVersion));
4601 }
4602
4603 return true;
4604}
4605
4613static bool ContextualCheckBlock(const CBlock &block,
4614 BlockValidationState &state,
4615 const ChainstateManager &chainman,
4616 const CBlockIndex *pindexPrev) {
4617 const int nHeight = pindexPrev == nullptr ? 0 : pindexPrev->nHeight + 1;
4618
4619 // Enforce BIP113 (Median Time Past).
4620 bool enforce_locktime_median_time_past{false};
4621 if (DeploymentActiveAfter(pindexPrev, chainman,
4623 assert(pindexPrev != nullptr);
4624 enforce_locktime_median_time_past = true;
4625 }
4626
4627 const int64_t nMedianTimePast =
4628 pindexPrev == nullptr ? 0 : pindexPrev->GetMedianTimePast();
4629
4630 const int64_t nLockTimeCutoff{enforce_locktime_median_time_past
4631 ? nMedianTimePast
4632 : block.GetBlockTime()};
4633
4634 const Consensus::Params params = chainman.GetConsensus();
4635 const bool fIsMagneticAnomalyEnabled =
4636 IsMagneticAnomalyEnabled(params, pindexPrev);
4637
4638 // Check transactions:
4639 // - canonical ordering
4640 // - ensure they are finalized
4641 // - check they have the minimum size
4642 const CTransaction *prevTx = nullptr;
4643 for (const auto &ptx : block.vtx) {
4644 const CTransaction &tx = *ptx;
4645 if (fIsMagneticAnomalyEnabled) {
4646 if (prevTx && (tx.GetId() <= prevTx->GetId())) {
4647 if (tx.GetId() == prevTx->GetId()) {
4649 "tx-duplicate",
4650 strprintf("Duplicated transaction %s",
4651 tx.GetId().ToString()));
4652 }
4653
4654 return state.Invalid(
4656 strprintf("Transaction order is invalid (%s < %s)",
4657 tx.GetId().ToString(),
4658 prevTx->GetId().ToString()));
4659 }
4660
4661 if (prevTx || !tx.IsCoinBase()) {
4662 prevTx = &tx;
4663 }
4664 }
4665
4666 TxValidationState tx_state;
4667 if (!ContextualCheckTransaction(params, tx, tx_state, nHeight,
4668 nLockTimeCutoff)) {
4670 tx_state.GetRejectReason(),
4671 tx_state.GetDebugMessage());
4672 }
4673 }
4674
4675 // Enforce rule that the coinbase starts with serialized block height
4676 if (DeploymentActiveAfter(pindexPrev, chainman,
4678 CScript expect = CScript() << nHeight;
4679 if (block.vtx[0]->vin[0].scriptSig.size() < expect.size() ||
4680 !std::equal(expect.begin(), expect.end(),
4681 block.vtx[0]->vin[0].scriptSig.begin())) {
4683 "bad-cb-height",
4684 "block height mismatch in coinbase");
4685 }
4686 }
4687
4688 return true;
4689}
4690
4697 const CBlockHeader &block, BlockValidationState &state,
4698 CBlockIndex **ppindex, bool min_pow_checked,
4699 const std::optional<CCheckpointData> &test_checkpoints) {
4701 const Config &config = this->GetConfig();
4702 const CChainParams &chainparams = config.GetChainParams();
4703
4704 // Check for duplicate
4705 BlockHash hash = block.GetHash();
4706 BlockMap::iterator miSelf{m_blockman.m_block_index.find(hash)};
4707 if (hash != chainparams.GetConsensus().hashGenesisBlock) {
4708 if (miSelf != m_blockman.m_block_index.end()) {
4709 // Block header is already known.
4710 CBlockIndex *pindex = &(miSelf->second);
4711 if (ppindex) {
4712 *ppindex = pindex;
4713 }
4714
4715 if (pindex->nStatus.isInvalid()) {
4716 LogPrint(BCLog::VALIDATION, "%s: block %s is marked invalid\n",
4717 __func__, hash.ToString());
4718 return state.Invalid(
4720 }
4721
4722 return true;
4723 }
4724
4725 if (!CheckBlockHeader(block, state, chainparams.GetConsensus(),
4726 BlockValidationOptions(config))) {
4728 "%s: Consensus::CheckBlockHeader: %s, %s\n", __func__,
4729 hash.ToString(), state.ToString());
4730 return false;
4731 }
4732
4733 // Get prev block index
4734 BlockMap::iterator mi{
4735 m_blockman.m_block_index.find(block.hashPrevBlock)};
4736 if (mi == m_blockman.m_block_index.end()) {
4738 "header %s has prev block not found: %s\n",
4739 hash.ToString(), block.hashPrevBlock.ToString());
4741 "prev-blk-not-found");
4742 }
4743
4744 CBlockIndex *pindexPrev = &((*mi).second);
4745 assert(pindexPrev);
4746 if (pindexPrev->nStatus.isInvalid()) {
4748 "header %s has prev block invalid: %s\n", hash.ToString(),
4749 block.hashPrevBlock.ToString());
4751 "bad-prevblk");
4752 }
4753
4755 block, state, m_blockman, *this, pindexPrev,
4756 m_options.adjusted_time_callback(), test_checkpoints)) {
4758 "%s: Consensus::ContextualCheckBlockHeader: %s, %s\n",
4759 __func__, hash.ToString(), state.ToString());
4760 return false;
4761 }
4762
4763 /* Determine if this block descends from any block which has been found
4764 * invalid (m_failed_blocks), then mark pindexPrev and any blocks
4765 * between them as failed. For example:
4766 *
4767 * D3
4768 * /
4769 * B2 - C2
4770 * / \
4771 * A D2 - E2 - F2
4772 * \
4773 * B1 - C1 - D1 - E1
4774 *
4775 * In the case that we attempted to reorg from E1 to F2, only to find
4776 * C2 to be invalid, we would mark D2, E2, and F2 as BLOCK_FAILED_CHILD
4777 * but NOT D3 (it was not in any of our candidate sets at the time).
4778 *
4779 * In any case D3 will also be marked as BLOCK_FAILED_CHILD at restart
4780 * in LoadBlockIndex.
4781 */
4782 if (!pindexPrev->IsValid(BlockValidity::SCRIPTS)) {
4783 // The above does not mean "invalid": it checks if the previous
4784 // block hasn't been validated up to BlockValidity::SCRIPTS. This is
4785 // a performance optimization, in the common case of adding a new
4786 // block to the tip, we don't need to iterate over the failed blocks
4787 // list.
4788 for (const CBlockIndex *failedit : m_failed_blocks) {
4789 if (pindexPrev->GetAncestor(failedit->nHeight) == failedit) {
4790 assert(failedit->nStatus.hasFailed());
4791 CBlockIndex *invalid_walk = pindexPrev;
4792 while (invalid_walk != failedit) {
4793 invalid_walk->nStatus =
4794 invalid_walk->nStatus.withFailedParent();
4795 m_blockman.m_dirty_blockindex.insert(invalid_walk);
4796 invalid_walk = invalid_walk->pprev;
4797 }
4799 "header %s has prev block invalid: %s\n",
4800 hash.ToString(), block.hashPrevBlock.ToString());
4801 return state.Invalid(
4803 "bad-prevblk");
4804 }
4805 }
4806 }
4807 }
4808 if (!min_pow_checked) {
4810 "%s: not adding new block header %s, missing anti-dos "
4811 "proof-of-work validation\n",
4812 __func__, hash.ToString());
4814 "too-little-chainwork");
4815 }
4816 CBlockIndex *pindex{m_blockman.AddToBlockIndex(block, m_best_header)};
4817
4818 if (ppindex) {
4819 *ppindex = pindex;
4820 }
4821
4822 // Since this is the earliest point at which we have determined that a
4823 // header is both new and valid, log here.
4824 //
4825 // These messages are valuable for detecting potential selfish mining
4826 // behavior; if multiple displacing headers are seen near simultaneously
4827 // across many nodes in the network, this might be an indication of selfish
4828 // mining. Having this log by default when not in IBD ensures broad
4829 // availability of this data in case investigation is merited.
4830 const auto msg = strprintf("Saw new header hash=%s height=%d",
4831 hash.ToString(), pindex->nHeight);
4832
4833 if (IsInitialBlockDownload()) {
4835 } else {
4836 LogPrintf("%s\n", msg);
4837 }
4838
4839 return true;
4840}
4841
4842// Exposed wrapper for AcceptBlockHeader
4844 const std::vector<CBlockHeader> &headers, bool min_pow_checked,
4845 BlockValidationState &state, const CBlockIndex **ppindex,
4846 const std::optional<CCheckpointData> &test_checkpoints) {
4848 {
4849 LOCK(cs_main);
4850 for (const CBlockHeader &header : headers) {
4851 // Use a temp pindex instead of ppindex to avoid a const_cast
4852 CBlockIndex *pindex = nullptr;
4853 bool accepted = AcceptBlockHeader(
4854 header, state, &pindex, min_pow_checked, test_checkpoints);
4856
4857 if (!accepted) {
4858 return false;
4859 }
4860
4861 if (ppindex) {
4862 *ppindex = pindex;
4863 }
4864 }
4865 }
4866
4867 if (NotifyHeaderTip()) {
4868 if (IsInitialBlockDownload() && ppindex && *ppindex) {
4869 const CBlockIndex &last_accepted{**ppindex};
4870 int64_t blocks_left{(NodeClock::now() - last_accepted.Time()) /
4872 blocks_left = std::max<int64_t>(0, blocks_left);
4873 const double progress{100.0 * last_accepted.nHeight /
4874 (last_accepted.nHeight + blocks_left)};
4875 LogInfo("Synchronizing blockheaders, height: %d (~%.2f%%)\n",
4876 last_accepted.nHeight, progress);
4877 }
4878 }
4879 return true;
4880}
4881
4883 int64_t height,
4884 int64_t timestamp) {
4886 {
4887 LOCK(cs_main);
4888 // Don't report headers presync progress if we already have a
4889 // post-minchainwork header chain.
4890 // This means we lose reporting for potentially legimate, but unlikely,
4891 // deep reorgs, but prevent attackers that spam low-work headers from
4892 // filling our logs.
4893 if (m_best_header->nChainWork >=
4894 UintToArith256(GetConsensus().nMinimumChainWork)) {
4895 return;
4896 }
4897 // Rate limit headers presync updates to 4 per second, as these are not
4898 // subject to DoS protection.
4899 auto now = Now<SteadyMilliseconds>();
4900 if (now < m_last_presync_update + 250ms) {
4901 return;
4902 }
4903 m_last_presync_update = now;
4904 }
4905 bool initial_download = IsInitialBlockDownload();
4907 GetSynchronizationState(initial_download,
4909 height, timestamp, /*presync=*/true);
4910 if (initial_download) {
4911 int64_t blocks_left{
4912 (NodeClock::now() - NodeSeconds{std::chrono::seconds{timestamp}}) /
4914 blocks_left = std::max<int64_t>(0, blocks_left);
4915 const double progress{100.0 * height / (height + blocks_left)};
4916 LogInfo("Pre-synchronizing blockheaders, height: %d (~%.2f%%)\n",
4917 height, progress);
4918 }
4919}
4920
4921bool ChainstateManager::AcceptBlock(const std::shared_ptr<const CBlock> &pblock,
4922 BlockValidationState &state,
4923 bool fRequested, const FlatFilePos *dbp,
4924 bool *fNewBlock, bool min_pow_checked) {
4926
4927 const CBlock &block = *pblock;
4928 if (fNewBlock) {
4929 *fNewBlock = false;
4930 }
4931
4932 CBlockIndex *pindex = nullptr;
4933
4934 bool accepted_header{
4935 AcceptBlockHeader(block, state, &pindex, min_pow_checked)};
4937
4938 if (!accepted_header) {
4939 return false;
4940 }
4941
4942 // Check all requested blocks that we do not already have for validity and
4943 // save them to disk. Skip processing of unrequested blocks as an anti-DoS
4944 // measure, unless the blocks have more work than the active chain tip, and
4945 // aren't too far ahead of it, so are likely to be attached soon.
4946 bool fAlreadyHave = pindex->nStatus.hasData();
4947
4948 // TODO: deal better with return value and error conditions for duplicate
4949 // and unrequested blocks.
4950 if (fAlreadyHave) {
4951 return true;
4952 }
4953
4954 // Compare block header timestamps and received times of the block and the
4955 // chaintip. If they have the same chain height, use these diffs as a
4956 // tie-breaker, attempting to pick the more honestly-mined block.
4957 int64_t newBlockTimeDiff = std::llabs(pindex->GetReceivedTimeDiff());
4958 int64_t chainTipTimeDiff =
4959 ActiveTip() ? std::llabs(ActiveTip()->GetReceivedTimeDiff()) : 0;
4960
4961 bool isSameHeight =
4962 ActiveTip() && (pindex->nChainWork == ActiveTip()->nChainWork);
4963 if (isSameHeight) {
4964 LogPrintf("Chain tip timestamp-to-received-time difference: hash=%s, "
4965 "diff=%d\n",
4966 ActiveTip()->GetBlockHash().ToString(), chainTipTimeDiff);
4967 LogPrintf("New block timestamp-to-received-time difference: hash=%s, "
4968 "diff=%d\n",
4969 pindex->GetBlockHash().ToString(), newBlockTimeDiff);
4970 }
4971
4972 bool fHasMoreOrSameWork =
4973 (ActiveTip() ? pindex->nChainWork >= ActiveTip()->nChainWork : true);
4974
4975 // Blocks that are too out-of-order needlessly limit the effectiveness of
4976 // pruning, because pruning will not delete block files that contain any
4977 // blocks which are too close in height to the tip. Apply this test
4978 // regardless of whether pruning is enabled; it should generally be safe to
4979 // not process unrequested blocks.
4980 bool fTooFarAhead{pindex->nHeight >
4982
4983 // TODO: Decouple this function from the block download logic by removing
4984 // fRequested
4985 // This requires some new chain data structure to efficiently look up if a
4986 // block is in a chain leading to a candidate for best tip, despite not
4987 // being such a candidate itself.
4988 // Note that this would break the getblockfrompeer RPC
4989
4990 // If we didn't ask for it:
4991 if (!fRequested) {
4992 // This is a previously-processed block that was pruned.
4993 if (pindex->nTx != 0) {
4994 return true;
4995 }
4996
4997 // Don't process less-work chains.
4998 if (!fHasMoreOrSameWork) {
4999 return true;
5000 }
5001
5002 // Block height is too high.
5003 if (fTooFarAhead) {
5004 return true;
5005 }
5006
5007 // Protect against DoS attacks from low-work chains.
5008 // If our tip is behind, a peer could try to send us
5009 // low-work blocks on a fake chain that we would never
5010 // request; don't process these.
5011 if (pindex->nChainWork < MinimumChainWork()) {
5012 return true;
5013 }
5014 }
5015
5016 if (!CheckBlock(block, state,
5019 !ContextualCheckBlock(block, state, *this, pindex->pprev)) {
5020 if (state.IsInvalid() &&
5022 pindex->nStatus = pindex->nStatus.withFailed();
5023 m_blockman.m_dirty_blockindex.insert(pindex);
5024 }
5025
5026 LogError("%s: %s (block %s)\n", __func__, state.ToString(),
5027 block.GetHash().ToString());
5028 return false;
5029 }
5030
5031 // If connecting the new block would require rewinding more than one block
5032 // from the active chain (i.e., a "deep reorg"), then mark the new block as
5033 // parked. If it has enough work then it will be automatically unparked
5034 // later, during FindMostWorkChain. We mark the block as parked at the very
5035 // last minute so we can make sure everything is ready to be reorged if
5036 // needed.
5038 // Blocks that are below the snapshot height can't cause reorgs, as the
5039 // active tip is at least thousands of blocks higher. Don't park them,
5040 // they will most likely connect on the tip of the background chain.
5041 std::optional<int> snapshot_base_height = GetSnapshotBaseHeight();
5042 const bool is_background_block =
5043 snapshot_base_height && BackgroundSyncInProgress() &&
5044 pindex->nHeight <= snapshot_base_height;
5045 const CBlockIndex *pindexFork = ActiveChain().FindFork(pindex);
5046 if (!is_background_block && pindexFork &&
5047 pindexFork->nHeight + 1 < ActiveHeight()) {
5048 LogPrintf("Park block %s as it would cause a deep reorg.\n",
5049 pindex->GetBlockHash().ToString());
5050 pindex->nStatus = pindex->nStatus.withParked();
5051 m_blockman.m_dirty_blockindex.insert(pindex);
5052 }
5053 }
5054
5055 // Header is valid/has work and the merkle tree is good.
5056 // Relay now, but if it does not build on our best tip, let the
5057 // SendMessages loop relay it.
5058 if (!IsInitialBlockDownload() && ActiveTip() == pindex->pprev &&
5060 m_options.signals->NewPoWValidBlock(pindex, pblock);
5061 }
5062
5063 // Write block to history file
5064 if (fNewBlock) {
5065 *fNewBlock = true;
5066 }
5067 try {
5068 FlatFilePos blockPos{};
5069 if (dbp) {
5070 blockPos = *dbp;
5071 m_blockman.UpdateBlockInfo(block, pindex->nHeight, blockPos);
5072 } else {
5073 blockPos = m_blockman.WriteBlock(block, pindex->nHeight);
5074 if (blockPos.IsNull()) {
5075 state.Error(strprintf(
5076 "%s: Failed to find position to write new block to disk",
5077 __func__));
5078 return false;
5079 }
5080 }
5081 ReceivedBlockTransactions(block, pindex, blockPos);
5082 } catch (const std::runtime_error &e) {
5083 return FatalError(GetNotifications(), state,
5084 std::string("System error: ") + e.what());
5085 }
5086
5087 // TODO: FlushStateToDisk() handles flushing of both block and chainstate
5088 // data, so we should move this to ChainstateManager so that we can be more
5089 // intelligent about how we flush.
5090 // For now, since FlushStateMode::NONE is used, all that can happen is that
5091 // the block files may be pruned, so we can just call this on one
5092 // chainstate (particularly if we haven't implemented pruning with
5093 // background validation yet).
5094 ActiveChainstate().FlushStateToDisk(state, FlushStateMode::NONE);
5095
5097
5098 return true;
5099}
5100
5102 const std::shared_ptr<const CBlock> &block, bool force_processing,
5103 bool min_pow_checked, bool *new_block,
5106
5107 {
5108 if (new_block) {
5109 *new_block = false;
5110 }
5111
5113
5114 // CheckBlock() does not support multi-threaded block validation
5115 // because CBlock::fChecked can cause data race.
5116 // Therefore, the following critical section must include the
5117 // CheckBlock() call as well.
5118 LOCK(cs_main);
5119
5120 // Skipping AcceptBlock() for CheckBlock() failures means that we will
5121 // never mark a block as invalid if CheckBlock() fails. This is
5122 // protective against consensus failure if there are any unknown form
5123 // s of block malleability that cause CheckBlock() to fail; see e.g.
5124 // CVE-2012-2459 and
5125 // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2019-February/016697.html.
5126 // Because CheckBlock() is not very expensive, the anti-DoS benefits of
5127 // caching failure (of a definitely-invalid block) are not substantial.
5128 bool ret = CheckBlock(*block, state, this->GetConsensus(),
5130 if (ret) {
5131 // Store to disk
5132 ret = AcceptBlock(block, state, force_processing, nullptr,
5133 new_block, min_pow_checked);
5134 }
5135
5136 if (!ret) {
5137 if (m_options.signals) {
5138 m_options.signals->BlockChecked(*block, state);
5139 }
5140 LogError("%s: AcceptBlock FAILED (%s)\n", __func__,
5141 state.ToString());
5142 return false;
5143 }
5144 }
5145
5147
5148 // Only used to report errors, not invalidity - ignore it
5150 if (!ActiveChainstate().ActivateBestChain(state, block, avalanche)) {
5151 LogError("%s: ActivateBestChain failed (%s)\n", __func__,
5152 state.ToString());
5153 return false;
5154 }
5155
5157 ? m_ibd_chainstate.get()
5158 : nullptr)};
5159 BlockValidationState bg_state;
5160 if (bg_chain && !bg_chain->ActivateBestChain(bg_state, block)) {
5161 LogError("%s: [background] ActivateBestChain failed (%s)\n", __func__,
5162 bg_state.ToString());
5163 return false;
5164 }
5165
5166 return true;
5167}
5168
5171 bool test_accept) {
5173 Chainstate &active_chainstate = ActiveChainstate();
5174 if (!active_chainstate.GetMempool()) {
5175 TxValidationState state;
5176 state.Invalid(TxValidationResult::TX_NO_MEMPOOL, "no-mempool");
5177 return MempoolAcceptResult::Failure(state);
5178 }
5179 auto result = AcceptToMemoryPool(active_chainstate, tx, GetTime(),
5180 /*bypass_limits=*/false, test_accept);
5181 active_chainstate.GetMempool()->check(
5182 active_chainstate.CoinsTip(), active_chainstate.m_chain.Height() + 1);
5183 return result;
5184}
5185
5187 BlockValidationState &state, const CChainParams &params,
5188 Chainstate &chainstate, const CBlock &block, CBlockIndex *pindexPrev,
5189 const std::function<NodeClock::time_point()> &adjusted_time_callback,
5190 BlockValidationOptions validationOptions) {
5192 assert(pindexPrev && pindexPrev == chainstate.m_chain.Tip());
5193 CCoinsViewCache viewNew(&chainstate.CoinsTip());
5194 BlockHash block_hash(block.GetHash());
5195 CBlockIndex indexDummy(block);
5196 indexDummy.pprev = pindexPrev;
5197 indexDummy.nHeight = pindexPrev->nHeight + 1;
5198 indexDummy.phashBlock = &block_hash;
5199
5200 // NOTE: CheckBlockHeader is called by CheckBlock
5201 if (!ContextualCheckBlockHeader(block, state, chainstate.m_blockman,
5202 chainstate.m_chainman, pindexPrev,
5203 adjusted_time_callback())) {
5204 LogError("%s: Consensus::ContextualCheckBlockHeader: %s\n", __func__,
5205 state.ToString());
5206 return false;
5207 }
5208
5209 if (!CheckBlock(block, state, params.GetConsensus(), validationOptions)) {
5210 LogError("%s: Consensus::CheckBlock: %s\n", __func__, state.ToString());
5211 return false;
5212 }
5213
5214 if (!ContextualCheckBlock(block, state, chainstate.m_chainman,
5215 pindexPrev)) {
5216 LogError("%s: Consensus::ContextualCheckBlock: %s\n", __func__,
5217 state.ToString());
5218 return false;
5219 }
5220
5221 if (!chainstate.ConnectBlock(block, state, &indexDummy, viewNew,
5222 validationOptions, nullptr, true)) {
5223 return false;
5224 }
5225
5226 assert(state.IsValid());
5227 return true;
5228}
5229
5230/* This function is called from the RPC code for pruneblockchain */
5231void PruneBlockFilesManual(Chainstate &active_chainstate,
5232 int nManualPruneHeight) {
5234 if (active_chainstate.FlushStateToDisk(state, FlushStateMode::NONE,
5235 nManualPruneHeight)) {
5236 LogPrintf("%s: failed to flush state (%s)\n", __func__,
5237 state.ToString());
5238 }
5239}
5240
5243 const CCoinsViewCache &coins_cache = CoinsTip();
5244 // Never called when the coins view is empty
5245 assert(!coins_cache.GetBestBlock().IsNull());
5246 const CBlockIndex *tip = m_chain.Tip();
5247
5248 if (tip && tip->GetBlockHash() == coins_cache.GetBestBlock()) {
5249 return true;
5250 }
5251
5252 // Load pointer to end of best chain
5253 CBlockIndex *pindex =
5255 if (!pindex) {
5256 return false;
5257 }
5258 m_chain.SetTip(*pindex);
5260
5261 tip = m_chain.Tip();
5262 LogPrintf(
5263 "Loaded best chain: hashBestChain=%s height=%d date=%s progress=%f\n",
5264 tip->GetBlockHash().ToString(), m_chain.Height(),
5267 return true;
5268}
5269
5271 : m_notifications{notifications} {
5272 m_notifications.progress(_("Verifying blocks…"), 0, false);
5273}
5274
5276 m_notifications.progress(bilingual_str{}, 100, false);
5277}
5278
5280 CCoinsView &coinsview, int nCheckLevel,
5281 int nCheckDepth) {
5283
5284 const Config &config = chainstate.m_chainman.GetConfig();
5285 const CChainParams &params = config.GetChainParams();
5286 const Consensus::Params &consensusParams = params.GetConsensus();
5287
5288 if (chainstate.m_chain.Tip() == nullptr ||
5289 chainstate.m_chain.Tip()->pprev == nullptr) {
5291 }
5292
5293 // Verify blocks in the best chain
5294 if (nCheckDepth <= 0 || nCheckDepth > chainstate.m_chain.Height()) {
5295 nCheckDepth = chainstate.m_chain.Height();
5296 }
5297
5298 nCheckLevel = std::max(0, std::min(4, nCheckLevel));
5299 LogPrintf("Verifying last %i blocks at level %i\n", nCheckDepth,
5300 nCheckLevel);
5301
5302 CCoinsViewCache coins(&coinsview);
5303 CBlockIndex *pindex;
5304 CBlockIndex *pindexFailure = nullptr;
5305 int nGoodTransactions = 0;
5307 int reportDone = 0;
5308 bool skipped_no_block_data{false};
5309 bool skipped_l3_checks{false};
5310 LogPrintf("Verification progress: 0%%\n");
5311
5312 const bool is_snapshot_cs{chainstate.m_from_snapshot_blockhash};
5313
5314 for (pindex = chainstate.m_chain.Tip(); pindex && pindex->pprev;
5315 pindex = pindex->pprev) {
5316 const int percentageDone = std::max(
5317 1, std::min(99, (int)(((double)(chainstate.m_chain.Height() -
5318 pindex->nHeight)) /
5319 (double)nCheckDepth *
5320 (nCheckLevel >= 4 ? 50 : 100))));
5321 if (reportDone < percentageDone / 10) {
5322 // report every 10% step
5323 LogPrintf("Verification progress: %d%%\n", percentageDone);
5324 reportDone = percentageDone / 10;
5325 }
5326
5327 m_notifications.progress(_("Verifying blocks…"), percentageDone, false);
5328 if (pindex->nHeight <= chainstate.m_chain.Height() - nCheckDepth) {
5329 break;
5330 }
5331
5332 if ((chainstate.m_blockman.IsPruneMode() || is_snapshot_cs) &&
5333 !pindex->nStatus.hasData()) {
5334 // If pruning or running under an assumeutxo snapshot, only go
5335 // back as far as we have data.
5336 LogPrintf("VerifyDB(): block verification stopping at height %d "
5337 "(no data). This could be due to pruning or use of an "
5338 "assumeutxo snapshot.\n",
5339 pindex->nHeight);
5340 skipped_no_block_data = true;
5341 break;
5342 }
5343
5344 CBlock block;
5345
5346 // check level 0: read from disk
5347 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
5348 LogPrintf("Verification error: ReadBlock failed at %d, hash=%s\n",
5349 pindex->nHeight, pindex->GetBlockHash().ToString());
5351 }
5352
5353 // check level 1: verify block validity
5354 if (nCheckLevel >= 1 && !CheckBlock(block, state, consensusParams,
5355 BlockValidationOptions(config))) {
5356 LogPrintf(
5357 "Verification error: found bad block at %d, hash=%s (%s)\n",
5358 pindex->nHeight, pindex->GetBlockHash().ToString(),
5359 state.ToString());
5361 }
5362
5363 // check level 2: verify undo validity
5364 if (nCheckLevel >= 2 && pindex) {
5365 CBlockUndo undo;
5366 if (!pindex->GetUndoPos().IsNull()) {
5367 if (!chainstate.m_blockman.ReadBlockUndo(undo, *pindex)) {
5368 LogPrintf("Verification error: found bad undo data at %d, "
5369 "hash=%s\n",
5370 pindex->nHeight,
5371 pindex->GetBlockHash().ToString());
5373 }
5374 }
5375 }
5376 // check level 3: check for inconsistencies during memory-only
5377 // disconnect of tip blocks
5378 size_t curr_coins_usage = coins.DynamicMemoryUsage() +
5379 chainstate.CoinsTip().DynamicMemoryUsage();
5380
5381 if (nCheckLevel >= 3) {
5382 if (curr_coins_usage <= chainstate.m_coinstip_cache_size_bytes) {
5383 assert(coins.GetBestBlock() == pindex->GetBlockHash());
5384 DisconnectResult res =
5385 chainstate.DisconnectBlock(block, pindex, coins);
5386 if (res == DisconnectResult::FAILED) {
5387 LogPrintf("Verification error: irrecoverable inconsistency "
5388 "in block data at %d, hash=%s\n",
5389 pindex->nHeight,
5390 pindex->GetBlockHash().ToString());
5392 }
5393 if (res == DisconnectResult::UNCLEAN) {
5394 nGoodTransactions = 0;
5395 pindexFailure = pindex;
5396 } else {
5397 nGoodTransactions += block.vtx.size();
5398 }
5399 } else {
5400 skipped_l3_checks = true;
5401 }
5402 }
5403
5404 if (chainstate.m_chainman.m_interrupt) {
5406 }
5407 }
5408
5409 if (pindexFailure) {
5410 LogPrintf("Verification error: coin database inconsistencies found "
5411 "(last %i blocks, %i good transactions before that)\n",
5412 chainstate.m_chain.Height() - pindexFailure->nHeight + 1,
5413 nGoodTransactions);
5415 }
5416 if (skipped_l3_checks) {
5417 LogPrintf("Skipped verification of level >=3 (insufficient database "
5418 "cache size). Consider increasing -dbcache.\n");
5419 }
5420
5421 // store block count as we move pindex at check level >= 4
5422 int block_count = chainstate.m_chain.Height() - pindex->nHeight;
5423
5424 // check level 4: try reconnecting blocks
5425 if (nCheckLevel >= 4 && !skipped_l3_checks) {
5426 while (pindex != chainstate.m_chain.Tip()) {
5427 const int percentageDone = std::max(
5428 1, std::min(99, 100 - int(double(chainstate.m_chain.Height() -
5429 pindex->nHeight) /
5430 double(nCheckDepth) * 50)));
5431 if (reportDone < percentageDone / 10) {
5432 // report every 10% step
5433 LogPrintf("Verification progress: %d%%\n", percentageDone);
5434 reportDone = percentageDone / 10;
5435 }
5436 m_notifications.progress(_("Verifying blocks…"), percentageDone,
5437 false);
5438 pindex = chainstate.m_chain.Next(pindex);
5439 CBlock block;
5440 if (!chainstate.m_blockman.ReadBlock(block, *pindex)) {
5441 LogPrintf("Verification error: ReadBlock failed at %d, "
5442 "hash=%s\n",
5443 pindex->nHeight, pindex->GetBlockHash().ToString());
5445 }
5446 if (!chainstate.ConnectBlock(block, state, pindex, coins,
5447 BlockValidationOptions(config))) {
5448 LogPrintf("Verification error: found unconnectable block at "
5449 "%d, hash=%s (%s)\n",
5450 pindex->nHeight, pindex->GetBlockHash().ToString(),
5451 state.ToString());
5453 }
5454 if (chainstate.m_chainman.m_interrupt) {
5456 }
5457 }
5458 }
5459
5460 LogPrintf("Verification: No coin database inconsistencies in last %i "
5461 "blocks (%i transactions)\n",
5462 block_count, nGoodTransactions);
5463
5464 if (skipped_l3_checks) {
5466 }
5467 if (skipped_no_block_data) {
5469 }
5471}
5472
5478 CCoinsViewCache &view) {
5480 // TODO: merge with ConnectBlock
5481 CBlock block;
5482 if (!m_blockman.ReadBlock(block, *pindex)) {
5483 LogError("ReplayBlock(): ReadBlock failed at %d, hash=%s\n",
5484 pindex->nHeight, pindex->GetBlockHash().ToString());
5485 return false;
5486 }
5487
5488 for (const CTransactionRef &tx : block.vtx) {
5489 // Pass check = true as every addition may be an overwrite.
5490 AddCoins(view, *tx, pindex->nHeight, true);
5491 }
5492
5493 for (const CTransactionRef &tx : block.vtx) {
5494 if (tx->IsCoinBase()) {
5495 continue;
5496 }
5497
5498 for (const CTxIn &txin : tx->vin) {
5499 view.SpendCoin(txin.prevout);
5500 }
5501 }
5502
5503 return true;
5504}
5505
5507 LOCK(cs_main);
5508
5509 CCoinsView &db = this->CoinsDB();
5510 CCoinsViewCache cache(&db);
5511
5512 std::vector<BlockHash> hashHeads = db.GetHeadBlocks();
5513 if (hashHeads.empty()) {
5514 // We're already in a consistent state.
5515 return true;
5516 }
5517 if (hashHeads.size() != 2) {
5518 LogError("ReplayBlocks(): unknown inconsistent state\n");
5519 return false;
5520 }
5521
5522 m_chainman.GetNotifications().progress(_("Replaying blocks…"), 0, false);
5523 LogPrintf("Replaying blocks\n");
5524
5525 // Old tip during the interrupted flush.
5526 const CBlockIndex *pindexOld = nullptr;
5527 // New tip during the interrupted flush.
5528 const CBlockIndex *pindexNew;
5529 // Latest block common to both the old and the new tip.
5530 const CBlockIndex *pindexFork = nullptr;
5531
5532 if (m_blockman.m_block_index.count(hashHeads[0]) == 0) {
5533 LogError("ReplayBlocks(): reorganization to unknown block requested\n");
5534 return false;
5535 }
5536
5537 pindexNew = &(m_blockman.m_block_index[hashHeads[0]]);
5538
5539 if (!hashHeads[1].IsNull()) {
5540 // The old tip is allowed to be 0, indicating it's the first flush.
5541 if (m_blockman.m_block_index.count(hashHeads[1]) == 0) {
5542 LogError("ReplayBlocks(): reorganization from unknown block "
5543 "requested\n");
5544 return false;
5545 }
5546
5547 pindexOld = &(m_blockman.m_block_index[hashHeads[1]]);
5548 pindexFork = LastCommonAncestor(pindexOld, pindexNew);
5549 assert(pindexFork != nullptr);
5550 }
5551
5552 // Rollback along the old branch.
5553 while (pindexOld != pindexFork) {
5554 if (pindexOld->nHeight > 0) {
5555 // Never disconnect the genesis block.
5556 CBlock block;
5557 if (!m_blockman.ReadBlock(block, *pindexOld)) {
5558 LogError("RollbackBlock(): ReadBlock() failed at "
5559 "%d, hash=%s\n",
5560 pindexOld->nHeight,
5561 pindexOld->GetBlockHash().ToString());
5562 return false;
5563 }
5564
5565 LogPrintf("Rolling back %s (%i)\n",
5566 pindexOld->GetBlockHash().ToString(), pindexOld->nHeight);
5567 DisconnectResult res = DisconnectBlock(block, pindexOld, cache);
5568 if (res == DisconnectResult::FAILED) {
5569 LogError(
5570 "RollbackBlock(): DisconnectBlock failed at %d, hash=%s\n",
5571 pindexOld->nHeight, pindexOld->GetBlockHash().ToString());
5572 return false;
5573 }
5574
5575 // If DisconnectResult::UNCLEAN is returned, it means a non-existing
5576 // UTXO was deleted, or an existing UTXO was overwritten. It
5577 // corresponds to cases where the block-to-be-disconnect never had
5578 // all its operations applied to the UTXO set. However, as both
5579 // writing a UTXO and deleting a UTXO are idempotent operations, the
5580 // result is still a version of the UTXO set with the effects of
5581 // that block undone.
5582 }
5583 pindexOld = pindexOld->pprev;
5584 }
5585
5586 // Roll forward from the forking point to the new tip.
5587 int nForkHeight = pindexFork ? pindexFork->nHeight : 0;
5588 for (int nHeight = nForkHeight + 1; nHeight <= pindexNew->nHeight;
5589 ++nHeight) {
5590 const CBlockIndex &pindex{*Assert(pindexNew->GetAncestor(nHeight))};
5591 LogPrintf("Rolling forward %s (%i)\n", pindex.GetBlockHash().ToString(),
5592 nHeight);
5594 _("Replaying blocks…"),
5595 (int)((nHeight - nForkHeight) * 100.0 /
5596 (pindexNew->nHeight - nForkHeight)),
5597 false);
5598 if (!RollforwardBlock(&pindex, cache)) {
5599 return false;
5600 }
5601 }
5602
5603 cache.SetBestBlock(pindexNew->GetBlockHash());
5604 // local CCoinsViewCache goes out of scope
5605 cache.Flush(/*reallocate_cache=*/false);
5607 return true;
5608}
5609
5610// May NOT be used after any connections are up as much of the peer-processing
5611// logic assumes a consistent block index state
5612void Chainstate::ClearBlockIndexCandidates() {
5614 m_best_fork_tip = nullptr;
5615 m_best_fork_base = nullptr;
5617}
5618
5621
5623 return false;
5624 }
5625
5626 // Dump enough headers for RTT computation, with a few extras in case a
5627 // reorg occurs.
5628 const uint64_t numHeaders{20};
5629
5630 try {
5631 const fs::path filePathTmp = filePath + ".new";
5632 FILE *filestr = fsbridge::fopen(filePathTmp, "wb");
5633 if (!filestr) {
5634 return false;
5635 }
5636
5637 AutoFile file{filestr};
5638 file << HEADERS_TIME_VERSION;
5639 file << numHeaders;
5640
5641 const CBlockIndex *index = ActiveTip();
5642 bool missingIndex{false};
5643 for (uint64_t i = 0; i < numHeaders; i++) {
5644 if (!index) {
5645 LogPrintf("Missing block index, stopping the headers time "
5646 "dumping after %d blocks.\n",
5647 i);
5648 missingIndex = true;
5649 break;
5650 }
5651
5652 file << index->GetBlockHash();
5653 file << index->GetHeaderReceivedTime();
5654
5655 index = index->pprev;
5656 }
5657
5658 if (!FileCommit(file.Get())) {
5659 throw std::runtime_error(strprintf("Failed to commit to file %s",
5660 PathToString(filePathTmp)));
5661 }
5662 file.fclose();
5663
5664 if (missingIndex) {
5665 fs::remove(filePathTmp);
5666 return false;
5667 }
5668
5669 if (!RenameOver(filePathTmp, filePath)) {
5670 throw std::runtime_error(strprintf("Rename failed from %s to %s",
5671 PathToString(filePathTmp),
5672 PathToString(filePath)));
5673 }
5674 } catch (const std::exception &e) {
5675 LogPrintf("Failed to dump the headers time: %s.\n", e.what());
5676 return false;
5677 }
5678
5679 LogPrintf("Successfully dumped the last %d headers time to %s.\n",
5680 numHeaders, PathToString(filePath));
5681
5682 return true;
5683}
5684
5687
5689 return false;
5690 }
5691
5692 FILE *filestr = fsbridge::fopen(filePath, "rb");
5693 AutoFile file{filestr};
5694 if (file.IsNull()) {
5695 LogPrintf("Failed to open header times from disk, skipping.\n");
5696 return false;
5697 }
5698
5699 try {
5700 uint64_t version;
5701 file >> version;
5702
5703 if (version != HEADERS_TIME_VERSION) {
5704 LogPrintf("Unsupported header times file version, skipping.\n");
5705 return false;
5706 }
5707
5708 uint64_t numBlocks;
5709 file >> numBlocks;
5710
5711 for (uint64_t i = 0; i < numBlocks; i++) {
5712 BlockHash blockHash;
5713 int64_t receiveTime;
5714
5715 file >> blockHash;
5716 file >> receiveTime;
5717
5718 CBlockIndex *index = m_blockman.LookupBlockIndex(blockHash);
5719 if (!index) {
5720 LogPrintf("Missing index for block %s, stopping the headers "
5721 "time loading after %d blocks.\n",
5722 blockHash.ToString(), i);
5723 return false;
5724 }
5725
5726 index->nTimeReceived = receiveTime;
5727 }
5728 } catch (const std::exception &e) {
5729 LogPrintf("Failed to read the headers time file data on disk: %s.\n",
5730 e.what());
5731 return false;
5732 }
5733
5734 return true;
5735}
5736
5739 // Load block index from databases
5741 bool ret{m_blockman.LoadBlockIndexDB(SnapshotBlockhash())};
5742 if (!ret) {
5743 return false;
5744 }
5745
5746 m_blockman.ScanAndUnlinkAlreadyPrunedFiles();
5747
5748 std::vector<CBlockIndex *> vSortedByHeight{
5749 m_blockman.GetAllBlockIndices()};
5750 std::sort(vSortedByHeight.begin(), vSortedByHeight.end(),
5752
5753 for (CBlockIndex *pindex : vSortedByHeight) {
5754 if (m_interrupt) {
5755 return false;
5756 }
5757 // If we have an assumeutxo-based chainstate, then the snapshot
5758 // block will be a candidate for the tip, but it may not be
5759 // VALID_TRANSACTIONS (eg if we haven't yet downloaded the block),
5760 // so we special-case the snapshot block as a potential candidate
5761 // here.
5762 if (pindex == GetSnapshotBaseBlock() ||
5764 (pindex->HaveNumChainTxs() || pindex->pprev == nullptr))) {
5765 for (Chainstate *chainstate : GetAll()) {
5766 chainstate->TryAddBlockIndexCandidate(pindex);
5767 }
5768 }
5769
5770 if (pindex->nStatus.isInvalid() &&
5771 (!m_best_invalid ||
5772 pindex->nChainWork > m_best_invalid->nChainWork)) {
5773 m_best_invalid = pindex;
5774 }
5775
5776 if (pindex->nStatus.isOnParkedChain() &&
5777 (!m_best_parked ||
5778 pindex->nChainWork > m_best_parked->nChainWork)) {
5779 m_best_parked = pindex;
5780 }
5781
5782 if (pindex->IsValid(BlockValidity::TREE) &&
5783 (m_best_header == nullptr ||
5784 CBlockIndexWorkComparator()(m_best_header, pindex))) {
5785 m_best_header = pindex;
5786 }
5787 }
5788 }
5789 return true;
5790}
5791
5793 LOCK(cs_main);
5794
5795 const CChainParams &params{m_chainman.GetParams()};
5796
5797 // Check whether we're already initialized by checking for genesis in
5798 // m_blockman.m_block_index. Note that we can't use m_chain here, since it
5799 // is set based on the coins db, not the block index db, which is the only
5800 // thing loaded at this point.
5801 if (m_blockman.m_block_index.count(params.GenesisBlock().GetHash())) {
5802 return true;
5803 }
5804
5805 try {
5806 const CBlock &block = params.GenesisBlock();
5807 FlatFilePos blockPos{m_blockman.WriteBlock(block, 0)};
5808 if (blockPos.IsNull()) {
5809 LogError("%s: writing genesis block to disk failed\n", __func__);
5810 return false;
5811 }
5812 CBlockIndex *pindex =
5813 m_blockman.AddToBlockIndex(block, m_chainman.m_best_header);
5814 m_chainman.ReceivedBlockTransactions(block, pindex, blockPos);
5815 } catch (const std::runtime_error &e) {
5816 LogError("%s: failed to write genesis block: %s\n", __func__, e.what());
5817 return false;
5818 }
5819
5820 return true;
5821}
5822
5824 AutoFile &file_in, FlatFilePos *dbp,
5825 std::multimap<BlockHash, FlatFilePos> *blocks_with_unknown_parent,
5827 // Either both should be specified (-reindex), or neither (-loadblock).
5828 assert(!dbp == !blocks_with_unknown_parent);
5829
5830 int64_t nStart = GetTimeMillis();
5831 const CChainParams &params{GetParams()};
5832
5833 int nLoaded = 0;
5834 try {
5835 // Make sure we have at least 2*MAX_TX_SIZE space in the buffer
5836 // so any transaction can fit in there.
5837 BufferedFile blkdat{file_in, 2 * MAX_TX_SIZE, MAX_TX_SIZE + 8};
5838 // nRewind indicates where to resume scanning in case something goes
5839 // wrong, such as a block fails to deserialize.
5840 uint64_t nRewind = blkdat.GetPos();
5841 while (!blkdat.eof()) {
5842 if (m_interrupt) {
5843 return;
5844 }
5845
5846 blkdat.SetPos(nRewind);
5847 // Start one byte further next time, in case of failure.
5848 nRewind++;
5849 // Remove former limit.
5850 blkdat.SetLimit();
5851 unsigned int nSize = 0;
5852 try {
5853 // Locate a header.
5855 blkdat.FindByte(std::byte(params.DiskMagic()[0]));
5856 nRewind = blkdat.GetPos() + 1;
5857 blkdat >> buf;
5858 if (memcmp(buf, params.DiskMagic().data(),
5860 continue;
5861 }
5862
5863 // Read size.
5864 blkdat >> nSize;
5865 if (nSize < 80) {
5866 continue;
5867 }
5868 } catch (const std::exception &) {
5869 // No valid block header found; don't complain.
5870 // (this happens at the end of every blk.dat file)
5871 break;
5872 }
5873
5874 try {
5875 // read block header
5876 const uint64_t nBlockPos{blkdat.GetPos()};
5877 if (dbp) {
5878 dbp->nPos = nBlockPos;
5879 }
5880 blkdat.SetLimit(nBlockPos + nSize);
5881 CBlockHeader header;
5882 blkdat >> header;
5883 const BlockHash hash{header.GetHash()};
5884 // Skip the rest of this block (this may read from disk
5885 // into memory); position to the marker before the next block,
5886 // but it's still possible to rewind to the start of the
5887 // current block (without a disk read).
5888 nRewind = nBlockPos + nSize;
5889 blkdat.SkipTo(nRewind);
5890
5891 // needs to remain available after the cs_main lock is released
5892 // to avoid duplicate reads from disk
5893 std::shared_ptr<CBlock> pblock{};
5894
5895 {
5896 LOCK(cs_main);
5897 // detect out of order blocks, and store them for later
5898 if (hash != params.GetConsensus().hashGenesisBlock &&
5900 LogPrint(
5902 "%s: Out of order block %s, parent %s not known\n",
5903 __func__, hash.ToString(),
5904 header.hashPrevBlock.ToString());
5905 if (dbp && blocks_with_unknown_parent) {
5906 blocks_with_unknown_parent->emplace(
5907 header.hashPrevBlock, *dbp);
5908 }
5909 continue;
5910 }
5911
5912 // process in case the block isn't known yet
5913 const CBlockIndex *pindex =
5915 if (!pindex || !pindex->nStatus.hasData()) {
5916 // This block can be processed immediately; rewind to
5917 // its start, read and deserialize it.
5918 blkdat.SetPos(nBlockPos);
5919 pblock = std::make_shared<CBlock>();
5920 blkdat >> *pblock;
5921 nRewind = blkdat.GetPos();
5922
5924 if (AcceptBlock(pblock, state, true, dbp, nullptr,
5925 true)) {
5926 nLoaded++;
5927 }
5928 if (state.IsError()) {
5929 break;
5930 }
5931 } else if (hash != params.GetConsensus().hashGenesisBlock &&
5932 pindex->nHeight % 1000 == 0) {
5933 LogPrint(
5935 "Block Import: already had block %s at height %d\n",
5936 hash.ToString(), pindex->nHeight);
5937 }
5938 }
5939
5940 // Activate the genesis block so normal node progress can
5941 // continue
5942 if (hash == params.GetConsensus().hashGenesisBlock) {
5943 bool genesis_activation_failure = false;
5944 for (auto c : GetAll()) {
5946 if (!c->ActivateBestChain(state, nullptr, avalanche)) {
5947 genesis_activation_failure = true;
5948 break;
5949 }
5950 }
5951 if (genesis_activation_failure) {
5952 break;
5953 }
5954 }
5955
5956 if (m_blockman.IsPruneMode() &&
5957 m_blockman.m_blockfiles_indexed && pblock) {
5958 // Must update the tip for pruning to work while importing
5959 // with -loadblock. This is a tradeoff to conserve disk
5960 // space at the expense of time spent updating the tip to be
5961 // able to prune. Otherwise, ActivateBestChain won't be
5962 // called by the import process until after all of the block
5963 // files are loaded. ActivateBestChain can be called by
5964 // concurrent network message processing, but that is not
5965 // reliable for the purpose of pruning while importing.
5966 bool activation_failure = false;
5967 for (auto c : GetAll()) {
5969 if (!c->ActivateBestChain(state, pblock, avalanche)) {
5971 "failed to activate chain (%s)\n",
5972 state.ToString());
5973 activation_failure = true;
5974 break;
5975 }
5976 }
5977 if (activation_failure) {
5978 break;
5979 }
5980 }
5981
5983
5984 if (!blocks_with_unknown_parent) {
5985 continue;
5986 }
5987
5988 // Recursively process earlier encountered successors of this
5989 // block
5990 std::deque<BlockHash> queue;
5991 queue.push_back(hash);
5992 while (!queue.empty()) {
5993 BlockHash head = queue.front();
5994 queue.pop_front();
5995 auto range = blocks_with_unknown_parent->equal_range(head);
5996 while (range.first != range.second) {
5997 std::multimap<BlockHash, FlatFilePos>::iterator it =
5998 range.first;
5999 std::shared_ptr<CBlock> pblockrecursive =
6000 std::make_shared<CBlock>();
6001 if (m_blockman.ReadBlock(*pblockrecursive,
6002 it->second)) {
6003 LogPrint(
6005 "%s: Processing out of order child %s of %s\n",
6006 __func__, pblockrecursive->GetHash().ToString(),
6007 head.ToString());
6008 LOCK(cs_main);
6010 if (AcceptBlock(pblockrecursive, dummy, true,
6011 &it->second, nullptr, true)) {
6012 nLoaded++;
6013 queue.push_back(pblockrecursive->GetHash());
6014 }
6015 }
6016 range.first++;
6017 blocks_with_unknown_parent->erase(it);
6019 }
6020 }
6021 } catch (const std::exception &e) {
6022 // Historical bugs added extra data to the block files that does
6023 // not deserialize cleanly. Commonly this data is between
6024 // readable blocks, but it does not really matter. Such data is
6025 // not fatal to the import process. The code that reads the
6026 // block files deals with invalid data by simply ignoring it. It
6027 // continues to search for the next {4 byte magic message start
6028 // bytes + 4 byte length + block} that does deserialize cleanly
6029 // and passes all of the other block validation checks dealing
6030 // with POW and the merkle root, etc... We merely note with this
6031 // informational log message when unexpected data is
6032 // encountered. We could also be experiencing a storage system
6033 // read error, or a read of a previous bad write. These are
6034 // possible, but less likely scenarios. We don't have enough
6035 // information to tell a difference here. The reindex process is
6036 // not the place to attempt to clean and/or compact the block
6037 // files. If so desired, a studious node operator may use
6038 // knowledge of the fact that the block files are not entirely
6039 // pristine in order to prepare a set of pristine, and perhaps
6040 // ordered, block files for later reindexing.
6042 "%s: unexpected data at file offset 0x%x - %s. "
6043 "continuing\n",
6044 __func__, (nRewind - 1), e.what());
6045 }
6046 }
6047 } catch (const std::runtime_error &e) {
6048 GetNotifications().fatalError(std::string("System error: ") + e.what());
6049 }
6050
6051 LogPrintf("Loaded %i blocks from external file in %dms\n", nLoaded,
6052 GetTimeMillis() - nStart);
6053}
6054
6056 // Assert to verify Flatten() has been called.
6058 return false;
6059 }
6060 if (FastRandomContext().randrange(*m_options.check_block_index) >= 1) {
6061 return false;
6062 }
6063 return true;
6064}
6065
6067 if (!ShouldCheckBlockIndex()) {
6068 return;
6069 }
6070
6071 LOCK(cs_main);
6072
6073 // During a reindex, we read the genesis block and call CheckBlockIndex
6074 // before ActivateBestChain, so we have the genesis block in
6075 // m_blockman.m_block_index but no active chain. (A few of the tests when
6076 // iterating the block tree require that m_chain has been initialized.)
6077 if (ActiveChain().Height() < 0) {
6078 assert(m_blockman.m_block_index.size() <= 1);
6079 return;
6080 }
6081
6082 // Build forward-pointing data structure for the entire block tree.
6083 // For performance reasons, indexes of the best header chain are stored in
6084 // a vector (within CChain).
6085 // All remaining blocks are stored in a multimap.
6086 // The best header chain can differ from the active chain: E.g. its entries
6087 // may belong to blocks that are not yet validated.
6088 CChain best_hdr_chain;
6089 assert(m_best_header);
6090 best_hdr_chain.SetTip(*m_best_header);
6091
6092 std::multimap<CBlockIndex *, CBlockIndex *> forward;
6093 for (auto &[_, block_index] : m_blockman.m_block_index) {
6094 // Only save indexes in forward that are not part of the best header
6095 // chain.
6096 if (!best_hdr_chain.Contains(&block_index)) {
6097 // Only genesis, which must be part of the best header chain,
6098 // can have a nullptr parent.
6099 assert(block_index.pprev);
6100 forward.emplace(block_index.pprev, &block_index);
6101 }
6102 }
6103 assert(forward.size() + best_hdr_chain.Height() + 1 ==
6104 m_blockman.m_block_index.size());
6105
6106 CBlockIndex *pindex = best_hdr_chain[0];
6107 assert(pindex);
6108 // Iterate over the entire block tree, using depth-first search.
6109 // Along the way, remember whether there are blocks on the path from genesis
6110 // block being explored which are the first to have certain properties.
6111 size_t nNodes = 0;
6112 int nHeight = 0;
6113 // Oldest ancestor of pindex which is invalid.
6114 CBlockIndex *pindexFirstInvalid = nullptr;
6115 // Oldest ancestor of pindex which is parked.
6116 CBlockIndex *pindexFirstParked = nullptr;
6117 // Oldest ancestor of pindex which does not have data available, since
6118 // assumeutxo snapshot if used.
6119 CBlockIndex *pindexFirstMissing = nullptr;
6120 // Oldest ancestor of pindex for which nTx == 0, since assumeutxo snapshot
6121 // if used..
6122 CBlockIndex *pindexFirstNeverProcessed = nullptr;
6123 // Oldest ancestor of pindex which does not have BLOCK_VALID_TREE
6124 // (regardless of being valid or not).
6125 CBlockIndex *pindexFirstNotTreeValid = nullptr;
6126 // Oldest ancestor of pindex which does not have BLOCK_VALID_TRANSACTIONS
6127 // (regardless of being valid or not), since assumeutxo snapshot if used.
6128 CBlockIndex *pindexFirstNotTransactionsValid = nullptr;
6129 // Oldest ancestor of pindex which does not have BLOCK_VALID_CHAIN
6130 // (regardless of being valid or not), since assumeutxo snapshot if used.
6131 CBlockIndex *pindexFirstNotChainValid = nullptr;
6132 // Oldest ancestor of pindex which does not have BLOCK_VALID_SCRIPTS
6133 // (regardless of being valid or not), since assumeutxo snapshot if used.
6134 CBlockIndex *pindexFirstNotScriptsValid = nullptr;
6135
6136 // After checking an assumeutxo snapshot block, reset pindexFirst pointers
6137 // to earlier blocks that have not been downloaded or validated yet, so
6138 // checks for later blocks can assume the earlier blocks were validated and
6139 // be stricter, testing for more requirements.
6140 const CBlockIndex *snap_base{GetSnapshotBaseBlock()};
6141 CBlockIndex *snap_first_missing{}, *snap_first_notx{}, *snap_first_notv{},
6142 *snap_first_nocv{}, *snap_first_nosv{};
6143 auto snap_update_firsts = [&] {
6144 if (pindex == snap_base) {
6145 std::swap(snap_first_missing, pindexFirstMissing);
6146 std::swap(snap_first_notx, pindexFirstNeverProcessed);
6147 std::swap(snap_first_notv, pindexFirstNotTransactionsValid);
6148 std::swap(snap_first_nocv, pindexFirstNotChainValid);
6149 std::swap(snap_first_nosv, pindexFirstNotScriptsValid);
6150 }
6151 };
6152
6153 while (pindex != nullptr) {
6154 nNodes++;
6155 if (pindexFirstInvalid == nullptr && pindex->nStatus.hasFailed()) {
6156 pindexFirstInvalid = pindex;
6157 }
6158 if (pindexFirstParked == nullptr && pindex->nStatus.isParked()) {
6159 pindexFirstParked = pindex;
6160 }
6161 if (pindexFirstMissing == nullptr && !pindex->nStatus.hasData()) {
6162 pindexFirstMissing = pindex;
6163 }
6164 if (pindexFirstNeverProcessed == nullptr && pindex->nTx == 0) {
6165 pindexFirstNeverProcessed = pindex;
6166 }
6167 if (pindex->pprev != nullptr && pindexFirstNotTreeValid == nullptr &&
6168 pindex->nStatus.getValidity() < BlockValidity::TREE) {
6169 pindexFirstNotTreeValid = pindex;
6170 }
6171 if (pindex->pprev != nullptr) {
6172 if (pindexFirstNotTransactionsValid == nullptr &&
6173 pindex->nStatus.getValidity() < BlockValidity::TRANSACTIONS) {
6174 pindexFirstNotTransactionsValid = pindex;
6175 }
6176 if (pindexFirstNotChainValid == nullptr &&
6177 pindex->nStatus.getValidity() < BlockValidity::CHAIN) {
6178 pindexFirstNotChainValid = pindex;
6179 }
6180 if (pindexFirstNotScriptsValid == nullptr &&
6181 pindex->nStatus.getValidity() < BlockValidity::SCRIPTS) {
6182 pindexFirstNotScriptsValid = pindex;
6183 }
6184 }
6185
6186 // Begin: actual consistency checks.
6187 if (pindex->pprev == nullptr) {
6188 // Genesis block checks.
6189 // Genesis block's hash must match.
6190 assert(pindex->GetBlockHash() == GetConsensus().hashGenesisBlock);
6191 for (auto c : GetAll()) {
6192 if (c->m_chain.Genesis() != nullptr) {
6193 // The chain's genesis block must be this block.
6194 assert(pindex == c->m_chain.Genesis());
6195 }
6196 }
6197 }
6198 if (!pindex->HaveNumChainTxs()) {
6199 // nSequenceId can't be set positive for blocks that aren't linked
6200 // (negative is used for preciousblock)
6201 assert(pindex->nSequenceId <= 0);
6202 }
6203 // VALID_TRANSACTIONS is equivalent to nTx > 0 for all nodes (whether or
6204 // not pruning has occurred). HAVE_DATA is only equivalent to nTx > 0
6205 // (or VALID_TRANSACTIONS) if no pruning has occurred.
6207 // If we've never pruned, then HAVE_DATA should be equivalent to nTx
6208 // > 0
6209 assert(pindex->nStatus.hasData() == (pindex->nTx > 0));
6210 assert(pindexFirstMissing == pindexFirstNeverProcessed);
6211 } else if (pindex->nStatus.hasData()) {
6212 // If we have pruned, then we can only say that HAVE_DATA implies
6213 // nTx > 0
6214 assert(pindex->nTx > 0);
6215 }
6216 if (pindex->nStatus.hasUndo()) {
6217 assert(pindex->nStatus.hasData());
6218 }
6219 if (snap_base && snap_base->GetAncestor(pindex->nHeight) == pindex) {
6220 // Assumed-valid blocks should connect to the main chain.
6221 assert(pindex->nStatus.getValidity() >= BlockValidity::TREE);
6222 }
6223 // There should only be an nTx value if we have
6224 // actually seen a block's transactions.
6225 // This is pruning-independent.
6226 assert((pindex->nStatus.getValidity() >= BlockValidity::TRANSACTIONS) ==
6227 (pindex->nTx > 0));
6228 // All parents having had data (at some point) is equivalent to all
6229 // parents being VALID_TRANSACTIONS, which is equivalent to
6230 // HaveNumChainTxs().
6231 assert((pindexFirstNeverProcessed == nullptr || pindex == snap_base) ==
6232 (pindex->HaveNumChainTxs()));
6233 assert((pindexFirstNotTransactionsValid == nullptr ||
6234 pindex == snap_base) == (pindex->HaveNumChainTxs()));
6235 // nHeight must be consistent.
6236 assert(pindex->nHeight == nHeight);
6237 // For every block except the genesis block, the chainwork must be
6238 // larger than the parent's.
6239 assert(pindex->pprev == nullptr ||
6240 pindex->nChainWork >= pindex->pprev->nChainWork);
6241 // The pskip pointer must point back for all but the first 2 blocks.
6242 assert(nHeight < 2 ||
6243 (pindex->pskip && (pindex->pskip->nHeight < nHeight)));
6244 // All m_blockman.m_block_index entries must at least be TREE valid
6245 assert(pindexFirstNotTreeValid == nullptr);
6246 if (pindex->nStatus.getValidity() >= BlockValidity::TREE) {
6247 // TREE valid implies all parents are TREE valid
6248 assert(pindexFirstNotTreeValid == nullptr);
6249 }
6250 if (pindex->nStatus.getValidity() >= BlockValidity::CHAIN) {
6251 // CHAIN valid implies all parents are CHAIN valid
6252 assert(pindexFirstNotChainValid == nullptr);
6253 }
6254 if (pindex->nStatus.getValidity() >= BlockValidity::SCRIPTS) {
6255 // SCRIPTS valid implies all parents are SCRIPTS valid
6256 assert(pindexFirstNotScriptsValid == nullptr);
6257 }
6258 if (pindexFirstInvalid == nullptr) {
6259 // Checks for not-invalid blocks.
6260 // The failed mask cannot be set for blocks without invalid parents.
6261 assert(!pindex->nStatus.isInvalid());
6262 }
6263 if (pindexFirstParked == nullptr) {
6264 // Checks for not-parked blocks.
6265 // The parked mask cannot be set for blocks without parked parents.
6266 // (i.e., hasParkedParent only if an ancestor is properly parked).
6267 assert(!pindex->nStatus.isOnParkedChain());
6268 }
6269 // Make sure m_chain_tx_count sum is correctly computed.
6270 if (!pindex->pprev) {
6271 // If no previous block, nTx and m_chain_tx_count must be the same.
6272 assert(pindex->m_chain_tx_count == pindex->nTx);
6273 } else if (pindex->pprev->m_chain_tx_count > 0 && pindex->nTx > 0) {
6274 // If previous m_chain_tx_count is set and number of transactions in
6275 // block is known, sum must be set.
6276 assert(pindex->m_chain_tx_count ==
6277 pindex->nTx + pindex->pprev->m_chain_tx_count);
6278 } else {
6279 // Otherwise m_chain_tx_count should only be set if this is a
6280 // snapshot block, and must be set if it is.
6281 assert((pindex->m_chain_tx_count != 0) == (pindex == snap_base));
6282 }
6283
6284 // Chainstate-specific checks on setBlockIndexCandidates
6285 for (auto c : GetAll()) {
6286 if (c->m_chain.Tip() == nullptr) {
6287 continue;
6288 }
6289 // Two main factors determine whether pindex is a candidate in
6290 // setBlockIndexCandidates:
6291 //
6292 // - If pindex has less work than the chain tip, it should not be a
6293 // candidate, and this will be asserted below. Otherwise it is a
6294 // potential candidate.
6295 //
6296 // - If pindex or one of its parent blocks back to the genesis block
6297 // or an assumeutxo snapshot never downloaded transactions
6298 // (pindexFirstNeverProcessed is non-null), it should not be a
6299 // candidate, and this will be asserted below. The only exception
6300 // is if pindex itself is an assumeutxo snapshot block. Then it is
6301 // also a potential candidate.
6302 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) &&
6303 (pindexFirstNeverProcessed == nullptr || pindex == snap_base)) {
6304 // If pindex was detected as invalid (pindexFirstInvalid is
6305 // non-null), it is not required to be in
6306 // setBlockIndexCandidates.
6307 if (pindexFirstInvalid == nullptr) {
6308 // If this chainstate is the active chainstate, pindex
6309 // must be in setBlockIndexCandidates. Otherwise, this
6310 // chainstate is a background validation chainstate, and
6311 // pindex only needs to be added if it is an ancestor of
6312 // the snapshot that is being validated.
6313 if (c == &ActiveChainstate() ||
6314 GetSnapshotBaseBlock()->GetAncestor(pindex->nHeight) ==
6315 pindex) {
6316 // If pindex and all its parents back to the genesis
6317 // block or an assumeutxo snapshot block downloaded
6318 // transactions, transactions, and the transactions were
6319 // not pruned (pindexFirstMissing is null), it is a
6320 // potential candidate or was parked. The check excludes
6321 // pruned blocks, because if any blocks were pruned
6322 // between pindex the current chain tip, pindex will
6323 // only temporarily be added to setBlockIndexCandidates,
6324 // before being moved to m_blocks_unlinked. This check
6325 // could be improved to verify that if all blocks
6326 // between the chain tip and pindex have data, pindex
6327 // must be a candidate.
6328 if (pindexFirstMissing == nullptr) {
6329 assert(pindex->nStatus.isOnParkedChain() ||
6330 c->setBlockIndexCandidates.count(pindex));
6331 }
6332 // If pindex is the chain tip, it also is a potential
6333 // candidate.
6334 //
6335 // If the chainstate was loaded from a snapshot and
6336 // pindex is the base of the snapshot, pindex is also a
6337 // potential candidate.
6338 if (pindex == c->m_chain.Tip() ||
6339 pindex == c->SnapshotBase()) {
6340 assert(c->setBlockIndexCandidates.count(pindex));
6341 }
6342 }
6343 // If some parent is missing, then it could be that this
6344 // block was in setBlockIndexCandidates but had to be
6345 // removed because of the missing data. In this case it must
6346 // be in m_blocks_unlinked -- see test below.
6347 }
6348 } else {
6349 // If this block sorts worse than the current tip or some
6350 // ancestor's block has never been seen, it cannot be in
6351 // setBlockIndexCandidates.
6352 assert(c->setBlockIndexCandidates.count(pindex) == 0);
6353 }
6354 }
6355 // Check whether this block is in m_blocks_unlinked.
6356 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6357 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6358 rangeUnlinked =
6359 m_blockman.m_blocks_unlinked.equal_range(pindex->pprev);
6360 bool foundInUnlinked = false;
6361 while (rangeUnlinked.first != rangeUnlinked.second) {
6362 assert(rangeUnlinked.first->first == pindex->pprev);
6363 if (rangeUnlinked.first->second == pindex) {
6364 foundInUnlinked = true;
6365 break;
6366 }
6367 rangeUnlinked.first++;
6368 }
6369 if (pindex->pprev && pindex->nStatus.hasData() &&
6370 pindexFirstNeverProcessed != nullptr &&
6371 pindexFirstInvalid == nullptr) {
6372 // If this block has block data available, some parent was never
6373 // received, and has no invalid parents, it must be in
6374 // m_blocks_unlinked.
6375 assert(foundInUnlinked);
6376 }
6377 if (!pindex->nStatus.hasData()) {
6378 // Can't be in m_blocks_unlinked if we don't HAVE_DATA
6379 assert(!foundInUnlinked);
6380 }
6381 if (pindexFirstMissing == nullptr) {
6382 // We aren't missing data for any parent -- cannot be in
6383 // m_blocks_unlinked.
6384 assert(!foundInUnlinked);
6385 }
6386 if (pindex->pprev && pindex->nStatus.hasData() &&
6387 pindexFirstNeverProcessed == nullptr &&
6388 pindexFirstMissing != nullptr) {
6389 // We HAVE_DATA for this block, have received data for all parents
6390 // at some point, but we're currently missing data for some parent.
6392 // This block may have entered m_blocks_unlinked if:
6393 // - it has a descendant that at some point had more work than the
6394 // tip, and
6395 // - we tried switching to that descendant but were missing
6396 // data for some intermediate block between m_chain and the
6397 // tip.
6398 // So if this block is itself better than any m_chain.Tip() and it
6399 // wasn't in setBlockIndexCandidates, then it must be in
6400 // m_blocks_unlinked.
6401 for (auto c : GetAll()) {
6402 const bool is_active = c == &ActiveChainstate();
6403 if (!CBlockIndexWorkComparator()(pindex, c->m_chain.Tip()) &&
6404 c->setBlockIndexCandidates.count(pindex) == 0) {
6405 if (pindexFirstInvalid == nullptr) {
6406 if (is_active ||
6407 snap_base->GetAncestor(pindex->nHeight) == pindex) {
6408 assert(foundInUnlinked);
6409 }
6410 }
6411 }
6412 }
6413 }
6414 // Perhaps too slow
6415 // assert(pindex->GetBlockHash() == pindex->GetBlockHeader().GetHash());
6416 // End: actual consistency checks.
6417
6418 // Try descending into the first subnode. Always process forks first and
6419 // the best header chain after.
6420 snap_update_firsts();
6421 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6422 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6423 range = forward.equal_range(pindex);
6424 if (range.first != range.second) {
6425 // A subnode not part of the best header chain was found.
6426 pindex = range.first->second;
6427 nHeight++;
6428 continue;
6429 } else if (best_hdr_chain.Contains(pindex)) {
6430 // Descend further into best header chain.
6431 nHeight++;
6432 pindex = best_hdr_chain[nHeight];
6433 if (!pindex) {
6434 // we are finished, since the best header chain is always
6435 // processed last
6436 break;
6437 }
6438 continue;
6439 }
6440 // This is a leaf node. Move upwards until we reach a node of which we
6441 // have not yet visited the last child.
6442 while (pindex) {
6443 // We are going to either move to a parent or a sibling of pindex.
6444 snap_update_firsts();
6445 // If pindex was the first with a certain property, unset the
6446 // corresponding variable.
6447 if (pindex == pindexFirstInvalid) {
6448 pindexFirstInvalid = nullptr;
6449 }
6450 if (pindex == pindexFirstParked) {
6451 pindexFirstParked = nullptr;
6452 }
6453 if (pindex == pindexFirstMissing) {
6454 pindexFirstMissing = nullptr;
6455 }
6456 if (pindex == pindexFirstNeverProcessed) {
6457 pindexFirstNeverProcessed = nullptr;
6458 }
6459 if (pindex == pindexFirstNotTreeValid) {
6460 pindexFirstNotTreeValid = nullptr;
6461 }
6462 if (pindex == pindexFirstNotTransactionsValid) {
6463 pindexFirstNotTransactionsValid = nullptr;
6464 }
6465 if (pindex == pindexFirstNotChainValid) {
6466 pindexFirstNotChainValid = nullptr;
6467 }
6468 if (pindex == pindexFirstNotScriptsValid) {
6469 pindexFirstNotScriptsValid = nullptr;
6470 }
6471 // Find our parent.
6472 CBlockIndex *pindexPar = pindex->pprev;
6473 // Find which child we just visited.
6474 std::pair<std::multimap<CBlockIndex *, CBlockIndex *>::iterator,
6475 std::multimap<CBlockIndex *, CBlockIndex *>::iterator>
6476 rangePar = forward.equal_range(pindexPar);
6477 while (rangePar.first->second != pindex) {
6478 // Our parent must have at least the node we're coming from as
6479 // child.
6480 assert(rangePar.first != rangePar.second);
6481 rangePar.first++;
6482 }
6483 // Proceed to the next one.
6484 rangePar.first++;
6485 if (rangePar.first != rangePar.second) {
6486 // Move to a sibling not part of the best header chain.
6487 pindex = rangePar.first->second;
6488 break;
6489 } else if (pindexPar == best_hdr_chain[nHeight - 1]) {
6490 // Move to pindex's sibling on the best-chain, if it has one.
6491 pindex = best_hdr_chain[nHeight];
6492 // There will not be a next block if (and only if) parent block
6493 // is the best header.
6494 assert((pindex == nullptr) ==
6495 (pindexPar == best_hdr_chain.Tip()));
6496 break;
6497 } else {
6498 // Move up further.
6499 pindex = pindexPar;
6500 nHeight--;
6501 continue;
6502 }
6503 }
6504 }
6505
6506 // Check that we actually traversed the entire block index.
6507 assert(nNodes == forward.size() + best_hdr_chain.Height() + 1);
6508}
6509
6510std::string Chainstate::ToString() {
6512 CBlockIndex *tip = m_chain.Tip();
6513 return strprintf("Chainstate [%s] @ height %d (%s)",
6514 m_from_snapshot_blockhash ? "snapshot" : "ibd",
6515 tip ? tip->nHeight : -1,
6516 tip ? tip->GetBlockHash().ToString() : "null");
6517}
6518
6519bool Chainstate::ResizeCoinsCaches(size_t coinstip_size, size_t coinsdb_size) {
6521 if (coinstip_size == m_coinstip_cache_size_bytes &&
6522 coinsdb_size == m_coinsdb_cache_size_bytes) {
6523 // Cache sizes are unchanged, no need to continue.
6524 return true;
6525 }
6526 size_t old_coinstip_size = m_coinstip_cache_size_bytes;
6527 m_coinstip_cache_size_bytes = coinstip_size;
6528 m_coinsdb_cache_size_bytes = coinsdb_size;
6529 CoinsDB().ResizeCache(coinsdb_size);
6530
6531 LogPrintf("[%s] resized coinsdb cache to %.1f MiB\n", this->ToString(),
6532 coinsdb_size * (1.0 / 1024 / 1024));
6533 LogPrintf("[%s] resized coinstip cache to %.1f MiB\n", this->ToString(),
6534 coinstip_size * (1.0 / 1024 / 1024));
6535
6537 bool ret;
6538
6539 if (coinstip_size > old_coinstip_size) {
6540 // Likely no need to flush if cache sizes have grown.
6542 } else {
6543 // Otherwise, flush state to disk and deallocate the in-memory coins
6544 // map.
6546 }
6547 return ret;
6548}
6549
6555 const CBlockIndex *pindex) {
6556 if (pindex == nullptr) {
6557 return 0.0;
6558 }
6559 if (pindex->m_chain_tx_count == 0) {
6561 "Block %d has unset m_chain_tx_count. Unable to "
6562 "estimate verification progress.\n",
6563 pindex->nHeight);
6564 return 0.0;
6565 }
6566
6567 int64_t nNow = time(nullptr);
6568
6569 double fTxTotal;
6570 if (pindex->GetChainTxCount() <= data.tx_count) {
6571 fTxTotal = data.tx_count + (nNow - data.nTime) * data.dTxRate;
6572 } else {
6573 fTxTotal = pindex->GetChainTxCount() +
6574 (nNow - pindex->GetBlockTime()) * data.dTxRate;
6575 }
6576
6577 return std::min<double>(pindex->GetChainTxCount() / fTxTotal, 1.0);
6578}
6579
6580std::optional<BlockHash> ChainstateManager::SnapshotBlockhash() const {
6581 LOCK(::cs_main);
6582 if (m_active_chainstate && m_active_chainstate->m_from_snapshot_blockhash) {
6583 // If a snapshot chainstate exists, it will always be our active.
6584 return m_active_chainstate->m_from_snapshot_blockhash;
6585 }
6586 return std::nullopt;
6587}
6588
6589std::vector<Chainstate *> ChainstateManager::GetAll() {
6590 LOCK(::cs_main);
6591 std::vector<Chainstate *> out;
6592
6593 for (Chainstate *pchainstate :
6594 {m_ibd_chainstate.get(), m_snapshot_chainstate.get()}) {
6595 if (this->IsUsable(pchainstate)) {
6596 out.push_back(pchainstate);
6597 }
6598 }
6599
6600 return out;
6601}
6602
6603Chainstate &ChainstateManager::InitializeChainstate(CTxMemPool *mempool) {
6605 assert(!m_ibd_chainstate);
6606 assert(!m_active_chainstate);
6607
6608 m_ibd_chainstate = std::make_unique<Chainstate>(mempool, m_blockman, *this);
6609 m_active_chainstate = m_ibd_chainstate.get();
6610 return *m_active_chainstate;
6611}
6612
6613[[nodiscard]] static bool DeleteCoinsDBFromDisk(const fs::path &db_path,
6614 bool is_snapshot)
6617
6618 if (is_snapshot) {
6619 fs::path base_blockhash_path =
6621
6622 try {
6623 const bool existed{fs::remove(base_blockhash_path)};
6624 if (!existed) {
6625 LogPrintf("[snapshot] snapshot chainstate dir being removed "
6626 "lacks %s file\n",
6628 }
6629 } catch (const fs::filesystem_error &e) {
6630 LogPrintf("[snapshot] failed to remove file %s: %s\n",
6631 fs::PathToString(base_blockhash_path),
6633 }
6634 }
6635
6636 std::string path_str = fs::PathToString(db_path);
6637 LogPrintf("Removing leveldb dir at %s\n", path_str);
6638
6639 // We have to destruct before this call leveldb::DB in order to release the
6640 // db lock, otherwise `DestroyDB` will fail. See `leveldb::~DBImpl()`.
6641 const bool destroyed = dbwrapper::DestroyDB(path_str, {}).ok();
6642
6643 if (!destroyed) {
6644 LogPrintf("error: leveldb DestroyDB call failed on %s\n", path_str);
6645 }
6646
6647 // Datadir should be removed from filesystem; otherwise initialization may
6648 // detect it on subsequent statups and get confused.
6649 //
6650 // If the base_blockhash_path removal above fails in the case of snapshot
6651 // chainstates, this will return false since leveldb won't remove a
6652 // non-empty directory.
6653 return destroyed && !fs::exists(db_path);
6654}
6655
6657 AutoFile &coins_file, const SnapshotMetadata &metadata, bool in_memory) {
6658 BlockHash base_blockhash = metadata.m_base_blockhash;
6659
6660 if (this->SnapshotBlockhash()) {
6662 "Can't activate a snapshot-based chainstate more than once")};
6663 }
6664
6665 CBlockIndex *snapshot_start_block{};
6666
6667 {
6668 LOCK(::cs_main);
6669
6670 if (!GetParams().AssumeutxoForBlockhash(base_blockhash).has_value()) {
6671 auto available_heights = GetParams().GetAvailableSnapshotHeights();
6672 std::string heights_formatted =
6673 util::Join(available_heights, ", ",
6674 [&](const auto &i) { return util::ToString(i); });
6675 return util::Error{strprintf(
6676 Untranslated("assumeutxo block hash in snapshot metadata not "
6677 "recognized (hash: %s). The following "
6678 "snapshot heights are available: %s."),
6679 base_blockhash.ToString(), heights_formatted)};
6680 }
6681
6682 snapshot_start_block = m_blockman.LookupBlockIndex(base_blockhash);
6683 if (!snapshot_start_block) {
6684 return util::Error{strprintf(
6685 Untranslated("The base block header (%s) must appear in the "
6686 "headers chain. Make sure all headers are "
6687 "syncing, and call loadtxoutset again."),
6688 base_blockhash.ToString())};
6689 }
6690
6691 if (snapshot_start_block->nStatus.isInvalid()) {
6692 return util::Error{strprintf(
6694 "The base block header (%s) is part of an invalid chain"),
6695 base_blockhash.ToString())};
6696 }
6697
6698 if (!m_best_header ||
6699 m_best_header->GetAncestor(snapshot_start_block->nHeight) !=
6700 snapshot_start_block) {
6702 "A forked headers-chain with more work than the chain with the "
6703 "snapshot base block header exists. Please proceed to sync "
6704 "without AssumeUtxo.")};
6705 }
6706
6707 auto mempool{m_active_chainstate->GetMempool()};
6708 if (mempool && mempool->size() > 0) {
6710 "Can't activate a snapshot when mempool not empty.")};
6711 }
6712 }
6713
6714 int64_t current_coinsdb_cache_size{0};
6715 int64_t current_coinstip_cache_size{0};
6716
6717 // Cache percentages to allocate to each chainstate.
6718 //
6719 // These particular percentages don't matter so much since they will only be
6720 // relevant during snapshot activation; caches are rebalanced at the
6721 // conclusion of this function. We want to give (essentially) all available
6722 // cache capacity to the snapshot to aid the bulk load later in this
6723 // function.
6724 static constexpr double IBD_CACHE_PERC = 0.01;
6725 static constexpr double SNAPSHOT_CACHE_PERC = 0.99;
6726
6727 {
6728 LOCK(::cs_main);
6729 // Resize the coins caches to ensure we're not exceeding memory limits.
6730 //
6731 // Allocate the majority of the cache to the incoming snapshot
6732 // chainstate, since (optimistically) getting to its tip will be the top
6733 // priority. We'll need to call `MaybeRebalanceCaches()` once we're done
6734 // with this function to ensure the right allocation (including the
6735 // possibility that no snapshot was activated and that we should restore
6736 // the active chainstate caches to their original size).
6737 //
6738 current_coinsdb_cache_size =
6739 this->ActiveChainstate().m_coinsdb_cache_size_bytes;
6740 current_coinstip_cache_size =
6741 this->ActiveChainstate().m_coinstip_cache_size_bytes;
6742
6743 // Temporarily resize the active coins cache to make room for the
6744 // newly-created snapshot chain.
6745 this->ActiveChainstate().ResizeCoinsCaches(
6746 static_cast<size_t>(current_coinstip_cache_size * IBD_CACHE_PERC),
6747 static_cast<size_t>(current_coinsdb_cache_size * IBD_CACHE_PERC));
6748 }
6749
6750 auto snapshot_chainstate =
6751 WITH_LOCK(::cs_main, return std::make_unique<Chainstate>(
6752 /* mempool */ nullptr, m_blockman, *this,
6753 base_blockhash));
6754
6755 {
6756 LOCK(::cs_main);
6757 snapshot_chainstate->InitCoinsDB(
6758 static_cast<size_t>(current_coinsdb_cache_size *
6759 SNAPSHOT_CACHE_PERC),
6760 in_memory, false, "chainstate");
6761 snapshot_chainstate->InitCoinsCache(static_cast<size_t>(
6762 current_coinstip_cache_size * SNAPSHOT_CACHE_PERC));
6763 }
6764
6765 auto cleanup_bad_snapshot =
6767 this->MaybeRebalanceCaches();
6768
6769 // PopulateAndValidateSnapshot can return (in error) before the
6770 // leveldb datadir has been created, so only attempt removal if we
6771 // got that far.
6772 if (auto snapshot_datadir =
6774 // We have to destruct leveldb::DB in order to release the db
6775 // lock, otherwise DestroyDB() (in DeleteCoinsDBFromDisk()) will
6776 // fail. See `leveldb::~DBImpl()`. Destructing the chainstate
6777 // (and so resetting the coinsviews object) does this.
6778 snapshot_chainstate.reset();
6779 bool removed = DeleteCoinsDBFromDisk(*snapshot_datadir,
6780 /*is_snapshot=*/true);
6781 if (!removed) {
6783 "Failed to remove snapshot chainstate dir (%s). "
6784 "Manually remove it before restarting.\n",
6785 fs::PathToString(*snapshot_datadir)));
6786 }
6787 }
6788 return util::Error{std::move(reason)};
6789 };
6790
6791 if (!this->PopulateAndValidateSnapshot(*snapshot_chainstate, coins_file,
6792 metadata)) {
6793 LOCK(::cs_main);
6794 return cleanup_bad_snapshot(Untranslated("population failed"));
6795 }
6796
6797 // cs_main required for rest of snapshot activation.
6798 LOCK(::cs_main);
6799
6800 // Do a final check to ensure that the snapshot chainstate is actually a
6801 // more work chain than the active chainstate; a user could have loaded a
6802 // snapshot very late in the IBD process, and we wouldn't want to load a
6803 // useless chainstate.
6805 snapshot_chainstate->m_chain.Tip())) {
6806 return cleanup_bad_snapshot(
6807 Untranslated("work does not exceed active chainstate"));
6808 }
6809 // If not in-memory, persist the base blockhash for use during subsequent
6810 // initialization.
6811 if (!in_memory) {
6812 if (!node::WriteSnapshotBaseBlockhash(*snapshot_chainstate)) {
6813 return cleanup_bad_snapshot(
6814 Untranslated("could not write base blockhash"));
6815 }
6816 }
6817
6818 assert(!m_snapshot_chainstate);
6819 m_snapshot_chainstate.swap(snapshot_chainstate);
6820 const bool chaintip_loaded = m_snapshot_chainstate->LoadChainTip();
6821 assert(chaintip_loaded);
6822
6823 // Transfer possession of the mempool to the snapshot chainstate.
6824 // Mempool is empty at this point because we're still in IBD.
6825 Assert(!m_active_chainstate->m_mempool ||
6826 m_active_chainstate->m_mempool->size() == 0);
6827 Assert(!m_snapshot_chainstate->m_mempool);
6828 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
6829 m_active_chainstate->m_mempool = nullptr;
6830 m_active_chainstate = m_snapshot_chainstate.get();
6831 m_blockman.m_snapshot_height = this->GetSnapshotBaseHeight();
6832
6833 LogPrintf("[snapshot] successfully activated snapshot %s\n",
6834 base_blockhash.ToString());
6835 LogPrintf("[snapshot] (%.2f MB)\n",
6836 m_snapshot_chainstate->CoinsTip().DynamicMemoryUsage() /
6837 (1000 * 1000));
6838
6839 this->MaybeRebalanceCaches();
6840 return snapshot_start_block;
6841}
6842
6843static void FlushSnapshotToDisk(CCoinsViewCache &coins_cache,
6844 bool snapshot_loaded) {
6846 strprintf("%s (%.2f MB)",
6847 snapshot_loaded ? "saving snapshot chainstate"
6848 : "flushing coins cache",
6849 coins_cache.DynamicMemoryUsage() / (1000 * 1000)),
6850 BCLog::LogFlags::ALL);
6851
6852 coins_cache.Flush();
6853}
6854
6855struct StopHashingException : public std::exception {
6856 const char *what() const noexcept override {
6857 return "ComputeUTXOStats interrupted by shutdown.";
6858 }
6859};
6860
6862 if (interrupt) {
6863 throw StopHashingException();
6864 }
6865}
6866
6868 Chainstate &snapshot_chainstate, AutoFile &coins_file,
6869 const SnapshotMetadata &metadata) {
6870 // It's okay to release cs_main before we're done using `coins_cache`
6871 // because we know that nothing else will be referencing the newly created
6872 // snapshot_chainstate yet.
6873 CCoinsViewCache &coins_cache =
6874 *WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsTip());
6875
6876 BlockHash base_blockhash = metadata.m_base_blockhash;
6877
6878 CBlockIndex *snapshot_start_block = WITH_LOCK(
6879 ::cs_main, return m_blockman.LookupBlockIndex(base_blockhash));
6880
6881 if (!snapshot_start_block) {
6882 // Needed for ComputeUTXOStats to determine the
6883 // height and to avoid a crash when base_blockhash.IsNull()
6884 LogPrintf("[snapshot] Did not find snapshot start blockheader %s\n",
6885 base_blockhash.ToString());
6886 return false;
6887 }
6888
6889 int base_height = snapshot_start_block->nHeight;
6890 const auto &maybe_au_data = GetParams().AssumeutxoForHeight(base_height);
6891
6892 if (!maybe_au_data) {
6893 LogPrintf("[snapshot] assumeutxo height in snapshot metadata not "
6894 "recognized (%d) - refusing to load snapshot\n",
6895 base_height);
6896 return false;
6897 }
6898
6899 const AssumeutxoData &au_data = *maybe_au_data;
6900
6901 // This work comparison is a duplicate check with the one performed later in
6902 // ActivateSnapshot(), but is done so that we avoid doing the long work of
6903 // staging a snapshot that isn't actually usable.
6905 ActiveTip(), snapshot_start_block))) {
6906 LogPrintf("[snapshot] activation failed - work does not exceed active "
6907 "chainstate\n");
6908 return false;
6909 }
6910
6911 const uint64_t coins_count = metadata.m_coins_count;
6912 uint64_t coins_left = metadata.m_coins_count;
6913
6914 LogPrintf("[snapshot] loading %d coins from snapshot %s\n", coins_left,
6915 base_blockhash.ToString());
6916 int64_t coins_processed{0};
6917
6918 while (coins_left > 0) {
6919 try {
6920 TxId txid;
6921 coins_file >> txid;
6922 size_t coins_per_txid{0};
6923 coins_per_txid = ReadCompactSize(coins_file);
6924
6925 if (coins_per_txid > coins_left) {
6926 LogPrintf("[snapshot] mismatch in coins count in snapshot "
6927 "metadata and actual snapshot data\n");
6928 return false;
6929 }
6930
6931 for (size_t i = 0; i < coins_per_txid; i++) {
6932 Coin coin;
6933 COutPoint outpoint{
6934 txid, static_cast<uint32_t>(ReadCompactSize(coins_file))};
6935 coins_file >> coin;
6936 // Avoid integer wrap-around in coinstats.cpp:ApplyHash
6937 if (coin.GetHeight() > uint32_t(base_height) ||
6938 outpoint.GetN() >=
6939 std::numeric_limits<decltype(outpoint.GetN())>::max()) {
6940 LogPrintf("[snapshot] bad snapshot data after "
6941 "deserializing %d coins\n",
6942 coins_count - coins_left);
6943 return false;
6944 }
6945 if (!MoneyRange(coin.GetTxOut().nValue)) {
6946 LogPrintf("[snapshot] bad snapshot data after "
6947 "deserializing %d coins - bad tx out value\n",
6948 coins_count - coins_left);
6949 return false;
6950 }
6951 coins_cache.EmplaceCoinInternalDANGER(std::move(outpoint),
6952 std::move(coin));
6953
6954 --coins_left;
6955 ++coins_processed;
6956
6957 if (coins_processed % 1000000 == 0) {
6958 LogPrintf("[snapshot] %d coins loaded (%.2f%%, %.2f MB)\n",
6959 coins_processed,
6960 static_cast<float>(coins_processed) * 100 /
6961 static_cast<float>(coins_count),
6962 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
6963 }
6964
6965 // Batch write and flush (if we need to) every so often.
6966 //
6967 // If our average Coin size is roughly 41 bytes, checking every
6968 // 120,000 coins means <5MB of memory imprecision.
6969 if (coins_processed % 120000 == 0) {
6970 if (m_interrupt) {
6971 return false;
6972 }
6973
6974 const auto snapshot_cache_state = WITH_LOCK(
6975 ::cs_main,
6976 return snapshot_chainstate.GetCoinsCacheSizeState());
6977
6978 if (snapshot_cache_state >= CoinsCacheSizeState::CRITICAL) {
6979 // This is a hack - we don't know what the actual best
6980 // block is, but that doesn't matter for the purposes of
6981 // flushing the cache here. We'll set this to its
6982 // correct value (`base_blockhash`) below after the
6983 // coins are loaded.
6984 coins_cache.SetBestBlock(BlockHash{GetRandHash()});
6985
6986 // No need to acquire cs_main since this chainstate
6987 // isn't being used yet.
6988 FlushSnapshotToDisk(coins_cache,
6989 /*snapshot_loaded=*/false);
6990 }
6991 }
6992 }
6993 } catch (const std::ios_base::failure &) {
6994 LogPrintf("[snapshot] bad snapshot format or truncated snapshot "
6995 "after deserializing %d coins\n",
6996 coins_processed);
6997 return false;
6998 }
6999 }
7000
7001 // Important that we set this. This and the coins_cache accesses above are
7002 // sort of a layer violation, but either we reach into the innards of
7003 // CCoinsViewCache here or we have to invert some of the Chainstate to
7004 // embed them in a snapshot-activation-specific CCoinsViewCache bulk load
7005 // method.
7006 coins_cache.SetBestBlock(base_blockhash);
7007
7008 bool out_of_coins{false};
7009 try {
7010 std::byte left_over_byte;
7011 coins_file >> left_over_byte;
7012 } catch (const std::ios_base::failure &) {
7013 // We expect an exception since we should be out of coins.
7014 out_of_coins = true;
7015 }
7016 if (!out_of_coins) {
7017 LogPrintf("[snapshot] bad snapshot - coins left over after "
7018 "deserializing %d coins\n",
7019 coins_count);
7020 return false;
7021 }
7022
7023 LogPrintf("[snapshot] loaded %d (%.2f MB) coins from snapshot %s\n",
7024 coins_count, coins_cache.DynamicMemoryUsage() / (1000 * 1000),
7025 base_blockhash.ToString());
7026
7027 // No need to acquire cs_main since this chainstate isn't being used yet.
7028 FlushSnapshotToDisk(coins_cache, /*snapshot_loaded=*/true);
7029
7030 assert(coins_cache.GetBestBlock() == base_blockhash);
7031
7032 // As above, okay to immediately release cs_main here since no other context
7033 // knows about the snapshot_chainstate.
7034 CCoinsViewDB *snapshot_coinsdb =
7035 WITH_LOCK(::cs_main, return &snapshot_chainstate.CoinsDB());
7036
7037 std::optional<CCoinsStats> maybe_stats;
7038
7039 try {
7040 maybe_stats = ComputeUTXOStats(
7041 CoinStatsHashType::HASH_SERIALIZED, snapshot_coinsdb, m_blockman,
7042 [&interrupt = m_interrupt] {
7043 SnapshotUTXOHashBreakpoint(interrupt);
7044 });
7045 } catch (StopHashingException const &) {
7046 return false;
7047 }
7048 if (!maybe_stats.has_value()) {
7049 LogPrintf("[snapshot] failed to generate coins stats\n");
7050 return false;
7051 }
7052
7053 // Assert that the deserialized chainstate contents match the expected
7054 // assumeutxo value.
7055 if (AssumeutxoHash{maybe_stats->hashSerialized} !=
7056 au_data.hash_serialized) {
7057 LogPrintf("[snapshot] bad snapshot content hash: expected %s, got %s\n",
7058 au_data.hash_serialized.ToString(),
7059 maybe_stats->hashSerialized.ToString());
7060 return false;
7061 }
7062
7063 snapshot_chainstate.m_chain.SetTip(*snapshot_start_block);
7064
7065 // The remainder of this function requires modifying data protected by
7066 // cs_main.
7067 LOCK(::cs_main);
7068
7069 // Fake various pieces of CBlockIndex state:
7070 CBlockIndex *index = nullptr;
7071
7072 // Don't make any modifications to the genesis block since it shouldn't be
7073 // necessary, and since the genesis block doesn't have normal flags like
7074 // BLOCK_VALID_SCRIPTS set.
7075 constexpr int AFTER_GENESIS_START{1};
7076
7077 for (int i = AFTER_GENESIS_START; i <= snapshot_chainstate.m_chain.Height();
7078 ++i) {
7079 index = snapshot_chainstate.m_chain[i];
7080
7081 m_blockman.m_dirty_blockindex.insert(index);
7082 // Changes to the block index will be flushed to disk after this call
7083 // returns in `ActivateSnapshot()`, when `MaybeRebalanceCaches()` is
7084 // called, since we've added a snapshot chainstate and therefore will
7085 // have to downsize the IBD chainstate, which will result in a call to
7086 // `FlushStateToDisk(ALWAYS)`.
7087 }
7088
7089 assert(index);
7090 assert(index == snapshot_start_block);
7091 index->m_chain_tx_count = au_data.m_chain_tx_count;
7092 snapshot_chainstate.setBlockIndexCandidates.insert(snapshot_start_block);
7093
7094 LogPrintf("[snapshot] validated snapshot (%.2f MB)\n",
7095 coins_cache.DynamicMemoryUsage() / (1000 * 1000));
7096 return true;
7097}
7098
7099// Currently, this function holds cs_main for its duration, which could be for
7100// multiple minutes due to the ComputeUTXOStats call. This hold is necessary
7101// because we need to avoid advancing the background validation chainstate
7102// farther than the snapshot base block - and this function is also invoked
7103// from within ConnectTip, i.e. from within ActivateBestChain, so cs_main is
7104// held anyway.
7105//
7106// Eventually (TODO), we could somehow separate this function's runtime from
7107// maintenance of the active chain, but that will either require
7108//
7109// (i) setting `m_disabled` immediately and ensuring all chainstate accesses go
7110// through IsUsable() checks, or
7111//
7112// (ii) giving each chainstate its own lock instead of using cs_main for
7113// everything.
7114SnapshotCompletionResult ChainstateManager::MaybeCompleteSnapshotValidation() {
7116 if (m_ibd_chainstate.get() == &this->ActiveChainstate() ||
7117 !this->IsUsable(m_snapshot_chainstate.get()) ||
7118 !this->IsUsable(m_ibd_chainstate.get()) ||
7119 !m_ibd_chainstate->m_chain.Tip()) {
7120 // Nothing to do - this function only applies to the background
7121 // validation chainstate.
7123 }
7124 const int snapshot_tip_height = this->ActiveHeight();
7125 const int snapshot_base_height = *Assert(this->GetSnapshotBaseHeight());
7126 const CBlockIndex &index_new = *Assert(m_ibd_chainstate->m_chain.Tip());
7127
7128 if (index_new.nHeight < snapshot_base_height) {
7129 // Background IBD not complete yet.
7131 }
7132
7134 BlockHash snapshot_blockhash = *Assert(SnapshotBlockhash());
7135
7136 auto handle_invalid_snapshot = [&]() EXCLUSIVE_LOCKS_REQUIRED(::cs_main) {
7137 bilingual_str user_error = strprintf(
7138 _("%s failed to validate the -assumeutxo snapshot state. "
7139 "This indicates a hardware problem, or a bug in the software, or "
7140 "a bad software modification that allowed an invalid snapshot to "
7141 "be loaded. As a result of this, the node will shut down and "
7142 "stop using any state that was built on the snapshot, resetting "
7143 "the chain height from %d to %d. On the next restart, the node "
7144 "will resume syncing from %d without using any snapshot data. "
7145 "Please report this incident to %s, including how you obtained "
7146 "the snapshot. The invalid snapshot chainstate will be left on "
7147 "disk in case it is helpful in diagnosing the issue that caused "
7148 "this error."),
7149 PACKAGE_NAME, snapshot_tip_height, snapshot_base_height,
7150 snapshot_base_height, PACKAGE_BUGREPORT);
7151
7152 LogPrintf("[snapshot] !!! %s\n", user_error.original);
7153 LogPrintf("[snapshot] deleting snapshot, reverting to validated chain, "
7154 "and stopping node\n");
7155
7156 m_active_chainstate = m_ibd_chainstate.get();
7157 m_snapshot_chainstate->m_disabled = true;
7158 assert(!this->IsUsable(m_snapshot_chainstate.get()));
7159 assert(this->IsUsable(m_ibd_chainstate.get()));
7160
7161 auto rename_result = m_snapshot_chainstate->InvalidateCoinsDBOnDisk();
7162 if (!rename_result) {
7163 user_error = strprintf(Untranslated("%s\n%s"), user_error,
7164 util::ErrorString(rename_result));
7165 }
7166
7167 GetNotifications().fatalError(user_error.original, user_error);
7168 };
7169
7170 if (index_new.GetBlockHash() != snapshot_blockhash) {
7171 LogPrintf(
7172 "[snapshot] supposed base block %s does not match the "
7173 "snapshot base block %s (height %d). Snapshot is not valid.\n",
7174 index_new.ToString(), snapshot_blockhash.ToString(),
7175 snapshot_base_height);
7176 handle_invalid_snapshot();
7178 }
7179
7180 assert(index_new.nHeight == snapshot_base_height);
7181
7182 int curr_height = m_ibd_chainstate->m_chain.Height();
7183
7184 assert(snapshot_base_height == curr_height);
7185 assert(snapshot_base_height == index_new.nHeight);
7186 assert(this->IsUsable(m_snapshot_chainstate.get()));
7187 assert(this->GetAll().size() == 2);
7188
7189 CCoinsViewDB &ibd_coins_db = m_ibd_chainstate->CoinsDB();
7190 m_ibd_chainstate->ForceFlushStateToDisk();
7191
7192 const auto &maybe_au_data =
7193 this->GetParams().AssumeutxoForHeight(curr_height);
7194 if (!maybe_au_data) {
7195 LogPrintf("[snapshot] assumeutxo data not found for height "
7196 "(%d) - refusing to validate snapshot\n",
7197 curr_height);
7198 handle_invalid_snapshot();
7200 }
7201
7202 const AssumeutxoData &au_data = *maybe_au_data;
7203 std::optional<CCoinsStats> maybe_ibd_stats;
7204 LogPrintf(
7205 "[snapshot] computing UTXO stats for background chainstate to validate "
7206 "snapshot - this could take a few minutes\n");
7207 try {
7208 maybe_ibd_stats =
7209 ComputeUTXOStats(CoinStatsHashType::HASH_SERIALIZED, &ibd_coins_db,
7210 m_blockman, [&interrupt = m_interrupt] {
7211 SnapshotUTXOHashBreakpoint(interrupt);
7212 });
7213 } catch (StopHashingException const &) {
7215 }
7216
7217 if (!maybe_ibd_stats) {
7218 LogPrintf(
7219 "[snapshot] failed to generate stats for validation coins db\n");
7220 // While this isn't a problem with the snapshot per se, this condition
7221 // prevents us from validating the snapshot, so we should shut down and
7222 // let the user handle the issue manually.
7223 handle_invalid_snapshot();
7225 }
7226 const auto &ibd_stats = *maybe_ibd_stats;
7227
7228 // Compare the background validation chainstate's UTXO set hash against the
7229 // hard-coded assumeutxo hash we expect.
7230 //
7231 // TODO: For belt-and-suspenders, we could cache the UTXO set
7232 // hash for the snapshot when it's loaded in its chainstate's leveldb. We
7233 // could then reference that here for an additional check.
7234 if (AssumeutxoHash{ibd_stats.hashSerialized} != au_data.hash_serialized) {
7235 LogPrintf("[snapshot] hash mismatch: actual=%s, expected=%s\n",
7236 ibd_stats.hashSerialized.ToString(),
7237 au_data.hash_serialized.ToString());
7238 handle_invalid_snapshot();
7240 }
7241
7242 LogPrintf("[snapshot] snapshot beginning at %s has been fully validated\n",
7243 snapshot_blockhash.ToString());
7244
7245 m_ibd_chainstate->m_disabled = true;
7246 this->MaybeRebalanceCaches();
7247
7249}
7250
7252 LOCK(::cs_main);
7253 assert(m_active_chainstate);
7254 return *m_active_chainstate;
7255}
7256
7258 auto &active_chainstate = ActiveChainstate();
7259 LOCK(active_chainstate.cs_avalancheFinalizedBlockIndex);
7260 return active_chainstate.m_avalancheFinalizedBlockIndex;
7261}
7262
7264 LOCK(::cs_main);
7265 return m_snapshot_chainstate &&
7266 m_active_chainstate == m_snapshot_chainstate.get();
7267}
7268void ChainstateManager::MaybeRebalanceCaches() {
7270 bool ibd_usable = this->IsUsable(m_ibd_chainstate.get());
7271 bool snapshot_usable = this->IsUsable(m_snapshot_chainstate.get());
7272 assert(ibd_usable || snapshot_usable);
7273
7274 if (ibd_usable && !snapshot_usable) {
7275 // Allocate everything to the IBD chainstate. This will always happen
7276 // when we are not using a snapshot.
7277 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache,
7279 } else if (snapshot_usable && !ibd_usable) {
7280 // If background validation has completed and snapshot is our active
7281 // chain...
7282 LogPrintf(
7283 "[snapshot] allocating all cache to the snapshot chainstate\n");
7284 // Allocate everything to the snapshot chainstate.
7285 m_snapshot_chainstate->ResizeCoinsCaches(m_total_coinstip_cache,
7287 } else if (ibd_usable && snapshot_usable) {
7288 // If both chainstates exist, determine who needs more cache based on
7289 // IBD status.
7290 //
7291 // Note: shrink caches first so that we don't inadvertently overwhelm
7292 // available memory.
7293 if (IsInitialBlockDownload()) {
7294 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache * 0.05,
7295 m_total_coinsdb_cache * 0.05);
7296 m_snapshot_chainstate->ResizeCoinsCaches(
7298 } else {
7299 m_snapshot_chainstate->ResizeCoinsCaches(
7301 m_ibd_chainstate->ResizeCoinsCaches(m_total_coinstip_cache * 0.95,
7302 m_total_coinsdb_cache * 0.95);
7303 }
7304 }
7305}
7306
7307void ChainstateManager::ResetChainstates() {
7308 m_ibd_chainstate.reset();
7309 m_snapshot_chainstate.reset();
7310 m_active_chainstate = nullptr;
7311}
7312
7319 if (!opts.check_block_index.has_value()) {
7320 opts.check_block_index =
7321 opts.config.GetChainParams().DefaultConsistencyChecks();
7322 }
7323
7324 if (!opts.minimum_chain_work.has_value()) {
7325 opts.minimum_chain_work = UintToArith256(
7326 opts.config.GetChainParams().GetConsensus().nMinimumChainWork);
7327 }
7328 if (!opts.assumed_valid_block.has_value()) {
7329 opts.assumed_valid_block =
7330 opts.config.GetChainParams().GetConsensus().defaultAssumeValid;
7331 }
7332 Assert(opts.adjusted_time_callback);
7333 return std::move(opts);
7334}
7335
7337 const util::SignalInterrupt &interrupt, Options options,
7338 node::BlockManager::Options blockman_options)
7339 : m_script_check_queue{/*batch_size=*/128, options.worker_threads_num},
7340 m_interrupt{interrupt}, m_options{Flatten(std::move(options))},
7341 m_blockman{interrupt, std::move(blockman_options)},
7342 m_validation_cache{m_options.script_execution_cache_bytes,
7343 m_options.signature_cache_bytes} {}
7344
7345bool ChainstateManager::DetectSnapshotChainstate(CTxMemPool *mempool) {
7346 assert(!m_snapshot_chainstate);
7347 std::optional<fs::path> path =
7349 if (!path) {
7350 return false;
7351 }
7352 std::optional<BlockHash> base_blockhash =
7354 if (!base_blockhash) {
7355 return false;
7356 }
7357 LogPrintf("[snapshot] detected active snapshot chainstate (%s) - loading\n",
7358 fs::PathToString(*path));
7359
7360 this->ActivateExistingSnapshot(*base_blockhash);
7361 return true;
7362}
7363
7364Chainstate &
7365ChainstateManager::ActivateExistingSnapshot(BlockHash base_blockhash) {
7366 assert(!m_snapshot_chainstate);
7367 m_snapshot_chainstate = std::make_unique<Chainstate>(nullptr, m_blockman,
7368 *this, base_blockhash);
7369 LogPrintf("[snapshot] switching active chainstate to %s\n",
7370 m_snapshot_chainstate->ToString());
7371
7372 // Mempool is empty at this point because we're still in IBD.
7373 Assert(m_active_chainstate->m_mempool->size() == 0);
7374 Assert(!m_snapshot_chainstate->m_mempool);
7375 m_snapshot_chainstate->m_mempool = m_active_chainstate->m_mempool;
7376 m_active_chainstate->m_mempool = nullptr;
7377 m_active_chainstate = m_snapshot_chainstate.get();
7378 return *m_snapshot_chainstate;
7379}
7380
7384 // Should never be called on a non-snapshot chainstate.
7385 assert(cs.m_from_snapshot_blockhash);
7386 auto storage_path_maybe = cs.CoinsDB().StoragePath();
7387 // Should never be called with a non-existent storage path.
7388 assert(storage_path_maybe);
7389 return *storage_path_maybe;
7390}
7391
7392util::Result<void> Chainstate::InvalidateCoinsDBOnDisk() {
7393 fs::path snapshot_datadir = GetSnapshotCoinsDBPath(*this);
7394
7395 // Coins views no longer usable.
7396 m_coins_views.reset();
7397
7398 auto invalid_path = snapshot_datadir + "_INVALID";
7399 std::string dbpath = fs::PathToString(snapshot_datadir);
7400 std::string target = fs::PathToString(invalid_path);
7401 LogPrintf("[snapshot] renaming snapshot datadir %s to %s\n", dbpath,
7402 target);
7403
7404 // The invalid snapshot datadir is simply moved and not deleted because we
7405 // may want to do forensics later during issue investigation. The user is
7406 // instructed accordingly in MaybeCompleteSnapshotValidation().
7407 try {
7408 fs::rename(snapshot_datadir, invalid_path);
7409 } catch (const fs::filesystem_error &e) {
7410 auto src_str = fs::PathToString(snapshot_datadir);
7411 auto dest_str = fs::PathToString(invalid_path);
7412
7413 LogPrintf("%s: error renaming file '%s' -> '%s': %s\n", __func__,
7414 src_str, dest_str, e.what());
7415 return util::Error{strprintf(_("Rename of '%s' -> '%s' failed. "
7416 "You should resolve this by manually "
7417 "moving or deleting the invalid "
7418 "snapshot directory %s, otherwise you "
7419 "will encounter the same error again "
7420 "on the next startup."),
7421 src_str, dest_str, src_str)};
7422 }
7423 return {};
7424}
7425
7426bool ChainstateManager::DeleteSnapshotChainstate() {
7428 Assert(m_snapshot_chainstate);
7429 Assert(m_ibd_chainstate);
7430
7431 fs::path snapshot_datadir =
7433 if (!DeleteCoinsDBFromDisk(snapshot_datadir, /*is_snapshot=*/true)) {
7434 LogPrintf("Deletion of %s failed. Please remove it manually to "
7435 "continue reindexing.\n",
7436 fs::PathToString(snapshot_datadir));
7437 return false;
7438 }
7439 m_active_chainstate = m_ibd_chainstate.get();
7440 m_active_chainstate->m_mempool = m_snapshot_chainstate->m_mempool;
7441 m_snapshot_chainstate.reset();
7442 return true;
7443}
7444
7445ChainstateRole Chainstate::GetRole() const {
7446 if (m_chainman.GetAll().size() <= 1) {
7448 }
7449 return (this != &m_chainman.ActiveChainstate())
7452}
7453const CBlockIndex *ChainstateManager::GetSnapshotBaseBlock() const {
7454 return m_active_chainstate ? m_active_chainstate->SnapshotBase() : nullptr;
7455}
7456
7457std::optional<int> ChainstateManager::GetSnapshotBaseHeight() const {
7458 const CBlockIndex *base = this->GetSnapshotBaseBlock();
7459 return base ? std::make_optional(base->nHeight) : std::nullopt;
7460}
7461
7462void ChainstateManager::RecalculateBestHeader() {
7464 m_best_header = ActiveChain().Tip();
7465 for (auto &entry : m_blockman.m_block_index) {
7466 if (!(entry.second.nStatus.isInvalid()) &&
7467 m_best_header->nChainWork < entry.second.nChainWork) {
7468 m_best_header = &entry.second;
7469 }
7470 }
7471}
7472
7473bool ChainstateManager::ValidatedSnapshotCleanup() {
7475 auto get_storage_path = [](auto &chainstate) EXCLUSIVE_LOCKS_REQUIRED(
7476 ::cs_main) -> std::optional<fs::path> {
7477 if (!(chainstate && chainstate->HasCoinsViews())) {
7478 return {};
7479 }
7480 return chainstate->CoinsDB().StoragePath();
7481 };
7482 std::optional<fs::path> ibd_chainstate_path_maybe =
7483 get_storage_path(m_ibd_chainstate);
7484 std::optional<fs::path> snapshot_chainstate_path_maybe =
7485 get_storage_path(m_snapshot_chainstate);
7486
7487 if (!this->IsSnapshotValidated()) {
7488 // No need to clean up.
7489 return false;
7490 }
7491 // If either path doesn't exist, that means at least one of the chainstates
7492 // is in-memory, in which case we can't do on-disk cleanup. You'd better be
7493 // in a unittest!
7494 if (!ibd_chainstate_path_maybe || !snapshot_chainstate_path_maybe) {
7495 LogPrintf("[snapshot] snapshot chainstate cleanup cannot happen with "
7496 "in-memory chainstates. You are testing, right?\n");
7497 return false;
7498 }
7499
7500 const auto &snapshot_chainstate_path = *snapshot_chainstate_path_maybe;
7501 const auto &ibd_chainstate_path = *ibd_chainstate_path_maybe;
7502
7503 // Since we're going to be moving around the underlying leveldb filesystem
7504 // content for each chainstate, make sure that the chainstates (and their
7505 // constituent CoinsViews members) have been destructed first.
7506 //
7507 // The caller of this method will be responsible for reinitializing
7508 // chainstates if they want to continue operation.
7509 this->ResetChainstates();
7510
7511 // No chainstates should be considered usable.
7512 assert(this->GetAll().size() == 0);
7513
7514 LogPrintf("[snapshot] deleting background chainstate directory (now "
7515 "unnecessary) (%s)\n",
7516 fs::PathToString(ibd_chainstate_path));
7517
7518 fs::path tmp_old{ibd_chainstate_path + "_todelete"};
7519
7520 auto rename_failed_abort = [this](fs::path p_old, fs::path p_new,
7521 const fs::filesystem_error &err) {
7522 LogPrintf("Error renaming path (%s) -> (%s): %s\n",
7523 fs::PathToString(p_old), fs::PathToString(p_new), err.what());
7525 "Rename of '%s' -> '%s' failed. "
7526 "Cannot clean up the background chainstate leveldb directory.",
7527 fs::PathToString(p_old), fs::PathToString(p_new)));
7528 };
7529
7530 try {
7531 fs::rename(ibd_chainstate_path, tmp_old);
7532 } catch (const fs::filesystem_error &e) {
7533 rename_failed_abort(ibd_chainstate_path, tmp_old, e);
7534 throw;
7535 }
7536
7537 LogPrintf("[snapshot] moving snapshot chainstate (%s) to "
7538 "default chainstate directory (%s)\n",
7539 fs::PathToString(snapshot_chainstate_path),
7540 fs::PathToString(ibd_chainstate_path));
7541
7542 try {
7543 fs::rename(snapshot_chainstate_path, ibd_chainstate_path);
7544 } catch (const fs::filesystem_error &e) {
7545 rename_failed_abort(snapshot_chainstate_path, ibd_chainstate_path, e);
7546 throw;
7547 }
7548
7549 if (!DeleteCoinsDBFromDisk(tmp_old, /*is_snapshot=*/false)) {
7550 // No need to FatalError because once the unneeded bg chainstate data is
7551 // moved, it will not interfere with subsequent initialization.
7552 LogPrintf("Deletion of %s failed. Please remove it manually, as the "
7553 "directory is now unnecessary.\n",
7554 fs::PathToString(tmp_old));
7555 } else {
7556 LogPrintf("[snapshot] deleted background chainstate directory (%s)\n",
7557 fs::PathToString(ibd_chainstate_path));
7558 }
7559 return true;
7560}
7561
7562Chainstate &ChainstateManager::GetChainstateForIndexing() {
7563 // We can't always return `m_ibd_chainstate` because after background
7564 // validation has completed,
7565 // `m_snapshot_chainstate == m_active_chainstate`, but it can be indexed.
7566 return (this->GetAll().size() > 1) ? *m_ibd_chainstate
7567 : *m_active_chainstate;
7568}
7569
7570std::pair<int, int>
7571ChainstateManager::GetPruneRange(const Chainstate &chainstate,
7572 int last_height_can_prune) {
7573 if (chainstate.m_chain.Height() <= 0) {
7574 return {0, 0};
7575 }
7576 int prune_start{0};
7577
7578 if (this->GetAll().size() > 1 &&
7579 m_snapshot_chainstate.get() == &chainstate) {
7580 // Leave the blocks in the background IBD chain alone if we're pruning
7581 // the snapshot chain.
7582 prune_start = *Assert(GetSnapshotBaseHeight()) + 1;
7583 }
7584
7585 int max_prune = std::max<int>(0, chainstate.m_chain.Height() -
7586 static_cast<int>(MIN_BLOCKS_TO_KEEP));
7587
7588 // last block to prune is the lesser of (caller-specified height,
7589 // MIN_BLOCKS_TO_KEEP from the tip)
7590 //
7591 // While you might be tempted to prune the background chainstate more
7592 // aggressively (i.e. fewer MIN_BLOCKS_TO_KEEP), this won't work with index
7593 // building - specifically blockfilterindex requires undo data, and if
7594 // we don't maintain this trailing window, we hit indexing failures.
7595 int prune_end = std::min(last_height_can_prune, max_prune);
7596
7597 return {prune_start, prune_end};
7598}
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:433
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:505
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:190
std::string ToString() const
Definition: blockindex.cpp:30
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: blockindex.h:32
uint64_t m_chain_tx_count
(memory only) Number of transactions in the chain up to and including this block.
Definition: blockindex.h:67
int64_t GetHeaderReceivedTime() const
Definition: blockindex.h:163
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
bool HaveNumChainTxs() const
Check whether this block and all previous blocks back to the genesis block or an assumeutxo snapshot ...
Definition: blockindex.h:153
uint32_t nTime
Definition: blockindex.h:75
int32_t nSequenceId
(memory only) Sequential id assigned to distinguish order in which blocks are received.
Definition: blockindex.h:81
uint64_t GetChainTxCount() const
Get the number of transaction in the chain so far.
Definition: blockindex.h:137
int64_t GetReceivedTimeDiff() const
Definition: blockindex.h:165
int64_t GetBlockTime() const
Definition: blockindex.h:159
int64_t GetMedianTimePast() const
Definition: blockindex.h:171
FlatFilePos GetUndoPos() const EXCLUSIVE_LOCKS_REQUIRED(
Definition: blockindex.h:106
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:198
int32_t nVersion
block header
Definition: blockindex.h:73
int64_t nTimeReceived
(memory only) block header metadata
Definition: blockindex.h:84
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: blockindex.cpp:62
BlockHash GetBlockHash() const
Definition: blockindex.h:129
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
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
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:319
void AddCoin(const COutPoint &outpoint, Coin coin, bool possible_overwrite)
Add a coin.
Definition: coins.cpp:97
BlockHash GetBestBlock() const override
Retrieve the block hash whose state this CCoinsView currently represents.
Definition: coins.cpp:217
bool SpendCoin(const COutPoint &outpoint, Coin *moveto=nullptr)
Spend a coin.
Definition: coins.cpp:173
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:337
void SetBestBlock(const BlockHash &hashBlock)
Definition: coins.cpp:224
void Flush(bool reallocate_cache=true)
Push the modifications applied to this cache to its base and wipe local state.
Definition: coins.cpp:307
unsigned int GetCacheSize() const
Size of the cache (in number of transaction outputs)
Definition: coins.cpp:349
bool HaveCoinInCache(const COutPoint &outpoint) const
Check if we have the given utxo already loaded in this cache.
Definition: coins.cpp:212
size_t DynamicMemoryUsage() const
Calculate the size of the cache (in bytes)
Definition: coins.cpp:69
void EmplaceCoinInternalDANGER(COutPoint &&outpoint, Coin &&coin)
Emplace a coin into cacheCoins without performing any checks, marking the emplaced coin as dirty.
Definition: coins.cpp:145
bool HaveCoin(const COutPoint &outpoint) const override
Just check whether a given outpoint is unspent.
Definition: coins.cpp:207
std::optional< Coin > GetCoin(const COutPoint &outpoint) const override
Retrieve the Coin (unspent transaction output) for a given outpoint.
Definition: coins.cpp:89
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Definition: coins.cpp:199
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
unsigned long size() const
Definition: txmempool.h:493
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:1445
ValidationCache m_validation_cache
Definition: validation.h:1337
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:1353
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:1690
const Config & GetConfig() const
Definition: validation.h:1288
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:1397
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:1303
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
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.
RecursiveMutex & GetMutex() const LOCK_RETURNED(
Alias for cs_main.
Definition: validation.h:1326
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:1483
bool IsUsable(const Chainstate *const pchainstate) const EXCLUSIVE_LOCKS_REQUIRED(
Return true if a chainstate is considered usable.
Definition: validation.h:1251
CBlockIndex * ActiveTip() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1452
bool BackgroundSyncInProgress() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
The state of a background sync (for net processing)
Definition: validation.h:1459
size_t m_total_coinsdb_cache
The total number of bytes available for us to use across all leveldb coins databases.
Definition: validation.h:1401
std::atomic< bool > m_cached_finished_ibd
Whether initial block download has ended and IsInitialBlockDownload should return false from now on.
Definition: validation.h:1346
bool PopulateAndValidateSnapshot(Chainstate &snapshot_chainstate, AutoFile &coins_file, const node::SnapshotMetadata &metadata)
Internal helper for ActivateSnapshot().
const util::SignalInterrupt & m_interrupt
Definition: validation.h:1330
int ActiveHeight() const EXCLUSIVE_LOCKS_REQUIRED(GetMutex())
Definition: validation.h:1449
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:1286
const CChainParams & GetParams() const
Definition: validation.h:1290
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:1293
ChainstateManager(const util::SignalInterrupt &interrupt, Options options, node::BlockManager::Options blockman_options)
const arith_uint256 & MinimumChainWork() const
Definition: validation.h:1297
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:1331
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:1446
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:1358
const BlockHash & AssumedValidBlock() const
Definition: validation.h:1300
bool NotifyHeaderTip() LOCKS_EXCLUDED(GetMutex())
Chainstate &InitializeChainstate(CTxMemPool *mempool) EXCLUSIVE_LOCKS_REQUIRED(std::vector< Chainstate * GetAll)()
Instantiate a new chainstate.
Definition: validation.h:1411
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:1387
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:1356
node::BlockManager m_blockman
A single BlockManager instance is shared across each constructed chainstate to avoid duplicating bloc...
Definition: validation.h:1335
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:385
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:522
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:420
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.
constexpr bool IsNull() const
Definition: uint256.h:40
constexpr uint8_t * begin()
Definition: uint256.h:89
std::string ToString() const
Definition: uint256.h:84
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:416
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
std::atomic_bool m_blockfiles_indexed
Whether all blockfiles have been added to the block tree database.
Definition: blockstorage.h:268
CBlockIndex * LookupBlockIndex(const BlockHash &hash) EXCLUSIVE_LOCKS_REQUIRED(cs_main)
bool LoadingBlocks() const
Definition: blockstorage.h:365
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:309
std::set< CBlockIndex * > m_dirty_blockindex
Dirty block index entries.
Definition: blockstorage.h:233
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:356
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:342
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:284
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:286
Metadata describing a serialized version of a UTXO set from which an assumeutxo Chainstate can be con...
Definition: utxo_snapshot.h:31
uint64_t m_coins_count
The number of coins in the UTXO set contained in this snapshot.
Definition: utxo_snapshot.h:43
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:39
256-bit opaque blob.
Definition: uint256.h:127
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:418
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:157
@ 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:190
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:152
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:1264
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
uint64_t m_chain_tx_count
Used to populate the m_chain_tx_count 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
uint64_t tx_count
Definition: chainparams.h:75
double dTxRate
Definition: chainparams.h:76
int64_t nTime
Definition: chainparams.h:74
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< int32_t > check_block_index
std::chrono::seconds max_tip_age
If the tip is older than this, the node is considered to be in initial block download.
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:1203
#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:172
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:183
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:141
#define expect(bit)
static bool DeleteCoinsDBFromDisk(const fs::path &db_path, bool is_snapshot) EXCLUSIVE_LOCKS_REQUIRED(
bool FatalError(Notifications &notifications, BlockValidationState &state, const std::string &strMessage, const bilingual_str &userMessage)
GlobalMutex g_best_block_mutex
Definition: validation.cpp:113
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 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 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 bool CheckMerkleRoot(const CBlock &block, BlockValidationState &state)
static constexpr int PRUNE_LOCK_BUFFER
The number of blocks to keep below the deepest prune lock.
Definition: validation.cpp:109
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.
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 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 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 SynchronizationState GetSynchronizationState(bool init, bool blockfiles_indexed)
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