v0.8.0 placeholder

.github/workflows/pr.yml

@@ -7,7 +7,7 @@ jobs:
     - name: install Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.18.x
+        go-version: 1.19.x
     - name: checkout code
       uses: actions/checkout@v2
       with:
@@ -22,20 +22,14 @@ jobs:
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
         restore-keys: |
           ${{ runner.os }}-go-
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+          args: --timeout=5m
     - name: install deps
       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 ./...
@@ -46,7 +40,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.18.x]
+        go-version: [1.19.x]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     needs:
@@ -74,17 +68,48 @@ jobs:
       run: |
         go test -v -short -timeout=30m ./...
 
-  slack-workflow-status:
-    if: always()
+  slack-workflow-status-failed:
+    if: failure()
+    name: post workflow status to slack
+    needs:
+      - staticcheck
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify slack -- workflow failed
+        id: slack
+        uses: slackapi/slack-github-action@v1.19.0
+        with:
+          payload: |
+            {
+              "actor": "${{ github.actor }}",
+              "repo": "${{ github.repository }}",
+              "status": "FAIL",
+              "title": "${{ github.event.pull_request.title }}",
+              "pr": "${{ github.event.pull_request.head.ref }}"
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+  slack-workflow-status-success:
+    if: success()
     name: post workflow status to slack
     needs:
       - staticcheck
       - test
     runs-on: ubuntu-latest
     steps:
-      - name: Build notification
-        uses: Gamesight/slack-workflow-status@master
+      - name: Notify slack -- workflow succeeded
+        id: slack
+        uses: slackapi/slack-github-action@v1.19.0
         with:
-          repo_token: ${{secrets.GITHUB_TOKEN}}
-          slack_webhook_url: ${{secrets.SLACK_WEBHOOK_URL}}
-          channel: '#team-gnark-build'
+          payload: |
+            {
+              "actor": "${{ github.actor }}",
+              "repo": "${{ github.repository }}",
+              "status": "SUCCESS",
+              "title": "${{ github.event.pull_request.title }}",
+              "pr": "${{ github.event.pull_request.head.ref }}"
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_SUCCESS }}

.github/workflows/push.yml

@@ -11,7 +11,7 @@ jobs:
     - name: install Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.18.x
+        go-version: 1.19.x
     - name: checkout code
       uses: actions/checkout@v2
       with:
@@ -26,20 +26,14 @@ jobs:
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
         restore-keys: |
           ${{ runner.os }}-go-
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+          args: --timeout=5m
     - name: install deps
       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 ./...
