From abdac5a075cb11d2c70581acb411abac5ff8259f Mon Sep 17 00:00:00 2001 From: Gautam Botrel Date: Wed, 3 Aug 2022 16:30:41 -0500 Subject: [PATCH] docs: updated changelog for v0.8.0 --- CHANGELOG.md | 57 +++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 47 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index be9784379e..a142c31e13 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,35 +1,72 @@ -Note: this version will be partially audited (bn254 & bls12-381 packages). +## [v0.8.0] - 2022-08-03 -## [v0.8.0] - 2022-05-31 +This version was partially audited by Kudelski Security for the Algorand Foundation. (TODO insert report link). +The scope of the audit covered `bn254` and `bls12-381` packages (including field arithmetic). ### Feat -- field/generator suppors 1-limb modulus ([#175](https://github.com/ConsenSys/gnark-crypto/issues/175)) - field/goldilocks (more efficient 1-limb modulus arith) ([#177](https://github.com/ConsenSys/gnark-crypto/issues/177)) -- **fri:** FRI protocol support and improvments -- field.SetRandom: use random uniform sampling instead of mod reduce (zero-allocs) -- adds BLS24-317 curve optimized for KZG ([#179](https://github.com/ConsenSys/gnark-crypto/pull/179)) +- field/generator suppors 1-limb modulus ([#175](https://github.com/ConsenSys/gnark-crypto/issues/175)) +- field.SetRandom zero-alloc uniform sampling +- **E6/E12/E24:** GT torus-based batch compression/decompression +- **fri:** modified challenge generation so it fits in a snark variable +- **fri:** added check of correctness between rounds ### Fix +- Handle edge case in Karabina decompression ([#219](https://github.com/ConsenSys/gnark-crypto/issues/219)) +- check nbTasks config when running msm, test all possible c-bit windows in when testing.Short not set) ([#226](https://github.com/ConsenSys/gnark-crypto/issues/226)) +- element.SetString(_) returns error if invalid input instead of panic +- expand_msg_xmd copy bug, a few tests ([#201](https://github.com/ConsenSys/gnark-crypto/issues/201)) - closes [#199](https://github.com/ConsenSys/gnark-crypto/issues/199). Correct bound in eddsa key gen template -### Refactor & Cosmetics +### Perf + +- remove unecessary inverse in KZG-verify +- faster GLV scalar decompostion + +### Refactor & Docs +- moved consensys/goff into field/goff ([#204](https://github.com/ConsenSys/gnark-crypto/issues/204)) - clean comments in curves ([#193](https://github.com/ConsenSys/gnark-crypto/issues/193)) -- replace modulus generated by constants ([#194](https://github.com/ConsenSys/gnark-crypto/issues/194)) +- remove dead code ([#230](https://github.com/ConsenSys/gnark-crypto/issues/230)) +- cosmetic changes ([#197](https://github.com/ConsenSys/gnark-crypto/issues/197)) +- replace modulus generated by constants, add zero-alloc SetRandom ([#194](https://github.com/ConsenSys/gnark-crypto/issues/194)) - remove uneeded x86 asm and files ([#192](https://github.com/ConsenSys/gnark-crypto/issues/192)) -- code cleaning & cosmetic changes ([#197](https://github.com/ConsenSys/gnark-crypto/issues/197)) -- clean HashToCurve APIs ([#188](https://github.com/ConsenSys/gnark-crypto/pull/188)) +- polish readme.md with updated godoc subpackage links ([#235](https://github.com/ConsenSys/gnark-crypto/issues/235)) +- acknowledge that inv(0)==0 in comments as a convention ([#233](https://github.com/ConsenSys/gnark-crypto/issues/233)) +- added note in pairing godoc - doesn't check inputs are in correct subgroup ([#231](https://github.com/ConsenSys/gnark-crypto/issues/231)) +- add security estimates of implemented curves in comments + +### Test + +- fix [#205](https://github.com/ConsenSys/gnark-crypto/issues/205) - msm bench with different bases ([#206](https://github.com/ConsenSys/gnark-crypto/issues/206)) +- vectors generated using +- **all curves:** compress/decompress pairing result ### Pull Requests +- Merge pull request [#232](https://github.com/ConsenSys/gnark-crypto/issues/232) from ConsenSys/docs/comments +- Merge pull request [#229](https://github.com/ConsenSys/gnark-crypto/issues/229) from ConsenSys/update_deps +- Merge pull request [#227](https://github.com/ConsenSys/gnark-crypto/issues/227) from ConsenSys/fix/element_setstring +- Merge pull request [#228](https://github.com/ConsenSys/gnark-crypto/issues/228) from ConsenSys/fix/race/test +- Merge pull request [#224](https://github.com/ConsenSys/gnark-crypto/issues/224) from ConsenSys/refactor/scalarmul +- Merge pull request [#220](https://github.com/ConsenSys/gnark-crypto/issues/220) from ConsenSys/perf/kzg-verify +- Merge pull request [#223](https://github.com/ConsenSys/gnark-crypto/issues/223) from ConsenSys/doc/security-estimates-curves +- Merge pull request [#216](https://github.com/ConsenSys/gnark-crypto/issues/216) from ConsenSys/feat/poly +- Merge pull request [#217](https://github.com/ConsenSys/gnark-crypto/issues/217) from ConsenSys/string-utils +- Merge pull request [#213](https://github.com/ConsenSys/gnark-crypto/issues/213) from ConsenSys/perf/glv +- Merge pull request [#129](https://github.com/ConsenSys/gnark-crypto/issues/129) from ConsenSys/feat/GT-compression +- Merge pull request [#209](https://github.com/ConsenSys/gnark-crypto/issues/209) from ConsenSys/codegen/svdw-not-e4 +- Merge pull request [#203](https://github.com/ConsenSys/gnark-crypto/issues/203) from ConsenSys/tests/bn254-vectors +- Merge pull request [#196](https://github.com/ConsenSys/gnark-crypto/issues/196) from ConsenSys/patch/hashToFpGeneric - Merge pull request [#202](https://github.com/ConsenSys/gnark-crypto/issues/202) from ConsenSys/gbotrel/issue199 - Merge pull request [#200](https://github.com/ConsenSys/gnark-crypto/issues/200) from tyGavinZJU/develop - Merge pull request [#85](https://github.com/ConsenSys/gnark-crypto/issues/85) from ConsenSys/feat/fri + ## [v0.7.0] - 2022-03-24