mithril-client 0.14.5

Mithril client library
Documentation 
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

/// Mithril result type, an alias of [anyhow::Result]
pub type MithrilResult<T> = anyhow::Result<T>;

/// Mithril error type, an alias of [anyhow::Error]
pub type MithrilError = anyhow::Error;

/// A Mithril snapshot of a Cardano Node database.
///
pub use mithril_common::messages::SnapshotMessage as Snapshot;

/// List item of Mithril snapshots
///
pub use mithril_common::messages::SnapshotListItemMessage as SnapshotListItem;

/// A Cardano node database snapshot
///
pub use mithril_common::messages::CardanoDatabaseSnapshotMessage as CardanoDatabaseSnapshot;

/// List items of Cardano node database snapshot
///
pub use mithril_common::messages::CardanoDatabaseSnapshotListItemMessage as CardanoDatabaseSnapshotListItem;

/// A Mithril stake distribution.
///
pub use mithril_common::messages::MithrilStakeDistributionMessage as MithrilStakeDistribution;

/// List item of Mithril stake distributions.
///
pub use mithril_common::messages::MithrilStakeDistributionListItemMessage as MithrilStakeDistributionListItem;

/// A Mithril certificate.
///
pub use mithril_common::messages::CertificateMessage as MithrilCertificate;

pub use mithril_common::messages::CertificateMetadataMessagePart as MithrilCertificateMetadata;

/// List item of Mithril certificates
///
pub use mithril_common::messages::CertificateListItemMessage as MithrilCertificateListItem;

pub use mithril_common::messages::CertificateListItemMessageMetadata as MithrilCertificateListItemMetadata;

/// An individual signer of a [Mithril certificate][MithrilCertificate]
///
pub use mithril_common::messages::SignerWithStakeMessagePart as MithrilSigner;

pub use mithril_common::messages::CardanoTransactionsProofsMessage as CardanoTransactionsProofs;

pub use mithril_common::messages::CardanoTransactionsSetProofMessagePart as CardanoTransactionsSetProof;

cfg_unstable! {
    pub use mithril_common::messages::CardanoTransactionsProofsV2Message as CardanoTransactionsProofsV2;

    pub use mithril_common::messages::CardanoBlocksProofsMessage as CardanoBlocksProofs;

    pub use mithril_common::messages::MkSetProofMessagePart as MkSetProof;

    pub use mithril_common::messages::CardanoBlockMessagePart as CardanoBlock;

    pub use mithril_common::messages::CardanoTransactionMessagePart as CardanoTransaction;

    pub use mithril_common::messages::VerifiedCardanoTransactionsV2;

    pub use mithril_common::messages::VerifiedCardanoBlocks;

    pub use mithril_common::messages::VerifyProofsV2Error;

    pub use mithril_common::messages::CardanoBlocksTransactionsSnapshotMessage as CardanoBlocksTransactionsSnapshot;

    pub use mithril_common::messages::CardanoBlocksTransactionsSnapshotListItemMessage as CardanoBlocksTransactionsSnapshotListItem;
}

pub use mithril_common::messages::VerifiedCardanoTransactions;

pub use mithril_common::messages::VerifyCardanoTransactionsProofsError;

/// A snapshot that allow to know up to which [point of time][common::CardanoDbBeacon] Mithril have certified Cardano transactions.
pub use mithril_common::messages::CardanoTransactionSnapshotMessage as CardanoTransactionSnapshot;

/// List item of a Cardano transaction snapshot.
pub use mithril_common::messages::CardanoTransactionSnapshotListItemMessage as CardanoTransactionSnapshotListItem;

/// A Cardano stake distribution.
pub use mithril_common::messages::CardanoStakeDistributionMessage as CardanoStakeDistribution;

/// List item of Cardano stake distributions.
pub use mithril_common::messages::CardanoStakeDistributionListItemMessage as CardanoStakeDistributionListItem;

/// `mithril-common` re-exports
pub mod common {
    pub use mithril_common::AggregateSignatureType;
    pub use mithril_common::crypto_helper::MKProof;
    pub use mithril_common::entities::{
        AncillaryLocation, BlockHash, BlockNumber, BlockNumberOffset, CardanoDbBeacon,
        CardanoNetwork, ChainPoint, CompressionAlgorithm, DigestLocation, Epoch, EpochSpecifier,
        ImmutableFileNumber, ImmutablesLocation, MagicId, MithrilNetwork, MultiFilesUri,
        ProtocolMessage, ProtocolMessagePartKey, ProtocolParameters, SignedEntityType,
        SignedEntityTypeDiscriminants, SlotNumber, StakeDistribution, SupportedEra, TemplateUri,
        TransactionHash,
    };
    pub use mithril_common::messages::{
        AncillaryMessagePart, DigestsMessagePart, ImmutablesMessagePart,
    };

    /// Test utilities.
    ///
    /// ⚠ Do not use in production code ⚠
    pub mod test {
        pub use mithril_common::test::double::Dummy;
    }
}

/// Required capabilities for an aggregator.
#[cfg(not(target_family = "wasm"))]
pub use mithril_aggregator_discovery::RequiredAggregatorCapabilities;