// This file is part of Substrate. // Copyright (C) Parity Technologies (UK) Ltd. // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see . //! Warp syncing strategy. Bootstraps chain by downloading warp proofs and state. use sc_consensus::IncomingBlock; use sp_consensus::BlockOrigin; use crate::{ block_relay_protocol::{BlockDownloader, BlockResponseError}, service::network::NetworkServiceHandle, strategy::{ chain_sync::validate_blocks, disconnected_peers::DisconnectedPeers, StrategyKey, SyncingAction, }, types::{BadPeer, SyncState, SyncStatus}, LOG_TARGET, }; use codec::{Decode, Encode}; use futures::{channel::oneshot, FutureExt}; use log::{debug, error, trace, warn}; use sc_network::{IfDisconnected, ProtocolName}; use sc_network_common::sync::message::{ BlockAnnounce, BlockAttributes, BlockData, BlockRequest, Direction, FromBlock, }; use sc_network_types::PeerId; use sp_blockchain::HeaderBackend; use sp_runtime::{ traits::{Block as BlockT, Header, NumberFor, Zero}, Justifications, SaturatedConversion, }; use std::{any::Any, collections::HashMap, fmt, sync::Arc}; /// Number of peers that need to be connected before warp sync is started. const MIN_PEERS_TO_START_WARP_SYNC: usize = 3; /// Scale-encoded warp sync proof response. pub struct EncodedProof(pub Vec); /// Warp sync request #[derive(Encode, Decode, Debug, Clone)] pub struct WarpProofRequest { /// Start collecting proofs from this block. pub begin: B::Hash, } /// Verifier for warp sync proofs. Each verifier operates in a specific context. pub trait Verifier: Send + Sync { /// Verify a warp sync proof. fn verify( &mut self, proof: &EncodedProof, ) -> Result, Box>; /// Hash to be used as the starting point for the next proof request. fn next_proof_context(&self) -> Block::Hash; /// Get status text for progress reporting fn status(&self) -> Option; } /// Proof verification result. pub enum VerificationResult { /// Proof is valid, but the target was not reached. Partial(Vec<(Block::Header, Justifications)>), /// Target finality is proved. Complete(Block::Header, Vec<(Block::Header, Justifications)>), } /// Warp sync backend. Handles retrieving and verifying warp sync proofs. pub trait WarpSyncProvider: Send + Sync { /// Generate proof starting at given block hash. The proof is accumulated until maximum proof /// size is reached. fn generate( &self, start: Block::Hash, ) -> Result>; /// Create a verifier for warp sync proofs. fn create_verifier(&self) -> Box>; } mod rep { use sc_network::ReputationChange as Rep; /// Unexpected response received form a peer pub const UNEXPECTED_RESPONSE: Rep = Rep::new(-(1 << 29), "Unexpected response"); /// Peer provided invalid warp proof data pub const BAD_WARP_PROOF: Rep = Rep::new(-(1 << 29), "Bad warp proof"); /// Peer did not provide us with advertised block data. pub const NO_BLOCK: Rep = Rep::new(-(1 << 29), "No requested block data"); /// Reputation change for peers which send us non-requested block data. pub const NOT_REQUESTED: Rep = Rep::new(-(1 << 29), "Not requested block data"); /// Reputation change for peers which send us a block which we fail to verify. pub const VERIFICATION_FAIL: Rep = Rep::new(-(1 << 29), "Block verification failed"); /// We received a message that failed to decode. pub const BAD_MESSAGE: Rep = Rep::new(-(1 << 12), "Bad message"); } /// Reported warp sync phase. #[derive(Clone, Eq, PartialEq, Debug)] pub enum WarpSyncPhase { /// Waiting for peers to connect. AwaitingPeers { required_peers: usize }, /// Downloading and verifying warp proofs. DownloadingWarpProofs, /// Downloading target block. DownloadingTargetBlock, /// Downloading state data. DownloadingState, /// Importing state. ImportingState, /// Downloading block history. DownloadingBlocks(NumberFor), /// Warp sync is complete. Complete, } impl fmt::Display for WarpSyncPhase { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { Self::AwaitingPeers { required_peers } => { write!(f, "Waiting for {required_peers} peers to be connected") }, Self::DownloadingWarpProofs => write!(f, "Downloading finality proofs"), Self::DownloadingTargetBlock => write!(f, "Downloading target block"), Self::DownloadingState => write!(f, "Downloading state"), Self::ImportingState => write!(f, "Importing state"), Self::DownloadingBlocks(n) => write!(f, "Downloading block history (#{})", n), Self::Complete => write!(f, "Warp sync is complete"), } } } /// Reported warp sync progress. #[derive(Clone, Eq, PartialEq, Debug)] pub struct WarpSyncProgress { /// Estimated download percentage. pub phase: WarpSyncPhase, /// Total bytes downloaded so far. pub total_bytes: u64, /// Optional status text from the verifier. pub status: Option, } /// Warp sync configuration as accepted by [`WarpSync`]. pub enum WarpSyncConfig { /// Standard warp sync for the chain. WithProvider(Arc>), /// Skip downloading proofs and use provided header of the state that should be downloaded. /// /// It is expected that the header provider ensures that the header is trusted. WithTarget(::Header), } /// Warp sync phase used by warp sync state machine. enum Phase { /// Waiting for enough peers to connect. WaitingForPeers { warp_sync_provider: Arc> }, /// Downloading warp proofs. WarpProof { verifier: Box> }, /// Downloading target block. TargetBlock(B::Header), /// Warp sync is complete. Complete, } enum PeerState { Available, DownloadingProofs, DownloadingTargetBlock, } impl PeerState { fn is_available(&self) -> bool { matches!(self, PeerState::Available) } } struct Peer { best_number: NumberFor, state: PeerState, } pub struct WarpSyncResult { pub target_header: B::Header, pub target_body: Option>, pub target_justifications: Option, } /// Warp sync state machine. Accumulates warp proofs and state. pub struct WarpSync { phase: Phase, total_proof_bytes: u64, total_state_bytes: u64, peers: HashMap>, disconnected_peers: DisconnectedPeers, protocol_name: Option, block_downloader: Arc>, actions: Vec>, result: Option>, /// Number of peers that need to be connected before warp sync is started. min_peers_to_start_warp_sync: usize, } impl WarpSync where B: BlockT, { /// Strategy key used by warp sync. pub const STRATEGY_KEY: StrategyKey = StrategyKey::new("Warp"); /// Create a new instance. When passing a warp sync provider we will be checking for proof and /// authorities. Alternatively we can pass a target block when we want to skip downloading /// proofs, in this case we will continue polling until the target block is known. pub fn new( client: Arc, warp_sync_config: WarpSyncConfig, protocol_name: Option, block_downloader: Arc>, min_peers_to_start_warp_sync: Option, ) -> Self where Client: HeaderBackend + 'static, { let min_peers_to_start_warp_sync = min_peers_to_start_warp_sync.unwrap_or(MIN_PEERS_TO_START_WARP_SYNC); if client.info().finalized_state.is_some() { error!( target: LOG_TARGET, "Can't use warp sync mode with a partially synced database. Reverting to full sync mode." ); return Self { phase: Phase::Complete, total_proof_bytes: 0, total_state_bytes: 0, peers: HashMap::new(), disconnected_peers: DisconnectedPeers::new(), protocol_name, block_downloader, actions: vec![SyncingAction::Finished], result: None, min_peers_to_start_warp_sync, }; } let phase = match warp_sync_config { WarpSyncConfig::WithProvider(warp_sync_provider) => { Phase::WaitingForPeers { warp_sync_provider } }, WarpSyncConfig::WithTarget(target_header) => Phase::TargetBlock(target_header), }; Self { phase, total_proof_bytes: 0, total_state_bytes: 0, peers: HashMap::new(), disconnected_peers: DisconnectedPeers::new(), protocol_name, block_downloader, actions: Vec::new(), result: None, min_peers_to_start_warp_sync, } } /// Notify that a new peer has connected. pub fn add_peer(&mut self, peer_id: PeerId, _best_hash: B::Hash, best_number: NumberFor) { self.peers.insert(peer_id, Peer { best_number, state: PeerState::Available }); self.try_to_start_warp_sync(); } /// Notify that a peer has disconnected. pub fn remove_peer(&mut self, peer_id: &PeerId) { if let Some(state) = self.peers.remove(peer_id) { if !state.state.is_available() { if let Some(bad_peer) = self.disconnected_peers.on_disconnect_during_request(*peer_id) { self.actions.push(SyncingAction::DropPeer(bad_peer)); } } } } /// Submit a validated block announcement. /// /// Returns new best hash & best number of the peer if they are updated. #[must_use] pub fn on_validated_block_announce( &mut self, is_best: bool, peer_id: PeerId, announce: &BlockAnnounce, ) -> Option<(B::Hash, NumberFor)> { is_best.then(|| { let best_number = *announce.header.number(); let best_hash = announce.header.hash(); if let Some(ref mut peer) = self.peers.get_mut(&peer_id) { peer.best_number = best_number; } // Let `SyncingEngine` know that we should update the peer info. (best_hash, best_number) }) } /// Start warp sync as soon as we have enough peers. fn try_to_start_warp_sync(&mut self) { let Phase::WaitingForPeers { warp_sync_provider } = &self.phase else { return }; if self.peers.len() < self.min_peers_to_start_warp_sync { return; } let verifier = warp_sync_provider.create_verifier(); self.phase = Phase::WarpProof { verifier }; debug!(target: LOG_TARGET, "Started warp sync with {} peers.", self.peers.len()); } pub fn on_generic_response( &mut self, peer_id: &PeerId, protocol_name: ProtocolName, response: Box, ) { if &protocol_name == self.block_downloader.protocol_name() { let Ok(response) = response .downcast::<(BlockRequest, Result>, BlockResponseError>)>() else { warn!(target: LOG_TARGET, "Failed to downcast block response"); debug_assert!(false); return; }; let (request, response) = *response; let blocks = match response { Ok(blocks) => blocks, Err(BlockResponseError::DecodeFailed(e)) => { debug!( target: LOG_TARGET, "Failed to decode block response from peer {:?}: {:?}.", peer_id, e ); self.actions.push(SyncingAction::DropPeer(BadPeer(*peer_id, rep::BAD_MESSAGE))); return; }, Err(BlockResponseError::ExtractionFailed(e)) => { debug!( target: LOG_TARGET, "Failed to extract blocks from peer response {:?}: {:?}.", peer_id, e ); self.actions.push(SyncingAction::DropPeer(BadPeer(*peer_id, rep::BAD_MESSAGE))); return; }, }; self.on_block_response(*peer_id, request, blocks); } else { let Ok(response) = response.downcast::>() else { warn!(target: LOG_TARGET, "Failed to downcast warp sync response"); debug_assert!(false); return; }; self.on_warp_proof_response(peer_id, EncodedProof(*response)); } } /// Process warp proof response. pub fn on_warp_proof_response(&mut self, peer_id: &PeerId, response: EncodedProof) { if let Some(peer) = self.peers.get_mut(peer_id) { peer.state = PeerState::Available; } let Phase::WarpProof { verifier } = &mut self.phase else { debug!(target: LOG_TARGET, "Unexpected warp proof response"); self.actions .push(SyncingAction::DropPeer(BadPeer(*peer_id, rep::UNEXPECTED_RESPONSE))); return; }; let proof_to_incoming_block = |(header, justifications): (B::Header, Justifications)| -> IncomingBlock { IncomingBlock { hash: header.hash(), header: Some(header), body: None, justifications: Some(justifications), origin: Some(*peer_id), // We are still in warp sync, so we don't have the state. This means // we also can't execute the block. allow_missing_state: true, skip_execution: true, // Shouldn't already exist in the database. import_existing: false, state: None, } }; match verifier.verify(&response) { Err(e) => { debug!(target: LOG_TARGET, "Bad warp proof response: {}", e); self.actions .push(SyncingAction::DropPeer(BadPeer(*peer_id, rep::BAD_WARP_PROOF))) }, Ok(VerificationResult::Partial(proofs)) => { debug!(target: LOG_TARGET, "Verified partial proof"); self.total_proof_bytes += response.0.len() as u64; self.actions.push(SyncingAction::ImportBlocks { origin: BlockOrigin::WarpSync, blocks: proofs.into_iter().map(proof_to_incoming_block).collect(), }); }, Ok(VerificationResult::Complete(header, proofs)) => { debug!( target: LOG_TARGET, "Verified complete proof. Continuing with target block download: {} ({}).", header.hash(), header.number(), ); self.total_proof_bytes += response.0.len() as u64; self.phase = Phase::TargetBlock(header.clone()); let incoming_blocks: Vec<_> = proofs .into_iter() .map(proof_to_incoming_block) .filter(|i| { // We need target block with state and warp sync does not provide this. // That's why we filter out target block here, otherwise oncoming state sync // (which comes after warp sync) will abort because target block is already // imported. if header.number() != i.header.as_ref().unwrap().number() { true } else { log::trace!( target: LOG_TARGET, "Filtered out target block: {} ({})", header.hash(), header.number() ); false } }) .collect(); self.actions.push(SyncingAction::ImportBlocks { origin: BlockOrigin::WarpSync, blocks: incoming_blocks, }); }, } } /// Process (target) block response. pub fn on_block_response( &mut self, peer_id: PeerId, request: BlockRequest, blocks: Vec>, ) { if let Err(bad_peer) = self.on_block_response_inner(peer_id, request, blocks) { self.actions.push(SyncingAction::DropPeer(bad_peer)); } } fn on_block_response_inner( &mut self, peer_id: PeerId, request: BlockRequest, mut blocks: Vec>, ) -> Result<(), BadPeer> { if let Some(peer) = self.peers.get_mut(&peer_id) { peer.state = PeerState::Available; } let Phase::TargetBlock(header) = &mut self.phase else { debug!(target: LOG_TARGET, "Unexpected target block response from {peer_id}"); return Err(BadPeer(peer_id, rep::UNEXPECTED_RESPONSE)); }; if blocks.is_empty() { debug!( target: LOG_TARGET, "Downloading target block failed: empty block response from {peer_id}", ); return Err(BadPeer(peer_id, rep::NO_BLOCK)); } if blocks.len() > 1 { debug!( target: LOG_TARGET, "Too many blocks ({}) in warp target block response from {peer_id}", blocks.len(), ); return Err(BadPeer(peer_id, rep::NOT_REQUESTED)); } validate_blocks::(&blocks, &peer_id, Some(request))?; let block = blocks.pop().expect("`blocks` len checked above; qed"); let Some(block_header) = &block.header else { debug!( target: LOG_TARGET, "Downloading target block failed: missing header in response from {peer_id}.", ); return Err(BadPeer(peer_id, rep::VERIFICATION_FAIL)); }; if block_header != header { debug!( target: LOG_TARGET, "Downloading target block failed: different header in response from {peer_id}.", ); return Err(BadPeer(peer_id, rep::VERIFICATION_FAIL)); } if block.body.is_none() { debug!( target: LOG_TARGET, "Downloading target block failed: missing body in response from {peer_id}.", ); return Err(BadPeer(peer_id, rep::VERIFICATION_FAIL)); } self.result = Some(WarpSyncResult { target_header: header.clone(), target_body: block.body, target_justifications: block.justifications, }); self.phase = Phase::Complete; self.actions.push(SyncingAction::Finished); Ok(()) } /// Reserve a peer for a request assigning `new_state`. fn schedule_next_peer( &mut self, new_state: PeerState, min_best_number: Option>, ) -> Option { let mut targets: Vec<_> = self.peers.values().map(|p| p.best_number).collect(); if targets.is_empty() { return None; } targets.sort(); let median = targets[targets.len() / 2]; let threshold = std::cmp::max(median, min_best_number.unwrap_or(Zero::zero())); // Find a random peer that is synced as much as peer majority and is above // `min_best_number`. for (peer_id, peer) in self.peers.iter_mut() { if peer.state.is_available() && peer.best_number >= threshold && self.disconnected_peers.is_peer_available(peer_id) { peer.state = new_state; return Some(*peer_id); } } None } /// Produce warp proof request. fn warp_proof_request(&mut self) -> Option<(PeerId, ProtocolName, WarpProofRequest)> { let Phase::WarpProof { verifier } = &self.phase else { return None }; // Copy verifier context early to cut the borrowing tie. let begin = verifier.next_proof_context(); if self .peers .values() .any(|peer| matches!(peer.state, PeerState::DownloadingProofs)) { // Only one warp proof request at a time is possible. return None; } let peer_id = self.schedule_next_peer(PeerState::DownloadingProofs, None)?; trace!(target: LOG_TARGET, "New WarpProofRequest to {peer_id}, begin hash: {begin}."); let request = WarpProofRequest { begin }; let Some(protocol_name) = self.protocol_name.clone() else { warn!( target: LOG_TARGET, "Trying to send warp sync request when no protocol is configured {request:?}", ); return None; }; Some((peer_id, protocol_name, request)) } /// Produce target block request. fn target_block_request(&mut self) -> Option<(PeerId, BlockRequest)> { let Phase::TargetBlock(target_header) = &self.phase else { return None }; if self .peers .values() .any(|peer| matches!(peer.state, PeerState::DownloadingTargetBlock)) { // Only one target block request at a time is possible. return None; } // Cut the borrowing tie. let target_hash = target_header.hash(); let target_number = *target_header.number(); let peer_id = self.schedule_next_peer(PeerState::DownloadingTargetBlock, Some(target_number))?; trace!( target: LOG_TARGET, "New target block request to {peer_id}, target: {} ({}).", target_hash, target_number, ); Some(( peer_id, BlockRequest:: { id: 0, fields: BlockAttributes::HEADER | BlockAttributes::BODY | BlockAttributes::JUSTIFICATION, from: FromBlock::Hash(target_hash), direction: Direction::Ascending, max: Some(1), }, )) } /// Returns warp sync estimated progress (stage, bytes received). pub fn progress(&self) -> WarpSyncProgress { match &self.phase { Phase::WaitingForPeers { .. } => WarpSyncProgress { phase: WarpSyncPhase::AwaitingPeers { required_peers: self.min_peers_to_start_warp_sync, }, total_bytes: self.total_proof_bytes, status: None, }, Phase::WarpProof { verifier } => WarpSyncProgress { phase: WarpSyncPhase::DownloadingWarpProofs, total_bytes: self.total_proof_bytes, status: verifier.status(), }, Phase::TargetBlock(_) => WarpSyncProgress { phase: WarpSyncPhase::DownloadingTargetBlock, total_bytes: self.total_proof_bytes, status: None, }, Phase::Complete => WarpSyncProgress { phase: WarpSyncPhase::Complete, total_bytes: self.total_proof_bytes + self.total_state_bytes, status: None, }, } } /// Get the number of peers known to warp sync. pub fn num_peers(&self) -> usize { self.peers.len() } /// Returns the current sync status. pub fn status(&self) -> SyncStatus { SyncStatus { state: match &self.phase { Phase::WaitingForPeers { .. } => SyncState::Downloading { target: Zero::zero() }, Phase::WarpProof { .. } => SyncState::Downloading { target: Zero::zero() }, Phase::TargetBlock(header) => SyncState::Downloading { target: *header.number() }, Phase::Complete => SyncState::Idle, }, best_seen_block: match &self.phase { Phase::WaitingForPeers { .. } => None, Phase::WarpProof { .. } => None, Phase::TargetBlock(header) => Some(*header.number()), Phase::Complete => None, }, num_peers: self.peers.len().saturated_into(), queued_blocks: 0, state_sync: None, warp_sync: Some(self.progress()), } } /// Get actions that should be performed by the owner on [`WarpSync`]'s behalf #[must_use] pub fn actions( &mut self, network_service: &NetworkServiceHandle, ) -> impl Iterator> { let warp_proof_request = self.warp_proof_request().into_iter().map(|(peer_id, protocol_name, request)| { trace!( target: LOG_TARGET, "Created `WarpProofRequest` to {}, request: {:?}.", peer_id, request, ); let (tx, rx) = oneshot::channel(); network_service.start_request( peer_id, protocol_name, request.encode(), tx, IfDisconnected::ImmediateError, ); SyncingAction::StartRequest { peer_id, key: Self::STRATEGY_KEY, request: async move { Ok(rx.await?.and_then(|(response, protocol_name)| { Ok((Box::new(response) as Box, protocol_name)) })) } .boxed(), } }); self.actions.extend(warp_proof_request); let target_block_request = self.target_block_request().into_iter().map(|(peer_id, request)| { let downloader = self.block_downloader.clone(); SyncingAction::StartRequest { peer_id, key: Self::STRATEGY_KEY, request: async move { Ok(downloader.download_blocks(peer_id, request.clone()).await?.and_then( |(response, protocol_name)| { let decoded_response = downloader.block_response_into_blocks(&request, response); let result = Box::new((request, decoded_response)) as Box; Ok((result, protocol_name)) }, )) } .boxed(), } }); self.actions.extend(target_block_request); std::mem::take(&mut self.actions).into_iter() } /// Take the result of finished warp sync, returning `None` if the sync was unsuccessful. #[must_use] pub fn take_result(&mut self) -> Option> { self.result.take() } } #[cfg(test)] mod test { use super::*; use crate::{mock::MockBlockDownloader, service::network::NetworkServiceProvider}; use sc_block_builder::BlockBuilderBuilder; use sp_blockchain::{BlockStatus, Error as BlockchainError, HeaderBackend, Info}; use sp_core::H256; use sp_runtime::{ traits::{Block as BlockT, Header as HeaderT, NumberFor}, ConsensusEngineId, }; use std::{io::ErrorKind, sync::Arc}; use substrate_test_runtime_client::{ runtime::{Block, Hash}, BlockBuilderExt, DefaultTestClientBuilderExt, TestClientBuilder, TestClientBuilderExt, }; pub const TEST_ENGINE_ID: ConsensusEngineId = *b"TEST"; mockall::mock! { pub Client {} impl HeaderBackend for Client { fn header(&self, hash: B::Hash) -> Result, BlockchainError>; fn info(&self) -> Info; fn status(&self, hash: B::Hash) -> Result; fn number( &self, hash: B::Hash, ) -> Result::Header as HeaderT>::Number>, BlockchainError>; fn hash(&self, number: NumberFor) -> Result, BlockchainError>; } } mockall::mock! { pub WarpSyncProvider {} impl super::WarpSyncProvider for WarpSyncProvider { fn generate( &self, start: B::Hash, ) -> Result>; fn create_verifier(&self) -> Box>; } } mockall::mock! { pub Verifier {} impl super::Verifier for Verifier { fn verify( &mut self, proof: &EncodedProof, ) -> Result, Box>; fn next_proof_context(&self) -> B::Hash; fn status(&self) -> Option; } } fn mock_client_with_state() -> MockClient { let mut client = MockClient::::new(); let genesis_hash = Hash::random(); client.expect_info().return_once(move || Info { best_hash: genesis_hash, best_number: 0, genesis_hash, finalized_hash: genesis_hash, finalized_number: 0, // We need some finalized state to render warp sync impossible. finalized_state: Some((genesis_hash, 0)), number_leaves: 0, block_gap: None, }); client } fn mock_client_without_state() -> MockClient { let mut client = MockClient::::new(); let genesis_hash = Hash::random(); client.expect_info().returning(move || Info { best_hash: genesis_hash, best_number: 0, genesis_hash, finalized_hash: genesis_hash, finalized_number: 0, finalized_state: None, number_leaves: 0, block_gap: None, }); client } #[test] fn warp_sync_with_provider_for_db_with_finalized_state_is_noop() { let client = mock_client_with_state(); let provider = MockWarpSyncProvider::::new(); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // Warp sync instantly finishes let actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); assert!(matches!(actions[0], SyncingAction::Finished)); // ... with no result. assert!(warp_sync.take_result().is_none()); } #[test] fn warp_sync_to_target_for_db_with_finalized_state_is_noop() { let client = mock_client_with_state(); let config = WarpSyncConfig::WithTarget(::Header::new( 1, Default::default(), Default::default(), Default::default(), Default::default(), )); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // Warp sync instantly finishes let actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); assert!(matches!(actions[0], SyncingAction::Finished)); // ... with no result. assert!(warp_sync.take_result().is_none()); } #[test] fn warp_sync_with_provider_for_empty_db_doesnt_finish_instantly() { let client = mock_client_without_state(); let provider = MockWarpSyncProvider::::new(); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // No actions are emitted. assert_eq!(warp_sync.actions(&network_handle).count(), 0) } #[test] fn warp_sync_to_target_for_empty_db_doesnt_finish_instantly() { let client = mock_client_without_state(); let config = WarpSyncConfig::WithTarget(::Header::new( 1, Default::default(), Default::default(), Default::default(), Default::default(), )); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // No actions are emitted. assert_eq!(warp_sync.actions(&network_handle).count(), 0) } #[test] fn warp_sync_is_started_only_when_there_is_enough_peers() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); // Warp sync is not started when there is not enough peers. for _ in 0..(MIN_PEERS_TO_START_WARP_SYNC - 1) { warp_sync.add_peer(PeerId::random(), Hash::random(), 10); assert!(matches!(warp_sync.phase, Phase::WaitingForPeers { .. })) } // Now we have enough peers and warp sync is started. warp_sync.add_peer(PeerId::random(), Hash::random(), 10); assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })) } #[test] fn no_peer_is_scheduled_if_no_peers_connected() { let client = mock_client_without_state(); let provider = MockWarpSyncProvider::::new(); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); assert!(warp_sync.schedule_next_peer(PeerState::DownloadingProofs, None).is_none()); } #[test] fn enough_peers_are_used_in_tests() { // Tests below use 10 peers. Fail early if it's less than a threshold for warp sync. assert!( 10 >= MIN_PEERS_TO_START_WARP_SYNC, "Tests must be updated to use that many initial peers.", ); } #[test] fn at_least_median_synced_peer_is_scheduled() { for _ in 0..100 { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } let peer_id = warp_sync.schedule_next_peer(PeerState::DownloadingProofs, None); assert!(warp_sync.peers.get(&peer_id.unwrap()).unwrap().best_number >= 6); } } #[test] fn min_best_number_peer_is_scheduled() { for _ in 0..10 { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } let peer_id = warp_sync.schedule_next_peer(PeerState::DownloadingProofs, Some(10)); assert!(warp_sync.peers.get(&peer_id.unwrap()).unwrap().best_number == 10); } } #[test] fn backedoff_number_peer_is_not_scheduled() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } let ninth_peer = *warp_sync.peers.iter().find(|(_, state)| state.best_number == 9).unwrap().0; let tenth_peer = *warp_sync.peers.iter().find(|(_, state)| state.best_number == 10).unwrap().0; // Disconnecting a peer without an inflight request has no effect on persistent states. warp_sync.remove_peer(&tenth_peer); assert!(warp_sync.disconnected_peers.is_peer_available(&tenth_peer)); warp_sync.add_peer(tenth_peer, H256::random(), 10); let peer_id = warp_sync.schedule_next_peer(PeerState::DownloadingProofs, Some(10)); assert_eq!(tenth_peer, peer_id.unwrap()); warp_sync.remove_peer(&tenth_peer); // Peer is backed off. assert!(!warp_sync.disconnected_peers.is_peer_available(&tenth_peer)); // No peer available for 10'th best block because of the backoff. warp_sync.add_peer(tenth_peer, H256::random(), 10); let peer_id: Option = warp_sync.schedule_next_peer(PeerState::DownloadingProofs, Some(10)); assert!(peer_id.is_none()); // Other requests can still happen. let peer_id: Option = warp_sync.schedule_next_peer(PeerState::DownloadingProofs, Some(9)); assert_eq!(ninth_peer, peer_id.unwrap()); } #[test] fn no_warp_proof_request_in_another_phase() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set to another phase. warp_sync.phase = Phase::TargetBlock(::Header::new( 1, Default::default(), Default::default(), Default::default(), Default::default(), )); // No request is made. assert!(warp_sync.warp_proof_request().is_none()); } #[test] fn warp_proof_request_starts_at_last_hash() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let known_last_hash = Hash::random(); verifier.expect_next_proof_context().returning(move || known_last_hash); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); let (_peer_id, _protocol_name, request) = warp_sync.warp_proof_request().unwrap(); assert_eq!(request.begin, known_last_hash); } #[test] fn no_parallel_warp_proof_requests() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make requests. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); // First request is made. assert!(warp_sync.warp_proof_request().is_some()); // Second request is not made. assert!(warp_sync.warp_proof_request().is_none()); } #[test] fn bad_warp_proof_response_drops_peer() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); // Warp proof verification fails. verifier.expect_verify().return_once(|_proof| { Err(Box::new(std::io::Error::new(ErrorKind::Other, "test-verification-failure"))) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // Consume `SendWarpProofRequest` action. let actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); let SyncingAction::StartRequest { peer_id: request_peer_id, .. } = actions[0] else { panic!("Invalid action"); }; warp_sync.on_warp_proof_response(&request_peer_id, EncodedProof(Vec::new())); // We only interested in already generated actions, not new requests. let actions = std::mem::take(&mut warp_sync.actions); assert_eq!(actions.len(), 1); assert!(matches!( actions[0], SyncingAction::DropPeer(BadPeer(peer_id, _rep)) if peer_id == request_peer_id )); assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); } #[test] fn partial_warp_proof_doesnt_advance_phase() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let target_header = target_block.header().clone(); let justifications = Justifications::new(vec![(TEST_ENGINE_ID, vec![1, 2, 3, 4, 5])]); // Warp proof is partial. let mut verifier = MockVerifier::::new(); let context = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || context); let header_for_verify = target_header.clone(); let just_for_verify = justifications.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Partial(vec![( header_for_verify.clone(), just_for_verify.clone(), )])) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( client, config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // Consume `SendWarpProofRequest` action. let actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); let SyncingAction::StartRequest { peer_id: request_peer_id, .. } = actions[0] else { panic!("Invalid action"); }; warp_sync.on_warp_proof_response(&request_peer_id, EncodedProof(Vec::new())); assert_eq!(warp_sync.actions.len(), 1); let SyncingAction::ImportBlocks { origin, mut blocks } = warp_sync.actions.pop().unwrap() else { panic!("Expected `ImportBlocks` action."); }; assert_eq!(origin, BlockOrigin::WarpSync); assert_eq!(blocks.len(), 1); let import_block = blocks.pop().unwrap(); assert_eq!( import_block, IncomingBlock { hash: target_header.hash(), header: Some(target_header), body: None, justifications: Some(justifications), origin: Some(request_peer_id), allow_missing_state: true, skip_execution: true, import_existing: false, state: None, } ); assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); } #[test] fn complete_warp_proof_advances_phase() { use crate::{pending_responses::PendingResponses, service::network::ToServiceCommand}; use futures::{executor::block_on, StreamExt}; // Initialize logging sp_tracing::try_init_simple(); let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); // Building both blocks manually. Can't use BlockBuilderBuilder to build one block on top of // another, if no genesis is set (required for warp sync to make sure finalized_state is not // set) let warp_synced_header = <::Header as HeaderT>::new( 1, Default::default(), Default::default(), client.chain_info().best_hash, Default::default(), ); // Build target_block on top of warp_synced_block let target_header = <::Header as HeaderT>::new( 2, Default::default(), Default::default(), warp_synced_header.hash(), Default::default(), ); let warp_justifications = Justifications::new(vec![(TEST_ENGINE_ID, vec![1, 2, 3, 4, 5])]); let target_justifications = Justifications::new(vec![(TEST_ENGINE_ID, vec![6, 7, 8, 9, 10])]); // Warp proof is complete and contains both blocks. let mut verifier = MockVerifier::::new(); let context = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || context); let warp_synced_header_for_verify = warp_synced_header.clone(); let warp_just_for_verify = warp_justifications.clone(); let target_header_for_verify = target_header.clone(); let target_just_for_verify = target_justifications.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete( target_header_for_verify.clone(), vec![ (warp_synced_header_for_verify, warp_just_for_verify), (target_header_for_verify, target_just_for_verify), ], )) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( client, config, Some(ProtocolName::Static("")), Arc::new(MockBlockDownloader::new()), Some(1), ); // One peer must serve both the proof and the subsequent target-block request. let peer_id = PeerId::random(); warp_sync.add_peer(peer_id, Hash::random(), 10); assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); let (tx, mut rx) = sc_utils::mpsc::tracing_unbounded("warp_test", 10); let network_handle = NetworkServiceHandle::new(tx); let mut pending = PendingResponses::new(); let mut actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); let SyncingAction::StartRequest { peer_id: request_peer_id, key, request } = actions.pop().unwrap() else { panic!("Expected warp proof request."); }; assert_eq!(request_peer_id, peer_id); pending.insert(request_peer_id, key, request); let ToServiceCommand::StartRequest(_, protocol, _, response_tx, _) = block_on(rx.next()).unwrap() else { panic!("Expected network request."); }; response_tx.send(Ok((Vec::new(), protocol))).unwrap(); let event = block_on(pending.next()).unwrap(); // Receiving the proof already frees this peer's request slot. assert_eq!(pending.len(), 0); let (response, _) = event.response.unwrap().unwrap(); warp_sync.on_warp_proof_response( &event.peer_id, EncodedProof(*response.downcast::>().unwrap()), ); assert_eq!(warp_sync.actions.len(), 1); let SyncingAction::ImportBlocks { origin, mut blocks } = warp_sync.actions.pop().unwrap() else { panic!("Expected `ImportBlocks` action."); }; assert_eq!(origin, BlockOrigin::WarpSync); // Only warp_synced_block should be in the import list; target_block is filtered out assert_eq!(blocks.len(), 1); let import_block = blocks.pop().unwrap(); assert_eq!( import_block, IncomingBlock { hash: warp_synced_header.hash(), header: Some(warp_synced_header), body: None, justifications: Some(warp_justifications), origin: Some(request_peer_id), allow_missing_state: true, skip_execution: true, import_existing: false, state: None, } ); assert!(matches!(&warp_sync.phase, Phase::TargetBlock(header) if *header == target_header)); let mut actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); let SyncingAction::StartRequest { peer_id: target_peer, key, request } = actions.pop().unwrap() else { panic!("Expected target block request."); }; assert_eq!(target_peer, request_peer_id); // No explicit cancellation or implicit removal is needed between these requests. pending.insert(target_peer, key, request); assert_eq!(pending.len(), 1); assert_eq!(warp_sync.actions(&network_handle).count(), 0); } #[test] fn no_target_block_requests_in_another_phase() { let client = mock_client_without_state(); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); verifier.expect_next_proof_context().returning(|| Hash::random()); verifier .expect_verify() .returning(|_| unreachable!("verify should not be called in this test")); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new( Arc::new(client), config, None, Arc::new(MockBlockDownloader::new()), None, ); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // We are not in `Phase::TargetBlock` assert!(matches!(warp_sync.phase, Phase::WarpProof { .. })); // No request is made. assert!(warp_sync.target_block_request().is_none()); } #[test] fn target_block_request_is_correct() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); let (_peer_id, request) = warp_sync.target_block_request().unwrap(); assert_eq!(request.from, FromBlock::Hash(target_block.header().hash())); assert_eq!( request.fields, BlockAttributes::HEADER | BlockAttributes::BODY | BlockAttributes::JUSTIFICATION ); assert_eq!(request.max, Some(1)); } #[test] fn externally_set_target_block_is_requested() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let target_header = target_block.header().clone(); let config = WarpSyncConfig::WithTarget(target_header); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } assert!(matches!(warp_sync.phase, Phase::TargetBlock(_))); let (_peer_id, request) = warp_sync.target_block_request().unwrap(); assert_eq!(request.from, FromBlock::Hash(target_block.header().hash())); assert_eq!( request.fields, BlockAttributes::HEADER | BlockAttributes::BODY | BlockAttributes::JUSTIFICATION ); assert_eq!(request.max, Some(1)); } #[test] fn no_parallel_target_block_requests() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); // First target block request is made. assert!(warp_sync.target_block_request().is_some()); // No parallel request is made. assert!(warp_sync.target_block_request().is_none()); } #[test] fn target_block_response_with_no_blocks_drops_peer() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); let (peer_id, request) = warp_sync.target_block_request().unwrap(); // Empty block response received. let response = Vec::new(); // Peer is dropped. assert!(matches!( warp_sync.on_block_response_inner(peer_id, request, response), Err(BadPeer(id, _rep)) if id == peer_id, )); } #[test] fn target_block_response_with_extra_blocks_drops_peer() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let mut extra_block_builder = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap(); extra_block_builder .push_storage_change(vec![1, 2, 3], Some(vec![4, 5, 6])) .unwrap(); let extra_block = extra_block_builder.build().unwrap().block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); let (peer_id, request) = warp_sync.target_block_request().unwrap(); // Block response with extra blocks received. let response = vec![ BlockData:: { hash: target_block.header().hash(), header: Some(target_block.header().clone()), body: Some(target_block.extrinsics().iter().cloned().collect::>()), receipt: None, message_queue: None, justification: None, justifications: None, }, BlockData:: { hash: extra_block.header().hash(), header: Some(extra_block.header().clone()), body: Some(extra_block.extrinsics().iter().cloned().collect::>()), receipt: None, message_queue: None, justification: None, justifications: None, }, ]; // Peer is dropped. assert!(matches!( warp_sync.on_block_response_inner(peer_id, request, response), Err(BadPeer(id, _rep)) if id == peer_id, )); } #[test] fn target_block_response_with_wrong_block_drops_peer() { sp_tracing::try_init_simple(); let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let target_block = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap() .build() .unwrap() .block; let mut wrong_block_builder = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap(); wrong_block_builder .push_storage_change(vec![1, 2, 3], Some(vec![4, 5, 6])) .unwrap(); let wrong_block = wrong_block_builder.build().unwrap().block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); let (peer_id, request) = warp_sync.target_block_request().unwrap(); // Wrong block received. let response = vec![BlockData:: { hash: wrong_block.header().hash(), header: Some(wrong_block.header().clone()), body: Some(wrong_block.extrinsics().iter().cloned().collect::>()), receipt: None, message_queue: None, justification: None, justifications: None, }]; // Peer is dropped. assert!(matches!( warp_sync.on_block_response_inner(peer_id, request, response), Err(BadPeer(id, _rep)) if id == peer_id, )); } #[test] fn correct_target_block_response_sets_strategy_result() { let client = Arc::new(TestClientBuilder::new().set_no_genesis().build()); let mut provider = MockWarpSyncProvider::::new(); let mut verifier = MockVerifier::::new(); let header_for_ctx = client.info().genesis_hash; verifier.expect_next_proof_context().returning(move || header_for_ctx); let mut target_block_builder = BlockBuilderBuilder::new(&*client) .on_parent_block(client.chain_info().best_hash) .with_parent_block_number(client.chain_info().best_number) .build() .unwrap(); target_block_builder .push_storage_change(vec![1, 2, 3], Some(vec![4, 5, 6])) .unwrap(); let target_block = target_block_builder.build().unwrap().block; let target_header = target_block.header().clone(); // Warp proof is complete. let header_for_verify = target_header.clone(); verifier.expect_verify().return_once(move |_proof| { Ok(VerificationResult::Complete(header_for_verify, Default::default())) }); provider.expect_create_verifier().return_once(move || Box::new(verifier)); let config = WarpSyncConfig::WithProvider(Arc::new(provider)); let mut warp_sync = WarpSync::new(client, config, None, Arc::new(MockBlockDownloader::new()), None); // Make sure we have enough peers to make a request. for best_number in 1..11 { warp_sync.add_peer(PeerId::random(), Hash::random(), best_number); } // Manually set `TargetBlock` phase. warp_sync.phase = Phase::TargetBlock(target_block.header().clone()); let (peer_id, request) = warp_sync.target_block_request().unwrap(); // Correct block received. let body = Some(target_block.extrinsics().iter().cloned().collect::>()); let justifications = Some(Justifications::from((*b"FRNK", Vec::new()))); let response = vec![BlockData:: { hash: target_block.header().hash(), header: Some(target_block.header().clone()), body: body.clone(), receipt: None, message_queue: None, justification: None, justifications: justifications.clone(), }]; assert!(warp_sync.on_block_response_inner(peer_id, request, response).is_ok()); let network_provider = NetworkServiceProvider::new(); let network_handle = network_provider.handle(); // Strategy finishes. let actions = warp_sync.actions(&network_handle).collect::>(); assert_eq!(actions.len(), 1); assert!(matches!(actions[0], SyncingAction::Finished)); // With correct result. let result = warp_sync.take_result().unwrap(); assert_eq!(result.target_header, *target_block.header()); assert_eq!(result.target_body, body); assert_eq!(result.target_justifications, justifications); } }