Enum bdk::keys::DescriptorSecretKey

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

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

Variants

Single(SinglePriv)

Single private key.

XPrv(DescriptorXKey<ExtendedPrivKey>)

Extended private key (xpriv).

MultiXPrv(DescriptorMultiXKey<ExtendedPrivKey>)

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, Global>

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.

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

Performs copy-assignment from source.

impl Debug for DescriptorSecretKey

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

Formats the value using the given formatter.

impl Display for DescriptorSecretKey

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

Formats the value using the given formatter.

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.

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

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

Turn the key into a DescriptorKey within the requested ScriptContext

impl PartialEq<DescriptorSecretKey> for DescriptorSecretKey

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

impl StructuralEq for DescriptorSecretKey

impl StructuralPartialEq for DescriptorSecretKey