Struct phoenix_core::SecretKey

pub struct SecretKey { /* private fields */ }

Secret (Spend) Key Secret pair of a and b defining a SecretKey

Safety

To ensure that no secret information lingers in memory after the variable goes out of scope, we advice calling zeroize before the variable goes out of scope.

Examples

Generate a random SecretKey:

use phoenix_core::SecretKey;
use rand::rngs::StdRng;
use rand::SeedableRng;
use zeroize::Zeroize;

let mut rng = StdRng::seed_from_u64(12345);
let mut sk = SecretKey::random(&mut rng);

// do something with the sk

sk.zeroize();

Implementations

impl SecretKey

pub fn new(a: JubJubScalar, b: JubJubScalar) -> Self

This method is used to construct a new SecretKey from the given secret pair of a and b.

pub fn a(&self) -> &JubJubScalar

Gets a

pub fn b(&self) -> &JubJubScalar

Gets b

pub fn random<R: RngCore + CryptoRng>(rng: &mut R) -> Self

Deterministically create a new SecretKey from a random number generator

pub fn gen_note_sk(&self, sa: impl Ownable) -> NoteSecretKey

Generates a NoteSecretKey using the R of the given [StealthAddress]. With the formula: note_sk = H(a · R) + b

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

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl From<&SecretKey> for PublicKey

fn from(sk: &SecretKey) -> Self

Converts to this type from the input type.

impl From<&SecretKey> for ViewKey

fn from(sk: &SecretKey) -> Self

Converts to this type from the input type.

impl PartialEq for SecretKey

fn eq(&self, other: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable<64> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

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

Serialize Self into a [[u8; N]].

fn from_bytes(buf: &[u8; 64]) -> Result<Self, Self::Error>

Deserialize a [&[u8; N]] into Self, it might be fail.

const SIZE: usize = N

The size of

impl Zeroize for SecretKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for SecretKey