Updated documentation and removed a debug print

This commit is contained in:
Vladimir Komendantskiy 2018-11-05 14:25:59 +00:00
parent 52cbde42f6
commit f02bbbb9da
3 changed files with 8 additions and 7 deletions

View File

@ -8,12 +8,14 @@
//! batch for each epoch. Each validator proposes one contribution per epoch, and every batch will
//! contain the contributions of at least _N - f_ validators.
//! Epochs are divided into intervals called _eras_ starting at 0. Each following era begins
//! immediately after a batch that
//! Epochs are divided into intervals called _eras_ starting at 0. An era covers the lifetime of
//! exactly one instance of `HoneyBadger`. Each following era begins immediately after a batch that
//!
//! - proposes a change in the set of validators or
//! - proposes a change in the set of validators,
//!
//! - finalizes that proposed change.
//! - finalizes that proposed change or
//!
//! - updates the encryption schedule.
//!
//! Unlike Honey Badger, this algorithm allows dynamically adding and removing validators.
//! As a signal to initiate converting observers to validators or vice versa, it defines a special
@ -43,6 +45,7 @@
//! * promote observer nodes to validators,
//! * demote validator nodes to observers, and
//! * remove observer nodes,
//! * change how frequently nodes use threshold encryption,
//!
//! without interrupting the consensus process.
//!

View File

@ -3,7 +3,6 @@ use std::collections::BTreeMap;
use std::sync::Arc;
use derivative::Derivative;
use log::debug;
use rand::{Rand, Rng};
use serde::{de::DeserializeOwned, Serialize};
@ -164,7 +163,6 @@ where
self.epochs.remove(&self.epoch);
self.epoch += 1;
self.has_input = false;
debug!("Started epoch {:?}", self.epoch);
}
/// Tries to decrypt contributions from all proposers and output those in a batch.

View File

@ -211,7 +211,7 @@ fn do_drop_and_readd(cfg: TestConfig) {
// Examine potential algorithm output.
for batch in step.output {
println!(
"Received epoch {:?} batch on node {:?}.",
"Received epoch {} batch on node {:?}.",
batch.epoch(),
node_id,
);