Fix remaining 'Core' mentions

Replace them with 'Stm' for clarity.

Author: jpraynaud

README.md

@@ -54,7 +54,7 @@ This repository is sliced in the following parts:
 
 * [**Mithril Common**](./mithril-common): this is the **common** library that is used by the **Mithril Network** nodes.
 
-* [**Mithril Core**](./mithril-stm): the **core** library that implements **Mithril** protocol cryptographic engine.
+* [**Mithril STM**](./mithril-stm): the **core** library that implements **Mithril** protocol cryptographic engine.
 
 * [**Mithril Explorer**](./mithril-explorer): the **explorer** website that connects to a **Mithril Aggregator** and displays its **Certificate Chain**.
 

docs/root/manual/developer-docs/references.md

@@ -29,7 +29,7 @@ For more information about the **Mithril Protocol**, please refer to the [About
 | Dependency | Description | Source Repository | Rust Documentation | REST API
 |------------|-------------|:-----------------:|:------------------:|:------------:|
 | **Mithril Common** | This is the **common** library that is used by the **Mithril Network** nodes. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-common) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_common/index.html) | -
-| **Mithril Core** | The **core** library that implements **Mithril** protocol cryptographic engine. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-stm) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril/index.html) | -
+| **Mithril STM** | The **core** library that implements **Mithril** protocol cryptographic engine. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-stm) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_stm/index.html) | -
 | **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. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-aggregator) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_aggregator/index.html) | [:arrow_upper_right:](/aggregator-api)
 | **Mithril Client** | The node of the **Mithril Network** responsible for restoring the **Cardano** blockchain on an empty node from a certified snapshot. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-client) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_client/index.html) | -
 | **Mithril Signer** | The node of the **Mithril Network** responsible for producing individual signatures that are collected and aggregated by the **Mithril Aggregator**. | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-signer) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_signer/index.html) | -

mithril-aggregator/src/multi_signer.rs

