Struct Commitment 

pub struct Commitment(/* private fields */);

Final LNPBP-4 commitment value.

Represents tagged hash of the merkle root of super::MerkleTree and super::MerkleBlock.

Implementations

impl Commitment

pub fn copy_from_slice(slice: &[u8]) -> Result<Commitment, FromSliceError>

Methods from Deref<Target = Array<u8, 32>>

pub fn as_slice(&self) -> &[T]

Returns byte slice representation.

pub fn to_vec(&self) -> Vec<T>

where T: Clone,

Returns vector representing internal slice data

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the array items.

The iterator yields all items from start to end.

pub fn to_byte_array(&self) -> [u8; LEN]

Returns a byte array representation stored in the wrapped type.

Trait Implementations

impl AsRef<Array<u8, 32>> for Commitment

fn as_ref(&self) -> &Array<u8, 32>

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for Commitment

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Borrow<Array<u8, 32>> for Commitment

fn borrow(&self) -> &Array<u8, 32>

Immutably borrows from an owned value.

impl Clone for Commitment

fn clone(&self) -> Commitment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitmentId for Commitment

const TAG: &'static str = "urn:ubideco:mpc:commitment#2024-01-31"

impl ConvolveCommit<Commitment, TapretProof, TapretFirst> for ScriptBuf

type Commitment = ScriptBuf

Commitment type produced as a result of Self::convolve_commit procedure.

type CommitError = TapretKeyError

Error type that may be reported during Self::convolve_commit procedure. It may also be returned from ConvolveCommitProof::verify in case the proof data are invalid and the commitment can’t be re-created.

fn convolve_commit( &self, supplement: &TapretProof, msg: &Commitment, ) -> Result<(ScriptBuf, TapretProof), <ScriptBuf as ConvolveCommit<Commitment, TapretProof, TapretFirst>>::CommitError>

Takes the supplement to unparse the content of this container (self) (“convolves” these two data together) and uses them to produce a final Self::Commitment to the message msg.

impl ConvolveCommit<Commitment, TapretProof, TapretFirst> for Transaction

type Commitment = Transaction

Commitment type produced as a result of Self::convolve_commit procedure.

type CommitError = TapretError

Error type that may be reported during Self::convolve_commit procedure. It may also be returned from ConvolveCommitProof::verify in case the proof data are invalid and the commitment can’t be re-created.

fn convolve_commit( &self, supplement: &TapretProof, msg: &Commitment, ) -> Result<(Transaction, TapretProof), <Transaction as ConvolveCommit<Commitment, TapretProof, TapretFirst>>::CommitError>

Takes the supplement to unparse the content of this container (self) (“convolves” these two data together) and uses them to produce a final Self::Commitment to the message msg.

impl ConvolveCommit<Commitment, TapretProof, TapretFirst> for TxOut

type Commitment = TxOut

Commitment type produced as a result of Self::convolve_commit procedure.

type CommitError = TapretKeyError

Error type that may be reported during Self::convolve_commit procedure. It may also be returned from ConvolveCommitProof::verify in case the proof data are invalid and the commitment can’t be re-created.

fn convolve_commit( &self, supplement: &TapretProof, msg: &Commitment, ) -> Result<(TxOut, TapretProof), <TxOut as ConvolveCommit<Commitment, TapretProof, TapretFirst>>::CommitError>

Takes the supplement to unparse the content of this container (self) (“convolves” these two data together) and uses them to produce a final Self::Commitment to the message msg.

impl ConvolveCommit<Commitment, TapretProof, TapretFirst> for XOnlyPublicKey

type Commitment = TweakedPublicKey

Commitment type produced as a result of Self::convolve_commit procedure.

type CommitError = TapretKeyError

Error type that may be reported during Self::convolve_commit procedure. It may also be returned from ConvolveCommitProof::verify in case the proof data are invalid and the commitment can’t be re-created.

fn convolve_commit( &self, supplement: &TapretPathProof, msg: &Commitment, ) -> Result<(TweakedPublicKey, TapretProof), <XOnlyPublicKey as ConvolveCommit<Commitment, TapretProof, TapretFirst>>::CommitError>

Takes the supplement to unparse the content of this container (self) (“convolves” these two data together) and uses them to produce a final Self::Commitment to the message msg.

impl ConvolveCommitProof<Commitment, ScriptBuf, TapretFirst> for TapretProof

type Suppl = TapretProof

Supplement is a part of the proof data provided during commitment procedure.

fn restore_original(&self, _: &ScriptBuf) -> ScriptBuf

Restores the original source before the commitment from the supplement (the self) and commitment.

fn extract_supplement( &self, ) -> &<TapretProof as ConvolveCommitProof<Commitment, ScriptBuf, TapretFirst>>::Suppl

Extract supplement from the proof.

