mithril_common/
lib.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
91
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]

//! Shared datatypes and traits used by Mithril rust projects
//!
//! Provide:
//! - [Digester][digesters] to compute mithril digest from a Cardano database
//! - Helpers for the [Mithril STM](https://mithril.network/rust-doc/mithril_stm/index.html)
//!   lib with the [crypto_helper].
//! - [certificate chain][certificate_chain] used to validate the Certificate Chain created by an aggregator
//! - The [entities] used by, and exchanged between, the aggregator, signers and client.

macro_rules! cfg_fs {
    ($($item:item)*) => {
        $(
            #[cfg(feature = "fs")]
            #[cfg_attr(docsrs, doc(cfg(feature = "fs")))]
            $item
        )*
    }
}

macro_rules! cfg_test_tools {
    ($($item:item)*) => {
        $(
            #[cfg(any(test, feature = "test_tools"))]
            #[cfg_attr(docsrs, doc(cfg(feature = "test_tools")))]
            $item
        )*
    }
}

pub mod api_version;
pub mod certificate_chain;
pub mod chain_observer;
pub mod crypto_helper;
pub mod entities;
#[macro_use]
pub mod era;
pub mod logging;
pub mod messages;
pub mod protocol;
pub mod signable_builder;

cfg_test_tools! {
    pub mod test_utils;
}

cfg_fs! {
    mod ticker_service;
    pub mod digesters;
    pub mod cardano_block_scanner;
    pub mod chain_reader;

    pub use ticker_service::{TickerService, MithrilTickerService};
}

pub use entities::{CardanoNetwork, MagicId};

/// Generic error type
pub type StdError = anyhow::Error;

/// Generic result type
pub type StdResult<T> = anyhow::Result<T, StdError>;

/// Mithril API protocol version header name
pub const MITHRIL_API_VERSION_HEADER: &str = "mithril-api-version";

/// Mithril signer node version header name
pub const MITHRIL_SIGNER_VERSION_HEADER: &str = "signer-node-version";

/// Mithril aggregator node version header name
pub const MITHRIL_AGGREGATOR_VERSION_HEADER: &str = "aggregator-node-version";

#[cfg(test)]
mod tests {
    #[cfg(feature = "apispec")]
    #[test]
    fn test_openapi_examples_conformity() {
        use crate::test_utils::apispec::APISpec;
        let api_spec = APISpec::from_file(&APISpec::get_default_spec_file());

        let errors: Vec<String> = api_spec.verify_examples();

        assert!(
            errors.is_empty(),
            "Errors in examples\n{}",
            errors.join("\n")
        );
    }
}