Enum bdk::keys::ExtendedKey

source · [−]

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

Expand description

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

source

impl<Ctx: ScriptContext> ExtendedKey<Ctx>

source

pub fn has_secret(&self) -> bool

Return whether or not the key contains the private data

source

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

source

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

source

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

Identity conversion

source

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

Consume self and turn it into an ExtendedKey Read more

source

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 Read more

source

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

source

fn from(xprv: ExtendedPrivKey) -> Self

Performs the conversion.

source

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

source

fn from(xpub: ExtendedPubKey) -> Self

Performs the conversion.

Auto Trait Implementations

impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx> where
Ctx: RefUnwindSafe,

impl<Ctx> Send for ExtendedKey<Ctx> where
Ctx: Send,

impl<Ctx> Sync for ExtendedKey<Ctx> where
Ctx: Sync,

impl<Ctx> Unpin for ExtendedKey<Ctx> where
Ctx: Unpin,

impl<Ctx> UnwindSafe for ExtendedKey<Ctx> where
Ctx: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum bdk::keys::ExtendedKey

Variants

Private((ExtendedPrivKey, PhantomData<Ctx>))

Public((ExtendedPubKey, PhantomData<Ctx>))

Implementations

impl<Ctx: ScriptContext> ExtendedKey<Ctx>

pub fn has_secret(&self) -> bool

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

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

Trait Implementations

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

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

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

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

fn from(xprv: ExtendedPrivKey) -> Self

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

fn from(xpub: ExtendedPubKey) -> Self

Auto Trait Implementations

impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx> where Ctx: RefUnwindSafe,

impl<Ctx> Send for ExtendedKey<Ctx> where Ctx: Send,

impl<Ctx> Sync for ExtendedKey<Ctx> where Ctx: Sync,

impl<Ctx> Unpin for ExtendedKey<Ctx> where Ctx: Unpin,

impl<Ctx> UnwindSafe for ExtendedKey<Ctx> where Ctx: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

`Private((ExtendedPrivKey, PhantomData<Ctx>))`

`Public((ExtendedPubKey, PhantomData<Ctx>))`

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

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

impl<Ctx> RefUnwindSafe for ExtendedKey<Ctx> where
Ctx: RefUnwindSafe,

impl<Ctx> Send for ExtendedKey<Ctx> where
Ctx: Send,

impl<Ctx> Sync for ExtendedKey<Ctx> where
Ctx: Sync,

impl<Ctx> Unpin for ExtendedKey<Ctx> where
Ctx: Unpin,

impl<Ctx> UnwindSafe for ExtendedKey<Ctx> where
Ctx: UnwindSafe,

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

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

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

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

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

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

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