Skip to content

Commit 979847a

Browse files
committed
docs: update CHANGELOG
1 parent 82c0747 commit 979847a

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,23 @@ As a minor extension, we have adopted a slightly different versioning convention
1414
- Support for multiple aggregate signature proof systems.
1515

1616
- Mithril-Aggregator:
17+
1718
- Added a `/artifact/cardano-database/epoch/{epoch}` route to fetch the list of cardano database snapshots for a given epoch, `{epoch}` can be a number, `latest`, or `latest-{offset}`.
1819
- Enhanced `/artifact/cardano-stake-distribution/epoch/{epoch}` route to support `latest` and `latest-{offset}` as `{epoch}` values.
1920

2021
- Client library and WASM:
22+
2123
- Added listing of `cardano_database_v2` snapshots for a given epoch, the latest epoch, or the latest epoch with offset
2224
- Added listing of `cardano_staked_distribution` snapshots for the latest epoch, or the latest epoch with offset
2325

2426
- Client CLI:
27+
2528
- Added `--epoch` optional parameter to `cardano-database snapshot list` commands snapshots, the given value can be a number, `latest`, or `latest-{offset}`.
2629

30+
- **UNSTABLE** :
31+
32+
- Support for Haskell DMQ node and modifications of the DMQ protocol.
33+
2734
- Crates versions:
2835

2936
| Crate | Version |
@@ -33,6 +40,7 @@ As a minor extension, we have adopted a slightly different versioning convention
3340
## Mithril Distribution [2537] - 2025-09-17
3441

3542
- Client library, CLI and WASM:
43+
3644
- Support for stable `cardano_database_v2` backend in the `mithril-client` library.
3745

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

6270
- **UNSTABLE** :
71+
6372
- Support for certificates chain synchronization between leader/follower aggregators.
6473

6574
- Support for DMQ signature publisher in the signer and signature consumer in the aggregator.
@@ -85,11 +94,14 @@ As a minor extension, we have adopted a slightly different versioning convention
8594
- Support for recording client types origin (library, CLI and WASM) in the aggregator metrics.
8695

8796
- **UNSTABLE** :
97+
8898
- New UTxO-HD snapshot converter command for client CLI:
99+
89100
- Added the `tools utxo-hd snapshot-converter` command to the client CLI that converts a restored UTxO-HD snapshot to another flavor.
90101
- Support for converting to `LMDB` on-disk and `Legacy` in-memory flavors.
91102

92103
- New api for client CLI partial cardano database restoration (aka Cardano DB V2):
104+
93105
- Support for switching the backend with parameter `--backend [v1,v2]` to `cardano-database` snapshot list, snapshot show and download subcommands:
94106
- backend `v1` (default): support full database restoration only.
95107
- backend `v2` (require `--unstable`): support full and partial database restoration.
@@ -113,6 +125,7 @@ As a minor extension, we have adopted a slightly different versioning convention
113125
## Mithril Distribution [2517.0] - 2025-05-05
114126

115127
- **BREAKING** changes in Mithril client CLI and library:
128+
116129
- 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.
117130
- 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.
118131
- 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.
@@ -141,6 +154,7 @@ As a minor extension, we have adopted a slightly different versioning convention
141154
## Mithril Distribution [2513.0] - 2025-03-28
142155

143156
- **BREAKING** changes in Mithril nodes:
157+
144158
- Upgraded the minimum required `glibc` version from `2.31` to `2.35` for the pre-built Linux binaries
145159
- Mithril signer with versions `<=0.2.200` **must be updated** following the cleanup of `Thales` era legacy code
146160
- Mithril client library `with_snapshot_uploader` function has been renamed to `with_file_uploader`.
@@ -150,13 +164,15 @@ As a minor extension, we have adopted a slightly different versioning convention
150164
- End support for **macOS x64 pre-built binaries** for the client CLI.
151165

152166
- Cardano database full certification:
167+
153168
- Creation of two separate archives for the immutable files and for the ancillary files.
154169
- Added a signed manifest file to the ancillary archive (contains the list of all files in the archive and their sha256 hashes).
155170
- Added client validation of the signature of the manifest file and the integrity of the files in the archive after downloading an ancillary archive.
156171

157172
- **UNSTABLE** Implement a follower signer registration mode in the aggregator.
158173

159174
- **UNSTABLE** Cardano database incremental certification:
175+
160176
- Implement the client library for the signed entity type `CardanoDatabase` (download and prove snapshot).
161177
- Implement the client CLI commands for the signed entity type `CardanoDatabase` (snapshot list, snapshot show and download commands).
162178
- Implement an example crate for the signed entity type `CardanoDatabase`.
@@ -191,6 +207,7 @@ As a minor extension, we have adopted a slightly different versioning convention
191207
- Support certification of the protocol parameters and epoch in the certificate chain.
192208

