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