Merge pull request #2058 from input-output-hk/dlachaume/1966/refactor-protocol-parameters-naming

Refactor: rename protocol parameters for consistency in signer and aggregator

Author: dlachaume

CHANGELOG.md

@@ -20,6 +20,8 @@ As a minor extension, we have adopted a slightly different versioning convention
 
 - Support for stable Cardano stake distribution client library, CLI and WASM.
 
+- Deprecate `protocol` and `next_protocol` in favor of `signer_registration_protocol` in the `/epoch-settings` route.
+
 - Crates versions:
 
 | Crate | Version |

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.5.93"
+version = "0.5.94"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -55,7 +55,7 @@ mod tests {
             ..AggregatorEpochSettings::dummy()
         };
         let epoch_service = FakeEpochServiceBuilder {
-            epoch_settings: epoch_settings.clone(),
+            current_epoch_settings: epoch_settings.clone(),
             current_signers_with_stake: signers_with_stake.clone(),
             next_signers_with_stake: signers_with_stake.clone(),
             ..FakeEpochServiceBuilder::dummy(Epoch(1))

mithril-aggregator/src/artifact_builder/mithril_stake_distribution.rs

@@ -38,8 +38,11 @@ async fn get_epoch_settings_message(
     let epoch_service = epoch_service.read().await;
 
     let epoch = epoch_service.epoch_of_current_data()?;
-    let protocol_parameters = epoch_service.next_protocol_parameters()?.clone();
-    let next_protocol_parameters = epoch_service.upcoming_protocol_parameters()?.clone();
+    let protocol_parameters = Some(epoch_service.next_protocol_parameters()?.clone());
+    let signer_registration_protocol_parameters = epoch_service
+        .signer_registration_protocol_parameters()?
+        .clone();
+    let next_protocol_parameters = Some(signer_registration_protocol_parameters.clone());
     let current_signers = epoch_service.current_signers()?;
     let next_signers = epoch_service.next_signers()?;
 
@@ -55,10 +58,12 @@ async fn get_epoch_settings_message(
         .transpose()?
         .cloned();
 
+    #[allow(deprecated)]
     let epoch_settings_message = EpochSettingsMessage {
         epoch,
         protocol_parameters,
         next_protocol_parameters,
+        signer_registration_protocol_parameters,
         current_signers: SignerMessagePart::from_signers(current_signers.to_vec()),
         next_signers: SignerMessagePart::from_signers(next_signers.to_vec()),
         cardano_transactions_signing_config,
@@ -178,15 +183,15 @@ mod tests {
             protocol_parameters: ProtocolParameters::new(102, 20, 0.5),
             ..AggregatorEpochSettings::dummy()
         };
-        let upcoming_epoch_settings = AggregatorEpochSettings {
+        let signer_registration_epoch_settings = AggregatorEpochSettings {
             protocol_parameters: ProtocolParameters::new(103, 30, 0.5),
             ..AggregatorEpochSettings::dummy()
         };
 
         let epoch_service = FakeEpochServiceBuilder {
-            epoch_settings: current_epoch_settings,
+            current_epoch_settings,
             next_epoch_settings: next_epoch_settings.clone(),
-            upcoming_epoch_settings: upcoming_epoch_settings.clone(),
+            signer_registration_epoch_settings: signer_registration_epoch_settings.clone(),
             current_signers_with_stake: fake_data::signers_with_stakes(5),
             next_signers_with_stake: fake_data::signers_with_stakes(3),
             ..FakeEpochServiceBuilder::dummy(Epoch(1))
@@ -200,13 +205,23 @@ mod tests {
         .await
         .unwrap();
 
+        #[allow(deprecated)]
+        let message_protocol_parameters = message.protocol_parameters.unwrap();
         assert_eq!(
-            message.protocol_parameters,
+            message_protocol_parameters,
             next_epoch_settings.protocol_parameters
         );
+
+        #[allow(deprecated)]
+        let message_next_protocol_parameters = message.next_protocol_parameters.unwrap();
+        assert_eq!(
+            message_next_protocol_parameters,
+            signer_registration_epoch_settings.protocol_parameters
+        );
+
         assert_eq!(
-            message.next_protocol_parameters,
-            upcoming_epoch_settings.protocol_parameters
+            message.signer_registration_protocol_parameters,
+            signer_registration_epoch_settings.protocol_parameters
         );
     }
 
@@ -228,9 +243,9 @@ mod tests {
         };
 
         let epoch_service = FakeEpochServiceBuilder {
-            epoch_settings: current_epoch_settings.clone(),
+            current_epoch_settings: current_epoch_settings.clone(),
             next_epoch_settings: next_epoch_settings.clone(),
-            upcoming_epoch_settings: AggregatorEpochSettings::dummy(),
+            signer_registration_epoch_settings: AggregatorEpochSettings::dummy(),
             current_signers_with_stake: fake_data::signers_with_stakes(5),
             next_signers_with_stake: fake_data::signers_with_stakes(3),
             ..FakeEpochServiceBuilder::dummy(Epoch(1))

mithril-aggregator/src/http_server/routes/epoch_routes.rs

@@ -185,15 +185,15 @@ mod tests {
         let multi_signer = MultiSignerImpl::new(
             Arc::new(RwLock::new(
                 FakeEpochServiceBuilder {
-                    epoch_settings: AggregatorEpochSettings {
+                    current_epoch_settings: AggregatorEpochSettings {
                         protocol_parameters: fixture.protocol_parameters(),
                         ..AggregatorEpochSettings::dummy()
                     },
                     next_epoch_settings: AggregatorEpochSettings {
                         protocol_parameters: next_fixture.protocol_parameters(),
                         ..AggregatorEpochSettings::dummy()
                     },
-                    upcoming_epoch_settings: AggregatorEpochSettings {
+                    signer_registration_epoch_settings: AggregatorEpochSettings {
                         protocol_parameters: next_fixture.protocol_parameters(),
                         ..AggregatorEpochSettings::dummy()
                     },

mithril-aggregator/src/multi_signer.rs

@@ -364,18 +364,17 @@ impl AggregatorRunnerTrait for AggregatorRunner {
         let protocol_parameters = epoch_service.next_protocol_parameters().with_context(|| {
             format!("no current protocol parameters found for time point {time_point:?}")
         })?;
-        let next_protocol_parameters =
-            epoch_service
-                .upcoming_protocol_parameters()
-                .with_context(|| {
-                    format!("no next protocol parameters found for time point {time_point:?}")
-                })?;
+        let signer_registration_protocol_parameters = epoch_service
+            .signer_registration_protocol_parameters()
+            .with_context(|| {
+                format!("no signer registration protocol parameters found for time point {time_point:?}")
+            })?;
 
         let pending_certificate = CertificatePending::new(
             time_point.epoch,
             signed_entity_type.to_owned(),
             protocol_parameters.clone(),
-            next_protocol_parameters.clone(),
+            signer_registration_protocol_parameters.clone(),
             Signer::vec_from(signers.clone()),
             Signer::vec_from(next_signers.clone()),
         );