Use optimized template

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'bug: ...'
+labels: ''
+assignees: ''
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Description
+<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
+
+## Expected Behavior
+<!--- Tell us what should happen -->
+
+## Actual Behavior
+<!--- Tell us what happens instead -->
+
+## Possible Fix
+<!--- Not obligatory, but suggest a fix or reason for the bug -->
+
+## Steps to Reproduce
+<!--- Provide an unambiguous set of steps to reproduce this bug. -->
+<!--- Include code to reproduce, if relevant -->
+<!--- or include https://play.gnark.io snippet, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+<!--- How has this bug affected you? What were you trying to accomplish? -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* gnark version used (e.g. v0.8.1, `HEAD@develop`):
+* gnark-crypto version used:
+* go version (e.g. 1.20.6):
+* Operating System and version:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+# Description
+
+<!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. -->
+
+Fixes # (issue)
+
+## Type of change
+
+<!-- Please delete options that are not relevant. -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# How has this been tested?
+
+<!-- Please describe the tests that you ran or implemented to verify your changes. Provide instructions so we can reproduce. -->
+
+- [ ] Test A
+- [ ] Test B
+
+# How has this been benchmarked?
+
+<!-- Please describe the benchmarks that you ran to verify your changes. -->
+
+- [ ] Benchmark A, on Macbook pro M1, 32GB RAM
+- [ ] Benchmark B, on x86 Intel xxx, 16GB RAM
+
+# Checklist:
+
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I did not modify files generated from templates
+- [ ] `golangci-lint` does not output errors locally
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+

.github/workflows/pr.yml

@@ -5,14 +5,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: install Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.19.x
+        go-version: 1.21.x
     - name: checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 0
-    - uses: actions/cache@v2
+    - uses: actions/cache@v3
       with:
         path: |
           ~/go/pkg/mod
@@ -22,10 +22,6 @@ 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
@@ -35,24 +31,35 @@ jobs:
         go generate ./...
         git update-index --assume-unchanged go.mod
         git update-index --assume-unchanged go.sum
-        if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after runing go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
+        if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after running go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
+
+     # hack to ensure golanglint process generated files
+    - name: remove "generated by" comments from generated files 
+      run: |
+        find . -type f -name '*.go' -exec sed -i 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
+      # on macos: find . -type f -name '*.go' -exec sed -i '' -E 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
+
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+          args: --timeout=5m
 
   test:
     strategy:
       matrix:
-        go-version: [1.19.x]
+        go-version: [1.21.x]
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     needs:
       - staticcheck
     steps:
     - name: install Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go-version }}
     - name: checkout code
-      uses: actions/checkout@v2
-    - uses: actions/cache@v2
+      uses: actions/checkout@v3
+    - uses: actions/cache@v3
       with:
         path: |
           ~/go/pkg/mod
@@ -63,10 +70,19 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-go-
     - name: install deps
-      run: go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
+      run: |
+        go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
+        go install github.com/ethereum/go-ethereum/cmd/[email protected]
+        go install github.com/consensys/gnark-solidity-checker@latest
+        sudo add-apt-repository ppa:ethereum/ethereum
+        sudo apt-get update
+        sudo apt-get install solc
     - name: Test
       run: |
-        go test -v -short -timeout=30m ./...
+        go test -v -short -tags=solccheck -timeout=30m ./...
+    - name: Test race
+      run: |
+        go test -v -short -race -timeout=50m
 
   slack-workflow-status-failed:
     if: failure()
@@ -78,15 +94,16 @@ jobs:
     steps:
       - name: Notify slack -- workflow failed
         id: slack
-        uses: slackapi/slack-github-action@v1.19.0
+        uses: slackapi/slack-github-action@v1.23.0
         with:
           payload: |
             {
               "actor": "${{ github.actor }}",
               "repo": "${{ github.repository }}",
               "status": "FAIL",
               "title": "${{ github.event.pull_request.title }}",
-              "pr": "${{ github.event.pull_request.head.ref }}"
+              "pr": "${{ github.event.pull_request.head.ref }}",
+              "failed_step_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/"
             }
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -101,7 +118,7 @@ jobs:
     steps:
       - name: Notify slack -- workflow succeeded
         id: slack
