pub struct ProvableCircuit<F: Halo2FFTFriendlyField> {
circuit_description: GKRCircuitDescription<F>,
inputs: HashMap<LayerId, MultilinearExtension<F>>,
committed_inputs: HashMap<LayerId, LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>,
layer_label_to_layer_id: HashMap<String, LayerId>,
}Expand description
A circuit, along with all of its input data, ready to be proven using the vanila GKR proving system which uses Ligero as a PCS for committed input layers, and provides no zero-knowledge guarantees.
Fields§
§circuit_description: GKRCircuitDescription<F>§inputs: HashMap<LayerId, MultilinearExtension<F>>§committed_inputs: HashMap<LayerId, LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>§layer_label_to_layer_id: HashMap<String, LayerId>Implementations§
Source§impl<F: Halo2FFTFriendlyField> ProvableCircuit<F>
impl<F: Halo2FFTFriendlyField> ProvableCircuit<F>
Sourcepub fn new(
circuit_description: GKRCircuitDescription<F>,
inputs: HashMap<LayerId, MultilinearExtension<F>>,
committed_inputs: HashMap<LayerId, LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>,
layer_label_to_layer_id: HashMap<String, LayerId>,
) -> Self
pub fn new( circuit_description: GKRCircuitDescription<F>, inputs: HashMap<LayerId, MultilinearExtension<F>>, committed_inputs: HashMap<LayerId, LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>, layer_label_to_layer_id: HashMap<String, LayerId>, ) -> Self
Constructor
Sourcepub fn _gen_verifiable_circuit(&self) -> VerifiableCircuit<F>
pub fn _gen_verifiable_circuit(&self) -> VerifiableCircuit<F>
§WARNING
To be used only for testing and debugging.
Constructs a form of this circuit that can be verified when a proof is provided. This is done by erasing all input data associated with committed input layers, along with any commitments (the latter can be found in the proof).
Sourcepub fn get_gkr_circuit_description_ref(&self) -> &GKRCircuitDescription<F>
pub fn get_gkr_circuit_description_ref(&self) -> &GKRCircuitDescription<F>
Returns a reference to the GKRCircuitDescription of this circuit.
TODO: This is only used by the back end. Do not expose it to the circuit developer.
Sourcepub fn get_public_input_layer_ids(&self) -> Vec<LayerId>
pub fn get_public_input_layer_ids(&self) -> Vec<LayerId>
Returns a vector of the LayerIds of all input layers which are public.
TODO: Consider returning an iterator instead.
Sourcepub fn get_committed_input_layer_ids(&self) -> Vec<LayerId>
pub fn get_committed_input_layer_ids(&self) -> Vec<LayerId>
Returns a vector of the LayerIds of all input layers which are committed to using a PCS.
TODO: Consider returning an iterator instead.
Sourcepub fn get_input_mle(
&self,
layer_id: LayerId,
) -> Result<MultilinearExtension<F>>
pub fn get_input_mle( &self, layer_id: LayerId, ) -> Result<MultilinearExtension<F>>
Returns the data associated with the input layer with ID layer_id, or an error if there is
no input layer with this ID.
Sourcepub fn get_committed_input_layer(
&self,
layer_id: LayerId,
) -> Result<LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>
pub fn get_committed_input_layer( &self, layer_id: LayerId, ) -> Result<LigeroInputLayerDescriptionWithOptionalProverPrecommit<F>>
Returns the description of the committed input layer with ID layer_id, or an error if no
such committed input layer exists.
Sourcepub fn get_inputs_ref(&self) -> &HashMap<LayerId, MultilinearExtension<F>>
pub fn get_inputs_ref(&self) -> &HashMap<LayerId, MultilinearExtension<F>>
Get a reference to the mapping that maps a LayerId of layer (either public or committed) to the data that are associated with it.
TODO: This is too transparent. Replace this with methods that answer the queries of the prover directly, and do not expose it to the circuit developer.
Sourcepub fn prove<Tr: TranscriptSponge<F>>(
&self,
circuit_description_hash_type: CircuitHashType,
transcript_writer: &mut TranscriptWriter<F, Tr>,
) -> Result<ProofConfig>
pub fn prove<Tr: TranscriptSponge<F>>( &self, circuit_description_hash_type: CircuitHashType, transcript_writer: &mut TranscriptWriter<F, Tr>, ) -> Result<ProofConfig>
Write the GKR proof to transcript. Appends inputs and Ligero input layer commitments to the transcript: public inputs first, then Ligero input layers, ordering by layer id in both cases. Arguments:
circuit_description_hash_type: The hash function we wish to use to hash the circuit description.transcript_writer: The struct used by the prover to write messages to the transcript, which will be used by the verifier to verify the circuit.
Trait Implementations§
Source§impl<F: Clone + Halo2FFTFriendlyField> Clone for ProvableCircuit<F>
impl<F: Clone + Halo2FFTFriendlyField> Clone for ProvableCircuit<F>
Source§fn clone(&self) -> ProvableCircuit<F>
fn clone(&self) -> ProvableCircuit<F>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl<F> Freeze for ProvableCircuit<F>
impl<F> RefUnwindSafe for ProvableCircuit<F>where
F: RefUnwindSafe,
impl<F> Send for ProvableCircuit<F>
impl<F> Sync for ProvableCircuit<F>
impl<F> Unpin for ProvableCircuit<F>where
F: Unpin,
impl<F> UnwindSafe for ProvableCircuit<F>where
F: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.