Struct grin_chain::txhashset::HeaderExtension

pub struct HeaderExtension<'a> {
    pub batch: &'a Batch<'a>,
    // some fields omitted
}

A header extension to allow the header MMR to extend beyond the other MMRs individually. This is to allow headers to be validated against the MMR before we have the full block data.

Fields

batch: &'a Batch<'a>

Batch in which the extension occurs, public so it can be used within an extending closure. Just be careful using it that way as it will get rolled back with the extension (i.e on a losing fork).

Methods

impl<'a> HeaderExtension<'a>

pub fn apply_header(&mut self, header: &BlockHeader) -> Result<(), Error>

Apply a new header to the header MMR extension. This may be either the header MMR or the sync MMR depending on the extension.

pub fn rewind(&mut self, header: &BlockHeader) -> Result<(), Error>

Rewind the header extension to the specified header. Note the close relationship between header height and insertion index.

pub fn truncate(&mut self) -> Result<(), Error>

Truncate the header MMR (rewind all the way back to pos 0). Used when rebuilding the header MMR by reapplying all headers including the genesis block header.

pub fn size(&self) -> u64

The size of the header MMR.

pub fn rebuild(     &mut self,     head: &Tip,     genesis: &BlockHeader ) -> Result<(), Error>

TODO - think about how to optimize this. Requires all header hashes to be iterated over in ascending order.

pub fn root(&self) -> Hash

The root of the header MMR for convenience.

pub fn validate_root(&self, header: &BlockHeader) -> Result<(), Error>

Validate the prev_root of the header against the root of the current header MMR.