chore(client-lib): fix reviews comments

- fix symbols rust doc: "Aggregator" -> "aggregator" + some plurals

Author: Alenar

mithril-client/src/aggregator_client.rs

@@ -1,4 +1,4 @@
-//! Mechanisms to exchange data with an Aggregator.
+//! Mechanisms to exchange data with an aggregator.
 //!
 
 use anyhow::Context;

mithril-client/src/cardano_database_client/api.rs

@@ -33,7 +33,7 @@ use super::{
     proving::InternalArtifactProver,
 };
 
-/// HTTP client for CardanoDatabase API from the Aggregator
+/// HTTP client for CardanoDatabase API from the aggregator
 pub struct CardanoDatabaseClient {
     pub(super) artifact_retriever: InternalArtifactRetriever,
     #[cfg(feature = "fs")]
@@ -43,21 +43,21 @@ pub struct CardanoDatabaseClient {
     pub(super) statistics_sender: InternalStatisticsSender,
 }
 
-/// Define the requests against an Aggregator related to Cardano database v2 snapshots.
+/// Define the requests against an aggregator related to Cardano database v2 snapshots.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait CardanoDatabaseAggregatorRequest: Send + Sync {
-    /// Get the list of the latest Cardano database v2 snapshots from the Aggregator.
+    /// Get the list of the latest Cardano database v2 snapshots from the aggregator.
     async fn list_latest(&self) -> MithrilResult<Vec<CardanoDatabaseSnapshotListItem>>;
 
-    /// Get the list of the latest Cardano database v2 snapshots for an [EpochSpecifier] from the Aggregator.
+    /// Get the list of the latest Cardano database v2 snapshots for an [EpochSpecifier] from the aggregator.
     async fn list_by_epoch(
         &self,
         specifier: EpochSpecifier,
     ) -> MithrilResult<Vec<CardanoDatabaseSnapshotListItem>>;
 
-    /// Get the details of a Cardano database v2 snapshot for a given hash from the Aggregator.
+    /// Get the details of a Cardano database v2 snapshot for a given hash from the aggregator.
     async fn get_by_hash(&self, hash: &str) -> MithrilResult<Option<CardanoDatabaseSnapshot>>;
 
     /// Notify the aggregator that a complete Cardano database v2 restoration has been performed.

mithril-client/src/cardano_database_client/mod.rs

@@ -1,4 +1,4 @@
-//! A client to retrieve Cardano databases data from an Aggregator.
+//! A client to retrieve Cardano databases data from an aggregator.
 //!
 //! In order to do so it defines a [CardanoDatabaseClient] which exposes the following features:
 //!  - [get][CardanoDatabaseClient::get]: get a Cardano database data from its hash

mithril-client/src/cardano_stake_distribution_client.rs

@@ -1,4 +1,4 @@
-//! A client to retrieve Cardano stake distributions data from an Aggregator.
+//! A client to retrieve Cardano stake distributions data from an aggregator.
 //!
 //! In order to do so it defines a [CardanoStakeDistributionClient] which exposes the following features:
 //!  - [get][CardanoStakeDistributionClient::get]: get a Cardano stake distribution data from its hash
@@ -77,23 +77,23 @@ use std::sync::Arc;
 use crate::common::{Epoch, EpochSpecifier};
 use crate::{CardanoStakeDistribution, CardanoStakeDistributionListItem, MithrilResult};
 
-/// HTTP client for CardanoStakeDistribution API from the Aggregator
+/// HTTP client for CardanoStakeDistribution API from the aggregator
 pub struct CardanoStakeDistributionClient {
     aggregator_requester: Arc<dyn CardanoStakeDistributionAggregatorRequest>,
 }
 
-/// Define the requests against an Aggregator related to Cardano stake distribution.
+/// Define the requests against an aggregator related to Cardano stake distribution.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait CardanoStakeDistributionAggregatorRequest: Send + Sync {
-    /// Get the list of latest Cardano stake distributions from the Aggregator.
+    /// Get the list of the latest Cardano stake distributions from the aggregator.
     async fn list_latest(&self) -> MithrilResult<Vec<CardanoStakeDistributionListItem>>;
 
-    /// Get a Cardano stake distribution for a given hash from the Aggregator.
+    /// Get a Cardano stake distribution for a given hash from the aggregator.
     async fn get_by_hash(&self, hash: &str) -> MithrilResult<Option<CardanoStakeDistribution>>;
 
-    /// Get a Cardano stake distribution for an [EpochSpecifier] from the Aggregator.
+    /// Get a Cardano stake distribution for an [EpochSpecifier] from the aggregator.
     async fn get_by_epoch(
         &self,
         specifier: EpochSpecifier,

mithril-client/src/cardano_transaction_client.rs

@@ -82,27 +82,27 @@ use crate::{
     MithrilResult,
 };
 
-/// HTTP client for CardanoTransactionsAPI from the Aggregator
+/// HTTP client for CardanoTransactionsAPI from the aggregator
 pub struct CardanoTransactionClient {
     aggregator_requester: Arc<dyn CardanoTransactionAggregatorRequest>,
 }
 
-/// Define the requests against an Aggregator related to Cardano transactions.
+/// Define the requests against an aggregator related to Cardano transactions.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait CardanoTransactionAggregatorRequest: Send + Sync {
-    /// Get a proof of membership for the given transactions hashes from the Aggregator.
+    /// Get a proof of membership for the given transactions hashes from the aggregator.
     async fn get_proof(
         &self,
         hashes: &[String],
     ) -> MithrilResult<Option<CardanoTransactionsProofs>>;
 
-    /// Fetch the list of latest signed Cardano transaction snapshots from the Aggregator
+    /// Fetch the list of latest signed Cardano transactions snapshots from the aggregator
     async fn list_latest_snapshots(&self)
     -> MithrilResult<Vec<CardanoTransactionSnapshotListItem>>;
 
-    /// Fetch a Cardano transaction snapshot by its hash from the Aggregator.
+    /// Fetch a Cardano transactions snapshot by its hash from the aggregator.
     async fn get_snapshot(&self, hash: &str) -> MithrilResult<Option<CardanoTransactionSnapshot>>;
 }
 

mithril-client/src/certificate_client/api.rs

@@ -14,15 +14,15 @@ pub struct CertificateClient {
     pub(super) verifier: Arc<dyn CertificateVerifier>,
 }
 
-/// Define the requests against an Aggregator related to Mithril certificate.
+/// Define the requests against an aggregator related to Mithril certificate.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait CertificateAggregatorRequest: Send + Sync {
-    /// Get the list of latest Mithril Certificates from the Aggregator.
+    /// Get the list of latest Mithril Certificates from the aggregator.
     async fn list_latest(&self) -> MithrilResult<Vec<MithrilCertificateListItem>>;
 
-    /// Get a Mithril Certificate for a given hash from the Aggregator.
+    /// Get a Mithril Certificate for a given hash from the aggregator.
     async fn get_by_hash(&self, hash: &str) -> MithrilResult<Option<MithrilCertificate>>;
 }
 

