Struct bc::InternalPk

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

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

Implementations

impl InternalPk

pub fn from_unchecked(pk: XOnlyPk) -> Self

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

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

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

pub fn to_output_key( &self, merkle_root: Option<impl IntoTapHash> ) -> XOnlyPublicKey

👎Deprecated since 0.10.9: use to_output_pk

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

Methods from Deref<Target = XOnlyPk>

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

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 key_pair = KeyPair::new(&secp, &mut rand::thread_rng());
let (mut public_key, _) = key_pair.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)].

Trait Implementations

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

fn as_mut(&mut self) -> &mut <Self 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 Borrow<XOnlyPk> for InternalPk

fn borrow(&self) -> &XOnlyPk

Immutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl Clone for InternalPk

fn clone(&self) -> InternalPk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConsensusDecode for InternalPk

fn consensus_decode( reader: &mut impl Read ) -> Result<Self, ConsensusDecodeError>

fn consensus_deserialize( bytes: impl AsRef<[u8]> ) -> Result<Self, ConsensusDecodeError>

impl ConsensusEncode for InternalPk

fn consensus_encode(&self, writer: &mut impl Write) -> Result<usize, IoError>

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

impl Debug for InternalPk

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

Formats the value using the given formatter.

impl Deref for InternalPk

type Target = XOnlyPk

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for InternalPk

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for InternalPk

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InternalPk

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

Formats the value using the given formatter.

impl From<InternalPk> for [u8; 32]

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

Converts to this type from the input type.

impl From<InternalPk> for XOnlyPk

fn from(wrapped: InternalPk) -> Self

Converts to this type from the input type.

impl From<XOnlyPk> for InternalPk

fn from(v: XOnlyPk) -> Self

Converts to this type from the input type.

impl From<XOnlyPublicKey> for InternalPk

fn from(v: XOnlyPublicKey) -> Self

Converts to this type from the input type.

impl FromStr for InternalPk

type Err = <<InternalPk as Wrapper>::Inner as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for InternalPk

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

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 InternalPk

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

Formats the value using the given formatter.

impl Ord for InternalPk

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

Restrict a value to a certain interval.

impl PartialEq for InternalPk

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

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

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.

impl PartialOrd for InternalPk

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for InternalPk

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

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

impl StrictDumb for InternalPk

fn strict_dumb() -> Self

impl StrictEncode for InternalPk

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

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

impl StrictTuple for InternalPk

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for InternalPk

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Wrapper for InternalPk

type Inner = XOnlyPk

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

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

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::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 InternalPk

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

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

impl Copy for InternalPk

impl Eq for InternalPk

impl StrictProduct for InternalPk

impl StructuralEq for InternalPk

impl StructuralPartialEq for InternalPk