diff --git a/docs/root/manual/getting-started/images/signer-deployment-naive.jpg b/docs/root/manual/getting-started/images/signer-deployment-naive.jpg index 53236ad1c73..e2a96328c32 100644 Binary files a/docs/root/manual/getting-started/images/signer-deployment-naive.jpg and b/docs/root/manual/getting-started/images/signer-deployment-naive.jpg differ diff --git a/docs/root/manual/getting-started/images/signer-deployment-production.jpg b/docs/root/manual/getting-started/images/signer-deployment-production.jpg index 6b9056bed81..aa919de6ac7 100644 Binary files a/docs/root/manual/getting-started/images/signer-deployment-production.jpg and b/docs/root/manual/getting-started/images/signer-deployment-production.jpg differ diff --git a/docs/root/manual/getting-started/run-signer-node.md b/docs/root/manual/getting-started/run-signer-node.md index 2118a2ed532..3c8b80f7d44 100644 --- a/docs/root/manual/getting-started/run-signer-node.md +++ b/docs/root/manual/getting-started/run-signer-node.md @@ -5,9 +5,9 @@ sidebar_position: 3 import NetworksMatrix from '../../networks-matrix.md'; import CompiledBinaries from '../../compiled-binaries.md' -# Run a Mithril Signer node (SPO) +# Run a Mithril Signer as an SPO -:::note Mithril Networks +:::note Mithril networks @@ -15,161 +15,157 @@ import CompiledBinaries from '../../compiled-binaries.md' :::tip -For more information about the **Mithril Protocol**, please refer to the [About Mithril](../../mithril/intro.md) section. +For more information about the **Mithril protocol**, see the section [About Mithril](../../mithril/intro.md). ::: -## Mithril Signer Deployment model +## Mithril Signer deployment model :::info -In this guide, you will learn how to setup a **Mithril Signer** on a **Cardano SPO Infrastructure** for the `mainnet` and the `testnet`: -- On the `mainnet`, you **must** run the **production** deployment where the **Mithril Signer** runs one the **Cardano Block Producer** machine and the **Mithril Relay** runs on the **Cardano Relay** machine. You can also run the **production** deployment on the `testnet`. -- On the `testnet` __only__, it is also acceptable (and easier) to run the **naive** deployment where the **Mithril Signer** runs on the **Cardano Relay** machine (in that case you don't need to setup a **Mithril Relay**). +In this guide, you will learn how to set up a **Mithril Signer** within the stake pool operator (SPO) infrastructure both on Cardano `mainnet` and `testnet` environments: +- On `mainnet`, you **must** run the **production** deployment where the **Mithril Signer** runs on the **Cardano block producer** machine and the **Mithril relay** runs on the **Cardano relay** machine. **Note** that you can run the **production** deployment on `testnet`. +- You can also run **naive** deployment, where the **Mithril Signer** runs on the **Cardano relay** machine. This is possible in the testnet environment only, and does not require setting up a **Mithril relay**. ::: :::caution -The **production** deployment model is still in beta version. +The **production** deployment model is currently in the beta version. ::: -Here is the schema of the **production** deployment for the `mainnet`: +Here is the schema of the **production** deployment on mainnet: [![Production Mithril Signer Deployment Model](images/signer-deployment-production.jpg)](images/signer-deployment-production.jpg) -and the schema of the **naive** deployment only for the `testnet`: +and the schema of the **naive** deployment specifically for `testnets`: [![Naive Mithril Signer Deployment Model](images/signer-deployment-naive.jpg)](images/signer-deployment-naive.jpg) -**Note**: You can also deploy the production deployment model on the `testnet`. - :::danger -On the `mainnet`, you must **never** copy the `KES Secret Key` out of the **Cardano Block Producer** machine! +On `mainnet`, you must **never** copy the `KES secret key` from the **Cardano block producer** machine! ::: -## Mithril Keys Certification +## Mithril keys certification -The **Mithril Signer** is using your Cardano `Operational Certificate` and `KES Secret Key` files which allow to: +The **Mithril Signer** uses your Cardano `operational certificate` and `KES secret key` files which enable: -* Compute automatically the `PoolId` -* Verify that you are the owner of the `PoolId`, and thus of the associated stakes used by Mithril protocol -* Verify that you are the owner of the Mithril `Signer Secret Key`, and thus allowed to contribute to the multi-signatures and certificate production of the Mithril network +* Automatic computation of the `PoolId` +* Verification of your `PoolId` ownership and the associated stake used by the Mithril protocol +* Verification of your Mithril `Signer secret key` ownership, which allows you to participate in the multi-signature process for certificate production on the Mithril network ## Pre-requisites -### What you'll need - :::info -This guide is working only on a Linux machine. +Note that this guide works on a Linux machine only. ::: -* Operating a **Cardano Node** as a **Stake Pool**: - * The Cardano `Operational Certificate` file of the pool - * The Cardano `KES Secret Key` file of the pool +* To operate a **Cardano node** as a **stake pool**, you need: + * The pool's `operational certificate` + * The pool's `KES secret key` -* Access to the file system of the **Cardano Block Producer** node for the **production** deployment (or of the **Cardano Relay** node for the **naive** deployment): - * Read rights on the `Database` folder (`--database-path` setting of the **Cardano Node**) - * Read/Write rights on the `Inter Process Communication` file (usually `CARDANO_NODE_SOCKET_PATH` env var used to launch the **Cardano Node**) +* 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: + * Read rights on the `Database` folder (specified by the `--database-path` setting of the **Cardano node**) + * 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**) -* Install a recent version of the [`cardano-cli`](https://github.com/input-output-hk/cardano-node/releases/tag/8.1.1) (version 8.1.1+) +* Install a recent version of [`cardano-cli`](https://github.com/input-output-hk/cardano-node/releases/tag/8.1.1) (version 8.1.1+). -* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version) +* Install a correctly configured Rust toolchain (latest stable version). You can follow the instructions provided [here](https://www.rust-lang.org/learn/get-started). -* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev` +* Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`. -* Install a recent version of `jq` (version `1.6+`) `apt install jq` +* Install a recent version of `jq` (version 1.6+). You can install it by running `apt install jq`. -* Only for the **production** deployment, install a recent version of [`squid-cache`](http://www.squid-cache.org/) (version `5.2+`) `apt install squid` +* Only for the **production** deployment, install a recent version of [`squid-cache`](http://www.squid-cache.org/) (version 5.2+). You can install it by running `apt install squid`. -## Setup the Mithril Signer node +## Set up the Mithril Signer node :::caution -- For the **production** deployment: the setup of the **Mithril Signer** is done on the **Cardano Block Producer** machine. +- For **production** deployment, the **Mithril Signer** setup is performed on the **Cardano block producer** machine. -- For the **naive** deployment: the setup of the **Mithril Signer** is done on the **Cardano Relay** machine. +- For **naive** deployment, the **Mithril Signer** setup is performed on the **Cardano relay** machine. ::: ### Building your own executable -#### Download source +#### Download the source file -Download from GitHub (HTTPS) +To download the source from GitHub (HTTPS), run: ```bash git clone https://github.com/input-output-hk/mithril.git ``` -Or (SSH) +Or (SSH): ```bash git clone git@github.com:input-output-hk/mithril.git ``` -#### Build Mithril Signer binary +#### Build the Mithril Signer binary -Switch to build branch / tag +First, switch to build a branch/tag: ```bash # **YOUR_BUILD_BRANCH_OR_TAG** depends on the Mithril network you target, -# please refer to the **Build From** column of the above **Mithril Networks** table +# please refer to the **Build from** column of the above **Mithril networks** table git switch **YOUR_BUILD_BRANCH_OR_TAG** ``` -Change directory +Then, change the directory: ```bash cd mithril/mithril-signer ``` -Run tests (Optional) +Run tests (optional): ```bash make test ``` -Build executable +Finally, build the executable: ```bash make build ``` -### Download pre-built binary +### Download the pre-built binary -### Verify binary +### Verifying the binary -#### Verify version +#### Verify the version of the binary -Check that the Mithril Signer binary is running the correct version by running +You can check that the Mithril Signer binary is running the correct version by running: ```bash ./mithril-signer -V ``` -You should see something like +You should see something like: ```bash mithril-signer 0.2.0 ``` -:warning: Verify that the version displayed is the version described in the content of the Release / Pre-Release note (see the **Build From** column of the above **Mithril Networks** table) +:warning: Please verify that the displayed version matches the version described in the release/pre-release notes (refer to the **Build from** column in the **Mithril networks** table above). -#### Verify build +#### Verify the build -Check that the Mithril Signer binary is working fine by running its help +Check that the Mithril Signer binary is working correctly by running the help function: ```bash ./mithril-signer -h ``` -You should see +You should see: ```bash An implementation of a Mithril Signer @@ -195,7 +191,7 @@ Options: :::tip -If you want to dig deeper, you can get access to several level of logs from the Mithril Signer: +If you wish to delve deeper, you can access logs at various levels from the Mithril Signer: * Add `-v` for some logs (WARN) * Add `-vv` for more logs (INFO) @@ -204,40 +200,40 @@ If you want to dig deeper, you can get access to several level of logs from the ::: -### Install the service +### Installing the service -#### Move executable +#### Move the executable -Move executable to /opt/mithril +To move the executable to /opt/mithril, run: ```bash sudo mkdir -p /opt/mithril sudo mv mithril-signer /opt/mithril ``` -#### Setup the service +#### Set up the service :::caution * `User=cardano`: -Replace this value with the correct user. We assume that the user used to run the **Cardano Node** is `cardano`. The **Mithril Signer** must imperatively run with the same user. +Replace this value with the correct user. We assume that the user used to run the **Cardano node** is `cardano`. The **Mithril Signer** must imperatively run with the same user. * In the `/opt/mithril/mithril-signer/service.env` env file: - * `KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES Secret Key` file - * `OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/opcert.cert`: replace `/cardano/cert/opcert.cert` with the path to your Cardano `Operational Certificate` file - * `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`) + * `KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES secret key` file + * `OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/opcert.cert`: replace `/cardano/cert/opcert.cert` with the path to your Cardano `operational certificate` file + * `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano node** (the one in `--database-path`) * `CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket`: replace with the path to the IPC file (`CARDANO_NODE_SOCKET_PATH` env var) * `CARDANO_CLI_PATH=/app/bin/cardano-cli`: replace with the path to the `cardano-cli` executable * `DATA_STORES_DIRECTORY=/opt/mithril/stores`: replace with the path to a folder where the **Mithril Signer** will store its data (`/opt/mithril/stores` e.g.) * `STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit). * `ERA_READER_ADAPTER_TYPE=cardano-chain`: replace `cardano-chain` with the era reader adapter type used in your Mithril network - * `ERA_READER_ADAPTER_PARAMS={"address": "...", "verification_key": "..."}`: replace `{"address": "...", "verification_key": "..."}` with the era reader params that you need to compute by running the command `jq -nc --arg address $(wget -q -O - **YOUR_ERA_READER_ADDRESS**) --arg verification_key $(wget -q -O - **YOUR_ERA_READER_VERIFICATION_KEY**) '{"address": $address, "verification_key": $verification_key}'` - * `RELAY_ENDPOINT=http://192.168.1.50:3128` **(optional)**: this is the endpoint of the **Mithril Relay**, which is required for the **production** deployment only. For the **naive** deployment, do not set this variable in your env file. + * `ERA_READER_ADAPTER_PARAMS={"address": "...", "verification_key": "..."}`: replace `{"address": "...", "verification_key": "..."}` with the era reader parameters that you need to compute by running the command `jq -nc --arg address $(wget -q -O - **YOUR_ERA_READER_ADDRESS**) --arg verification_key $(wget -q -O - **YOUR_ERA_READER_VERIFICATION_KEY**) '{"address": $address, "verification_key": $verification_key}'` + * `RELAY_ENDPOINT=http://192.168.1.50:3128` **(optional)**: this is the endpoint of the **Mithril relay**, which is required for **production** deployment only. For **naive** deployment, do not set this variable in your environment file. ::: -First create an env file that will be used by the service: +First, create an environment file that will be used by the service: -- for the **production** deployment: +- for **production** deployment: ```bash sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH** @@ -256,7 +252,7 @@ RELAY_ENDPOINT=**YOUR_RELAY_ENDPOINT** EOF' ``` -- for the **naive** deployment: +- for **naive** deployment: ```bash sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH** @@ -274,7 +270,7 @@ ERA_READER_ADAPTER_PARAMS=**YOUR_ERA_READER_ADAPTER_PARAMS** EOF' ``` -Then we will create a `/etc/systemd/system/mithril-signer.service` description file for our service +Then, create a `/etc/systemd/system/mithril-signer.service` description file for the service: ```bash sudo bash -c 'cat > /etc/systemd/system/mithril-signer.service << EOF @@ -295,55 +291,55 @@ WantedBy=multi-user.target EOF' ``` -Reload the service configuration (Optional) +Reload the service configuration (optional): ```bash sudo systemctl daemon-reload ``` -Then start the service +Then, start the service: ```bash sudo systemctl start mithril-signer ``` -Then register the service to start on boot +Register the service to start on boot: ```bash sudo systemctl enable mithril-signer ``` -Then monitor status of the service +Monitor the status of the service: ```bash systemctl status mithril-signer.service ``` -And monitor the logs of the service +Finally, monitor the logs of the service: ```bash tail /var/log/syslog ``` -## Setup the Mithril Relay node +## Set up the Mithril relay node :::caution -- For the **production** deployment: the setup of the **Mithril Relay** is done on the **Cardano Relay** machine. +- For **production** deployment, the setup of the **Mithril relay** is performed on the **Cardano relay** machine. -- For the **naive** deployment: this step is not necessary. +- For **naive** deployment: this step is not necessary. ::: -### Configure Squid service +### Configuring the Squid service :::info -The **Mithril Relay** node is a forward proxy that relays the traffic between the **Mithril Signer** and the **Mithril Aggregator**. When properly configured, it guarantees the security of the **Block Producing** node. We use `squid` to operate this forward proxy, and this section provides a recommended configuration. +The **Mithril relay** node serves as a forward proxy, relaying traffic between the **Mithril Signer** and the **Mithril Aggregator**. When appropriately configured, it facilitates the security of the **block-producing** node. You can use `squid` to operate this forward proxy, and this section presents a recommended configuration. ::: -Verify that the service was correctly configured at install: +Verify that the service was correctly configured at installation: ```bash sudo systemctl status squid @@ -380,8 +376,8 @@ EOF' ``` With this configuration, the proxy will: -- accept incoming traffic made from the internal IP of the block producing machine -- accept incoming traffic made to the listening port of the proxy +- accept incoming traffic originating from the internal IP of the block-producing machine +- accept incoming traffic directed to the listening port of the proxy - accept incoming HTTPS traffic proxied to `mithril.network` domain hosts - deny all other traffic @@ -391,13 +387,13 @@ Restart the service: sudo systemctl restart squid ``` -And make sure that it is running properly: +Ensure it runs properly: ```bash sudo systemctl status squid ``` -And monitor the logs of the service +Finally, monitor service logs: ```bash tail /var/log/syslog @@ -407,21 +403,20 @@ tail /var/log/syslog :::info -We assume that the **Cardano Relay** machine is protected by a firewall, and that the proxied traffic originating from the **Cardano Block Producer** must be allowed on this firewall. - +We assume that the **Cardano relay** machine is protected by a firewall. It is necessary to allow the proxied traffic, originating from the **Cardano block producer**, through this firewall. ::: -#### On the Cardano Relay machine +#### About the Cardano relay machine -We need to allow the incoming traffic on the listening port of the **Mithril Relay** on **Cardano Relay** machine that is originating from the **Cardano Block Producer** machine. +You need to allow incoming traffic on the listening port of the **Mithril relay** on the **Cardano relay** machine, originating from the **Cardano block producer** machine. -Assuming you are using [`Uncomplicated Firewall`](https://en.wikipedia.org/wiki/Uncomplicated_Firewall) (`0.36+`), the command to run in order to open that traffic is: +Assuming you are using [`Uncomplicated Firewall`](https://en.wikipedia.org/wiki/Uncomplicated_Firewall) (`0.36+`), the command to open that traffic is: ```bash sudo ufw allow from **YOUR_BLOCK_PRODUCER_INTERNAL_IP** to any port **YOUR_RELAY_LISTENING_PORT** proto tcp ``` -Assuming you are using [`Iptables`](https://en.wikipedia.org/wiki/Iptables) (`1.8.7+`), the commands to run in order to open that traffic is: +Assuming you are using [`Iptables`](https://en.wikipedia.org/wiki/Iptables) (`1.8.7+`), the command to open that traffic is: ```bash sudo iptables -A INPUT -s **YOUR_BLOCK_PRODUCER_INTERNAL_IP** -p tcp --dport **YOUR_RELAY_LISTENING_PORT** -j ACCEPT @@ -429,9 +424,10 @@ sudo iptables -L -v sudo service netfilter-persistent save ``` -## Verify the Mithril Signer Deployment +## Verify the Mithril Signer deployment :::tip -There is a `2` epochs delay between the signer node registration and its ability to create individual signatures, as explained in the [Mithril Certificate Chain in depth](https://mithril.network/doc/mithril/mithril-protocol/certificates). -After this delay, you should be able to see your `PoolId` listed in some of the certificates available on the [`Mithril Explorer`](https://mithril.network/explorer) +There is a delay of `2` epochs between the registration of the signer node and its ability to generate individual signatures. This delay is further explained in the [Mithril certificate chain in depth](https://mithril.network/doc/mithril/mithril-protocol/certificates) documentation. + +Once this delay has passed, you should be able to observe your `PoolId` listed in some of the certificates accessible on the [`Mithril Explorer`](https://mithril.network/explorer). ::: diff --git a/docs/root/networks-matrix.md b/docs/root/networks-matrix.md index 19bbdf24139..b1bf35d9a27 100644 --- a/docs/root/networks-matrix.md +++ b/docs/root/networks-matrix.md @@ -7,7 +7,7 @@ hide_table_of_contents: true import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -Here is an up to date list of all the **Mithril Networks**, their configurations and their status: +Here is an updated list of all **Mithril networks**, including their configurations and current statuses: > Last update: 07/05/2023 @@ -18,17 +18,17 @@ Here is an up to date list of all the **Mithril Networks**, their configurations | Information | - |------------|------------ -| **Mithril Network** | `pre-release-preview` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.pre-release-preview.api.mithril.network%2Faggregator) -| **Cardano Network** | `preview` -| **Cardano Magic Id** | `2` +| **Mithril network** | `pre-release-preview` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.pre-release-preview.api.mithril.network%2Faggregator) +| **Cardano network** | `preview` +| **Cardano magic Id** | `2` | **Supported** | Yes :heavy_check_mark: | **Status** | Pre-Release 🟠 -| **Aggregator Endpoint** | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.pre-release-preview.api.mithril.network/aggregator) -| **Genesis Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey) -| **Era Reader Adapter Type** | `cardano-chain` -| **Era Reader Address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.addr) -| **Era Reader Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey) -| **Build From** | **Latest Pre-Release** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/releases?q=pre) +| **Aggregator endpoint** | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.pre-release-preview.api.mithril.network/aggregator) +| **Genesis verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey) +| **Era reader adapter type** | `cardano-chain` +| **Era reader address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.addr) +| **Era reader verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey) +| **Build from** | **Latest pre-release** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/releases?q=pre)
@@ -37,17 +37,17 @@ Here is an up to date list of all the **Mithril Networks**, their configurations | Information | - |------------|------------ -| **Mithril Network** | `testing-preview` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.testing-preview.api.mithril.network%2Faggregator) -| **Cardano Network** | `preview` -| **Cardano Magic Id** | `2` +| **Mithril network** | `testing-preview` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.testing-preview.api.mithril.network%2Faggregator) +| **Cardano network** | `preview` +| **Cardano magic Id** | `2` | **Supported** | Yes :heavy_check_mark: | **Status** | Unstable 🔴 -| **Aggregator Endpoint** | `https://aggregator.testing-preview.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.testing-preview.api.mithril.network/aggregator) -| **Genesis Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey) -| **Era Reader Adapter Type** | `cardano-chain` -| **Era Reader Address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.addr) -| **Era Reader Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey) -| **Build From** | **Main Branch** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main) +| **Aggregator endpoint** | `https://aggregator.testing-preview.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.testing-preview.api.mithril.network/aggregator) +| **Genesis verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey) +| **Era reader adapter type** | `cardano-chain` +| **Era reader address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.addr) +| **Era reader verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey) +| **Build from** | **Main branch** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main) @@ -56,17 +56,17 @@ Here is an up to date list of all the **Mithril Networks**, their configurations | Information | - |------------|------------ -| **Mithril Network** | `release-preprod` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-preprod.api.mithril.network%2Faggregator) -| **Cardano Network** | `preprod` -| **Cardano Magic Id** | `1` +| **Mithril network** | `release-preprod` [:mag_right:](https://mithril.network/explorer?aggregator=https%3A%2F%2Faggregator.release-preprod.api.mithril.network%2Faggregator) +| **Cardano network** | `preprod` +| **Cardano magic Id** | `1` | **Supported** | Yes :heavy_check_mark: | **Status** | Release 🟢 -| **Aggregator Endpoint** | `https://aggregator.release-preprod.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.release-preprod.api.mithril.network/aggregator) -| **Genesis Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey) -| **Era Reader Adapter Type** | `cardano-chain` -| **Era Reader Address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.addr) -| **Era Reader Verification Key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.vkey) -| **Build From** | **Latest Release** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/releases/latest) +| **Aggregator endpoint** | `https://aggregator.release-preprod.api.mithril.network/aggregator` [:arrow_upper_right:](https://aggregator.release-preprod.api.mithril.network/aggregator) +| **Genesis verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey) +| **Era reader adapter type** | `cardano-chain` +| **Era reader address** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.addr` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.addr) +| **Era reader verification key** | `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.vkey` [:arrow_upper_right:](https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.vkey) +| **Build from** | **Latest release** [:arrow_upper_right:](https://github.com/input-output-hk/mithril/releases/latest) @@ -75,28 +75,29 @@ Here is an up to date list of all the **Mithril Networks**, their configurations | Information | - |------------|------------ -| **Mithril Network** | `release-mainnet` -| **Cardano Network** | `mainnet` -| **Cardano Magic Id** | `-` +| **Mithril network** | `release-mainnet` +| **Cardano network** | `mainnet` +| **Cardano magic Id** | `-` | **Supported** | No :x: | **Status** | - -| **Aggregator Endpoint** | - -| **Genesis Verification Key** | - -| **Era Reader Adapter Type** | - -| **Era Reader Address** | - -| **Era Reader Verification Key** | - +| **Aggregator endpoint** | - +| **Genesis verification key** | - +| **Era reader adapter type** | - +| **Era reader address** | - +| **Era reader verification key** | - | **Build From** | - :::caution -In this documentation, we use the generic: -* ****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`) -* ****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`) -* ****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/mithril-infra/configuration/release-preprod/genesis.vkey`) -* ****YOUR_ERA_READER_ADAPTER_TYPE**** identifier, but you need to replace it with the era reader adapter type used by the Mithril network you target (e.g. `cardano-chain`) -* ****YOUR_ERA_READER_ADDRESS**** identifier, but you need to replace it with the era reader address url used by the Mithril network you target (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/address.addr`) -* ****YOUR_ERA_READER_VERIFICATION_KEY**** identifier, but you need to replace it with the era reader verification key url used by the Mithril network you target (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_era.vkey`) - -::: \ No newline at end of file +In this documentation, we use the following generic identifiers: + +* ****YOUR_CARDANO_NETWORK**** You need to replace this with the name of the network that runs on your Cardano node (e.g. `preprod`) +* ****YOUR_AGGREGATOR_ENDPOINT**** You need to replace this with the endpoint of an aggregator that runs on the Cardano network you are targeting (e.g. `https://aggregator.release-preprod.api.mithril.network/aggregator`) +* ****YOUR_GENESIS_VERIFICATION_KEY**** You need to replace this with the genesis verification key URL that runs on the Cardano network you are targeting (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey`) +* ****YOUR_ERA_READER_ADAPTER_TYPE**** You need to replace this with the era reader adapter type used by the Mithril network you are targeting (e.g. `cardano-chain`) +* ****YOUR_ERA_READER_ADDRESS**** You need to replace this with the era reader address URL used by the Mithril network you are targeting (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/address.addr`) +* ****YOUR_ERA_READER_VERIFICATION_KEY**** You need to replace this with the era reader verification key URL used by the Mithril network you are targeting (e.g. `https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_era.vkey`) + +:::