chainstate.h

Go to the documentation of this file.

// Copyright (c) 2021 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_NODE_CHAINSTATE_H
#define BITCOIN_NODE_CHAINSTATE_H
 
#include <validation.h>
 
#include <cstdint>
#include <functional>
#include <optional>
 
struct bilingual_str;
class Config;
class ChainstateManager;
class CTxMemPool;
namespace Consensus {
struct Params;
} // namespace Consensus
 
namespace kernel {
struct CacheSizes;
} // namespace kernel
 
namespace node {
 
struct ChainstateLoadOptions {
    CTxMemPool *mempool{nullptr};
    bool block_tree_db_in_memory{false};
    bool coins_db_in_memory{false};
    // Whether to wipe the block tree database when loading it. If set, this
    // will also set a reindexing flag so any existing block data files will be
    // scanned and added to the database.
    bool wipe_block_tree_db{false};
    // Whether to wipe the chainstate database when loading it. If set, this
    // will cause the chainstate database to be rebuilt starting from genesis.
    bool wipe_chainstate_db{false};
    bool prune{false};
    bool require_full_verification{true};
    int64_t check_blocks{DEFAULT_CHECKBLOCKS};
    int64_t check_level{DEFAULT_CHECKLEVEL};
    std::function<bool()> check_interrupt;
    std::function<void()> coins_error_cb;
};
 
enum class ChainstateLoadStatus {
    SUCCESS,
    FAILURE,
    FAILURE_FATAL,
    FAILURE_INCOMPATIBLE_DB,
    FAILURE_INSUFFICIENT_DBCACHE,
    INTERRUPTED
};
 
using ChainstateLoadResult = std::tuple<ChainstateLoadStatus, bilingual_str>;
 
ChainstateLoadResult LoadChainstate(ChainstateManager &chainman,
                                    const kernel::CacheSizes &cache_sizes,
                                    const ChainstateLoadOptions &options);
 
ChainstateLoadResult
VerifyLoadedChainstate(ChainstateManager &chainman,
                       const ChainstateLoadOptions &options);
} // namespace node
 
#endif // BITCOIN_NODE_CHAINSTATE_H