Struct PublicKey 

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

32-byte BIP-340 x-only public key.

Display and serde use lowercase 64-char hex.

Example

use nula_core::PublicKey;

let pk = PublicKey::parse(
    "79be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798",
)
.unwrap();
assert_eq!(pk.to_hex().len(), 64);

Implementations

impl PublicKey

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

Construct from a fixed-size byte array.

Errors

Returns PublicKeyError::InvalidPoint when the bytes do not encode a valid x-coordinate.

pub fn from_slice(bytes: &[u8]) -> Result<Self, PublicKeyError>

Construct from a byte slice.

Errors

Returns PublicKeyError::InvalidLength when the slice is not 32 bytes long, or PublicKeyError::InvalidPoint otherwise.

pub fn parse<S>(input: S) -> Result<Self, PublicKeyError>

where S: AsRef<str>,

Parse from a 64-char lowercase hex string.

Errors

See PublicKeyError.

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

Return the public key as raw bytes.

pub fn to_hex(self) -> String

Return the public key as a 64-char lowercase hex string.

pub const fn as_inner(&self) -> &XOnlyPublicKey

Borrow the inner secp256k1::XOnlyPublicKey.

Use this only at the boundary with the cryptography backend.

pub fn verify_schnorr(&self, message: &[u8; 32], sig: &Signature) -> bool

Verify a BIP-340 Schnorr signature against this public key.

message is the 32-byte digest the signer signed (typically the canonical NIP-01 event id). The function uses the global secp256k1 context and is therefore allocation-free.

Returns true when the signature is valid for this public key over message, false on every other path (invalid signature, wrong key, malformed point at construction time is impossible because PublicKey only holds curve-valid points).

Trait Implementations

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PublicKey

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: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

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 Eq for PublicKey

impl From<PublicKey> for Recipient

Available on crate feature nip17 only.

fn from(public_key: PublicKey) -> Self

Converts to this type from the input type.

impl From<XOnlyPublicKey> for PublicKey

fn from(value: XOnlyPublicKey) -> Self

Converts to this type from the input type.

impl FromBech32 for PublicKey

fn from_bech32(s: &str) -> Result<Self, FromBech32Error>

Parse the given NIP-19 bech32 string.

impl FromNostrUri for PublicKey

fn from_nostr_uri(uri: &str) -> Result<Self, Nip21Error>

Parse a nostr:<bech32> URI whose body matches Self.

impl FromStr for PublicKey

type Err = PublicKeyError

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 PublicKey

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 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.

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PublicKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PublicKey

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PublicKey

impl ToBech32 for PublicKey

fn to_bech32(&self) -> Result<String, ToBech32Error>

Produce the NIP-19 bech32 string.

impl ToNostrUri for PublicKey

fn to_nostr_uri(&self) -> Result<String, Nip21Error>

Produce the nostr:<bech32> URI for this value.