Struct dbc::anchor::Anchor

pub struct Anchor<L: Proof> {
    pub txid: Txid,
    pub lnpbp4_proof: L,
    pub dbc_proof: Proof,
}

Anchor is a data structure used in deterministic bitcoin commitments for keeping information about the proof of the commitment in connection to the transaction which contains the commitment, and multi-protocol merkle tree as defined by LNPBP-4.

Fields

txid: Txid

Transaction containing deterministic bitcoin commitment.

lnpbp4_proof: L

Structured multi-protocol LNPBP-4 data the transaction commits to.

dbc_proof: Proof

Proof of the DBC commitment.

Implementations

impl Anchor<MerkleBlock>

pub fn anchor_id(&self) -> AnchorId

Returns id of the anchor (commitment hash).

impl Anchor<MerkleProof>

pub fn verify(
    &self,
    protocol_id: ProtocolId,
    message: Message,
    tx: Transaction
) -> Result<bool, VerifyError>

Verifies that the transaction commits to the anchor and the anchor commits to the given message under the given protocol.

pub fn convolve(
    &self,
    protocol_id: ProtocolId,
    message: Message
) -> Result<CommitmentHash, UnrelatedProof>

Verifies that the anchor commits to the given message under the given protocol.

impl Anchor<MerkleBlock>

pub fn into_merkle_proof(
    self,
    protocol: impl Into<ProtocolId>
) -> Result<Anchor<MerkleProof>, LeafNotKnown>

Conceals all LNPBP-4 data except specific protocol and converts anchor into merkle proof anchor.

pub fn conceal_except(
    &mut self,
    protocols: impl AsRef<[ProtocolId]>
) -> Result<usize, LeafNotKnown>

Conceals all LNPBP-4 data except specific protocol.

pub fn merge_reveal(self, other: Self) -> Result<Self, MergeError>

Merges two anchors keeping revealed data.

Trait Implementations

impl<L: Clone + Proof> Clone for Anchor<L>

fn clone(&self) -> Anchor<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Anchor<MerkleBlock>

fn commit_encode<E: Write>(&self, e: E) -> usize

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

fn commit_serialize(&self) -> Vec<u8, Global>

Serializes data for the commitment in-memory into a newly allocated array

impl ConsensusCommit for Anchor<MerkleBlock>

type Commitment = AnchorId

Type of the resulting commitment

fn consensus_commit(&self) -> Self::Commitment

Performs commitment to client-side-validated data

fn consensus_verify(&self, commitment: &Self::Commitment) -> bool

Verifies commitment to client-side-validated data

impl<L: Debug + Proof> Debug for Anchor<L>

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

Formats the value using the given formatter.

impl Ord for Anchor<MerkleBlock>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<L: PartialEq + Proof> PartialEq<Anchor<L>> for Anchor<L>

fn eq(&self, other: &Anchor<L>) -> bool

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

fn ne(&self, other: &Anchor<L>) -> bool

This method tests for !=.

impl PartialOrd<Anchor<MerkleBlock>> for Anchor<MerkleBlock>

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

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

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

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

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

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

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

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

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

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

impl<L: Proof> StrictDecode for Anchor<L>

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode

impl<L: Proof> StrictEncode for Anchor<L>

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

impl<L: Eq + Proof> Eq for Anchor<L>

impl<L: Proof> StructuralEq for Anchor<L>

impl<L: Proof> StructuralPartialEq for Anchor<L>