Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: Signature bincode serialization #509

Merged
merged 3 commits into from
Feb 6, 2024
Merged

fix: Signature bincode serialization #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c506a7
add parity to u64 conversion
Wollac Feb 4, 2024
bea435e
fix bincode serialization
Wollac Feb 4, 2024
580ab73
don't use json in bincode test
Wollac Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions crates/primitives/src/signature/parity.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,15 @@ impl Parity {
}
}

/// Return the corresponding u64 V value.
pub const fn to_u64(&self) -> u64 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be a From/Into implementation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could be, yes. To me it felt more like the y_parity_byte which is not a From<u8> either.
But I don't have a strong opinion at all, I can change it to a From. Whatever you prefer.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can be follow ups

match self {
Self::Eip155(v) => *v,
Self::NonEip155(b) => *b as u64 + 27,
Self::Parity(b) => *b as u64,
}
}

/// Inverts the parity.
pub const fn inverted(&self) -> Self {
match *self {
Expand Down Expand Up @@ -205,6 +214,22 @@ mod test {
}
}

#[test]
fn u64_round_trip() {
let parity = Parity::Eip155(37);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
let parity = Parity::Eip155(38);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
let parity = Parity::NonEip155(false);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
let parity = Parity::NonEip155(true);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
let parity = Parity::Parity(false);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
let parity = Parity::Parity(true);
assert_eq!(parity, Parity::try_from(parity.to_u64()).unwrap());
}

#[test]
fn round_trip() {
// with chain ID 1
Expand Down
83 changes: 70 additions & 13 deletions crates/primitives/src/signature/sig.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,20 +405,31 @@ impl serde::Serialize for crate::Signature {
where
S: serde::Serializer,
{
use serde::ser::SerializeMap;
// if the serializer is human readable, serialize as a map, otherwise as a tuple
if serializer.is_human_readable() {
use serde::ser::SerializeMap;

let mut map = serializer.serialize_map(Some(3))?;
let mut map = serializer.serialize_map(Some(3))?;

map.serialize_entry("r", &self.r)?;
map.serialize_entry("s", &self.s)?;
map.serialize_entry("r", &self.r)?;
map.serialize_entry("s", &self.s)?;

match self.v {
Parity::Eip155(v) => map.serialize_entry("v", &crate::U64::from(v))?,
Parity::NonEip155(b) => map.serialize_entry("v", &(b as u8 + 27))?,
Parity::Parity(true) => map.serialize_entry("yParity", "0x1")?,
Parity::Parity(false) => map.serialize_entry("yParity", "0x0")?,
match self.v {
Parity::Eip155(v) => map.serialize_entry("v", &crate::U64::from(v))?,
Parity::NonEip155(b) => map.serialize_entry("v", &(b as u8 + 27))?,
Parity::Parity(true) => map.serialize_entry("yParity", "0x1")?,
Parity::Parity(false) => map.serialize_entry("yParity", "0x0")?,
}
map.end()
} else {
use serde::ser::SerializeTuple;

let mut tuple = serializer.serialize_tuple(3)?;
tuple.serialize_element(&self.r)?;
tuple.serialize_element(&self.s)?;
tuple.serialize_element(&self.v.to_u64())?;
tuple.end()
}
map.end()
}
}

Expand Down Expand Up @@ -472,8 +483,8 @@ impl<'de> serde::Deserialize<'de> for crate::Signature {
}
}

struct SignatureVisitor;
impl<'de> serde::de::Visitor<'de> for SignatureVisitor {
struct MapVisitor;
impl<'de> serde::de::Visitor<'de> for MapVisitor {
type Value = crate::Signature;

fn expecting(&self, formatter: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
Expand Down Expand Up @@ -526,7 +537,37 @@ impl<'de> serde::Deserialize<'de> for crate::Signature {
}
}

deserializer.deserialize_map(SignatureVisitor)
struct TupleVisitor;
impl<'de> serde::de::Visitor<'de> for TupleVisitor {
type Value = crate::Signature;

fn expecting(&self, formatter: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
formatter.write_str("a tuple containing r, s, and v")
}

fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
where
A: serde::de::SeqAccess<'de>,
{
let r = seq
.next_element()?
.ok_or_else(|| serde::de::Error::invalid_length(0, &self))?;
let s = seq
.next_element()?
.ok_or_else(|| serde::de::Error::invalid_length(1, &self))?;
let v: u64 = seq
.next_element()?
.ok_or_else(|| serde::de::Error::invalid_length(2, &self))?;

crate::Signature::from_rs_and_parity(r, s, v).map_err(serde::de::Error::custom)
}
}

if deserializer.is_human_readable() {
deserializer.deserialize_map(MapVisitor)
} else {
deserializer.deserialize_tuple(3, TupleVisitor)
}
}
}

Expand Down Expand Up @@ -664,6 +705,22 @@ mod tests {
assert_eq!(serialized, expected);
}

#[cfg(feature = "serde")]
#[test]
fn test_bincode_roundtrip() {
let signature = crate::Signature::from_rs_and_parity(
U256::from_str("0xc569c92f176a3be1a6352dd5005bfc751dcb32f57623dd2a23693e64bf4447b0")
.unwrap(),
U256::from_str("0x1a891b566d369e79b7a66eecab1e008831e22daa15f91a0a0cf4f9f28f47ee05")
.unwrap(),
1,
)
.unwrap();

let bin = bincode::serialize(&signature).unwrap();
assert_eq!(bincode::deserialize::<crate::Signature>(&bin).unwrap(), signature);
}

#[cfg(feature = "rlp")]
#[test]
fn signature_rlp_decode() {
Expand Down
Loading