Skip to content

Commit 1c85ed0

Browse files
committed
docs: update CHANGELOG
1 parent bcd25c4 commit 1c85ed0

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CHANGELOG.md

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

1010
## Mithril Distribution [XXXX] - UNRELEASED
1111

12+
- Support for `Cardano node` `10.5.1` in the signer and the aggregator.
13+
1214
- `cardano_database_v2` in the `mithril-client` library is now stable
1315

1416
- Support for loose enforcement of OpenAPI compatibility: a warning is displayed when a call to an aggregator may be incompatible.
@@ -30,6 +32,7 @@ As a minor extension, we have adopted a slightly different versioning convention
3032
- Support for Mithril era transition in the client library, CLI and WASM.
3133

3234
- **UNSTABLE** :
35+
3336
- Support for DMQ signature publisher in the signer and signature consumer in the aggregator.
3437

3538
- Implement automatic certificates chain synchronization between leader/follower aggregators.
@@ -47,11 +50,14 @@ As a minor extension, we have adopted a slightly different versioning convention
4750
- Support for recording client types origin (library, CLI and WASM) in the aggregator metrics.
4851

4952
- **UNSTABLE** :
53+
5054
- New UTxO-HD snapshot converter command for client CLI:
55+
5156
- Added the `tools utxo-hd snapshot-converter` command to the client CLI that converts a restored UTxO-HD snapshot to another flavor.
5257
- Support for converting to `LMDB` on-disk and `Legacy` in-memory flavors.
5358

5459
- New api for client CLI partial cardano database restoration (aka Cardano DB V2):
60+
5561
- Support for switching the backend with parameter `--backend [v1,v2]` to `cardano-database` snapshot list, snapshot show and download subcommands:
5662
- backend `v1` (default): support full database restoration only.
5763
- backend `v2` (require `--unstable`): support full and partial database restoration.
@@ -75,6 +81,7 @@ As a minor extension, we have adopted a slightly different versioning convention
7581
## Mithril Distribution [2517.0] - 2025-05-05
7682

7783
- **BREAKING** changes in Mithril client CLI and library:
84+
7885
- 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.
7986
- 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.
8087
- 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.
@@ -103,6 +110,7 @@ As a minor extension, we have adopted a slightly different versioning convention
103110
## Mithril Distribution [2513.0] - 2025-03-28
104111

105112
- **BREAKING** changes in Mithril nodes:
113+
106114
- Upgraded the minimum required `glibc` version from `2.31` to `2.35` for the pre-built Linux binaries
107115
- Mithril signer with versions `<=0.2.200` **must be updated** following the cleanup of `Thales` era legacy code
108116
- Mithril client library `with_snapshot_uploader` function has been renamed to `with_file_uploader`.
@@ -112,13 +120,15 @@ As a minor extension, we have adopted a slightly different versioning convention
112120
- End support for **macOS x64 pre-built binaries** for the client CLI.
113121

114122
- Cardano database full certification:
123+
115124
- Creation of two separate archives for the immutable files and for the ancillary files.
116125
- Added a signed manifest file to the ancillary archive (contains the list of all files in the archive and their sha256 hashes).
117126
- Added client validation of the signature of the manifest file and the integrity of the files in the archive after downloading an ancillary archive.
118127

119128
- **UNSTABLE** Implement a follower signer registration mode in the aggregator.
120129

121130
- **UNSTABLE** Cardano database incremental certification:
131+
122132
- Implement the client library for the signed entity type `CardanoDatabase` (download and prove snapshot).
123133
- Implement the client CLI commands for the signed entity type `CardanoDatabase` (snapshot list, snapshot show and download commands).
124134
- Implement an example crate for the signed entity type `CardanoDatabase`.
@@ -153,6 +163,7 @@ As a minor extension, we have adopted a slightly different versioning convention
153163
- Support certification of the protocol parameters and epoch in the certificate chain.
154164

155165
- **UNSTABLE** Cardano database incremental certification:
166+
156167
- Implement the artifact routes of the aggregator for the signed entity type `CardanoDatabase`.
157168
- Implement the immutable file digests route in the aggregator.
158169
- Implement the artifact ancillary builder in the aggregator.
@@ -176,6 +187,7 @@ As a minor extension, we have adopted a slightly different versioning convention
176187
## Mithril Distribution [2450.0] - 2024-12-17
177188

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

