octo
/
Zebra
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enable `checkpoint_sync` by default (#3777) 

* Enable `checkpoint_sync` by default

Provide fast synchronization by default.

* Add newline to separate fields

Make it slighly easier to read.

* Update `checkpoint_sync` documentation

Change the documentation to match the new default value, and explain
that changing the value can be used for debugging.

* Improve documentation

Remove `post-Canopy`, because Zebra will likely change checkpoint
heights in the future. Also explain better what the checkpoints are and
why it helps with debugging.

Co-authored-by: teor <teor@riseup.net>

Co-authored-by: teor <teor@riseup.net>
This commit is contained in:
Janito Vaqueiro Ferreira Filho 2022-03-08 22:21:54 -03:00 committed by GitHub
parent 44c7b5d2a4
commit a6672aa4b9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
zebra-consensus/src/config.rs
View File

@ -4,14 +4,19 @@ use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields, default)] #[serde(deny_unknown_fields, default)]
pub struct Config { pub struct Config {
/// Should Zebra sync using checkpoints? /// Should Zebra use its optional checkpoints to sync?
/// ///
/// Setting this option to true enables post-Canopy checkpoints. /// This option is `true` by default, and allows for faster chain synchronization.
/// (Zebra always checkpoints up to and including Canopy activation.)
/// ///
/// Future versions of Zebra may change the mandatory checkpoint /// Zebra requires some checkpoints to validate legacy network upgrades.
/// height. /// But it also ships with optional checkpoints, which can be used instead of full block validation.
///
/// Disabling this option makes Zebra start full validation as soon as possible.
/// This helps developers debug Zebra, by running full validation on more blocks.
///
/// Future versions of Zebra may change the required and optional checkpoints.
pub checkpoint_sync: bool, pub checkpoint_sync: bool,
/// Skip the pre-download of Groth16 parameters if this option is true. /// Skip the pre-download of Groth16 parameters if this option is true.
pub debug_skip_parameter_preload: bool, pub debug_skip_parameter_preload: bool,
} }
@ -22,7 +27,7 @@ pub struct Config {
impl Default for Config { impl Default for Config {
fn default() -> Self { fn default() -> Self {
Self { Self {
checkpoint_sync: false, checkpoint_sync: true,
debug_skip_parameter_preload: false, debug_skip_parameter_preload: false,
} }
} }