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