refactor(aggregator): make ctx signing config optional in sqlite database

Note: this commit compiles, but aggregator tests are still failing
because `EpochService::inform_epoch` still need a ctx signing config.

Author: Alenar

mithril-aggregator/src/database/migration.rs

@@ -251,5 +251,30 @@ alter table signed_entity add column epoch as (coalesce(json_extract(beacon, '$.
 create index signed_entity_epoch on signed_entity(epoch);
         "#,
         ),
+        // Migration 37
+        // Update `epoch_setting` table to make `cardano_transactions_signing_config` optional.
+        SqlMigration::new(
+            37,
+            r#"
+-- disable foreign keys since `signer_registration` has a foreign key constraint on `epoch_setting`
+pragma foreign_keys=false;
+
+create table if not exists new_epoch_setting (
+    epoch_setting_id                    integer     not null,
+    protocol_parameters                 json        not null,
+    cardano_transactions_signing_config json,
+    primary key (epoch_setting_id)
+);
+insert into new_epoch_setting (epoch_setting_id, protocol_parameters, cardano_transactions_signing_config)
+    select epoch_setting_id, protocol_parameters, cardano_transactions_signing_config
+    from epoch_setting order by rowid asc;
+drop table epoch_setting;
+alter table new_epoch_setting rename to epoch_setting;
+
+-- reenable foreign keys
+pragma foreign_key_check;
+pragma foreign_keys=true;
+        "#,
+        ),
     ]
 }

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

@@ -69,10 +69,10 @@ mod tests {
         );
 
         assert_eq!(
-            CardanoTransactionsSigningConfig {
+            Some(CardanoTransactionsSigningConfig {
                 security_parameter: BlockNumber(10),
                 step: BlockNumber(15)
-            },
+            }),
             epoch_settings_record.cardano_transactions_signing_config
         );
 
@@ -86,10 +86,10 @@ mod tests {
             epoch_settings_record.protocol_parameters
         );
         assert_eq!(
-            CardanoTransactionsSigningConfig {
+            Some(CardanoTransactionsSigningConfig {
                 security_parameter: BlockNumber(30),
                 step: BlockNumber(15),
-            },
+            }),
             epoch_settings_record.cardano_transactions_signing_config
         );
 

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

@@ -19,10 +19,10 @@ impl InsertOrIgnoreEpochSettingsQuery {
                     Value::String(
                         serde_json::to_string(&epoch_settings.protocol_parameters).unwrap(),
                     ),
-                    Value::String(
-                        serde_json::to_string(&epoch_settings.cardano_transactions_signing_config)
-                            .unwrap(),
-                    ),
+                    match &epoch_settings.cardano_transactions_signing_config {
+                        Some(config) => Value::String(serde_json::to_string(config).unwrap()),
+                        None => Value::Null,
+                    },
                 ],
             ),
         }
