Module commit_verify::lnpbp4

Multi-message commitments: implementation of LNPBP-4 standard.

LNPBP-4 defines a commit-verify scheme for committing to a multiple messages under distinct protocols with ability to partially reveal set of the commitments and still be able to prove the commitment for each message without exposing the exact number of other messages and their respective protocol identifiers.

LBPBP-4 commitments are originally constructed from MultiSource data structure in form of full LNPBP-4 merkle trees MerkleTree using MerkleTree::try_commit method. Full trees preserve all the information from the MultiSource, plus keep information on generated entropy and the actual size of the created tree.

MerkleTree can than be either converted into MerkleBlock and than a separate instances of MerkleProofs can be extracted from it for each specific protocol using MerkleBlock::conceal_except operation. MerkleBlock can conceal sme data and can also be constructed from (multiple) MerkleProof and/or other MerkleBlock.

Summary of the operations with LNPBP-4 data structures:

• MerkleTree::try_commit: MultiSource -> MerkleTree
• MerkleBlock::from: MerkleTree -> Self
• MerkleBlock::into_merkle_proof: Self, ProtocolId -> MerkleProof
• MerkleBlock::with: MerkleProof, ProtocolId, Message -> Self
• MerkleBlock::merge_reveal: Self, MerkleProof -> Self

Structs

CommitmentHash

Final LNPBP-4 commitment value.

LeafNotKnown

commitment under protocol id {_0} is absent from the known part of a given LNPBP-4 Merkle block.

Lnpbp4Tag

Tag used for CommitmentHash hash type

MerkleBlock

Partially-concealed merkle tree data.

MerkleProof

A proof of the merkle commitment.

MerkleTree

Complete information about LNPBP-4 merkle tree.

MessageIter

Iterator over messages in MerkleTree and MerkleBlock.

MultiSource

Structured source multi-message data for commitment creation

UnrelatedProof

attempt to merge unrelated LNPBP-4 proof.

Enums

Error

Errors generated during multi-message commitment process by MerkleTree::try_commit

Constants

MAX_TREE_DEPTH

Maximal depth of LNPBP-4 commitment tree.

Traits

Proof

Marker trait for variates of LNPBP-4 commitment proofs, which differ by the amount of concealed information.

Type Definitions

Message

Original message participating in multi-message commitment.

MessageMap

Map from protocol ids to commitment messages.

ProtocolId

Source data for creation of multi-message commitments according to LNPBP-4 procedure.