Struct PartialBlockchain 

pub struct PartialBlockchain { /* private fields */ }

A partial view into the full Blockchain’s Merkle Mountain Range (MMR).

It allows for efficient authentication of input notes during transaction execution or authentication of reference blocks during batch or block execution. Authentication is achieved by providing inclusion proofs for the notes consumed in the transaction against the partial blockchain root associated with the transaction’s reference block.

PartialBlockchain contains authentication paths for a limited set of blocks. The intent is to include only the blocks relevant for execution:

• For transactions: the set of blocks in which all input notes were created.
• For batches: the set of reference blocks of all transactions in the batch and the blocks to prove any unauthenticated note’s inclusion.
• For blocks: the set of reference blocks of all batches in the block and the blocks to prove any unauthenticated note’s inclusion.

Guarantees

The PartialBlockchain contains the full authenticated BlockHeaders of all blocks it tracks in its partial MMR and users of this type can make this assumption. This is ensured when using PartialBlockchain::new. PartialBlockchain::new_unchecked should only be used whenever this guarantee can be upheld.

Implementations

impl PartialBlockchain

pub fn new( mmr: PartialMmr, blocks: impl IntoIterator<Item = BlockHeader>, ) -> Result<Self, PartialBlockchainError>

Returns a new PartialBlockchain instantiated from the provided partial MMR and a list of block headers.

Errors

Returns an error if:

• block_num for any of the blocks is greater than the chain length implied by the provided partial MMR.
• The same block appears more than once in the provided list of block headers.
• The partial MMR does not track authentication paths for any of the specified blocks.
• Any of the provided block header’s commitment is not tracked in the MMR, i.e. its inclusion cannot be verified.

pub fn new_unchecked( mmr: PartialMmr, blocks: impl IntoIterator<Item = BlockHeader>, ) -> Result<Self, PartialBlockchainError>

Returns a new PartialBlockchain instantiated from the provided partial MMR and a list of block headers.

Warning

This does not verify that the provided block commitments are in the MMR. Use Self::new to run this verification. This constructor is provided to bypass this check in trusted environment because it is relatively expensive.

Errors

Returns an error if:

• block_num for any of the blocks is greater than the chain length implied by the provided partial MMR.
• The same block appears more than once in the provided list of block headers.
• The partial MMR does not track authentication paths for any of the specified blocks.

pub fn mmr(&self) -> &PartialMmr

Returns the underlying PartialMmr.

pub fn peaks(&self) -> MmrPeaks

Returns peaks of this MMR.

pub fn chain_length(&self) -> BlockNumber

Returns total number of blocks contain in the chain described by this MMR.

pub fn num_tracked_blocks(&self) -> usize

Returns the number of blocks tracked by this partial blockchain.

pub fn contains_block(&self, block_num: BlockNumber) -> bool

Returns true if a block with the given number is present in this partial blockchain.

Note that this only checks whether an entry with the block’s number exists in the MMR.

pub fn get_block(&self, block_num: BlockNumber) -> Option<&BlockHeader>

Returns the block header for the specified block, or None if the block is not present in this partial blockchain.

pub fn block_headers(&self) -> impl Iterator<Item = &BlockHeader>

Returns an iterator over the block headers in this partial blockchain.

pub fn add_block(&mut self, block_header: BlockHeader, track: bool)

Appends the provided block header to this partial blockchain. This method assumes that the provided block header is for the next block in the chain.

If track parameter is set to true, the authentication path for the provided block header will be added to this partial blockchain.

Panics

Panics if the block_header.block_num is not equal to the current chain length (i.e., the provided block header is not the next block in the chain).

pub fn prune_to(&mut self, to: RangeTo<BlockNumber>)

Drop every block header whose number is strictly less than to.end.

After the call, all such headers are removed, and each pruned header’s path is untrack‑ed from the internal PartialMmr, eliminating local authentication data for those leaves while leaving the MMR root commitment unchanged.

pub fn remove(&mut self, block_num: BlockNumber)

Removes a single block header and the associated authentication path from this PartialBlockchain.

This does not change the commitment to the underlying MMR, but the current partial MMR will no longer track the removed data.

pub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_

Returns an iterator over the inner nodes of authentication paths contained in this chain MMR.

Trait Implementations

impl Clone for PartialBlockchain

fn clone(&self) -> PartialBlockchain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialBlockchain

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

Formats the value using the given formatter.

impl Default for PartialBlockchain

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for PartialBlockchain

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 PartialBlockchain

fn eq(&self, other: &PartialBlockchain) -> 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 PartialBlockchain

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 PartialBlockchain

impl StructuralPartialEq for PartialBlockchain