Struct bitcoin::util::bip32::ExtendedPrivKey

pub struct ExtendedPrivKey {
    pub network: Network,
    pub depth: u8,
    pub parent_fingerprint: Fingerprint,
    pub child_number: ChildNumber,
    pub private_key: SecretKey,
    pub chain_code: ChainCode,
}

Extended private key

Fields

network: Network

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 ExtendedPrivKey

pub fn new_master(
    network: Network,
    seed: &[u8]
) -> Result<ExtendedPrivKey, 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: Signing>(self, secp: &Secp256k1<C>) -> KeyPair

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

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

Attempts to derive an extended private key from a path.

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

pub fn ckd_priv<C: Signing>(
    &self,
    secp: &Secp256k1<C>,
    i: ChildNumber
) -> Result<ExtendedPrivKey, Error>

Private->Private child key derivation

pub fn decode(data: &[u8]) -> Result<ExtendedPrivKey, 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: Signing>(&self, secp: &Secp256k1<C>) -> XpubIdentifier

Returns the HASH160 of the public key belonging to the xpriv

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

Returns the first four bytes of the identifier

Trait Implementations

impl Clone for ExtendedPrivKey

fn clone(&self) -> ExtendedPrivKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExtendedPrivKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExtendedPrivKey

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for ExtendedPrivKey

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

Formats the value using the given formatter.

impl FromStr for ExtendedPrivKey

type Err = Error

The associated error which can be returned from parsing.

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

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

impl PartialEq<ExtendedPrivKey> for ExtendedPrivKey

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

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

const 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 ExtendedPrivKey

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl Copy for ExtendedPrivKey

impl Eq for ExtendedPrivKey

impl StructuralEq for ExtendedPrivKey

impl StructuralPartialEq for ExtendedPrivKey