mithril-client/src/certificate_client/mod.rs

@@ -1,4 +1,4 @@
-//! A client which retrieves and validates certificates from an Aggregator.
+//! A client which retrieves and validates certificates from an aggregator.
 //!
 //! In order to do so it defines a [CertificateClient] exposes the following features:
 //!  - [get][CertificateClient::get]: get a certificate data from its hash

mithril-client/src/mithril_stake_distribution_client.rs

@@ -1,4 +1,4 @@
-//! A client to retrieve Mithril stake distributions data from an Aggregator.
+//! A client to retrieve Mithril stake distributions data from an aggregator.
 //!
 //! In order to do so it defines a [MithrilStakeDistributionClient] which exposes the following features:
 //!  - [get][MithrilStakeDistributionClient::get]: get a Mithril stake distribution data from its hash
@@ -42,20 +42,20 @@ use std::sync::Arc;
 
 use crate::{MithrilResult, MithrilStakeDistribution, MithrilStakeDistributionListItem};
 
-/// HTTP client for MithrilStakeDistribution API from the Aggregator
+/// HTTP client for MithrilStakeDistribution API from the aggregator
 pub struct MithrilStakeDistributionClient {
     aggregator_requester: Arc<dyn MithrilStakeDistributionAggregatorRequest>,
 }
 
-/// Define the requests against an Aggregator related to Mithril stake distribution.
+/// Define the requests against an aggregator related to Mithril stake distribution.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait MithrilStakeDistributionAggregatorRequest: Send + Sync {
-    /// Get the list of latest Mithril stake distributions from the Aggregator.
+    /// Get the list of latest Mithril stake distributions from the aggregator.
     async fn list_latest(&self) -> MithrilResult<Vec<MithrilStakeDistributionListItem>>;
 
-    /// Get a Mithril stake distribution for a given hash from the Aggregator.
+    /// Get a Mithril stake distribution for a given hash from the aggregator.
     async fn get_by_hash(&self, hash: &str) -> MithrilResult<Option<MithrilStakeDistribution>>;
 }
 

mithril-client/src/snapshot_client.rs

@@ -1,4 +1,4 @@
-//! A client to retrieve snapshots data from an Aggregator.
+//! A client to retrieve snapshots data from an aggregator.
 //!
 //! In order to do so it defines a [SnapshotClient] which exposes the following features:
 //!  - [get][SnapshotClient::get]: get a single snapshot data from its digest
@@ -160,15 +160,15 @@ pub struct SnapshotClient {
     logger: Logger,
 }
 
-/// Define the requests against an Aggregator related to Cardano database v1 snapshots.
+/// Define the requests against an aggregator related to Cardano database v1 snapshots.
 #[cfg_attr(test, mockall::automock)]
 #[cfg_attr(target_family = "wasm", async_trait::async_trait(?Send))]
 #[cfg_attr(not(target_family = "wasm"), async_trait::async_trait)]
 pub trait SnapshotAggregatorRequest: Send + Sync {
-    /// Get the list of the latest Cardano database v1 snapshots from the Aggregator.
+    /// Get the list of the latest Cardano database v1 snapshots from the aggregator.
     async fn list_latest(&self) -> MithrilResult<Vec<SnapshotListItem>>;
 
-    /// Get the details of a Cardano database v1 snapshot for a given hash from the Aggregator.
+    /// Get the details of a Cardano database v1 snapshot for a given hash from the aggregator.
     async fn get_by_hash(&self, hash: &str) -> MithrilResult<Option<Snapshot>>;
 
     /// Notify the aggregator that a Cardano database v1 snapshot has been downloaded.