SPO onboarding guide
The journey with Mithril toward mainnet
β
Welcome to Mithril! Here is a description of the journey you will need to follow as an SPO to prepare for running a Mithril signer on mainnet
. We assume that you are already an active SPO on the Cardano mainnet
and have experience using the pre-production
testnet.
Step 1: Participate in the Pioneer Programβ
This step is optional, but recommended as it helps us deliver quality software. We are actively looking for SPO candidates to test Mithril on the Cardano testnets.
To participate in the Pioneer Program, you will need to:
- Run an active SPO on the Cardano
preview
network for at least one epoch or one day. - Set up a Mithril signer node on the
pre-release-preview
Mithril network by following the Run a Mithril signer node (SPO) guide. - You can choose between the Naive (easier to set up) or the Production deployment models.
- Wait for two epochs (or two days) before your Mithril signer is eligible to contribute. Check that your Mithril signer is registered by the aggregator following Verify your signer is registered steps.
- Verify that your Pool Id is listed in some of the produced certificates using the Mithril explorer or following Verify your signer contributes with individual signatures steps.
- β οΈ Follow our #ask-mithril Discord channel or our GitHub repository for new pre-releases to install.
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the #ask-mithril Discord channel.
Each Mithril network has its own configuration, which can be found in the Configuration parameters section of this guide.
Step 2: Get Mithril ready for mainnet
β
This step is optional. It's intended to familiarize SPOs with setting up Mithril on their infrastructure. It's strongly recommended to complete it before proceeding to Step 3.
To get ready for mainnet
, you need to:
- Be an active SPO on the Cardano
preprod
network for at least one epoch or five days. - Set up a Mithril signer node on Mithril's
release-preprod
network by following the Run a Mithril signer node (SPO) guide. - You must run the Production deployment model.
- Wait for two epochs (or ten days) before your Mithril signer is eligible to contribute. Check that your Mithril signer is registered by the aggregator following Verify your signer is registered steps.
- Verify that your Pool Id is listed in some of the produced certificates using the Mithril explorer or following Verify your signer contributes with individual signatures steps.
- β οΈ Follow our #ask-mithril Discord channel or our GitHub repository for new releases to install.
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the #ask-mithril Discord channel.
Each Mithril network has its own configuration, which can be found in the Configuration parameters section of this guide.
Step 3: Run Mithril on mainnet
β
This step is mandatory. It is strongly recommended to complete Step 2 beforehand.
To run Mithril on mainnet
, you need to:
- Be an active SPO on Cardano
mainnet
for at least one epoch or five days. - Set up a Mithril signer node on Mithril's
release-mainnet
network by following the Run a Mithril signer node (SPO) guide. - You must run the Production deployment model.
- Wait for two epochs (or ten days) before your Mithril signer is eligible to contribute. Check that your Mithril signer is registered by the aggregator following Verify your signer is registered steps.
- Verify that your Pool Id is listed in some of the produced certificates using the Mithril explorer or following Verify your signer contributes with individual signatures steps.
- β οΈ Follow our #ask-mithril Discord channel or our GitHub repository for new releases to install.
- If you have any technical issues or would like to provide feedback, feel free to ask questions on the #ask-mithril Discord channel.
Each Mithril network has its own configuration, which can be found in the Configuration parameters section of this guide.
Configuration parametersβ
Here is an updated list of all Mithril networks, including their configurations and current statuses:
Last update: 07/21/2023
- Mainnet
- Preprod
- Preview
- Sanchonet
release-mainnet
β
Information | - |
---|---|
Mithril network | release-mainnet |
Cardano network | mainnet |
Cardano magic Id | - |
Supported | Yes βοΈ |
Status | Beta π’ |
Aggregator endpoint | https://aggregator.release-mainnet.api.mithril.network/aggregator βοΈ |
Genesis verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/genesis.vkey βοΈ |
Era reader adapter type | cardano-chain |
Era reader address | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/era.addr βοΈ |
Era reader verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/era.vkey βοΈ |
Build from | Latest release βοΈ |
release-preprod
β
Information | - |
---|---|
Mithril network | release-preprod π |
Cardano network | preprod |
Cardano magic Id | 1 |
Supported | Yes βοΈ |
Status | Release π’ |
Aggregator endpoint | 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 βοΈ |
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 βοΈ |
Era reader verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/era.vkey βοΈ |
Build from | Latest release βοΈ |
pre-release-preview
β
Information | - |
---|---|
Mithril network | pre-release-preview π |
Cardano network | preview |
Cardano magic Id | 2 |
Supported | Yes βοΈ |
Status | Pre-release π |
Aggregator endpoint | 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 βοΈ |
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 βοΈ |
Era reader verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey βοΈ |
Build from | Latest pre-release βοΈ |
testing-preview
β
β οΈ For developers only
Information | - |
---|---|
Mithril network | testing-preview π |
Cardano network | preview |
Cardano magic Id | 2 |
Supported | Yes βοΈ |
Status | Unstable π΄ |
Aggregator endpoint | 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 βοΈ |
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 βοΈ |
Era reader verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey βοΈ |
Build from | Main branch βοΈ |
testing-sanchonet
β
β οΈ For developers only
Information | - |
---|---|
Mithril network | testing-sanchonet π |
Cardano network | sanchonet |
Cardano magic Id | 4 |
Supported | Yes βοΈ |
Status | Unstable π΄ |
Aggregator endpoint | https://aggregator.testing-sanchonet.api.mithril.network/aggregator βοΈ |
Genesis verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-sanchonet/genesis.vkey βοΈ |
Era reader adapter type | cardano-chain |
Era reader address | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-sanchonet/era.addr βοΈ |
Era reader verification key | https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-sanchonet/era.vkey βοΈ |
Build from | Main branch βοΈ |
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 (eg,
preprod
) - YOUR_AGGREGATOR_ENDPOINT You need to replace this with the endpoint of an aggregator that runs on the Cardano network you are targeting (eg,
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 (eg,
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 (eg,
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 (eg,
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 (eg,
https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_era.vkey
)