Skip to content

Commit ea995a0

Browse files
authored
Merge pull request #2601 from input-output-hk/djo/prettier_3.6
prettier 3.6 compatibility
2 parents 7827a52 + 3f7acd7 commit ea995a0

File tree

13 files changed

+4
-46
lines changed

13 files changed

+4
-46
lines changed

.prettierignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ mithril-test-lab/mithril-devnet/configuration/
1313
flake.lock
1414
**/dist/
1515
**/pkg/
16+
.jlv.jsonc
17+
18+
# CI
19+
rust-clippy-results.sarif

CHANGELOG.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,11 @@ As a minor extension, we have adopted a slightly different versioning convention
3232
- Support for recording client types origin (library, CLI and WASM) in the aggregator metrics.
3333

3434
- **UNSTABLE** :
35-
3635
- New UTxO-HD snapshot converter command for client CLI:
37-
3836
- Added the `tools utxo-hd snapshot-converter` command to the client CLI that converts a restored UTxO-HD snapshot to another flavor.
3937
- Support for converting to `LMDB` on-disk and `Legacy` in-memory flavors.
4038

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

6562
- **BREAKING** changes in Mithril client CLI and library:
66-
6763
- 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.
6864
- 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.
6965
- 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.
@@ -92,7 +88,6 @@ As a minor extension, we have adopted a slightly different versioning convention
9288
## Mithril Distribution [2513.0] - 2025-03-28
9389

9490
- **BREAKING** changes in Mithril nodes:
95-
9691
- Upgraded the minimum required `glibc` version from `2.31` to `2.35` for the pre-built Linux binaries
9792
- Mithril signer with versions `<=0.2.200` **must be updated** following the cleanup of `Thales` era legacy code
9893
- Mithril client library `with_snapshot_uploader` function has been renamed to `with_file_uploader`.
@@ -102,15 +97,13 @@ As a minor extension, we have adopted a slightly different versioning convention
10297
- End support for **macOS x64 pre-built binaries** for the client CLI.
10398

10499
- Cardano database full certification:
105-
106100
- Creation of two separate archives for the immutable files and for the ancillary files.
107101
- Added a signed manifest file to the ancillary archive (contains the list of all files in the archive and their sha256 hashes).
108102
- Added client validation of the signature of the manifest file and the integrity of the files in the archive after downloading an ancillary archive.
109103

110104
- **UNSTABLE** Implement a follower signer registration mode in the aggregator.
111105

112106
- **UNSTABLE** Cardano database incremental certification:
113-
114107
- Implement the client library for the signed entity type `CardanoDatabase` (download and prove snapshot).
115108
- Implement the client CLI commands for the signed entity type `CardanoDatabase` (snapshot list, snapshot show and download commands).
116109
- Implement an example crate for the signed entity type `CardanoDatabase`.
@@ -145,7 +138,6 @@ As a minor extension, we have adopted a slightly different versioning convention
145138
- Support certification of the protocol parameters and epoch in the certificate chain.
146139

147140
- **UNSTABLE** Cardano database incremental certification:
148-
149141
- Implement the artifact routes of the aggregator for the signed entity type `CardanoDatabase`.
150142
- Implement the immutable file digests route in the aggregator.
151143
- Implement the artifact ancillary builder in the aggregator.
@@ -169,7 +161,6 @@ As a minor extension, we have adopted a slightly different versioning convention
169161
## Mithril Distribution [2450.0] - 2024-12-17
170162

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

190181
- **UNSTABLE** Cardano database incremental certification:
191-
192182
- Implement the new signed entity type `CardanoDatabase`.
193183
- Implement the signable builder for the signed entity type `CardanoDatabase`.
194184

@@ -207,7 +197,6 @@ As a minor extension, we have adopted a slightly different versioning convention
207197
## Mithril Distribution [2445.0] - 2024-11-07
208198

