Struct InternalPk

Source

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

Expand description

Internal taproot public key, which can be present only in key fragment inside taproot descriptors.

Implementations§

Source §

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

Source

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

Source

pub fn to_xonly_pk(&self) -> XOnlyPk

Source

pub fn to_output_pk( &self, merkle_root: Option<TapNodeHash>, ) -> (OutputPk, Parity)

Methods from Deref<Target = XOnlyPk>§

Source

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

Methods from Deref<Target = XOnlyPublicKey>§

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

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

Source

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));