Skip to content

Refactor timepoint retrieval & conversion to signed entities #1736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jun 7, 2024
Merged

Refactor timepoint retrieval & conversion to signed entities #1736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
5428144
Rename `TimePointProvider` to `TickerService`
Alenar Jun 5, 2024
29c3966
Adapt aggregator to use the common TickerService
Alenar Jun 5, 2024
6723403
Add `get_current_epoch` to ticker service
Alenar Jun 5, 2024
2b5b3a1
Rename remaning occurences of `time_point_provider`
Alenar Jun 5, 2024
ebd52bb
Add `SignedEntityConversionConfig` alongside `TimePoint`
Alenar Jun 6, 2024
1799706
Make signer & aggregator dependency injection create the new config
Alenar Jun 6, 2024
c101409
Transfert timepoint->signed_entity conversion from the later to the f…
Alenar Jun 6, 2024
68e39fc
Add `list_allowed_signed_entity_types` and discriminants in TimePoint
Alenar Jun 6, 2024
eb0ee5d
Design change: use a dedicated type for conversion & list
Alenar Jun 6, 2024
d027982
Use `SignedEntityConfig` in aggregator root route
Alenar Jun 6, 2024
97e30a2
Aggregator config: remove default signed entity handling & cleanup tests
Alenar Jun 6, 2024
9b8c795
PR self-review adjustments
Alenar Jun 6, 2024
2cb5f21
Move signed entity discriminant list parsing to the discriminant itself
Alenar Jun 7, 2024
c9cba9d
Handle invalid values when parsing Signed entity discriminants
Alenar Jun 7, 2024
53e1076
Adjustment from PR review
Alenar Jun 7, 2024
179f66d
Upgrade crates versions
Alenar Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion mithril-aggregator/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "mithril-aggregator"
version = "0.5.17"
version = "0.5.18"
description = "A Mithril Aggregator server"
authors = { workspace = true }
edition = { workspace = true }
Expand Down
233 changes: 24 additions & 209 deletions mithril-aggregator/src/configuration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
use anyhow::anyhow;
use anyhow::{anyhow, Context};
use config::{ConfigError, Map, Source, Value, ValueKind};
use mithril_common::chain_observer::ChainObserverType;
use mithril_common::crypto_helper::ProtocolGenesisSigner;
use mithril_common::era::adapters::EraReaderAdapterType;
use mithril_doc::{Documenter, DocumenterDefault, StructDoc};
use serde::{Deserialize, Serialize};
use std::collections::{BTreeSet, HashMap};
use std::collections::HashMap;
use std::path::PathBuf;
use std::str::FromStr;

use mithril_common::entities::{
CardanoTransactionsSigningConfig, CompressionAlgorithm, HexEncodedGenesisVerificationKey,
ProtocolParameters, SignedEntityType, SignedEntityTypeDiscriminants, TimePoint,
ProtocolParameters, SignedEntityConfig, SignedEntityTypeDiscriminants,
};
use mithril_common::{CardanoNetwork, StdResult};

Expand Down Expand Up @@ -130,7 +130,11 @@ pub struct Configuration {
/// Era reader adapter parameters
pub era_reader_adapter_params: Option<String>,

/// Signed entity types parameters (discriminants names in an ordered comma separated list).
/// Signed entity types parameters (discriminants names in an ordered, case-sensitive, comma
/// separated list).
///
/// The values `MithrilStakeDistribution` and `CardanoImmutableFilesFull` are prepended
/// automatically to the list.
#[example = "`MithrilStakeDistribution,CardanoImmutableFilesFull,CardanoStakeDistribution`"]
pub signed_entity_types: Option<String>,

Expand Down Expand Up @@ -272,57 +276,22 @@ impl Configuration {
.map(|limit| if limit > 3 { limit as u64 } else { 3 })
}

/// Create the deduplicated list of allowed signed entity types discriminants.
///
/// By default, the list contains the MithrilStakeDistribution and the CardanoImmutableFilesFull.
/// The list can be extended with the configuration parameter `signed_entity_types`.
/// The signed entity types are defined in the [SignedEntityTypeDiscriminants] enum.
/// The signed entity types are discarded if they are not declared in the [SignedEntityType] enum.
pub fn list_allowed_signed_entity_types_discriminants(
&self,
) -> StdResult<BTreeSet<SignedEntityTypeDiscriminants>> {
let default_discriminants = BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
]);

let mut all_discriminants = default_discriminants;

let discriminant_names = self.signed_entity_types.clone().unwrap_or_default();
for discriminant in discriminant_names
.split(',')
.filter_map(|name| SignedEntityTypeDiscriminants::from_str(name.trim()).ok())
{
all_discriminants.insert(discriminant);
}

Ok(all_discriminants)
}

