Coverage Report

Created: 2026-06-16 16:41

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