Crate commit_verify

Modules

merkle

mpc

Multi-protocol commitments according to LNPBP-4 standard.

strategies

Strategies simplifying implementation of CommitEncode trait.

Macros

commit_encode_list

Convenience macro for commit-encoding list of the data

Structs

Sha256

Engine to compute SHA256 hash function.

StrictEncodedProtocol

Commitment protocol which writes strict-encoded data into a hasher.

UntaggedProtocol

Protocol defining commits created by using externally created hash value *optionally pretagged).

Constants

LIB_NAME_COMMIT_VERIFY

Traits

CommitEncode

Prepares the data to the consensus commit procedure by first running necessary conceal and merklization procedures, and them performing strict encoding for the resulted data.

CommitStrategy

Marker trait defining specific encoding strategy which should be used for automatic implementation of CommitEncode.

CommitVerify

Trait for commit-verify scheme. A message for the commitment may be any structure that can be represented as a byte array (i.e. implements AsRef<[u8]>).

CommitmentId

High-level API used in client-side validation for producing a single commitment to the data, which includes running all necessary procedures like concealment with [CommitConceal], merklization, strict encoding, wrapped into CommitEncode, followed by the actual commitment to its output.

CommitmentProtocol

Marker trait for specific commitment protocols.

Conceal

Trait that should perform conversion of a given client-side-validated data type into a concealed (private) form, for instance hiding some of the data behind hashed - or homomorphically-encrypted version.

ConvolveCommit

Trait for convolve-commit-verify scheme, where some data structure (named container) may commit to existing message using supplement and producing final commitment value. The commitment can’t be used to restore original message, however the fact of the commitment may be deterministically verified when the message and the supplement (now acting as a proof) proof are revealed.

ConvolveCommitProof

Proof type used by ConvolveCommit protocol.

EmbedCommitProof

Proofs produced by EmbedCommitVerify::embed_commit procedure.

EmbedCommitVerify

Trait for embed-commit-verify scheme, where some data structure (named container) may commit to existing message (producing commitment data structure and a proof) in such way that the original message can’t be restored from the commitment, however the fact of the commitment may be deterministically verified when the message and the proof are revealed.

TryCommitVerify

Trait for a failable version of commit-verify scheme. A message for the commitment may be any structure that can be represented as a byte array (i.e. implements AsRef<[u8]>).

VerifyEq

Trait for equivalence verification. Implemented for all types implemeting Eq. For non-Eq types this trait provides way to implement custom equivalence verification used during commitment verification procedure.