zebra_network/protocol/external/
types.rs

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() || params.is_regtest() => {
100                170_008
101            }
102            (Mainnet, Blossom) => 170_009,
103            (Testnet(params), Heartwood) if params.is_default_testnet() || params.is_regtest() => {
104                170_010
105            }
106            (Mainnet, Heartwood) => 170_011,
107            (Testnet(params), Canopy) if params.is_default_testnet() || params.is_regtest() => {
108                170_012
109            }
110            (Mainnet, Canopy) => 170_013,
111            (Testnet(params), Nu5) if params.is_default_testnet() || params.is_regtest() => 170_050,
112            (Mainnet, Nu5) => 170_100,
113            (Testnet(params), Nu6) if params.is_default_testnet() || params.is_regtest() => 170_110,
114            (Mainnet, Nu6) => 170_120,
115            (Testnet(params), Nu6_1) if params.is_default_testnet() || params.is_regtest() => {
116                170_130
117            }
118            (Mainnet, Nu6_1) => 170_140,
119            (Testnet(params), Nu7) if params.is_default_testnet() || params.is_regtest() => 170_150,
120            (Mainnet, Nu7) => 170_160,
121
122            // It should be fine to reject peers with earlier network protocol versions on custom testnets for now.
123            (Testnet(_), _) => CURRENT_NETWORK_PROTOCOL_VERSION.0,
124        })
125    }
126}
127
128bitflags! {
129    /// A bitflag describing services advertised by a node in the network.
130    ///
131    /// Note that bits 24-31 are reserved for temporary experiments; other
132    /// service bits should be allocated via the ZIP process.
133    #[derive(Copy, Clone, Debug, Default, Hash, PartialEq, Eq, PartialOrd, Ord)]
134    pub struct PeerServices: u64 {
135        /// NODE_NETWORK means that the node is a full node capable of serving
136        /// blocks, as opposed to a light client that makes network requests but
137        /// does not provide network services.
138        const NODE_NETWORK = 1;
139    }
140}
141
142/// A nonce used in the networking layer to identify messages.
143#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
144#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
145pub struct Nonce(pub u64);
146
147impl Default for Nonce {
148    fn default() -> Self {
149        use rand::{thread_rng, Rng};
150        Self(thread_rng().gen())
151    }
152}
153
154/// A random value to add to the seed value in a hash function.
155#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
156#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
157pub struct Tweak(pub u32);
158
159impl Default for Tweak {
160    fn default() -> Self {
161        use rand::{thread_rng, Rng};
162        Self(thread_rng().gen())
163    }
164}
165
166/// A Bloom filter consisting of a bit field of arbitrary byte-aligned
167/// size, maximum size is 36,000 bytes.
168#[derive(Clone, Debug, Eq, PartialEq)]
169#[cfg_attr(any(test, feature = "proptest-impl"), derive(Arbitrary))]
170pub struct Filter(pub Vec<u8>);
171
172#[cfg(test)]
173mod test {
174    use super::*;
175
176    #[test]
177    fn version_extremes_mainnet() {
178        version_extremes(&Mainnet)
179    }
180
181    #[test]
182    fn version_extremes_testnet() {
183        version_extremes(&Network::new_default_testnet())
184    }
185
186    /// Test the min_specified_for_upgrade and min_specified_for_height functions for `network` with
187    /// extreme values.
188    fn version_extremes(network: &Network) {
189        let _init_guard = zebra_test::init();
190
191        assert_eq!(
192            Version::min_specified_for_height(network, block::Height(0)),
193            Version::min_specified_for_upgrade(network, BeforeOverwinter),
194        );
195
196        // We assume that the last version we know about continues forever
197        // (even if we suspect that won't be true)
198        assert_ne!(
199            Version::min_specified_for_height(network, block::Height::MAX),
200            Version::min_specified_for_upgrade(network, BeforeOverwinter),
201        );
202    }
203
204    #[test]
205    fn version_consistent_mainnet() {
206        version_consistent(&Mainnet)
207    }
208
209    #[test]
210    fn version_consistent_testnet() {
211        version_consistent(&Network::new_default_testnet())
212    }
213
214    /// Check that the min_specified_for_upgrade and min_specified_for_height functions
215    /// are consistent for `network`.
216    fn version_consistent(network: &Network) {
217        let _init_guard = zebra_test::init();
218
219        let highest_network_upgrade = NetworkUpgrade::current(network, block::Height::MAX);
220        assert!(
221            matches!(highest_network_upgrade, Nu6 | Nu6_1 | Nu7),
222            "expected coverage of all network upgrades: \
223            add the new network upgrade to the list in this test"
224        );
225
226        for &network_upgrade in &[
227            BeforeOverwinter,
228            Overwinter,
229            Sapling,
230            Blossom,
231            Heartwood,
232            Canopy,
233            Nu5,
234            Nu6,
235            Nu6_1,
236            Nu7,
237        ] {
238            let height = network_upgrade.activation_height(network);
239            if let Some(height) = height {
240                assert_eq!(
241                    Version::min_specified_for_upgrade(network, network_upgrade),
242                    Version::min_specified_for_height(network, height)
243                );
244            }
245        }
246    }
247}
zebra_network/protocol/external/types.rs

zebra_network/protocol/external/
types.rs
