refactor: std/math/nonnative -> std/math/emulated

.github/workflows/pr.yml

@@ -30,16 +30,6 @@ jobs:
       run: go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
     - name: gofmt
       run: if [[ -n $(gofmt -l .) ]]; then echo "please run gofmt"; exit 1; fi
-    - name: go vet
-      run: go vet ./...
-    - name: staticcheck
-      run: |
-        go install honnef.co/go/tools/cmd/staticcheck@23e1086441d24fed9f668ad1cd4374245118b590
-        staticcheck ./...
-    - name: gosec
-      run: |
-        go install github.com/securego/gosec/v2/cmd/gosec@latest
-        gosec -exclude G204 ./...
     - name: generated files should not be modified
       run: |
         go generate ./...

.github/workflows/push.yml

@@ -34,16 +34,6 @@ jobs:
       run: go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
     - name: gofmt
       run: if [[ -n $(gofmt -l .) ]]; then echo "please run gofmt"; exit 1; fi
-    - name: go vet
-      run: go vet ./...
-    - name: staticcheck
-      run: |
-        go install honnef.co/go/tools/cmd/staticcheck@23e1086441d24fed9f668ad1cd4374245118b590
-        staticcheck ./...
-    - name: gosec
-      run: |
-        go install github.com/securego/gosec/v2/cmd/gosec@latest
-        gosec -exclude G204 ./...
     - name: generated files should not be modified
       run: |
         go generate ./...

backend/plonkfri/plonkfri.go

@@ -41,6 +41,10 @@ import (
 	witness_bn254 "github.com/consensys/gnark/internal/backend/bn254/witness"
 	witness_bw6633 "github.com/consensys/gnark/internal/backend/bw6-633/witness"
 	witness_bw6761 "github.com/consensys/gnark/internal/backend/bw6-761/witness"
+
+	cs_bls24317 "github.com/consensys/gnark/internal/backend/bls24-317/cs"
+	plonk_bls24317 "github.com/consensys/gnark/internal/backend/bls24-317/plonkfri"
+	witness_bls24317 "github.com/consensys/gnark/internal/backend/bls24-317/witness"
 )
 
 // Proof represents a Plonk proof generated by plonk.Prove
@@ -86,6 +90,8 @@ func Setup(ccs frontend.CompiledConstraintSystem) (ProvingKey, VerifyingKey, err
 		return plonk_bls24315.Setup(tccs)
 	case *cs_bw6633.SparseR1CS:
 		return plonk_bw6633.Setup(tccs)
+	case *cs_bls24317.SparseR1CS:
+		return plonk_bls24317.Setup(tccs)
 	default:
 		panic("unrecognized SparseR1CS curve type")
 	}
@@ -147,7 +153,12 @@ func Prove(ccs frontend.CompiledConstraintSystem, pk ProvingKey, fullWitness *wi
 			return nil, witness.ErrInvalidWitness
 		}
 		return plonk_bls24315.Prove(tccs, pk.(*plonk_bls24315.ProvingKey), *w, opt)
-
+	case *cs_bls24317.SparseR1CS:
+		w, ok := fullWitness.Vector.(*witness_bls24317.Witness)
+		if !ok {
+			return nil, witness.ErrInvalidWitness
+		}
+		return plonk_bls24317.Prove(tccs, pk.(*plonk_bls24317.ProvingKey), *w, opt)
 	default:
 		panic("unrecognized SparseR1CS curve type")
 	}
@@ -199,6 +210,12 @@ func Verify(proof Proof, vk VerifyingKey, publicWitness *witness.Witness) error
 			return witness.ErrInvalidWitness
 		}
 		return plonk_bls24315.Verify(_proof, vk.(*plonk_bls24315.VerifyingKey), *w)
+	case *plonk_bls24317.Proof:
+		w, ok := publicWitness.Vector.(*witness_bls24317.Witness)
+		if !ok {
+			return witness.ErrInvalidWitness
+		}
+		return plonk_bls24317.Verify(_proof, vk.(*plonk_bls24317.VerifyingKey), *w)
 
 	default:
 		panic("unrecognized proof type")

examples/emulated/emulated.go

