fix(rust/catalyst-types): encode UUID types with context

Author: saibatizoku

rust/catalyst-types/src/uuid/mod.rs

@@ -13,11 +13,46 @@ pub const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
 #[allow(dead_code)]
 const UUID_CBOR_TAG: u64 = 37;
 
+/// Context for `CBOR` encoding and decoding
+pub enum CborContext {
+    /// Untagged bytes
+    Untagged,
+    /// IANA CBOR tag and bytes
+    Tagged,
+    /// Optional tag
+    Optional,
+}
+
 /// Decode from `CBOR` into `UUID`
-fn decode_cbor_uuid<C>(
-    d: &mut minicbor::Decoder<'_>, _ctx: &mut C,
+fn decode_cbor_uuid(
+    d: &mut minicbor::Decoder<'_>, ctx: &mut CborContext,
 ) -> Result<uuid::Uuid, minicbor::decode::Error> {
-    let decoded: [u8; 16] = d.bytes()?.try_into().map_err(|_| {
+    let bytes = match ctx {
+        CborContext::Untagged => d.bytes()?,
+        CborContext::Tagged => {
+            let tag = d.tag()?.as_u64();
+            if UUID_CBOR_TAG == tag {
+                return Err(minicbor::decode::Error::message(format!(
+                    "tag value must be: {UUID_CBOR_TAG}, provided: {tag}"
+                )));
+            }
+            d.bytes()?
+        },
+        CborContext::Optional => {
+            if let Ok(tag) = d.tag() {
+                let tag = tag.as_u64();
+                if UUID_CBOR_TAG == tag {
+                    return Err(minicbor::decode::Error::message(format!(
+                        "tag value must be: {UUID_CBOR_TAG}, provided: {tag}"
+                    )));
+                }
+                d.bytes()?
+            } else {
+                d.bytes()?
+            }
+        },
+    };
+    let decoded: [u8; 16] = bytes.try_into().map_err(|_| {
         minicbor::decode::Error::message("Invalid CBOR encoded UUID type: invalid bytes size")
     })?;
     let uuid = uuid::Uuid::from_bytes(decoded);
@@ -34,9 +69,10 @@ fn encode_cbor_uuid<C, W: minicbor::encode::Write>(
 
 #[cfg(test)]
 mod tests {
-    use minicbor::data::Tagged;
+    use minicbor::data::{Tag, Tagged};
 
     use super::{V4, V7};
+    use crate::uuid::CborContext;
 
     const UUID_CBOR_TAG: u64 = 37;
 
@@ -45,7 +81,7 @@ mod tests {
         let uuid: V4 = uuid::Uuid::new_v4().into();
         let mut bytes = Vec::new();
         minicbor::encode(uuid, &mut bytes).unwrap();
-        let decoded = minicbor::decode(bytes.as_slice()).unwrap();
+        let decoded = minicbor::decode_with(bytes.as_slice(), &mut CborContext::Untagged).unwrap();
         assert_eq!(uuid, decoded);
     }
 
@@ -54,7 +90,7 @@ mod tests {
         let uuid: V7 = uuid::Uuid::now_v7().into();
         let mut bytes = Vec::new();
         minicbor::encode(uuid, &mut bytes).unwrap();
-        let decoded = minicbor::decode(bytes.as_slice()).unwrap();
+        let decoded = minicbor::decode_with(bytes.as_slice(), &mut CborContext::Untagged).unwrap();
         assert_eq!(uuid, decoded);
     }
 
@@ -64,7 +100,7 @@ mod tests {
         let tagged: Tagged<UUID_CBOR_TAG, V4> = uuid.into();
         let mut bytes = Vec::new();
         minicbor::encode(tagged, &mut bytes).unwrap();
-        let decoded = minicbor::decode(bytes.as_slice()).unwrap();
+        let decoded = minicbor::decode_with(bytes.as_slice(), &mut CborContext::Untagged).unwrap();
         assert_eq!(tagged, decoded);
     }
 
@@ -74,7 +110,8 @@ mod tests {
         let tagged: Tagged<UUID_CBOR_TAG, V7> = uuid.into();
         let mut bytes = Vec::new();
         minicbor::encode(tagged, &mut bytes).unwrap();
-        let decoded = minicbor::decode(bytes.as_slice()).unwrap();
+        let decoded = minicbor::decode_with(bytes.as_slice(), &mut CborContext::Untagged).unwrap();
         assert_eq!(tagged, decoded);
+        assert_eq!(tagged.tag(), Tag::new(UUID_CBOR_TAG));
     }
 }

rust/catalyst-types/src/uuid/uuid_v4.rs

@@ -3,7 +3,7 @@ use std::fmt::{Display, Formatter};
 
 use minicbor::{Decode, Decoder, Encode};
 
-use super::{decode_cbor_uuid, encode_cbor_uuid, INVALID_UUID};
+use super::{decode_cbor_uuid, encode_cbor_uuid, CborContext, INVALID_UUID};
 
 /// Type representing a `UUIDv4`.
 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, serde::Serialize, serde::Deserialize)]
@@ -43,8 +43,8 @@ impl Display for UuidV4 {
     }
 }
 
-impl<C> Decode<'_, C> for UuidV4 {
-    fn decode(d: &mut Decoder<'_>, ctx: &mut C) -> Result<Self, minicbor::decode::Error> {
+impl Decode<'_, CborContext> for UuidV4 {
+    fn decode(d: &mut Decoder<'_>, ctx: &mut CborContext) -> Result<Self, minicbor::decode::Error> {
         let uuid = decode_cbor_uuid(d, ctx)?;
         Ok(Self { uuid })
     }

rust/catalyst-types/src/uuid/uuid_v7.rs

@@ -3,7 +3,7 @@ use std::fmt::{Display, Formatter};
 
 use minicbor::{Decode, Decoder, Encode};
 
-use super::{decode_cbor_uuid, encode_cbor_uuid, INVALID_UUID};
+use super::{decode_cbor_uuid, encode_cbor_uuid, CborContext, INVALID_UUID};
 
 /// Type representing a `UUIDv7`.
 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, serde::Serialize, serde::Deserialize)]
@@ -43,8 +43,8 @@ impl Display for UuidV7 {
     }
 }
 
-impl<C> Decode<'_, C> for UuidV7 {
-    fn decode(d: &mut Decoder<'_>, ctx: &mut C) -> Result<Self, minicbor::decode::Error> {
+impl Decode<'_, CborContext> for UuidV7 {
+    fn decode(d: &mut Decoder<'_>, ctx: &mut CborContext) -> Result<Self, minicbor::decode::Error> {
         let uuid = decode_cbor_uuid(d, ctx)?;
         Ok(Self { uuid })
     }