Skip to content

Commit 379586f

Browse files
committed
prettier check
1 parent d22d638 commit 379586f

13 files changed

Lines changed: 37 additions & 4 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ 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+
5354
- This is the mode that all nodes were running prior to this release
5455
- This mode is still the **stable** mode
5556
- We intend to deprecate this mode in the near future

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,12 @@ 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+
5051
- [x] Create the era switch transaction (done at epoch `757`)
5152
- [x] Complete the era switch to `Pythagoras` at the transition to epoch `759`
5253

5354
- **release-preprod** network:
55+
5456
- [x] Create the era switch transaction (done at epoch `184`)
5557
- [x] Complete the era switch to `Pythagoras` at the transition to epoch `186`
5658

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,27 @@ 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+
3839
- Introduced the `--backend` parameter in the `cardano-db` command
3940
- The default backend is `v1`; the `v2` backend is still considered **unstable**
4041
- No breaking changes in the client CLI
4142
- The `v2` backend is accessible via the `cardano_database_v2` function in the client library.
4243

4344
- [x] **Distribution [2537](https://github.com/input-output-hk/mithril/releases/tag/2537.0)**:
45+
4446
- The `v2` backend is promoted to **stable** status but will remain optional
4547
- The `v1` backend is still the default.
4648

4749
- [x] **Distribution [2543](https://github.com/input-output-hk/mithril/releases/tag/2543.0)**:
50+
4851
- The `v2` backend is the default
4952

5053
- [x] **Distribution [2603](https://github.com/input-output-hk/mithril/releases/tag/2603.1)**:
54+
5155
- The `v1` backend is deprecated.
5256

5357
- [x] **Distribution [2617](https://github.com/input-output-hk/mithril/releases/tag/2617.0)**:
58+
5459
- The `v1` backend is decommissioned and removed from the client CLI and library.
5560

5661
- [ ] **Distribution +5**:

docs/website/blog/2025-09-17-pre-built-linux-arm-binaries.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ To provide a clear overview of supported platforms, the team has added a new 'Pl
1717

1818
| Binary | Linux x64 | Linux arm64 | macOS arm64 | Windows x64 |
1919
| ------------------ | :-------: | :---------: | :---------: | :---------: |
20-
| mithril-aggregator | | ✔ ⁽\* |||
21-
| mithril-signer | | ✔ ⁽\* |||
22-
| mithril-client | | ✔ ⁽\* | | |
20+
| mithril-aggregator || ✔ ⁽\*|||
21+
| mithril-signer || ✔ ⁽\*|||
22+
| mithril-client || ✔ ⁽\*|||
2323

2424
\*⁾⚠️ Linux arm64 builds are provided on a best-effort basis and are not officially supported.
2525

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Note that this guide works only on a Linux machine.
6060
- Operate a **Cardano full node**
6161

6262
- To access the file system of the **Cardano full node**, you will need the following permissions:
63+
6364
- Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
6465
- 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**)
6566

@@ -273,10 +274,12 @@ The configuration values for the `/opt/mithril/mithril-aggregator.env` file are
273274
- `CUSTOM_ORIGIN_TAG_WHITE_LIST`: Comma-separated list of custom origin tags to whitelist for client requests (default: `EXPLORER,BENCHMARK,CI,NA`).
274275

275276
- **Base configuration** **optional** values are:
277+
276278
- `BLOCKFROST_PARAMETERS`: Parameters to connect to the Blockfrost API. Used to fetch the ticker and name of the registered stake pools. Example: `{"project_id":"preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ"}`
277279
- `SIGNER_IMPORTER_RUN_INTERVAL`: Time interval at which the pools names and ticker in blockfrost will be imported (in minutes, default: `720`).
278280

279281
- The **Cardano database** configuration values are (only needed if supporting Cardano database certification):
282+
280283
- `DB_DIRECTORY`: Directory of the Cardano node database stores (same as the `--database-path` setting of the Cardano node)
281284
- `DATA_STORES_DIRECTORY`: Directory where the aggregator will store its databases (eg, `/opt/mithril/stores`)
282285
- `GOOGLE_APPLICATION_CREDENTIALS_JSON`: JSON content of the GCP service account credentials (required if using GCP for snapshot storage)
@@ -300,6 +303,7 @@ The configuration values for the `/opt/mithril/mithril-aggregator.env` file are
300303
Here is an **example** set of values for **release-preprod** that will be used in this guide in the **tip** boxes to illustrate some commands:
301304

302305
- **Base configuration**:
306+
303307
- **SIGNED_ENTITY_TYPES**: `MithrilStakeDistribution,CardanoStakeDistribution,CardanoTransactions` (only supporting stake distributions and transactions, excluding database snapshots)
304308
- **SERVER_PORT**: `8080`
305309
- **PUBLIC_SERVER_URL**: `https://aggregator.example.com/aggregator`
@@ -319,10 +323,12 @@ Here is an **example** set of values for **release-preprod** that will be used i
319323
- **CUSTOM_ORIGIN_TAG_WHITE_LIST**: `EXPLORER,BENCHMARK,CI,NA`
320324

321325
- **Optional configuration**:
326+
322327
- **BLOCKFROST_PARAMETERS**: `{"project_id":"preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ"}`
323328
- **SIGNER_IMPORTER_RUN_INTERVAL**: 720
324329

325330
- **Cardano database configuration**:
331+
326332
- **DB_DIRECTORY**: `/cardano/db`
327333
- **DATA_STORES_DIRECTORY**: `/opt/mithril/stores`
328334
- **GOOGLE_APPLICATION_CREDENTIALS_JSON**: `**YOUR_SECRET**`
@@ -1299,6 +1305,7 @@ If you want to make your follower aggregator publicly discoverable, you should:
12991305
1. **Ensure your aggregator is accessible via HTTPS** by setting up Traefik or another reverse proxy with a valid SSL certificate (as described in the [Set up the SSL certificate](#setup-the-ssl-certificate-traefik) section).
13001306
13011307
2. **Register your aggregator in the networks configuration**. You can do this by:
1308+
13021309
- Opening an issue in the [Mithril GitHub repository](https://github.com/input-output-hk/mithril/issues)
13031310
- Or by creating a pull request that modifies the [`networks.json`](https://github.com/input-output-hk/mithril/blob/main/networks.json) file and updates the `aggregators` field in the Cardano network you are targeting.
13041311

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

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

101101
- To operate a **Cardano node** as a **stake pool**, you need:
102+
102103
- The pool's `operational certificate`
103104
- The pool's `KES secret key`
104105

105106
- To access the file system of the **Cardano block-producing** node for **production** deployment (or of the **Cardano relay** node for **naive** deployment), you will need the following permissions:
107+
106108
- Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
107109
- 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**)
108110

@@ -546,6 +548,7 @@ sudo systemctl restart mithril-signer
546548
:::info
547549
548550
- If you have already installed `Squid` via the `apt` package manager, we recommend that you delete it before manually building it from source by running the following commands:
551+
549552
- `sudo systemctl stop squid`
550553
- `sudo apt remove squid`
551554
- `sudo apt autoremove`

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ 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+
106107
- Verifying signatures from each party:
107108
- Checking the party is authorized to sign for the given index (using the same procedure as signing)
108109
- Checking the proof is valid which means:

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ 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+
117118
- **Confidentiality**: Yes
118119
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.
119120

@@ -324,6 +325,7 @@ A DoS on the `mithril-aggregator`.
324325
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.
325326

326327
- **Assets at risk**:
328+
327329
- [Block production](#block-production)
328330
- [Cardano chain database](#cardano-chain-database).
329331

docs/website/src/css/custom.css

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ h3 {
160160

161161
.navbar__item:hover {
162162
color: var(--ifm-color-primary);
163-
164163
}
165164

166165
.navbar__items {

docs/website/versioned_docs/version-maintained/manual/operate/run-aggregator-node.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Note that this guide works only on a Linux machine.
6060
- Operate a **Cardano full node**
6161

6262
- To access the file system of the **Cardano full node**, you will need the following permissions:
63+
6364
- Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**)
6465
- 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**)
6566

@@ -273,10 +274,12 @@ The configuration values for the `/opt/mithril/mithril-aggregator.env` file are
273274
- `CUSTOM_ORIGIN_TAG_WHITE_LIST`: Comma-separated list of custom origin tags to whitelist for client requests (default: `EXPLORER,BENCHMARK,CI,NA`).
274275

275276
- **Base configuration** **optional** values are:
277+
276278
- `BLOCKFROST_PARAMETERS`: Parameters to connect to the Blockfrost API. Used to fetch the ticker and name of the registered stake pools. Example: `{"project_id":"preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ"}`
277279
- `SIGNER_IMPORTER_RUN_INTERVAL`: Time interval at which the pools names and ticker in blockfrost will be imported (in minutes, default: `720`).
278280

279281
- The **Cardano database** configuration values are (only needed if supporting Cardano database certification):
282+
280283
- `DB_DIRECTORY`: Directory of the Cardano node database stores (same as the `--database-path` setting of the Cardano node)
281284
- `DATA_STORES_DIRECTORY`: Directory where the aggregator will store its databases (eg, `/opt/mithril/stores`)
282285
- `GOOGLE_APPLICATION_CREDENTIALS_JSON`: JSON content of the GCP service account credentials (required if using GCP for snapshot storage)
@@ -300,6 +303,7 @@ The configuration values for the `/opt/mithril/mithril-aggregator.env` file are
300303
Here is an **example** set of values for **release-preprod** that will be used in this guide in the **tip** boxes to illustrate some commands:
301304

302305
- **Base configuration**:
306+
303307
- **SIGNED_ENTITY_TYPES**: `MithrilStakeDistribution,CardanoStakeDistribution,CardanoTransactions` (only supporting stake distributions and transactions, excluding database snapshots)
304308
- **SERVER_PORT**: `8080`
305309
- **PUBLIC_SERVER_URL**: `https://aggregator.example.com/aggregator`
@@ -319,10 +323,12 @@ Here is an **example** set of values for **release-preprod** that will be used i
319323
- **CUSTOM_ORIGIN_TAG_WHITE_LIST**: `EXPLORER,BENCHMARK,CI,NA`
320324

321325
- **Optional configuration**:
326+
322327
- **BLOCKFROST_PARAMETERS**: `{"project_id":"preprodWuV1ICdtOWfZYfdcxpZ0tsS1N9rVZomQ"}`
323328
- **SIGNER_IMPORTER_RUN_INTERVAL**: 720
324329

325330
- **Cardano database configuration**:
331+
326332
- **DB_DIRECTORY**: `/cardano/db`
327333
- **DATA_STORES_DIRECTORY**: `/opt/mithril/stores`
328334
- **GOOGLE_APPLICATION_CREDENTIALS_JSON**: `**YOUR_SECRET**`
@@ -1300,6 +1306,7 @@ If you want to make your follower aggregator publicly discoverable, you should:
13001306
1. **Ensure your aggregator is accessible via HTTPS** by setting up Traefik or another reverse proxy with a valid SSL certificate (as described in the [Set up the SSL certificate](#setup-the-ssl-certificate-traefik) section).
13011307
13021308
2. **Register your aggregator in the networks configuration**. You can do this by:
1309+
13031310
- Opening an issue in the [Mithril GitHub repository](https://github.com/input-output-hk/mithril/issues)
13041311
- Or by creating a pull request that modifies the [`networks.json`](https://github.com/input-output-hk/mithril/blob/main/networks.json) file and updates the `aggregators` field in the Cardano network you are targeting.
13051312

0 commit comments

Comments
 (0)