Struct coins_bip32::derived::DerivedXPriv

pub struct DerivedXPriv { /* private fields */ }

An XPriv with its derivation.

Implementations

impl DerivedXPriv

pub fn new(xpriv: XPriv, derivation: KeyDerivation) -> Self

Instantiate a derived XPub from the XPub and derivatin. This usually should not be called directly. Prefer deriving keys from parents.

pub fn is_private_ancestor_of(
    &self,
    other: &DerivedXPub
) -> Result<bool, Bip32Error>

Check if this XPriv is the private ancestor of some other derived key. To check ancestry of another private key, derive its public key first

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

Generate a customized root node using the stati

pub fn root_from_seed(
    data: &[u8],
    hint: Option<Hint>
) -> Result<DerivedXPriv, 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<DerivedXPriv, Bip32Error>

Instantiate a root node using a custom HMAC key.

pub fn custom_root_from_seed(
    data: &[u8],
    hint: Option<Hint>
) -> Result<DerivedXPriv, 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 verify_key(&self) -> DerivedXPub

Derive the corresponding xpub

Trait Implementations

impl AsRef<SigningKey> for DerivedXPriv

fn as_ref(&self) -> &SigningKey

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

impl AsRef<XKeyInfo> for DerivedXPriv

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 Clone for DerivedXPriv

fn clone(&self) -> DerivedXPriv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DerivedXPriv

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

Formats the value using the given formatter.

impl DerivedKey for DerivedXPriv

fn derivation(&self) -> &KeyDerivation

Return this key’s derivation

fn same_root<K: DerivedKey>(&self, other: &K) -> bool

true if the keys share a root fingerprint, false otherwise. Note that on key fingerprints, which may collide accidentally, or be intentionally collided.

fn is_possible_ancestor_of<K: DerivedKey>(&self, other: &K) -> bool

true if this key is a possible ancestor of the argument, false otherwise.

fn path_to_descendant<K: DerivedKey>(&self, other: &K) -> Option<DerivationPath>

Returns the path to the descendant, or None if the argument is definitely not a descendant.

impl<'de> Deserialize<'de> for DerivedXPriv

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<D> DigestSigner<D, Signature<Secp256k1>> for DerivedXPriv 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 DerivedXPriv 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 Parent for DerivedXPriv

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 Serialize for DerivedXPriv

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

Serialize this value into the given Serde serializer.