feat: uuid

Author: apskhem

rust/catalyst-types/Cargo.toml

@@ -18,10 +18,12 @@ name = "catalyst_types"
 [dependencies]
 anyhow = "1.0.95"
 blake2b_simd = "1.0.2"
+coset = "0.3.8"
 ed25519-dalek = "2.1.1"
 hex = "0.4.3"
 minicbor = { version = "0.25.1", features = ["std"] }
 num-traits = "0.2.19"
 orx-concurrent-vec = "3.1.0"
 pallas-crypto = { version = "0.30.1", git = "https://github.com/input-output-hk/catalyst-pallas.git", rev = "9b5183c8b90b90fe2cc319d986e933e9518957b3" }
 serde = { version = "1.0.217", features = ["derive"] }
+uuid = { version = "1.11.0", features = ["v4", "v7", "serde"] }

rust/catalyst-types/src/lib.rs

@@ -3,3 +3,4 @@
 pub mod conversion;
 pub mod hashes;
 pub mod problem_report;
+pub mod uuid;

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

@@ -0,0 +1,27 @@
+//! `UUID` types.
+
+mod uuid_v4;
+mod uuid_v7;
+
+pub use uuid_v4::UuidV4;
+pub use uuid_v7::UuidV7;
+
+/// Invalid Doc Type UUID
+pub const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
+
+/// CBOR tag for UUID content.
+const UUID_CBOR_TAG: u64 = 37;
+
+/// Decode `CBOR` encoded `UUID`.
+pub fn decode_cbor_uuid(val: &coset::cbor::Value) -> anyhow::Result<uuid::Uuid> {
+    let Some((UUID_CBOR_TAG, coset::cbor::Value::Bytes(bytes))) = val.as_tag() else {
+        anyhow::bail!("Invalid CBOR encoded UUID type");
+    };
+    let uuid = uuid::Uuid::from_bytes(
+        bytes
+            .clone()
+            .try_into()
+            .map_err(|_| anyhow::anyhow!("Invalid CBOR encoded UUID type, invalid bytes size"))?,
+    );
+    Ok(uuid)
+}

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

@@ -0,0 +1,67 @@
+//! `UUIDv4` Type.
+use std::fmt::{Display, Formatter};
+
+use super::{decode_cbor_uuid, INVALID_UUID};
+
+/// Type representing a `UUIDv4`.
+#[derive(Copy, Clone, Debug, PartialEq, PartialOrd, serde::Deserialize)]
+#[serde(from = "uuid::Uuid")]
+pub struct UuidV4 {
+    /// UUID
+    uuid: uuid::Uuid,
+}
+
+impl UuidV4 {
+    /// Version for `UUIDv4`.
+    const UUID_VERSION_NUMBER: usize = 4;
+
+    /// Generates a zeroed out `UUIDv4` that can never be valid.
+    pub fn invalid() -> Self {
+        Self { uuid: INVALID_UUID }
+    }
+
+    /// Check if this is a valid `UUIDv4`.
+    pub fn is_valid(&self) -> bool {
+        self.uuid != INVALID_UUID && self.uuid.get_version_num() == Self::UUID_VERSION_NUMBER
+    }
+
+    /// Returns the `uuid::Uuid` type.
+    #[must_use]
+    pub fn uuid(&self) -> uuid::Uuid {
+        self.uuid
+    }
+}
+
+impl Display for UuidV4 {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
+        write!(f, "{}", self.uuid)
+    }
+}
+
+impl TryFrom<&coset::cbor::Value> for UuidV4 {
+    type Error = anyhow::Error;
+
+    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 {
+                    anyhow::bail!("UUID {uuid} is not `v{}`", Self::UUID_VERSION_NUMBER);
+                }
+            },
+            Err(e) => {
+                anyhow::bail!("Invalid UUID. Error: {e}");
+            },
+        }
+    }
+}
+
+/// Returns a `UUIDv4` from `uuid::Uuid`.
+///
+/// NOTE: This does not guarantee that the `UUID` is valid.
+impl From<uuid::Uuid> for UuidV4 {
+    fn from(uuid: uuid::Uuid) -> Self {
+        Self { uuid }
+    }
+}

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

@@ -0,0 +1,69 @@
+//! `UUIDv7` Type.
+use std::fmt::{Display, Formatter};
+
+use super::{decode_cbor_uuid, INVALID_UUID};
+
+/// Type representing a `UUIDv7`.
+#[derive(Copy, Clone, Debug, PartialEq, PartialOrd, serde::Deserialize)]
+#[serde(from = "uuid::Uuid")]
+pub struct UuidV7 {
+    /// UUID
+    uuid: uuid::Uuid,
+}
+
+impl UuidV7 {
+    /// Version for `UUIDv7`.
+    const UUID_VERSION_NUMBER: usize = 7;
+
+    /// Generates a zeroed out `UUIDv7` that can never be valid.
+    #[must_use]
+    pub fn invalid() -> Self {
+        Self { uuid: INVALID_UUID }
+    }
+
+    /// Check if this is a valid `UUIDv7`.
+    #[must_use]
+    pub fn is_valid(&self) -> bool {
+        self.uuid != INVALID_UUID && self.uuid.get_version_num() == Self::UUID_VERSION_NUMBER
+    }
+
+    /// Returns the `uuid::Uuid` type.
+    #[must_use]
+    pub fn uuid(&self) -> uuid::Uuid {
+        self.uuid
+    }
+}
+
+impl Display for UuidV7 {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
+        write!(f, "{}", self.uuid)
+    }
+}
+
+impl TryFrom<&coset::cbor::Value> for UuidV7 {
+    type Error = anyhow::Error;
+
+    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 {
+                    anyhow::bail!("UUID {uuid} is not `v{}`", Self::UUID_VERSION_NUMBER);
+                }
+            },
+            Err(e) => {
+                anyhow::bail!("Invalid UUID. Error: {e}");
+            },
+        }
+    }
+}
+
+/// Returns a `UUIDv7` from `uuid::Uuid`.
+///
+/// NOTE: This does not guarantee that the `UUID` is valid.
+impl From<uuid::Uuid> for UuidV7 {
+    fn from(uuid: uuid::Uuid) -> Self {
+        Self { uuid }
+    }
+}