@@ -0,0 +1,23 @@
+package emulated
+
+import (
+	"github.com/consensys/gnark/frontend"
+	"github.com/consensys/gnark/std/math/emulated"
+)
+
+type Circuit struct {
+	// Limbs of non-native elements X, Y and Res
+	X, Y, Res emulated.Element[emulated.Secp256k1]
+}
+
+func (circuit *Circuit) Define(api frontend.API) error {
+	// wrap API to work in SECP256k1 scalar field
+	secp256k1, err := emulated.NewField[emulated.Secp256k1](api)
+	if err != nil {
+		return err
+	}
+
+	tmp := secp256k1.Mul(circuit.X, circuit.Y)
+	secp256k1.AssertIsEqual(tmp, circuit.Res)
+	return nil
+}

examples/emulated/emulated_test.go

@@ -0,0 +1,23 @@
+package emulated
+
+import (
+	"testing"
+
+	"github.com/consensys/gnark-crypto/ecc"
+	"github.com/consensys/gnark/backend"
+	"github.com/consensys/gnark/std"
+	"github.com/consensys/gnark/test"
+)
+
+func TestEmulatedArithmetic(t *testing.T) {
+	assert := test.NewAssert(t)
+	std.RegisterHints()
+
+	var circuit, witness Circuit
+
+	witness.X.Assign("26959946673427741531515197488526605382048662297355296634326893985793")
+	witness.Y.Assign("53919893346855483063030394977053210764097324594710593268653787971586")
+	witness.Res.Assign("485279052387156144224396168012515269674445015885648619762653195154800")
+
+	assert.ProverSucceeded(&circuit, &witness, test.WithCurves(ecc.BN254), test.WithBackends(backend.GROTH16), test.NoSerialization())
+}

frontend/schema/schema.go

