Coverage Report

Created: 2026-07-08 14:14

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