qyriad/miden-crypto
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated Changelog + pre commit

Browse source
This commit is contained in:
Paul-Henry Kajfasz 2024-08-16 16:09:51 -07:00
parent 374a10f340
commit ac3c6976bd
No known key found for this signature in database
GPG key ID: 5EB89DCE97DB7417
2 changed files with 74 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
.pre-commit-config.yaml
View file

@ -1,43 +1,34 @@
# See https://pre-commit.com for more information # See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks # See https://pre-commit.com/hooks.html for more hooks
repos: repos:
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0 rev: v4.6.0
hooks: hooks:
- id: trailing-whitespace - id: trailing-whitespace
- id: end-of-file-fixer - id: end-of-file-fixer
- id: check-yaml - id: check-yaml
- id: check-json - id: check-json
- id: check-toml - id: check-toml
- id: pretty-format-json - id: pretty-format-json
- id: check-added-large-files - id: check-added-large-files
- id: check-case-conflict - id: check-case-conflict
- id: check-executables-have-shebangs - id: check-executables-have-shebangs
- id: check-merge-conflict - id: check-merge-conflict
- id: detect-private-key - id: detect-private-key
- repo: https://github.com/hackaugusto/pre-commit-cargo - repo: local
rev: v1.0.0 hooks:
hooks: - id: lint
# Allows cargo fmt to modify the source code prior to the commit name: Make lint
- id: cargo stages: [commit]
name: Cargo fmt language: rust
args: ["+stable", "fmt", "--all"] entry: make lint
stages: [commit] - id: doc
# Requires code to be properly formatted prior to pushing upstream name: Make doc
- id: cargo stages: [commit]
name: Cargo fmt --check language: rust
args: ["+stable", "fmt", "--all", "--check"] entry: make doc
stages: [push, manual] - id: check
- id: cargo name: Make check
name: Cargo check --all-targets stages: [commit]
args: ["+stable", "check", "--all-targets"] language: rust
- id: cargo entry: make check
name: Cargo check --all-targets --no-default-features
args: ["+stable", "check", "--all-targets", "--no-default-features"]
- id: cargo
name: Cargo check --all-targets --features default,std,serde
args: ["+stable", "check", "--all-targets", "--features", "default,std,serde"]
# Unlike fmt, clippy will not be automatically applied
- id: cargo
name: Cargo clippy
args: ["+nightly", "clippy", "--workspace", "--", "--deny", "clippy::all", "--deny", "warnings"]

85
CHANGELOG.md
View file

