sc_network_common/
sync.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Abstract interfaces and data structures related to network sync.
20
21pub mod message;
22
23/// Sync operation mode.
24#[derive(Copy, Clone, Debug, Eq, PartialEq)]
25pub enum SyncMode {
26	/// Full block download and verification.
27	Full,
28	/// Download blocks and the latest state.
29	LightState {
30		/// Skip state proof download and verification.
31		skip_proofs: bool,
32		/// Download indexed transactions for recent blocks.
33		storage_chain_mode: bool,
34	},
35	/// Warp sync - verify authority set transitions and the latest state.
36	Warp,
37}
38
39impl SyncMode {
40	/// Returns `true` if `self` is [`Self::Warp`].
41	pub fn is_warp(&self) -> bool {
42		matches!(self, Self::Warp)
43	}
44
45	/// Returns `true` if `self` is [`Self::LightState`].
46	pub fn light_state(&self) -> bool {
47		matches!(self, Self::LightState { .. })
48	}
49}
50
51impl Default for SyncMode {
52	fn default() -> Self {
53		Self::Full
54	}
55}
sc_network_common/sync.rs

sc_network_common/
sync.rs
