Struct XPrv

pub struct XPrv(/* private fields */);

HDWallet extended private key

Effectively this is an ed25519 extended secret key (64 bytes) followed by a chain code (32 bytes).

Implementations

impl XPrv

pub fn normalize_bytes_force3rd(bytes: [u8; 96]) -> Self

takes the given raw bytes and perform some modifications to normalize to a valid Ed25519 extended key, but it does also force the 3rd highest bit to be cleared too.

pub fn normalize_bytes_ed25519(bytes: [u8; 96]) -> Self

Takes the given raw bytes and perform some modifications to normalize to a valid Ed25519 extended key. It doesn’t touch the 3rd highest bit as expected in the ed25519-bip32 paper.

pub fn is_3rd_highest_bit_clear(&self) -> bool

Check if the 3rd highest bit is clear as expected from the paper

pub fn clear_3rd_highest_bit(self) -> Self

Clear the 3rd highest bit as expected from the paper setting

pub fn from_nonextended_force(bytes: &[u8; 32], chain_code: &[u8; 32]) -> Self

Takes a non-extended Ed25519 secret key and hash through SHA512 it in the same way the standard Ed25519 signature system make extended key, but also force clear the 3rd highest bit of the key instead of returning an error

pub fn from_nonextended_noforce( bytes: &[u8; 32], chain_code: &[u8; 32], ) -> Result<Self, ()>

Takes a non-extended Ed25519 secret key and hash through SHA512 it in the same way the standard Ed25519 signature system make extended key. If the 3rd highest bit is set, then return an error

bip32-ed25519 paper:

“2) We admit only those ~k such that the third highest bit of the last byte of kL is zero.”

pub fn from_extended_and_chaincode(sk: &[u8; 64], chain_code: &[u8; 32]) -> Self

create a XPrv by its components (a 64 bytes extended secret key, and a 32 bytes chain code)

No verification is done on the extended secret key

pub fn from_bytes_verified(bytes: [u8; 96]) -> Result<Self, PrivateKeyError>

Create a XPrv by taking ownership of the given array

This function may returns an error if it does not have the expected format.

This function allow the 3rd highest bit to not be clear (to handle potential derived valid xprv), but self.is_3rd_highest_bit_clear() can be called to check if the 3rd highest bit is assumed to be clear or not.

pub fn from_slice_verified(bytes: &[u8]) -> Result<Self, PrivateKeyError>

pub fn public(&self) -> XPub

Get the associated XPub

pub fn sign<T>(&self, message: &[u8]) -> Signature<T>

sign the given message with the XPrv.

pub fn verify<T>(&self, message: &[u8], signature: &Signature<T>) -> bool

verify a given signature

pub fn derive(&self, scheme: DerivationScheme, index: DerivationIndex) -> Self

pub fn get_extended_mut(&self, out: &mut [u8; 64])

pub fn extended_secret_key_bytes(&self) -> &[u8; 64]

pub fn extended_secret_key_slice(&self) -> &[u8]

pub fn chain_code(&self) -> &[u8; 32]

pub fn chain_code_slice(&self) -> &[u8]

pub fn extended_secret_key(&self) -> [u8; 64]

Trait Implementations

impl AsRef<[u8]> for XPrv

fn as_ref(&self) -> &[u8]

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

impl Clone for XPrv

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 XPrv

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

Formats the value using the given formatter.

impl Display for XPrv

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

Formats the value using the given formatter.

impl Drop for XPrv

fn drop(&mut self)

Executes the destructor for this type.

impl From<XPrv> for [u8; 96]

fn from(v: XPrv) -> [u8; 96]

Converts to this type from the input type.

impl PartialEq for XPrv

fn eq(&self, rhs: &XPrv) -> 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 Eq for XPrv