Struct commit_verify::lnpbp4::MerkleBlock

pub struct MerkleBlock { /* private fields */ }

Partially-concealed merkle tree data.

Implementations

impl MerkleBlock

pub fn depth(&self) -> u8

Method returning copy of MerkleBlock::depth field. Tree depth (up to 16).

pub fn entropy(&self) -> Option<u64>

Method returning copy of MerkleBlock::entropy field. Entropy used for placeholders. May be unknown if the message is not

impl MerkleBlock

pub fn with(
    proof: &MerkleProof,
    protocol_id: ProtocolId,
    message: Message
) -> Result<Self, UnrelatedProof>

Constructs merkle block from a merkle proof

pub fn conceal_except(
    &mut self,
    protocols: impl AsRef<[ProtocolId]>
) -> Result<usize, LeafNotKnown>

Conceals all commitments in the block except for the commitment under given protocol_ids. Also removes information about the entropy value used.

Returns

Number of concealed nodes.

Error

If leaf with the given protocol_id is not found (absent or already concealed), errors with LeafNotKnown error.

pub fn merge_reveal_path(
    &mut self,
    proof: &MerkleProof,
    protocol_id: ProtocolId,
    message: Message
) -> Result<u16, UnrelatedProof>

Merges information from the given proof to the merkle block, revealing path related to te commitment to the message under the given protocol_id.

pub fn merge_reveal(
    &mut self,
    other: MerkleBlock
) -> Result<u16, UnrelatedProof>

Merges two merkle blocks together, joining revealed information from each one of them.

pub fn into_merkle_proof(
    self,
    protocol_id: ProtocolId
) -> Result<MerkleProof, LeafNotKnown>

Converts the merkle block into a merkle proof for the inclusion of a commitment under given protocol_id.

pub fn to_merkle_proof(
    &self,
    protocol_id: ProtocolId
) -> Result<MerkleProof, LeafNotKnown>

Constructs merkle proof for the inclusion of a commitment under given protocol_id for the current Merkle block.

pub fn protocol_id_pos(&self, protocol_id: ProtocolId) -> u16

Computes position for a given protocol_id within the tree leaves.

pub fn width(&self) -> usize

Computes the width of the merkle tree.

Trait Implementations

impl Clone for MerkleBlock

fn clone(&self) -> MerkleBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitConceal for MerkleBlock

fn commit_conceal(&self) -> Self::ConcealedCommitment

Reduces merkle tree into merkle tree root.

type ConcealedCommitment = MerkleNode

The resulting confidential type concealing and committing to the original data

impl CommitEncode for MerkleBlock

fn commit_encode<E: Write>(&self, e: E) -> usize

Encodes the data for the commitment by writing them directly into a io::Write writer instance

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

Serializes data for the commitment in-memory into a newly allocated array

impl ConsensusCommit for MerkleBlock

type Commitment = CommitmentHash

Type of the resulting commitment

fn consensus_commit(&self) -> Self::Commitment

Performs commitment to client-side-validated data

fn consensus_verify(&self, commitment: &Self::Commitment) -> bool

Verifies commitment to client-side-validated data

impl Debug for MerkleBlock

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

Formats the value using the given formatter.

impl Default for MerkleBlock

fn default() -> MerkleBlock

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MerkleBlock

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<&'_ MerkleTree> for MerkleBlock

fn from(tree: &MerkleTree) -> Self

Converts to this type from the input type.

impl From<MerkleTree> for MerkleBlock

fn from(tree: MerkleTree) -> Self

Converts to this type from the input type.

impl Hash for MerkleBlock

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for &MerkleBlock

type Item = Hash

The type of the elements being iterated over.

type IntoIter = MessageIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for MerkleBlock

fn cmp(&self, other: &MerkleBlock) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MerkleBlock> for MerkleBlock

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<MerkleBlock> for MerkleBlock

fn partial_cmp(&self, other: &MerkleBlock) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MerkleBlock

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StrictDecode for MerkleBlock

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode

impl StrictEncode for MerkleBlock

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

impl Eq for MerkleBlock

impl Proof for MerkleBlock

impl StructuralEq for MerkleBlock

impl StructuralPartialEq for MerkleBlock