package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Main end
exception Rest_not_null of string

Raised by the prover when the provided inputs are not a satisfying assignment of the circuit.

exception Entry_not_in_table of string

Raised by the prover when the provided inputs are not a satisfying assignment of the circuit when using Plookup.

module Input_commitment = Main.Input_commitment
type scalar = Kzg.Bls.Scalar.t
val scalar_t : scalar Repr.t
val scalar_encoding : scalar Data_encoding.t

Before proving and verifying, circuits go through a pre-processing step called setup. The setup takes as input a circuit_map, which associates an identifier to a circuit and the number of statements that can be proved with that circuit. This produces a set of public_parameters which are bound to the circuits and can be reused.

type prover_public_parameters = Main.prover_public_parameters

Set of public_parameters needed by the prover. Its size is linear in the size of the circuits.

val prover_public_parameters_t : prover_public_parameters Repr.t
type verifier_public_parameters = Main.verifier_public_parameters

Set of public_parameters needed by the verifier. Its size is constant w.r.t. the size of the circuits.

val verifier_public_parameters_t : verifier_public_parameters Repr.t
val verifier_public_parameters_encoding : verifier_public_parameters Data_encoding.t
type proof = Main.proof

Succinct proof for a collection of statements.

val proof_t : proof Repr.t
val proof_encoding : proof Data_encoding.t
type circuit_prover_input = Main.circuit_prover_input = {
  1. witness : scalar array;
  2. input_commitments : Input_commitment.t list;
}

Witness is the whole trace for the circuit, including input_commitment values first, followed by public input values and followed by the rest of the trace. This is the prover input for a single proof.

val circuit_prover_input_t : circuit_prover_input Repr.t

Map where each circuit identifier is bound to a list of circuit_prover_input for a list of statements.

val prover_inputs_t : prover_inputs Repr.t
type public_inputs = Main.public_inputs

The public inputs for one circuit & several statements

val public_inputs_t : public_inputs Repr.t
type circuit_verifier_input = Main.circuit_verifier_input = {
  1. nb_proofs : int;
  2. public : public_inputs;
  3. commitments : Input_commitment.public list list;
}

The verifier input for a circuit, represented as the actual number of proofs that have been proved by the prover, the public inputs & the input commitments

val circuit_verifier_input_t : circuit_verifier_input Repr.t

The verifier inputs, represented as a map where each circuit is binded to the verifier inputs for this circuit.

val verifier_inputs_t : verifier_inputs Repr.t

Conversion from prover_inputs to verifier_inputs.

val input_commit : ?size:int -> ?shift:int -> prover_public_parameters -> scalar array -> Input_commitment.t

input_commit ~shift pp secret produces a commitment to the secret array and additional prover information. This commitment is designed to be easily involved in a PlonK proof. In particular, the values of secret will be added to the arithmetic identity in such a way that secret.(i) participates in constraint number shift + i, where equality will be asserted with respect to a PlonK variable in the same constraint. This allows us to "load" the value of secret.(i) into the variable, which may be reused across the circuit. The optional argument shift has a default value of 0. The commitment is relative to a certain domain size n, included in pp, the secret will remain information-theoretically hidden as long as the commitment is involved in at most n - |secret| different proofs. If the optionnal argument size is given, the secret will be padded with zeros to have the length size (note that an error will be risen if size is smaller than the secret length).

val update_prover_public_parameters : 'a Repr.ty -> 'a -> prover_public_parameters -> prover_public_parameters

Enrich the prover_public_parameters with extra application data to prevent replay attacks. The same data must be used for updating the prover and verifier public parameters.

val update_verifier_public_parameters : 'a Repr.ty -> 'a -> verifier_public_parameters -> verifier_public_parameters

Enrich the verifier_public_parameters with extra application data to prevent replay attacks. The same data must be used for updating the prover and verifier public parameters.

module Internal_for_tests = Main.Internal_for_tests
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct