docs: added release notes for v0.5.1 in CHANGELOG.md

Consensys · Sep 21, 2021 · 3a403e7 · 3a403e7
1 parent afede0e
commit 3a403e7
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 10 deletions.
diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml
@@ -31,18 +31,18 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-go-
     - name: install deps
-      run: go get golang.org/x/tools/cmd/goimports && go get github.com/klauspost/asmfmt/cmd/asmfmt
+      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 get -u honnef.co/go/tools/cmd/staticcheck
+        go install honnef.co/go/tools/cmd/staticcheck@latest
         staticcheck ./...
     - name: gosec
       run: |
-        go get -u github.com/securego/gosec/cmd/gosec
+        go install github.com/securego/gosec/cmd/gosec@latest
         gosec -exclude G204 ./...
     - name: generated files should not be modified
       run: |
@@ -77,7 +77,7 @@ jobs:
         restore-keys: |
           ${{ runner.os }}-go-
     - name: install deps
-      run: go get golang.org/x/tools/cmd/goimports && go get github.com/klauspost/asmfmt/cmd/asmfmt
+      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=20m -short ./...

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,42 @@
+<a name="v0.5.1"></a>
+## [v0.5.1] - 2021-09-20
+
+### Build
+- updated to gnark-crypto@v0.5.1
+
+### Feat
+- adds solver hints `cs.NewHint` [#139](https://github.com/ConsenSys/gnark/pull/139)
+- adds `cs.AssertIsDifferent` [#131](https://github.com/ConsenSys/gnark/pull/131)
+- consistent support of `cs.Println` and `debugInfo` [#142](https://github.com/ConsenSys/gnark/pull/142)
+- adds sanity check in `frontend.Compile` to ensure constraint validity
+- adds `witness.WriteSequence` to export expected witness sequence
+- adds sanity checks in R1CS and SparseR1CS solvers
+- adds ToHTML on SparseR1CS and R1CS
+- add witness reconstruction methods. closes [#135](https://github.com/consensys/gnark/issues/135)
+
+### Perf
+- IsZero is now implemented with 3 constraints [#134](https://github.com/ConsenSys/gnark/pull/134)
+- Groth16 maximize number of infinity points in G2 part of the ProvingKey [#130](https://github.com/ConsenSys/gnark/pull/130)
+
+### Fix
+- can constraint linear expressions to be boolean fixes [#136](https://github.com/consensys/gnark/issues/136)
+- **eddsa:** addition of isOnCurve check
+- **eddsa:** S not splitted (s<r) + 2,3 Double instead of [cofactor]G
+
+### Refactor
+- `groth16.Prove` and `plonk.Prove` takes `backend.ProverOption` as parameter
+- factorized structs between `compiled.SparseR1CS` and `compiled.R1CS`
+- assertions -> constraints in `R1CS` and `SparseR1CS`
+- removed `r1c.SolvingMethod` in favor of `cs.NewHint`
+- `cs.IsZero` doesn't need curveID anymore
+
+### Test
+- ensure `frontend.Compile` is deterministic
+- added non regression for `cs.Println` and `debugInfo` traces
+- added circuit statistic non regression tests
+- added plonk path to `integration_test.go`
+- added test from [#136](https://github.com/consensys/gnark/issues/136)
+
 
 <a name="v0.5.0"></a>
 

diff --git a/go.mod b/go.mod
@@ -3,8 +3,8 @@ module github.com/consensys/gnark
 go 1.16
 
 require (
-	github.com/consensys/bavard v0.1.8-0.20210806153619-fcffe4ffd871
-	github.com/consensys/gnark-crypto v0.5.1-0.20210917183421-cb36b2c871c0
+	github.com/consensys/bavard v0.1.8-0.20210915155054-088da2f7f54a
+	github.com/consensys/gnark-crypto v0.5.1
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/fxamacker/cbor/v2 v2.2.0
 	github.com/kr/pretty v0.2.0 // indirect

diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
-github.com/consensys/bavard v0.1.8-0.20210806153619-fcffe4ffd871 h1:gfdz2r/E4uQhD8jDUv2SaWQClfzFuZioHGAzPw7oZng=
-github.com/consensys/bavard v0.1.8-0.20210806153619-fcffe4ffd871/go.mod h1:Bpd0/3mZuaj6Sj+PqrmIquiOKy397AKGThQPaGzNXAQ=
-github.com/consensys/gnark-crypto v0.5.1-0.20210917183421-cb36b2c871c0 h1:ODfAG0P/XaGvh1JNZM9tzL2MKVaqFdE7FeATcrdrHB0=
-github.com/consensys/gnark-crypto v0.5.1-0.20210917183421-cb36b2c871c0/go.mod h1:wAZ9dsKCDVTSIy2KVTik+ZF16GUX9qp96mxFBDl9iAQ=
+github.com/consensys/bavard v0.1.8-0.20210915155054-088da2f7f54a h1:AEpwbXTjBGKoqxuQ6QAcBMEuK0+PtajQj0wJkhTnSd0=
+github.com/consensys/bavard v0.1.8-0.20210915155054-088da2f7f54a/go.mod h1:9ItSMtA/dXMAiL7BG6bqW2m3NdSEObYWoH223nGHukI=
+github.com/consensys/gnark-crypto v0.5.1 h1:80Uu3fxY5mezoT2cIctyQcn4AcqMNl6nb+zfnYBE24Q=
+github.com/consensys/gnark-crypto v0.5.1/go.mod h1:hOdPlWQV1gDLp7faZVeg8Y0iEPFaOUnCc4XeCCk96p0=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -36,3 +36,5 @@ gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+rsc.io/tmplfunc v0.0.3 h1:53XFQh69AfOa8Tw0Jm7t+GV7KZhOi6jzsCzTtKbMvzU=
+rsc.io/tmplfunc v0.0.3/go.mod h1:AG3sTPzElb1Io3Yg4voV9AGZJuleGAwaVRxL9M49PhA=