arnaucube
arnaucube/miden-cryptoPublic Self-hosted repository
miden-crypto/CHANGELOG.md
CHANGELOG.mdRaw
  1## 0.13.0 (TBD)
  2
  3- Fixed a bug in the implementation of `draw_integers` for `RpoRandomCoin` (#343).
  4- [BREAKING] Refactor error messages and use `thiserror` to derive errors (#344).
  5
  6## 0.12.0 (2024-10-30)
  7
  8- [BREAKING] Updated Winterfell dependency to v0.10 (#338).
  9
 10## 0.11.0 (2024-10-17)
 11
 12- [BREAKING]: renamed `Mmr::open()` into `Mmr::open_at()` and `Mmr::peaks()` into `Mmr::peaks_at()` (#234).
 13- Added `Mmr::open()` and `Mmr::peaks()` which rely on `Mmr::open_at()` and `Mmr::peaks()` respectively (#234).
 14- Standardized CI and Makefile across Miden repos (#323).
 15- Added `Smt::compute_mutations()` and `Smt::apply_mutations()` for validation-checked insertions (#327).
 16- Changed padding rule for RPO/RPX hash functions (#318).
 17- [BREAKING] Changed return value of the `Mmr::verify()` and `MerklePath::verify()` from `bool` to `Result<>` (#335).
 18- Added `is_empty()` functions to the `SimpleSmt` and `Smt` structures. Added `EMPTY_ROOT` constant to the `SparseMerkleTree` trait (#337).
 19
 20## 0.10.3 (2024-09-25)
 21
 22- Implement `get_size_hint` for `Smt` (#331).
 23
 24## 0.10.2 (2024-09-25)
 25
 26- Implement `get_size_hint` for `RpoDigest` and `RpxDigest` and expose constants for their serialized size (#330).
 27
 28## 0.10.1 (2024-09-13)
 29
 30- Added `Serializable` and `Deserializable` implementations for `PartialMmr` and `InOrderIndex` (#329).
 31
 32## 0.10.0 (2024-08-06)
 33
 34- Added more `RpoDigest` and `RpxDigest` conversions (#311).
 35- [BREAKING] Migrated to Winterfell v0.9 (#315).
 36- Fixed encoding of Falcon secret key (#319).
 37
 38## 0.9.3 (2024-04-24)
 39
 40- Added `RpxRandomCoin` struct (#307).
 41
 42## 0.9.2 (2024-04-21)
 43
 44- Implemented serialization for the `Smt` struct (#304).
 45- Fixed a bug in Falcon signature generation (#305).
 46
 47## 0.9.1 (2024-04-02)
 48
 49- Added `num_leaves()` method to `SimpleSmt` (#302).
 50
 51## 0.9.0 (2024-03-24)
 52
 53- [BREAKING] Removed deprecated re-exports from liballoc/libstd (#290).
 54- [BREAKING] Refactored RpoFalcon512 signature to work with pure Rust (#285).
 55- [BREAKING] Added `RngCore` as supertrait for `FeltRng` (#299).
 56
 57# 0.8.4 (2024-03-17)
 58
 59- Re-added unintentionally removed re-exported liballoc macros (`vec` and `format` macros).
 60
 61# 0.8.3 (2024-03-17)
 62
 63- Re-added unintentionally removed re-exported liballoc macros (#292).
 64
 65# 0.8.2 (2024-03-17)
 66
 67- Updated `no-std` approach to be in sync with winterfell v0.8.3 release (#290).
 68
 69## 0.8.1 (2024-02-21)
 70
 71- Fixed clippy warnings (#280)
 72
 73## 0.8.0 (2024-02-14)
 74
 75- Implemented the `PartialMmr` data structure (#195).
 76- Implemented RPX hash function (#201).
 77- Added `FeltRng` and `RpoRandomCoin` (#237).
 78- Accelerated RPO/RPX hash functions using AVX512 instructions (#234).
 79- Added `inner_nodes()` method to `PartialMmr` (#238).
 80- Improved `PartialMmr::apply_delta()` (#242).
 81- Refactored `SimpleSmt` struct (#245).
 82- Replaced `TieredSmt` struct with `Smt` struct (#254, #277).
 83- Updated Winterfell dependency to v0.8 (#275).
 84
 85## 0.7.1 (2023-10-10)
 86
 87- Fixed RPO Falcon signature build on Windows.
 88
 89## 0.7.0 (2023-10-05)
 90
 91- Replaced `MerklePathSet` with `PartialMerkleTree` (#165).
 92- Implemented clearing of nodes in `TieredSmt` (#173).
 93- Added ability to generate inclusion proofs for `TieredSmt` (#174).
 94- Implemented Falcon DSA (#179).
 95- Added conditional `serde`` support for various structs (#180).
 96- Implemented benchmarking for `TieredSmt` (#182).
 97- Added more leaf traversal methods for `MerkleStore` (#185).
 98- Added SVE acceleration for RPO hash function (#189).
 99
100## 0.6.0 (2023-06-25)
101
102- [BREAKING] Added support for recording capabilities for `MerkleStore` (#162).
103- [BREAKING] Refactored Merkle struct APIs to use `RpoDigest` instead of `Word` (#157).
104- Added initial implementation of `PartialMerkleTree` (#156).
105
106## 0.5.0 (2023-05-26)
107
108- Implemented `TieredSmt` (#152, #153).
109- Implemented ability to extract a subset of a `MerkleStore` (#151).
110- Cleaned up `SimpleSmt` interface (#149).
111- Decoupled hashing and padding of peaks in `Mmr` (#148).
112- Added `inner_nodes()` to `MerkleStore` (#146).
113
114## 0.4.0 (2023-04-21)
115
116- Exported `MmrProof` from the crate (#137).
117- Allowed merging of leaves in `MerkleStore` (#138).
118- [BREAKING] Refactored how existing data structures are added to `MerkleStore` (#139).
119
120## 0.3.0 (2023-04-08)
121
122- Added `depth` parameter to SMT constructors in `MerkleStore` (#115).
123- Optimized MMR peak hashing for Miden VM (#120).
124- Added `get_leaf_depth` method to `MerkleStore` (#119).
125- Added inner node iterators to `MerkleTree`, `SimpleSmt`, and `Mmr` (#117, #118, #121).
126
127## 0.2.0 (2023-03-24)
128
129- Implemented `Mmr` and related structs (#67).
130- Implemented `MerkleStore` (#93, #94, #95, #107 #112).
131- Added benchmarks for `MerkleStore` vs. other structs (#97).
132- Added Merkle path containers (#99).
133- Fixed depth handling in `MerklePathSet` (#110).
134- Updated Winterfell dependency to v0.6.
135
136## 0.1.4 (2023-02-22)
137
138- Re-export winter-crypto Hasher, Digest & ElementHasher (#72)
139
140## 0.1.3 (2023-02-20)
141
142- Updated Winterfell dependency to v0.5.1 (#68)
143
144## 0.1.2 (2023-02-17)
145
146- Fixed `Rpo256::hash` pad that was panicking on input (#44)
147- Added `MerklePath` wrapper to encapsulate Merkle opening verification and root computation (#53)
148- Added `NodeIndex` Merkle wrapper to encapsulate Merkle tree traversal and mappings (#54)
149
150## 0.1.1 (2023-02-06)
151
152- Introduced `merge_in_domain` for the RPO hash function, to allow using a specified domain value in the second capacity register when hashing two digests together.
153- Added a simple sparse Merkle tree implementation.
154- Added re-exports of Winterfell RandomCoin and RandomCoinError.
155
156## 0.1.0 (2022-12-02)
157
158- Initial release on crates.io containing the cryptographic primitives used in Miden VM and the Miden Rollup.
159- Hash module with the BLAKE3 and Rescue Prime Optimized hash functions.
160  - BLAKE3 is implemented with 256-bit, 192-bit, or 160-bit output.
161  - RPO is implemented with 256-bit output.
162- Merkle module, with a set of data structures related to Merkle trees, implemented using the RPO hash function.