zebra_network/protocol/external/
types.rs

Help
1use std::{cmp::max, fmt};
2
3use zebra_chain::{
4    block,
5    parameters::{
6        Network::{self, *},
7        NetworkUpgrade::{self, *},
8    },
9};
10
11use crate::constants::{self, CURRENT_NETWORK_PROTOCOL_VERSION};
12
13#[cfg(any(test, feature = "proptest-impl"))]
14use proptest_derive::Arbitrary;
15
16/// A protocol version number.
17#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
18pub struct Version(pub u32);
19
20impl fmt::Display for Version {
21    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
22        f.write_str(&self.0.to_string())
23    }
24}
25
26impl Version {
27    /// Returns the minimum remote node network protocol version for `network` and
28    /// `height`. Zebra disconnects from peers with lower versions.
29    ///
30    /// # Panics
31    ///
32    /// If we are incompatible with our own minimum remote protocol version.
33    pub fn min_remote_for_height(
34        network: &Network,
35        height: impl Into<Option<block::Height>>,
36    ) -> Version {
37        let height = height.into().unwrap_or(block::Height(0));
38        let min_spec = Version::min_specified_for_height(network, height);
39
40        // shut down if our own version is too old
41        assert!(
42            constants::CURRENT_NETWORK_PROTOCOL_VERSION >= min_spec,
43            "Zebra does not implement the minimum specified {:?} protocol version for {:?} at {:?}",
44            NetworkUpgrade::current(network, height),
45            network,
46            height,
47        );
48
49        max(min_spec, Version::initial_min_for_network(network))
50    }
51
52    /// Returns the minimum supported network protocol version for `network`.
53    ///
54    /// This is the minimum peer version when Zebra is significantly behind current tip:
55    /// - during the initial block download,
56    /// - after Zebra restarts, and
57    /// - after Zebra's local network is slow or shut down.
58    fn initial_min_for_network(network: &Network) -> Version {
59        *constants::INITIAL_MIN_NETWORK_PROTOCOL_VERSION
60            .get(&network.kind())
61            .expect("We always have a value for testnet or mainnet")
62    }
63
64    /// Returns the minimum specified network protocol version for `network` and
65    /// `height`.
66    ///
67    /// This is the minimum peer version when Zebra is close to the current tip.
68    fn min_specified_for_height(network: &Network, height: block::Height) -> Version {
69        let network_upgrade = NetworkUpgrade::current(network, height);
70        Version::min_specified_for_upgrade(network, network_upgrade)
71    }
72
73    /// Returns the minimum specified network protocol version for `network` and
74    /// `network_upgrade`.
75    ///
76    /// ## ZIP-253
77    ///
78    /// > Nodes compatible with a network upgrade activation MUST advertise a network protocol
79    /// > version that is greater than or equal to the MIN_NETWORK_PROTOCOL_VERSION for that
80    /// > activation.
81    ///
82    /// <https://zips.z.cash/zip-0253>
83    ///
84    /// ### Notes
85    ///
86    /// - The citation above is a generalization of a statement in ZIP-253 since that ZIP is
87    ///   concerned only with NU6 on Mainnet and Testnet.
88    pub(crate) fn min_specified_for_upgrade(
89        network: &Network,
90        network_upgrade: NetworkUpgrade,
91    ) -> Version {
92        Version(match (network, network_upgrade) {
93            (_, Genesis) | (_, BeforeOverwinter) => 170_002,
94            (Testnet(params), Overwinter) if params.is_default_testnet() => 170_003,
95            (Mainnet, Overwinter) => 170_005,
96            (Testnet(params), Sapling) if params.is_default_testnet() => 170_007,
97            (Testnet(params), Sapling) if params.is_regtest() => 170_006,
98            (Mainnet, Sapling) => 170_007,
99            (Testnet(params), Blossom) if params.is_default_testnet() => 170_008,
100            (Mainnet, Blossom) => 170_009,
101            (Testnet(params), Heartwood) if params.is_default_testnet() => 170_010,
102            (Mainnet, Heartwood) => 170_011,
103            (Testnet(params), Canopy) if params.is_default_testnet() => 170_012,
104            (Mainnet, Canopy) => 170_013,
105            (Testnet(params), Nu5) if params.is_default_testnet() => 170_050,
106            (Mainnet, Nu5) => 170_100,
107            (Testnet(params), Nu6) if params.is_default_testnet() => 170_110,
108            (Mainnet, Nu6) => 170_120,
109            (Testnet(params), Nu6_1) if params.is_default_testnet() => 170_130,
110            (Mainnet, Nu6_1) => 170_140,
111            (Testnet(params), Nu7) if params.is_default_testnet() => 170_150,
112            (Mainnet, Nu7) => 170_160,
113
114            // It should be fine to reject peers with earlier network protocol versions on custom testnets for now.
115            (Testnet(_), _) => CURRENT_NETWORK_PROTOCOL_VERSION.0,
116        })
117    }
118}
119
120bitflags! {
121    /// A bitflag describing services advertised by a node in the network.
122    ///
123    /// Note that bits 24-31 are reserved for temporary experiments; other
124    /// service bits should be allocated via the ZIP process.
125    #[derive(Copy, Clone, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
126    pub struct PeerServices: u64 {
127        /// NODE_NETWORK means that the node is a full node capable of serving
128        /// blocks, as opposed to a light client that makes network requests but
129        /// does not provide network services.
130        const NODE_NETWORK = 1;
131    }
132}
133
134/// A nonce used in the networking layer to identify messages.
135#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
136#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
137pub struct Nonce(pub u64);
138
139impl Default for Nonce {
140    fn default() -> Self {
141        use rand::{thread_rng, Rng};
142        Self(thread_rng().gen())
143    }
144}
145
146/// A random value to add to the seed value in a hash function.
147#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
148#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
149pub struct Tweak(pub u32);
150
151impl Default for Tweak {
152    fn default() -> Self {
153        use rand::{thread_rng, Rng};
154        Self(thread_rng().gen())
155    }
156}
157
158/// A Bloom filter consisting of a bit field of arbitrary byte-aligned
159/// size, maximum size is 36,000 bytes.
160#[derive(Clone, Debug, Eq, PartialEq)]
161#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
162pub struct Filter(pub Vec<u8>);
163
164#[cfg(test)]
165mod test {
166    use super::*;
167
168    #[test]
169    fn version_extremes_mainnet() {
170        version_extremes(&Mainnet)
171    }
172
173    #[test]
174    fn version_extremes_testnet() {
175        version_extremes(&Network::new_default_testnet())
176    }
177
178    /// Test the min_specified_for_upgrade and min_specified_for_height functions for `network` with
179    /// extreme values.
180    fn version_extremes(network: &Network) {
181        let _init_guard = zebra_test::init();
182
183        assert_eq!(
184            Version::min_specified_for_height(network, block::Height(0)),
185            Version::min_specified_for_upgrade(network, BeforeOverwinter),
186        );
187
188        // We assume that the last version we know about continues forever
189        // (even if we suspect that won't be true)
190        assert_ne!(
191            Version::min_specified_for_height(network, block::Height::MAX),
192            Version::min_specified_for_upgrade(network, BeforeOverwinter),
193        );
194    }
195
196    #[test]
197    fn version_consistent_mainnet() {
198        version_consistent(&Mainnet)
199    }
200
201    #[test]
202    fn version_consistent_testnet() {
203        version_consistent(&Network::new_default_testnet())
204    }
205
206    /// Check that the min_specified_for_upgrade and min_specified_for_height functions
207    /// are consistent for `network`.
208    fn version_consistent(network: &Network) {
209        let _init_guard = zebra_test::init();
210
211        let highest_network_upgrade = NetworkUpgrade::current(network, block::Height::MAX);
212        assert!(
213            matches!(highest_network_upgrade, Nu6 | Nu6_1 | Nu7),
214            "expected coverage of all network upgrades: \
215            add the new network upgrade to the list in this test"
216        );
217
218        for &network_upgrade in &[
219            BeforeOverwinter,
220            Overwinter,
221            Sapling,
222            Blossom,
223            Heartwood,
224            Canopy,
225            Nu5,
226            Nu6,
227            Nu6_1,
228            Nu7,
229        ] {
230            let height = network_upgrade.activation_height(network);
231            if let Some(height) = height {
232                assert_eq!(
233                    Version::min_specified_for_upgrade(network, network_upgrade),
234                    Version::min_specified_for_height(network, height)
235                );
236            }
237        }
238    }
239}
zebra_network/protocol/external/types.rs

zebra_network/protocol/external/
types.rs
