Struct ProvenBlock

pub struct ProvenBlock { /* private fields */ }

A block in the Miden chain.

A block is built from batches of transactions, i.e. multiple ProvenBatches, and each batch contains multiple ProvenTransactions.

It consists of the following components:

• A BlockHeader committing to the current state of the chain and against which account, note or nullifier inclusion or absence can be proven. See its documentation for details on what it commits to. Eventually, it will also contain a ZK proof of the validity of the block.
• A list of account updates for all accounts updated in this block. For private accounts, the update contains only the new account state commitments while for public accounts, the update also includes the delta which can be applied to the previous account state to get the new account state.
• A list of new notes created in this block. For private notes, the block contains only note IDs and note metadata while for public notes the full note details are included.
• A list of new nullifiers created for all notes that were consumed in the block.
• A list of transaction headers that were included in the block.

Implementations

impl ProvenBlock

pub fn new_unchecked( header: BlockHeader, updated_accounts: Vec<BlockAccountUpdate>, output_note_batches: Vec<OutputNoteBatch>, created_nullifiers: Vec<Nullifier>, transactions: OrderedTransactionHeaders, ) -> Self

Returns a new ProvenBlock instantiated from the provided components.

Warning

This constructor does not do any validation, so passing incorrect values may lead to later panics.

pub fn commitment(&self) -> Digest

Returns the commitment to this block.

pub fn header(&self) -> &BlockHeader

Returns the header of this block.

pub fn updated_accounts(&self) -> &[BlockAccountUpdate]

Returns the slice of BlockAccountUpdates for all accounts updated in this block.

pub fn output_note_batches(&self) -> &[OutputNoteBatch]

Returns the slice of OutputNoteBatches for all output notes created in this block.

pub fn proof_security_level(&self) -> u32

Returns the proof security level of the block.

pub fn output_notes( &self, ) -> impl Iterator<Item = (BlockNoteIndex, &OutputNote)>

Returns an iterator over all OutputNotes created in this block.

Each note is accompanied by a corresponding index specifying where the note is located in the block’s BlockNoteTree.

pub fn build_output_note_tree(&self) -> BlockNoteTree

Returns the BlockNoteTree containing all OutputNotes created in this block.

pub fn created_nullifiers(&self) -> &[Nullifier]

Returns a reference to the slice of nullifiers for all notes consumed in the block.

pub fn transactions(&self) -> &OrderedTransactionHeaders

Returns the OrderedTransactionHeaders of all transactions included in this block.

Trait Implementations

impl Clone for ProvenBlock

fn clone(&self) -> ProvenBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProvenBlock

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

Formats the value using the given formatter.

impl Deserializable for ProvenBlock

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for ProvenBlock

fn eq(&self, other: &ProvenBlock) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for ProvenBlock

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for ProvenBlock

impl StructuralPartialEq for ProvenBlock