mithril_common/chain_observer/
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
use crate::{
    crypto_helper::{KESPeriod, OpCert},
    entities::*,
    StdError,
};
use async_trait::async_trait;
use thiserror::Error;

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

use super::{ChainAddress, TxDatum};

/// [ChainObserver] related errors.
#[derive(Debug, Error)]
pub enum ChainObserverError {
    /// Generic [ChainObserver] error.
    #[error("general error")]
    General(#[source] StdError),

    /// Error raised when the content could not be parsed.
    #[error("could not parse content")]
    InvalidContent(#[source] StdError),
}

/// Retrieve data from the cardano network
#[cfg_attr(test, automock)]
#[async_trait]
pub trait ChainObserver: Sync + Send {
    /// Retrieve the datums associated to an address
    async fn get_current_datums(
        &self,
        address: &ChainAddress,
    ) -> Result<Vec<TxDatum>, ChainObserverError>;

    /// Retrieve the current era of the Cardano network
    async fn get_current_era(&self) -> Result<Option<String>, ChainObserverError>;

    /// Retrieve the current epoch of the Cardano network
    async fn get_current_epoch(&self) -> Result<Option<Epoch>, ChainObserverError>;

    /// Retrieve the current chain point of the Cardano network
    async fn get_current_chain_point(&self) -> Result<Option<ChainPoint>, ChainObserverError>;

    /// Retrieve the current stake distribution of the Cardano network
    async fn get_current_stake_distribution(
        &self,
    ) -> Result<Option<StakeDistribution>, ChainObserverError>;

    /// Retrieve the KES period of an operational certificate
    async fn get_current_kes_period(
        &self,
        _opcert: &OpCert,
    ) -> Result<Option<KESPeriod>, ChainObserverError> {
        Ok(None)
    }
}