arc-malachitebft-network 0.7.0-pre

Networking layer for the Malachite BFT consensus engine
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

use core::fmt;

use libp2p::gossipsub;
use libp2p_broadcast as broadcast;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Copy)]
pub struct ChannelNames {
    pub consensus: &'static str,
    pub proposal_parts: &'static str,
    pub sync: &'static str,
    pub liveness: &'static str,
}

impl Default for ChannelNames {
    fn default() -> Self {
        Self {
            consensus: "/consensus",
            proposal_parts: "/proposal_parts",
            sync: "/sync",
            liveness: "/liveness",
        }
    }
}

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Channel {
    Consensus,
    Liveness,
    ProposalParts,
    Sync,
}

impl Channel {
    pub fn all() -> &'static [Channel] {
        &[
            Channel::Consensus,
            Channel::ProposalParts,
            Channel::Sync,
            Channel::Liveness,
        ]
    }

    pub fn consensus() -> &'static [Channel] {
        &[
            Channel::Consensus,
            Channel::ProposalParts,
            Channel::Liveness,
        ]
    }

    pub fn to_gossipsub_topic(self, channel_names: ChannelNames) -> gossipsub::IdentTopic {
        gossipsub::IdentTopic::new(self.as_str(channel_names))
    }

    pub fn to_broadcast_topic(self, channel_names: ChannelNames) -> broadcast::Topic {
        broadcast::Topic::new(self.as_str(channel_names).as_bytes())
    }

    pub fn as_str(&self, channel_names: ChannelNames) -> &'static str {
        match self {
            Channel::Consensus => channel_names.consensus,
            Channel::ProposalParts => channel_names.proposal_parts,
            Channel::Sync => channel_names.sync,
            Channel::Liveness => channel_names.liveness,
        }
    }

    pub fn has_gossipsub_topic(
        topic_hash: &gossipsub::TopicHash,
        channel_names: ChannelNames,
    ) -> bool {
        Self::all()
            .iter()
            .any(|channel| &channel.to_gossipsub_topic(channel_names).hash() == topic_hash)
    }

    pub fn has_broadcast_topic(topic: &broadcast::Topic, channel_names: ChannelNames) -> bool {
        Self::all()
            .iter()
            .any(|channel| &channel.to_broadcast_topic(channel_names) == topic)
    }

    pub fn from_gossipsub_topic_hash(
        topic: &gossipsub::TopicHash,
        channel_names: ChannelNames,
    ) -> Option<Self> {
        if topic == &Self::Consensus.to_gossipsub_topic(channel_names).hash() {
            Some(Self::Consensus)
        } else if topic == &Self::ProposalParts.to_gossipsub_topic(channel_names).hash() {
            Some(Self::ProposalParts)
        } else if topic == &Self::Sync.to_gossipsub_topic(channel_names).hash() {
            Some(Self::Sync)
        } else if topic == &Self::Liveness.to_gossipsub_topic(channel_names).hash() {
            Some(Self::Liveness)
        } else {
            None
        }
    }

    pub fn from_broadcast_topic(
        topic: &broadcast::Topic,
        channel_names: ChannelNames,
    ) -> Option<Self> {
        if topic == &Self::Consensus.to_broadcast_topic(channel_names) {
            Some(Self::Consensus)
        } else if topic == &Self::ProposalParts.to_broadcast_topic(channel_names) {
            Some(Self::ProposalParts)
        } else if topic == &Self::Sync.to_broadcast_topic(channel_names) {
            Some(Self::Sync)
        } else if topic == &Self::Liveness.to_broadcast_topic(channel_names) {
            Some(Self::Liveness)
        } else {
            None
        }
    }
}

impl fmt::Display for Channel {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{self:?}")
    }
}