Struct EncryptedSecretKey 

pub struct EncryptedSecretKey { /* private fields */ }

Available on crate feature nip49 only.

An encrypted secret key, ready to be bech32-encoded as ncryptsec1....

Debug redacts every byte so the value can be safely logged.

We deliberately do not implement Copy: even though every field is Copy-eligible, silently duplicating an encrypted secret across the stack would violate the principle that callers must reason explicitly about every place the ciphertext lives. Use Clone when you really need a second owned copy.

Implementations

impl EncryptedSecretKey

pub fn encrypt( secret: &SecretKey, password: &str, log_n: u8, security: KeySecurity, ) -> Result<Self, Nip49Error>

Encrypt secret under password with a random salt and nonce.

log_n is the scrypt cost parameter; spec recommends 16 for client UX and 21+ for cold-storage. security is recorded as AAD so any later tamper is caught by the AEAD.

Errors

Returns Nip49Error::LogNTooLarge / Nip49Error::InvalidParams when scrypt rejects the cost, or Nip49Error::Rng when the OS RNG is unavailable.

pub fn encrypt_with( secret: &SecretKey, password: &str, log_n: u8, security: KeySecurity, salt: [u8; 16], nonce: [u8; 24], ) -> Result<Self, Nip49Error>

Encrypt with a caller-supplied salt and nonce.

Use with care: reusing a (password, salt, nonce) triple across two encryptions defeats the AEAD. Reserved for known-answer test vectors and deterministic fixtures.

Errors

See Self::encrypt.

pub fn decrypt(&self, password: &str) -> Result<SecretKey, Nip49Error>

Recover the secret key with the same password used to encrypt.

Errors

Returns Nip49Error::Aead when the password is wrong or the ciphertext / security byte was tampered with, Nip49Error::SecretKey when the decrypted bytes do not encode a valid secp256k1 scalar, or Nip49Error::InvalidParams / Nip49Error::Scrypt for derivation failures.

pub const fn log_n(&self) -> u8

Cost parameter the secret was encrypted under.

pub const fn security(&self) -> KeySecurity

Security level the author declared at encryption time.

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

Encode as the spec-mandated ncryptsec1... bech32 string.

Errors

Returns Nip49Error::Encode only if the underlying bech32 crate rejects the payload, which on a 91-byte buffer is statically impossible.

pub fn from_bech32(input: &str) -> Result<Self, Nip49Error>

Decode from the ncryptsec1... bech32 string.

Errors

Returns Nip49Error::Decode for malformed bech32, Nip49Error::UnexpectedHrp when the HRP is not ncryptsec, Nip49Error::InvalidLength when the decoded payload is not exactly PAYLOAD_BYTES long, and Nip49Error::UnsupportedVersion / Nip49Error::InvalidKeySecurity when the payload header is malformed.

Trait Implementations

impl Clone for EncryptedSecretKey

fn clone(&self) -> EncryptedSecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptedSecretKey

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

Formats the value using the given formatter.

impl Drop for EncryptedSecretKey

fn drop(&mut self)

Best-effort zeroize on drop.

ciphertext is encrypted, but salt and nonce are privacy-relevant inputs to the scrypt KDF — wiping them reduces the chance that a freed allocation hands them to the next allocator caller. The compiler may still elide some writes under aggressive optimisation; the zeroize crate’s volatile-write implementation is the best portable mitigation we have.

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 EncryptedSecretKey

impl PartialEq for EncryptedSecretKey

fn eq(&self, other: &EncryptedSecretKey) -> 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 StructuralPartialEq for EncryptedSecretKey