Support for CometBFT proto 0.38

tendermint/src/vote.rs

@@ -9,15 +9,15 @@ use core::{fmt, str::FromStr};
 
 use bytes::BufMut;
 use serde::{Deserialize, Serialize};
-use tendermint_proto::v0_37::types::{CanonicalVote as RawCanonicalVote, Vote as RawVote};
+use tendermint_proto::v0_38::types::{CanonicalVote as RawCanonicalVote, Vote as RawVote};
 use tendermint_proto::{Error as ProtobufError, Protobuf};
 
 pub use self::{
     canonical_vote::CanonicalVote, power::Power, sign_vote::*, validator_index::ValidatorIndex,
 };
 use crate::{
     account, block, chain::Id as ChainId, consensus::State, error::Error, hash, prelude::*,
-    signature::Ed25519Signature, Signature, Time,
+    Signature, Time,
 };
 
 /// Votes are signed messages from validators for a particular block which
@@ -50,12 +50,76 @@ pub struct Vote {
 
     /// Signature
     pub signature: Option<Signature>,
+
+    /// Vote extension provided by the application.
+    /// Only valid for precommit messages.
+    pub extension: Vec<u8>,
+
+    /// Vote extension signature by the validator
+    /// Only valid for precommit messages.
+    pub extension_signature: Option<Signature>,
+}
+
+// =============================================================================
+// Protobuf conversions
+// =============================================================================
+
+mod v0_34 {
+    use super::Vote;
+    use crate::{block, prelude::*, Error, Signature};
+    use tendermint_proto::v0_34::types::Vote as RawVote;
+    use tendermint_proto::Protobuf;
+
+    impl Protobuf<RawVote> for Vote {}
+
+    impl TryFrom<RawVote> for Vote {
+        type Error = Error;
+
+        fn try_from(value: RawVote) -> Result<Self, Self::Error> {
+            if value.timestamp.is_none() {
+                return Err(Error::missing_timestamp());
+            }
+            Ok(Vote {
+                vote_type: value.r#type.try_into()?,
+                height: value.height.try_into()?,
+                round: value.round.try_into()?,
+                // block_id can be nil in the Go implementation
+                block_id: value
+                    .block_id
+                    .map(TryInto::try_into)
+                    .transpose()?
+                    .filter(|i| i != &block::Id::default()),
+                timestamp: value.timestamp.map(|t| t.try_into()).transpose()?,
+                validator_address: value.validator_address.try_into()?,
+                validator_index: value.validator_index.try_into()?,
+                signature: Signature::new(value.signature)?,
+                extension: Default::default(),
+                extension_signature: None,
+            })
+        }
+    }
+
+    impl From<Vote> for RawVote {
+        fn from(value: Vote) -> Self {
+            RawVote {
+                r#type: value.vote_type.into(),
+                height: value.height.into(),
+                round: value.round.into(),
+                block_id: value.block_id.map(Into::into),
+                timestamp: value.timestamp.map(Into::into),
+                validator_address: value.validator_address.into(),
+                validator_index: value.validator_index.into(),
+                signature: value.signature.map(|s| s.into_bytes()).unwrap_or_default(),
+            }
+        }
+    }
 }
 
-tendermint_pb_modules! {
+mod v0_37 {
     use super::Vote;
-    use crate::{prelude::*, block, Error, Signature};
-    use pb::types::Vote as RawVote;
+    use crate::{block, prelude::*, Error, Signature};
+    use tendermint_proto::v0_37::types::Vote as RawVote;
+    use tendermint_proto::Protobuf;
 
     impl Protobuf<RawVote> for Vote {}
 
@@ -80,6 +144,8 @@ tendermint_pb_modules! {
                 validator_address: value.validator_address.try_into()?,
                 validator_index: value.validator_index.try_into()?,
                 signature: Signature::new(value.signature)?,
+                extension: Default::default(),
+                extension_signature: None,
             })
         }
     }
@@ -100,6 +166,62 @@ tendermint_pb_modules! {
     }
 }
 
