Skip to content

Commit 2001021

Browse files
committed
docs: update CHANGELOG
1 parent abf2fa3 commit 2001021

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ As a minor extension, we have adopted a slightly different versioning convention
1111

1212
- **BREAKING** changes in aggregator OpenAPI: removed the `next_cardano_transactions_signing_config` in `/epoch-settings` route.
1313

14+
- Support for multiple aggregate signature proof systems.
15+
1416
- Crates versions:
1517

1618
| Crate | Version |
@@ -20,6 +22,7 @@ As a minor extension, we have adopted a slightly different versioning convention
2022
## Mithril Distribution [2537] - 2025-09-17
2123

2224
- Client library, CI and WASM:
25+
2326
- Support for stable `cardano_database_v2` backend in the `mithril-client` library.
2427

2528
- Support for stable `v2` backend of `cardano-db` command and decommission of the `cardano-db-v2` command in client CLI.
@@ -47,6 +50,7 @@ As a minor extension, we have adopted a slightly different versioning convention
4750
- Support for the Rust `2024` edition (from `2021` edition).
4851

4952
- **UNSTABLE** :
53+
5054
- Support for certificates chain synchronization between leader/follower aggregators.
5155

5256
- Support for DMQ signature publisher in the signer and signature consumer in the aggregator.
@@ -72,11 +76,14 @@ As a minor extension, we have adopted a slightly different versioning convention
7276
- Support for recording client types origin (library, CLI and WASM) in the aggregator metrics.
7377

7478
- **UNSTABLE** :
79+
7580
- New UTxO-HD snapshot converter command for client CLI:
81+
7682
- Added the `tools utxo-hd snapshot-converter` command to the client CLI that converts a restored UTxO-HD snapshot to another flavor.
7783
- Support for converting to `LMDB` on-disk and `Legacy` in-memory flavors.
7884

7985
- New api for client CLI partial cardano database restoration (aka Cardano DB V2):
86+
8087
- Support for switching the backend with parameter `--backend [v1,v2]` to `cardano-database` snapshot list, snapshot show and download subcommands:
8188
- backend `v1` (default): support full database restoration only.
8289
- backend `v2` (require `--unstable`): support full and partial database restoration.
@@ -100,6 +107,7 @@ As a minor extension, we have adopted a slightly different versioning convention
100107
## Mithril Distribution [2517.0] - 2025-05-05
101108

