style: address PR comments

Author: Alenar

mithril-aggregator/src/configuration.rs

@@ -384,7 +384,7 @@ pub trait ConfigurationSource {
     ) -> StdResult<AggregatorEpochSettings> {
         Ok(AggregatorEpochSettings {
             protocol_parameters: self.protocol_parameters().with_context(
-                || "Configuration `protocol_parameter` is mandatory for a Leader Aggregator",
+                || "Configuration `protocol_parameters` is mandatory for a Leader Aggregator",
             )?,
             cardano_transactions_signing_config: self
                 .cardano_transactions_signing_config()
@@ -571,8 +571,9 @@ pub struct ServeCommandConfiguration {
     #[example = "`{ security_parameter: 3000, step: 120 }`"]
     pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 
-    /// Blocks offset, from the tip of the chain, to exclude during the cardano transactions preload
-    /// `[default: 2160]`.
+    /// Blocks offset, from the tip of the chain, to exclude during the Cardano transactions preload,
+    /// default to 2160.
+    #[example = "`2160`"]
     pub preload_security_parameter: BlockNumber,
 
     /// Maximum number of transactions hashes allowed by request to the prover of the Cardano transactions
@@ -1003,7 +1004,7 @@ pub struct DefaultConfiguration {
     /// Cardano transactions signing configuration
     pub cardano_transactions_signing_config: CardanoTransactionsSigningConfig,
 
-    /// Blocks offset, from the tip of the chain, to exclude during the cardano transactions preload
+    /// Blocks offset, from the tip of the chain, to exclude during the Cardano transactions preload
     pub preload_security_parameter: u64,
 
     /// Maximum number of transactions hashes allowed by request to the prover of the Cardano transactions

mithril-aggregator/src/database/query/epoch_settings/insert_or_ignore_epoch_settings.rs

@@ -4,7 +4,7 @@ use mithril_persistence::sqlite::{Query, SourceAlias, SqLiteEntity, WhereConditi
 
 use crate::database::record::EpochSettingsRecord;
 
-/// Query to update [EpochSettingsRecord] in the sqlite database
+/// Query to insert a [EpochSettingsRecord] into the sqlite database if it does not already exist.
 pub struct InsertOrIgnoreEpochSettingsQuery {
     condition: WhereCondition,
 }

mithril-aggregator/src/store/epoch_settings_storer.rs

@@ -70,7 +70,7 @@ pub trait EpochSettingsStorer:
                             .cardano_transactions
                             .clone()
                             .ok_or(anyhow!(
-                                "missing cardano transactions signing config for epoch {epoch}"
+                                "Missing cardano transactions signing config for epoch {epoch}"
                             ))?,
                     },
                 )

mithril-common/src/messages/epoch_settings.rs

@@ -11,7 +11,7 @@ pub struct EpochSettingsMessage {
     /// Signer Registration Protocol parameters
     #[deprecated(
         since = "0.6.27",
-        note = "Will be removed soon. use `mithril_protocol_config` crate instead."
+        note = "Will be removed soon. use `mithril-protocol-config` crate instead."
     )]
     #[serde(
         rename = "signer_registration_protocol",
@@ -28,7 +28,7 @@ pub struct EpochSettingsMessage {
     /// Cardano transactions signing configuration for the current epoch
     #[deprecated(
         since = "0.6.27",
-        note = "Will be removed soon. use `mithril_protocol_config` crate instead."
+        note = "Will be removed soon. use `mithril-protocol-config` crate instead."
     )]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,

mithril-signer/src/configuration.rs

@@ -70,8 +70,9 @@ pub struct Configuration {
     /// be considered final, preventing any further rollback `[default: 2160]`.
     pub network_security_parameter: BlockNumber,
 
-    /// Blocks offset, from the tip of the chain, to exclude during the cardano transactions preload
-    /// `[default: 3000]`.
+    /// Blocks offset, from the tip of the chain, to exclude during the Cardano transactions preload,
+    /// default to 1000.
+    #[example = "`2160`"]
     pub preload_security_parameter: BlockNumber,
 
     /// Aggregator endpoint

mithril-signer/src/database/query/protocol_initializer/insert_protocol_initializer.rs

@@ -5,7 +5,7 @@ use mithril_persistence::sqlite::{Query, SourceAlias, SqLiteEntity, WhereConditi
 
 use crate::database::record::ProtocolInitializerRecord;
 
-/// Query to insert or ignore [ProtocolInitializerRecord] in the sqlite database
+/// Query to insert a [ProtocolInitializerRecord] into the sqlite database if it does not already exist.
 pub struct InsertOrIgnoreProtocolInitializerQuery {
     condition: WhereCondition,
 }