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