Struct bpstd::XOnlyPk

source ·
pub struct XOnlyPk(/* private fields */);
Expand description

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§

source§

impl XOnlyPk

source

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

source

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

source

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 ) -> boolwhere 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: &Message, sig: &Signature ) -> Result<(), Error>where C: Verification,

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

Trait Implementations§

source§

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

source§

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

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

impl AsRef<XOnlyPk> for InternalPk

source§

fn as_ref(&self) -> &XOnlyPk

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

impl AsRef<XOnlyPk> for OutputPk

source§

fn as_ref(&self) -> &XOnlyPk

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

impl AsRef<XOnlyPublicKey> for XOnlyPk

source§

fn as_ref(&self) -> &XOnlyPublicKey

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

impl Borrow<XOnlyPk> for InternalPk

source§

fn borrow(&self) -> &XOnlyPk

Immutably borrows from an owned value. Read more
source§

impl Borrow<XOnlyPk> for OutputPk

source§

fn borrow(&self) -> &XOnlyPk

Immutably borrows from an owned value. Read more
source§

impl Borrow<XOnlyPublicKey> for XOnlyPk

source§

fn borrow(&self) -> &XOnlyPublicKey

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl Clone for XOnlyPk

source§

fn clone(&self) -> XOnlyPk

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for XOnlyPk

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for XOnlyPk

§

type Target = XOnlyPublicKey

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for XOnlyPk

source§

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

Mutably dereferences the value.
source§

impl Derive<XOnlyPk> for XpubDerivable

source§

fn keychains(&self) -> Range<u8>

source§

fn derive(&self, keychain: u8, index: impl Into<NormalIndex>) -> XOnlyPk

source§

fn derive_batch( &self, keychain: u8, from: impl Into<NormalIndex>, max_count: u8 ) -> Vec<D>

source§

impl DeriveKey<XOnlyPk> for XpubDerivable

source§

impl Display for XOnlyPk

source§

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

Formats the value using the given formatter. Read more
source§

impl From<CompressedPk> for XOnlyPk

source§

fn from(pubkey: CompressedPk) -> XOnlyPk

Converts to this type from the input type.
source§

impl From<InternalPk> for XOnlyPk

source§

fn from(wrapped: InternalPk) -> XOnlyPk

Converts to this type from the input type.
source§

impl From<OutputPk> for XOnlyPk

source§

fn from(wrapped: OutputPk) -> XOnlyPk

Converts to this type from the input type.
source§

impl From<PublicKey> for XOnlyPk

source§

fn from(pubkey: PublicKey) -> XOnlyPk

Converts to this type from the input type.
source§

impl From<XOnlyPk> for InternalPk

source§

fn from(v: XOnlyPk) -> InternalPk

Converts to this type from the input type.
source§

impl From<XOnlyPk> for OutputPk

source§

fn from(v: XOnlyPk) -> OutputPk

Converts to this type from the input type.
source§

impl From<XOnlyPk> for XOnlyPublicKey

source§

fn from(wrapped: XOnlyPk) -> XOnlyPublicKey

Converts to this type from the input type.
source§

impl From<XOnlyPublicKey> for XOnlyPk

source§

fn from(v: XOnlyPublicKey) -> XOnlyPk

Converts to this type from the input type.
source§

impl FromStr for XOnlyPk

§

type Err = PubkeyParseError<32>

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

impl Hash for XOnlyPk

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for XOnlyPk

source§

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

Formats the value using the given formatter.
source§

impl Ord for XOnlyPk

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for XOnlyPk

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for XOnlyPk

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StrictDecode for XOnlyPk

source§

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

§

fn strict_read(lim: usize, reader: impl Read) -> Result<Self, DecodeError>

source§

impl StrictDumb for XOnlyPk

source§

impl StrictEncode for XOnlyPk

source§

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

§

fn strict_write(&self, lim: usize, writer: impl Write) -> Result<usize, Error>

source§

impl StrictTuple for XOnlyPk

source§

const FIELD_COUNT: u8 = 1u8

§

fn strict_check_fields()

§

fn strict_type_info() -> TypeInfo<Self>

source§

impl StrictType for XOnlyPk

source§

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

§

fn strict_name() -> Option<TypeName>

source§

impl Wrapper for XOnlyPk

§

type Inner = XOnlyPublicKey

Inner type wrapped by the current newtype
source§

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

Instantiates wrapper type with the inner data
source§

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

Returns reference to the inner representation for the wrapper type
source§

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

Unwraps the wrapper returning the inner type
source§

fn to_inner(&self) -> Self::Innerwhere Self::Inner: Clone,

Clones inner data of the wrapped type and return them
source§

fn copy(&self) -> Selfwhere Self: Sized, Self::Inner: Copy,

Copies the wrapped type
source§

impl WrapperMut for XOnlyPk

source§

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

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

impl Copy for XOnlyPk

source§

impl Eq for XOnlyPk

source§

impl StrictProduct for XOnlyPk

source§

impl StructuralEq for XOnlyPk

source§

impl StructuralPartialEq for XOnlyPk

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Qwhere Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> ToHex for Twhere T: LowerHex,

§

fn to_hex(&self) -> String

Outputs the hash in hexadecimal form

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> VerifyEq for Twhere T: Eq,

source§

fn verify_eq(&self, other: &T) -> bool

Verifies commit-equivalence of two instances of the same type.