196208
- **UNSTABLE** Cardano database incremental certification:
209+
197210
- Implement the new signed entity type `CardanoDatabase`.
198211
- Implement the signable builder for the signed entity type `CardanoDatabase`.
199212

@@ -212,6 +225,7 @@ As a minor extension, we have adopted a slightly different versioning convention
212225
## Mithril Distribution [2445.0] - 2024-11-07
213226

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

@@ -240,6 +254,7 @@ As a minor extension, we have adopted a slightly different versioning convention
240254
## Mithril Distribution [2442.0] - 2024-10-21
241255

242256
- Decentralization of the signature orchestration:
257+
243258
- Optimizations of the state machine used by the signer to create individual signatures.
244259

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

277292
- **BREAKING** changes in Mithril client WASM:
293+
278294
- Implementation of seamless transition from **unstable** to **stable** features.
279295
- A new `unstable` option in the client allows the usage of unstable features.
280296
- The previous `client.unstable` implementation is not supported anymore and must be replaced with `client`.
@@ -290,11 +306,13 @@ As a minor extension, we have adopted a slightly different versioning convention
290306
- Post `Chang` hard fork cleanup of the CI, devnet and infrastructure.
291307

292308
- Cardano transactions certification (stable for signer and aggregator):
309+
293310
- Support for Mithril signer memory optimization when signing Cardano transactions with multiple Merkle tree storage backends.
294311
- Support infinite preloading of Cardano transactions in signer.
295312
- Fix Cardano transactions rollbacks creating panics in signer and aggregator.
296313

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

327345
- **UNSTABLE** Cardano transactions certification:
346+
328347
- Make Cardano transaction signing settings configurable via the CD.
329348

330349
- Crates versions:
@@ -360,6 +379,7 @@ As a minor extension, we have adopted a slightly different versioning convention
360379
- Field `beacon` becomes optional in `CertificatePendingMessage` response of `/certificate-pending` route.
361380

362381
- **UNSTABLE** Cardano transactions certification:
382+
363383
- Optimize the performances of the computation of the proof with a Merkle map.
364384
- Handle rollback events from the Cardano chain by removing stale data.
365385
- Preload Cardano transactions and Block Range Roots at signer & aggregator startup.
@@ -383,12 +403,14 @@ As a minor extension, we have adopted a slightly different versioning convention
383403
## Mithril Distribution [2423.0] - 2024-06-12
384404

385405
- **BREAKING** changes in Mithril client CLI:
406+
386407
- The deprecated `snapshot` command is removed from the Mithril client CLI
387408
- Use the `cardano-db snapshot` command instead.
388409

389410
- Update website and explorer user interface to use the new mithril logo.
390411

391412
- **UNSTABLE** Cardano transactions certification:
413+
392414
- Support computation of the Cardano Transactions signature and proving with the pre-computed Block Range Merkle Roots retrieved from the database.
393415
- Prune Cardano Transactions from the signer database after the Block Range Merkle Roots have been computed.
394416
- Implement a Chain Reader which retrieves blocks from the Cardano chain with Pallas through the `chainsync` mini-protocol.
@@ -410,6 +432,7 @@ As a minor extension, we have adopted a slightly different versioning convention
410432
## Mithril Distribution [2418.1] - 2024-05-13
411433

412434
- **BREAKING** changes in Mithril client CLI:
435+
413436
- Certificate chain structure has been modified to remove coupling with immutable file number.
414437
- Client needs to be updated to verify certificate chain.
415438

@@ -418,6 +441,7 @@ As a minor extension, we have adopted a slightly different versioning convention
418441
- Chain observers support the retrieval of the current Cardano chain point.
419442

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

443467
- _DEPRECATED_ the `snapshot` command in the Mithril client CLI:
468+
444469
- Renamed to `cardano-db snapshot`.
445470
- Will be **removed** in **2** distributions.
446471

0 commit comments

Comments
 (0)