hopr-types 1.8.0

Complete collection of Rust types used in Hoprnet and other related projects
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

//! This Rust crate contains implementation of common cryptographic types.

/// Contains error enum implementation used across other crypto modules
pub mod errors;
/// Implements [ChainKeypair](keypairs::ChainKeypair) and [OffchainKeypair](keypairs::OffchainKeypair),
/// the important representations of chain key and packet key.
pub mod keypairs;
/// Implementation of the Lioness PRP
#[allow(deprecated)] // Until the dependency updates to newer versions of `generic-array`
pub mod lioness;
/// Re-exports of low-level cryptographic primitives.
pub mod primitives;
/// Enables randomized encryption (sealing)
/// and decryption of data using [`OffchainKeypair`](keypairs::OffchainKeypair).
pub mod seal;
/// Separate module for signature algorithms.
pub mod signing;
/// Implements basic cryptography-related types based on [primitives], such as [Hash](types::Hash)
/// and [PublicKey](types::PublicKey).
pub mod types;
/// Contains small utility functions used in the other crypto modules
pub mod utils;
/// Contains implementation of Verifiable Random Function used in tickets
pub mod vrf;

/// Re-exports from the generic cryptographic traits.
pub mod crypto_traits {
    pub use crate::crypto_random::Randomizable;
    pub use cipher::{
        Block, BlockSizeUser, Iv, IvSizeUser, Key, KeyInit, KeyIvInit, KeySizeUser, StreamCipher,
        StreamCipherSeek,
    };
    pub use digest::{
        Digest, FixedOutput, FixedOutputReset, HashMarker, Output, OutputSizeUser, Update,
    };
    pub use poly1305::universal_hash::UniversalHash;

    /// Pseudo-random permutation (PRP)
    pub trait PRP: BlockSizeUser {
        /// Forward permutation
        fn forward(&self, data: &mut Block<Self>);
        /// Inverse permutation
        fn inverse(&self, data: &mut Block<Self>);
    }
}

#[doc(hidden)]
pub mod prelude {
    pub use libp2p_identity::PeerId;

    pub use super::{
        crypto_traits, errors::CryptoError, keypairs::*, primitives::*, seal::*, signing::*,
        types::*, utils::*, vrf::*,
    };
}