Type Alias bitcoin::util::schnorr::KeyPair

source ·

pub type KeyPair = KeyPair;

👎Deprecated since 0.28.0: Please use util::key::KeyPair instead

Expand description

Deprecated re-export of secp256k1::KeyPair

Aliased Type§

struct KeyPair(/* private fields */);

Implementations§

source §

impl KeyPair

source

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::ONE_KEY;
use secp256k1::KeyPair;
use secp256k1::Secp256k1;

let secp = Secp256k1::new();
let key = ONE_KEY;
let key = KeyPair::from_secret_key(&secp, &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

source

pub fn as_ptr(&self) -> *const KeyPair

Obtains a raw const pointer suitable for use with FFI functions.

source

pub fn as_mut_ptr(&mut self) -> *mut KeyPair

Obtains a raw mutable pointer suitable for use with FFI functions.

source

pub fn from_secret_key<C>(secp: &Secp256k1<C>, sk: &SecretKey) -> KeyPairwhere C: Signing,

Creates a KeyPair directly from a Secp256k1 secret key.

source

pub fn from_seckey_slice<C>( secp: &Secp256k1<C>, data: &[u8] ) -> Result<KeyPair, Error>where C: Signing,

Creates a KeyPair directly from a secret key slice.

Errors

Error::InvalidSecretKey if the provided data has an incorrect length, exceeds Secp256k1 field p value or the corresponding public key is not even.

source

pub fn from_seckey_str<C>( secp: &Secp256k1<C>, s: &str ) -> Result<KeyPair, Error>where C: Signing,

Creates a KeyPair directly from a secret key string.

Errors

Error::InvalidSecretKey if corresponding public key for the provided secret key is not even.

source

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

Returns the secret bytes for this key pair.

source

pub fn tweak_add_assign<C>( &mut self, secp: &Secp256k1<C>, tweak: &Scalar ) -> Result<(), Error>where C: Verification,

👎Deprecated since 0.23.0: Use add_xonly_tweak instead

Tweaks a keypair by adding the given tweak to the secret key and updating the public key accordingly.

source

pub fn add_xonly_tweak<C>( self, secp: &Secp256k1<C>, tweak: &Scalar ) -> Result<KeyPair, Error>where C: Verification,

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::{Secp256k1, KeyPair, Scalar};
use secp256k1::rand::{RngCore, thread_rng};

let secp = Secp256k1::new();
let tweak = Scalar::random();

let mut key_pair = KeyPair::new(&secp, &mut thread_rng());
let tweaked = key_pair.add_xonly_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");