pub struct Keypair(/* private fields */);Expand description
Opaque data structure that holds a keypair consisting of a secret and a public key.
§Serde support
Implements de/serialization with the serde and global-context features enabled. Serializes
the secret bytes only. We treat the byte value as a tuple of 32 u8s for non-human-readable
formats. This representation is optimal for some formats (e.g. bincode) however other
formats may be less optimal (e.g. cbor). For human-readable formats we use a hex string.
§Examples
Basic usage:
use secp256k1::{rand, Keypair};
let (secret_key, public_key) = secp256k1::generate_keypair(&mut rand::rng());
let keypair = Keypair::from_secret_key(&secret_key);Implementations§
Source§impl Keypair
impl Keypair
Sourcepub fn display_secret(&self) -> DisplaySecret
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 precaution.
§Example
use secp256k1::{Keypair, Secp256k1, SecretKey};
let secp = Secp256k1::new();
let key = SecretKey::from_str("0000000000000000000000000000000000000000000000000000000000000001").unwrap();
let key = Keypair::from_secret_key(&key);
// 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())
);Source§impl Keypair
impl Keypair
Sourcepub fn cmp_fast_unstable(&self, other: &Self) -> Ordering
pub fn cmp_fast_unstable(&self, other: &Self) -> Ordering
Like cmp::Cmp but faster and with no guarantees across library versions.
The Cmp implementation for FFI types is stable but slow because it first
serializes self and other before comparing them. This function provides a faster
comparison if you know that your types come from the same library version.
Sourcepub fn eq_fast_unstable(&self, other: &Self) -> bool
pub fn eq_fast_unstable(&self, other: &Self) -> bool
Like cmp::Eq but faster and with no guarantees across library versions.
The Eq implementation for FFI types is stable but slow because it first serializes
self and other before comparing them. This function provides a faster equality
check if you know that your types come from the same library version.
Source§impl Keypair
impl Keypair
Sourcepub fn from_secret_key(sk: &SecretKey) -> Keypair
pub fn from_secret_key(sk: &SecretKey) -> Keypair
Creates a Keypair directly from a Secp256k1 secret key.
Sourcepub fn from_seckey_slice(data: &[u8]) -> Result<Keypair, Error>
👎Deprecated since 0.31.0: Use from_seckey_byte_array instead.
pub fn from_seckey_slice(data: &[u8]) -> Result<Keypair, Error>
from_seckey_byte_array instead.Creates a Keypair directly from a secret key slice.
§Errors
Error::InvalidSecretKey if the slice is not exactly 32 bytes long,
or if the encoded number is an invalid scalar.
Sourcepub fn from_seckey_byte_array(data: [u8; 32]) -> Result<Keypair, Error>
pub fn from_seckey_byte_array(data: [u8; 32]) -> Result<Keypair, Error>
Creates a Keypair directly from a secret key byte array.
§Errors
Error::InvalidSecretKey if the encoded number is an invalid scalar.
Sourcepub fn from_seckey_str(s: &str) -> Result<Self, Error>
👎Deprecated: use FromStr or parse instead
pub fn from_seckey_str(s: &str) -> Result<Self, Error>
Creates a Keypair directly from a secret key string.
§Errors
Error::InvalidSecretKey if the string does not consist of exactly 64 hex characters,
or if the encoded number is an invalid scalar.
Sourcepub fn from_seckey_str_global(s: &str) -> Result<Keypair, Error>
👎Deprecated: use FromStr or parse instead
pub fn from_seckey_str_global(s: &str) -> Result<Keypair, Error>
Creates a Keypair directly from a secret key string.
§Errors
Error::InvalidSecretKey if the string does not consist of exactly 64 hex characters,
or if the encoded number is an invalid scalar.
Sourcepub fn to_secret_bytes(&self) -> [u8; 32]
pub fn to_secret_bytes(&self) -> [u8; 32]
Returns the secret bytes for this key pair.
Sourcepub fn secret_bytes(&self) -> [u8; 32]
👎Deprecating in a future version: use to_secret_bytes instead
pub fn secret_bytes(&self) -> [u8; 32]
Returns the secret bytes for this key pair.
Sourcepub fn add_xonly_tweak(self, tweak: &Scalar) -> Result<Keypair, Error>
pub fn add_xonly_tweak(self, tweak: &Scalar) -> Result<Keypair, Error>
Tweaks a keypair by first converting the public key to an xonly key and tweaking it.
§Errors
Returns an error if the resulting key would be invalid.
NB: Will not error if the tweaked public key has an odd value and can’t be used for BIP 340-342 purposes.
§Examples
use secp256k1::{Keypair, Scalar};
let tweak = Scalar::random();
let mut keypair = Keypair::new(&mut rand::rng());
let tweaked = keypair.add_xonly_tweak(&tweak).expect("Improbable to fail with a randomly generated tweak");Sourcepub fn secret_key(&self) -> SecretKey
pub fn secret_key(&self) -> SecretKey
Returns the SecretKey for this Keypair.
This is equivalent to using SecretKey::from_keypair.
Sourcepub fn public_key(&self) -> PublicKey
pub fn public_key(&self) -> PublicKey
Returns the PublicKey for this Keypair.
This is equivalent to using PublicKey::from_keypair.
Sourcepub fn x_only_public_key(&self) -> (XOnlyPublicKey, Parity)
pub fn x_only_public_key(&self) -> (XOnlyPublicKey, Parity)
Returns the XOnlyPublicKey (and its Parity) for this Keypair.
This is equivalent to using XOnlyPublicKey::from_keypair.
Sourcepub fn sign_schnorr_no_aux_rand(&self, msg: &[u8]) -> Signature
pub fn sign_schnorr_no_aux_rand(&self, msg: &[u8]) -> Signature
Constructs a schnorr signature without aux rand for msg.
Sourcepub fn non_secure_erase(&mut self)
pub fn non_secure_erase(&mut self)
Attempts to erase the secret within the underlying array.
Note, however, that the compiler is allowed to freely copy or move the contents
of this array to other places in memory. Preventing this behavior is very subtle.
For more discussion on this, please see the documentation of the
zeroize crate.