coinstats.h

Go to the documentation of this file.

// Copyright (c) 2022-present 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_KERNEL_COINSTATS_H
#define BITCOIN_KERNEL_COINSTATS_H
 
#include <arith_uint256.h>
#include <consensus/amount.h>
#include <uint256.h>
 
#include <cstdint>
#include <functional>
#include <optional>
 
class CCoinsView;
class Coin;
class COutPoint;
class CScript;
class MuHash3072;
namespace node {
class BlockManager;
} // namespace node
 
namespace kernel {
enum class CoinStatsHashType {
    HASH_SERIALIZED,
    MUHASH,
    NONE,
};
 
struct CCoinsStats {
    int nHeight{0};
    uint256 hashBlock{};
    uint64_t nTransactions{0};
    uint64_t nTransactionOutputs{0};
    uint64_t nBogoSize{0};
    uint256 hashSerialized{};
    uint64_t nDiskSize{0};
    std::optional<CAmount> total_amount{0};

    uint64_t coins_count{0};

    bool index_used{false};
 
    // Following values are only available from coinstats index

    CAmount total_subsidy{0};
    CAmount total_unspendables_genesis_block{0};
    CAmount total_unspendables_bip30{0};
    CAmount total_unspendables_scripts{0};
    CAmount total_unspendables_unclaimed_rewards{0};
 
    // Despite containing amounts the following values use a uint256 type to prevent overflowing

    arith_uint256 total_prevout_spent_amount{0};
    arith_uint256 total_new_outputs_ex_coinbase_amount{0};
    arith_uint256 total_coinbase_amount{0};
 
    CCoinsStats() = default;
    CCoinsStats(int block_height, const uint256& block_hash);
};
 
uint64_t GetBogoSize(const CScript& script_pub_key);
 
void ApplyCoinHash(MuHash3072& muhash, const COutPoint& outpoint, const Coin& coin);
void RemoveCoinHash(MuHash3072& muhash, const COutPoint& outpoint, const Coin& coin);
 
std::optional<CCoinsStats> ComputeUTXOStats(CoinStatsHashType hash_type, CCoinsView* view, node::BlockManager& blockman, const std::function<void()>& interruption_point = {});
} // namespace kernel
 
#endif // BITCOIN_KERNEL_COINSTATS_H