Struct ProverOpts 

#[non_exhaustive]
pub struct ProverOpts {
    pub hashfn: String,
    pub prove_guest_errors: bool,
    pub receipt_kind: ReceiptKind,
    pub control_ids: Vec<Digest>,
    /* private fields */
}

Available on crate feature client and non-target_os="zkvm" only.

Options to configure a Prover.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hashfn: String

Identifier of the hash function to use for the STARK proving protocol.

prove_guest_errors: bool

When false, only prove execution sessions that end in a successful crate::ExitCode (i.e. Halted(0) or Paused(0)). When set to true, any completed execution session will be proven, including indicated errors (e.g. Halted(1)) and sessions ending in Fault.

receipt_kind: ReceiptKind

Kind of receipt to be generated by the prover.

control_ids: Vec<Digest>

List of control IDs to enable for recursion proving.

This list is used to construct the control root, which commits to the set of recursion programs that are allowed to run and is a key field in the SuccinctReceiptVerifierParameters.

Implementations

impl ProverOpts

pub fn from_max_po2(po2_max: usize) -> Self

Available on crate feature unstable only.

Construct a ProverOpts ready to prove segments with up to the given max cycle count as a power of two (po2). All fields are equal to the default expect where they need to be adjusted to support a larger po2.

NOTE: If the po2 used to prove is greater than the targeted verifier supports, DEFAULT_MAX_PO2 by default, receipts will be rejected by the verifier.

Availability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn all_po2s() -> Self

Available on crate feature unstable only.

Construct a verifier context that will accept receipts with control any of the default control ID associated with cycle counts of all supported powers of two (po2).

Availability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn fast() -> Self

Choose the fastest prover options. Receipt will be linear in length of the execution,

This is an alias for ProverOpts::composite.

pub fn composite() -> Self

Choose the prover that generates composite receipts, linear in the length of the execution, and supports compression via recursion.

pub fn succinct() -> Self

Choose the prover that generates succinct receipts, which are constant size in the length of execution.

pub fn groth16() -> Self

Choose the prover that generates Groth16 receipts which are constant size in the length of the execution and small enough to verify on blockchains, like Ethereum.

Only supported with Docker installed.

pub fn with_hashfn(self, hashfn: String) -> Self

Return ProverOpts with the hashfn set to the given value.

pub fn with_prove_guest_errors(self, prove_guest_errors: bool) -> Self

Return ProverOpts with prove_guest_errors set to the given value.

pub fn with_receipt_kind(self, receipt_kind: ReceiptKind) -> Self

Return ProverOpts with the receipt_kind set to the given value.

pub fn with_control_ids(self, control_ids: Vec<Digest>) -> Self

Return ProverOpts with the control_ids set to the given value.

pub fn with_segment_po2_max(self, max_segment_po2: usize) -> Self

Available on crate feature unstable only.

Return ProverOpts with the max_segment_po2 set to the given value.

Availability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

pub fn with_dev_mode(self, dev_mode: bool) -> Self

Return ProverOpts with dev_mode enabled or disabled.

pub fn dev_mode(&self) -> bool

Returns true if dev-mode is enabled.

Trait Implementations

impl Clone for ProverOpts

fn clone(&self) -> ProverOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProverOpts

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

Formats the value using the given formatter.

impl Default for ProverOpts

fn default() -> Self

Return ProverOpts that are intended to work for most applications.

Proof generated with these options may be linear in size with the execution length, but can be compressed using the Prover::compress methods.

impl<'de> Deserialize<'de> for ProverOpts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProverOpts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.