Mod docs for light client: mention warp sync

ordian · Jun 6, 2018 · 3dbe8b9 · 3dbe8b9
1 parent 22feaed
commit 3dbe8b9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/ethcore/sync/src/light_sync/mod.rs b/ethcore/sync/src/light_sync/mod.rs
@@ -31,6 +31,10 @@
 //! - When within a certain distance of the head of the chain, aggressively download all
 //!   announced blocks.
 //! - On bad block/response, punish peer and reset.
+//!
+//! When `warp_sync` is enabled (by default), a light client will first try to
+//! sync using snapshots. If a client fails to get a snapshot manifest within a certain period of time,
+//! it will fall back to normal sync.
 
 use std::collections::{HashMap, HashSet};
 use std::mem;