Enum bdk_wallet::keys::DescriptorSecretKey

pub enum DescriptorSecretKey {
    Single(SinglePriv),
    XPrv(DescriptorXKey<Xpriv>),
    MultiXPrv(DescriptorMultiXKey<Xpriv>),
}
Expand description

The descriptor secret key, either a single private key or an xprv.

Variants§

§

Single(SinglePriv)

Single private key.

§

XPrv(DescriptorXKey<Xpriv>)

Extended private key (xpriv).

§

MultiXPrv(DescriptorMultiXKey<Xpriv>)

Multiple extended private keys.

Implementations§

§

impl DescriptorSecretKey

pub fn to_public<C>( &self, secp: &Secp256k1<C> ) -> Result<DescriptorPublicKey, DescriptorKeyParseError>
where C: Signing,

Returns the public version of this key.

If the key is an “XPrv”, the hardened derivation steps will be applied before converting it to a public key.

It will return an error if the key is a “multi-xpriv”, as we wouldn’t always be able to apply hardened derivation steps if there are multiple paths.

pub fn is_multipath(&self) -> bool

Whether or not this key has multiple derivation paths.

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

Get as many keys as derivation paths in this key.

For raw keys 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 DescriptorSecretKey

§

fn clone(&self) -> DescriptorSecretKey

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 DescriptorSecretKey

§

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

Formats the value using the given formatter. Read more
§

impl Display for DescriptorSecretKey

§

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

Formats the value using the given formatter. Read more
§

impl FromStr for DescriptorSecretKey

§

type Err = DescriptorKeyParseError

The associated error which can be returned from parsing.
§

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

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

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

source§

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

Turn the key into a DescriptorKey within the requested ScriptContext
§

impl PartialEq for DescriptorSecretKey

§

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

§

impl StructuralPartialEq for DescriptorSecretKey

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.

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