Struct bdk_chain::bitcoin::bip32::Xpriv

pub struct Xpriv {
    pub network: NetworkKind,
    pub depth: u8,
    pub parent_fingerprint: Fingerprint,
    pub child_number: ChildNumber,
    pub private_key: SecretKey,
    pub chain_code: ChainCode,
}
Expand description

Extended private key

Fields§

§network: NetworkKind

The network this key is to be used on

§depth: u8

How many derivations this key is from the master (which is 0)

§parent_fingerprint: Fingerprint

Fingerprint of the parent key (0 for master)

§child_number: ChildNumber

Child number of the key used to derive from parent (0 for master)

§private_key: SecretKey

Private key

§chain_code: ChainCode

Chain code

Implementations§

§

impl Xpriv

pub fn new_master( network: impl Into<NetworkKind>, seed: &[u8] ) -> Result<Xpriv, Error>

Construct a new master key from a seed value

pub fn to_priv(self) -> PrivateKey

Constructs ECDSA compressed private key matching internal secret key representation.

pub fn to_keypair<C>(self, secp: &Secp256k1<C>) -> Keypair
where C: Signing,

Constructs BIP340 keypair for Schnorr signatures and Taproot use matching the internal secret key representation.

pub fn derive_priv<C, P>( &self, secp: &Secp256k1<C>, path: &P ) -> Result<Xpriv, Error>
where C: Signing, P: AsRef<[ChildNumber]>,

Attempts to derive an extended private key from a path.

The path argument can be both of type DerivationPath or Vec<ChildNumber>.

pub fn decode(data: &[u8]) -> Result<Xpriv, Error>

Decoding extended private key from binary data according to BIP 32

pub fn encode(&self) -> [u8; 78]

Extended private key binary encoding according to BIP 32

pub fn identifier<C>(&self, secp: &Secp256k1<C>) -> XKeyIdentifier
where C: Signing,

Returns the HASH160 of the public key belonging to the xpriv

pub fn fingerprint<C>(&self, secp: &Secp256k1<C>) -> Fingerprint
where C: Signing,

Returns the first four bytes of the identifier

Trait Implementations§

§

impl Clone for Xpriv

§

fn clone(&self) -> Xpriv

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Xpriv

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for Xpriv

§

fn deserialize<D>( deserializer: D ) -> Result<Xpriv, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Display for Xpriv

§

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

Formats the value using the given formatter. Read more
§

impl FromStr for Xpriv

§

type Err = Error

The associated error which can be returned from parsing.
§

fn from_str(inp: &str) -> Result<Xpriv, Error>

Parses a string s to return a value of this type. Read more
§

impl GetKey for Xpriv

§

type Error = GetKeyError

An error occurred while getting the key.
§

fn get_key<C>( &self, key_request: KeyRequest, secp: &Secp256k1<C> ) -> Result<Option<PrivateKey>, <Xpriv as GetKey>::Error>
where C: Signing,

Attempts to get the private key for key_request. Read more
§

impl InnerXKey for Xpriv

§

fn xkey_fingerprint<C>(&self, secp: &Secp256k1<C>) -> Fingerprint
where C: Signing,

Returns the fingerprint of the key
§

fn can_derive_hardened() -> bool

Returns whether hardened steps can be derived on the key Read more
§

impl PartialEq for Xpriv

§

fn eq(&self, other: &Xpriv) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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 Serialize for Xpriv

§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl Copy for Xpriv

§

impl Eq for Xpriv

§

impl StructuralPartialEq for Xpriv

Auto Trait Implementations§

§

impl Freeze for Xpriv

§

impl RefUnwindSafe for Xpriv

§

impl Send for Xpriv

§

impl Sync for Xpriv

§

impl Unpin for Xpriv

§

impl UnwindSafe for Xpriv

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,