mithril_aggregator/database/record/
signer_registration.rs

1use chrono::{DateTime, Utc};
2
3use mithril_common::crypto_helper::KESPeriod;
4use mithril_common::entities::{
5    Epoch, HexEncodedOpCert, HexEncodedVerificationKey, HexEncodedVerificationKeySignature, Signer,
6    SignerWithStake, Stake,
7};
8use mithril_persistence::sqlite::{HydrationError, Projection, SqLiteEntity};
9
10/// SignerRegistration record is the representation of a stored signer_registration.
11#[derive(Debug, PartialEq, Clone)]
12pub struct SignerRegistrationRecord {
13    /// Signer id.
14    pub signer_id: String,
15
16    /// Epoch of creation of the signer_registration.
17    pub epoch_settings_id: Epoch,
18
19    /// Verification key of the signer
20    pub verification_key: HexEncodedVerificationKey,
21
22    /// Signature of the verification key of the signer
23    pub verification_key_signature: Option<HexEncodedVerificationKeySignature>,
24
25    /// Operational certificate of the stake pool operator associated to the signer
26    pub operational_certificate: Option<HexEncodedOpCert>,
27
28    /// The kes period used to compute the verification key signature
29    pub kes_period: Option<KESPeriod>,
30
31    /// The stake associated to the signer
32    pub stake: Option<Stake>,
33
34    /// Date and time when the signer_registration was created
35    pub created_at: DateTime<Utc>,
36}
37
38impl SignerRegistrationRecord {
39    pub(crate) fn from_signer_with_stake(other: SignerWithStake, epoch: Epoch) -> Self {
40        SignerRegistrationRecord {
41            signer_id: other.party_id,
42            epoch_settings_id: epoch,
43            verification_key: other.verification_key.to_json_hex().unwrap(),
44            verification_key_signature: other
45                .verification_key_signature
46                .map(|k| k.to_json_hex().unwrap()),
47            operational_certificate: other
48                .operational_certificate
49                .map(|o| o.to_json_hex().unwrap()),
50            kes_period: other.kes_period,
51            stake: Some(other.stake),
52            created_at: Utc::now(),
53        }
54    }
55}
56
57impl From<SignerRegistrationRecord> for Signer {
58    fn from(other: SignerRegistrationRecord) -> Self {
59        Self {
60            party_id: other.signer_id,
61            verification_key: other.verification_key.try_into().unwrap(),
62            verification_key_signature: other
63                .verification_key_signature
64                .map(|k| (k.try_into().unwrap())),
65            operational_certificate: other
66                .operational_certificate
67                .map(|o| (o.try_into().unwrap())),
68            kes_period: other.kes_period,
69        }
70    }
71}
72
73impl From<SignerRegistrationRecord> for SignerWithStake {
74    fn from(other: SignerRegistrationRecord) -> Self {
75        Self {
76            party_id: other.signer_id,
77            verification_key: other.verification_key.try_into().unwrap(),
78            verification_key_signature: other
79                .verification_key_signature
80                .map(|k| (k.try_into().unwrap())),
81            operational_certificate: other
82                .operational_certificate
83                .map(|o| (o.try_into().unwrap())),
84            kes_period: other.kes_period,
85            stake: other.stake.unwrap_or_default(),
86        }
87    }
88}
89
90impl SqLiteEntity for SignerRegistrationRecord {
91    fn hydrate(row: sqlite::Row) -> Result<Self, HydrationError>
92    where
93        Self: Sized,
94    {
95        let signer_id = row.read::<&str, _>(0).to_string();
96        let epoch_settings_id_int = row.read::<i64, _>(1);
97        let verification_key = row.read::<&str, _>(2).to_string();
98        let verification_key_signature = row.read::<Option<&str>, _>(3).map(|s| s.to_owned());
99        let operational_certificate = row.read::<Option<&str>, _>(4).map(|s| s.to_owned());
100        let kes_period_int = row.read::<Option<i64>, _>(5);
101        let stake_int = row.read::<Option<i64>, _>(6);
102        let created_at = row.read::<&str, _>(7);
103
104        let signer_registration_record = Self {
105            signer_id,
106            epoch_settings_id: Epoch(epoch_settings_id_int.try_into().map_err(|e| {
107                HydrationError::InvalidData(format!(
108                    "Could not cast i64 ({epoch_settings_id_int}) to u64. Error: '{e}'"
109                ))
110            })?),
111            verification_key,
112            verification_key_signature,
113            operational_certificate,
114            kes_period: match kes_period_int {
115                Some(kes_period_int) => Some(kes_period_int.try_into().map_err(|e| {
116                    HydrationError::InvalidData(format!(
117                        "Could not cast i64 ({kes_period_int}) to u64. Error: '{e}'"
118                    ))
119                })?),
120                None => None,
121            },
122            stake: match stake_int {
123                Some(stake_int) => Some(stake_int.try_into().map_err(|e| {
124                    HydrationError::InvalidData(format!(
125                        "Could not cast i64 ({stake_int}) to u64. Error: '{e}'"
126                    ))
127                })?),
128                None => None,
129            },
130            created_at: DateTime::parse_from_rfc3339(created_at)
131                .map_err(|e| {
132                    HydrationError::InvalidData(format!(
133                        "Could not turn string '{created_at}' to rfc3339 Datetime. Error: {e}"
134                    ))
135                })?
136                .with_timezone(&Utc),
137        };
138
139        Ok(signer_registration_record)
140    }
141
142    fn get_projection() -> Projection {
143        let mut projection = Projection::default();
144        projection.add_field("signer_id", "{:signer_registration:}.signer_id", "text");
145        projection.add_field(
146            "epoch_setting_id",
147            "{:signer_registration:}.epoch_setting_id",
148            "integer",
149        );
150        projection.add_field(
151            "verification_key",
152            "{:signer_registration:}.verification_key",
153            "text",
154        );
155        projection.add_field(
156            "verification_key_signature",
157            "{:signer_registration:}.verification_key_signature",
158            "text",
159        );
160        projection.add_field(
161            "operational_certificate",
162            "{:signer_registration:}.operational_certificate",
163            "text",
164        );
165        projection.add_field(
166            "kes_period",
167            "{:signer_registration:}.kes_period",
168            "integer",
169        );
170        projection.add_field("stake", "{:signer_registration:}.stake", "integer");
171        projection.add_field("created_at", "{:signer_registration:}.created_at", "text");
172
173        projection
174    }
175}
176
177#[cfg(test)]
178mod tests {
179    use mithril_common::test_utils::MithrilFixtureBuilder;
180
181    use super::*;
182
183    #[test]
184    fn test_convert_signer_registrations() {
185        let fixture = MithrilFixtureBuilder::default().with_signers(5).build();
186        let signer_with_stakes = fixture.signers_with_stake();
187
188        let mut signer_registration_records: Vec<SignerRegistrationRecord> = Vec::new();
189        for signer_with_stake in signer_with_stakes.clone() {
190            signer_registration_records.push(SignerRegistrationRecord::from_signer_with_stake(
191                signer_with_stake,
192                Epoch(1),
193            ));
194        }
195        let mut signer_with_stakes_new: Vec<SignerWithStake> = Vec::new();
196        for signer_registration_record in signer_registration_records {
197            signer_with_stakes_new.push(signer_registration_record.into());
198        }
199        assert_eq!(signer_with_stakes, signer_with_stakes_new);
200    }
201}
mithril_aggregator/database/record/signer_registration.rs

mithril_aggregator/database/record/
signer_registration.rs