@ -1,84 +1,85 @@
## 0.10.0 (2024-08-06) ## 0.10.0 (2024-08-06)
* Added more `RpoDigest` and `RpxDigest` conversions (#311). - Added more `RpoDigest` and `RpxDigest` conversions (#311).
* [BREAKING] Migrated to Winterfell v0.9 (#315). - [BREAKING] Migrated to Winterfell v0.9 (#315).
* Fixed encoding of Falcon secret key (#319). - Fixed encoding of Falcon secret key (#319).
- Standardised CI and Makefile across Miden repos (#323).
## 0.9.3 (2024-04-24) ## 0.9.3 (2024-04-24)
* Added `RpxRandomCoin` struct (#307). - Added `RpxRandomCoin` struct (#307).
## 0.9.2 (2024-04-21) ## 0.9.2 (2024-04-21)
* Implemented serialization for the `Smt` struct (#304). - Implemented serialization for the `Smt` struct (#304).
* Fixed a bug in Falcon signature generation (#305). - Fixed a bug in Falcon signature generation (#305).
## 0.9.1 (2024-04-02) ## 0.9.1 (2024-04-02)
* Added `num_leaves()` method to `SimpleSmt` (#302). - Added `num_leaves()` method to `SimpleSmt` (#302).
## 0.9.0 (2024-03-24) ## 0.9.0 (2024-03-24)
* [BREAKING] Removed deprecated re-exports from liballoc/libstd (#290). - [BREAKING] Removed deprecated re-exports from liballoc/libstd (#290).
* [BREAKING] Refactored RpoFalcon512 signature to work with pure Rust (#285). - [BREAKING] Refactored RpoFalcon512 signature to work with pure Rust (#285).
* [BREAKING] Added `RngCore` as supertrait for `FeltRng` (#299). - [BREAKING] Added `RngCore` as supertrait for `FeltRng` (#299).
# 0.8.4 (2024-03-17) # 0.8.4 (2024-03-17)
* Re-added unintentionally removed re-exported liballoc macros (`vec` and `format` macros). - Re-added unintentionally removed re-exported liballoc macros (`vec` and `format` macros).
# 0.8.3 (2024-03-17) # 0.8.3 (2024-03-17)
* Re-added unintentionally removed re-exported liballoc macros (#292). - Re-added unintentionally removed re-exported liballoc macros (#292).
# 0.8.2 (2024-03-17) # 0.8.2 (2024-03-17)
* Updated `no-std` approach to be in sync with winterfell v0.8.3 release (#290). - Updated `no-std` approach to be in sync with winterfell v0.8.3 release (#290).
## 0.8.1 (2024-02-21) ## 0.8.1 (2024-02-21)
* Fixed clippy warnings (#280) - Fixed clippy warnings (#280)
## 0.8.0 (2024-02-14) ## 0.8.0 (2024-02-14)
* Implemented the `PartialMmr` data structure (#195). - Implemented the `PartialMmr` data structure (#195).
* Implemented RPX hash function (#201). - Implemented RPX hash function (#201).
* Added `FeltRng` and `RpoRandomCoin` (#237). - Added `FeltRng` and `RpoRandomCoin` (#237).
* Accelerated RPO/RPX hash functions using AVX512 instructions (#234). - Accelerated RPO/RPX hash functions using AVX512 instructions (#234).
* Added `inner_nodes()` method to `PartialMmr` (#238). - Added `inner_nodes()` method to `PartialMmr` (#238).
* Improved `PartialMmr::apply_delta()` (#242). - Improved `PartialMmr::apply_delta()` (#242).
* Refactored `SimpleSmt` struct (#245). - Refactored `SimpleSmt` struct (#245).
* Replaced `TieredSmt` struct with `Smt` struct (#254, #277). - Replaced `TieredSmt` struct with `Smt` struct (#254, #277).
* Updated Winterfell dependency to v0.8 (#275). - Updated Winterfell dependency to v0.8 (#275).
## 0.7.1 (2023-10-10) ## 0.7.1 (2023-10-10)
* Fixed RPO Falcon signature build on Windows. - Fixed RPO Falcon signature build on Windows.
## 0.7.0 (2023-10-05) ## 0.7.0 (2023-10-05)
* Replaced `MerklePathSet` with `PartialMerkleTree` (#165). - Replaced `MerklePathSet` with `PartialMerkleTree` (#165).
* Implemented clearing of nodes in `TieredSmt` (#173). - Implemented clearing of nodes in `TieredSmt` (#173).
* Added ability to generate inclusion proofs for `TieredSmt` (#174). - Added ability to generate inclusion proofs for `TieredSmt` (#174).
* Implemented Falcon DSA (#179). - Implemented Falcon DSA (#179).
* Added conditional `serde`` support for various structs (#180). - Added conditional `serde`` support for various structs (#180).
* Implemented benchmarking for `TieredSmt` (#182). - Implemented benchmarking for `TieredSmt` (#182).
* Added more leaf traversal methods for `MerkleStore` (#185). - Added more leaf traversal methods for `MerkleStore` (#185).
* Added SVE acceleration for RPO hash function (#189). - Added SVE acceleration for RPO hash function (#189).
## 0.6.0 (2023-06-25) ## 0.6.0 (2023-06-25)
* [BREAKING] Added support for recording capabilities for `MerkleStore` (#162). - [BREAKING] Added support for recording capabilities for `MerkleStore` (#162).
* [BREAKING] Refactored Merkle struct APIs to use `RpoDigest` instead of `Word` (#157). - [BREAKING] Refactored Merkle struct APIs to use `RpoDigest` instead of `Word` (#157).
* Added initial implementation of `PartialMerkleTree` (#156). - Added initial implementation of `PartialMerkleTree` (#156).
## 0.5.0 (2023-05-26) ## 0.5.0 (2023-05-26)
* Implemented `TieredSmt` (#152, #153). - Implemented `TieredSmt` (#152, #153).
* Implemented ability to extract a subset of a `MerkleStore` (#151). - Implemented ability to extract a subset of a `MerkleStore` (#151).
* Cleaned up `SimpleSmt` interface (#149). - Cleaned up `SimpleSmt` interface (#149).
* Decoupled hashing and padding of peaks in `Mmr` (#148). - Decoupled hashing and padding of peaks in `Mmr` (#148).
* Added `inner_nodes()` to `MerkleStore` (#146). - Added `inner_nodes()` to `MerkleStore` (#146).
## 0.4.0 (2023-04-21) ## 0.4.0 (2023-04-21)
@ -126,6 +127,6 @@
- Initial release on crates.io containing the cryptographic primitives used in Miden VM and the Miden Rollup. - Initial release on crates.io containing the cryptographic primitives used in Miden VM and the Miden Rollup.
- Hash module with the BLAKE3 and Rescue Prime Optimized hash functions. - Hash module with the BLAKE3 and Rescue Prime Optimized hash functions.
- BLAKE3 is implemented with 256-bit, 192-bit, or 160-bit output. - BLAKE3 is implemented with 256-bit, 192-bit, or 160-bit output.
- RPO is implemented with 256-bit output. - RPO is implemented with 256-bit output.
- Merkle module, with a set of data structures related to Merkle trees, implemented using the RPO hash function. - Merkle module, with a set of data structures related to Merkle trees, implemented using the RPO hash function.