tari_comms 5.3.0-pre.3

A peer-to-peer messaging system
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
116
117
118
119
120
121
122
123
124
125
126
127

//  Copyright 2019 The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! Common Tari comms types

use multiaddr::{Multiaddr, Protocol};
use serde::{Deserialize, Serialize};
use tari_crypto::{
    compressed_key::CompressedKey,
    dhke::DiffieHellmanSharedSecret,
    hash_domain,
    keys::PublicKey,
    ristretto::RistrettoPublicKey,
    signatures::{CompressedSchnorrSignature, SchnorrSignature},
};
use tari_storage::lmdb_store::LMDBStore;

use crate::peer_manager::database::PeerDatabaseSql;

/// Public key type
pub type CommsPublicKey = CompressedKey<RistrettoPublicKey>;
pub type UncompressedCommsPublicKey = RistrettoPublicKey;
pub type CommsSecretKey = <RistrettoPublicKey as PublicKey>::K;

// Diffie-Hellman key exchange type
pub type CommsDHKE = DiffieHellmanSharedSecret<RistrettoPublicKey>;

/// Comms signature type
pub type Signature = SchnorrSignature<RistrettoPublicKey, CommsSecretKey>;
pub type CompressedSignature = CompressedSchnorrSignature<RistrettoPublicKey, CommsSecretKey>;

/// Specify the RNG that should be used for random selection
pub type CommsRng = rand::rngs::OsRng;

/// Datastore and Database used for persistence storage
pub type CommsDataStore = LMDBStore;

pub type CommsDatabase = PeerDatabaseSql;

/// Specify the address protocol
#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
pub enum TransportProtocol {
    Ipv4,
    Ipv6,
    Onion,
    Memory,
}

impl TransportProtocol {
    pub fn get_all() -> Vec<TransportProtocol> {
        vec![
            TransportProtocol::Ipv4,
            TransportProtocol::Ipv6,
            TransportProtocol::Onion,
            TransportProtocol::Memory,
        ]
    }

    pub fn get_prefix(&self) -> &str {
        match self {
            TransportProtocol::Ipv4 => "/ip4",
            TransportProtocol::Ipv6 => "/ip6",
            TransportProtocol::Onion => "/onion",
            TransportProtocol::Memory => "/memory",
        }
    }
}

impl From<Multiaddr> for TransportProtocol {
    fn from(addr: Multiaddr) -> Self {
        match addr.iter().next() {
            Some(Protocol::Ip4(_)) => TransportProtocol::Ipv4,
            Some(Protocol::Ip6(_)) => TransportProtocol::Ipv6,
            Some(Protocol::Onion(_, _)) => TransportProtocol::Onion,
            Some(Protocol::Onion3(_)) => TransportProtocol::Onion,
            Some(Protocol::Memory(_)) => TransportProtocol::Memory,
            _ => TransportProtocol::Ipv4,
        }
    }
}

impl From<&Multiaddr> for TransportProtocol {
    fn from(addr: &Multiaddr) -> Self {
        match addr.iter().next() {
            Some(Protocol::Ip4(_)) => TransportProtocol::Ipv4,
            Some(Protocol::Ip6(_)) => TransportProtocol::Ipv6,
            Some(Protocol::Onion(_, _)) => TransportProtocol::Onion,
            Some(Protocol::Onion3(_)) => TransportProtocol::Onion,
            Some(Protocol::Memory(_)) => TransportProtocol::Memory,
            _ => TransportProtocol::Ipv4,
        }
    }
}

impl From<&Multiaddr> for &TransportProtocol {
    fn from(addr: &Multiaddr) -> Self {
        match addr.iter().next() {
            Some(Protocol::Ip4(_)) => &TransportProtocol::Ipv4,
            Some(Protocol::Ip6(_)) => &TransportProtocol::Ipv6,
            Some(Protocol::Onion(_, _)) => &TransportProtocol::Onion,
            Some(Protocol::Onion3(_)) => &TransportProtocol::Onion,
            Some(Protocol::Memory(_)) => &TransportProtocol::Memory,
            _ => &TransportProtocol::Ipv4,
        }
    }
}

hash_domain!(CommsCoreHashDomain, "com.tari.comms.core", 0);