BREAKING: human readable de/ser for shortvec

Author: jstarry

message/src/legacy.rs

@@ -66,7 +66,7 @@ fn compile_instructions(ixs: &[Instruction], keys: &[Address]) -> Vec<CompiledIn
 // for versioned messages in the `RemainingLegacyMessage` struct.
 #[cfg_attr(
     feature = "frozen-abi",
-    frozen_abi(digest = "GXpvLNiMCnjnZpQEDKpc2NBpsqmRnAX7ZTCy9JmvG8Dg"),
+    frozen_abi(digest = "AhkTFHhRftw61EGDjZcMZhoLozeSnb1gRRZmQeoaPXeE"),
     derive(AbiExample)
 )]
 #[cfg_attr(

message/src/versions/mod.rs

@@ -38,7 +38,7 @@ pub const MESSAGE_VERSION_PREFIX: u8 = 0x80;
 /// format.
 #[cfg_attr(
     feature = "frozen-abi",
-    frozen_abi(digest = "AbhbWKcm8BEickDjeXN7mL4BTvrqvhVKv7ZXNykq22ck"),
+    frozen_abi(digest = "7yd5QJuxKgmkEt2ig4X91pCJCfTtjZVarMSzJ4eWzBrE"),
     derive(AbiEnumVisitor, AbiExample)
 )]
 #[derive(Debug, PartialEq, Eq, Clone)]

message/src/versions/v0/mod.rs

@@ -13,7 +13,7 @@ pub use loaded::*;
 #[cfg(feature = "serde")]
 use serde_derive::{Deserialize, Serialize};
 #[cfg(feature = "frozen-abi")]
-use solana_frozen_abi_macro::AbiExample;
+use solana_frozen_abi_macro::{frozen_abi, AbiExample};
 use {
     crate::{
         compiled_instruction::CompiledInstruction,
@@ -57,7 +57,11 @@ pub struct MessageAddressTableLookup {
 ///
 /// See the crate documentation for further description.
 ///
-#[cfg_attr(feature = "frozen-abi", derive(AbiExample))]
+#[cfg_attr(
+    feature = "frozen-abi",
+    frozen_abi(digest = "4Mr6qK8Srdgr7PyeZjXy99ekj5pwHQSbNCVD3TmzcxTM"),
+    derive(AbiExample)
+)]
 #[cfg_attr(
     feature = "serde",
     derive(Deserialize, Serialize),

short-vec/src/lib.rs

@@ -26,6 +26,10 @@ impl Serialize for ShortU16 {
     where
         S: Serializer,
     {
+        if serializer.is_human_readable() {
+            return serializer.serialize_u16(self.0);
+        }
+
         // Pass a non-zero value to serialize_tuple() so that serde_json will
         // generate an open bracket.
         let mut seq = serializer.serialize_tuple(1)?;
@@ -155,7 +159,11 @@ impl<'de> Deserialize<'de> for ShortU16 {
     where
         D: Deserializer<'de>,
     {
-        deserializer.deserialize_tuple(3, ShortU16Visitor)
+        if deserializer.is_human_readable() {
+            Ok(ShortU16(u16::deserialize(deserializer)?))
+        } else {
+            deserializer.deserialize_tuple(3, ShortU16Visitor)
+        }
     }
 }
 
@@ -168,6 +176,15 @@ pub fn serialize<S: Serializer, T: Serialize>(
     elements: &[T],
     serializer: S,
 ) -> Result<S::Ok, S::Error> {
+    if serializer.is_human_readable() {
+        use serde_core::ser::SerializeSeq;
+        let mut seq = serializer.serialize_seq(Some(elements.len()))?;
+        for element in elements {
+            seq.serialize_element(element)?;
+        }
+        return seq.end();
+    }
+
     // Pass a non-zero value to serialize_tuple() so that serde_json will
     // generate an open bracket.
     let mut seq = serializer.serialize_tuple(1)?;
@@ -229,6 +246,9 @@ where
     D: Deserializer<'de>,
     T: Deserialize<'de>,
 {
+    if deserializer.is_human_readable() {
+        return <Vec<T> as Deserialize<'de>>::deserialize(deserializer);
+    }
     let visitor = ShortVecVisitor { _t: PhantomData };
     deserializer.deserialize_tuple(usize::MAX, visitor)
 }
@@ -274,8 +294,43 @@ mod tests {
         super::*,
         assert_matches::assert_matches,
         bincode::{deserialize, serialize},
+        std::u16,
     };
 
+    #[test]
+    fn test_short_u16_human_readable_serialization() {
+        let value = ShortU16(0u16);
+        let string = serde_json::to_string(&value).unwrap();
+        let expected_string = String::from("0");
+        assert_eq!(string, expected_string);
+        let deser_value: ShortU16 = serde_json::from_str(&string).unwrap();
+        assert_eq!(value.0, deser_value.0);
+
+        let value = ShortU16(u16::MAX);
+        let string = serde_json::to_string(&value).unwrap();
+        let expected_string = String::from("65535");
+        assert_eq!(string, expected_string);
+        let deser_value: ShortU16 = serde_json::from_str(&string).unwrap();
+        assert_eq!(value.0, deser_value.0);
+    }
+
+    #[test]
+    fn test_short_vec_human_readable_serialization() {
+        let value = ShortVec::<()>(vec![]);
+        let string = serde_json::to_string(&value).unwrap();
+        let expected_string = String::from("[]");
+        assert_eq!(string, expected_string);
+        let deser_value: ShortVec<()> = serde_json::from_str(&string).unwrap();
+        assert_eq!(value.0, deser_value.0);
+
+        let value = ShortVec(vec![1, 2, 3]);
+        let string = serde_json::to_string(&value).unwrap();
+        let expected_string = String::from("[1,2,3]");
+        assert_eq!(string, expected_string);
+        let deser_value: ShortVec<usize> = serde_json::from_str(&string).unwrap();
+        assert_eq!(value.0, deser_value.0);
+    }
+
     /// Return the serialized length.
     fn encode_len(len: u16) -> Vec<u8> {
         bincode::serialize(&ShortU16(len)).unwrap()
@@ -372,13 +427,6 @@ mod tests {
         assert_matches!(serialize(&vec), Err(_));
     }
 
-    #[test]
-    fn test_short_vec_json() {
-        let vec = ShortVec(vec![0, 1, 2]);
-        let s = serde_json::to_string(&vec).unwrap();
-        assert_eq!(s, "[[3],0,1,2]");
-    }
-
     #[test]
     fn test_short_vec_aliased_length() {
         let bytes = [

transaction/src/lib.rs

@@ -177,7 +177,7 @@ const NONCED_TX_MARKER_IX_INDEX: u8 = 0;
 #[cfg_attr(
     feature = "frozen-abi",
     derive(solana_frozen_abi_macro::AbiExample),
-    solana_frozen_abi_macro::frozen_abi(digest = "BLig4G2ysd7dcensK9bhKtnKvCQc1n65XdanyzsdWGXN")
+    solana_frozen_abi_macro::frozen_abi(digest = "5V7i4Tngkou3ieDNdtPpwYaFZpe2S2vZL71wrdJq5zTQ")
 )]
 #[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
 #[derive(Debug, PartialEq, Default, Eq, Clone)]