Skip to content

Commit d5d8638

Browse files
jpraynaudjpraynaud
committed
Enhance Mithril networks documentation
Provide a shared document for Mithril networks and call it from the pages where it is needed.
1 parent dc29fd2 commit d5d8638

File tree

7 files changed

+55
-65
lines changed

7 files changed

+55
-65
lines changed

‎docs/root/manual/developer-docs/nodes/mithril-aggregator.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 1
33
---
44

5+
import NetworksMatrix from '../../../../shared/networks-matrix.md';
6+
57
# Mithril Aggregator Node
68

79
:::info
@@ -18,15 +20,9 @@ This is the node of the **Mithril Network** responsible for collecting individua
1820

1921
:::
2022

21-
:::tip
22-
23-
The [Mithril test networks](../../../manual/developer-docs/references.md#mithril-networks) are:
24-
25-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
26-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
27-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
23+
:::note Mithril Networks
2824

29-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
25+
<NetworksMatrix />
3026

3127
:::
3228

@@ -157,7 +153,7 @@ Run 'serve' command in release with a specific mode
157153
Run 'serve' command in release with a custom configuration via env vars
158154

159155
```bash
160-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_TEST_NETWORK** ./mithril-aggregator serve
156+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator serve
161157
```
162158

163159
## Release build and run binary 'genesis' command
@@ -224,7 +220,7 @@ This allows the Mithril Aggregator node to import the signed payload of the `Gen
224220
Run 'genesis import' command in release with a custom configuration via env vars
225221

226222
```bash
227-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_TEST_NETWORK** ./mithril-aggregator genesis import --signed-payload-path **YOUR_SIGNED_PAYLOAD_PATH**
223+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator genesis import --signed-payload-path **YOUR_SIGNED_PAYLOAD_PATH**
228224
```
229225

230226
:::tip

‎docs/root/manual/developer-docs/nodes/mithril-client.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 3
33
---
44

5+
import NetworksMatrix from '../../../../shared/networks-matrix.md';
6+
57
# Mithril Client Node
68

79
:::info
@@ -20,18 +22,13 @@ This is the node of the **Mithril Network** responsible for restoring the **Card
2022

2123
:::
2224

23-
:::tip
24-
25-
The [Mithril test networks](../../../manual/developer-docs/references.md#mithril-networks) are:
25+
:::note Mithril Networks
2626

27-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
28-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
29-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
30-
31-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
27+
<NetworksMatrix />
3228

3329
:::
3430

31+
3532
## Resources
3633

3734
| Node | Source Repository | Rust Documentation | Docker Packages |
@@ -159,7 +156,7 @@ Run in release with a specific mode
159156
Run in release with a custom configuration via env vars
160157

161158
```bash
162-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) NETWORK=**YOUR_TEST_NETWORK** AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator ./mithril-client
159+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
163160
```
164161

165162
:::tip
@@ -223,6 +220,6 @@ Here is a list of the available parameters:
223220
| `verbose` | `--verbose` | `-v` | `VERBOSE` | Verbosity level | - | Parsed from number of occurrences: `-v` for `Warning`, `-vv` for `Info`, `-vvv` for `Debug` and `-vvvv` for `Trace` | :heavy_check_mark: |
224221
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Runtime mode | `dev` | - | :heavy_check_mark: |
225222
| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: |
226-
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.api.mithril.network/aggregator` | :heavy_check_mark: |
223+
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
227224
| `genesis_verification_key` | - | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key | - | - | :heavy_check_mark: |
228225
| `json_output` | `--json` | `-j` | - | Enable JSON output | no | - | - |

‎docs/root/manual/developer-docs/nodes/mithril-signer.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 2
33
---
44

5+
import NetworksMatrix from '../../../../shared/networks-matrix.md';
6+
57
# Mithril Signer Node
68

79
:::info
@@ -20,15 +22,9 @@ This is the node of the **Mithril Network** responsible for producing individual
2022

2123
:::
2224

