Struct bdk::descriptor::template::Bip84

source · [−]

pub struct Bip84<K: DerivableKey<Segwitv0>>(pub K, pub KeychainKind);

Expand description

BIP84 template. Expands to wpkh(key/84'/0'/0'/{0,1}/*)

Since there are hardened derivation steps, this template requires a private derivable key (generally a xprv/tprv).

See Bip84Public for a template that can work with a xpub/tpub.

Example

use bdk::template::Bip84;

let key = bitcoin::util::bip32::ExtendedPrivKey::from_str("tprv8ZgxMBicQKsPeZRHk4rTG6orPS2CRNFX3njhUXx5vj9qGog5ZMH4uGReDWN5kCkY3jmWEtWause41CDvBRXD1shKknAMKxT99o9qUTRVC6m")?;
let wallet = Wallet::new_offline(
    Bip84(key.clone(), KeychainKind::External),
    Some(Bip84(key, KeychainKind::Internal)),
    Network::Testnet,
    MemoryDatabase::default()
)?;

assert_eq!(wallet.get_address(New)?.to_string(), "tb1qedg9fdlf8cnnqfd5mks6uz5w4kgpk2pr6y4qc7");
assert_eq!(wallet.public_descriptor(KeychainKind::External)?.unwrap().to_string(), "wpkh([c55b303f/84\'/0\'/0\']tpubDC2Qwo2TFsaNC4ju8nrUJ9mqVT3eSgdmy1yPqhgkjwmke3PRXutNGRYAUo6RCHTcVQaDR3ohNU9we59brGHuEKPvH1ags2nevW5opEE9Z5Q/0/*)#nkk5dtkg");

Tuple Fields

0: K1: KeychainKind

Trait Implementations

source

impl<K: DerivableKey<Segwitv0>> DescriptorTemplate for Bip84<K>

source

fn build(self) -> Result<DescriptorTemplateOut, DescriptorError>

Build the complete descriptor

Auto Trait Implementations

impl<K> RefUnwindSafe for Bip84<K> where
K: RefUnwindSafe,

impl<K> Send for Bip84<K> where
K: Send,

impl<K> Sync for Bip84<K> where
K: Sync,

impl<K> Unpin for Bip84<K> where
K: Unpin,

impl<K> UnwindSafe for Bip84<K> where
K: 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.

source

impl<T> IntoWalletDescriptor for T where
T: DescriptorTemplate,

source

pub fn into_wallet_descriptor(
 Self,
 &Secp256k1<All>,
 Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

Convert to wallet descriptor

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.

Struct bdk::descriptor::template::Bip84

Example

Tuple Fields

Trait Implementations

impl<K: DerivableKey<Segwitv0>> DescriptorTemplate for Bip84<K>

fn build(self) -> Result<DescriptorTemplateOut, DescriptorError>

Auto Trait Implementations

impl<K> RefUnwindSafe for Bip84<K> where
K: RefUnwindSafe,

impl<K> Send for Bip84<K> where
K: Send,

impl<K> Sync for Bip84<K> where
K: Sync,

impl<K> Unpin for Bip84<K> where
K: Unpin,

impl<K> UnwindSafe for Bip84<K> where
K: 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> IntoWalletDescriptor for T where
T: DescriptorTemplate,

pub fn into_wallet_descriptor(
    Self,
    &Secp256k1<All>,
    Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

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

Struct bdk::descriptor::template::Bip84

Example

Tuple Fields

Trait Implementations

impl<K: DerivableKey<Segwitv0>> DescriptorTemplate for Bip84<K>

fn build(self) -> Result<DescriptorTemplateOut, DescriptorError>

Auto Trait Implementations

impl<K> RefUnwindSafe for Bip84<K> where K: RefUnwindSafe,

impl<K> Send for Bip84<K> where K: Send,

impl<K> Sync for Bip84<K> where K: Sync,

impl<K> Unpin for Bip84<K> where K: Unpin,

impl<K> UnwindSafe for Bip84<K> where K: 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> IntoWalletDescriptor for T where T: DescriptorTemplate,

pub fn into_wallet_descriptor( Self, &Secp256k1<All>, Network) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

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

impl<K> RefUnwindSafe for Bip84<K> where
K: RefUnwindSafe,

impl<K> Send for Bip84<K> where
K: Send,

impl<K> Sync for Bip84<K> where
K: Sync,

impl<K> Unpin for Bip84<K> where
K: Unpin,

impl<K> UnwindSafe for Bip84<K> where
K: 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> IntoWalletDescriptor for T where
T: DescriptorTemplate,

pub fn into_wallet_descriptor(
Self,
&Secp256k1<All>,
Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

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