102109
- **BREAKING** changes in Mithril client CLI and library:
110+
103111
- To fast bootstrap a Cardano node, the new `--include-ancillary` option has been added to the _Cardano node database_ command in the Mithril client CLI.
104112
- Without this option, only final immutable files are downloaded, and the ledger state must be computed from the genesis block when the Cardano node starts.
105113
- The `--include-ancillary` option requires the usage of an **ancillary verification key** (`--ancillary-verification-key` or `ANCILLARY_VERIFICATION_KEY`) which is specified in the [Networks configuration](https://mithril.network/doc/manual/getting-started/network-configurations) page.
@@ -128,6 +136,7 @@ As a minor extension, we have adopted a slightly different versioning convention
128136
## Mithril Distribution [2513.0] - 2025-03-28
129137

130138
- **BREAKING** changes in Mithril nodes:
139+
131140
- Upgraded the minimum required `glibc` version from `2.31` to `2.35` for the pre-built Linux binaries
132141
- Mithril signer with versions `<=0.2.200` **must be updated** following the cleanup of `Thales` era legacy code
133142
- Mithril client library `with_snapshot_uploader` function has been renamed to `with_file_uploader`.
@@ -137,13 +146,15 @@ As a minor extension, we have adopted a slightly different versioning convention
137146
- End support for **macOS x64 pre-built binaries** for the client CLI.
138147

139148
- Cardano database full certification:
149+
140150
- Creation of two separate archives for the immutable files and for the ancillary files.
141151
- Added a signed manifest file to the ancillary archive (contains the list of all files in the archive and their sha256 hashes).
142152
- Added client validation of the signature of the manifest file and the integrity of the files in the archive after downloading an ancillary archive.
143153

144154
- **UNSTABLE** Implement a follower signer registration mode in the aggregator.
145155

146156
- **UNSTABLE** Cardano database incremental certification:
157+
147158
- Implement the client library for the signed entity type `CardanoDatabase` (download and prove snapshot).
148159
- Implement the client CLI commands for the signed entity type `CardanoDatabase` (snapshot list, snapshot show and download commands).
149160
- Implement an example crate for the signed entity type `CardanoDatabase`.
@@ -178,6 +189,7 @@ As a minor extension, we have adopted a slightly different versioning convention
178189
- Support certification of the protocol parameters and epoch in the certificate chain.
179190

180191
- **UNSTABLE** Cardano database incremental certification:
192+
181193
- Implement the artifact routes of the aggregator for the signed entity type `CardanoDatabase`.
182194
- Implement the immutable file digests route in the aggregator.
183195
- Implement the artifact ancillary builder in the aggregator.
@@ -201,6 +213,7 @@ As a minor extension, we have adopted a slightly different versioning convention
201213
## Mithril Distribution [2450.0] - 2024-12-17
202214

203215
- **BREAKING** changes in Mithril client library, CLI, and WASM:
216+
204217
- Remove deprecated `network` field from the internal `CardanoDbBeacon`.
205218
- The Mithril certificates of type `CardanoImmutableFilesFull` can't be verified anymore with the previous clients.
206219
- Clients from distribution [`2445`](#mithril-distribution-24450---2024-11-07) and earlier must be updated.
@@ -219,6 +232,7 @@ As a minor extension, we have adopted a slightly different versioning convention
219232
- Update to Rust `1.83`.
220233

221234
- **UNSTABLE** Cardano database incremental certification:
235+
222236
- Implement the new signed entity type `CardanoDatabase`.
223237
- Implement the signable builder for the signed entity type `CardanoDatabase`.
224238

@@ -237,6 +251,7 @@ As a minor extension, we have adopted a slightly different versioning convention
237251
## Mithril Distribution [2445.0] - 2024-11-07
238252

239253
- **BREAKING** changes in Mithril client library, CLI, and WASM:
254+
240255
- Remove deprecated `beacon` field from Mithril certificates.
241256
- Clients from distribution [`2430`](#mithril-distribution-24300---2024-07-30) and above are compatible with this change.
242257

@@ -265,6 +280,7 @@ As a minor extension, we have adopted a slightly different versioning convention
265280
## Mithril Distribution [2442.0] - 2024-10-21
266281

267282
- Decentralization of the signature orchestration:
283+
268284
- Optimizations of the state machine used by the signer to create individual signatures.
269285

270286
- Support for buffering of incoming single signatures by the aggregator if it can not aggregate them yet.
@@ -300,6 +316,7 @@ As a minor extension, we have adopted a slightly different versioning convention
300316
## Mithril Distribution [2437.1] - 2024-09-23
301317

302318
- **BREAKING** changes in Mithril client WASM:
319+
303320
- Implementation of seamless transition from **unstable** to **stable** features.
304321
- A new `unstable` option in the client allows the usage of unstable features.
305322
- The previous `client.unstable` implementation is not supported anymore and must be replaced with `client`.
@@ -315,11 +332,13 @@ As a minor extension, we have adopted a slightly different versioning convention
315332
- Post `Chang` hard fork cleanup of the CI, devnet and infrastructure.
316333

317334
- Cardano transactions certification (stable for signer and aggregator):
335+
318336
- Support for Mithril signer memory optimization when signing Cardano transactions with multiple Merkle tree storage backends.
319337
- Support infinite preloading of Cardano transactions in signer.
320338
- Fix Cardano transactions rollbacks creating panics in signer and aggregator.
321339

322340
- Cardano stake distribution certification (stable for signer and aggregator):
341+
323342
- Implement the signable and artifact builders for the signed entity type `CardanoStakeDistribution`.
324343
- Implement the HTTP routes related to the signed entity type `CardanoStakeDistribution` on the aggregator REST API.
325344
- Added support in the `mithril-client` library for retrieving `CardanoStakeDistribution` by epoch or by hash, and for listing all available `CardanoStakeDistribution`.
@@ -350,6 +369,7 @@ As a minor extension, we have adopted a slightly different versioning convention
350369
- Support better disk configuration in terraform deployments with the CI/CD workflows.
351370

352371
- **UNSTABLE** Cardano transactions certification:
372+
353373
- Make Cardano transaction signing settings configurable via the CD.
354374

355375
- Crates versions:
@@ -385,6 +405,7 @@ As a minor extension, we have adopted a slightly different versioning convention
385405
- Field `beacon` becomes optional in `CertificatePendingMessage` response of `/certificate-pending` route.
386406

387407
- **UNSTABLE** Cardano transactions certification:
408+
388409
- Optimize the performances of the computation of the proof with a Merkle map.
389410
- Handle rollback events from the Cardano chain by removing stale data.
390411
- Preload Cardano transactions and Block Range Roots at signer & aggregator startup.
@@ -408,12 +429,14 @@ As a minor extension, we have adopted a slightly different versioning convention
408429
## Mithril Distribution [2423.0] - 2024-06-12
409430

410431
- **BREAKING** changes in Mithril client CLI:
432+
411433
- The deprecated `snapshot` command is removed from the Mithril client CLI
412434
- Use the `cardano-db snapshot` command instead.
413435

414436
- Update website and explorer user interface to use the new mithril logo.
415437

416438
- **UNSTABLE** Cardano transactions certification:
439+
417440
- Support computation of the Cardano Transactions signature and proving with the pre-computed Block Range Merkle Roots retrieved from the database.
418441
- Prune Cardano Transactions from the signer database after the Block Range Merkle Roots have been computed.
419442
- Implement a Chain Reader which retrieves blocks from the Cardano chain with Pallas through the `chainsync` mini-protocol.
@@ -435,6 +458,7 @@ As a minor extension, we have adopted a slightly different versioning convention
435458
## Mithril Distribution [2418.1] - 2024-05-13
436459

437460
- **BREAKING** changes in Mithril client CLI:
461+
438462
- Certificate chain structure has been modified to remove coupling with immutable file number.
439463
- Client needs to be updated to verify certificate chain.
440464

@@ -443,6 +467,7 @@ As a minor extension, we have adopted a slightly different versioning convention
443467
- Chain observers support the retrieval of the current Cardano chain point.
444468

445469
- Deprecate `portable` feature of `mithril-stm` and `mithril-client`:
470+
446471
- Instead, always enable BLST `portable` feature in `mithril-stm` for runtime check of intel ADX instruction set.
447472
- `portable` feature now has no effect and should be removed from crate dependencies.
448473
- Removed it from all other crates (including `mithril-common`).
@@ -466,6 +491,7 @@ As a minor extension, we have adopted a slightly different versioning convention
466491
- **GitHub release**: <https://github.com/input-output-hk/mithril/releases/tag/2412.0>
467492

468493
- _DEPRECATED_ the `snapshot` command in the Mithril client CLI:
494+
469495
- Renamed to `cardano-db snapshot`.
470496
- Will be **removed** in **2** distributions.
471497

mithril-stm/CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## 0.5.3 (10-07-2025)
9+
10+
### Added
11+
12+
- Added support for multiple aggregate signature proof systems.
13+
814
## 0.5.0 (09-09-2025)
915

1016
### Changed

0 commit comments

Comments
 (0)