gkr

Documentation

Index

• Variables
• func ChallengeNames(sorted []*Wire, logNbInstances int, prefix string) []string
• func ProofSize(c Circuit, logNbInstances int) int
• func Verify(c Circuit, assignment WireAssignment, proof Proof, ...) error
• type AddGate
  • func (g AddGate) Degree() int
  • func (g AddGate) Evaluate(x ...fr.Element) (res fr.Element)
• type Circuit
  • func (c Circuit) MemoryRequirements(nbInstances int) []int
• type Gate
• type IdentityGate
  • func (IdentityGate) Degree() int
  • func (IdentityGate) Evaluate(input ...fr.Element) fr.Element
• type MulGate
  • func (g MulGate) Degree() int
  • func (g MulGate) Evaluate(x ...fr.Element) (res fr.Element)
• type NegGate
  • func (g NegGate) Degree() int
  • func (g NegGate) Evaluate(element ...fr.Element) (neg fr.Element)
• type Option
  • func WithPool(pool *polynomial.Pool) Option
  • func WithSortedCircuit(sorted []*Wire) Option
  • func WithWorkers(workers *utils.WorkerPool) Option
• type Proof
  • func Prove(c Circuit, assignment WireAssignment, transcriptSettings fiatshamir.Settings, ...) (Proof, error)
  • func (p Proof) SerializeToBigInts(outs []*big.Int)
• type SubGate
  • func (g SubGate) Degree() int
  • func (g SubGate) Evaluate(element ...fr.Element) (diff fr.Element)
• type Wire
  • func (w Wire) IsInput() bool
  • func (w Wire) IsOutput() bool
  • func (w Wire) NbClaims() int
• type WireAssignment
  • func (a WireAssignment) Complete(c Circuit) WireAssignment
  • func (a WireAssignment) NumInstances() int
  • func (a WireAssignment) NumVars() int

Variables

var Gates = map[string]Gate{
	"identity": IdentityGate{},
	"add":      AddGate{},
	"sub":      SubGate{},
	"neg":      NegGate{},
	"mul":      MulGate(2),
}

Gates defined by name

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 Verify

func Verify(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 AddGate

type AddGate struct{}

func (AddGate) Degree

func (g AddGate) Degree() int

func (AddGate) Evaluate

func (g AddGate) Evaluate(x ...fr.Element) (res fr.Element)

type Circuit

type Circuit []Wire

func (Circuit) MemoryRequirements

func (c Circuit) MemoryRequirements(nbInstances int) []int

MemoryRequirements returns an increasing vector of memory allocation sizes required for proving a GKR statement

type Gate

type Gate interface {
	Evaluate(...fr.Element) fr.Element
	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(input ...fr.Element) fr.Element

type MulGate

type MulGate int

func (MulGate) Degree

func (g MulGate) Degree() int

func (MulGate) Evaluate

func (g MulGate) Evaluate(x ...fr.Element) (res fr.Element)

type NegGate

type NegGate struct{}

func (NegGate) Degree

func (g NegGate) Degree() int

func (NegGate) Evaluate

func (g NegGate) Evaluate(element ...fr.Element) (neg fr.Element)

type Option

type Option func(*settings)

func WithPool

func WithPool(pool *polynomial.Pool) Option

func WithSortedCircuit

func WithSortedCircuit(sorted []*Wire) Option

func WithWorkers

func WithWorkers(workers *utils.WorkerPool) Option

type Proof

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

func Prove

func Prove(c Circuit, assignment WireAssignment, transcriptSettings fiatshamir.Settings, options ...Option) (Proof, error)

Prove consistency of the claimed assignment

func (Proof) SerializeToBigInts

func (p Proof) SerializeToBigInts(outs []*big.Int)

SerializeToBigInts flattens a proof object into the given slice of big.Ints useful in gnark hints. TODO: Change propagation: Once this is merged, it will duplicate some code in std/gkr/bn254Prover.go. Remove that in favor of this

type SubGate

type SubGate struct{}

func (SubGate) Degree

func (g SubGate) Degree() int

func (SubGate) Evaluate

func (g SubGate) Evaluate(element ...fr.Element) (diff fr.Element)

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) Complete

func (a WireAssignment) Complete(c Circuit) WireAssignment

Complete the circuit evaluation from input values

func (WireAssignment) NumInstances

func (a WireAssignment) NumInstances() int

func (WireAssignment) NumVars

func (a WireAssignment) NumVars() int