Struct ExtendedPrivateKey

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

Extended private keys derived using BIP32.

Generic around a PrivateKey type. When the secp256k1 feature of this crate is enabled, the XPrv type provides a convenient alias for extended ECDSA/secp256k1 private keys.

Implementations

impl<K> ExtendedPrivateKey<K>

where K: PrivateKey,

pub const MAX_DEPTH: Depth = 255u8

Maximum derivation depth.

pub fn derive_from_path<S>(seed: S, path: &DerivationPath) -> Result<Self>

where S: AsRef<[u8]>,

Available on crate feature alloc only.

Derive a child key from the given DerivationPath.

pub fn new<S>(seed: S) -> Result<Self>

where S: AsRef<[u8]>,

Create the root extended key for the given seed value.

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

Derive a child key for a particular ChildNumber.

pub fn private_key(&self) -> &K

Borrow the derived private key value.

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

Serialize the derived public key as bytes.

pub fn attrs(&self) -> &ExtendedKeyAttrs

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

pub fn to_bytes(&self) -> PrivateKeyBytes

Serialize the raw private key as a byte array.

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

Serialize this key as an ExtendedKey.

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

Available on crate feature alloc only.

Serialize this key as a self-Zeroizing String.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K> ConstantTimeEq for ExtendedPrivateKey<K>

where K: PrivateKey,

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

Determine if two items are equal.

impl<K> Debug for ExtendedPrivateKey<K>

where K: PrivateKey,

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

Formats the value using the given formatter.

impl<K> From<&ExtendedPrivateKey<K>> for ExtendedPublicKey<K::PublicKey>

where K: PrivateKey,

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

Converts to this type from the input type.

impl From<&ExtendedPrivateKey<SigningKey<Secp256k1>>> for SigningKey

Available on crate feature secp256k1 only.

fn from(xprv: &XPrv) -> SigningKey

Converts to this type from the input type.

impl From<ExtendedPrivateKey<SigningKey<Secp256k1>>> for SigningKey

Available on crate feature secp256k1 only.

fn from(xprv: XPrv) -> SigningKey

Converts to this type from the input type.

impl<K> FromStr for ExtendedPrivateKey<K>

where K: PrivateKey,

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<K> PartialEq for ExtendedPrivateKey<K>

where K: PrivateKey,

NOTE: uses ConstantTimeEq internally

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> TryFrom<ExtendedKey> for ExtendedPrivateKey<K>

where K: PrivateKey,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<K> Eq for ExtendedPrivateKey<K>

where K: PrivateKey,

NOTE: uses ConstantTimeEq internally