mithril_aggregator/services/signer_registration/
api.rs

1use async_trait::async_trait;
2
3use mithril_common::{
4    StdResult,
5    entities::{Epoch, Signer, SignerWithStake, StakeDistribution},
6};
7
8use super::SignerRegistrationError;
9
10/// Represents the information needed to handle a signer registration round
11#[derive(Debug, Clone, PartialEq, Eq)]
12pub struct SignerRegistrationRound {
13    /// Registration round epoch
14    pub epoch: Epoch,
15
16    /// Stake distribution
17    pub(super) stake_distribution: StakeDistribution,
18}
19
20#[cfg(test)]
21impl SignerRegistrationRound {
22    pub(crate) fn dummy(epoch: Epoch, stake_distribution: StakeDistribution) -> Self {
23        Self {
24            epoch,
25            stake_distribution,
26        }
27    }
28}
29
30/// Trait to register a signer
31#[cfg_attr(test, mockall::automock)]
32#[async_trait]
33pub trait SignerRegisterer: Sync + Send {
34    /// Register a signer
35    async fn register_signer(
36        &self,
37        epoch: Epoch,
38        signer: &Signer,
39    ) -> Result<SignerWithStake, SignerRegistrationError>;
40
41    /// Get current open round if exists
42    async fn get_current_round(&self) -> Option<SignerRegistrationRound>;
43}
44
45/// Trait to synchronize signers
46#[cfg_attr(test, mockall::automock)]
47#[async_trait]
48pub trait SignerSynchronizer: Sync + Send {
49    /// Check if the signers can be synchronized
50    async fn can_synchronize_signers(&self, epoch: Epoch) -> Result<bool, SignerRegistrationError>;
51
52    /// Synchronize all signers
53    async fn synchronize_all_signers(&self) -> Result<(), SignerRegistrationError>;
54}
55
56/// Trait to open a signer registration round
57#[cfg_attr(test, mockall::automock)]
58#[async_trait]
59pub trait SignerRegistrationRoundOpener: Sync + Send {
60    /// Open a signer registration round
61    async fn open_registration_round(
62        &self,
63        registration_epoch: Epoch,
64        stake_distribution: StakeDistribution,
65    ) -> StdResult<()>;
66
67    /// Close a signer registration round
68    async fn close_registration_round(&self) -> StdResult<()>;
69}
70
71/// Signer recorder trait
72#[cfg_attr(test, mockall::automock)]
73#[async_trait]
74pub trait SignerRecorder: Sync + Send {
75    /// Record a signer registration
76    async fn record_signer_registration(&self, signer_id: String) -> StdResult<()>;
77}
78
79/// A trait for verifying a [Signer] registration.
80#[cfg_attr(test, mockall::automock)]
81#[async_trait]
82pub trait SignerRegistrationVerifier: Send + Sync {
83    /// Verifies a [Signer] registration.
84    async fn verify(
85        &self,
86        signer: &Signer,
87        stake_distribution: &StakeDistribution,
88    ) -> StdResult<SignerWithStake>;
89}
mithril_aggregator/services/signer_registration/api.rs

mithril_aggregator/services/signer_registration/
api.rs
