Enum bdk_wallet::keys::DescriptorPublicKey

pub enum DescriptorPublicKey {
    Single(SinglePub),
    XPub(DescriptorXKey<Xpub>),
    MultiXPub(DescriptorMultiXKey<Xpub>),
}
Expand description

The descriptor pubkey, either a single pubkey or an xpub.

Variants§

§

Single(SinglePub)

Single public key.

§

XPub(DescriptorXKey<Xpub>)

Extended public key (xpub).

§

MultiXPub(DescriptorMultiXKey<Xpub>)

Multiple extended public keys.

Implementations§

§

impl DescriptorPublicKey

pub fn master_fingerprint(&self) -> Fingerprint

The fingerprint of the master key associated with this key, 0x00000000 if none.

pub fn full_derivation_path(&self) -> Option<DerivationPath>

Full path, from the master key

For wildcard keys this will return the path up to the wildcard, so you can get full paths by appending one additional derivation step, according to the wildcard type (hardened or normal).

For multipath extended keys, this returns None.

pub fn full_derivation_paths(&self) -> Vec<DerivationPath>

Returns a vector containing the full derivation paths from the master key. The vector will contain just one element for single keys, and multiple elements for multipath extended keys.

For wildcard keys this will return the path up to the wildcard, so you can get full paths by appending one additional derivation step, according to the wildcard type (hardened or normal).

pub fn is_deriveable(&self) -> bool

👎Deprecated: use has_wildcard instead

Whether or not the key has a wildcard

pub fn has_wildcard(&self) -> bool

Whether or not the key has a wildcard

pub fn derive( self, index: u32 ) -> Result<DefiniteDescriptorKey, ConversionError>

👎Deprecated: use at_derivation_index instead

Deprecated name for Self::at_derivation_index.

pub fn at_derivation_index( self, index: u32 ) -> Result<DefiniteDescriptorKey, ConversionError>

Replaces any wildcard (i.e. /*) in the key with a particular derivation index, turning it into a definite key (i.e. one where all the derivation paths are set).

§Returns
  • If this key is not an xpub, returns self.
  • If this key is an xpub but does not have a wildcard, returns self.
  • Otherwise, returns the xpub at derivation index (removing the wildcard).
§Errors
  • If index is hardened.

pub fn is_multipath(&self) -> bool

Whether or not this key has multiple derivation paths.

pub fn into_single_keys(self) -> Vec<DescriptorPublicKey>

Get as many keys as derivation paths in this key.

For raw public key and single-path extended keys it will return the key itself. For multipath extended keys it will return a single-path extended key per derivation path.

Trait Implementations§

§

impl Clone for DescriptorPublicKey

§

fn clone(&self) -> DescriptorPublicKey

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for DescriptorPublicKey

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for DescriptorPublicKey

§

fn deserialize<D>( deserializer: D ) -> Result<DescriptorPublicKey, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for DescriptorPublicKey

§

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

Formats the value using the given formatter. Read more
§

impl From<DefiniteDescriptorKey> for DescriptorPublicKey

§

fn from(d: DefiniteDescriptorKey) -> DescriptorPublicKey

Converts to this type from the input type.
§

impl FromStr for DescriptorPublicKey

§

type Err = DescriptorKeyParseError

The associated error which can be returned from parsing.
§

fn from_str( s: &str ) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl Hash for DescriptorPublicKey

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl IntoAssets for DescriptorPublicKey

§

fn into_assets(self) -> Assets

Convert self into a Assets struct
source§

impl<Ctx: ScriptContext> IntoDescriptorKey<Ctx> for DescriptorPublicKey

source§

fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>

Turn the key into a DescriptorKey within the requested ScriptContext
§

impl MiniscriptKey for DescriptorPublicKey

§

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 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.
§

fn num_der_paths(&self) -> usize

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

impl Ord for DescriptorPublicKey

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for DescriptorPublicKey

§

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

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

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 DescriptorPublicKey

§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Serialize for DescriptorPublicKey

§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl Eq for DescriptorPublicKey

§

impl StructuralPartialEq for DescriptorPublicKey

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromStrKey for T
where T: MiniscriptKey + FromStr, <T as MiniscriptKey>::Sha256: FromStr, <T as MiniscriptKey>::Hash256: FromStr, <T as MiniscriptKey>::Ripemd160: FromStr, <T as MiniscriptKey>::Hash160: FromStr, <T as FromStr>::Err: Debug + Display, <<T as MiniscriptKey>::Sha256 as FromStr>::Err: Debug + Display, <<T as MiniscriptKey>::Hash256 as FromStr>::Err: Debug + Display, <<T as MiniscriptKey>::Ripemd160 as FromStr>::Err: Debug + Display, <<T as MiniscriptKey>::Hash160 as FromStr>::Err: Debug + Display,

§

type _Sha256 = <T as MiniscriptKey>::Sha256

Dummy type. Do not use.
§

type _Sha256FromStrErr = <<T as MiniscriptKey>::Sha256 as FromStr>::Err

Dummy type. Do not use.
§

type _Hash256 = <T as MiniscriptKey>::Hash256

Dummy type. Do not use.
§

type _Hash256FromStrErr = <<T as MiniscriptKey>::Hash256 as FromStr>::Err

Dummy type. Do not use.
§

type _Ripemd160 = <T as MiniscriptKey>::Ripemd160

Dummy type. Do not use.
§

type _Ripemd160FromStrErr = <<T as MiniscriptKey>::Ripemd160 as FromStr>::Err

Dummy type. Do not use.
§

type _Hash160 = <T as MiniscriptKey>::Hash160

Dummy type. Do not use.
§

type _Hash160FromStrErr = <<T as MiniscriptKey>::Hash160 as FromStr>::Err

Dummy type. Do not use.
§

type _FromStrErr = <T as FromStr>::Err

Dummy type. Do not use.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,