backend

Documentation

Overview

Package backend implements Zero Knowledge Proof systems: it consumes circuit compiled with gnark/frontend.

Index

• func IgnoreSolverError(opt *ProverOption) error
• func WithHints(hintFunctions ...hint.Function) func(opt *ProverOption) error
• func WithOutput(w io.Writer) func(opt *ProverOption) error
• type ID
  • func Implemented() []ID
  • func (id ID) String() string
• type ProverOption
  • func NewProverOption(opts ...func(opt *ProverOption) error) (ProverOption, error)

Functions

func IgnoreSolverError

func IgnoreSolverError(opt *ProverOption) error

IgnoreSolverError is a ProverOption that indicates that the Prove algorithm should complete, even if constraint system is not solved. In that case, Prove will output an invalid Proof, but will execute all algorithms which is useful for test and benchmarking purposes

func WithHints

func WithHints(hintFunctions ...hint.Function) func(opt *ProverOption) error

WithHints is a Prover option that specifies additional hint functions to be used by the constraint solver

func WithOutput

func WithOutput(w io.Writer) func(opt *ProverOption) error

WithOutput is a Prover option that specifies an io.Writer as destination for logs printed by cs.Println(). If set to nil, no logs are printed.

Types

type ID

type ID uint16

ID represent a unique ID for a proving scheme

const (
	UNKNOWN ID = iota
	GROTH16
	PLONK
)

func Implemented

func Implemented() []ID

Implemented return the list of proof systems implemented in gnark

func (ID) String

func (id ID) String() string

String returns the string representation of a proof system

type ProverOption

type ProverOption struct {
	Force         bool            // default to false
	HintFunctions []hint.Function // default to nil (use only solver std hints)
	LoggerOut     io.Writer       // default to os.Stdout
}

ProverOption is shared accross backends to parametrize calls to xxx.Prove(...)

func NewProverOption

func NewProverOption(opts ...func(opt *ProverOption) error) (ProverOption, error)

NewProverOption returns a default ProverOption with given options applied