Struct secp256k1::key::PublicKey

#[repr(transparent)]
pub struct PublicKey(_);

A Secp256k1 public key, used for verification of signatures

Implementations

impl PublicKey

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

Obtains a raw const pointer suitable for use with FFI functions

pub fn as_mut_ptr(&mut self) -> *mut PublicKey

Obtains a raw mutable pointer suitable for use with FFI functions

pub fn from_secret_key<C: Signing>(
    secp: &Secp256k1<C>,
    sk: &SecretKey
) -> PublicKey

Creates a new public key from a secret key.

pub fn from_slice(data: &[u8]) -> Result<PublicKey, Error>

Creates a public key directly from a slice

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

Serialize 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]

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

pub fn negate_assign<C: Verification>(&mut self, secp: &Secp256k1<C>)

Negates the pk to the pk self in place Will return an error if the pk would be invalid.

pub fn add_exp_assign<C: Verification>(
    &mut self,
    secp: &Secp256k1<C>,
    other: &[u8]
) -> Result<(), Error>

Adds the pk corresponding to other to the pk self in place Will return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

pub fn mul_assign<C: Verification>(
    &mut self,
    secp: &Secp256k1<C>,
    other: &[u8]
) -> Result<(), Error>

Muliplies the pk self in place by the scalar other Will return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

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

Adds a second key to this one, returning the sum. Returns an error if the result would be the point at infinity, i.e. we are adding this point to its own negation

pub fn combine_keys(keys: &[&PublicKey]) -> Result<PublicKey, Error>

Adds the keys in the provided slice together, returning the sum. Returns an error if the result would be the point at infinity, i.e. we are adding a point to its own negation

Trait Implementations

impl CPtr for PublicKey

type Target = PublicKey

fn as_c_ptr(&self) -> *const Self::Target

fn as_mut_c_ptr(&mut self) -> *mut Self::Target

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<PublicKey, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PublicKey

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

Formats the value using the given formatter.

impl From<PublicKey> for PublicKey

Creates a new public key from a FFI public key

fn from(pk: PublicKey) -> PublicKey

Performs the conversion.

impl From<PublicKey> for PublicKey

fn from(src: PublicKey) -> PublicKey

Performs the conversion.

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PublicKey, Error>

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

impl Hash for PublicKey

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for PublicKey

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

Formats the value using the given formatter.

impl Ord for PublicKey

fn cmp(&self, other: &PublicKey) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PublicKey> for PublicKey

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

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

fn ne(&self, other: &PublicKey) -> bool

This method tests for !=.

impl PartialOrd<PublicKey> for PublicKey

fn partial_cmp(&self, other: &PublicKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub 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 PublicKey

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for PublicKey

impl Eq for PublicKey

impl StructuralEq for PublicKey

impl StructuralPartialEq for PublicKey