@@ -64,10 +64,10 @@ mod tests {
         let expected_epoch_settings = EpochSettingsRecord {
             epoch_settings_id: Epoch(3),
             protocol_parameters: fake_data::protocol_parameters(),
-            cardano_transactions_signing_config: CardanoTransactionsSigningConfig {
+            cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
                 security_parameter: BlockNumber(24),
                 step: BlockNumber(62),
-            },
+            }),
         };
         let record = connection
             .fetch_first(InsertOrIgnoreEpochSettingsQuery::one(
@@ -76,6 +76,19 @@ mod tests {
             .unwrap();
 
         assert_eq!(Some(expected_epoch_settings), record);
+
+        let expected_epoch_settings_without_ctx_config = EpochSettingsRecord {
+            epoch_settings_id: Epoch(4),
+            protocol_parameters: fake_data::protocol_parameters(),
+            cardano_transactions_signing_config: None,
+        };
+        let record = connection
+            .fetch_first(InsertOrIgnoreEpochSettingsQuery::one(
+                expected_epoch_settings_without_ctx_config.clone(),
+            ))
+            .unwrap();
+
+        assert_eq!(Some(expected_epoch_settings_without_ctx_config), record);
     }
 
     #[test]
@@ -85,10 +98,10 @@ mod tests {
         let expected_epoch_settings = EpochSettingsRecord {
             epoch_settings_id: Epoch(3),
             protocol_parameters: fake_data::protocol_parameters(),
-            cardano_transactions_signing_config: CardanoTransactionsSigningConfig {
+            cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
                 security_parameter: BlockNumber(24),
                 step: BlockNumber(62),
-            },
+            }),
         };
         let record = connection
             .fetch_first(InsertOrIgnoreEpochSettingsQuery::one(
@@ -99,10 +112,10 @@ mod tests {
 
         let record = connection
             .fetch_first(InsertOrIgnoreEpochSettingsQuery::one(EpochSettingsRecord {
-                cardano_transactions_signing_config: CardanoTransactionsSigningConfig {
+                cardano_transactions_signing_config: Some(CardanoTransactionsSigningConfig {
                     security_parameter: BlockNumber(134),
                     step: BlockNumber(872),
-                },
+                }),
                 ..expected_epoch_settings.clone()
             }))
             .unwrap();

mithril-aggregator/src/database/record/epoch_settings.rs

@@ -13,14 +13,14 @@ pub struct EpochSettingsRecord {
     pub protocol_parameters: ProtocolParameters,
 
     /// Cardano transactions signing configuration.
-    pub cardano_transactions_signing_config: CardanoTransactionsSigningConfig,
+    pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 }
 
 impl From<EpochSettingsRecord> for AggregatorEpochSettings {
     fn from(other: EpochSettingsRecord) -> Self {
         Self {
             protocol_parameters: other.protocol_parameters,
-            cardano_transactions_signing_config: Some(other.cardano_transactions_signing_config),
+            cardano_transactions_signing_config: other.cardano_transactions_signing_config,
         }
     }
 }
@@ -32,7 +32,7 @@ impl SqLiteEntity for EpochSettingsRecord {
     {
         let epoch_settings_id_int = row.read::<i64, _>(0);
         let protocol_parameters_string = &row.read::<&str, _>(1);
-        let cardano_transactions_signing_config_string = &row.read::<&str, _>(2);
+        let cardano_transactions_signing_config_string = &row.read::<Option<&str>, _>(2);
 
         let epoch_settings_record = Self {
             epoch_settings_id: Epoch(epoch_settings_id_int.try_into().map_err(|e| {
@@ -47,13 +47,13 @@ impl SqLiteEntity for EpochSettingsRecord {
                     ))
                 },
             )?,
-            cardano_transactions_signing_config: serde_json::from_str(cardano_transactions_signing_config_string).map_err(
+            cardano_transactions_signing_config: cardano_transactions_signing_config_string.map(|config| serde_json::from_str(config).map_err(
                 |e| {
                     HydrationError::InvalidData(format!(
-                        "Could not turn string '{cardano_transactions_signing_config_string}' to CardanoTransactionsSigningConfig. Error: {e}"
+                        "Could not turn string '{config}' to CardanoTransactionsSigningConfig. Error: {e}"
                     ))
                 },
-            )?,
+            )).transpose()?,
 
         };
 

mithril-aggregator/src/database/repository/epoch_settings_store.rs

@@ -53,10 +53,7 @@ impl EpochSettingsStorer for EpochSettingsStore {
     ) -> StdResult<Option<AggregatorEpochSettings>> {
         let record_to_insert = EpochSettingsRecord {
             epoch_settings_id: epoch,
-            // Todo: make this field optional allowing removal of the unwrap()
-            cardano_transactions_signing_config: epoch_settings
-                .cardano_transactions_signing_config
-                .unwrap(),
+            cardano_transactions_signing_config: epoch_settings.cardano_transactions_signing_config,
             protocol_parameters: epoch_settings.protocol_parameters,
         };
         let epoch_settings_record = self

mithril-aggregator/src/database/test_helper.rs

@@ -208,10 +208,7 @@ pub fn insert_epoch_settings(
         let (sql_values, _) = InsertOrIgnoreEpochSettingsQuery::one(EpochSettingsRecord {
             epoch_settings_id: Epoch(1),
             protocol_parameters: ProtocolParameters::new(1, 2, 1.0),
-            cardano_transactions_signing_config: CardanoTransactionsSigningConfig {
-                security_parameter: BlockNumber(0),
-                step: BlockNumber(0),
-            },
+            cardano_transactions_signing_config: None,
         })
         .filters()
         .expand();