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
- Preview
- Preprod
- Mainnet
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 devs 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 ↗️ |
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 ↗️ |
release-mainnet
| Information | - |
|---|---|
| Mithril Network | release-mainnet |
| Cardano Network | mainnet |
| Cardano Magic Id | - |
| Supported | No ❌ |
| Status | - |
| 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)
Dependencies List
| Dependency | Description | Source Repository | Rust Documentation | REST API |
|---|---|---|---|---|
| Mithril Common | This is the common library that is used by the Mithril Network nodes. | ↗️ | ↗️ | - |
| Mithril STM | The core library that implements Mithril protocol cryptographic engine. | ↗️ | ↗️ | - |
| Mithril Aggregator | The 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 Client | The node of the Mithril Network responsible for restoring the Cardano blockchain on an empty node from a certified snapshot. | ↗️ | ↗️ | - |
| Mithril Signer | The node of the Mithril Network responsible for producing individual signatures that are collected and aggregated by the Mithril Aggregator. | ↗️ | ↗️ | - |
| Mithril Devnet | The private Mithril/Cardano Network used to scaffold a Mithril Network on top of a private Cardano Network. | ↗️ | - | - |
| Mithril End to End | The tool used to run tests scenari against a Mithril Devnet. | ↗️ | - | - |
| Mithril Explorer | The explorer website that connects to a Mithril Aggregator and displays its Certificate Chain. | ↗️ | - | - |
| Protocol Simulation | A simple cli that helps understand how the Mithril Protocol works and the role of its protocol parameters. | ↗️ | - | - |