Candidate agreement "glue" code

candidate-agreement/Cargo.toml

@@ -4,5 +4,6 @@ version = "0.1.0"
 authors = ["Parity Technologies <[email protected]>"]
 
 [dependencies]
-futures = "0.1"
-polkadot-primitives = { path = "../primitives" }
+futures = "0.1.17"
+parking_lot = "0.4"
+tokio-timer = "0.1.2"

candidate-agreement/src/bft/accumulator.rs

@@ -117,37 +117,37 @@ struct VoteCounts {
 
 /// Accumulates messages for a given round of BFT consensus.
 ///
-/// This isn't tied to the "view" of a single validator. It
+/// This isn't tied to the "view" of a single authority. It
 /// keeps accurate track of the state of the BFT consensus based
 /// on all messages imported.
 #[derive(Debug)]
-pub struct Accumulator<Candidate, Digest, ValidatorId, Signature>
+pub struct Accumulator<Candidate, Digest, AuthorityId, Signature>
  where
  Candidate: Eq + Clone,
  Digest: Hash + Eq + Clone,
- ValidatorId: Hash + Eq,
+ AuthorityId: Hash + Eq,
  Signature: Eq + Clone,
 {
  round_number: usize,
  threshold: usize,
- round_proposer: ValidatorId,
+ round_proposer: AuthorityId,
  proposal: Option<Candidate>,
- prepares: HashMap<ValidatorId, (Digest, Signature)>,
- commits: HashMap<ValidatorId, (Digest, Signature)>,
+ prepares: HashMap<AuthorityId, (Digest, Signature)>,
+ commits: HashMap<AuthorityId, (Digest, Signature)>,
  vote_counts: HashMap<Digest, VoteCounts>,
- advance_round: HashSet<ValidatorId>,
+ advance_round: HashSet<AuthorityId>,
  state: State<Candidate, Digest, Signature>,
 }
 
-impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, ValidatorId, Signature>
+impl<Candidate, Digest, AuthorityId, Signature> Accumulator<Candidate, Digest, AuthorityId, Signature>
  where
  Candidate: Eq + Clone,
  Digest: Hash + Eq + Clone,
- ValidatorId: Hash + Eq,
+ AuthorityId: Hash + Eq,
  Signature: Eq + Clone,
 {
  /// Create a new state accumulator.
- pub fn new(round_number: usize, threshold: usize, round_proposer: ValidatorId) -> Self {
+ pub fn new(round_number: usize, threshold: usize, round_proposer: AuthorityId) -> Self {
  Accumulator {
  round_number,
  threshold,
@@ -171,11 +171,6 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
  self.round_number.clone()
  }
 
- /// Get the round proposer.
- pub fn round_proposer(&self) -> &ValidatorId {
- &self.round_proposer
- }
-
  pub fn proposal(&self) -> Option<&Candidate> {
  self.proposal.as_ref()
  }
@@ -189,7 +184,7 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
  /// and authorization should have already been checked.
  pub fn import_message(
  &mut self,
- message: LocalizedMessage<Candidate, Digest, ValidatorId, Signature>,
+ message: LocalizedMessage<Candidate, Digest, AuthorityId, Signature>,
  )
  {
  // message from different round.
@@ -210,7 +205,7 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
  fn import_proposal(
  &mut self,
  proposal: Candidate,
- sender: ValidatorId,
+ sender: AuthorityId,
  ) {
  if sender != self.round_proposer || self.proposal.is_some() { return }
 
@@ -221,7 +216,7 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
  fn import_prepare(
  &mut self,
  digest: Digest,
- sender: ValidatorId,
+ sender: AuthorityId,
  signature: Signature,
  ) {
  // ignore any subsequent prepares by the same sender.
@@ -264,7 +259,7 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
  fn import_commit(
  &mut self,
  digest: Digest,
- sender: ValidatorId,
+ sender: AuthorityId,
  signature: Signature,
  ) {
  // ignore any subsequent commits by the same sender.
@@ -304,7 +299,7 @@ impl<Candidate, Digest, ValidatorId, Signature> Accumulator<Candidate, Digest, V
 
  fn import_advance_round(
  &mut self,
- sender: ValidatorId,
+ sender: AuthorityId,
  ) {
  self.advance_round.insert(sender);
 
@@ -332,7 +327,7 @@ mod tests {
  pub struct Digest(usize);
 
  #[derive(Hash, PartialEq, Eq, Debug)]
- pub struct ValidatorId(usize);
+ pub struct AuthorityId(usize);
 
  #[derive(PartialEq, Eq, Clone, Debug)]
  pub struct Signature(usize, usize);
@@ -347,7 +342,7 @@ mod tests {
 
  let check_message = |r, d: &Digest, s: &Signature| {
  if r == 2 && d.0 == 600 && s.0 == 600 {
- Some(ValidatorId(s.1))
+ Some(AuthorityId(s.1))
  } else {
  None
  }
@@ -370,19 +365,19 @@ mod tests {
 
  #[test]
  fn accepts_proposal_from_proposer_only() {
- let mut accumulator = Accumulator::<_, Digest, _, _>::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::<_, Digest, _, _>::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(5),
+ sender: AuthorityId(5),
  signature: Signature(999, 5),
  message: Message::Propose(1, Candidate(999)),
  });
 
  assert_eq!(accumulator.state(), &State::Begin);
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(8),
+ sender: AuthorityId(8),
  signature: Signature(999, 8),
  message: Message::Propose(1, Candidate(999)),
  });
@@ -392,11 +387,11 @@ mod tests {
 
  #[test]
  fn reaches_prepare_phase() {
- let mut accumulator = Accumulator::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(8),
+ sender: AuthorityId(8),
  signature: Signature(999, 8),
  message: Message::Propose(1, Candidate(999)),
  });
@@ -405,7 +400,7 @@ mod tests {
 
  for i in 0..6 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -414,7 +409,7 @@ mod tests {
  }
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(7),
+ sender: AuthorityId(7),
  signature: Signature(999, 7),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -427,11 +422,11 @@ mod tests {
 
  #[test]
  fn prepare_to_commit() {
- let mut accumulator = Accumulator::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(8),
+ sender: AuthorityId(8),
  signature: Signature(999, 8),
  message: Message::Propose(1, Candidate(999)),
  });
@@ -440,7 +435,7 @@ mod tests {
 
  for i in 0..6 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -449,7 +444,7 @@ mod tests {
  }
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(7),
+ sender: AuthorityId(7),
  signature: Signature(999, 7),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -461,7 +456,7 @@ mod tests {
 
  for i in 0..6 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Commit(1, Digest(999)),
  });
@@ -473,7 +468,7 @@ mod tests {
  }
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(7),
+ sender: AuthorityId(7),
  signature: Signature(999, 7),
  message: Message::Commit(1, Digest(999)),
  });
@@ -486,11 +481,11 @@ mod tests {
 
  #[test]
  fn prepare_to_advance() {
- let mut accumulator = Accumulator::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(8),
+ sender: AuthorityId(8),
  signature: Signature(999, 8),
  message: Message::Propose(1, Candidate(999)),
  });
@@ -499,7 +494,7 @@ mod tests {
 
  for i in 0..7 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -512,7 +507,7 @@ mod tests {
 
  for i in 0..6 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::AdvanceRound(1),
  });
@@ -524,7 +519,7 @@ mod tests {
  }
 
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(7),
+ sender: AuthorityId(7),
  signature: Signature(999, 7),
  message: Message::AdvanceRound(1),
  });
@@ -537,12 +532,12 @@ mod tests {
 
  #[test]
  fn conclude_different_than_proposed() {
- let mut accumulator = Accumulator::<Candidate, _, _, _>::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::<Candidate, _, _, _>::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  for i in 0..7 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Prepare(1, Digest(999)),
  });
@@ -555,7 +550,7 @@ mod tests {
 
  for i in 0..7 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Commit(1, Digest(999)),
  });
@@ -569,12 +564,12 @@ mod tests {
 
  #[test]
  fn begin_to_advance() {
- let mut accumulator = Accumulator::<Candidate, Digest, _, _>::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::<Candidate, Digest, _, _>::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  for i in 0..7 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(1, i),
  message: Message::AdvanceRound(1),
  });
@@ -588,12 +583,12 @@ mod tests {
 
  #[test]
  fn conclude_without_prepare() {
- let mut accumulator = Accumulator::<Candidate, _, _, _>::new(1, 7, ValidatorId(8));
+ let mut accumulator = Accumulator::<Candidate, _, _, _>::new(1, 7, AuthorityId(8));
  assert_eq!(accumulator.state(), &State::Begin);
 
  for i in 0..7 {
  accumulator.import_message(LocalizedMessage {
- sender: ValidatorId(i),
+ sender: AuthorityId(i),
  signature: Signature(999, i),
  message: Message::Commit(1, Digest(999)),
  });