Enum BitcoinKey

pub enum BitcoinKey {
    Fullkey(PublicKey),
    XOnlyPublicKey(XOnlyPublicKey),
}

This type is exported in elements-miniscript because it also captures information about the type of Extension. For rust-miniscript, this is not an issue because there are no extensions. Internally used enum for different types of bitcoin keys Even though we implement MiniscriptKey for BitcoinKey, we make sure that there are little mis-use

• The only constructors for this are only called in from_txdata that take care using the correct enum variant
• This does not implement ToPublicKey to avoid context dependant encoding/decoding of 33/32 byte keys. This allows us to keep a single NoChecks context instead of a context for for NoChecksSchnorr/NoChecksEcdsa.

Variants

Fullkey(PublicKey)

Full key

XOnlyPublicKey(XOnlyPublicKey)

Xonly key

Trait Implementations

impl Clone for BitcoinKey

fn clone(&self) -> BitcoinKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitcoinKey

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

Formats the value using the given formatter.

impl Display for BitcoinKey

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

Formats the value using the given formatter.

impl From<PublicKey> for BitcoinKey

fn from(pk: PublicKey) -> Self

Converts to this type from the input type.

impl From<XOnlyPublicKey> for BitcoinKey

fn from(xpk: XOnlyPublicKey) -> Self

Converts to this type from the input type.

impl Hash for BitcoinKey

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MiniscriptKey for BitcoinKey

type Sha256 = Hash

The associated bitcoin::hashes::sha256::Hash for this MiniscriptKey, used in the sha256 fragment.

type Hash256 = Hash

The associated miniscript::hash256::Hash for this MiniscriptKey, used in the hash256 fragment.

type Ripemd160 = Hash

The associated bitcoin::hashes::ripemd160::Hash for this MiniscriptKey type, used in the ripemd160 fragment.

type Hash160 = Hash

The associated bitcoin::hashes::hash160::Hash for this MiniscriptKey type, used in the hash160 fragment.

fn num_der_paths(&self) -> usize

Returns the number of different derivation paths in this key. Only >1 for keys in BIP389 multipath descriptors.

fn is_uncompressed(&self) -> bool

Returns true if the pubkey is uncompressed. Defaults to false.

fn is_x_only_key(&self) -> bool

Returns true if the pubkey is an x-only pubkey. Defaults to false.

impl Ord for BitcoinKey

fn cmp(&self, other: &BitcoinKey) -> 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 BitcoinKey

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

fn partial_cmp(&self, other: &BitcoinKey) -> 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 Copy for BitcoinKey

impl Eq for BitcoinKey

impl StructuralPartialEq for BitcoinKey