[#node-LoadChainstate]
= xref:node.adoc[node]::LoadChainstate
:relfileprefix: ../
:mrdocs:

This sequence can have 4 types of outcomes:

== Synopsis

Declared in `<node/chainstate.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:node/ChainstateLoadResult.adoc[ChainstateLoadResult]
LoadChainstate(
    xref:ChainstateManager.adoc[ChainstateManager]& chainman,
    xref:kernel/CacheSizes.adoc[kernel::CacheSizes] const& cache_sizes,
    xref:node/ChainstateLoadOptions.adoc[ChainstateLoadOptions] const& options);
----

== Description

1. Success 2. Shutdown requested

* nothing failed but a shutdown was triggered in the middle of the sequence 3. Soft failure
* a failure that might be recovered from with a reindex 4. Hard failure
* a failure that definitively cannot be recovered from with a reindex

LoadChainstate returns a (status code, error string) tuple.

== Return Value

A status code paired with an optional error string.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *chainman*
| The chainstate manager to load into.
| *cache_sizes*
| Cache sizes to allocate to the chainstate databases.
| *options*
| Options controlling how the chainstate is loaded.
|===


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