Skip to main content

Setup

Struct Setup 

Source
pub struct Setup<G> { /* private fields */ }
Expand description

A setup decides on what group elements we use to commit to vectors and their product.

A setup for an inner product argument for c = <a_i, b_i> needs generators to commit to a_i, which we call G_i, generators for b_i, which we call H_i, and a generator for the product, c, which we call Q, or “the product generator”.

We can support inner products of different sizes, as long as we have enough generators.

To construct this type, see Self::new.

Implementations§

Source§

impl<G> Setup<G>

Source

pub fn new( product_generator: G, g_and_h: impl IntoIterator<Item = (G, G)>, ) -> Self

Create a new Setup, given specific choices of the generator.

You MUST ensure that all of the values provided to this function are unique.

Source

pub fn g(&self) -> &[G]

The left-side generators G_i.

Source

pub fn h(&self) -> &[G]

The right-side generators H_i.

Source

pub const fn product_generator(&self) -> &G

The product generator Q.

Source

pub const fn supports(&self, lg_len: u8) -> bool

Check if this setup supports claims of a given length.

Source

pub fn eval<F: Field>( &self, f: impl FnOnce(&Setup<Synthetic<F, G>>) -> Option<Synthetic<F, G>>, strategy: &impl Strategy, ) -> Option<G>
where G: Space<F>,

Build a virtual setup, call f to obtain a verification equation, and evaluate it against the concrete generators in self.

Returns None when f returns None (malformed proof). Otherwise returns the evaluated group element, which should be zero for a valid proof.

Trait Implementations§

Source§

impl<G: Debug> Debug for Setup<G>

Source§

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

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

impl<G: EncodeSize> EncodeSize for Setup<G>

Source§

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).
Source§

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.
Source§

impl<G: PartialEq> PartialEq for Setup<G>

Source§

fn eq(&self, other: &Setup<G>) -> 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<G: Read> Read for Setup<G>

Source§

type Cfg = (usize, <G as Read>::Cfg)

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings. Read more
Source§

fn read_cfg( buf: &mut impl Buf, (max_len, cfg): &Self::Cfg, ) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg. Read more
Source§

impl<G: Write> Write for Setup<G>

Source§

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf. Read more
Source§

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.
Source§

impl<G> StructuralPartialEq for Setup<G>

Auto Trait Implementations§

§

impl<G> Freeze for Setup<G>
where G: Freeze,

§

impl<G> RefUnwindSafe for Setup<G>
where G: RefUnwindSafe,

§

impl<G> Send for Setup<G>
where G: Send,

§

impl<G> Sync for Setup<G>
where G: Sync,

§

impl<G> Unpin for Setup<G>
where G: Unpin,

§

impl<G> UnsafeUnpin for Setup<G>
where G: UnsafeUnpin,

§

impl<G> UnwindSafe for Setup<G>
where G: UnwindSafe,

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> Decode for T
where T: Read,

Source§

fn decode_cfg(buf: impl Buf, cfg: &Self::Cfg) -> Result<Self, Error>

Decodes a value from buf using cfg, ensuring the entire buffer is consumed. Read more
Source§

impl<T> Encode for T
where T: Write + EncodeSize,

Source§

fn encode(&self) -> Bytes

Encodes self into a new Bytes buffer. Read more
Source§

fn encode_mut(&self) -> BytesMut

Encodes self into a new BytesMut buffer. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Codec for T
where T: Encode + Decode,

Source§

impl<T> CodecShared for T
where T: Codec + Send + Sync,

Source§

impl<T> EncodeShared for T
where T: Encode + Send + Sync,