input-output-hk / mithril

Mithril :shield: :sunny: Introduction **Mithril** is a research project the goal of which is to provide stake-based threshold multi-signatures(STM) on top of the **Cardano network**. In a nutshell, **Mithril** can be summarized as: > A protocol that enables stakeholders in a proof-of-stake (PoS) blockchain network to individually sign messages, which are then aggregated into a multi-signature, guaranteeing that they represent a minimum share of the total stake. In other words, an adversarial participant with less than this share of the total stake will be unable to produce valid multi-signatures. :closed_lock_with_key:. The goal of the first implementation of the Mithril network protocol is to provide a way to quickly bootstrap a fully operating Cardano node in less than two hours, compared to the days it used to take before. To unleash the power of Mithril and leverage new use cases, we have also implemented a framework in the Mithril network that allows the certification of multiple types of data, provided they can be computed deterministically. :shield: Mainnet availability **Mithril** is currently a work in progress, and is available in its **beta** version on mainnet. :heavy_check_mark: It is ready to be safely deployed in the SPO production infrastructure for **Cardano** mainnet. :warning: It is **NOT** yet completely ready for production usage of the artifacts produced before a minimum level of participation in the network (which depends on the artifact type). Disclaimer By using the Mithril protocol, you understand it is in development and that using the , , and on mainnet is entirely at your own risk. You also acknowledge and agree to have an adequate understanding of the risks associated with use of the Mithril network and that all information and materials published, distributed or otherwise made available on the Mithril site and Mithril GitHub repository is available on an ‘AS IS’ and ‘AS AVAILABLE’ basis, without any representations or warranties of any kind. All implied terms are excluded to the fullest extent permitted by law. For details, see also sections 7, 8, and 9 of the Apache 2.0 License. :rocket: Getting started with Mithril If you are a **Cardano SPO**, a good entry point is the SPO onboarding guide. Additionally, you can find detailed instructions for running a **signer node** in this guide. If you are interested in **fast bootstrapping** of a Cardano node, please refer to this guide. You can access tutorials, the user manual, guides, and plenty of documentation on our website! Mithril wiki is also available here. :satellite: Structure of the repository This repository consists of the following parts: • **Mithril aggregator**: the node of the **Mithril network** responsible for collecting individual signatures from the **Mithril signers** and aggregating them into a multi-signature. The **Mithril aggregator** uses this ability to provide certified snapshots of the **Cardano** blockchain. • **Mithril client**: the **client** library that developers can use to interact with Mithril-certified data in their applications. • **Mithril client CLI**: the CLI used for retrieving the certified artifacts produced by the **Mithril network**, eg, the **Cardano** chain certified snapshots used to securely restore a **Cardano node**. • **Mithril client WASM**: the WASM-compatible library used for retrieving the certified artifacts produced by the **Mithril network**. • **Mithril common**: the **common** library used by the **Mithril network** nodes. • **Mithril STM**: the **core** library that implements the **Mithril** protocol cryptographic engine. • **Mithril explorer**: the **explorer** website that connects to a **Mithril aggregator** and displays its **certificate chain** and artifacts. • **Mithril infrastructure**: the infrastructure used to power a **Mithril network** in the cloud. • **Mithril signer**: the node of the **Mithril network** responsible for producing individual signatures that are collected and aggregated by the **Mithril aggregator**. • **Internal**: the shared tools and API used by **Mithril** crates. • **Mithril aggregator client**: a client to request data from a Mithril aggregator, used by **Mithril network** nodes and client library. • **Mithril aggregator discovery**: mechanisms to discover available Mithril aggregators, used by **Mithril network** nodes and client library. • **Mithril build script**: a toolbox for Mithril crates that uses a build script phase. • **Mithril cardano-node-chain**: mechanisms to read and interact with the **Cardano chain** through a Cardano node, used by **Mithril network** nodes. • **Mithril cardano-node-internal-database**: mechanisms to read the files of a **Cardano node** internal database and compute digests from them, used by **Mithril network** nodes and client library. • **Mithril cli helper**: **CLI** tools for **Mithril** binaries. • **Mithril DMQ node**: mechanisms to publish and consume messages of a **Decentralized Message Queue network** through a DMQ node, used by Mithril network nodes. • **Mithril doc**: an API that generates Markdown documentation for crate command line arguments. • **Mithril doc derive**: a macro implementation used by **Mithril doc**. • **Mithril era**: mechanisms to read and check **Mithril Era markers**, used by **Mithril network** nodes. • **Mithril metric**: materials to expose **metrics** in **Mithril network** nodes. • **Mithril persistence**: the **persistence** library that is used by **Mithril network** nodes. • **Mithril protocol config**: mechanisms to read and check the **configuration parameters** of a **Mithril network**. • **Mithril resource pool**: a **resource pool** mechanism that is used by **Mithril network** nodes. • **Mithril ticker**: a **ticker** mechanism that reads time information from the chain and is used by **Mithril network** nodes. • **Mithril signed entity lock**: a non-blocking **lock** mechanism for signed entity types, used by *…