pub struct ExtendedPrivateKey<K: PrivateKey> { /* private fields */ }
Expand description

Extended private keys derived using BIP32.

Generic around a PrivateKey type.

Implementations§

source§

impl<K> ExtendedPrivateKey<K>
where K: PrivateKey,

source

pub const MAX_DEPTH: Depth = 255u8

Maximum derivation depth.

source

pub fn new<S>(seed: S) -> Result<Self>
where S: AsRef<[u8]>,

Create the root extended key for the given seed value.

source

pub fn derive_child(&self, child_number: ChildNumber) -> Result<Self>

Derive a child key for a particular ChildNumber.

source

pub fn derive_path(self, path: DerivationPath) -> Result<Self>

source

pub fn private_key(&self) -> &K

Borrow the derived private key value.

source

pub fn public_key(&self) -> ExtendedPublicKey<K::PublicKey>

Serialize the derived public key as bytes.

source

pub fn attrs(&self) -> &ExtendedKeyAttrs

Get attributes for this key such as depth, parent fingerprint, child number, and chain code.

source

pub fn to_bytes(&self) -> PrivateKeyBytes

Serialize the raw private key as a byte array.

source

pub fn to_extended_key(&self, prefix: Prefix) -> ExtendedKey

Serialize this key as an ExtendedKey.

source

pub fn to_string(&self, prefix: Prefix) -> Zeroizing<String>

Trait Implementations§

source§

impl<K: Clone + PrivateKey> Clone for ExtendedPrivateKey<K>

source§

fn clone(&self) -> ExtendedPrivateKey<K>

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
source§

impl<K> ConstantTimeEq for ExtendedPrivateKey<K>
where K: PrivateKey,

source§

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal. Read more
source§

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal. Read more
source§

impl<K> Debug for ExtendedPrivateKey<K>
where K: PrivateKey,

source§

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

Formats the value using the given formatter. Read more
source§

impl<K> From<&ExtendedPrivateKey<K>> for ExtendedPublicKey<K::PublicKey>
where K: PrivateKey,

source§

fn from(xprv: &ExtendedPrivateKey<K>) -> ExtendedPublicKey<K::PublicKey>

Converts to this type from the input type.
source§

impl<K> FromStr for ExtendedPrivateKey<K>
where K: PrivateKey,

§

type Err = Error

The associated error which can be returned from parsing.
source§

fn from_str(xprv: &str) -> Result<Self>

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

impl<K> PartialEq for ExtendedPrivateKey<K>
where K: PrivateKey,

NOTE: uses ConstantTimeEq internally

source§

fn eq(&self, other: &Self) -> 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.
source§

impl<K> TryFrom<ExtendedKey> for ExtendedPrivateKey<K>
where K: PrivateKey,

§

type Error = Error

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

fn try_from(extended_key: ExtendedKey) -> Result<ExtendedPrivateKey<K>>

Performs the conversion.
source§

impl<K> Eq for ExtendedPrivateKey<K>
where K: PrivateKey,

NOTE: uses ConstantTimeEq internally

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

impl<K> UnwindSafe for ExtendedPrivateKey<K>
where K: UnwindSafe,

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

§

type Output = T

Should always be Self
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, 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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more