mithril_common/signable_builder/
interface.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
use async_trait::async_trait;
use std::fmt::Debug;

use crate::{
    entities::{
        BlockNumber, CardanoDatabaseSnapshot, CardanoDbBeacon, CardanoStakeDistribution,
        CardanoTransactionsSnapshot, Epoch, MithrilStakeDistribution, ProtocolMessage,
        ProtocolMessagePartValue, Snapshot,
    },
    StdResult,
};

#[cfg(test)]
use mockall::automock;

/// Beacon trait
pub trait Beacon: Send + Sync {}

/// Artifact is a trait for types that represent signed artifacts
#[cfg_attr(not(target_family = "wasm"), typetag::serde(tag = "type"))]
pub trait Artifact: Debug + Send + Sync {
    /// Get artifact identifier
    fn get_id(&self) -> String;
}

/// SignableBuilder is a trait for building a protocol message for a beacon
#[cfg_attr(test, automock)]
#[async_trait]
pub trait SignableBuilder<U>: Send + Sync
where
    U: Beacon,
{
    /// Compute a protocol message
    async fn compute_protocol_message(&self, beacon: U) -> StdResult<ProtocolMessage>;
}

/// SignableSeedBuilder is a trait for building seed protocol message part values
#[cfg_attr(test, automock)]
#[async_trait]
pub trait SignableSeedBuilder: Send + Sync {
    /// Compute next aggregate verification key protocol message part value
    async fn compute_next_aggregate_verification_key(&self) -> StdResult<ProtocolMessagePartValue>;

    /// Compute next protocol parameters protocol message part value
    async fn compute_next_protocol_parameters(&self) -> StdResult<ProtocolMessagePartValue>;

    /// Compute current epoch protocol message part value
    async fn compute_current_epoch(&self) -> StdResult<ProtocolMessagePartValue>;
}

impl Beacon for BlockNumber {}

impl Beacon for CardanoDbBeacon {}

impl Beacon for Epoch {}

#[cfg_attr(not(target_family = "wasm"), typetag::serde)]
impl Artifact for CardanoDatabaseSnapshot {
    fn get_id(&self) -> String {
        self.hash.clone()
    }
}

#[cfg_attr(not(target_family = "wasm"), typetag::serde)]
impl Artifact for CardanoStakeDistribution {
    fn get_id(&self) -> String {
        self.hash.clone()
    }
}

#[cfg_attr(not(target_family = "wasm"), typetag::serde)]
impl Artifact for CardanoTransactionsSnapshot {
    fn get_id(&self) -> String {
        self.hash.clone()
    }
}

#[cfg_attr(not(target_family = "wasm"), typetag::serde)]
impl Artifact for MithrilStakeDistribution {
    fn get_id(&self) -> String {
        self.hash.clone()
    }
}

#[cfg_attr(not(target_family = "wasm"), typetag::serde)]
impl Artifact for Snapshot {
    fn get_id(&self) -> String {
        self.digest.clone()
    }
}