Struct XOnlyPubKey

pub struct XOnlyPubKey { /* private fields */ }

---

Implementations

impl XOnlyPubKey

pub fn is_null(&self) -> bool

| Test whether this is the 0 key (the result | of default construction). This implies | !IsFullyValid(). |

pub fn data(&self) -> *const u8

pub fn size() -> usize

pub fn begin(&self) -> *const u8

pub fn end(&self) -> *const u8

pub fn begin_mut(&mut self) -> *mut u8

pub fn end_mut(&mut self) -> *mut u8

pub fn get_key_ids(&self) -> Vec<KeyID>

| Returns a list of CKeyIDs for the CPubKeys | that could have been used to create this | | XOnlyPubKey. | | This is needed for key lookups since | keys are indexed by CKeyID. |

pub fn is_fully_valid(&self) -> bool

| Determine if this pubkey is fully valid. | This is true for approximately 50% of | all possible 32-byte arrays. If false, | | VerifySchnorr and CreatePayToContract | will always fail. |

pub fn verify_schnorr(&self, msg: &u256, sigbytes: &[u8]) -> bool

| Verify a Schnorr signature against | this public key. sigbytes must be exactly | 64 bytes. |

pub fn compute_tap_tweak_hash(&self, merkle_root: *const u256) -> u256

| Compute the Taproot tweak as specified | in BIP341, with *this as internal key: | | - if merkle_root == nullptr: H_TapTweak(xonly_pubkey) | | - otherwise: H_TapTweak(xonly_pubkey || *merkle_root) | | ———– | @note | | the behavior of this function with merkle_root | != nullptr is consensus critical. |

pub fn check_tap_tweak( &self, internal: &XOnlyPubKey, merkle_root: &u256, parity: bool, ) -> bool

| Verify that this is a Taproot tweaked | output point, against a specified internal | key, | | Merkle root, and parity. |

pub fn create_tap_tweak( &self, merkle_root: *const u256, ) -> Option<(XOnlyPubKey, bool)>

| Construct a Taproot tweaked output | point with this point as internal key. |

Trait Implementations

impl Default for XOnlyPubKey

fn default() -> XOnlyPubKey

Returns the “default value” for a type.

impl From<&[u8]> for XOnlyPubKey

fn from(bytes: &[u8]) -> Self

| Construct an x-only pubkey from exactly | 32 bytes. |

impl From<&PubKey> for XOnlyPubKey

fn from(pubkey: &PubKey) -> Self

| Construct an x-only pubkey from a normal | pubkey. |

impl Index<i32> for XOnlyPubKey

type Output = u8

The returned type after indexing.

fn index(&self, pos: i32) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for XOnlyPubKey

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

fn eq(&self, other: &XOnlyPubKey) -> 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 XOnlyPubKey

fn partial_cmp(&self, other: &XOnlyPubKey) -> 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 Eq for XOnlyPubKey