-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #857 from input-output-hk/greg/848/beacon_message_…
…type embed beacon in open_message type
- Loading branch information
Showing
6 changed files
with
102 additions
and
62 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,97 @@ | ||
| use strum::IntoEnumIterator; | ||
| use strum_macros::{Display, EnumIter, EnumString, FromRepr}; | ||
| use strum_macros::Display; | ||
|
|
||
| use crate::{sqlite::HydrationError, StdError}; | ||
|
|
||
| use super::{Beacon, Epoch}; | ||
|
|
||
| /// Database representation of the SignedEntityType::MithrilStakeDistribution value | ||
| const ENTITY_TYPE_MITHRIL_STAKE_DISTRIBUTION: usize = 0; | ||
|
|
||
| /// Database representation of the SignedEntityType::CardanoStakeDistribution value | ||
| const ENTITY_TYPE_CARDANO_STAKE_DISTRIBUTION: usize = 1; | ||
|
|
||
| /// Database representation of the SignedEntityType::CardanoImmutableFilesFull value | ||
| const ENTITY_TYPE_CARDANO_IMMUTABLE_FILES_FULL: usize = 2; | ||
|
|
||
| /// The signed entity type that represents a type of data signed by the Mithril | ||
| /// protocol Note: Each variant of this enum must be associated to an entry in | ||
| /// the `signed_entity_type` table of the signer/aggregator nodes. The variant | ||
| /// are identified by their discriminant (i.e. index in the enum), thus the | ||
| /// modification of this type should only ever consist of appending new | ||
| /// variants. | ||
| #[derive(Display, FromRepr, EnumString, EnumIter, Debug, Clone, Copy, PartialEq, Eq)] | ||
| #[derive(Display, Debug, Clone, PartialEq, Eq)] | ||
| #[strum(serialize_all = "PascalCase")] | ||
| pub enum SignedEntityType { | ||
| /// Mithril stake distribution | ||
| MithrilStakeDistribution, | ||
| MithrilStakeDistribution(Epoch), | ||
|
|
||
| /// Cardano Stake Distribution | ||
| CardanoStakeDistribution, | ||
| CardanoStakeDistribution(Epoch), | ||
|
|
||
| /// Full Cardano Immutable Files | ||
| CardanoImmutableFilesFull, | ||
| CardanoImmutableFilesFull(Beacon), | ||
| } | ||
|
|
||
| impl SignedEntityType { | ||
| /// Retrieve the list of entity types | ||
| pub fn entity_types() -> Vec<Self> { | ||
| Self::iter().collect() | ||
| } | ||
|
|
||
| /// Retrieve a dummy enty (for test only) | ||
| pub fn dummy() -> Self { | ||
| Self::entity_types().first().unwrap().to_owned() | ||
| Self::MithrilStakeDistribution(Epoch(5)) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
| /// Create an instance from data coming from the database | ||
| pub fn hydrate(signed_entity_type_id: usize, beacon_str: &str) -> Result<Self, HydrationError> { | ||
| let myself = match signed_entity_type_id { | ||
| ENTITY_TYPE_MITHRIL_STAKE_DISTRIBUTION => { | ||
| let epoch: Epoch = serde_json::from_str(beacon_str).map_err(|e| { | ||
| HydrationError::InvalidData(format!( | ||
| "Invalid Epoch JSON representation '{beacon_str}. Error: {e}'." | ||
| )) | ||
| })?; | ||
| Self::MithrilStakeDistribution(epoch) | ||
| } | ||
| ENTITY_TYPE_CARDANO_STAKE_DISTRIBUTION => { | ||
| let epoch: Epoch = serde_json::from_str(beacon_str).map_err(|e| { | ||
| HydrationError::InvalidData(format!( | ||
| "Invalid Epoch JSON representation '{beacon_str}. Error: {e}'." | ||
| )) | ||
| })?; | ||
| Self::CardanoStakeDistribution(epoch) | ||
| } | ||
| ENTITY_TYPE_CARDANO_IMMUTABLE_FILES_FULL => { | ||
| let beacon: Beacon = serde_json::from_str(beacon_str).map_err(|e| { | ||
| HydrationError::InvalidData(format!( | ||
| "Invalid Beacon JSON in open_message.beacon: '{beacon_str}'. Error: {e}" | ||
| )) | ||
| })?; | ||
| Self::CardanoImmutableFilesFull(beacon) | ||
| } | ||
| index => panic!("Invalid entity_type_id {index}."), | ||
| }; | ||
|
|
||
| #[test] | ||
| fn from_repr() { | ||
| let supported_entity_type = SignedEntityType::from_repr(SignedEntityType::dummy() as usize) | ||
| .expect("This signed entity type should support conversion from representation."); | ||
| Ok(myself) | ||
| } | ||
|
|
||
| assert_eq!(SignedEntityType::dummy(), supported_entity_type); | ||
| /// Get the database value from enum's instance | ||
| pub fn index(&self) -> usize { | ||
| match self { | ||
| Self::MithrilStakeDistribution(_) => ENTITY_TYPE_MITHRIL_STAKE_DISTRIBUTION, | ||
| Self::CardanoStakeDistribution(_) => ENTITY_TYPE_CARDANO_STAKE_DISTRIBUTION, | ||
| Self::CardanoImmutableFilesFull(_) => ENTITY_TYPE_CARDANO_IMMUTABLE_FILES_FULL, | ||
| } | ||
| } | ||
|
|
||
| /// Return a JSON serialized value of the internal beacon | ||
| pub fn get_json_beacon(&self) -> Result<String, StdError> { | ||
| let value = match self { | ||
| Self::CardanoImmutableFilesFull(value) => serde_json::to_string(value)?, | ||
| Self::CardanoStakeDistribution(value) | Self::MithrilStakeDistribution(value) => { | ||
| serde_json::to_string(value)? | ||
| } | ||
| }; | ||
|
|
||
| Ok(value) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests {} |