-        uses: slackapi/slack-github-action@v1.19.0
+        uses: slackapi/slack-github-action@v1.23.0
         with:
           payload: |
             {

.github/workflows/push.yml

@@ -9,14 +9,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: install Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
-        go-version: 1.19.x
+        go-version: 1.21.x
     - name: checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 0
-    - uses: actions/cache@v2
+    - uses: actions/cache@v3
       with:
         path: |
           ~/go/pkg/mod
@@ -26,10 +26,8 @@ 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
@@ -39,24 +37,36 @@ jobs:
         go generate ./...
         git update-index --assume-unchanged go.mod
         git update-index --assume-unchanged go.sum
-        if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after runing go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
+        if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after running go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi
+
+     # hack to ensure golanglint process generated files
+    - name: remove "generated by" comments from generated files 
+      run: |
+        find . -type f -name '*.go' -exec sed -i 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
+      # on macos: find . -type f -name '*.go' -exec sed -i '' -E 's/Code generated by .* DO NOT EDIT/FOO/g' {} \;
+
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v3
+      with:
+          args: --timeout=5m
+
 
   test:
     strategy:
       matrix:
-        go-version: [1.19.x]
+        go-version: [1.21.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     needs:
       - staticcheck
     steps:
     - name: install Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go-version }}
     - name: checkout code
-      uses: actions/checkout@v2
-    - uses: actions/cache@v2
+      uses: actions/checkout@v3
+    - uses: actions/cache@v3
       with:
         path: |
           ~/go/pkg/mod
@@ -66,15 +76,30 @@ jobs:
         key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
         restore-keys: |
           ${{ runner.os }}-go-
+
     - name: install deps
-      run: go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
-    - name: Test
       run: |
-        go test -v -timeout=30m ./...
-    - name: Test (race)
+        go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest
+        go install github.com/ethereum/go-ethereum/cmd/[email protected]
+    - name: install solc deps
       if: matrix.os == 'ubuntu-latest'
       run: |
-        go test -v -timeout=50m -race -short ./...
+        go install github.com/consensys/gnark-solidity-checker@latest
+        sudo add-apt-repository ppa:ethereum/ethereum
+        sudo apt-get update
+        sudo apt-get install solc
+    - name: Test (windows / mac)
+      # on macOS CI / Windows CI we avoid running the std/ tests (they are run on ubuntu CI)
+      if: matrix.os != 'ubuntu-latest'
+      run: |
+        go test -v -timeout=60m .
+        go test -v -timeout=60m ./frontend/...
+        go test -v -timeout=60m ./backend/...
+    - name: Test (race and solc)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        go test -v -tags=solccheck ./...
+        go test -v -timeout=60m -race -short ./...
 
   slack-workflow-status-failed:
     if: failure()
@@ -86,15 +111,16 @@ jobs:
     steps:
       - name: Notify slack -- workflow failed
         id: slack
-        uses: slackapi/slack-github-action@v1.19.0
+        uses: slackapi/slack-github-action@v1.23.0
         with:
           payload: |
             {
               "actor": "${{ github.actor }}",
               "repo": "${{ github.repository }}",
               "status": "FAIL",
               "title": "push to ${{ github.event.push.base_ref }}",
-              "pr": ""
+              "pr": "",
+              "failed_step_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/"
             }
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
@@ -109,7 +135,7 @@ jobs:
     steps:
       - name: Notify slack -- workflow succeeded
         id: slack
-        uses: slackapi/slack-github-action@v1.19.0
+        uses: slackapi/slack-github-action@v1.23.0
         with:
           payload: |
             {

.gitignore

@@ -50,3 +50,9 @@ gnarkd/circuits/**
 
 # Jetbrains stuff
 .idea/
+
+# go workspace
+go.work
+go.work.sum
+
+examples/gbotrel/**

README.md

@@ -122,17 +122,17 @@ 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.8.0,
+@software{gnark-v0.9.0,
   author       = {Gautam Botrel and
                   Thomas Piellard and
                   Youssef El Housni and
                   Ivo Kubjas and
                   Arya Tabaie},
-  title        = {ConsenSys/gnark: v0.8.0},
+  title        = {ConsenSys/gnark: v0.9.0},
   month        = feb,
   year         = 2023,
   publisher    = {Zenodo},
-  version      = {v0.8.0},
+  version      = {v0.9.0},
   doi          = {10.5281/zenodo.5819104},
   url          = {https://doi.org/10.5281/zenodo.5819104}
 }