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

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: impl AsRef<Bip32Seed>, ) -> Self

Constructs a new master key from a Bip32Seed.

pub fn to_priv(self) -> PrivateKey

👎Deprecating in a future version:

use to_private_key() instead

Constructs a new ECDSA compressed private key matching internal secret key representation.

pub fn to_private_key(self) -> PrivateKey

Constructs a new ECDSA compressed private key matching internal secret key representation.

pub fn to_xpub(self) -> Xpub

Constructs a new extended public key from this extended private key.

pub fn to_keypair(self) -> Keypair

Constructs a new BIP-0340 keypair for Schnorr signatures and Taproot use matching the internal secret key representation.

pub fn derive_priv<P: AsRef<[ChildNumber]>>( &self, path: P, ) -> Result<Self, DerivationError>

👎Deprecating in a future version:

use derive_xpriv() instead

Derives an extended private key from a path.

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

Errors

See derive_xpriv.

pub fn derive_xpriv<P: AsRef<[ChildNumber]>>( &self, path: P, ) -> Result<Self, DerivationError>

Derives an extended private key from a path.

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

Errors

Returns an error if the derived key exceeds the maximum key depth.

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

Decoding extended private key from binary data according to BIP-0032

Errors

• ParseError::UnknownVersion if the decoded network value is not main or testnet.
• ParseError::InvalidPrivateKeyPrefix if the private key bytes don’t start with zero.
• ParseError::Secp256k1 if the private key bytes are not a valid secp secret key.
• ParseError::WrongExtendedKeyLength if the data is not the correct length.
• ParseError::NonZeroParentFingerprintForMasterKey if the depth is 0 and the master key fingerprint is non-zero.
• ParseError::NonZeroChildNumberForMasterKey if the depth is 0 and the child number is non-zero.

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

Extended private key binary encoding according to BIP-0032

pub fn identifier(&self) -> XKeyIdentifier

Returns the HASH160 of the public key belonging to the xpriv

pub fn fingerprint(&self) -> Fingerprint

Returns the first four bytes of the identifier

Trait Implementations

impl<'a> Arbitrary<'a> for Xpriv

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Xpriv

fn clone(&self) -> Xpriv

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Xpriv

impl Debug for Xpriv

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Xpriv, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Xpriv

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

Formats the value using the given formatter.

impl Eq for Xpriv

impl FromStr for Xpriv

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(inp: &str) -> Result<Self, ParseError>

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

impl PartialEq for Xpriv

fn eq(&self, other: &Xpriv) -> 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 Serialize for Xpriv

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Xpriv