Skip to main content
Version: Current

API references

info

This page compiles the external developer documentation available for Mithril, intended exclusively for a technical audience.

tip

To learn more about the Mithril protocol, please refer to the about Mithril section.

Mithril networks​

Here is an updated list of all Mithril networks, including their configurations and current statuses:

Last update: 07/21/2023

release-mainnet​

Information-
Mithril networkrelease-mainnet
Cardano networkmainnet
Cardano magic Id-
SupportedYes βœ”οΈ
StatusBeta 🟒
Aggregator endpointhttps://aggregator.release-mainnet.api.mithril.network/aggregator ↗️
Genesis verification keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/genesis.vkey ↗️
Era reader adapter typecardano-chain
Era reader addresshttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/era.addr ↗️
Era reader verification keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-mainnet/era.vkey ↗️
Build fromLatest release ↗️
caution

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)

A list of dependencies​

DependencyDescriptionSource repositoryRust documentationREST API
Mithril commonThe common library used by Mithril network nodes.↗️↗️-
Mithril persistenceThe persistence library used by Mithril network nodes.↗️↗️-
Mithril STMThe core library that implements the cryptographic engine for the Mithril protocol.↗️↗️-
Mithril aggregatorThe node within the Mithril network responsible for collecting individual signatures from the Mithril signers and aggregating them into a multi-signature. This capability enables the Mithril aggregator to provide certified snapshots of the Cardano blockchain.↗️↗️↗️
Mithril client CLIThe node within the Mithril network responsible for restoring the Cardano blockchain on an empty node from a certified snapshot.↗️↗️-
Mithril clientThe library that can be used by developers to interact with Mithril certified data in their applications.↗️↗️-
Mithril signerThe node responsible for producing individual signatures that are collected and aggregated by the Mithril aggregator.↗️↗️-
Mithril devnetThe private Mithril/Cardano network used to create a Mithril network on top of a private Cardano network.↗️--
Mithril end to endThe tool used to run test scenarios against a Mithril devnet.↗️--
Mithril explorerThe explorer website that connects to a Mithril aggregator and displays its certificate chain.↗️--
Protocol simulationA simple CLI that helps understand how the Mithril protocol works and the role of its protocol parameters.↗️--