+mod v0_38 {
+    use super::Vote;
+    use crate::{block, prelude::*, Error, Signature};
+    use tendermint_proto::v0_38::types::Vote as RawVote;
+    use tendermint_proto::Protobuf;
+
+    impl Protobuf<RawVote> for Vote {}
+
+    impl TryFrom<RawVote> for Vote {
+        type Error = Error;
+
+        fn try_from(value: RawVote) -> Result<Self, Self::Error> {
+            if value.timestamp.is_none() {
+                return Err(Error::missing_timestamp());
+            }
+            Ok(Vote {
+                vote_type: value.r#type.try_into()?,
+                height: value.height.try_into()?,
+                round: value.round.try_into()?,
+                // block_id can be nil in the Go implementation
+                block_id: value
+                    .block_id
+                    .map(TryInto::try_into)
+                    .transpose()?
+                    .filter(|i| i != &block::Id::default()),
+                timestamp: value.timestamp.map(|t| t.try_into()).transpose()?,
+                validator_address: value.validator_address.try_into()?,
+                validator_index: value.validator_index.try_into()?,
+                signature: Signature::new(value.signature)?,
+                extension: value.extension,
+                extension_signature: Signature::new(value.extension_signature)?,
+            })
+        }
+    }
+
+    impl From<Vote> for RawVote {
+        fn from(value: Vote) -> Self {
+            RawVote {
+                r#type: value.vote_type.into(),
+                height: value.height.into(),
+                round: value.round.into(),
+                block_id: value.block_id.map(Into::into),
+                timestamp: value.timestamp.map(Into::into),
+                validator_address: value.validator_address.into(),
+                validator_index: value.validator_index.into(),
+                signature: value.signature.map(|s| s.into_bytes()).unwrap_or_default(),
+                extension: value.extension,
+                extension_signature: value
+                    .extension_signature
+                    .map(|s| s.into_bytes())
+                    .unwrap_or_default(),
+            }
+        }
+    }
+}
+
 impl Vote {
     /// Is this vote a prevote?
     pub fn is_prevote(&self) -> bool {
@@ -157,26 +279,6 @@ impl Vote {
     }
 }
 
-/// Default trait. Used in tests.
-// FIXME: Does it need to be in public crate API? If not, replace with a helper fn in crate::test?
-impl Default for Vote {
-    fn default() -> Self {
-        Vote {
-            vote_type: Type::Prevote,
-            height: Default::default(),
-            round: Default::default(),
-            block_id: None,
-            timestamp: Some(Time::unix_epoch()),
-            validator_address: account::Id::new([0; account::LENGTH]),
-            validator_index: ValidatorIndex::try_from(0_i32).unwrap(),
-            // Could have reused crate::test::dummy_signature, except that
-            // this Default impl is defined outside of #[cfg(test)].
-            signature: Some(Signature::from(Ed25519Signature::from_bytes(
-                &[0; Ed25519Signature::BYTE_SIZE],
-            ))),
-        }
-    }
-}
 /// SignedVote is the union of a canonicalized vote, the signature on
 /// the sign bytes of that vote and the id of the validator who signed it.
 pub struct SignedVote {

tendermint/src/vote/sign_vote.rs

@@ -110,7 +110,7 @@ mod tests {
         chain::Id as ChainId,
         hash::Algorithm,
         prelude::*,
-        signature::{Ed25519Signature, Signature},
+        signature::Signature,
         vote::{CanonicalVote, SignVoteRequest, Type, ValidatorIndex},
         Hash, Vote,
     };
@@ -144,6 +144,9 @@ mod tests {
                 192, 133, 130, 193, 115, 32, 206, 152, 91, 173, 10,
             ])
             .unwrap(),
+            // TODO: test serialization of extensions
+            extension: vec![],
+            extension_signature: None,
         };
 
         let mut got = vec![];
@@ -228,6 +231,9 @@ mod tests {
                 192, 133, 130, 193, 115, 32, 206, 152, 91, 173, 10,
             ])
             .unwrap(),
+            // TODO: test serialization of extensions
+            extension: vec![],
+            extension_signature: None,
         };
 
         let request = SignVoteRequest {
@@ -278,10 +284,31 @@ mod tests {
     tendermint_pb_modules! {
         use super::*;
         use pb::types::CanonicalVote as RawCanonicalVote;
+        use crate::{Time, account, signature::Ed25519Signature};
+
+        /// Returns a dummy value to be used in tests.
+        pub fn dummy_vote() -> Vote {
+            Vote {
+                vote_type: Type::Prevote,
+                height: Default::default(),
+                round: Default::default(),
+                block_id: None,
+                timestamp: Some(Time::unix_epoch()),
+                validator_address: account::Id::new([0; account::LENGTH]),
+                validator_index: ValidatorIndex::try_from(0_i32).unwrap(),
+                // Could have reused crate::test::dummy_signature, except that
+                // this Default impl is defined outside of #[cfg(test)].
+                signature: Some(Signature::from(Ed25519Signature::from_bytes(
+                    &[0; Ed25519Signature::BYTE_SIZE],
+                ))),
+                extension: Default::default(),
+                extension_signature: None,
+            }
+        }
 
         #[test]
         fn test_sign_bytes_compatibility() {
-            let cv = CanonicalVote::new(Vote::default(), ChainId::try_from("A").unwrap());
+            let cv = CanonicalVote::new(dummy_vote(), ChainId::try_from("A").unwrap());
             let mut got = vec![];
             // SignBytes are encoded using MarshalBinary and not MarshalBinaryBare
             Protobuf::<RawCanonicalVote>::encode_length_delimited(&cv, &mut got).unwrap();
@@ -297,7 +324,7 @@ mod tests {
                     height: Height::from(1_u32),
                     round: Round::from(1_u16),
                     vote_type: Type::Precommit,
-                    ..Default::default()
+                    ..dummy_vote()
                 };
                 println!("{vt_precommit:?}");
                 let cv_precommit = CanonicalVote::new(vt_precommit, ChainId::try_from("A").unwrap());
@@ -323,7 +350,7 @@ mod tests {
                     height: Height::from(1_u32),
                     round: Round::from(1_u16),
                     vote_type: Type::Prevote,
-                    ..Default::default()
+                    ..dummy_vote()
                 };
 
                 let cv_prevote = CanonicalVote::new(vt_prevote, ChainId::try_from("A").unwrap());
@@ -384,6 +411,9 @@ mod tests {
                     .unwrap(),
                 }),
                 signature: Signature::new(vec![1; Ed25519Signature::BYTE_SIZE]).unwrap(),
+                // TODO: test deserialization of extensions in 0.38
+                extension: vec![],
+                extension_signature: None,
             };
             let want = SignVoteRequest {
                 vote,
@@ -428,6 +458,9 @@ mod tests {
                     192, 133, 130, 193, 115, 32, 206, 152, 91, 173, 10,
                 ])
                 .unwrap(),
+                // TODO: test deserialization of extensions in 0.38
+                extension: vec![],
+                extension_signature: None,
             };
             let got = Protobuf::<pb::types::Vote>::encode_vec(&vote).unwrap();
             let v = <Vote as Protobuf::<pb::types::Vote>>::decode_vec(&got).unwrap();