octez-libs 20.1 (latest) · OCaml Package

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 : Plonk.Input_commitment.S

type scalar = Kzg.Bls.Scalar.t

val scalar_t : scalar Repr.t

val scalar_encoding : scalar Data_encoding.t

type circuit_map = (Plonk.Circuit.t * int) Plonk.Main_protocol_intf.SMap.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

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

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

Succinct proof for a collection of statements.

val proof_t : proof Repr.t

val proof_encoding : proof Data_encoding.t

type circuit_prover_input = {

witness : scalar array;
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

type prover_inputs = circuit_prover_input list Plonk.Main_protocol_intf.SMap.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

The public inputs for one circuit & several statements

val public_inputs_t : public_inputs Repr.t

type circuit_verifier_input = {

nb_proofs : int;
public : public_inputs;
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

type verifier_inputs = circuit_verifier_input Plonk.Main_protocol_intf.SMap.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

val to_verifier_inputs : 
  prover_public_parameters ->
  prover_inputs ->
  verifier_inputs

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 setup : 
  zero_knowledge:bool ->
  circuit_map ->
  srs:(Kzg.Bls.Srs.t * Kzg.Bls.Srs.t) ->
  prover_public_parameters * verifier_public_parameters

setup ~zero_knowledge circuit_map ~srs pre-processes the circuit_map producing the public parameters. The SRSs of ZCash and Filecoin can be loaded from file using the Bls12_381_polynomial library. Activating zero_knowledge adds an overhead in proving time.

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.

val prove : prover_public_parameters -> inputs:prover_inputs -> proof

prove public_parameters ~inputs produces a proof for the collection of statements implied by inputs and the circuits used for generating public_parameters.

raises Rest_not_null

raises Entry_not_in_table

val verify : 
  verifier_public_parameters ->
  inputs:verifier_inputs ->
  proof ->
  bool

verify public_parameters ~inputs proof checks the validity of the proof with regards to public_parameters and inputs.

module Internal_for_tests : sig ... end

package octez-libs