Struct 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<(), Error>

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

Converts to this type from the input type.

impl FromBase32 for PayeePubKey

type Err = Bolt11ParseError

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

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

Convert a base32 slice to Self.

impl Hash for PayeePubKey

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

where __H: Hasher,

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

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

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

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

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

where W: WriteBase32,

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

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

Convert Self to base32 vector

impl Eq for PayeePubKey

impl StructuralPartialEq for PayeePubKey