Struct Blockchain

Source

pub struct Blockchain { /* private fields */ }

Expand description

The Merkle Mountain Range defining the Miden blockchain.

The values of the leaves in the MMR are the commitments of blocks, i.e. BlockHeader::commitment.

Each new block updates the blockchain by adding the previous block’s commitment to the MMR. This means the chain commitment found in block 10’s header commits to all blocks 0..=9, but not 10 itself. This results from the fact that block 10 cannot compute its own block commitment and thus cannot add itself to the chain. Hence, the blockchain is lagging behind by one block.

Some APIs take a checkpoint which is equivalent to the concept of forest of the underlying MMR. As an example, if the blockchain has 20 blocks in total, and the checkpoint is 10, then the API works in the context of the chain at the time it had 10 blocks, i.e. it contains blocks 0..=9. This is useful, for example, to retrieve proofs that are valid when verified against the chain commitment of block 10.

The maximum number of supported blocks is u32::MAX. This is not validated however.

Struct BlockchainCopy item path

Implementations§

impl Blockchain

pub fn new() -> Self

pub fn from_mmr_unchecked(mmr: Mmr) -> Self

pub fn num_blocks(&self) -> u32

pub fn chain_tip(&self) -> Option<BlockNumber>

pub fn commitment(&self) -> Digest

pub fn peaks(&self) -> MmrPeaks

pub fn peaks_at(&self, checkpoint: BlockNumber) -> Result<MmrPeaks, MmrError>

§Errors

pub fn open(&self, block: BlockNumber) -> Result<MmrProof, MmrError>

§Errors

pub fn open_at( &self, block: BlockNumber, checkpoint: BlockNumber, ) -> Result<MmrProof, MmrError>

§Errors

pub fn as_mmr(&self) -> &Mmr

pub fn partial_mmr_from_blocks( &self, blocks: &BTreeSet<BlockNumber>, checkpoint: BlockNumber, ) -> Result<PartialMmr, MmrError>

§Errors

pub fn push(&mut self, block_commitment: Digest)

Trait Implementations§

impl Clone for Blockchain

fn clone(&self) -> Blockchain

fn clone_from(&mut self, source: &Self)

impl Debug for Blockchain

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Default for Blockchain

fn default() -> Self

Auto Trait Implementations§

impl Freeze for Blockchain

impl RefUnwindSafe for Blockchain

impl Send for Blockchain

impl Sync for Blockchain

impl Unpin for Blockchain

impl UnwindSafe for Blockchain

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Struct Blockchain

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,