23-
:::tip
24-
25-
The [Mithril test networks](../../../manual/developer-docs/references.md#mithril-networks) are:
26-
27-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
28-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
29-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
25+
:::note Mithril Networks
3026

31-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
27+
<NetworksMatrix />
3228

3329
:::
3430

@@ -142,7 +138,7 @@ Run in release with a specific mode
142138
Run in release with a custom configuration via env vars
143139

144140
```bash
145-
NETWORK=**YOUR_TEST_NETWORK** AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator ./mithril-signer
141+
NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-signer
146142
```
147143

148144
:::tip
@@ -188,7 +184,7 @@ Here is a list of the available parameters:
188184
`network_magic` | - | - | `NETWORK_MAGIC` | Cardano Network Magic number (for `testnet` and `devnet`) | - | `1097911063` or `42` | - |
189185
| `party_id` | - | - | `PARTY_ID` | Party Id of the signer, usually the `Pool Id` of the SPO | - | `pool1pxaqe80sqpde7902er5kf6v0c7y0sv6d5g676766v2h829fvs3x` | - | Mandatory in `Pool Id Declaration Mode` where the owner is not verified (soon to be deprecated)
190186
| `run_interval` | - | - | `RUN_INTERVAL` | Interval between two runtime cycles in ms | - | `60000` | :heavy_check_mark: |
191-
| `aggregator_endpoint` | - | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.api.mithril.network/aggregator` | :heavy_check_mark: |
187+
| `aggregator_endpoint` | - | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
192188
| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store signer data (Stakes, Protocol initializers, ...) | - | `./mithril-signer/stores` | :heavy_check_mark: |
193189
| `store_retention_limit` | - | - | `STORE_RETENTION_LIMIT` | Maximum number of records in stores. If not set, no limit is set. | - | - | - |
194190
| `kes_secret_key_path` | - | - | `KES_SECRET_KEY_PATH` | Path to the `Cardano KES Secret Key` file. Mandatory in `Pool Id Certification Mode` where the owner is verified (experimental, soon to be stable & preferred mode) | - | - | - |

‎docs/root/manual/developer-docs/references.md‎

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 2
33
---
44

5+
import NetworksMatrix from '../../../shared/networks-matrix.md';
6+
57
# API Reference
68

79
Welcome to the Mithril API references doc!
@@ -20,17 +22,7 @@ For more information about the **Mithril Protocol**, please refer to the [About
2022

2123
## Mithril Networks
2224

23-
Here is an up to date list of all the Mithril Networks and their status
24-
> Last update: 11/02/2022
25-
26-
| Mithril Network | Cardano Network | Magic Id | Supported | Aggregator Endpoint | Genesis Verification Key | Note
27-
|------------|------------|:-----------:|:------------:|:-----------------:|:------------------:|:------------|
28-
| `release-mainnet` | `mainnet` | - | :x: | - | - | Not supported yet
29-
| `release-preprod` | `preprod` | `1` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.release-preprod.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Works on re-spun `preprod` network
30-
| `pre-release-preview` | `preview` | `2` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.pre-release-preview.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Works on re-spun `preview` network
31-
| `testing-preview` | `preview` | `2` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.testing-preview.api.mithril.network/aggregator) | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) | Works on re-spun `preview` network
32-
| `dev-devnet` | `devnet` | `42` | :heavy_check_mark: | [:arrow_upper_right:](http://localhost:8080/aggregator) | - | Supported on the `devnet` only
33-
| `-` | `testnet` | `1097911063` | :x: | - | - | Decommissioned, not supported anymore
25+
<NetworksMatrix />
3426

3527
## Dependencies List
3628

‎docs/root/manual/getting-started/bootstrap-cardano-node.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 1
33
---
44

5+
import NetworksMatrix from '../../../shared/networks-matrix.md';
6+
57
# Bootstrap a Cardano Node
68

79
:::info
@@ -10,15 +12,9 @@ Thanks to a **Mithril Client** connected to a **Mithril Aggregator**, you will r
1012

1113
:::
1214

13-
:::tip
14-
15-
The [Mithril test networks](../../manual/developer-docs/references.md#mithril-networks) are:
16-
17-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
18-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
19-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
15+
:::note Mithril Networks
2016

21-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
17+
<NetworksMatrix />
2218

2319
:::
2420

@@ -120,13 +116,13 @@ If you want to dig deeper, you can get access to several level of logs from the
120116

121117
```bash
122118
# Cardano network
123-
NETWORK=**YOUR_TEST_NETWORK**
119+
NETWORK=**YOUR_CARDANO_NETWORK**
124120

125121
# Aggregator API endpoint URL
126-
AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator
122+
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
127123

128124
# Genesis verification key
129-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey)
125+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**)
130126

131127
# Digest of the latest produced snapshot for convenience of the demo
132128
# You can also modify this variable and set it to the value of the digest of a snapshot that you can retrieve at step 2
@@ -225,7 +221,7 @@ docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind
225221
Launch an empty Cardano node and make it live in minutes!
226222