fn verify( &self, msg: &Msg, commitment: &<Source as ConvolveCommit<Msg, Self, Protocol>>::Commitment, ) -> Result<(), ConvolveVerifyError>

where Self: VerifyEq,

Verifies commitment using proof (the self) against the message.

impl ConvolveCommitProof<Commitment, Transaction, TapretFirst> for TapretProof

type Suppl = TapretProof

Supplement is a part of the proof data provided during commitment procedure.

fn restore_original(&self, commitment: &Transaction) -> Transaction

Restores the original source before the commitment from the supplement (the self) and commitment.

fn extract_supplement( &self, ) -> &<TapretProof as ConvolveCommitProof<Commitment, Transaction, TapretFirst>>::Suppl

Extract supplement from the proof.

fn verify( &self, msg: &Msg, commitment: &<Source as ConvolveCommit<Msg, Self, Protocol>>::Commitment, ) -> Result<(), ConvolveVerifyError>

where Self: VerifyEq,

Verifies commitment using proof (the self) against the message.

impl ConvolveCommitProof<Commitment, TxOut, TapretFirst> for TapretProof

type Suppl = TapretProof

Supplement is a part of the proof data provided during commitment procedure.

fn restore_original(&self, commitment: &TxOut) -> TxOut

Restores the original source before the commitment from the supplement (the self) and commitment.

fn extract_supplement( &self, ) -> &<TapretProof as ConvolveCommitProof<Commitment, TxOut, TapretFirst>>::Suppl

Extract supplement from the proof.

fn verify( &self, msg: &Msg, commitment: &<Source as ConvolveCommit<Msg, Self, Protocol>>::Commitment, ) -> Result<(), ConvolveVerifyError>

where Self: VerifyEq,

Verifies commitment using proof (the self) against the message.

impl ConvolveCommitProof<Commitment, XOnlyPublicKey, TapretFirst> for TapretProof

type Suppl = TapretPathProof

Supplement is a part of the proof data provided during commitment procedure.

fn restore_original(&self, _: &TweakedPublicKey) -> XOnlyPublicKey

Restores the original source before the commitment from the supplement (the self) and commitment.

fn extract_supplement( &self, ) -> &<TapretProof as ConvolveCommitProof<Commitment, XOnlyPublicKey, TapretFirst>>::Suppl

Extract supplement from the proof.

fn verify( &self, msg: &Msg, commitment: &<Source as ConvolveCommit<Msg, Self, Protocol>>::Commitment, ) -> Result<(), ConvolveVerifyError>

where Self: VerifyEq,

Verifies commitment using proof (the self) against the message.

impl Debug for Commitment

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

Formats the value using the given formatter.

impl Deref for Commitment

type Target = Array<u8, 32>

The resulting type after dereferencing.

fn deref(&self) -> &<Commitment as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Commitment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Commitment

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

Formats the value using the given formatter.

impl EmbedCommitProof<Commitment, ScriptBuf, OpretFirst> for OpretProof

fn restore_original_container( &self, commit_container: &ScriptBuf, ) -> Result<ScriptBuf, EmbedVerifyError<OpretError>>

Restores original container before the commitment from the proof data and a container containing embedded commitment.

impl EmbedCommitProof<Commitment, Transaction, OpretFirst> for OpretProof

fn restore_original_container( &self, commit_container: &Transaction, ) -> Result<Transaction, EmbedVerifyError<OpretError>>

Restores original container before the commitment from the proof data and a container containing embedded commitment.

impl EmbedCommitProof<Commitment, TxOut, OpretFirst> for OpretProof

fn restore_original_container( &self, commit_container: &TxOut, ) -> Result<TxOut, EmbedVerifyError<OpretError>>

Restores original container before the commitment from the proof data and a container containing embedded commitment.

impl EmbedCommitVerify<Commitment, OpretFirst> for ScriptBuf

type Proof = OpretProof

The proof of the commitment produced as a result of Self::embed_commit procedure. This proof is later used for verification.

type CommitError = OpretError