193209
- **UNSTABLE** Cardano database incremental certification:
210+
194211
- Implement the artifact routes of the aggregator for the signed entity type `CardanoDatabase`.
195212
- Implement the immutable file digests route in the aggregator.
196213
- Implement the artifact ancillary builder in the aggregator.
@@ -214,6 +231,7 @@ As a minor extension, we have adopted a slightly different versioning convention
214231
## Mithril Distribution [2450.0] - 2024-12-17
215232

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

234252
- **UNSTABLE** Cardano database incremental certification:
253+
235254
- Implement the new signed entity type `CardanoDatabase`.
236255
- Implement the signable builder for the signed entity type `CardanoDatabase`.
237256

@@ -250,6 +269,7 @@ As a minor extension, we have adopted a slightly different versioning convention
250269
## Mithril Distribution [2445.0] - 2024-11-07
251270

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

@@ -278,6 +298,7 @@ As a minor extension, we have adopted a slightly different versioning convention
278298
## Mithril Distribution [2442.0] - 2024-10-21
279299

280300
- Decentralization of the signature orchestration:
301+
281302
- Optimizations of the state machine used by the signer to create individual signatures.
282303

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

315336
- **BREAKING** changes in Mithril client WASM:
337+
316338
- Implementation of seamless transition from **unstable** to **stable** features.
317339
- A new `unstable` option in the client allows the usage of unstable features.
318340
- The previous `client.unstable` implementation is not supported anymore and must be replaced with `client`.
@@ -328,11 +350,13 @@ As a minor extension, we have adopted a slightly different versioning convention
328350
- Post `Chang` hard fork cleanup of the CI, devnet and infrastructure.
329351

330352
- Cardano transactions certification (stable for signer and aggregator):
353+
331354
- Support for Mithril signer memory optimization when signing Cardano transactions with multiple Merkle tree storage backends.
332355
- Support infinite preloading of Cardano transactions in signer.
333356
- Fix Cardano transactions rollbacks creating panics in signer and aggregator.
334357

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

365389
- **UNSTABLE** Cardano transactions certification:
390+
366391
- Make Cardano transaction signing settings configurable via the CD.
367392

368393
- Crates versions:
@@ -398,6 +423,7 @@ As a minor extension, we have adopted a slightly different versioning convention
398423
- Field `beacon` becomes optional in `CertificatePendingMessage` response of `/certificate-pending` route.
399424

400425
- **UNSTABLE** Cardano transactions certification:
426+
401427
- Optimize the performances of the computation of the proof with a Merkle map.
402428
- Handle rollback events from the Cardano chain by removing stale data.
403429
- Preload Cardano transactions and Block Range Roots at signer & aggregator startup.
@@ -421,12 +447,14 @@ As a minor extension, we have adopted a slightly different versioning convention
421447
## Mithril Distribution [2423.0] - 2024-06-12
422448

423449
- **BREAKING** changes in Mithril client CLI:
450+
424451
- The deprecated `snapshot` command is removed from the Mithril client CLI
425452
- Use the `cardano-db snapshot` command instead.
426453

427454
- Update website and explorer user interface to use the new mithril logo.
428455

429456
- **UNSTABLE** Cardano transactions certification:
457+
430458
- Support computation of the Cardano Transactions signature and proving with the pre-computed Block Range Merkle Roots retrieved from the database.
431459
- Prune Cardano Transactions from the signer database after the Block Range Merkle Roots have been computed.
432460
- Implement a Chain Reader which retrieves blocks from the Cardano chain with Pallas through the `chainsync` mini-protocol.
@@ -448,6 +476,7 @@ As a minor extension, we have adopted a slightly different versioning convention
448476
## Mithril Distribution [2418.1] - 2024-05-13
449477

450478
- **BREAKING** changes in Mithril client CLI:
479+
451480
- Certificate chain structure has been modified to remove coupling with immutable file number.
452481
- Client needs to be updated to verify certificate chain.
453482

@@ -456,6 +485,7 @@ As a minor extension, we have adopted a slightly different versioning convention
456485
- Chain observers support the retrieval of the current Cardano chain point.
457486

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

481511
- _DEPRECATED_ the `snapshot` command in the Mithril client CLI:
512+
482513
- Renamed to `cardano-db snapshot`.
483514
- Will be **removed** in **2** distributions.
484515

0 commit comments

Comments
 (0)