Documentation tweaks for common crypto helper

Author: Alenar

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

@@ -23,7 +23,7 @@ pub enum OpCertError {
     PoolAddressEncoding,
 }
 
-/// Raw Fields of the operational certificates (without incluiding the cold VK)
+/// Raw Fields of the operational certificates (without including the cold VK)
 #[derive(Clone, Debug, Deserialize, PartialEq, Eq, Serialize)]
 struct RawFields(
     #[serde(with = "serde_bytes")] Vec<u8>,

mithril-common/src/crypto_helper/era.rs

@@ -6,13 +6,13 @@ use thiserror::Error;
 
 use super::ProtocolKey;
 
-/// Alias of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.VerifyingKey.html).
+/// Wrapper of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.VerifyingKey.html).
 pub type EraMarkersVerifierVerificationKey = ProtocolKey<ed25519_dalek::VerifyingKey>;
 
-/// Alias of [Ed25519:SigningKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.SigningKey.html).
+/// Wrapper of [Ed25519:SigningKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.SigningKey.html).
 pub type EraMarkersVerifierSecretKey = ProtocolKey<ed25519_dalek::SigningKey>;
 
-/// Alias of [Ed25519:Signature](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.Signature.html).
+/// Wrapper of [Ed25519:Signature](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.Signature.html).
 pub type EraMarkersVerifierSignature = ProtocolKey<ed25519_dalek::Signature>;
 
 #[derive(Error, Debug)]
@@ -30,7 +30,7 @@ pub struct EraMarkersSigner {
 }
 
 impl EraMarkersSigner {
-    /// EraMarkersSigner factory
+    /// [EraMarkersSigner] factory
     pub fn create_test_signer<R>(mut rng: R) -> Self
     where
         R: CryptoRng + RngCore,
@@ -39,29 +39,29 @@ impl EraMarkersSigner {
         Self::from_secret_key(secret_key.into())
     }
 
-    /// EraMarkersSigner deterministic
+    /// [EraMarkersSigner] deterministic
     pub fn create_deterministic_signer() -> Self {
         let rng = ChaCha20Rng::from_seed([0u8; 32]);
         Self::create_test_signer(rng)
     }
 
-    /// EraMarkersSigner non deterministic
+    /// [EraMarkersSigner] non deterministic
     pub fn create_non_deterministic_signer() -> Self {
         let rng = rand_core::OsRng;
         Self::create_test_signer(rng)
     }
 
-    /// EraMarkersSigner from EraMarkersVerifierSecretKey
+    /// [EraMarkersSigner] from [EraMarkersVerifierSecretKey]
     pub fn from_secret_key(secret_key: EraMarkersVerifierSecretKey) -> Self {
         Self { secret_key }
     }
 
-    /// Create a EraMarkersVerifier
+    /// Create a [EraMarkersVerifier]
     pub fn create_verifier(&self) -> EraMarkersVerifier {
         EraMarkersVerifier::from_verification_key(self.secret_key.verifying_key().into())
     }
 
-    /// Signs a message and returns a EraMarkersVerifierSignature
+    /// Signs a message and returns a [EraMarkersVerifierSignature]
     pub fn sign(&self, message: &[u8]) -> EraMarkersVerifierSignature {
         self.secret_key.sign(message).into()
     }
@@ -74,12 +74,12 @@ pub struct EraMarkersVerifier {
 }
 
 impl EraMarkersVerifier {
-    /// EraMarkersVerifier from EraMarkersVerifierVerificationKey
+    /// [EraMarkersVerifier] from [EraMarkersVerifierVerificationKey]
     pub fn from_verification_key(verification_key: EraMarkersVerifierVerificationKey) -> Self {
         Self { verification_key }
     }
 
-    /// EraMarkersVerifier to EraMarkersVerifierVerificationKey
+    /// [EraMarkersVerifier] to [EraMarkersVerifierVerificationKey]
     pub fn to_verification_key(&self) -> EraMarkersVerifierVerificationKey {
         self.verification_key
     }

mithril-common/src/crypto_helper/genesis.rs

@@ -25,7 +25,7 @@ pub struct ProtocolGenesisSigner {
 }
 
 impl ProtocolGenesisSigner {
-    /// ProtocolGenesisSigner factory
+    /// [ProtocolGenesisSigner] factory
     pub fn create_test_genesis_signer<R>(mut rng: R) -> Self
     where
         R: CryptoRng + RngCore,
@@ -34,29 +34,29 @@ impl ProtocolGenesisSigner {
         Self::from_secret_key(secret_key.into())
     }
 
-    /// ProtocolGenesisSigner deterministic
+    /// [ProtocolGenesisSigner] deterministic
     pub fn create_deterministic_genesis_signer() -> Self {
         let rng = ChaCha20Rng::from_seed([0u8; 32]);
         Self::create_test_genesis_signer(rng)
     }
 
-    /// ProtocolGenesisSigner non deterministic
+    /// [ProtocolGenesisSigner] non deterministic
     pub fn create_non_deterministic_genesis_signer() -> Self {
         let rng = rand_core::OsRng;
         Self::create_test_genesis_signer(rng)
     }
 
-    /// ProtocolGenesisSigner from ProtocolGenesisSecretKey
+    /// [ProtocolGenesisSigner] from [ProtocolGenesisSecretKey]
     pub fn from_secret_key(secret_key: ProtocolGenesisSecretKey) -> Self {
         Self { secret_key }
     }
 
-    /// Create a ProtocolGenesisVerifier
+    /// Create a [ProtocolGenesisVerifier]
     pub fn create_genesis_verifier(&self) -> ProtocolGenesisVerifier {
         ProtocolGenesisVerifier::from_verification_key(self.secret_key.verifying_key().into())
     }
 
-    /// Signs a message and returns a ProtocolGenesisSignature
+    /// Signs a message and returns a [ProtocolGenesisSignature]
     pub fn sign(&self, message: &[u8]) -> ProtocolGenesisSignature {
         self.secret_key.sign(message).into()
     }
@@ -79,12 +79,12 @@ pub struct ProtocolGenesisVerifier {
 }
 
 impl ProtocolGenesisVerifier {
-    /// ProtocolGenesisVerifier from ProtocolGenesisVerificationKey
+    /// [ProtocolGenesisVerifier] from [ProtocolGenesisVerificationKey]
     pub fn from_verification_key(verification_key: ProtocolGenesisVerificationKey) -> Self {
         Self { verification_key }
     }
 
-    /// ProtocolGenesisVerifier to ProtocolGenesisVerificationKey
+    /// [ProtocolGenesisVerifier] to [ProtocolGenesisVerificationKey]
     pub fn to_verification_key(&self) -> ProtocolGenesisVerificationKey {
         self.verification_key
     }

mithril-common/src/crypto_helper/types/wrappers.rs

@@ -26,13 +26,13 @@ pub type ProtocolGenesisSignature = ProtocolKey<ed25519_dalek::Signature>;
 /// Wrapper of [OpCert] to add serialization utilities.
 pub type ProtocolOpCert = ProtocolKey<OpCert>;
 
-/// Alias of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.VerifyingKey.html).
+/// Wrapper of [Ed25519:PublicKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.VerifyingKey.html).
 pub type ProtocolGenesisVerificationKey = ProtocolKey<ed25519_dalek::VerifyingKey>;
 
-/// Alias of [Ed25519:SigningKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.SigningKey.html).
+/// Wrapper of [Ed25519:SigningKey](https://docs.rs/ed25519-dalek/latest/ed25519_dalek/struct.SigningKey.html).
 pub type ProtocolGenesisSecretKey = ProtocolKey<ed25519_dalek::SigningKey>;
 
-/// Alias of [MithrilStm:StmAggrVerificationKey](struct@mithril_stm::stm::StmAggrVerificationKey).
+/// Wrapper of [MithrilStm:StmAggrVerificationKey](struct@StmAggrVerificationKey).
 pub type ProtocolAggregateVerificationKey = ProtocolKey<StmAggrVerificationKey<D>>;
 
 impl ProtocolGenesisSignature {