Skip to main content

ROInput

Struct ROInput 

Source
pub struct ROInput {
    fields: Vec<Fp>,
    bits: BitVec<u8>,
}
Expand description

Random oracle input structure

The random oracle input encapsulates the serialization format and methods using during hashing.

When implementing the Hashable trait to enable hashing for a type, you must implement its to_roinput() serialization method using the ROInput functions below.

The random oracle input structure is used (by generic code) to serialize the object into both a vector of pasta::Fp field elements and into a vector of bytes, depending on the situation.

Here is an example of how ROInput is used during the definition of the Hashable trait.

use mina_hasher::{Hashable, ROInput};
use mina_curves::pasta::Fp;

#[derive(Clone)]
pub struct MyExample {
    pub x: Fp,
    pub y: Fp,
    pub nonce: u64,
}

impl Hashable for MyExample {
    type D = ();

    fn to_roinput(&self) -> ROInput {
        ROInput::new()
            .append_field(self.x)
            .append_field(self.y)
            .append_u64(self.nonce)
    }

    fn domain_string(_: Self::D) -> Option<String> {
        format!("MyExampleMainnet").into()
    }
}

Details: For technical reasons related to our proof system and performance, non-field-element members are serialized for signing differently than other types. Additionally, during signing all members of the random oracle input get serialized together in two different ways: both as bytes and as a vector of field elements. The random oracle input automates and encapsulates this complexity.

Fields§

§fields: Vec<Fp>§bits: BitVec<u8>

Implementations§

Source§

impl ROInput

Source

pub fn new() -> Self

Create a new empty random oracle input

Source

pub fn append_hashable(self, input: &impl Hashable) -> Self

Append a Hashable input

Source

pub fn append_roinput(self, roi: Self) -> Self

Append another random oracle input

Source

pub fn append_field(self, f: Fp) -> Self

Append a base field element

Source

pub fn append_scalar(self, s: Fq) -> Self

Append a scalar field element by converting it to bits.

This method converts the scalar field element to its byte representation, then extracts exactly [Fq::MODULUS_BIT_SIZE] bits (255 bits for Pallas curve) in little-endian bit order and appends them to the bits vector.

§Bit Representation
  • Uses little-endian bit ordering within bytes (LSB first)
  • Extracts exactly 255 bits from the 32-byte scalar representation
  • The scalar field modulus is 255 bits, so the MSB of the 32nd byte is unused
§Differences from Self::append_field
§Examples
use mina_hasher::ROInput;
use mina_curves::pasta::Fq;

// Regular scalar value
let scalar = Fq::from(42u64);
let roi = ROInput::new().append_scalar(scalar);
let bytes = roi.to_bytes();
assert_eq!(bytes.len(), 32); // 255 bits rounded up to 32 bytes

// Maximum scalar value (modulus - 1)
let max_scalar = Fq::from(0u64) - Fq::from(1u64);
let roi = ROInput::new().append_scalar(max_scalar);
let bytes = roi.to_bytes();
assert_eq!(bytes.len(), 32); // 255 bits rounded up to 32 bytes
§Note

All scalar field values, including the maximum value (modulus - 1), will fit exactly in 255 bits and can be safely appended.

Source

pub fn append_bool(self, b: bool) -> Self

Append a single bit

Source

pub fn append_bytes(self, bytes: &[u8]) -> Self

Append bytes

Source

pub fn append_u32(self, x: u32) -> Self

Append a 32-bit unsigned integer

Source

pub fn append_u64(self, x: u64) -> Self

Append a 64-bit unsigned integer

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize random oracle input to bytes

Source

pub fn to_fields(&self) -> Vec<Fp>

Convert the random oracle input to a vector of packed field elements by packing the bits into field elements and appending them to the fields. The bits are packed by taking chunks of size Fp::MODULUS_BIT_SIZE - 1.

§Panics

Panics if a bit chunk cannot be converted to a valid base field element.

Source

pub fn serialize(&self) -> Vec<u8>

Serialize the ROInput into bytes

Source

pub fn deserialize(input: &[u8]) -> Result<Self, Error>

Deserialize a ROInput from bytes

§Errors

Returns Error if the input is too short, the header lengths are inconsistent with the payload size, or a field element cannot be reconstructed from the bits.

§Panics

Panics if the header slice conversion to a fixed-size array fails (unreachable after the length check).

Trait Implementations§

Source§

impl Clone for ROInput

Source§

fn clone(&self) -> ROInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ROInput

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ROInput

Source§

fn default() -> ROInput

Returns the “default value” for a type. Read more
Source§

impl Eq for ROInput

Source§

impl PartialEq for ROInput

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ROInput

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V