Struct XOnlyPk

pub struct XOnlyPk(/* private fields */);

Generic taproot x-only (BIP-340) public key - a wrapper around XOnlyPublicKey providing APIs compatible with the rest of the library. Should be used everywhere when InternalPk and OutputPk do not apply: as an output of BIP32 key derivation functions, inside tapscripts/ leafscripts etc.

Implementations

impl XOnlyPk

pub fn from_byte_array(data: [u8; 32]) -> Result<XOnlyPk, InvalidPubkey<32>>

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

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<XOnlyPk, InvalidPubkey<33>>

Methods from Deref<Target = XOnlyPublicKey>

pub fn cmp_fast_unstable(&self, other: &XOnlyPublicKey) -> Ordering

Like cmp::Cmp but faster and with no guarantees across library versions.

The Cmp implementation for FFI types is stable but slow because it first serializes self and other before comparing them. This function provides a faster comparison if you know that your types come from the same library version.

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

Like cmp::Eq but faster and with no guarantees across library versions.

The Eq implementation for FFI types is stable but slow because it first serializes self and other before comparing them. This function provides a faster equality check if you know that your types come from the same library version.

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

👎Deprecated since 0.25.0: Use Self::as_c_ptr if you need to access the FFI layer

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

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

👎Deprecated since 0.25.0: Use Self::as_mut_c_ptr if you need to access the FFI layer

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

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

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

pub fn tweak_add_check<V>( &self, secp: &Secp256k1<V>, tweaked_key: &XOnlyPublicKey, tweaked_parity: Parity, tweak: Scalar, ) -> bool

where V: Verification,

Verifies that a tweak produced by XOnlyPublicKey::add_tweak was computed correctly.

Should be called on the original untweaked key. Takes the tweaked key and output parity from XOnlyPublicKey::add_tweak 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.

Returns

True if tweak and check is successful, false otherwise.

Examples

use secp256k1::{Secp256k1, Keypair, Scalar};

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

let mut keypair = Keypair::new(&secp, &mut rand::thread_rng());
let (mut public_key, _) = keypair.x_only_public_key();
let original = public_key;
let (tweaked, parity) = public_key.add_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
assert!(original.tweak_add_check(&secp, &tweaked, parity, tweak));

pub fn public_key(&self, parity: Parity) -> PublicKey

Returns the PublicKey for this XOnlyPublicKey.

This is equivalent to using [PublicKey::from_xonly_and_parity(self, parity)].

pub fn verify<C>( &self, secp: &Secp256k1<C>, msg: &[u8], sig: &Signature, ) -> Result<(), Error>

where C: Verification,

Checks that sig is a valid schnorr signature for msg using this public key.

Trait Implementations

impl AsMut<<XOnlyPk as Wrapper>::Inner> for XOnlyPk

fn as_mut(&mut self) -> &mut <XOnlyPk as Wrapper>::Inner

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<XOnlyPk> for InternalPk

fn as_ref(&self) -> &XOnlyPk

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XOnlyPk> for OutputPk

fn as_ref(&self) -> &XOnlyPk

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<XOnlyPublicKey> for XOnlyPk

fn as_ref(&self) -> &XOnlyPublicKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<XOnlyPk> for InternalPk

fn borrow(&self) -> &XOnlyPk

Immutably borrows from an owned value.

impl Borrow<XOnlyPk> for OutputPk

fn borrow(&self) -> &XOnlyPk

Immutably borrows from an owned value.

impl Borrow<XOnlyPublicKey> for XOnlyPk

fn borrow(&self) -> &XOnlyPublicKey

Immutably borrows from an owned value.

impl BorrowMut<<XOnlyPk as Wrapper>::Inner> for XOnlyPk

fn borrow_mut(&mut self) -> &mut <XOnlyPk as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for XOnlyPk

fn clone(&self) -> XOnlyPk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XOnlyPk

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

Formats the value using the given formatter.

impl Deref for XOnlyPk

type Target = XOnlyPublicKey

The resulting type after dereferencing.

fn deref(&self) -> &<XOnlyPk as Deref>::Target

Dereferences the value.

impl DerefMut for XOnlyPk

fn deref_mut(&mut self) -> &mut <XOnlyPk as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for XOnlyPk

fn deserialize<__D>( __deserializer: __D, ) -> Result<XOnlyPk, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for XOnlyPk

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

Formats the value using the given formatter.

impl From<CompressedPk> for XOnlyPk

fn from(pubkey: CompressedPk) -> XOnlyPk

Converts to this type from the input type.

impl From<InternalPk> for XOnlyPk

fn from(wrapped: InternalPk) -> XOnlyPk

Converts to this type from the input type.

impl From<OutputPk> for XOnlyPk

fn from(wrapped: OutputPk) -> XOnlyPk

Converts to this type from the input type.

impl From<PublicKey> for XOnlyPk

fn from(pubkey: PublicKey) -> XOnlyPk

Converts to this type from the input type.

impl From<XOnlyPk> for [u8; 32]

fn from(pk: XOnlyPk) -> [u8; 32]

Converts to this type from the input type.

impl From<XOnlyPk> for InternalPk

fn from(v: XOnlyPk) -> InternalPk

Converts to this type from the input type.

impl From<XOnlyPk> for OutputPk

fn from(v: XOnlyPk) -> OutputPk

Converts to this type from the input type.

impl From<XOnlyPk> for XOnlyPublicKey

fn from(wrapped: XOnlyPk) -> XOnlyPublicKey

Converts to this type from the input type.

impl From<XOnlyPublicKey> for XOnlyPk

fn from(v: XOnlyPublicKey) -> XOnlyPk

Converts to this type from the input type.

impl FromStr for XOnlyPk

type Err = PubkeyParseError<32>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<XOnlyPk, <XOnlyPk as FromStr>::Err>

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

impl Hash for XOnlyPk

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for XOnlyPk

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

Formats the value using the given formatter.

impl Ord for XOnlyPk

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for XOnlyPk

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for XOnlyPk

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for XOnlyPk

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for XOnlyPk

fn strict_decode(reader: &mut impl TypedRead) -> Result<XOnlyPk, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for XOnlyPk

fn strict_dumb() -> XOnlyPk

impl StrictEncode for XOnlyPk

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for XOnlyPk

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for XOnlyPk

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Wrapper for XOnlyPk

type Inner = XOnlyPublicKey

Inner type wrapped by the current newtype

fn from_inner(inner: <XOnlyPk as Wrapper>::Inner) -> XOnlyPk

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<XOnlyPk as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <XOnlyPk as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl WrapperMut for XOnlyPk

fn as_inner_mut(&mut self) -> &mut <XOnlyPk as Wrapper>::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl Copy for XOnlyPk

impl Eq for XOnlyPk

impl StrictProduct for XOnlyPk

impl StructuralPartialEq for XOnlyPk