gkr

Documentation

Index

• Variables
• func ChallengeNames(sorted []*Wire, logNbInstances int, prefix string) []string
• func ProofSize(c Circuit, logNbInstances int) int
• func ProveHintPlaceholder(*big.Int, []*big.Int, []*big.Int) error
• func SolveHintPlaceholder(*big.Int, []*big.Int, []*big.Int) error
• func Verify(api frontend.API, c Circuit, assignment WireAssignment, proof Proof, ...) error
• type API
  • func NewApi() *API
  • func (api *API) Add(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable
  • func (api *API) Import(assignment []frontend.Variable) (constraint.GkrVariable, error)
  • func (api *API) Mul(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable
  • func (api *API) NamedGate(gate string, in ...constraint.GkrVariable) constraint.GkrVariable
  • func (api *API) Neg(i1 constraint.GkrVariable) constraint.GkrVariable
  • func (api *API) Println(a ...constraint.GkrVariable)
  • func (api *API) Series(input, output constraint.GkrVariable, inputInstance, outputInstance int) *API
  • func (api *API) Solve(parentApi frontend.API) (Solution, error)
  • func (api *API) Sub(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable
• type AddGate
  • func (a AddGate) Degree() int
  • func (a AddGate) Evaluate(api frontend.API, v ...frontend.Variable) frontend.Variable
• type Circuit
• type Gate
• type IdentityGate
  • func (IdentityGate) Degree() int
  • func (IdentityGate) Evaluate(_ frontend.API, input ...frontend.Variable) frontend.Variable
• type MulGate
  • func (g MulGate) Degree() int
  • func (g MulGate) Evaluate(api frontend.API, x ...frontend.Variable) frontend.Variable
• type Option
  • func WithSortedCircuit(sorted []*Wire) Option
• type Proof
  • func DeserializeProof(sorted []*Wire, serializedProof []frontend.Variable) (Proof, error)
  • func (p Proof) Serialize() []frontend.Variable
• type Solution
  • func (s Solution) Export(v frontend.Variable) []frontend.Variable
  • func (s Solution) Verify(hashName string, initialChallenges ...frontend.Variable) error
• type Wire
  • func (w Wire) IsInput() bool
  • func (w Wire) IsOutput() bool
  • func (w Wire) NbClaims() int
• type WireAssignment
  • func (a WireAssignment) NumInstances() int
  • func (a WireAssignment) NumVars() int

Variables

var Gates = map[string]Gate{
	"identity": IdentityGate{},
	"add":      AddGate{},
	"mul":      MulGate{},
}

Functions

func ChallengeNames

func ChallengeNames(sorted []*Wire, logNbInstances int, prefix string) []string

func ProofSize

func ProofSize(c Circuit, logNbInstances int) int

ProofSize computes how large the proof for a circuit would be. It needs nbUniqueOutputs to be set

func ProveHintPlaceholder

func ProveHintPlaceholder(*big.Int, []*big.Int, []*big.Int) error

func SolveHintPlaceholder

func SolveHintPlaceholder(*big.Int, []*big.Int, []*big.Int) error

func Verify

func Verify(api frontend.API, c Circuit, assignment WireAssignment, proof Proof, transcriptSettings fiatshamir.Settings, options ...Option) error

Verify the consistency of the claimed output with the claimed input Unlike in Prove, the assignment argument need not be complete

Types

type API

type API struct {
	// contains filtered or unexported fields
}

func NewApi

func NewApi() *API

NewApi creates a new GKR API

func (*API) Add

func (api *API) Add(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable

func (*API) Import

func (api *API) Import(assignment []frontend.Variable) (constraint.GkrVariable, error)

Import creates a new input variable, whose values across all instances are given by assignment. If the value in an instance depends on an output of another instance, leave the corresponding index in assigment nil and use Series to specify the dependency.

func (*API) Mul

func (api *API) Mul(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable

func (*API) NamedGate

func (api *API) NamedGate(gate string, in ...constraint.GkrVariable) constraint.GkrVariable

func (*API) Neg

func (api *API) Neg(i1 constraint.GkrVariable) constraint.GkrVariable

func (*API) Println

func (api *API) Println(a ...constraint.GkrVariable)

TODO @Tabaie This can be useful

func (*API) Series

func (api *API) Series(input, output constraint.GkrVariable, inputInstance, outputInstance int) *API

Series like in an electric circuit, binds an input of an instance to an output of another

func (*API) Solve

func (api *API) Solve(parentApi frontend.API) (Solution, error)

Solve finalizes the GKR circuit and returns the output variables in the order created

func (*API) Sub

func (api *API) Sub(i1, i2 constraint.GkrVariable, in ...constraint.GkrVariable) constraint.GkrVariable

type AddGate

type AddGate struct{}

func (AddGate) Degree

func (a AddGate) Degree() int

func (AddGate) Evaluate

func (a AddGate) Evaluate(api frontend.API, v ...frontend.Variable) frontend.Variable

type Circuit

type Circuit []Wire

type Gate

type Gate interface {
	Evaluate(frontend.API, ...frontend.Variable) frontend.Variable
	Degree() int
}

Gate must be a low-degree polynomial

type IdentityGate

type IdentityGate struct{}

func (IdentityGate) Degree

func (IdentityGate) Degree() int

func (IdentityGate) Evaluate

func (IdentityGate) Evaluate(_ frontend.API, input ...frontend.Variable) frontend.Variable

type MulGate

type MulGate struct{}

func (MulGate) Degree

func (g MulGate) Degree() int

TODO: Degree must take nbInputs as an argument and return degree = nbInputs

func (MulGate) Evaluate

func (g MulGate) Evaluate(api frontend.API, x ...frontend.Variable) frontend.Variable

type Option

type Option func(*settings)

func WithSortedCircuit

func WithSortedCircuit(sorted []*Wire) Option

type Proof

type Proof []sumcheck.Proof // for each layer, for each wire, a sumcheck (for each variable, a polynomial)

func DeserializeProof

func DeserializeProof(sorted []*Wire, serializedProof []frontend.Variable) (Proof, error)

func (Proof) Serialize

func (p Proof) Serialize() []frontend.Variable

type Solution

type Solution struct {
	// contains filtered or unexported fields
}

func (Solution) Export

func (s Solution) Export(v frontend.Variable) []frontend.Variable

Export returns the values of an output variable across all instances

func (Solution) Verify

func (s Solution) Verify(hashName string, initialChallenges ...frontend.Variable) error

Verify encodes the verification circuitry for the GKR circuit

type Wire

type Wire struct {
	Gate   Gate
	Inputs []*Wire // if there are no Inputs, the wire is assumed an input wire
	// contains filtered or unexported fields
}

func (Wire) IsInput

func (w Wire) IsInput() bool

func (Wire) IsOutput

func (w Wire) IsOutput() bool

func (Wire) NbClaims

func (w Wire) NbClaims() int

type WireAssignment

type WireAssignment map[*Wire]polynomial.MultiLin

WireAssignment is assignment of values to the same wire across many instances of the circuit

func (WireAssignment) NumInstances

func (a WireAssignment) NumInstances() int

func (WireAssignment) NumVars

func (a WireAssignment) NumVars() int