Struct SecretKey

pub struct SecretKey { /* private fields */ }

SecretKey

Implementations

impl SecretKey

pub fn from_slice(slice: &[u8]) -> Result<SecretKey, Error>

Parse from bytes

pub fn from_hex<S>(hex: S) -> Result<SecretKey, Error>

where S: AsRef<str>,

Parse from hex string

pub fn generate() -> SecretKey

Generate random secret key

pub fn to_secret_hex(&self) -> String

Get secret key as hex string

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

Get secret key as bytes

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

Get secret key as bytes

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

Schnorr Signature on Message

pub fn public_key(&self) -> PublicKey

Get public key

pub fn to_scalar(self) -> Scalar

SecretKey to Scalar

pub fn as_scalar(&self) -> Scalar

SecretKey as Scalar

impl SecretKey

pub fn from_xpriv( xpriv: Xpriv, keyset_id: Id, counter: u32, ) -> Result<SecretKey, Error>

Create new SecretKey from xpriv

Methods from Deref<Target = SecretKey>

pub fn display_secret(&self) -> DisplaySecret

Formats the explicit byte value of the secret key kept inside the type as a little-endian hexadecimal string using the provided formatter.

This is the only method that outputs the actual secret key value, and, thus, should be used with extreme caution.

Examples

use secp256k1::SecretKey;
let key = SecretKey::from_str("0000000000000000000000000000000000000000000000000000000000000001").unwrap();

// Normal debug hides value (`Display` is not implemented for `SecretKey`).
// E.g., `format!("{:?}", key)` prints "SecretKey(#2518682f7819fb2d)".

// Here we explicitly display the secret value:
assert_eq!(
    "0000000000000000000000000000000000000000000000000000000000000001",
    format!("{}", key.display_secret())
);
// Also, we can explicitly display with `Debug`:
assert_eq!(
    format!("{:?}", key.display_secret()),
    format!("DisplaySecret(\"{}\")", key.display_secret())
);

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

Returns the secret key as a byte value.

pub fn keypair<C>(&self, secp: &Secp256k1<C>) -> Keypair

where C: Signing,

Returns the Keypair for this SecretKey.

This is equivalent to using Keypair::from_secret_key.

pub fn public_key<C>(&self, secp: &Secp256k1<C>) -> PublicKey

where C: Signing,

Returns the PublicKey for this SecretKey.

This is equivalent to using PublicKey::from_secret_key.

pub fn x_only_public_key<C>( &self, secp: &Secp256k1<C>, ) -> (XOnlyPublicKey, Parity)

where C: Signing,

Returns the XOnlyPublicKey (and it’s Parity) for this SecretKey.

This is equivalent to XOnlyPublicKey::from_keypair(self.keypair(secp)).

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<(), Error>

Formats the value using the given formatter.

impl Deref for SecretKey

type Target = SecretKey

The resulting type after dereferencing.

fn deref(&self) -> &<SecretKey as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SecretKey

fn deserialize<D>( deserializer: D, ) -> Result<SecretKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<SecretKey> for SecretKey

fn from(inner: SecretKey) -> SecretKey

Converts to this type from the input type.

impl FromStr for SecretKey

fn from_str(secret_key: &str) -> Result<SecretKey, <SecretKey as FromStr>::Err>

Try to parse SecretKey from hex or bech32

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for SecretKey

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecretKey

impl StructuralPartialEq for SecretKey