Struct lightning_invoice::PayeePubKey

pub struct PayeePubKey(pub PublicKey);

Payee public key

Tuple Fields

0: PublicKey

Methods from Deref<Target = PublicKey>

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

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

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

Serializes the key as a byte-encoded pair of values. In compressed form the y-coordinate is represented by only a single bit, as x determines it up to one bit.

pub fn serialize_uncompressed(&self) -> [u8; 65]

Serializes the key as a byte-encoded pair of values, in uncompressed form.

pub fn combine(&self, other: &PublicKey) -> Result<PublicKey, Error>

Adds a second key to this one, returning the sum.

Errors

If the result would be the point at infinity, i.e. adding this point to its own negation.

Examples

use secp256k1::{rand, Secp256k1};

let secp = Secp256k1::new();
let mut rng = rand::thread_rng();
let (_, pk1) = secp.generate_keypair(&mut rng);
let (_, pk2) = secp.generate_keypair(&mut rng);
let sum = pk1.combine(&pk2).expect("It's improbable to fail for 2 random public keys");

pub fn x_only_public_key(&self) -> (XOnlyPublicKey, Parity)

Returns the XOnlyPublicKey (and it’s Parity) for this PublicKey.

Trait Implementations

impl Base32Len for PayeePubKey

fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for PayeePubKey

fn clone(&self) -> PayeePubKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayeePubKey

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

Formats the value using the given formatter.

impl Deref for PayeePubKey

type Target = PublicKey

The resulting type after dereferencing.

fn deref(&self) -> &PublicKey

Dereferences the value.

impl From<PublicKey> for PayeePubKey

fn from(pk: PublicKey) -> Self

Converts to this type from the input type.

impl FromBase32 for PayeePubKey

type Err = ParseError

The associated error which can be returned from parsing (e.g. because of bad padding).

fn from_base32(field_data: &[u5]) -> Result<PayeePubKey, ParseError>

Convert a base32 slice to Self.

impl Hash for PayeePubKey

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 PartialEq<PayeePubKey> for PayeePubKey

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

fn write_base32<W: WriteBase32>(
    &self,
    writer: &mut W
) -> Result<(), <W as WriteBase32>::Err>

Encode as base32 and write it to the supplied writer Implementations shouldn’t allocate.

fn to_base32(&self) -> Vec<u5, Global>

Convert Self to base32 vector

impl Eq for PayeePubKey

impl StructuralEq for PayeePubKey

impl StructuralPartialEq for PayeePubKey