Struct bitcoin::XOnlyPublicKey

pub struct XOnlyPublicKey(_);

A x-only public key, used for verification of Schnorr signatures and serialized according to BIP-340.

Implementations

impl XOnlyPublicKey

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(keypair: &KeyPair) -> XOnlyPublicKey

Creates a new Schnorr public key from a Schnorr key pair.

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

Creates a Schnorr public key directly from a slice

Errors

Returns Error::InvalidPublicKey if the length of the data slice is not 32 bytes or the slice does not represent a valid Secp256k1 point x coordinate

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

Serialize the key as a byte-encoded x coordinate value (32 bytes).

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

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

Return

An opaque type representing the parity of the tweaked key, this should be provided to tweak_add_check which can be used to verify a tweak more efficiently than regenerating it and checking equality.

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: &XOnlyPublicKey,
    tweaked_parity: Parity,
    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.

Return

True if tweak and check is successful, false otherwise.

Trait Implementations

impl CPtr for XOnlyPublicKey

type Target = XOnlyPublicKey

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

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

impl Clone for XOnlyPublicKey

pub fn clone(&self) -> XOnlyPublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XOnlyPublicKey

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

Formats the value using the given formatter.

impl Deserialize for XOnlyPublicKey

fn deserialize(bytes: &[u8]) -> Result<Self, Error>

Deserialize a value from raw data.

impl<'de> Deserialize<'de> for XOnlyPublicKey

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

Deserialize this value from the given Serde deserializer.

impl Display for XOnlyPublicKey

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

Formats the value using the given formatter.

impl From<PublicKey> for XOnlyPublicKey

pub fn from(src: PublicKey) -> XOnlyPublicKey

Performs the conversion.

impl From<TweakedPublicKey> for XOnlyPublicKey

fn from(pair: TweakedPublicKey) -> Self

Performs the conversion.

impl From<XOnlyPublicKey> for XOnlyPublicKey

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

pub fn from(pk: XOnlyPublicKey) -> XOnlyPublicKey

Performs the conversion.

impl FromStr for XOnlyPublicKey

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for XOnlyPublicKey

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

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

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

Formats the value using the given formatter.

impl Ord for XOnlyPublicKey

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

Restrict a value to a certain interval.

impl PartialEq<XOnlyPublicKey> for XOnlyPublicKey

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

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

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

This method tests for !=.

impl PartialOrd<XOnlyPublicKey> for XOnlyPublicKey

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

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

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

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

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

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

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

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

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 XOnlyPublicKey

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 Serialize for XOnlyPublicKey

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl Copy for XOnlyPublicKey

impl Eq for XOnlyPublicKey

impl StructuralEq for XOnlyPublicKey

impl StructuralPartialEq for XOnlyPublicKey