Error type that may be reported during Self::embed_commit procedure. It may also be returned from Self::verify (wrapped into EmbedVerifyError in case the proof data are invalid and the commitment can’t be re-created.

fn embed_commit( &mut self, msg: &Commitment, ) -> Result<<ScriptBuf as EmbedCommitVerify<Commitment, OpretFirst>>::Proof, <ScriptBuf as EmbedCommitVerify<Commitment, OpretFirst>>::CommitError>

Creates a commitment to a message and embeds it into the provided container (self) by mutating it and returning commitment proof.

fn verify( &self, msg: &Msg, proof: &Self::Proof, ) -> Result<(), EmbedVerifyError<Self::CommitError>>

where Self: VerifyEq, Self::Proof: VerifyEq,

Verifies commitment with commitment proof against the message.

impl EmbedCommitVerify<Commitment, OpretFirst> for Transaction

type Proof = OpretProof

The proof of the commitment produced as a result of Self::embed_commit procedure. This proof is later used for verification.

type CommitError = OpretError

Error type that may be reported during Self::embed_commit procedure. It may also be returned from Self::verify (wrapped into EmbedVerifyError in case the proof data are invalid and the commitment can’t be re-created.

fn embed_commit( &mut self, msg: &Commitment, ) -> Result<<Transaction as EmbedCommitVerify<Commitment, OpretFirst>>::Proof, <Transaction as EmbedCommitVerify<Commitment, OpretFirst>>::CommitError>

Creates a commitment to a message and embeds it into the provided container (self) by mutating it and returning commitment proof.

fn verify( &self, msg: &Msg, proof: &Self::Proof, ) -> Result<(), EmbedVerifyError<Self::CommitError>>

where Self: VerifyEq, Self::Proof: VerifyEq,

Verifies commitment with commitment proof against the message.

impl EmbedCommitVerify<Commitment, OpretFirst> for TxOut

type Proof = OpretProof

The proof of the commitment produced as a result of Self::embed_commit procedure. This proof is later used for verification.

type CommitError = OpretError

Error type that may be reported during Self::embed_commit procedure. It may also be returned from Self::verify (wrapped into EmbedVerifyError in case the proof data are invalid and the commitment can’t be re-created.

fn embed_commit( &mut self, msg: &Commitment, ) -> Result<<TxOut as EmbedCommitVerify<Commitment, OpretFirst>>::Proof, <TxOut as EmbedCommitVerify<Commitment, OpretFirst>>::CommitError>

Creates a commitment to a message and embeds it into the provided container (self) by mutating it and returning commitment proof.

fn verify( &self, msg: &Msg, proof: &Self::Proof, ) -> Result<(), EmbedVerifyError<Self::CommitError>>

where Self: VerifyEq, Self::Proof: VerifyEq,

Verifies commitment with commitment proof against the message.

impl From<[u8; 32]> for Commitment

fn from(v: [u8; 32]) -> Commitment

Converts to this type from the input type.

impl From<Array<u8, 32>> for Commitment

fn from(v: Array<u8, 32>) -> Commitment

Converts to this type from the input type.

impl From<Commitment> for Array<u8, 32>

fn from(wrapped: Commitment) -> Array<u8, 32>

Converts to this type from the input type.

impl FromHex for Commitment

fn from_byte_iter<I>(iter: I) -> Result<Commitment, Error>

where I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produce an object from a byte iterator

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string

impl FromStr for Commitment

type Err = <<Commitment as Wrapper>::Inner as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Commitment, <Commitment as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Commitment

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

where __H: Hasher,

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 Index<Range<usize>> for Commitment

type Output = <Array<u8, 32> as Index<Range<usize>>>::Output

The returned type after indexing.

fn index( &self, index: Range<usize>, ) -> &<Commitment as Index<Range<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Commitment

type Output = <Array<u8, 32> as Index<RangeFrom<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeFrom<usize>, ) -> &<Commitment as Index<RangeFrom<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Commitment

type Output = <Array<u8, 32> as Index<RangeFull>>::Output

The returned type after indexing.

fn index(&self, index: RangeFull) -> &<Commitment as Index<RangeFull>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for Commitment

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeInclusive<usize>, ) -> &<Commitment as Index<RangeInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Commitment

type Output = <Array<u8, 32> as Index<RangeTo<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeTo<usize>, ) -> &<Commitment as Index<RangeTo<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for Commitment

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeToInclusive<usize>, ) -> &<Commitment as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Commitment

type Output = <Array<u8, 32> as Index<usize>>::Output

The returned type after indexing.

fn index(&self, index: usize) -> &<Commitment as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for Commitment

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

Formats the value using the given formatter.

impl Ord for Commitment

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Commitment

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Commitment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Commitment

fn strict_decode(reader: &mut impl TypedRead) -> Result<Commitment, DecodeError>

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

impl StrictDumb for Commitment

fn strict_dumb() -> Commitment

impl StrictEncode for Commitment

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

where W: TypedWrite,

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

impl StrictTuple for Commitment

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Commitment

const STRICT_LIB_NAME: &'static str = LIB_NAME_COMMIT_VERIFY

fn strict_name() -> Option<TypeName>

impl UpperHex for Commitment

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

Formats the value using the given formatter.

impl Wrapper for Commitment

type Inner = Array<u8, 32>

Inner type wrapped by the current newtype

fn from_inner(inner: <Commitment as Wrapper>::Inner) -> Commitment

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<Commitment as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <Commitment as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl Copy for Commitment

impl Eq for Commitment

impl StrictProduct for Commitment

impl StructuralPartialEq for Commitment