Struct coins_bip32::xkeys::XPriv

pub struct XPriv { /* private fields */ }

A BIP32 eXtended Privkey

Implementations

impl XPriv

pub fn new(key: SigningKey, xkey_info: XKeyInfo) -> Self

Instantiate a new XPriv.

pub fn verify_key(&self) -> XPub

Derive the associated XPub

pub fn fingerprint(&self) -> KeyFingerprint

The fingerprint is the first 4 bytes of the HASH160 of the public key

pub fn root_node(
    hmac_key: &[u8],
    data: &[u8],
    hint: Option<Hint>
) -> Result<XPriv, Bip32Error>

Generate a customized root node

pub fn root_from_seed(
    data: &[u8],
    hint: Option<Hint>
) -> Result<XPriv, Bip32Error>

Generate a root node from some seed data. Uses the BIP32-standard hmac key.

Important:

Use a seed of AT LEAST 128 bits.

pub fn custom_root_node(
    hmac_key: &[u8],
    data: &[u8],
    hint: Option<Hint>
) -> Result<XPriv, Bip32Error>

Instantiate a root node using a custom HMAC key.

pub fn custom_root_from_seed(
    data: &[u8],
    hint: Option<Hint>
) -> Result<XPriv, Bip32Error>

Generate a root node from some seed data. Uses the BIP32-standard hmac key.

Important:

Use a seed of AT LEAST 128 bits.

pub fn derive_path<E, P>(&self, p: P) -> Result<Self, Bip32Error> where
    E: Into<Bip32Error>,
    P: TryInto<DerivationPath, Error = E>, 

Derive a series of child indices. Allows traversing several levels of the tree at once. Accepts an iterator producing u32, or a string.

Trait Implementations

impl AsRef<SigningKey> for XPriv

fn as_ref(&self) -> &SigningKey

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XKeyInfo> for XPriv

fn as_ref(&self) -> &XKeyInfo

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XPriv> for DerivedXPriv

fn as_ref(&self) -> &XPriv

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XPriv> for XPriv

fn as_ref(&self) -> &XPriv

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for XPriv

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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<D> DigestSigner<D, Signature<Secp256k1>> for XPriv where
    D: FixedOutput<OutputSize = U32> + Clone + Default + Reset + Update + HashMarker, 

fn try_sign_digest(&self, digest: D) -> Result<Signature, Error>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl<D> DigestSigner<D, Signature> for XPriv where
    D: FixedOutput<OutputSize = U32> + Clone + Default + Reset + Update + HashMarker, 

fn try_sign_digest(&self, digest: D) -> Result<Signature, Error>

Attempt to sign the given prehashed message Digest, returning a digital signature on success, or an error if something went wrong.

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl FromStr for XPriv

type Err = Bip32Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Parent for XPriv

fn derive_child(&self, index: u32) -> Result<Self, Bip32Error>

Derive the child at index. Note that this may produce the child at index+1 in rare circumstances. For public keys this will derive public children. For private keys it will derive private children.

fn derive_path<E, P>(&self, p: P) -> Result<Self, Bip32Error> where
    E: Into<Bip32Error>,
    P: TryInto<DerivationPath, Error = E>, 

Derive a series of child indices. Allows traversing several levels of the tree at once. Accepts an iterator producing u32, or a string.

impl PartialEq<XPriv> for XPriv

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

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

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

This method tests for !=.

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.