/// Create the deduplicated list of allowed signed entity types.
///
/// By default, the list contains the MithrilStakeDistribution and the CardanoImmutableFilesFull.
/// The list can be extended with the configuration parameter `signed_entity_types`.
/// The signed entity types are defined in the [SignedEntityTypeDiscriminants] enum.
/// The signed entity types are discarded if they are not declared in the [SignedEntityType] enum.
pub fn list_allowed_signed_entity_types(
&self,
time_point: &TimePoint,
) -> StdResult<Vec<SignedEntityType>> {
let allowed_discriminants = self.list_allowed_signed_entity_types_discriminants()?;
let signed_entity_types = allowed_discriminants
.into_iter()
.map(|discriminant| {
SignedEntityType::from_time_point(
&discriminant,
&self.network,
time_point,
&self.cardano_transactions_signing_config,
)
})
.collect();

Ok(signed_entity_types)
/// Compute a [SignedEntityConfig] based on this configuration.
pub fn compute_signed_entity_config(&self) -> StdResult<SignedEntityConfig> {
let network = self.get_network()?;
let allowed_discriminants = self
.signed_entity_types
.as_ref()
.map(SignedEntityTypeDiscriminants::parse_list)
.transpose()
.with_context(|| "Invalid 'signed_entity_types' configuration")?
.unwrap_or_default();

Ok(SignedEntityConfig {
allowed_discriminants,
network,
cardano_transactions_signing_config: self.cardano_transactions_signing_config.clone(),
})
}
}

Expand Down Expand Up @@ -509,9 +478,6 @@ impl Source for DefaultConfiguration {

#[cfg(test)]
mod test {
use mithril_common::entities::ChainPoint;
use mithril_common::test_utils::fake_data;

use super::*;

#[test]
Expand Down Expand Up @@ -545,157 +511,6 @@ mod test {
}
}

#[test]
fn test_list_allowed_signed_entity_types_discriminant_without_specific_configuration() {
let config = Configuration {
signed_entity_types: None,
..Configuration::new_sample()
};

let discriminants = config
.list_allowed_signed_entity_types_discriminants()
.unwrap();

assert_eq!(
BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
]),
discriminants
);
}

#[test]
fn test_list_allowed_signed_entity_types_discriminant_should_not_return_unknown_signed_entity_types_in_configuration(
) {
let config = Configuration {
signed_entity_types: Some("Unknown".to_string()),
..Configuration::new_sample()
};

let discriminants = config
.list_allowed_signed_entity_types_discriminants()
.unwrap();

assert_eq!(
BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
]),
discriminants
);
}

#[test]
fn test_list_allowed_signed_entity_types_discriminant_should_not_duplicate_a_signed_entity_discriminant_type_already_in_default_ones(
) {
let config = Configuration {
signed_entity_types: Some(
"CardanoImmutableFilesFull, MithrilStakeDistribution, CardanoImmutableFilesFull"
.to_string(),
),
..Configuration::new_sample()
};

let discriminants = config
.list_allowed_signed_entity_types_discriminants()
.unwrap();

assert_eq!(
BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
]),
discriminants
);
}

#[test]
fn test_list_allowed_signed_entity_types_discriminants_should_add_signed_entity_types_in_configuration_at_the_end(
) {
let config = Configuration {
signed_entity_types: Some("CardanoStakeDistribution, CardanoTransactions".to_string()),
..Configuration::new_sample()
};

let discriminants = config
.list_allowed_signed_entity_types_discriminants()
.unwrap();

assert_eq!(
BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
SignedEntityTypeDiscriminants::CardanoStakeDistribution,
SignedEntityTypeDiscriminants::CardanoTransactions,
]),
discriminants
);
}

#[test]
fn test_list_allowed_signed_entity_types_discriminants_with_multiple_identical_signed_entity_types_in_configuration_should_not_be_added_several_times(
) {
let config = Configuration {
signed_entity_types: Some(
"CardanoStakeDistribution, CardanoStakeDistribution, CardanoStakeDistribution"
.to_string(),
),
..Configuration::new_sample()
};

let discriminants = config
.list_allowed_signed_entity_types_discriminants()
.unwrap();

assert_eq!(
BTreeSet::from([
SignedEntityTypeDiscriminants::MithrilStakeDistribution,
SignedEntityTypeDiscriminants::CardanoStakeDistribution,
SignedEntityTypeDiscriminants::CardanoImmutableFilesFull,
]),
discriminants
);
}

#[test]
fn test_list_allowed_signed_entity_types_with_specific_configuration() {
let beacon = fake_data::beacon();
let chain_point = ChainPoint {
block_number: 45,
..ChainPoint::dummy()
};
let time_point = TimePoint::new(
*beacon.epoch,
beacon.immutable_file_number,
chain_point.clone(),
);

let config = Configuration {
network: beacon.network.clone(),
signed_entity_types: Some("CardanoStakeDistribution, CardanoTransactions".to_string()),
cardano_transactions_signing_config: CardanoTransactionsSigningConfig {
security_parameter: 0,
step: 15,
},
..Configuration::new_sample()
};

let signed_entity_types = config
.list_allowed_signed_entity_types(&time_point)
.unwrap();

assert_eq!(
vec![
SignedEntityType::MithrilStakeDistribution(beacon.epoch),
SignedEntityType::CardanoStakeDistribution(beacon.epoch),
SignedEntityType::CardanoImmutableFilesFull(beacon.clone()),
SignedEntityType::CardanoTransactions(beacon.epoch, chain_point.block_number),
],
signed_entity_types
);
}

#[test]
fn can_build_config_with_ctx_signing_config_from_default_configuration() {
#[derive(Debug, Deserialize)]
Expand Down
Loading
Loading