-
Notifications
You must be signed in to change notification settings - Fork 216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CommitSig refactor #277
Merged
Merged
CommitSig refactor #277
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f381650
CommitSig refactor
greg-szabo f35cf8e
Cargo fmt and clippy
greg-szabo e6eb53e
CHANGES.md fix
greg-szabo b91bfaf
CommitSig internal tests
greg-szabo 3125b77
Removed comment asking for clarificiation about validator_address ver…
greg-szabo d214e9d
Opened issue and tagged it about the code comment
greg-szabo a23d019
Merge branch 'master' into greg/commitsig
greg-szabo c634764
Update tendermint/src/block/commit_sig.rs
greg-szabo ad16064
null -> missing in error messages
greg-szabo fe15f62
Removed commented code that fixes compatibility workarounds. Left TOD…
greg-szabo dee63d2
Typo fix
greg-szabo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,79 +1,88 @@ | ||
//! CommitSig within Commit | ||
|
||
use crate::serializers; | ||
use crate::serializers::BlockIDFlag; | ||
use crate::serializers::RawCommitSig; | ||
use crate::{account, Signature, Time}; | ||
use serde::{de::Error as _, Deserialize, Deserializer, Serialize, Serializer}; | ||
|
||
/// BlockIDFlag is used to indicate the validator has voted either for nil, a particular BlockID or | ||
/// was absent. | ||
#[derive(Copy, Clone, Debug, PartialEq)] | ||
pub enum BlockIDFlag { | ||
/// BlockIDFlagAbsent - no vote was received from a validator. | ||
BlockIDFlagAbsent = 1, | ||
/// BlockIDFlagCommit - voted for the Commit.BlockID. | ||
BlockIDFlagCommit = 2, | ||
/// BlockIDFlagNil - voted for nil. | ||
BlockIDFlagNil = 3, | ||
} | ||
|
||
impl BlockIDFlag { | ||
/// Deserialize this type from a byte | ||
pub fn from_u8(byte: u8) -> Option<BlockIDFlag> { | ||
match byte { | ||
1 => Some(BlockIDFlag::BlockIDFlagAbsent), | ||
2 => Some(BlockIDFlag::BlockIDFlagCommit), | ||
3 => Some(BlockIDFlag::BlockIDFlagNil), | ||
_ => None, | ||
} | ||
} | ||
|
||
/// Serialize this type as a byte | ||
pub fn to_u8(self) -> u8 { | ||
self as u8 | ||
} | ||
|
||
/// Serialize this type as a 32-bit unsigned integer | ||
pub fn to_u32(self) -> u32 { | ||
self as u32 | ||
} | ||
} | ||
|
||
impl Serialize for BlockIDFlag { | ||
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> { | ||
self.to_u8().serialize(serializer) | ||
} | ||
} | ||
|
||
impl<'de> Deserialize<'de> for BlockIDFlag { | ||
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> { | ||
let byte = u8::deserialize(deserializer)?; | ||
BlockIDFlag::from_u8(byte) | ||
.ok_or_else(|| D::Error::custom(format!("invalid block ID flag: {}", byte))) | ||
} | ||
} | ||
use serde::{Deserialize, Serialize}; | ||
use std::convert::TryFrom; | ||
|
||
/// CommitSig represents a signature of a validator. | ||
/// It's a part of the Commit and can be used to reconstruct the vote set given the validator set. | ||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)] | ||
pub struct CommitSig { | ||
/// Block ID FLag | ||
pub block_id_flag: BlockIDFlag, | ||
|
||
/// Validator address | ||
#[serde(deserialize_with = "serializers::parse_non_empty_id")] | ||
pub validator_address: Option<account::Id>, | ||
|
||
/// Timestamp | ||
pub timestamp: Time, | ||
|
||
/// Signature | ||
#[serde(deserialize_with = "serializers::parse_non_empty_signature")] | ||
pub signature: Option<Signature>, | ||
#[serde(try_from = "RawCommitSig")] | ||
pub enum CommitSig { | ||
/// no vote was received from a validator. | ||
// Todo: https://github.com/informalsystems/tendermint-rs/issues/260 - CommitSig validator address missing in Absent vote | ||
BlockIDFlagAbsent, | ||
/// voted for the Commit.BlockID. | ||
BlockIDFlagCommit { | ||
/// Validator address | ||
validator_address: account::Id, | ||
/// Timestamp of vote | ||
timestamp: Time, | ||
/// Signature of vote | ||
signature: Signature, | ||
}, | ||
/// voted for nil. | ||
BlockIDFlagNil { | ||
/// Validator address | ||
validator_address: account::Id, | ||
/// Timestamp of vote | ||
timestamp: Time, | ||
/// Signature of vote | ||
signature: Signature, | ||
}, | ||
} | ||
|
||
impl CommitSig { | ||
/// Checks if a validator's vote is absent | ||
pub fn is_absent(&self) -> bool { | ||
self.block_id_flag == BlockIDFlag::BlockIDFlagAbsent | ||
// Todo: https://github.com/informalsystems/tendermint-rs/issues/259 - CommitSig Timestamp can be zero time | ||
// Todo: https://github.com/informalsystems/tendermint-rs/issues/260 - CommitSig validator address missing in Absent vote | ||
impl TryFrom<RawCommitSig> for CommitSig { | ||
type Error = &'static str; | ||
|
||
fn try_from(value: RawCommitSig) -> Result<Self, Self::Error> { | ||
match value.block_id_flag { | ||
BlockIDFlag::BlockIDFlagAbsent => { | ||
if value.timestamp.is_some() | ||
&& value.timestamp.unwrap() | ||
!= Time::parse_from_rfc3339("0001-01-01T00:00:00Z").unwrap() | ||
{ | ||
return Err("timestamp is present for BlockIDFlagAbsent CommitSig"); | ||
} | ||
if value.signature.is_some() { | ||
return Err("signature is present for BlockIDFlagAbsent CommitSig"); | ||
} | ||
Ok(CommitSig::BlockIDFlagAbsent) | ||
} | ||
BlockIDFlag::BlockIDFlagCommit => { | ||
if value.timestamp.is_none() { | ||
Err("timestamp is missing for BlockIDFlagCommit CommitSig") | ||
} else if value.signature.is_none() { | ||
Err("signature is missing for BlockIDFlagCommit CommitSig") | ||
} else if value.validator_address.is_none() { | ||
Err("validator_address is missing for BlockIDFlagCommit CommitSig") | ||
} else { | ||
Ok(CommitSig::BlockIDFlagCommit { | ||
validator_address: value.validator_address.unwrap(), | ||
liamsi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
timestamp: value.timestamp.unwrap(), | ||
signature: value.signature.unwrap(), | ||
}) | ||
} | ||
} | ||
BlockIDFlag::BlockIDFlagNil => { | ||
if value.timestamp.is_none() { | ||
Err("timestamp is missing for BlockIDFlagNil CommitSig") | ||
} else if value.signature.is_none() { | ||
Err("signature is missing for BlockIDFlagNil CommitSig") | ||
} else if value.validator_address.is_none() { | ||
Err("validator_address is missing for BlockIDFlagNil CommitSig") | ||
} else { | ||
Ok(CommitSig::BlockIDFlagNil { | ||
validator_address: value.validator_address.unwrap(), | ||
liamsi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
timestamp: value.timestamp.unwrap(), | ||
signature: value.signature.unwrap(), | ||
}) | ||
} | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