fix(rust/catalyst-types): use minicbor and remove coset

saibatizoku · saibatizoku · commit 60933ea83de4 · 2025-01-14T15:28:56.000-06:00
diff --git a/rust/catalyst-types/Cargo.toml b/rust/catalyst-types/Cargo.toml
@@ -17,7 +17,6 @@ name = "catalyst_types"
 
 [dependencies]
 blake2b_simd = "1.0.2"
-coset = "0.3.8"
 displaydoc = "0.2.5"
 ed25519-dalek = "2.1.1"
 fluent-uri = "0.3.2"
@@ -33,4 +32,4 @@ uuid = { version = "1.11.0", features = ["v4", "v7", "serde"] }
 
 [dev-dependencies]
 ed25519-dalek = { version = "2.1.1", features = ["rand_core"] }
-rand = "0.8.5"
+rand = "0.8.5"
diff --git a/rust/catalyst-types/src/uuid/mod.rs b/rust/catalyst-types/src/uuid/mod.rs
@@ -1,6 +1,7 @@
 //! `UUID` types.
 
 use displaydoc::Display;
+use minicbor::Decoder;
 use thiserror::Error;
 use uuid::Uuid;
 
@@ -13,9 +14,6 @@ pub use uuid_v7::UuidV7 as V7;
 /// Invalid Doc Type UUID
 pub const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
 
-/// CBOR tag for UUID content.
-pub const UUID_CBOR_TAG: u64 = 37;
-
 /// Errors that can occur when decoding CBOR-encoded UUIDs.
 #[derive(Display, Debug, Error)]
 pub enum CborUuidError {
@@ -32,24 +30,21 @@ pub enum CborUuidError {
     },
 }
 
