Struct schnorr_fun::Signature

pub struct Signature<S = Public> {
    pub R: Point<EvenY>,
    pub s: Scalar<S, Zero>,
}

A Schnorr signature.

Fields

R: Point<EvenY>

The signature’s public nonce

s: Scalar<S, Zero>

The challenge response part of the signature.

Implementations

impl<S> Signature<S>

pub fn to_bytes(&self) -> [u8; 64]

Serializes the signature as 64 bytes – First the 32-byte nonce x-coordinate and then the 32-byte challenge response scalar.

Examples

let bytes = signature.to_bytes();
assert_eq!(signature.R.to_xonly_bytes(), bytes[..32]);
assert_eq!(signature.s.to_bytes(), bytes[32..]);

pub fn as_tuple(&self) -> (Point<EvenY>, &Scalar<S, Zero>)

Gets a reference to the signature components as a tuple.

Examples

let (R, s) = signature.as_tuple();

pub fn set_secrecy<M: Secrecy>(self) -> Signature<M>

Marks the signature with a Secrecy. If it is marked as Secret the operations (e.g. verification) on the signature should be done in constant time.

Examples

use schnorr_fun::{fun::marker::*, Signature};
let signature = Signature::random(&mut rand::thread_rng());
let secret_sig = signature.set_secrecy::<Secret>();

impl Signature<Public>

pub fn random<R: RngCore>(rng: &mut R) -> Self

Generates a uniformly distributed signature. It will be valid for an infinite number of messages on every key but computationally you will never be able to find one! Useful for testing.

Examples

use schnorr_fun::Signature;
let random_signature = Signature::random(&mut rand::thread_rng());

pub fn from_bytes(bytes: [u8; 64]) -> Option<Self>

Deserializes a signature from the byte representation produced by to_bytes.

This returns None if the first 32 bytes were not a valid x-only key or the last 32 bytes were not a valid scalar.

Examples

match Signature::from_bytes(bytes) {
    Some(signature) => println!("the bytes were a valid encoding of a signature!"),
    None => eprintln!("the bytes did *not* encode a valid signature"),
}

Trait Implementations

impl<'de, S: Secrecy> BorrowDecode<'de> for Signature<S>

Available on crate feature bincode only.

fn borrow_decode<D: BorrowDecoder<'de>>( decoder: &mut D ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<S: Clone> Clone for Signature<S>

fn clone(&self) -> Signature<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Signature<S>

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

Formats the type as hex and any markers on the type.

impl<S: Secrecy> Decode for Signature<S>

Available on crate feature bincode only.

fn decode<D: Decoder>(decoder: &mut D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de, S: Secrecy> Deserialize<'de> for Signature<S>

Available on crate feature serde only.

fn deserialize<Deser: Deserializer<'de>>( deserializer: Deser ) -> Result<Signature<S>, Deser::Error>

Deserialize this value from the given Serde deserializer.

impl<S> Display for Signature<S>

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

Displays as hex.

impl<S> Encode for Signature<S>

Available on crate feature bincode only.

fn encode<E: Encoder>(&self, encoder: &mut E) -> Result<(), EncodeError>

Encode a given type.

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

Converts to this type from the input type.

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

Converts to this type from the input type.

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

Converts to this type from the input type.

impl From<Signature> for Signature

fn from(sig: Signature) -> Self

Converts to this type from the input type.

impl<S: Secrecy> FromStr for Signature<S>

fn from_str(hex: &str) -> Result<Signature<S>, HexError>

Parses the string as hex and interprets tries to convert the resulting byte array into the desired value.

type Err = HexError

The associated error which can be returned from parsing.

impl<S1, S2> PartialEq<Signature<S2>> for Signature<S1>

fn eq(&self, rhs: &Signature<S2>) -> 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<S> Serialize for Signature<S>

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl<S: Eq> Eq for Signature<S>