@@ -50,7 +44,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.17.x, 1.18.x]
+        go-version: [1.19.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     needs:
@@ -82,17 +76,48 @@ jobs:
       run: |
         go test -v -timeout=50m -race -short ./...
 
-  slack-workflow-status:
-    if: always()
+  slack-workflow-status-failed:
+    if: failure()
+    name: post workflow status to slack
+    needs:
+      - staticcheck
+      - test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify slack -- workflow failed
+        id: slack
+        uses: slackapi/slack-github-action@v1.19.0
+        with:
+          payload: |
+            {
+              "actor": "${{ github.actor }}",
+              "repo": "${{ github.repository }}",
+              "status": "FAIL",
+              "title": "push to ${{ github.event.push.base_ref }}",
+              "pr": ""
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+  slack-workflow-status-success:
+    if: success()
     name: post workflow status to slack
     needs:
       - staticcheck
       - test
     runs-on: ubuntu-latest
     steps:
-      - name: Build notification
-        uses: Gamesight/slack-workflow-status@master
+      - name: Notify slack -- workflow succeeded
+        id: slack
+        uses: slackapi/slack-github-action@v1.19.0
         with:
-          repo_token: ${{secrets.GITHUB_TOKEN}}
-          slack_webhook_url: ${{secrets.SLACK_WEBHOOK_URL}}
-          channel: '#team-gnark-build'
+          payload: |
+            {
+              "actor": "${{ github.actor }}",
+              "repo": "${{ github.repository }}",
+              "status": "SUCCESS",
+              "title": "push to ${{ github.event.push.base_ref }}",
+              "pr": ""
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_SUCCESS }}

.gitignore

@@ -47,3 +47,6 @@ gnarkd/circuits/**
 
 # compiled sage -> python code
 *.sage.py
+
+# Jetbrains stuff
+.idea/

.golangci.yml

@@ -0,0 +1,12 @@
+linters:
+  disable-all: true
+  enable:
+    - gofmt
+    - staticcheck
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+
+run:
+  issues-exit-code: 1

README.md

@@ -5,9 +5,6 @@
 [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/consensys/gnark)](https://pkg.go.dev/mod/github.com/consensys/gnark)
 [![Documentation Status](https://readthedocs.com/projects/pegasys-gnark/badge/)][`gnark` User Documentation] [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5819104.svg)](https://doi.org/10.5281/zenodo.5819104)
 
-<img  width="100px"
-src="logo_new.png">
-
 `gnark` is a fast zk-SNARK library that offers a high-level API to design circuits. The library is open source and developed under the Apache 2.0 license
 
 
@@ -16,7 +13,7 @@ src="logo_new.png">
 * [`gnark` User Documentation]
 * [`gnark` Playground]
 * [`gnark` Issues]
-* [`gnark` Benchmarks](https://docs.gnark.consensys.net/en/latest/#gnark-is-fast)
+* [`gnark` Benchmarks](https://docs.gnark.consensys.net/overview#gnark-is-fast) 🏁
 * [`gnark-announce`] - Announcement list for new releases and security patches
 
 
@@ -29,7 +26,7 @@ Checkout the [online playground][`gnark` Playground] to compile circuits and vis
 
 ## Warning
 
-**`gnark` has not been audited and is provided as-is, we make no guarantees or warranties to its safety and reliability. In particular, `gnark` makes no security guarantees such as constant time implementation or side-channel attack resistance.**
+**`gnark` has been [partially audited](https://github.com/ConsenSys/gnark-crypto/blob/master/audit_oct2022.pdf) and is provided as-is, we make no guarantees or warranties to its safety and reliability. In particular, `gnark` makes no security guarantees such as constant time implementation or side-channel attack resistance.**
 
 `gnark` and `gnark-crypto` packages are optimized for 64bits architectures (x86 `amd64`) and tested on Unix (Linux / macOS).
 
@@ -64,6 +61,7 @@ which can be instantiated with the following curves
 - [x] BW6-761
 - [x] BLS24-315
 - [x] BW6-633
+- [x] BLS24-317
 
 ### Example
 
@@ -91,14 +89,14 @@ func (circuit *CubicCircuit) Define(api frontend.API) error {
 
 // compiles our circuit into a R1CS
 var circuit CubicCircuit
-ccs, err := frontend.Compile(ecc.BN254, r1cs.NewBuilder, &circuit)
+ccs, err := frontend.Compile(ecc.BN254.ScalarField(), r1cs.NewBuilder, &circuit)
 
 // groth16 zkSNARK: Setup
 pk, vk, err := groth16.Setup(ccs)
 
 // witness definition
 assignment := CubicCircuit{X: 3, Y: 35}
-witness, err := frontend.NewWitness(&assignment, ecc.BN254)
+witness, err := frontend.NewWitness(&assignment, ecc.BN254.ScalarField())
 publicWitness, _ := witness.Public()
 
 // groth16: Prove & Verify
@@ -112,19 +110,19 @@ If you use `gnark` in your research a citation would be appreciated.
 Please use the following BibTeX to cite the most recent release.
 
 ```bib
-@software{gnark-v0.6.4,
+@software{gnark-v0.8.0,
   author       = {Gautam Botrel and
                   Thomas Piellard and
                   Youssef El Housni and
                   Ivo Kubjas and
                   Arya Tabaie},
-  title        = {ConsenSys/gnark: v0.6.4},
+  title        = {ConsenSys/gnark: v0.8.0},
   month        = feb,
-  year         = 2022,
+  year         = 2023,
   publisher    = {Zenodo},
-  version      = {v0.6.4},
-  doi          = {10.5281/zenodo.6093969},
-  url          = {https://doi.org/10.5281/zenodo.6093969}
+  version      = {v0.8.0},
+  doi          = {10.5281/zenodo.5819104},
+  url          = {https://doi.org/10.5281/zenodo.5819104}
 }
 ```
 
@@ -142,8 +140,8 @@ This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE)
 
 [`gnark` Issues]: https://github.com/consensys/gnark/issues
 [`gnark` Playground]: https://play.gnark.io
-[`gnark` User Documentation]: https://docs.gnark.consensys.net/en/latest/
+[`gnark` User Documentation]: https://docs.gnark.consensys.net/
 [GitHub discussions]: https://github.com/ConsenSys/gnark/discussions
-[Proving schemes and curves]: https://docs.gnark.consensys.net/en/latest/Concepts/schemes_curves/
+[Proving schemes and curves]: https://docs.gnark.consensys.net/Concepts/schemes_curves
 [`gnark-announce`]: https://groups.google.com/g/gnark-announce
-[@gnark_team]: https://twitter.com/gnark_team
+[@gnark_team]: https://twitter.com/gnark_team

backend/backend.go

@@ -28,11 +28,12 @@ const (
 	UNKNOWN ID = iota
 	GROTH16
 	PLONK
+	PLONKFRI
 )
 
 // Implemented return the list of proof systems implemented in gnark
 func Implemented() []ID {
-	return []ID{GROTH16, PLONK}
+	return []ID{GROTH16, PLONK, PLONKFRI}
 }
 
 // String returns the string representation of a proof system
@@ -42,6 +43,8 @@ func (id ID) String() string {
 		return "groth16"
 	case PLONK:
 		return "plonk"
+	case PLONKFRI:
+		return "plonkFRI"
 	default:
 		return "unknown"
 	}

backend/groth16/bellman_test.go

@@ -106,13 +106,17 @@ func TestVerifyBellmanProof(t *testing.T) {
 
 		// verify groth16 proof
 		// we need to prepend the number of elements in the witness.
+		// witness package expects [nbPublic nbSecret] followed by [n | elements];
+		// note that n is redundant with nbPublic + nbSecret
 		var buf bytes.Buffer
-		binary.Write(&buf, binary.BigEndian, uint32(len(inputsBytes)/(fr.Limbs*8)))
+		_ = binary.Write(&buf, binary.BigEndian, uint32(len(inputsBytes)/(fr.Limbs*8)))
+		_ = binary.Write(&buf, binary.BigEndian, uint32(0))
+		_ = binary.Write(&buf, binary.BigEndian, uint32(len(inputsBytes)/(fr.Limbs*8)))
 		buf.Write(inputsBytes)
 
-		witness := &witness.Witness{
-			CurveID: ecc.BLS12_381,
-		}
+		witness, err := witness.New(ecc.BLS12_381.ScalarField())
+		require.NoError(t, err)
+
 		err = witness.UnmarshalBinary(buf.Bytes())
 		require.NoError(t, err)