Struct dbc::anchor::Anchor

pub struct Anchor<L: Proof + StrictDumb> {
    pub txid: Txid,
    pub mpc_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.

mpc_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 anchor_id( &self, protocol_id: impl Into<ProtocolId>, message: Message ) -> Result<AnchorId, InvalidProof>

Returns id of the anchor (commitment hash).

pub fn into_merkle_block( self, protocol_id: impl Into<ProtocolId>, message: Message ) -> Result<Anchor<MerkleBlock>, InvalidProof>

Reconstructs anchor containing merkle block

pub fn to_merkle_block( &self, protocol_id: impl Into<ProtocolId>, message: Message ) -> Result<Anchor<MerkleBlock>, InvalidProof>

Reconstructs anchor containing merkle block

pub fn verify( &self, protocol_id: impl Into<ProtocolId>, message: Message, tx: &Tx ) -> 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: impl Into<ProtocolId>, message: Message ) -> Result<Commitment, InvalidProof>

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

impl Anchor<MerkleBlock>

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

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

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 + StrictDumb> 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<L: Proof + StrictDumb> CommitEncode for Anchor<L>

fn commit_encode(&self, e: &mut impl Write)

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

impl CommitmentId for Anchor<MerkleBlock>

const TAG: [u8; 32] = _

type Id = AnchorId

Type of the resulting commitment.

fn commitment_id(&self) -> Self::Id

Performs commitment to client-side-validated data

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

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

Formats the value using the given formatter.

impl<'de, L> Deserialize<'de> for Anchor<L>

where L: Deserialize<'de> + Proof + StrictDumb,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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 + PartialOrd,

Restrict a value to a certain interval.

impl<L: PartialEq + Proof + StrictDumb> PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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> Serialize for Anchor<L>

where L: Serialize + Proof + StrictDumb,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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

fn strict_read(lim: usize, reader: impl Read) -> Result<Self, DecodeError>

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

fn strict_dumb() -> Self

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

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

fn strict_write(&self, lim: usize, writer: impl Write) -> Result<usize, Error>

impl<L: Proof + StrictDumb> StrictStruct for Anchor<L>

const ALL_FIELDS: &'static [&'static str] = _

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl<L: Proof + StrictDumb> StrictType for Anchor<L>

const STRICT_LIB_NAME: &'static str = LIB_NAME_BPCORE

fn strict_name() -> Option<TypeName>

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

impl<L: Proof + StrictDumb> StrictProduct for Anchor<L>

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

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