@@ -34,6 +34,12 @@ type Schema struct {
 // LeafHandler is the handler function that will be called when Visit reaches leafs of the struct
 type LeafHandler func(field *Field, tValue reflect.Value) error
 
+// An object implementing an init hook knows how to "init" itself
+// when parsed at compile time
+type InitHook interface {
+	GnarkInitHook() // TODO @gbotrel find a better home for this
+}
+
 // Parse filters recursively input data struct and keeps only the fields containing slices, arrays of elements of
 // type frontend.Variable and return the corresponding  Slices are converted to arrays.
 //
@@ -278,6 +284,9 @@ func parse(r []Field, input interface{}, target reflect.Type, parentFullName, pa
 
 			if fValue.CanAddr() && fValue.Addr().CanInterface() {
 				value := fValue.Addr().Interface()
+				if ih, hasInitHook := value.(InitHook); hasInitHook {
+					ih.GnarkInitHook()
+				}
 				var err error
 				subFields, err = parse(subFields, value, target, getFullName(parentFullName, name, nameTag), name, nameTag, visibility, handler, nbPublic, nbSecret)
 				if err != nil {

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/leanovate/gopter v0.2.9
 	github.com/rs/zerolog v1.26.1
 	github.com/stretchr/testify v1.7.1
+	golang.org/x/exp v0.0.0-20220713135740-79cabaa25d75
 )
 
 require (

go.sum

@@ -47,6 +47,8 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U
 golang.org/x/crypto v0.0.0-20211215165025-cf75a172585e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8=
 golang.org/x/crypto v0.0.0-20220321153916-2c7772ba3064 h1:S25/rfnfsMVgORT4/J61MJ7rdyseOZOyvLIrZEZ7s6s=
 golang.org/x/crypto v0.0.0-20220321153916-2c7772ba3064/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
+golang.org/x/exp v0.0.0-20220713135740-79cabaa25d75 h1:x03zeu7B2B11ySp+daztnwM5oBJ/8wGUSqrwcw9L0RA=
+golang.org/x/exp v0.0.0-20220713135740-79cabaa25d75/go.mod h1:Kr81I6Kryrl9sr8s2FK3vxD90NdsKWRuOIl2O4CvYbA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=

internal/stats/snippet.go

@@ -11,6 +11,7 @@ import (
 	"github.com/consensys/gnark/std/algebra/sw_bls24315"
 	"github.com/consensys/gnark/std/hash/mimc"
 	"github.com/consensys/gnark/std/math/bits"
+	"github.com/consensys/gnark/std/math/emulated"
 )
 
 var (
@@ -78,6 +79,25 @@ func initSnippets() {
 		mimc.Write(newVariable())
 		_ = mimc.Sum()
 	})
+	registerSnippet("math/emulated/secp256k1_32", func(api frontend.API, newVariable func() frontend.Variable) {
+		secp256k1, _ := emulated.NewField[emulated.Secp256k1](api)
+
+		newElement := func() emulated.Element[emulated.Secp256k1] {
+			r := emulated.NewElement[emulated.Secp256k1](nil)
+			for i := 0; i < len(r.Limbs); i++ {
+				r.Limbs[i] = newVariable()
+			}
+			return r
+		}
+
+		x13 := secp256k1.Mul(newElement(), newElement(), newElement())
+		fx2 := secp256k1.Mul(5, newElement())
+		nom := secp256k1.Sub(fx2, x13)
+		denom := secp256k1.Add(newElement(), newElement(), newElement(), newElement())
+		free := secp256k1.Div(nom, denom)
+		res := secp256k1.Add(x13, fx2, free)
+		secp256k1.AssertIsEqual(res, newElement())
+	})
 
 	registerSnippet("pairing_bls12377", func(api frontend.API, newVariable func() frontend.Variable) {
 

internal/stats/stats.go

@@ -12,7 +12,6 @@ import (
 	"github.com/consensys/gnark/frontend"
 	"github.com/consensys/gnark/frontend/cs/r1cs"
 	"github.com/consensys/gnark/frontend/cs/scs"
-	"github.com/consensys/gnark/logger"
 )
 
 const nbCurves = 7
@@ -46,7 +45,7 @@ func init() {
 
 func NewGlobalStats() *globalStats {
 	return &globalStats{
-		Stats: make(map[string][backend.PLONK + 1][nbCurves + 1]snippetStats),
+		Stats: make(map[string][backend.PLONKFRI + 1][nbCurves + 1]snippetStats),
 	}
 }
 
@@ -80,7 +79,7 @@ func NewSnippetStats(curve ecc.ID, backendID backend.ID, circuit frontend.Circui
 	switch backendID {
 	case backend.GROTH16:
 		newCompiler = r1cs.NewBuilder
-	case backend.PLONK:
+	case backend.PLONK, backend.PLONKFRI:
 		newCompiler = scs.NewBuilder
 	default:
 		panic("not implemented")
@@ -101,11 +100,6 @@ func NewSnippetStats(curve ecc.ID, backendID backend.ID, circuit frontend.Circui
 func (s *globalStats) Add(curve ecc.ID, backendID backend.ID, cs snippetStats, circuitName string) {
 	s.Lock()
 	defer s.Unlock()
-	if backendID == backend.PLONKFRI {
-		log := logger.Logger()
-		log.Warn().Msg("ignoring plonk_fri circuit")
-		return
-	}
 	rs := s.Stats[circuitName]
 	rs[backendID][CurveIdx(curve)] = cs
 	s.Stats[circuitName] = rs
@@ -118,7 +112,7 @@ type Circuit struct {
 
 type globalStats struct {
 	sync.RWMutex
-	Stats map[string][backend.PLONK + 1][nbCurves + 1]snippetStats
+	Stats map[string][backend.PLONKFRI + 1][nbCurves + 1]snippetStats
 }
 
 type snippetStats struct {

internal/stats/stats_test.go

@@ -29,10 +29,6 @@ func TestCircuitStatistics(t *testing.T) {
 			for _, b := range backend.Implemented() {
 				curve := curve
 				backendID := b
-				if backendID == backend.PLONKFRI {
-					// TODO
-					continue
-				}
 				name := name
 				// copy the circuit now in case assert calls t.Parallel()
 				circuit := c.Circuit

std/hints.go

@@ -7,7 +7,7 @@ import (
 	"github.com/consensys/gnark/std/algebra/sw_bls12377"
 	"github.com/consensys/gnark/std/algebra/sw_bls24315"
 	"github.com/consensys/gnark/std/math/bits"
-	"github.com/consensys/gnark/std/math/nonnative"
+	"github.com/consensys/gnark/std/math/emulated"
 )
 
 var registerOnce sync.Once
@@ -30,5 +30,5 @@ func registerHints() {
 	hint.Register(bits.NNAF)
 	hint.Register(bits.IthBit)
 	hint.Register(bits.NBits)
-	hint.Register(nonnative.GetHints()...)
+	hint.Register(emulated.GetHints()...)
 }