@@ -48,7 +48,7 @@ pub enum ProtocolError {
     #[error("codec error: '{0}'")]
     Codec(String),
 
-    /// Mithril Core library returned an error.
+    /// Mithril STM library returned an error.
     #[error("core error: '{0}'")]
     Core(String),
 

mithril-common/src/crypto_helper/cardano/key_certification.rs

@@ -79,7 +79,7 @@ pub enum ProtocolInitializerErrorWrapper {
     #[error("KES key cannot be updated for period {0}")]
     KesUpdate(KESPeriod),
 }
-/// Wrapper structure for [MithrilCore:StmInitializer](mithril::stm::StmInitializer).
+/// Wrapper structure for [MithrilStm:StmInitializer](mithril::stm::StmInitializer).
 /// It now obtains a KES signature over the Mithril key. This allows the signers prove
 /// their correct identity with respect to a Cardano PoolID.
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -88,7 +88,7 @@ pub struct StmInitializerWrapper {
     kes_signature: Option<ProtocolSignerVerificationKeySignature>, // todo: The option is ONLY for a smooth transition. We have to remove this.
 }
 
-/// Wrapper structure for [MithrilCore:KeyReg](mithril::key_reg::KeyReg).
+/// Wrapper structure for [MithrilStm:KeyReg](mithril::key_reg::KeyReg).
 /// The wrapper not only contains a map between `Mithril vkey <-> Stake`, but also
 /// a map `PoolID <-> Stake`. This information is recovered from the node state, and
 /// is used to verify the identity of a Mithril signer. Furthermore, the `register` function

mithril-common/src/crypto_helper/mod.rs

@@ -1,4 +1,4 @@
-//! Tools and types to abstract the use of the [Mithril Core library](https://mithril.network/rust-doc/mithril/index.html)
+//! Tools and types to abstract the use of the [Mithril STM library](https://mithril.network/rust-doc/mithril_stm/index.html)
 
 mod cardano;
 mod codec;

mithril-common/src/crypto_helper/tests_setup.rs

@@ -1,4 +1,4 @@
-//! Test data builders for Mithril Core types, for testing purpose.
+//! Test data builders for Mithril STM types, for testing purpose.
 use super::cardano::ColdKeyGenerator;
 use super::{genesis::*, key_encode_hex, types::*, OpCert, SerDeShelleyFileFormat};
 use crate::certificate_chain::CertificateGenesisProducer;

mithril-common/src/crypto_helper/types.rs

@@ -24,43 +24,43 @@ type D = Blake2b<U32>;
 /// The id of a mithril party.
 pub type ProtocolPartyId = String;
 
-/// Alias of [MithrilCore:Stake](type@mithril::stm::Stake).
+/// Alias of [MithrilStm:Stake](type@mithril::stm::Stake).
 pub type ProtocolStake = Stake;
 
 /// A list of [Party Id][ProtocolPartyId] associated with its [Stake][ProtocolStake].
 pub type ProtocolStakeDistribution = Vec<(ProtocolPartyId, ProtocolStake)>;
 
-/// Alias of [MithrilCore::StmParameters](struct@mithril::stm::StmParameters).
+/// Alias of [MithrilStm::StmParameters](struct@mithril::stm::StmParameters).
 pub type ProtocolParameters = StmParameters;
 
-/// Alias of [MithrilCore::Index](type@mithril::stm::Index).
+/// Alias of [MithrilStm::Index](type@mithril::stm::Index).
 pub type ProtocolLotteryIndex = Index;
 
-/// Alias of [MithrilCore:StmSigner](struct@mithril::stm::StmSigner).
+/// Alias of [MithrilStm:StmSigner](struct@mithril::stm::StmSigner).
 pub type ProtocolSigner = StmSigner<D>;
 
-/// Alias of a wrapper of [MithrilCore:StmInitializer](struct@mithril::stm::StmInitializer).
+/// Alias of a wrapper of [MithrilStm:StmInitializer](struct@mithril::stm::StmInitializer).
 pub type ProtocolInitializer = StmInitializerWrapper;
 
-/// Alias of [MithrilCore:StmClerk](struct@mithril::stm::StmClerk).
+/// Alias of [MithrilStm:StmClerk](struct@mithril::stm::StmClerk).
 pub type ProtocolClerk = StmClerk<D>;
 
-/// Alias of a wrapper of [MithrilCore:KeyReg](struct@mithril::key_reg::KeyReg).
+/// Alias of a wrapper of [MithrilStm:KeyReg](struct@mithril::key_reg::KeyReg).
 pub type ProtocolKeyRegistration = KeyRegWrapper;
 
-/// Alias of [MithrilCore:StmSig](struct@mithril::stm::StmSig).
+/// Alias of [MithrilStm:StmSig](struct@mithril::stm::StmSig).
 pub type ProtocolSingleSignature = StmSig;
 
-/// Alias of [MithrilCore:StmAggrSig](struct@mithril::stm::StmAggrSig).
+/// Alias of [MithrilStm:StmAggrSig](struct@mithril::stm::StmAggrSig).
 pub type ProtocolMultiSignature = StmAggrSig<D>;
 
-/// Alias of [MithrilCore:StmVerificationKeyPoP](type@mithril::stm::StmVerificationKeyPoP).
+/// Alias of [MithrilStm:StmVerificationKeyPoP](type@mithril::stm::StmVerificationKeyPoP).
 pub type ProtocolSignerVerificationKey = StmVerificationKeyPoP;
 
 /// Alias of [KES:Sum6KesSig](https://github.com/input-output-hk/kes/blob/master/src/kes.rs).
 pub type ProtocolSignerVerificationKeySignature = Sum6KesSig;
 
-/// Alias of [MithrilCore:StmAggrVerificationKey](struct@mithril::stm::StmAggrVerificationKey).
+/// Alias of [MithrilStm:StmAggrVerificationKey](struct@mithril::stm::StmAggrVerificationKey).
 pub type ProtocolAggregateVerificationKey = StmAggrVerificationKey<D>;
 
 /// Alias of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.PublicKey.html).
@@ -73,17 +73,17 @@ pub type ProtocolGenesisSecretKey = ed25519_dalek::SecretKey;
 pub type ProtocolGenesisSignature = ed25519_dalek::Signature;
 
 // Error alias
-/// Alias of a wrapper of [MithrilCore:RegisterError](enum@mithril::RegisterError).
+/// Alias of a wrapper of [MithrilStm:RegisterError](enum@mithril::RegisterError).
 pub type ProtocolRegistrationError = ProtocolRegistrationErrorWrapper;
 
-/// Alias of [MithrilCore:AggregationError](enum@mithril::AggregationError).
+/// Alias of [MithrilStm:AggregationError](enum@mithril::AggregationError).
 pub type ProtocolAggregationError = AggregationError;
 
 // Test only
-/// (Test only) Alias of [MithrilCore:StmInitializer](struct@mithril::stm::StmInitializer).
+/// (Test only) Alias of [MithrilStm:StmInitializer](struct@mithril::stm::StmInitializer).
 #[cfg(any(test, feature = "allow_skip_signer_certification"))]
 pub type ProtocolInitializerNotCertified = StmInitializer;
 
-/// (Test only) Alias of [MithrilCore:KeyReg](struct@mithril::key_reg::KeyReg). (Test only)
+/// (Test only) Alias of [MithrilStm:KeyReg](struct@mithril::key_reg::KeyReg). (Test only)
 #[cfg(any(test, feature = "allow_skip_signer_certification"))]
 pub type ProtocolKeyRegistrationNotCertified = KeyReg;

mithril-common/src/entities/single_signatures.rs

@@ -31,7 +31,7 @@ impl SingleSignatures {
         }
     }
 
-    /// Convert this [SingleSignatures] to its corresponding [MithrilCore Signature][ProtocolSingleSignature].
+    /// Convert this [SingleSignatures] to its corresponding [MithrilStm Signature][ProtocolSingleSignature].
     pub fn to_protocol_signature(&self) -> Result<ProtocolSingleSignature, String> {
         match key_decode_hex::<ProtocolSingleSignature>(&self.signature) {
             Ok(signature) => Ok(signature),

mithril-common/src/lib.rs

@@ -5,7 +5,7 @@
 //! Provide:
 //! - A way to store data with the [store] types
 //! - [Digester][digesters] to compute mithril digest from a Cardano database
-//! - Helpers for the [Mithril Core](https://mithril.network/rust-doc/mithril/index.html)
+//! - Helpers for the [Mithril STM](https://mithril.network/rust-doc/mithril_stm/index.html)
 //! lib with the [crypto_helper].
 //! - A [certificate chain] used to validate the Certificate Chain created by an aggregator
 //! - The [entities] used by, and exchanged between, the aggregator, signers and client.