Skip to main content
Version: Current

API Reference

Welcome to the Mithril API references doc!

info

This page gathers the external developer documentations available for Mithril. They are intended for a technical audience only.

tip

For more information about the Mithril Protocol, please refer to the About Mithril section.

Mithril Networks

Here is an up to date list of all the Mithril Networks, their configurations and their status:

Last update: 02/28/2023

pre-release-preview

Information-
Mithril Networkpre-release-preview 🔎
Cardano Networkpreview
Cardano Magic Id2
SupportedYes ✔️
StatusPre-Release 🟠
Aggregator Endpointhttps://aggregator.pre-release-preview.api.mithril.network/aggregator ↗️
Genesis Verification Keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/genesis.vkey ↗️
Era Reader Adapter Typecardano-chain
Era Reader Addresshttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.addr ↗️
Era Reader Verification Keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/pre-release-preview/era.vkey ↗️
Build FromLatest Pre-Release ↗️

testing-preview

⚠️ For devs only

Information-
Mithril Networktesting-preview 🔎
Cardano Networkpreview
Cardano Magic Id2
SupportedYes ✔️
StatusUnstable 🔴
Aggregator Endpointhttps://aggregator.testing-preview.api.mithril.network/aggregator ↗️
Genesis Verification Keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/genesis.vkey ↗️
Era Reader Adapter Typecardano-chain
Era Reader Addresshttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.addr ↗️
Era Reader Verification Keyhttps://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/testing-preview/era.vkey ↗️
Build FromMain Branch ↗️
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)

Dependencies List

DependencyDescriptionSource RepositoryRust DocumentationREST API
Mithril CommonThis is the common library that is used by the Mithril Network nodes.↗️↗️-
Mithril STMThe core library that implements Mithril protocol cryptographic engine.↗️↗️-
Mithril AggregatorThe node of the Mithril Network responsible for collecting individual signatures from the Mithril Signers and aggregate them into a multisignature. The Mithril Aggregator uses this ability to provide certified snapshots of the Cardano blockchain.↗️↗️↗️
Mithril ClientThe node of the Mithril Network responsible for restoring the Cardano blockchain on an empty node from a certified snapshot.↗️↗️-
Mithril SignerThe node of the Mithril Network responsible for producing individual signatures that are collected and aggregated by the Mithril Aggregator.↗️↗️-
Mithril DevnetThe private Mithril/Cardano Network used to scaffold a Mithril Network on top of a private Cardano Network.↗️--
Mithril End to EndThe tool used to run tests scenari 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.↗️--