Struct lnpbp::dbc::lockscript::LockscriptCommitment

pub struct LockscriptCommitment(_);

LockScript containing public keys which sum is commit to some message according to LNPBP-2

Trait Implementations

impl AsMut<<LockscriptCommitment as Wrapper>::Inner> for LockscriptCommitment

pub fn as_mut(&mut self) -> &mut Self::Inner

Performs the conversion.

impl AsRef<<LockscriptCommitment as Wrapper>::Inner> for LockscriptCommitment

pub fn as_ref(&self) -> &Self::Inner

Performs the conversion.

impl Borrow<<LockscriptCommitment as Wrapper>::Inner> for LockscriptCommitment

pub fn borrow(&self) -> &Self::Inner

Immutably borrows from an owned value.

impl BorrowMut<<LockscriptCommitment as Wrapper>::Inner> for LockscriptCommitment

pub fn borrow_mut(&mut self) -> &mut Self::Inner

Mutably borrows from an owned value.

impl Clone for LockscriptCommitment

pub fn clone(&self) -> LockscriptCommitment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LockscriptCommitment

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

Formats the value using the given formatter.

impl Default for LockscriptCommitment

pub fn default() -> LockscriptCommitment

Returns the "default value" for a type.

impl Deref for LockscriptCommitment

type Target = Self::Inner

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for LockscriptCommitment

pub fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for LockscriptCommitment

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

Formats the value using the given formatter.

impl<MSG> EmbedCommitVerify<MSG> for LockscriptCommitment where
    MSG: AsRef<[u8]>, 

type Container = LockscriptContainer

External container type that will be used to host commitment to a message

type Error = Error

Error type that may be reported during [commit_embed] procedure

pub fn embed_commit(
    container: &mut Self::Container,
    msg: &MSG
) -> Result<Self, Self::Error>

Function implements commitment procedure according to LNPBP-2.

LNPBP-2 Specification extract:

1. The provided script MUST be parsed with Miniscript parser; if the parser fails the procedure MUST fail.
2. Iterate over all branches of the abstract syntax tree generated by the Miniscript parser, running the following algorithm for each node:
   • if a public key hash is met (pk_h Miniscript command) and it can't be resolved against known public keys or other public keys extracted from the script, fail the procedure;
   • if a public key is found (pk) add it to the list of the collected public keys;
   • for all other types of Miniscript commands iterate over their branches.
3. Select unique public keys (i.e. if some public key is repeated in different parts of the script/in different script branches, pick a single instance of it). Compressed and uncompressed versions of the same public key must be treaded as the same public key under this procedure.
4. If no public keys were found fail the procedure; return the collected keys otherwise.

NB: SUBJECT TO CHANGE UPON RELEASE By "miniscript" we mean usage of rust-miniscript library at commit a5ba1219feb8b5a289c8f12176d632635eb8a959 which may be found on https://github.com/LNP-BP/rust-miniscript/commit/a5ba1219feb8b5a289c8f12176d632635eb8a959

pub fn verify(
    &self,
    container: &Self::Container,
    msg: &MSG
) -> Result<bool, Self::Error>

Verifies commitment against the message; default implementation just reconstructs the original container with [container] function, repeats the commitment to the message and check it against the self.

impl Eq for LockscriptCommitment

impl From<LockScript> for LockscriptCommitment

pub fn from(v: LockScript) -> Self

Performs the conversion.

impl Hash for LockscriptCommitment

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for LockscriptCommitment

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

Formats the value using the given formatter.

impl Ord for LockscriptCommitment

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<LockscriptCommitment> for LockscriptCommitment

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

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

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

This method tests for !=.

impl PartialOrd<LockscriptCommitment> for LockscriptCommitment

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for LockscriptCommitment

impl StructuralPartialEq for LockscriptCommitment

impl UpperHex for LockscriptCommitment

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

Formats the value using the given formatter.

impl Wrapper for LockscriptCommitment

type Inner = LockScript

Inner type wrapped by the current newtype

pub fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

pub fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

pub fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

pub fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

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

Clones inner data of the wrapped type and return them