Struct schnorrkel::vrf::VRFInOut

pub struct VRFInOut {
    pub input: RistrettoBoth,
    pub output: RistrettoBoth,
}

VRF input and output paired together, possibly unverified.

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

Fields

input: RistrettoBoth

VRF input point

output: RistrettoBoth

VRF output point

Implementations

impl VRFInOut

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

VRF output point bytes for serialization.

pub fn to_output(&self) -> VRFOutput

VRF output point bytes for serialization.

pub fn commit<T: SigningTranscript>(&self, t: &mut T)

Commit VRF input and output to a transcript.

We commit both the input and output to provide the 2Hash-DH construction from Theorem 2 on page 32 in appendix C of “Ouroboros Praos: An adaptively-secure, semi-synchronous proof-of-stake blockchain” by Bernardo David, Peter Gazi, Aggelos Kiayias, and Alexander Russell.

We use this construction both for the VRF usage methods VRFInOut::make_* as well as for signer side batching.

pub fn make_bytes<B: Default + AsMut<[u8]>>(&self, context: &[u8]) -> B

Raw bytes output from the VRF.

If you are not the signer then you must verify the VRF before calling this method.

If called with distinct contexts then outputs should be independent.

We incorporate both the input and output to provide the 2Hash-DH construction from Theorem 2 on page 32 in appendex C of “Ouroboros Praos: An adaptively-secure, semi-synchronous proof-of-stake blockchain” by Bernardo David, Peter Gazi, Aggelos Kiayias, and Alexander Russell.

pub fn make_rng<R: SeedableRng>(&self, context: &[u8]) -> R

VRF output converted into any SeedableRng.

If you are not the signer then you must verify the VRF before calling this method.

We expect most users would prefer the less generic VRFInOut::make_chacharng method.

pub fn make_merlin_rng(&self, context: &[u8]) -> TranscriptRng

VRF output converted into Merlin’s Keccek based Rng.

If you are not the signer then you must verify the VRF before calling this method.

We think this might be marginally slower than ChaChaRng when considerable output is required, but it should reduce the final linked binary size slightly, and improves domain separation.

Trait Implementations

impl Clone for VRFInOut

fn clone(&self) -> VRFInOut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VRFInOut

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

Formats the value using the given formatter.

impl Hash for VRFInOut

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

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

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

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

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

This method tests for !=.

impl PartialOrd<VRFInOut> for VRFInOut

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

impl StructuralEq for VRFInOut

impl StructuralPartialEq for VRFInOut