Struct SecretKey 

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

32-byte secp256k1 secret scalar.

Display and serde use lowercase hex. Debug deliberately hides the secret bytes — this type never logs in plaintext.

Example

use nula_core::SecretKey;

let sk = SecretKey::generate().unwrap();
let hex = sk.to_hex();
let restored = SecretKey::parse(&hex).unwrap();
assert_eq!(sk, restored);

Implementations

impl SecretKey

pub fn from_byte_array(bytes: [u8; 32]) -> Result<Self, SecretKeyError>

Construct a SecretKey from a fixed-size byte array.

Errors

Returns SecretKeyError::InvalidScalar if the bytes do not encode a valid secp256k1 scalar (i.e. 0 or >= n).

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

Construct a SecretKey from a byte slice.

Errors

Returns SecretKeyError::InvalidLength when the slice is not 32 bytes long, or SecretKeyError::InvalidScalar when the bytes are not a valid scalar.

pub fn parse<S>(input: S) -> Result<Self, SecretKeyError>

where S: AsRef<str>,

Parse a SecretKey from a 64-char lowercase hex string.

Errors

See SecretKeyError.

pub fn generate() -> Result<Self, SecretKeyError>

Generate a fresh SecretKey using the operating system’s entropy.

Errors

Returns SecretKeyError::Rng if the OS RNG fails, or SecretKeyError::InvalidScalar in the cryptographically negligible case where the random bytes happen to land on 0 or >= n.

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

Return the secret key as raw bytes.

pub fn to_hex(&self) -> String

Return the secret key as a 64-char lowercase hex string.

pub const fn as_inner(&self) -> &SecretKey

Borrow the inner secp256k1::SecretKey.

Use this only at the boundary with the cryptography backend.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate 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<'de> Deserialize<'de> for SecretKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for SecretKey

impl From<SecretKey> for Keys

fn from(secret_key: SecretKey) -> Self

Converts to this type from the input type.

impl FromBech32 for SecretKey

fn from_bech32(s: &str) -> Result<Self, FromBech32Error>

Parse the given NIP-19 bech32 string.

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SecretKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretKey

impl ToBech32 for SecretKey

fn to_bech32(&self) -> Result<String, ToBech32Error>

Produce the NIP-19 bech32 string.