Struct schnorrkel::vrf::VRFOutput

pub struct VRFOutput(pub [u8; 32]);

VRF output, possibly unverified.

Internally, we keep both RistrettoPoint and CompressedRistretto forms using RistrettoBoth.

We'd actually love to statically distinguish here between inputs and outputs, as well as whether outputs were verified, but doing so would disrupt our general purpose DLEQ proof mechanism, so users must be responcible for this themselves. We do however consume by value in actual output methods, and do not implement Copy, as a reminder that VRF outputs should only be used once and should be checked before usage.

Implementations

impl VRFOutput

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

Convert this VRF output to a byte array.

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

View this secret key as a byte array.

pub fn from_bytes(bytes: &[u8]) -> SignatureResult<VRFOutput>

Construct a VRFOutput from a slice of bytes.

pub fn attach_input_hash<T>(
    &self,
    public: &PublicKey,
    t: T
) -> SignatureResult<VRFInOut> where
    T: VRFSigningTranscript, 

Pair a non-malleable VRF output with the hash of the given transcript.

Trait Implementations

impl Clone for VRFOutput

fn clone(&self) -> VRFOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VRFOutput

impl Debug for VRFOutput

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

Formats the value using the given formatter.

impl Default for VRFOutput

fn default() -> VRFOutput

Returns the "default value" for a type.

impl Eq for VRFOutput

impl Hash for VRFOutput

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for VRFOutput

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<VRFOutput> for VRFOutput

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

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

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

This method tests for !=.

impl PartialOrd<VRFOutput> for VRFOutput

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

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

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

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

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

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

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

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

fn ge(&self, other: &VRFOutput) -> bool

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

impl StructuralEq for VRFOutput

impl StructuralPartialEq for VRFOutput