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