Struct bitcoin::util::schnorr::KeyPair

pub struct KeyPair(_);

Opaque data structure that holds a keypair consisting of a secret and a public key.

Implementations

impl KeyPair

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

Obtains a raw const pointer suitable for use with FFI functions

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

Obtains a raw mutable pointer suitable for use with FFI functions

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

Creates a Schnorr KeyPair directly from generic Secp256k1 secret key

Panics if internal representation of the provided [SecretKey] does not holds correct secret key value obtained from Secp256k1 library previously

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

Creates a Schnorr KeyPair directly from a secret key slice

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

Creates a Schnorr KeyPair directly from a secret key string

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

Tweak a keypair by adding the given tweak to the secret key and updating the public key accordingly. Will return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

Trait Implementations

impl Clone for KeyPair

pub fn clone(&self) -> KeyPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPair

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

Formats the value using the given formatter.

impl Hash for KeyPair

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for KeyPair

pub fn cmp(&self, other: &KeyPair) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeyPair> for KeyPair

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<KeyPair> for KeyPair

pub fn partial_cmp(&self, other: &KeyPair) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for KeyPair

impl Eq for KeyPair

impl StructuralEq for KeyPair

impl StructuralPartialEq for KeyPair