Struct MerkleBlock

pub struct MerkleBlock { /* private fields */ }

Partially-concealed merkle tree data.

Implementations

impl MerkleBlock

pub fn method(&self) -> Method

Method returning copy of MerkleBlock::method field. Method used to construct MPC proof (hash function, merklization).

pub fn depth(&self) -> u5

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

pub fn cofactor(&self) -> u16

Method returning copy of MerkleBlock::cofactor field. Cofactor is used as an additive to the modulo divisor to improve packing

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

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

impl MerkleBlock

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

Constructs merkle block from a merkle proof

pub fn conceal_other( &mut self, protocol: ProtocolId, ) -> Result<(), LeafNotKnown>

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

Error

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

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, MergeError>

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

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

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 the given protocol_id for the current Merkle block.

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

Computes position for a given protocol_id within the tree leaves.

pub fn width_limit(&self) -> u32

Computes the maximum possible width of the merkle tree.

pub fn factored_width(&self) -> u32

Computes the factored width of the merkle tree according to the formula 2 ^ depth - cofactor.

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

Get an iterator over the known protocol ids present in the MPC Merkle block.

pub fn to_known_message_map(&self) -> MessageMap

Constructs MessageMap for revealed protocols and messages.

pub fn into_known_proofs( self, ) -> impl Iterator<Item = (ProtocolId, MerkleProof)>

Convert this MPC Merkle block into an iterator over items and proofs of their inclusion.

Trait Implementations

impl Clone for MerkleBlock

fn clone(&self) -> MerkleBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitEncode for MerkleBlock

type CommitmentId = Commitment

Type of the resulting commitment.

fn commit_encode(&self, engine: &mut CommitEngine)

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

impl Conceal for MerkleBlock

fn conceal(&self) -> Self::Concealed

Reduces merkle tree into merkle tree root.

type Concealed = MerkleConcealed

The resulting confidential type concealing original data.

impl Debug for MerkleBlock

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

Formats the value using the given formatter.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MerkleBlock

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

fn matches(&self, other: &Self) -> bool

Verifies whether one MPC proof matches another MPC proof.

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(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDeserialize for MerkleBlock

fn from_strict_serialized<const MAX: usize>( ast_data: Confined<Vec<u8>, 0, MAX>, ) -> Result<Self, DeserializeError>

fn strict_deserialize<const MAX: usize>( read: impl Read, ) -> Result<Self, DeserializeError>

fn strict_deserialize_from_file<const MAX: usize>( path: impl AsRef<Path>, ) -> Result<Self, DeserializeError>

impl StrictDumb for MerkleBlock

fn strict_dumb() -> Self

impl StrictEncode for MerkleBlock

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSerialize for MerkleBlock

fn strict_serialized_len<const MAX: usize>(&self) -> Result<usize, Error>

fn to_strict_serialized<const MAX: usize>( &self, ) -> Result<Confined<Vec<u8>, 0, MAX>, SerializeError>

fn strict_serialize<const MAX: usize>( &self, write: impl Write, ) -> Result<(), Error>

fn strict_serialize_to_file<const MAX: usize>( &self, path: impl AsRef<Path>, ) -> Result<(), SerializeError>

impl StrictStruct for MerkleBlock

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for MerkleBlock

const STRICT_LIB_NAME: &'static str = LIB_NAME_COMMIT_VERIFY

fn strict_name() -> Option<TypeName>

impl Eq for MerkleBlock

impl StrictProduct for MerkleBlock

impl StructuralPartialEq for MerkleBlock