227223
```bash
228-
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="$(pwd)/data/testnet/$SNAPSHOT_DIGEST/db",target=/data/db/ -e NETWORK=**YOUR_TEST_NETWORK** inputoutput/cardano-node
224+
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="$(pwd)/data/testnet/$SNAPSHOT_DIGEST/db",target=/data/db/ -e NETWORK=**YOUR_CARDANO_NETWORK** inputoutput/cardano-node
229225
```
230226

231227
You will see the node start by validating the files injested from the snapshot archive

‎docs/root/manual/getting-started/run-signer-node.md‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 2
33
---
44

5+
import NetworksMatrix from '../../../shared/networks-matrix.md';
6+
57
# Run a Mithril Signer node (SPO)
68

79
:::info
@@ -10,15 +12,9 @@ In this guide, you will learn how to setup a **Mithril Signer** on top of a **Ca
1012

1113
:::
1214

13-
:::tip
14-
15-
The [Mithril test networks](../../manual/developer-docs/references.md#mithril-networks) are:
16-
17-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
18-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
19-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
15+
:::note Mithril Networks
2016

21-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
17+
<NetworksMatrix />
2218

2319
:::
2420

@@ -194,8 +190,8 @@ First create an env file that will be used by the service:
194190
```bash
195191
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
196192
PARTY_ID=**YOUR_POOL_ID_BECH32**
197-
NETWORK=**YOUR_TEST_NETWORK**
198-
AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator
193+
NETWORK=**YOUR_CARDANO_NETWORK**
194+
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
199195
RUN_INTERVAL=60000
200196
DB_DIRECTORY=/cardano/db
201197
CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket
@@ -211,8 +207,8 @@ EOF'
211207
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
212208
KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH**
213209
OPERATIONAL_CERTIFICATE_PATH=**YOUR_OPERATIONAL_CERTIFICATE_PATH**
214-
NETWORK=**YOUR_TEST_NETWORK**
215-
AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator
210+
NETWORK=**YOUR_CARDANO_NETWORK**
211+
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
216212
RUN_INTERVAL=60000
217213
DB_DIRECTORY=/cardano/db
218214
CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket

‎docs/shared/networks-matrix.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Here is an up to date list of all the **Mithril Networks**, their configurations and their status:
2+
3+
> Last update: 11/14/2022
4+
5+
| Mithril Network | Cardano Network | Magic Id | Supported | Aggregator Endpoint | Genesis Verification Key | Note
6+
|------------|------------|:-----------:|:------------:|:-----------------:|:------------------:|:------------|
7+
| `release-mainnet` | `mainnet` | - | :x: | - | - | Not supported yet
8+
| `release-preprod` | `preprod` | `1` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.release-preprod.api.mithril.network/aggregator "https://aggregator.release-preprod.api.mithril.network/aggregator") | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey "https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey") | Stable Release
9+
| `pre-release-preview` | `preview` | `2` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.pre-release-preview.api.mithril.network/aggregator "https://aggregator.pre-release-preview.api.mithril.network/aggregator") | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey "https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey") | Unstable Pre-Release
10+
| `testing-preview` | `preview` | `2` | :heavy_check_mark: | [:arrow_upper_right:](https://aggregator.testing-preview.api.mithril.network/aggregator "https://aggregator.testing-preview.api.mithril.network/aggregator") | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey "https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey") | Unstable Testing (devs only)
11+
| `dev-devnet` | `devnet` | `42` | :heavy_check_mark: | [:arrow_upper_right:](http://localhost:8080/aggregator "http://localhost:8080/aggregator") | - | Supported on the `devnet` only
12+
| `-` | `testnet` | `1097911063` | :x: | [:arrow_upper_right:](https://aggregator.api.mithril.network/aggregator "https://aggregator.api.mithril.network/aggregator") | [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey "https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey") | Decommissioned, not supported anymore
13+
14+
:warning: In this documentation, we use the generic:
15+
* ****YOUR_CARDANO_NETWORK**** identifier, but you need to replace it with the name of the network that runs on your Cardano node (e.g. `preprod`)
16+
* ****YOUR_AGGREGATOR_ENDPOINT**** identifier, but you need to replace it with the endpoint of an aggregator that runs on the Cardano network you target (e.g. `https://aggregator.release-preprod.api.mithril.network/aggregator`)
17+
* ****YOUR_GENESIS_VERIFICATION_KEY**** identifier, but you need to replace it with the genesis verification key url that runs on the Cardano network you target (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey`)

0 commit comments

Comments
 (0)