Struct secp256k1::schnorrsig::PublicKey

pub struct PublicKey(_);

A Schnorr public key, used for verification of Schnorr signatures

Methods

impl PublicKey

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

Obtains a raw const pointer suitable for use with FFI functions

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

Obtains a raw mutable pointer suitable for use with FFI functions

pub fn from_keypair<C: Signing>(
    secp: &Secp256k1<C>,
    keypair: &KeyPair
) -> PublicKey

Creates a new Schnorr public key from a Schnorr key pair

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

Creates a Schnorr public key directly from a slice

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

Serialize the key as a byte-encoded pair of values. In compressed form the y-coordinate is represented by only a single bit, as x determines it up to one bit.

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

Tweak an x-only PublicKey by adding the generator multiplied with the given tweak to it.

Returns a boolean representing the parity of the tweaked key, which can be provided to tweak_add_check which can be used to verify a tweak more efficiently than regenerating it and checking equality. Will return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

pub fn tweak_add_check<V: Verification>(
    &self,
    secp: &Secp256k1<V>,
    tweaked_key: &Self,
    tweaked_parity: bool,
    tweak: [u8; 32]
) -> bool

Verify that a tweak produced by tweak_add_assign was computed correctly

Should be called on the original untweaked key. Takes the tweaked key and output parity from tweak_add_assign as input.

Currently this is not much more efficient than just recomputing the tweak and checking equality. However, in future this API will support batch verification, which is significantly faster, so it is wise to design protocols with this in mind.

Trait Implementations

impl From<XOnlyPublicKey> for PublicKey

Creates a new Schnorr public key from a FFI x-only public key

fn from(pk: XOnlyPublicKey) -> PublicKey

Performs the conversion.

impl From<PublicKey> for PublicKey

fn from(src: PublicKey) -> PublicKey

Performs the conversion.

impl Ord for PublicKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<PublicKey> for PublicKey

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

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

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

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

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

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

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

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

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

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

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PublicKey> for PublicKey

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

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

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

This method tests for !=.

impl Eq for PublicKey

impl Copy for PublicKey

impl Display for PublicKey

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

Formats the value using the given formatter.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl Hash for PublicKey

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PublicKey, Error>

Parses a string s to return a value of this type.

impl LowerHex for PublicKey

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

Formats the value using the given formatter.

impl CPtr for PublicKey

type Target = XOnlyPublicKey

fn as_c_ptr(&self) -> *const Self::Target

fn as_mut_c_ptr(&mut self) -> *mut Self::Target