Enum bdk::keys::ExtendedKey

pub enum ExtendedKey<Ctx: ScriptContext = Legacy> {
    Private((ExtendedPrivKey, PhantomData<Ctx>)),
    Public((ExtendedPubKey, PhantomData<Ctx>)),
}

Enum for extended keys that can be either xprv or xpub

An instance of ExtendedKey can be constructed from an ExtendedPrivKey or an ExtendedPubKey by using the From trait.

Defaults to the Legacy context.

Variants

Private((ExtendedPrivKey, PhantomData<Ctx>))

A private extended key, aka an xprv

Public((ExtendedPubKey, PhantomData<Ctx>))

A public extended key, aka an xpub

Implementations

impl<Ctx: ScriptContext> ExtendedKey<Ctx>

pub fn has_secret(&self) -> bool

Return whether or not the key contains the private data

pub fn into_xprv(self, network: Network) -> Option<ExtendedPrivKey>

Transform the ExtendedKey into an ExtendedPrivKey for the given [Network], if the key contains the private data

pub fn into_xpub<C: Signing>(
    self,
    network: Network,
    secp: &Secp256k1<C>
) -> ExtendedPubKey

Transform the ExtendedKey into an ExtendedPubKey for the given [Network]

Trait Implementations

impl<Ctx: ScriptContext> DerivableKey<Ctx> for ExtendedKey<Ctx>

Identity conversion

fn into_extended_key(self) -> Result<ExtendedKey<Ctx>, KeyError>

Consume self and turn it into an ExtendedKey

fn into_descriptor_key(
    self,
    origin: Option<KeySource>,
    derivation_path: DerivationPath
) -> Result<DescriptorKey<Ctx>, KeyError>

Consume self and turn it into a DescriptorKey by adding the extra metadata, such as key origin and derivation path

impl<Ctx: ScriptContext> From<ExtendedPrivKey> for ExtendedKey<Ctx>

fn from(xprv: ExtendedPrivKey) -> Self

Converts to this type from the input type.

impl<Ctx: ScriptContext> From<ExtendedPubKey> for ExtendedKey<Ctx>

fn from(xpub: ExtendedPubKey) -> Self

Converts to this type from the input type.