209199
- **BREAKING** changes in Mithril client library, CLI, and WASM:
210-
211200
- Remove deprecated `beacon` field from Mithril certificates.
212201
- Clients from distribution [`2430`](#mithril-distribution-24300---2024-07-30) and above are compatible with this change.
213202

@@ -236,7 +225,6 @@ As a minor extension, we have adopted a slightly different versioning convention
236225
## Mithril Distribution [2442.0] - 2024-10-21
237226

238227
- Decentralization of the signature orchestration:
239-
240228
- Optimizations of the state machine used by the signer to create individual signatures.
241229

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

274262
- **BREAKING** changes in Mithril client WASM:
275-
276263
- Implementation of seamless transition from **unstable** to **stable** features.
277264
- A new `unstable` option in the client allows the usage of unstable features.
278265
- The previous `client.unstable` implementation is not supported anymore and must be replaced with `client`.
@@ -288,13 +275,11 @@ As a minor extension, we have adopted a slightly different versioning convention
288275
- Post `Chang` hard fork cleanup of the CI, devnet and infrastructure.
289276

290277
- Cardano transactions certification (stable for signer and aggregator):
291-
292278
- Support for Mithril signer memory optimization when signing Cardano transactions with multiple Merkle tree storage backends.
293279
- Support infinite preloading of Cardano transactions in signer.
294280
- Fix Cardano transactions rollbacks creating panics in signer and aggregator.
295281

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

327312
- **UNSTABLE** Cardano transactions certification:
328-
329313
- Make Cardano transaction signing settings configurable via the CD.
330314

331315
- Crates versions:
@@ -361,7 +345,6 @@ As a minor extension, we have adopted a slightly different versioning convention
361345
- Field `beacon` becomes optional in `CertificatePendingMessage` response of `/certificate-pending` route.
362346

363347
- **UNSTABLE** Cardano transactions certification:
364-
365348
- Optimize the performances of the computation of the proof with a Merkle map.
366349
- Handle rollback events from the Cardano chain by removing stale data.
367350
- Preload Cardano transactions and Block Range Roots at signer & aggregator startup.
@@ -385,14 +368,12 @@ As a minor extension, we have adopted a slightly different versioning convention
385368
## Mithril Distribution [2423.0] - 2024-06-12
386369

387370
- **BREAKING** changes in Mithril client CLI:
388-
389371
- The deprecated `snapshot` command is removed from the Mithril client CLI
390372
- Use the `cardano-db snapshot` command instead.
391373

392374
- Update website and explorer user interface to use the new mithril logo.
393375

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

416397
- **BREAKING** changes in Mithril client CLI:
417-
418398
- Certificate chain structure has been modified to remove coupling with immutable file number.
419399
- Client needs to be updated to verify certificate chain.
420400

@@ -423,7 +403,6 @@ As a minor extension, we have adopted a slightly different versioning convention
423403
- Chain observers support the retrieval of the current Cardano chain point.
424404

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

449428
- _DEPRECATED_ the `snapshot` command in the Mithril client CLI:
450-
451429
- Renamed to `cardano-db snapshot`.
452430
- Will be **removed** in **2** distributions.
453431

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ This repository consists of the following parts:
8080
- [**Mithril signer**](./mithril-signer): the node of the **Mithril network** responsible for producing individual signatures that are collected and aggregated by the **Mithril aggregator**.
8181

8282
- [**Internal**](./internal): the shared tools and API used by **Mithril** crates.
83-
8483
- [**Mithril build script**](./internal/mithril-build-script): a toolbox for Mithril crates that uses a build script phase.
8584

8685
- [**Mithril cardano-node-chain**](./internal/cardano-node/mithril-cardano-node-chain): mechanisms to read and interact with the **Cardano chain** through a Cardano node, used by **Mithril network** nodes.
@@ -108,13 +107,11 @@ This repository consists of the following parts:
108107
- [**Mithril signed entity prealoader**](./internal/signed-entity/mithril-signed-entity-preloader): a **preload** mechanism for the Cardano transaction signed entity, used by **Mithril network** nodes.
109108

110109
- [**tests**](./internal/tests): shared testing tools used by **Mithril** crates.
111-
112110
- [**Mithril api spec**](./internal/tests/mithril-api-spec): toolset to verify conformity of http routes against an Open Api specification, used by **Mithril network** nodes.
113111

114112
- [**Mithril test http server**](internal/tests/mithril-test-http-server): provides a test http server, used by **Mithril network** nodes.
115113

116114
- [**Mithril test lab**](./mithril-test-lab): the suite of tools that allow us to test and stress the **Mithril** protocol implementations.
117-
118115
- [**Mithril devnet**](./mithril-test-lab/mithril-devnet): the private **Mithril/Cardano network** used to scaffold a **Mithril network** on top of a **Cardano network**.
119116

120117
- [**Mithril end to end**](./mithril-test-lab/mithril-end-to-end): the tool used to run test scenarios against a **Mithril devnet**.

SECURITY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ Please include as much details as needed to clearly qualify the issue:
5353
a. **Mitigation**: Depending on the severity and criticity of the issue, the team can decide to disclose the issue publicly in the absence of a fix _if and only if_ a clear, simple, and effective mitigation plan is defined. This _must_ include instructions for users and operators of the software, and a time horizon at which the issue will be properly fixed (eg. version number).
5454

5555
b. **Fix**: When a fix is available and approved, it should be merged and made available as quickly as possible:
56-
5756
- All commits to the private repository are squashed into a single commit whose description _should not_ make any reference it relates to a security vulnerability
5857
- A new Pull Request is created with this single commit
5958
- This PR's review and merging is expedited as all the work as already been done

docs/website/blog/2022-10-11-keys-certification-badge/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,11 @@ sqlite3 ${DATA_STORES_DIRECTORY}/signer.sqlite3 "UPDATE protocol_initializer SET
5050
From now, SPOs can either run their node by:
5151

5252
- **Declaring their Cardano `PoolId`**:
53-
5453
- This is the mode that all nodes were running prior to this release
5554
- This mode is still the **stable** mode
5655
- We intend to deprecate this mode in the near future
5756

5857
- **Certifying their Cardano `PoolId`**:
59-
6058
- The certification is done by providing the Mithril Signer node with `KES Secret Key Path` and `Operational Certificate Path`
6159
- This is an **experimental** mode
6260
- We intend to make this mode the only way of providing a `PoolId` in the near future

docs/website/blog/2024-12-17-era-switch-pythagoras.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,10 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/input-out
4747
#### Era switch plan for `Pythagoras`
4848

4949
- **pre-release-preview** network:
50-
5150
- [x] Create the era switch transaction (done at epoch `757`)
5251
- [x] Complete the era switch to `Pythagoras` at the transition to epoch `759`
5352

5453
- **release-preprod** network:
55-
5654
- [x] Create the era switch transaction (done at epoch `184`)
5755
- [x] Complete the era switch to `Pythagoras` at the transition to epoch `186`
5856

docs/website/blog/2025-06-17-client-cli-cardano-database-backends.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,24 +35,20 @@ In particular, the `cardano-db` command in the Mithril client CLI has been updat
3535
To support this transition, both certification versions will remain available during the migration period, allowing users to adapt at their own pace.
3636

3737
- [x] **Distribution [2524](https://github.com/input-output-hk/mithril/releases/tag/2524.0)**:
38-
3938
- Introduced the `--backend` parameter in the `cardano-db` command
4039
- The default backend is `v1`; the `v2` backend is still considered **unstable**
4140
- No breaking changes in the client CLI
4241
- The `v2` backend is accessible via the `cardano_database_v2` function in the client library.
4342

4443
- [ ] **Distribution +1**:
45-
4644
- The `v2` backend will be promoted to **stable** status but will remain optional
4745
- The `v1` backend will continue to be the default.
4846

4947
- [ ] **Distribution +2**:
50-
5148
- The `v2` backend will become the default
5249
- The `v1` backend will be deprecated.
5350

5451
- [ ] **Distribution +3**:
55-
5652
- The `v1` backend will be decommissioned and removed from the client CLI and library.
5753

5854
- [ ] **Distribution +4**:

docs/website/root/manual/operate/run-signer-node.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,12 +99,10 @@ Note that this guide works on a Linux machine only.
9999
:::
100100

101101
- To operate a **Cardano node** as a **stake pool**, you need:
102-
103102
- The pool's `operational certificate`
104103
- The pool's `KES secret key`
105104

106105
- To access the file system of the **Cardano block producer** node for **production** deployment (or of the **Cardano relay** node for **naive** deployment), you will need the following permissions:
107-
108106
- Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
109107
- Read and write rights on the `Inter Process Communication` file (typically defined by the `CARDANO_NODE_SOCKET_PATH` environment variable used to launch the **Cardano node**)
110108

@@ -548,7 +546,6 @@ sudo systemctl restart mithril-signer
548546
:::info
549547
550548
- If you have already installed `Squid` via `apt` package manager, we recommend that you delete it before manually building it from source by running the following commands:
551-
552549
- `sudo systemctl stop squid`
553550
- `sudo apt remove squid`
554551
- `sudo apt autoremove`.

docs/website/root/mithril/advanced/mithril-protocol/protocol.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ a quorum of `k` valid signatures must be submitted.
103103
- For every valid signature, the party creates a proof (`π`) containing a signature of the message, verification key, stake, and paths of the party in the Merkle tree.
104104

105105
- Then, multiple signatures can be aggregated together to form a certificate (`τ`) by:
106-
107106
- Verifying signatures from each party:
108107
- Checking the party is authorized to sign for the given index (using the same procedure as signing)
109108
- Checking the proof is valid which means:

docs/website/root/mithril/advanced/threat-model.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,6 @@ For each asset, we first identify which part of the **CIA triad** (Confidentiali
114114
- The KES key is present only on the block-producing (BP) node but needs to be shared with both the `cardano-node` process and the `mithril-signer` process.
115115
- KES keys are needed by `mithril-signer` to sign a verification key along with an operational certificate that authenticates the key for this stake pool ID.
116116
- This signing happens at every epoch.
117-
118117
- **Confidentiality**: Yes
119118
Capturing KES private keys allows an attacker to impersonate a registered SPO on-chain and produce blocks on its behalf until the keys are rotated.
120119

@@ -325,7 +324,6 @@ A DoS on the `mithril-aggregator`.
325324
Data integrity of the Cardano block producer’s on-disk database could be compromised either by the action of the Mithril signer or by an attacker with access to the signer.
326325

327326
- **Assets at risk**:
328-
329327
- [Block production](#block-production)
330328
- [Cardano chain database](#cardano-chain-database).
331329

0 commit comments

Comments
 (0)