-/// Encode `UUID` into `CBOR`.
-pub(crate) fn encode_cbor_uuid(uuid: uuid::Uuid) -> coset::cbor::Value {
-    coset::cbor::Value::Tag(
-        UUID_CBOR_TAG,
-        coset::cbor::Value::Bytes(uuid.as_bytes().to_vec()).into(),
-    )
+/// Decode from `CBOR` into `UUID`
+pub(crate) fn decode_cbor_uuid(
+    d: &mut Decoder<'_>, (): &mut (),
+) -> Result<uuid::Uuid, minicbor::decode::Error> {
+    let decoded = d.bytes()?.try_into().map_err(|e| {
+        minicbor::decode::Error::message(format!("Expected UUID to have 16 bytes: {e}"))
+    })?;
+    let uuid = uuid::Uuid::from_bytes(decoded);
+    Ok(uuid)
 }
 
-/// Decode `CBOR` encoded `UUID`.
-pub(crate) fn decode_cbor_uuid(val: &coset::cbor::Value) -> Result<uuid::Uuid, CborUuidError> {
-    let Some((UUID_CBOR_TAG, coset::cbor::Value::Bytes(bytes))) = val.as_tag() else {
-        return Err(CborUuidError::InvalidCborType);
-    };
-    let uuid = uuid::Uuid::from_bytes(
-        bytes
-            .clone()
-            .try_into()
-            .map_err(|_| CborUuidError::InvalidByteSize)?,
-    );
-    Ok(uuid)
+/// Encode `UUID` into `CBOR`
+pub(crate) fn encode_cbor_uuid<W: minicbor::encode::Write>(
+    uuid: uuid::Uuid, e: &mut minicbor::Encoder<W>, (): &mut (),
+) -> Result<(), minicbor::encode::Error<W::Error>> {
+    e.bytes(uuid.as_bytes())?;
+    Ok(())
 }
diff --git a/rust/catalyst-types/src/uuid/uuid_v4.rs b/rust/catalyst-types/src/uuid/uuid_v4.rs
@@ -1,6 +1,8 @@
 //! `UUIDv4` Type.
 use std::fmt::{Display, Formatter};
 
+use minicbor::{Decode, Decoder, Encode};
+
 use super::{decode_cbor_uuid, encode_cbor_uuid, INVALID_UUID};
 
 /// Type representing a `UUIDv4`.
@@ -41,29 +43,18 @@ impl Display for UuidV4 {
     }
 }
 
-impl From<UuidV4> for coset::cbor::Value {
-    fn from(val: UuidV4) -> Self {
-        encode_cbor_uuid(val.into())
+impl Decode<'_, ()> for UuidV4 {
+    fn decode(d: &mut Decoder<'_>, ctx: &mut ()) -> Result<Self, minicbor::decode::Error> {
+        let uuid = decode_cbor_uuid(d, ctx)?;
+        Ok(Self { uuid })
     }
 }
 
-impl TryFrom<&coset::cbor::Value> for UuidV4 {
-    type Error = super::CborUuidError;
-
-    fn try_from(cbor_value: &coset::cbor::Value) -> Result<Self, Self::Error> {
-        match decode_cbor_uuid(cbor_value) {
-            Ok(uuid) => {
-                if uuid.get_version_num() == Self::UUID_VERSION_NUMBER {
-                    Ok(Self { uuid })
-                } else {
-                    Err(super::CborUuidError::InvalidVersion {
-                        uuid,
-                        expected_version: Self::UUID_VERSION_NUMBER,
-                    })
-                }
-            },
-            Err(e) => Err(e),
-        }
+impl Encode<()> for UuidV4 {
+    fn encode<W: minicbor::encode::Write>(
+        &self, e: &mut minicbor::Encoder<W>, ctx: &mut (),
+    ) -> Result<(), minicbor::encode::Error<W::Error>> {
+        encode_cbor_uuid(self.uuid(), e, ctx)
     }
 }
 
@@ -87,11 +78,9 @@ impl From<UuidV4> for uuid::Uuid {
 
 #[cfg(test)]
 mod tests {
-    use coset::cbor::Value;
     use uuid::Uuid;
 
     use super::*;
-    use crate::uuid::UUID_CBOR_TAG;
 
     #[test]
     fn test_invalid_uuid() {
@@ -118,37 +107,4 @@ mod tests {
             "Zero UUID should not be valid"
         );
     }
-
-    #[test]
-    fn test_try_from_cbor_valid_uuid() {
-        let uuid = Uuid::new_v4();
-        let cbor_value = Value::Tag(
-            UUID_CBOR_TAG,
-            Box::new(Value::Bytes(uuid.as_bytes().to_vec())),
-        );
-        let result = UuidV4::try_from(&cbor_value);
-
-        assert!(
-            result.is_ok(),
-            "Should successfully parse valid UUID from CBOR"
-        );
-        let uuid_v4 = result.unwrap();
-        assert!(uuid_v4.is_valid(), "Parsed UUIDv4 should be valid");
-        assert_eq!(
-            uuid_v4.uuid(),
-            uuid,
-            "Parsed UUID should match original UUID"
-        );
-    }
-
-    #[test]
-    fn test_try_from_cbor_invalid_uuid() {
-        let cbor_value = Value::Bytes(vec![0; 16]);
-        let result = UuidV4::try_from(&cbor_value);
-
-        assert!(
-            result.is_err(),
-            "Should fail to parse invalid UUID from CBOR"
-        );
-    }
 }
diff --git a/rust/catalyst-types/src/uuid/uuid_v7.rs b/rust/catalyst-types/src/uuid/uuid_v7.rs
@@ -1,6 +1,8 @@
 //! `UUIDv7` Type.
 use std::fmt::{Display, Formatter};
 
+use minicbor::{Decode, Decoder, Encode};
+
 use super::{decode_cbor_uuid, encode_cbor_uuid, INVALID_UUID};
 
 /// Type representing a `UUIDv7`.
@@ -41,29 +43,18 @@ impl Display for UuidV7 {
     }
 }
 
-impl From<UuidV7> for coset::cbor::Value {
-    fn from(val: UuidV7) -> Self {
-        encode_cbor_uuid(val.into())
+impl Decode<'_, ()> for UuidV7 {
+    fn decode(d: &mut Decoder<'_>, ctx: &mut ()) -> Result<Self, minicbor::decode::Error> {
+        let uuid = decode_cbor_uuid(d, ctx)?;
+        Ok(Self { uuid })
     }
 }
 
-impl TryFrom<&coset::cbor::Value> for UuidV7 {
-    type Error = super::CborUuidError;
-
-    fn try_from(cbor_value: &coset::cbor::Value) -> Result<Self, Self::Error> {
-        match decode_cbor_uuid(cbor_value) {
-            Ok(uuid) => {
-                if uuid.get_version_num() == Self::UUID_VERSION_NUMBER {
-                    Ok(Self { uuid })
-                } else {
-                    Err(super::CborUuidError::InvalidVersion {
-                        uuid,
-                        expected_version: Self::UUID_VERSION_NUMBER,
-                    })
-                }
-            },
-            Err(e) => Err(e),
-        }
+impl Encode<()> for UuidV7 {
+    fn encode<W: minicbor::encode::Write>(
+        &self, e: &mut minicbor::Encoder<W>, ctx: &mut (),
+    ) -> Result<(), minicbor::encode::Error<W::Error>> {
+        encode_cbor_uuid(self.uuid(), e, ctx)
     }
 }
 
@@ -87,11 +78,9 @@ impl From<UuidV7> for uuid::Uuid {
 
 #[cfg(test)]
 mod tests {
-    use coset::cbor::Value;
     use uuid::Uuid;
 
     use super::*;
-    use crate::uuid::UUID_CBOR_TAG;
 
     #[test]
     fn test_invalid_uuid() {
@@ -119,37 +108,4 @@ mod tests {
             "Zero UUID should not be valid"
         );
     }
-
-    #[test]
-    fn test_try_from_cbor_valid_uuid() {
-        let uuid = Uuid::try_parse("017f22e3-79b0-7cc7-98cf-e0bbf8a1c5f1").unwrap();
-        let cbor_value = Value::Tag(
-            UUID_CBOR_TAG,
-            Box::new(Value::Bytes(uuid.as_bytes().to_vec())),
-        );
-        let result = UuidV7::try_from(&cbor_value);
-
-        assert!(
-            result.is_ok(),
-            "Should successfully parse valid UUID from CBOR"
-        );
-        let uuid_v7 = result.unwrap();
-        assert!(uuid_v7.is_valid(), "Parsed UUIDv7 should be valid");
-        assert_eq!(
-            uuid_v7.uuid(),
-            uuid,
-            "Parsed UUID should match original UUID"
-        );
-    }
-
-    #[test]
-    fn test_try_from_cbor_invalid_uuid() {
-        let cbor_value = Value::Bytes(vec![0; 16]);
-        let result = UuidV7::try_from(&cbor_value);
-
-        assert!(
-            result.is_err(),
-            "Should fail to parse invalid UUID from CBOR"
-        );
-    }
 }
