apollo_network: add BadPeerReport and PenaltyCard

Author: guy-starkware

crates/apollo_consensus/src/manager.rs

@@ -276,17 +276,17 @@ impl<ContextT: ConsensusContext> ConsensusCache<ContextT> {
         let votes = self.future_votes.entry(vote.height).or_default();
         // Find a vote in the list with the same type, round, and voter. If found, do not add it to
         // list.
-        let duplicate_vote = votes.iter().find(|v| {
+        let existing_vote = votes.iter().find(|v| {
             v.vote_type == vote.vote_type && v.round == vote.round && v.voter == vote.voter
         });
-        if let Some(duplicate_vote) = duplicate_vote {
+        if let Some(existing_vote) = existing_vote {
             // If the two votes are identical, we just ignore this.
-            if duplicate_vote == &vote {
+            if existing_vote == &vote {
                 Ok(())
             } else {
                 // Otherwise, we report equivocation.
                 Err(Box::new(EquivocationVoteReport {
-                    cached_vote: duplicate_vote.clone(),
+                    cached_vote: existing_vote.clone(),
                     new_vote: vote,
                 }))
             }

crates/apollo_network_types/src/network_types.rs

@@ -23,3 +23,22 @@ impl OpaquePeerId {
         self.0
     }
 }
+
+// TODO(guyn): remove allow dead code once we use the duplicate vote report.
+#[allow(dead_code)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+pub struct BadPeerReport {
+    pub peer_id: OpaquePeerId,
+    pub reason: String,
+    pub penalty_card: PenaltyCard,
+}
+
+// TODO(guyn): need to decide how much misconduct score to add when getting each yellow card.
+/// Represents the severity of the bad peer behavior.
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+pub enum PenaltyCard {
+    /// Overtly malicious behavior.
+    Red,
+    /// Possibly sent malicious data on accident, will be considered malicious on repeat offenses.
+    Yellow,
+}