Enum lnpbp::bp::scripts::descriptor::PubkeyExtended

pub enum PubkeyExtended {
    Native(DescriptorPublicKey),
    Tweaked(PubkeyWithTweak),
}

Public key information that can be used as a part of Bitcoin Core/miniscript descriptors and parsed/serialized into string. Unlike [miniscript::DescriptorPublicKey] type can contain tweaking factor applied to a public key after derication. In string-serialized form this factor can be given as an optional extension after + sign.

Variants

Native(DescriptorPublicKey)

Public key or extended public key without tweaking factor information

Tweaked(PubkeyWithTweak)

Public key or extended public key with tweaking information

Implementations

impl PubkeyExtended

pub fn has_tweak(&self) -> bool

Returns whether key has embedded tweaking information

pub fn as_tweaking_factor(&self) -> Option<&SecretKey>

Returns reference to a tweaking factor (in form of Option::Some([secp256k1::SecretKey]) for [PublicKey::Tweaked] variant, or Option::None otherwise

pub fn as_descriptor_public_key(&self) -> &DescriptorPublicKey

Returns reference to an untweaked DescriptorPublicKey value

pub fn into_tweaking_factor(self) -> Option<SecretKey>

Converts into a tweaking factor value (in form of Option::Some([secp256k1::SecretKey]) for [PublicKey::Tweaked] variant, or Option::None otherwise

pub fn into_descriptor_public_key(self) -> DescriptorPublicKey

Converts into an untweaked DescriptorPublicKey value

pub fn to_tweaked_public_key(&self, index: Option<u32>) -> PublicKey

Converts into an untweaked DescriptorPublicKey value, optionally using derivation into a child with index

Trait Implementations

impl Clone for PubkeyExtended

fn clone(&self) -> PubkeyExtended

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PubkeyExtended

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

Formats the value using the given formatter.

impl Display for PubkeyExtended

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

Formats the value using the given formatter.

impl Eq for PubkeyExtended

impl FromStr for PubkeyExtended

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for PubkeyExtended

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl MiniscriptKey for PubkeyExtended

type Hash = Self

The associated Hash type with the publicKey

fn to_pubkeyhash(&self) -> Self::Hash

Converts an object to PublicHash

fn is_uncompressed(&self) -> bool

Check if the publicKey is uncompressed. The default implementation returns false

impl Ord for PubkeyExtended

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<PubkeyExtended> for PubkeyExtended

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

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

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

This method tests for !=.

impl PartialOrd<PubkeyExtended> for PubkeyExtended

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for PubkeyExtended

impl StructuralPartialEq for PubkeyExtended

impl ToPublicKey for PubkeyExtended

fn to_public_key(&self) -> PublicKey

Converts an object to a public key

fn hash_to_hash160(hash: &Self::Hash) -> Hash

Converts a hashed version of the public key to a hash160 hash.

fn serialized_len(&self) -> usize

Computes the size of a public key when serialized in a script, including the length bytes