Coverage Report

Created: 2025-09-19 18:31

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