[#kernel-ComputeUTXOStats]
= xref:kernel.adoc[kernel]::ComputeUTXOStats
:relfileprefix: ../
:mrdocs:

Computes aggregate statistics over the UTXO set.

== Synopsis

Declared in `<kernel/coinstats.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional<CCoinsStats>
ComputeUTXOStats(
    xref:kernel/CoinStatsHashType.adoc[CoinStatsHashType] hash_type,
    xref:CCoinsViewDB.adoc[CCoinsViewDB] const& view,
    xref:node/BlockManager.adoc[node::BlockManager]& blockman,
    std::function<void()> const& interruption_point = {});
----

== Return Value

The computed statistics, or `std::nullopt` on failure.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *hash_type*
| The hashing scheme used to summarize the set.
| *view*
| The UTXO database to read from.
| *blockman*
| The block manager providing block data.
| *interruption_point*
| Callback invoked to allow the computation to be interrupted.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#