[#CChain]
= CChain
:mrdocs:

An in‐memory indexed chain of blocks.

== Synopsis

Declared in `<chain.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CChain;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:CChain/2constructor-0f.adoc[`CChain`]         [.small]#[constructor]#
| Constructors
| xref:CChain/operator_assign.adoc[`operator=`]  [.small]#[deleted]#
| Copy assignment is deleted; chains are not copyable.
| xref:CChain/Contains.adoc[`Contains`] 
| Efficiently check whether a block is present in this chain.
| xref:CChain/FindEarliestAtLeast.adoc[`FindEarliestAtLeast`] 
| Find the earliest block with timestamp equal or greater than the given time and height equal or greater than the given height.
| xref:CChain/FindFork.adoc[`FindFork`] 
| Find the last common block between this chain and a block index entry.
| xref:CChain/Genesis.adoc[`Genesis`] 
| Returns the index entry for the genesis block of this chain, or nullptr if none.
| xref:CChain/Height.adoc[`Height`] 
| Return the maximal height in the chain. Is equal to chain.Tip() ? chain.Tip()‐>nHeight : ‐1.
| xref:CChain/IsTipRecent.adoc[`IsTipRecent`] 
| Check whether this chain's tip exists, has enough work, and is recent.
| xref:CChain/Next.adoc[`Next`] 
| Find the successor of a block in this chain, or nullptr if the given index is not found or is the tip.
| xref:CChain/SetTip.adoc[`SetTip`] 
| Set/initialize a chain with a given tip.
| xref:CChain/Tip.adoc[`Tip`] 
| Returns the index entry for the tip of this chain, or nullptr if none.
| xref:CChain/operator_subs.adoc[`operator[]`] 
| Returns the index entry at a particular height in this chain, or nullptr if no such height exists.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:TestLockPointValidity.adoc[`TestLockPointValidity`]
| Test whether the LockPoints height and time are still valid on the current chain
|===


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