Struct bitcoin::util::schnorr::PublicKey

pub struct PublicKey(_);

A Schnorr public key, used for verification of Schnorr signatures

Implementations

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>(secp: &Secp256k1<C>, keypair: &KeyPair) -> PublicKey where
    C: Signing, 

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>(
    &mut self,
    secp: &Secp256k1<V>,
    tweak: &[u8]
) -> Result<bool, Error> where
    V: Verification, 

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>(
    &self,
    secp: &Secp256k1<V>,
    tweaked_key: &PublicKey,
    tweaked_parity: bool,
    tweak: [u8; 32]
) -> bool where
    V: Verification, 

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 CPtr for PublicKey

type Target = XOnlyPublicKey

pub fn as_c_ptr(&self) -> *const <PublicKey as CPtr>::Target

pub fn as_mut_c_ptr(&mut self) -> *mut <PublicKey as CPtr>::Target

impl Clone for PublicKey

pub fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

pub fn deserialize<D>(
    d: D
) -> Result<PublicKey, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for PublicKey

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

Formats the value using the given formatter.

impl From<PublicKey> for PublicKey

pub fn from(src: PublicKey) -> PublicKey

Performs the conversion.

impl From<XOnlyPublicKey> for PublicKey

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

pub fn from(pk: XOnlyPublicKey) -> PublicKey

Performs the conversion.

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for PublicKey

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 LowerHex for PublicKey

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

Formats the value using the given formatter.

impl Ord for PublicKey

pub fn cmp(&self, other: &PublicKey) -> 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<PublicKey> for PublicKey

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

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

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

This method tests for !=.

impl PartialOrd<PublicKey> for PublicKey

pub fn partial_cmp(&self, other: &PublicKey) -> 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 Serialize for PublicKey

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

Serialize this value into the given Serde serializer.

impl Copy for PublicKey

impl Eq for PublicKey

impl StructuralEq for PublicKey

impl StructuralPartialEq for PublicKey