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.
List of dependencies
| Dependency | Description | Source repository | Rust documentation | Published | REST API |
|---|---|---|---|---|---|
| Mithril STM | The core library that implements the cryptographic engine for the Mithril protocol. | ↗️ | ↗️ | crates ↗️ | - |
| Mithril aggregator | The 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 | The library that can be used by developers to interact with Mithril certified data in their applications. | ↗️ | ↗️ | crates ↗️ | - |
| Mithril client CLI | The node within the Mithril network responsible for restoring the Cardano blockchain on an empty node from a certified snapshot. | ↗️ | ↗️ | - | - |
| Mithril client wasm | The WASM compatible library used for retrieving the certified artifacts produced by the Mithril network. | ↗️ | - | npm ↗️ | - |
| Mithril signer | The node responsible for producing individual signatures that are collected and aggregated by the Mithril aggregator. | ↗️ | ↗️ | - | - |
| Mithril common | The common library used by Mithril network nodes. | ↗️ | ↗️ | crates ↗️ | - |
| Mithril build script | A toolbox for Mithril crates using a build scripts phase. | ↗️ | ↗️ | crates ↗️ | - |
| Mithril doc | An API that generates markdown documentation for a crate command lines arguments. | ↗️ | ↗️ | - | - |
| Mithril doc derive | A macro implementation used by Mithril doc. | ↗️ | ↗️ | - | - |
| Mithril persistence | The persistence library used by Mithril network nodes. | ↗️ | ↗️ | - | - |
| Mithril devnet | The private Mithril/Cardano network used to create a Mithril network on top of a private Cardano network. | ↗️ | - | - | - |
| Mithril end to end | The tool used to run test scenarios 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. | ↗️ | - | - | - |