Struct halo2_proofs::plonk::ProvingKey

pub struct ProvingKey<C>
where
    C: CurveAffine,
{ /* private fields */ }

This is a proving key which allows for the creation of proofs for a particular circuit.

Implementations

impl<C> ProvingKey<C>

where C: CurveAffine, <C as PrimeCurveAffine>::Scalar: FromUniformBytes<64>,

pub fn get_vk(&self) -> &VerifyingKey<C>

Get the underlying VerifyingKey.

impl<C> ProvingKey<C>

where C: SerdeCurveAffine, <C as PrimeCurveAffine>::Scalar: SerdePrimeField + FromUniformBytes<64>,

pub fn write<W>(&self, writer: &mut W, format: SerdeFormat) -> Result<(), Error>

where W: Write,

Writes a proving key to a buffer.

Writes a curve element according to format:

• Processed: Writes a compressed curve element with coordinates in standard form. Writes a field element in standard form, with endianness specified by the PrimeField implementation.
• Otherwise: Writes an uncompressed curve element with coordinates in Montgomery form Writes a field element into raw bytes in its internal Montgomery representation, WITHOUT performing the expensive Montgomery reduction. Does so by first writing the verifying key and then serializing the rest of the data (in the form of field polynomials)

pub fn read<R>( reader: &mut R, format: SerdeFormat, cs: ConstraintSystemBack<<C as PrimeCurveAffine>::Scalar> ) -> Result<ProvingKey<C>, Error>

where R: Read,

Reads a proving key from a buffer. Does so by reading verification key first, and then deserializing the rest of the file into the remaining proving key data.

Reads a curve element from the buffer and parses it according to the format:

• Processed: Reads a compressed curve element and decompresses it. Reads a field element in standard form, with endianness specified by the PrimeField implementation, and checks that the element is less than the modulus.
• RawBytes: Reads an uncompressed curve element with coordinates in Montgomery form. Checks that field elements are less than modulus, and then checks that the point is on the curve.
• RawBytesUnchecked: Reads an uncompressed curve element with coordinates in Montgomery form; does not perform any checks

pub fn to_bytes(&self, format: SerdeFormat) -> Vec<u8>

Writes a proving key to a vector of bytes using Self::write.

pub fn from_bytes( bytes: &[u8], format: SerdeFormat, cs: ConstraintSystemBack<<C as PrimeCurveAffine>::Scalar> ) -> Result<ProvingKey<C>, Error>

Reads a proving key from a slice of bytes using Self::read.

Trait Implementations

impl<C> Clone for ProvingKey<C>

where C: Clone + CurveAffine, <C as PrimeCurveAffine>::Scalar: Clone,

fn clone(&self) -> ProvingKey<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for ProvingKey<C>

where C: Debug + CurveAffine, <C as PrimeCurveAffine>::Scalar: Debug,

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

Formats the value using the given formatter.