Skip to content

Commit

Permalink
Witness human-readable serde
Browse files Browse the repository at this point in the history
Previous implementations of Witness (and Vec<Vec<u8>>) serde serialization
didn't support human-readable representations. This resulted in long unreadable 
JSON/YAML byte arrays, which were especially ugly when pretty-printed (a line 
per each byte).
  • Loading branch information
dr-orlovsky committed Mar 23, 2022
1 parent e8f983a commit 90d220d
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions src/blockdata/witness.rs
Expand Up @@ -272,8 +272,18 @@ impl serde::Serialize for Witness {
where
S: serde::Serializer,
{
let vec: Vec<_> = self.to_vec();
serde::Serialize::serialize(&vec, serializer)
use hashes::hex::ToHex;
use serde::ser::SerializeSeq;
if serializer.is_human_readable() {
let mut seq = serializer.serialize_seq(Some(self.serialized_len()))?;
for elem in self.iter() {
seq.serialize_element(&elem.to_hex())?;
}
seq.end()
} else {
let vec: Vec<_> = self.to_vec();
serde::Serialize::serialize(&vec, serializer)
}
}
}
#[cfg(feature = "serde")]
Expand All @@ -282,8 +292,36 @@ impl<'de> serde::Deserialize<'de> for Witness {
where
D: serde::Deserializer<'de>,
{
let vec: Vec<Vec<u8>> = serde::Deserialize::deserialize(deserializer)?;
Ok(Witness::from_vec(vec))
struct Visitor;
impl<'de> serde::de::Visitor<'de> for Visitor
{
type Value = Witness;

fn expecting(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
write!(f, "a sequence of hex arrays")
}

fn visit_seq<A: serde::de::SeqAccess<'de>>(self, mut a: A)
-> Result<Self::Value, A::Error>
{
use hashes::hex::FromHex;
let mut ret = Vec::new();
while let Option::Some(elem) = a.next_element::<String>()? {
let vec = Vec::<u8>::from_hex(&elem).map_err(|_| {
serde::de::Error::invalid_value(serde::de::Unexpected::Str(&elem), &"hex byte representation")
})?;
ret.push(vec);
}
Ok(Witness::from_vec(ret))
}
}

if deserializer.is_human_readable() {
deserializer.deserialize_seq(Visitor)
} else {
let vec: Vec<Vec<u8>> = serde::Deserialize::deserialize(deserializer)?;
Ok(Witness::from_vec(vec))
}
}
}

Expand Down

0 comments on commit 90d220d

Please sign in to comment.