Organize BLS message into two types and reorder signature (#91)

* include `BLSSignature` inside `VoteMessage` and `Certificate` for easier organization

* rename `Certificate` to `CertificateMessage`

* divide `Certificate` into `Certificate` and `CertificateMessage`

Author: samkim-crypto

program/src/bls_message.rs

@@ -3,78 +3,67 @@
 use serde::{Deserialize, Serialize};
 
 use {
-    crate::{
-        certificate::{Certificate, CertificateType},
-        vote::Vote,
-    },
+    crate::{certificate::Certificate, vote::Vote},
     bitvec::prelude::*,
     solana_bls::Signature as BLSSignature,
-    solana_hash::Hash,
-    solana_program::clock::Slot,
 };
 
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
-/// BLS message vote data, we need rank to look up pubkey
-pub struct BLSMessageVoteData {
+/// BLS vote message, we need rank to look up pubkey
+pub struct VoteMessage {
     /// The vote
     pub vote: Vote,
+    /// The signature
+    pub signature: BLSSignature,
     /// The rank of the validator
     pub rank: u16,
 }
 
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Clone, Debug, PartialEq)]
-#[allow(clippy::large_enum_variant)]
-/// BLS message data in Alpenglow
-pub enum BLSMessageData {
-    /// Vote message, with the vote and the rank of the validator.
-    Vote(BLSMessageVoteData),
-    /// Certificate message
-    Certificate(Certificate),
+/// BLS vote message, we need rank to look up pubkey
+pub struct CertificateMessage {
+    /// The certificate
+    pub certificate: Certificate,
+    /// The signature
+    pub signature: BLSSignature,
+    /// The bitmap for validators, little endian byte order
+    pub bitmap: BitVec<u8, Lsb0>,
 }
 
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Clone, Debug, PartialEq)]
-/// BLS message to be sent all to all in Alpenglow
-pub struct BLSMessage {
-    /// The message data
-    pub message_data: BLSMessageData,
-    /// The signature of the message
-    pub signature: BLSSignature,
+#[allow(clippy::large_enum_variant)]
+/// BLS message data in Alpenglow
+pub enum BLSMessage {
+    /// Vote message, with the vote and the rank of the validator.
+    Vote(VoteMessage),
+    /// Certificate message
+    Certificate(CertificateMessage),
 }
 
 impl BLSMessage {
     /// Create a new vote message
-    pub fn new_vote(vote: Vote, my_rank: u16, signature: BLSSignature) -> Self {
-        Self {
-            message_data: BLSMessageData::Vote(BLSMessageVoteData {
-                vote,
-                rank: my_rank,
-            }),
+    pub fn new_vote(vote: Vote, signature: BLSSignature, rank: u16) -> Self {
+        Self::Vote(VoteMessage {
+            vote,
             signature,
-        }
+            rank,
+        })
     }
 
     /// Create a new certificate message
     pub fn new_certificate(
-        certificate_type: CertificateType,
-        slot: Slot,
-        block_id: Option<Hash>,
-        replayed_bank_hash: Option<Hash>,
+        certificate: Certificate,
         bitmap: BitVec<u8, Lsb0>,
         signature: BLSSignature,
     ) -> Self {
-        Self {
-            message_data: BLSMessageData::Certificate(Certificate {
-                certificate_type,
-                slot,
-                block_id,
-                replayed_bank_hash,
-                bitmap,
-            }),
+        Self::Certificate(CertificateMessage {
+            certificate,
             signature,
-        }
+            bitmap,
+        })
     }
 
     #[cfg(feature = "serde")]

program/src/certificate.rs

@@ -2,7 +2,7 @@
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
-use {bitvec::prelude::*, solana_hash::Hash, solana_program::clock::Slot};
+use {solana_hash::Hash, solana_program::clock::Slot};
 
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
@@ -32,6 +32,4 @@ pub struct Certificate {
     pub block_id: Option<Hash>,
     /// The bank hash of the block
     pub replayed_bank_hash: Option<Hash>,
-    /// The bitmap for validators, little endian byte order
-    pub bitmap: BitVec<u8, Lsb0>,
 }