Fix broken links in rust documentations

Author: Alenar

mithril-client/src/lib.rs

@@ -1,14 +1,14 @@
 #![warn(missing_docs)]
 
 //! Define everything necessary to list, download, and validate snapshots from a
-//! [Mithril Aggregator](https://mithril.network/mithril-aggregator/doc/mithril_aggregator/index.html).
+//! [Mithril Aggregator](https://mithril.network/rust-doc/mithril_aggregator/index.html).
 //!
 //! To query an aggregator for snapshots & certificate use the [AggregatorHTTPClient] that implement
 //! the [AggregatorHandler] trait.
 //!
 //! To list, download, and validate snapshots use the [Runtime].
 //! You must initialize it by giving it a CertificateVerifier, a ProtocolGenesisVerifier and a [AggregatorHandler], and a
-//! [Digester](https://mithril.network/mithril-common/doc/mithril_common/digesters/trait.Digester.html)
+//! [Digester](mithril_common::digesters::ImmutableDigester)
 //! implementations using the `with_xxx` methods.
 
 mod aggregator;

mithril-client/src/runtime.rs

@@ -30,7 +30,7 @@ pub enum RuntimeError {
     AggregatorHandler(#[from] AggregatorHandlerError),
 
     /// Error raised when a CertificateRetrieverError tries to retrieve a
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
+    /// [certificate](mithril_common::entities::Certificate)
     #[error("certificate retriever error: '{0}'")]
     CertificateRetriever(#[from] CertificateRetrieverError),
 
@@ -39,7 +39,7 @@ pub enum RuntimeError {
     ImmutableDigester(#[from] ImmutableDigesterError),
 
     /// Error raised when the digest stored in the signed message doesn't match the
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
+    /// [certificate](mithril_common::entities::Certificate)
     /// hash.
     #[error("digest doesn't match error: '{0}'")]
     DigestDoesntMatch(String),

mithril-common/src/certificate_chain/certificate_retriever.rs

@@ -10,16 +10,16 @@ use mockall::automock;
 /// [CertificateRetriever] related errors.
 #[derive(Error, Debug)]
 pub enum CertificateRetrieverError {
-    /// Error raised when a [CertificateRetriever] tries to retrieve a [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
+    /// Error raised when a [CertificateRetriever] tries to retrieve a [Certificate]
     #[error("general error: '{0}'")]
     General(String),
 }
 
-/// CertificateRetriever is in charge of retrieving a Certificate given its hash
+/// CertificateRetriever is in charge of retrieving a [Certificate] given its hash
 #[cfg_attr(test, automock)]
 #[async_trait]
 pub trait CertificateRetriever: Sync + Send {
-    /// Get certificate details
+    /// Get [Certificate] details
     async fn get_certificate_details(
         &self,
         certificate_hash: &str,

mithril-common/src/certificate_chain/certificate_verifier.rs

@@ -31,31 +31,24 @@ pub enum CertificateVerifierError {
     #[error("codec genesis error: '{0}'")]
     CodecGenesis(String),
 
-    /// Error raised when a CertificateRetriever tries to retrieve
-    /// a [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
+    /// Error raised when a CertificateRetriever tries to retrieve a [Certificate].
     #[error("certificate retriever error: '{0}'")]
     CertificateRetriever(#[from] CertificateRetrieverError),
 
-    /// Error raised when the Genesis Signature stored in a
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
-    /// is invalid.
+    /// Error raised when the Genesis Signature stored in a [Certificate] is invalid.
     #[error("certificate genesis error: '{0}'")]
     CertificateGenesis(#[from] ProtocolGenesisError),
 
-    /// Error raised when the hash stored in a
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
-    /// doesn't match a recomputed hash.
+    /// Error raised when the hash stored in a [Certificate] doesn't match a recomputed hash.
     #[error("certificate hash unmatch error")]
     CertificateHashUnmatch,
 
-    /// Error raised when validating the certificate chain if a previous
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
-    /// hash isn't equal to the current certificate `previous_hash`.
+    /// Error raised when validating the certificate chain if a previous [Certificate] hash isn't
+    /// equal to the current certificate `previous_hash`.
     #[error("certificate chain previous hash unmatch error")]
     CertificateChainPreviousHashUnmatch,
 
-    /// Error raised when validating the certificate chain if the current
-    /// [certificate](https://mithril.network/mithril-common/doc/mithril_common/entities/struct.Certificate.html)
+    /// Error raised when validating the certificate chain if the current [Certificate]
     /// `aggregate_verification_key` doesn't match the previous `aggregate_verification_key` (if
     /// the certificates are on the same epoch) or the previous `next_aggregate_verification_key`
     /// (if the certificates are on different epoch).
@@ -67,7 +60,8 @@ pub enum CertificateVerifierError {
     CertificateChainInfiniteLoop,
 }
 
-/// CertificateVerifier is the cryptographic engine in charge of verifying multi signatures and certificates
+/// CertificateVerifier is the cryptographic engine in charge of verifying multi signatures and
+/// [certificates](Certificate)
 #[cfg_attr(test, automock)]
 #[async_trait]
 pub trait CertificateVerifier: Send + Sync {

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

@@ -76,7 +76,7 @@ pub enum ProtocolInitializerErrorWrapper {
     #[error("KES key cannot be updated for period {0}")]
     KesUpdate(KESPeriod),
 }
-/// Wrapper structure for [MithrilCore:StmInitializer](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmInitializer.html).
+/// Wrapper structure for [MithrilCore: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)]
@@ -85,7 +85,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](https://mithril.network/mithril-core/doc/mithril/key_reg/struct.KeyReg.html).
+/// Wrapper structure for [MithrilCore: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/genesis.rs

@@ -14,7 +14,8 @@ pub enum ProtocolGenesisError {
     SignatureVerification(#[from] SignatureError),
 }
 
-/// A protocol Genesis Signer that is responsible for signing the [Genesis Certificate](https://mithril.network/doc/mithril/mithril-protocol/certificates#the-certificate-chain-design)
+/// A protocol Genesis Signer that is responsible for signing the
+/// [Genesis Certificate](https://mithril.network/doc/mithril/mithril-protocol/certificates#the-certificate-chain-design)
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ProtocolGenesisSigner {
     pub(crate) secret_key: ProtocolGenesisSecretKey,
@@ -76,7 +77,8 @@ impl ProtocolGenesisSigner {
     }
 }
 
-/// A protocol Genesis Verifier that is responsible for verifying the [Genesis Certificate](https://mithril.network/doc/mithril/mithril-protocol/certificates#the-certificate-chain-design)
+/// A protocol Genesis Verifier that is responsible for verifying the
+/// [Genesis Certificate](https://mithril.network/doc/mithril/mithril-protocol/certificates#the-certificate-chain-design)
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct ProtocolGenesisVerifier {
     pub(crate) verification_key: ProtocolGenesisVerificationKey,

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/mithril-core/doc/mithril/index.html)
+//! Tools and types to abstract the use of the [Mithril Core library](https://mithril.network/rust-doc/mithril/index.html)
 
 mod cardano;
 mod codec;

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](https://mithril.network/mithril-core/doc/mithril/stm/type.Stake.html).
+/// Alias of [MithrilCore: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](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmParameters.html).
+/// Alias of [MithrilCore::StmParameters](struct@mithril::stm::StmParameters).
 pub type ProtocolParameters = StmParameters;
 
-/// Alias of [MithrilCore::Index](https://mithril.network/mithril-core/doc/mithril/stm/type.Index.html).
+/// Alias of [MithrilCore::Index](type@mithril::stm::Index).
 pub type ProtocolLotteryIndex = Index;
 
-/// Alias of [MithrilCore:StmSigner](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmSigner.html).
+/// Alias of [MithrilCore:StmSigner](struct@mithril::stm::StmSigner).
 pub type ProtocolSigner = StmSigner<D>;
 
-/// Alias of a wrapper of [MithrilCore:StmInitializer](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmInitializer.html).
+/// Alias of a wrapper of [MithrilCore:StmInitializer](struct@mithril::stm::StmInitializer).
 pub type ProtocolInitializer = StmInitializerWrapper;
 
-/// Alias of [MithrilCore:StmClerk](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmClerk.html).
+/// Alias of [MithrilCore:StmClerk](struct@mithril::stm::StmClerk).
 pub type ProtocolClerk = StmClerk<D>;
 
-/// Alias of a wrapper of [MithrilCore:KeyReg](https://mithril.network/mithril-core/doc/mithril/key_reg/struct.KeyReg.html).
+/// Alias of a wrapper of [MithrilCore:KeyReg](struct@mithril::key_reg::KeyReg).
 pub type ProtocolKeyRegistration = KeyRegWrapper;
 
-/// Alias of [MithrilCore:StmSig](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmSig.html).
+/// Alias of [MithrilCore:StmSig](struct@mithril::stm::StmSig).
 pub type ProtocolSingleSignature = StmSig<D>;
 
-/// Alias of [MithrilCore:StmAggrSig](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmAggrSig.html).
+/// Alias of [MithrilCore:StmAggrSig](struct@mithril::stm::StmAggrSig).
 pub type ProtocolMultiSignature = StmAggrSig<D>;
 
-/// Alias of [MithrilCore:StmVerificationKeyPoP](https://mithril.network/mithril-core/doc/mithril/stm/type.StmVerificationKeyPoP.html).
+/// Alias of [MithrilCore: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](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmAggrVerificationKey.html).
+/// Alias of [MithrilCore: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](https://mithril.network/mithril-core/doc/mithril/error/enum.RegisterError.html).
+/// Alias of a wrapper of [MithrilCore:RegisterError](enum@mithril::RegisterError).
 pub type ProtocolRegistrationError = ProtocolRegistrationErrorWrapper;
 
-/// Alias of [MithrilCore:AggregationError](https://mithril.network/mithril-core/doc/mithril/error/enum.AggregationError.html).
+/// Alias of [MithrilCore:AggregationError](enum@mithril::AggregationError).
 pub type ProtocolAggregationError = AggregationError;
 
 // Test only
-/// (Test only) Alias of [MithrilCore:StmInitializer](https://mithril.network/mithril-core/doc/mithril/stm/struct.StmInitializer.html).
+/// (Test only) Alias of [MithrilCore:StmInitializer](struct@mithril::stm::StmInitializer).
 #[cfg(any(test, feature = "allow_skip_signer_certification"))]
 pub type ProtocolInitializerNotCertified = StmInitializer;
 
-/// (Test only) Alias of [MithrilCore:KeyReg](https://mithril.network/mithril-core/doc/mithril/key_reg/struct.KeyReg.html). (Test only)
+/// (Test only) Alias of [MithrilCore:KeyReg](struct@mithril::key_reg::KeyReg). (Test only)
 #[cfg(any(test, feature = "allow_skip_signer_certification"))]
 pub type ProtocolKeyRegistrationNotCertified = KeyReg;

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/mithril-core/doc/mithril/index.html)
+//! - Helpers for the [Mithril Core](https://mithril.network/rust-doc/mithril/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.

mithril-signer/src/lib.rs

@@ -3,7 +3,8 @@
 //!
 //! This crate is used by Cardano nodes to participate to Mithril signatures.
 //! It proposes tools to communicate with Mithril aggregators and to issue Single Signatures.
-//! See the [Mithril documentation](https://mithril.network/doc/manual/developer-docs/nodes/mithril-signer) for more information on how it works.
+//! See the [Mithril documentation](https://mithril.network/doc/manual/developer-docs/nodes/mithril-signer)
+//! for more information on how it works.
 
 mod certificate_handler;
 mod entities;