From 35a83644ebc7b98bb3c83e8aeada17343dd03756 Mon Sep 17 00:00:00 2001 From: Olexandr88 Date: Tue, 21 Jan 2025 01:38:51 +0200 Subject: [PATCH 1/2] docs: readme (#592) Co-authored-by: Ivo Kubjas --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c92ba7855c..26ae98982a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # gnark-crypto -[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/gnark_team.svg?style=social&label=Follow%20%40gnark_team)](https://twitter.com/gnark_team) [![License](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto)](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto) [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/Consensys/gnark-crypto)](https://pkg.go.dev/mod/github.com/Consensys/gnark-crypto) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815453.svg)](https://doi.org/10.5281/zenodo.5815453) +[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/gnark_team.svg?style=social&label=Follow%20%40gnark_team)](https://x.com/gnark_team) [![License](https://img.shields.io/badge/license-Apache%202-blue)](LICENSE) [![Go Report Card](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto)](https://goreportcard.com/badge/github.com/Consensys/gnark-crypto) [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/consensys/gnark-crypto)](https://pkg.go.dev/mod/github.com/consensys/gnark-crypto) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5815453.svg)](https://doi.org/10.5281/zenodo.5815453) `gnark-crypto` provides efficient cryptographic primitives, in Go: * Elliptic curve cryptography & **Pairing** on: - * [`bn254`] ([audit report](https://github.com/Consensys/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf)) - * [`bls12-381`] ([audit report](https://github.com/Consensys/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf)) + * [`bn254`] ([audit report](https://github.com/consensys/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf)) + * [`bls12-381`] ([audit report](https://github.com/consensys/gnark/blob/master/audits/2022-10%20-%20Kudelski%20-%20gnark-crypto.pdf)) * [`bls24-317`] * [`bls12-377`] / [`bw6-761`] * [`bls24-315`] / [`bw6-633`] @@ -103,20 +103,20 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available, This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for details. -[`field/goff`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/field/goff -[`bn254`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254 -[`bls12-381`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls12-381 -[`bls24-317`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls24-317 -[`bls12-377`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls12-377 -[`bls24-315`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bls24-315 -[`bw6-761`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bw6-761 -[`bw6-633`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bw6-633 -[`twistededwards`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/twistededwards -[`eddsa`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/twistededwards/eddsa -[`fft`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/fft -[`fri`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/fri -[`mimc`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/mimc -[`kzg`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/kzg -[`plookup`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/plookup -[`permutation`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/ecc/bn254/fr/permutation -[`fiatshamir`]: https://pkg.go.dev/github.com/Consensys/gnark-crypto/fiat-shamir +[`field/goff`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/field/goff +[`bn254`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254 +[`bls12-381`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls12-381 +[`bls24-317`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls24-317 +[`bls12-377`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls12-377 +[`bls24-315`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bls24-315 +[`bw6-761`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bw6-761 +[`bw6-633`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bw6-633 +[`twistededwards`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/twistededwards +[`eddsa`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/twistededwards/eddsa +[`fft`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/fft +[`fri`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/fri +[`mimc`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/mimc +[`kzg`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/kzg +[`plookup`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/plookup +[`permutation`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/ecc/bn254/fr/permutation +[`fiatshamir`]: https://pkg.go.dev/github.com/consensys/gnark-crypto/fiat-shamir From 2acf0658fb3882f4e634fef72e1be180d4f06f04 Mon Sep 17 00:00:00 2001 From: piguagua Date: Tue, 21 Jan 2025 08:01:01 +0800 Subject: [PATCH 2/2] chore: fix problematic function name in comment (#605) Signed-off-by: piguagua --- field/generator/config/fft_config.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/field/generator/config/fft_config.go b/field/generator/config/fft_config.go index e36d38aa0d..faa7fa9fc2 100644 --- a/field/generator/config/fft_config.go +++ b/field/generator/config/fft_config.go @@ -12,7 +12,7 @@ type FFT struct { } -// NewFFTConfig returns a data structure with needed information to generate apis for the FFT +// NewConfig returns a data structure with needed information to generate apis for the FFT func NewConfig( genFullMultiplicativeGroup uint64, generatorMaxTwoAdicSubgroup,