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,1}'/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(
    Bip84(key.clone(), KeychainKind::External),
    Some(Bip84(key, KeychainKind::Internal)),
    Network::Testnet,
    MemoryDatabase::default()
)?;

assert_eq!(wallet.get_address(New)?.to_string(), "tb1qhl85z42h7r4su5u37rvvw0gk8j2t3n9y7zsg4n");
assert_eq!(wallet.public_descriptor(KeychainKind::External)?.unwrap().to_string(), "wpkh([c55b303f/84'/1'/0']tpubDDc5mum24DekpNw92t6fHGp8Gr2JjF9J7i4TZBtN6Vp8xpAULG5CFaKsfugWa5imhrQQUZKXe261asP5koDHo5bs3qNTmf3U3o4v9SaB8gg/0/*)#6kfecsmr");

Tuple Fields

0: K1: KeychainKind

Trait Implementations

source

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

source

fn build(
self,
network: Network
) -> 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 Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> IntoWalletDescriptor for Twhere
T: DescriptorTemplate,

source

fn into_wallet_descriptor(
 self,
 secp: &Secp256k1<All>,
 network: Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

Convert to wallet descriptor

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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,
network: Network
) -> 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 Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoWalletDescriptor for Twhere
T: DescriptorTemplate,

fn into_wallet_descriptor(
    self,
    secp: &Secp256k1<All>,
    network: Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

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, network: Network) -> 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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoWalletDescriptor for Twhere T: DescriptorTemplate,

fn into_wallet_descriptor( self, secp: &Secp256k1<All>, network: Network) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

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

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 Twhere
T: 'static + ?Sized,

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

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

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

impl<T> IntoWalletDescriptor for Twhere
T: DescriptorTemplate,

fn into_wallet_descriptor(
self,
secp: &Secp256k1<All>,
network: Network
) -> Result<(Descriptor<DescriptorPublicKey>, HashMap<DescriptorPublicKey, DescriptorSecretKey, RandomState>), Error>

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

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

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