Struct keynesis::key::ed25519_hd::SecretKey

pub struct SecretKey { /* fields omitted */ }

Implementations

impl SecretKey

pub const SIZE: usize

pub fn new<Rng>(rng: &mut Rng) -> Self where
    Rng: RngCore + CryptoRng, 

generate a new SecretKey with the given random number generator

pub fn is_3rd_highest_bit_clear(&self) -> bool

pub fn public_key(&self) -> PublicKey

get the PublicKey associated to this key

Unlike the SecretKey, the PublicKey can be safely publicly shared. The key can then be used to verify any Signature generated with this SecretKey and the original message.

pub fn chain(&self) -> &ChainCode

pub fn key(&self) -> &SecretKey

pub fn into_key(self) -> SecretKey

pub fn leak_to_hex(&self) -> String

pub fn exchange(&self, public_key: &PublicKey) -> SharedSecret

generate a shared secret between the owner of the given public key and ourselves.

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

create a Signature for the given message with this SecretKey.

The Signature can then be verified against the associated PublicKey and the original message.

pub fn derive<P>(&self, path: P) -> Self where
    P: AsRef<[u8]>, 

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Eq for SecretKey

impl FromStr for SecretKey

type Err = SecretKeyError

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 Hash for SecretKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<SecretKey> for SecretKey

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

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

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

This method tests for !=.

impl StructuralEq for SecretKey

impl StructuralPartialEq for SecretKey

impl<'a> TryFrom<&'a [u8]> for SecretKey

type Error = SecretKeyError

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[u8; 96]> for SecretKey

type Error = SecretKeyError

The type returned in the event of a conversion error.

fn try_from(bytes: [u8; 96]) -> Result<Self, Self::Error>

Performs the conversion.