fix(signed-doc): improve static doc types

Signed-off-by: bkioshn <bkioshn@gmail.com>

Author: bkioshn

rust/signed_doc/src/doc_types/mod.rs

@@ -4,56 +4,63 @@
 use std::sync::LazyLock;
 
 use catalyst_types::uuid::Uuid;
-use deprecated::{
-    COMMENT_DOCUMENT_UUID_TYPE, PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, PROPOSAL_DOCUMENT_UUID_TYPE,
-};
 
-use crate::{doc_types::deprecated::PROPOSAL_TEMPLATE_UUID_TYPE, DocType};
+use crate::DocType;
 
 /// Proposal document type.
 #[allow(clippy::expect_used)]
-pub static PROPOSAL_DOC_TYPE: LazyLock<DocType> = LazyLock::new(|| {
-    let ids = &[PROPOSAL_UUID_TYPE];
+pub static PROPOSAL: LazyLock<DocType> = LazyLock::new(|| {
+    let ids = &[PROPOSAL_BASE_TYPE];
     ids.to_vec()
         .try_into()
         .expect("Failed to convert proposal document Uuid to DocType")
 });
 
 /// Proposal comment document type.
 #[allow(clippy::expect_used)]
-pub static PROPOSAL_COMMENT_DOC: LazyLock<DocType> = LazyLock::new(|| {
-    let ids = &[COMMENT_UUID_TYPE, PROPOSAL_UUID_TYPE];
+pub static PROPOSAL_COMMENT: LazyLock<DocType> = LazyLock::new(|| {
+    let ids = &[COMMENT_BASE_TYPE, PROPOSAL_BASE_TYPE];
     ids.to_vec()
         .try_into()
         .expect("Failed to convert proposal comment document Uuid to DocType")
 });
 
 /// Proposal action document type.
 #[allow(clippy::expect_used)]
-pub static PROPOSAL_ACTION_DOC: LazyLock<DocType> = LazyLock::new(|| {
+pub static PROPOSAL_SUBMISSION_ACTION: LazyLock<DocType> = LazyLock::new(|| {
     let ids = &[
-        ACTION_UUID_TYPE,
-        PROPOSAL_UUID_TYPE,
-        SUBMISSION_ACTION_UUID_TYPE,
+        ACTION_BASE_TYPE,
+        PROPOSAL_BASE_TYPE,
+        SUBMISSION_ACTION_BASE_TYPE,
     ];
     ids.to_vec()
         .try_into()
         .expect("Failed to convert proposal action document Uuid to DocType")
 });
 
-/// Submission Action UUID type.
-pub const SUBMISSION_ACTION_UUID_TYPE: Uuid =
+/// -------------- Base Types --------------
+/// Action UUID base type.
+pub const ACTION_BASE_TYPE: Uuid = Uuid::from_u128(0x5E60_E623_AD02_4A1B_A1AC_406D_B978_EE48);
+/// Brand UUID base type.
+pub const BRAND_BASE_TYPE: Uuid = Uuid::from_u128(0xEBCA_BEEB_5BC5_4F95_91E8_CAB8_CA72_4172);
+/// Campaign UUID base type.
+pub const CAMPAIGN_BASE_TYPE: Uuid = Uuid::from_u128(0x5EF3_2D5D_F240_462C_A7A4_BA4A_F221_FA23);
+/// Category UUID base type.
+pub const CATEGORY_BASE_TYPE: Uuid = Uuid::from_u128(0x8189_38C3_3139_4DAA_AFE6_974C_7848_8E95);
+/// Comment UUID base type.
+pub const COMMENT_BASE_TYPE: Uuid = Uuid::from_u128(0xB679_DED3_0E7C_41BA_89F8_DA62_A178_98EA);
+/// Decision UUID base type.
+pub const DECISION_BASE_TYPE: Uuid = Uuid::from_u128(0x788F_F4C6_D65A_451F_BB33_575F_E056_B411);
+/// Moderation Action UUID base type.
+pub const MODERATION_ACTION_BASE_TYPE: Uuid =
+    Uuid::from_u128(0xA5D2_32B8_5E03_4117_9AFD_BE32_B878_FCDD);
+/// Proposal UUID base type.
+pub const PROPOSAL_BASE_TYPE: Uuid = Uuid::from_u128(0x7808_D2BA_D511_40AF_84E8_C0D1_625F_DFDC);
+/// Submission Action UUID base type.
+pub const SUBMISSION_ACTION_BASE_TYPE: Uuid =
     Uuid::from_u128(0x7892_7329_CFD9_4EA1_9C71_0E01_9B12_6A65);
-/// Category UUID type.
-pub const CATEGORY_UUID_TYPE: Uuid = Uuid::from_u128(0x818938C3_3139_4DAA_AFE6_974C78488E95);
-/// Proposal UUID type.
-pub const PROPOSAL_UUID_TYPE: Uuid = PROPOSAL_DOCUMENT_UUID_TYPE;
-/// Comment UUID type.
-pub const COMMENT_UUID_TYPE: Uuid = COMMENT_DOCUMENT_UUID_TYPE;
-/// Action UUID type.
-pub const ACTION_UUID_TYPE: Uuid = PROPOSAL_ACTION_DOCUMENT_UUID_TYPE;
-/// Template UUID type.
-pub const TEMPLATE_UUID_TYPE: Uuid = PROPOSAL_TEMPLATE_UUID_TYPE;
+/// Template UUID base type.
+pub const TEMPLATE_BASE_TYPE: Uuid = Uuid::from_u128(0x0CE8_AB38_9258_4FBC_A62E_7FAA_6E58_318F);
 
 /// Document type which will be deprecated.
 pub mod deprecated {

rust/signed_doc/src/metadata/doc_type.rs

@@ -16,10 +16,7 @@ use tracing::warn;
 
 use crate::{
     decode_context::{CompatibilityPolicy, DecodeContext},
-    doc_types::{
-        ACTION_UUID_TYPE, COMMENT_UUID_TYPE, PROPOSAL_ACTION_DOC, PROPOSAL_COMMENT_DOC,
-        PROPOSAL_DOC_TYPE, PROPOSAL_UUID_TYPE,
-    },
+    doc_types::{deprecated, PROPOSAL, PROPOSAL_COMMENT, PROPOSAL_SUBMISSION_ACTION},
 };
 
 /// List of `UUIDv4` document type.
@@ -252,9 +249,11 @@ impl Decode<'_, DecodeContext<'_>> for DocType {
 /// <https://github.com/input-output-hk/catalyst-libs/blob/main/docs/src/architecture/08_concepts/signed_doc/types.md#document-types>
 fn map_doc_type(uuid: Uuid) -> anyhow::Result<DocType> {
     match uuid {
-        id if id == PROPOSAL_UUID_TYPE => Ok(PROPOSAL_DOC_TYPE.clone()),
-        id if id == COMMENT_UUID_TYPE => Ok(PROPOSAL_COMMENT_DOC.clone()),
-        id if id == ACTION_UUID_TYPE => Ok(PROPOSAL_ACTION_DOC.clone()),
+        id if id == deprecated::PROPOSAL_DOCUMENT_UUID_TYPE => Ok(PROPOSAL.clone()),
+        id if id == deprecated::COMMENT_DOCUMENT_UUID_TYPE => Ok(PROPOSAL_COMMENT.clone()),
+        id if id == deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE => {
+            Ok(PROPOSAL_SUBMISSION_ACTION.clone())
+        },
         _ => anyhow::bail!("Unknown document type: {uuid}"),
     }
 }
@@ -337,9 +336,12 @@ impl PartialEq for DocType {
         // List of special-case (single UUID) -> new DocType
         // The old one should equal to the new one
         let special_cases = [
-            (PROPOSAL_UUID_TYPE, &*PROPOSAL_DOC_TYPE),
-            (COMMENT_UUID_TYPE, &*PROPOSAL_COMMENT_DOC),
-            (ACTION_UUID_TYPE, &*PROPOSAL_ACTION_DOC),
+            (deprecated::PROPOSAL_DOCUMENT_UUID_TYPE, &*PROPOSAL),
+            (deprecated::COMMENT_DOCUMENT_UUID_TYPE, &*PROPOSAL_COMMENT),
+            (
+                deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE,
+                &*PROPOSAL_SUBMISSION_ACTION,
+            ),
         ];
         for (uuid, expected) in special_cases {
             match DocType::try_from(uuid) {
@@ -478,18 +480,18 @@ mod tests {
     #[test]
     fn test_doctype_equal_special_cases() {
         // Direct equal
-        let uuid = PROPOSAL_UUID_TYPE;
+        let uuid = deprecated::PROPOSAL_DOCUMENT_UUID_TYPE;
         let dt1 = DocType::try_from(vec![uuid]).unwrap();
         let dt2 = DocType::try_from(vec![uuid]).unwrap();
         assert_eq!(dt1, dt2);
 
         // single -> special mapped type
-        let single = DocType::try_from(PROPOSAL_UUID_TYPE).unwrap();
-        assert_eq!(single, *PROPOSAL_DOC_TYPE);
-        let single = DocType::try_from(COMMENT_UUID_TYPE).unwrap();
-        assert_eq!(single, *PROPOSAL_COMMENT_DOC);
-        let single = DocType::try_from(ACTION_UUID_TYPE).unwrap();
-        assert_eq!(single, *PROPOSAL_ACTION_DOC);
+        let single = DocType::try_from(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap();
+        assert_eq!(single, *PROPOSAL);
+        let single = DocType::try_from(deprecated::COMMENT_DOCUMENT_UUID_TYPE).unwrap();
+        assert_eq!(single, *PROPOSAL_COMMENT);
+        let single = DocType::try_from(deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE).unwrap();
+        assert_eq!(single, *PROPOSAL_SUBMISSION_ACTION);
     }
 
     #[test]
@@ -518,10 +520,10 @@ mod tests {
 
     #[test]
     fn test_deserialize_special_case() {
-        let uuid = PROPOSAL_UUID_TYPE.to_string();
+        let uuid = deprecated::PROPOSAL_DOCUMENT_UUID_TYPE.to_string();
         let json = json!(uuid);
         let dt: DocType = serde_json::from_value(json).unwrap();
 
-        assert_eq!(dt, *PROPOSAL_DOC_TYPE);
+        assert_eq!(dt, *PROPOSAL);
     }
 }

rust/signed_doc/src/validator/mod.rs

@@ -23,7 +23,7 @@ use rules::{
 use crate::{
     doc_types::{
         deprecated::{self},
-        PROPOSAL_ACTION_DOC, PROPOSAL_COMMENT_DOC, PROPOSAL_DOC_TYPE,
+        PROPOSAL, PROPOSAL_COMMENT, PROPOSAL_SUBMISSION_ACTION,
     },
     metadata::DocType,
     providers::{CatalystSignedDocumentProvider, VerifyingKeyProvider},
@@ -136,9 +136,12 @@ fn document_rules_init() -> HashMap<DocType, Arc<Rules>> {
     let comment_rules = Arc::new(comment_document_rules);
     let action_rules = Arc::new(proposal_submission_action_rules);
 
-    document_rules_map.insert(PROPOSAL_DOC_TYPE.clone(), Arc::clone(&proposal_rules));
-    document_rules_map.insert(PROPOSAL_COMMENT_DOC.clone(), Arc::clone(&comment_rules));
-    document_rules_map.insert(PROPOSAL_ACTION_DOC.clone(), Arc::clone(&action_rules));
+    document_rules_map.insert(PROPOSAL.clone(), Arc::clone(&proposal_rules));
+    document_rules_map.insert(PROPOSAL_COMMENT.clone(), Arc::clone(&comment_rules));
+    document_rules_map.insert(
+        PROPOSAL_SUBMISSION_ACTION.clone(),
+        Arc::clone(&action_rules),
+    );
 
     // Insert old rules (for backward compatibility)
     document_rules_map.insert(

rust/signed_doc/tests/comment.rs

@@ -1,23 +1,25 @@
 //! Integration test for comment document validation part.
 
-use catalyst_signed_doc::{providers::tests::TestCatalystSignedDocumentProvider, *};
+use catalyst_signed_doc::{
+    doc_types::deprecated, providers::tests::TestCatalystSignedDocumentProvider, *,
+};
 use catalyst_types::catalyst_id::role_index::RoleId;
 
 mod common;
 
 #[tokio::test]
 async fn test_valid_comment_doc() {
     let (proposal_doc, proposal_doc_id, proposal_doc_ver) =
-        common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap();
     let (template_doc, template_doc_id, template_doc_ver) =
-        common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
 
     let uuid_v7 = UuidV7::new();
     let (doc, ..) = common::create_dummy_signed_doc(
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_COMMENT_DOC.clone(),
+            "type": doc_types::PROPOSAL_COMMENT.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {
@@ -46,17 +48,17 @@ async fn test_valid_comment_doc() {
 #[tokio::test]
 async fn test_valid_comment_doc_old_type() {
     let (proposal_doc, proposal_doc_id, proposal_doc_ver) =
-        common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap();
     let (template_doc, template_doc_id, template_doc_ver) =
-        common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
 
     let uuid_v7 = UuidV7::new();
     let (doc, ..) = common::create_dummy_signed_doc(
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
             // Using old (single uuid)
-            "type": doc_types::deprecated::COMMENT_DOCUMENT_UUID_TYPE,
+            "type": deprecated::COMMENT_DOCUMENT_UUID_TYPE,
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {
@@ -87,17 +89,17 @@ async fn test_valid_comment_doc_with_reply() {
     let empty_json = serde_json::to_vec(&serde_json::json!({})).unwrap();
 
     let (proposal_doc, proposal_doc_id, proposal_doc_ver) =
-        common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap();
     let (template_doc, template_doc_id, template_doc_ver) =
-        common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
 
     let comment_doc_id = UuidV7::new();
     let comment_doc_ver = UuidV7::new();
     let comment_doc = Builder::new()
         .with_json_metadata(serde_json::json!({
             "id": comment_doc_id,
             "ver": comment_doc_ver,
-            "type": doc_types::PROPOSAL_COMMENT_DOC.clone(),
+            "type": doc_types::PROPOSAL_COMMENT.clone(),
             "content-type": ContentType::Json.to_string(),
             "template": { "id": template_doc_id.to_string(), "ver": template_doc_ver.to_string() },
             "ref": {
@@ -114,7 +116,7 @@ async fn test_valid_comment_doc_with_reply() {
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_COMMENT_DOC.clone(),
+            "type": doc_types::PROPOSAL_COMMENT.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {
@@ -147,16 +149,17 @@ async fn test_valid_comment_doc_with_reply() {
 
 #[tokio::test]
 async fn test_invalid_comment_doc() {
-    let (proposal_doc, ..) = common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap();
+    let (proposal_doc, ..) =
+        common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap();
     let (template_doc, template_doc_id, template_doc_ver) =
-        common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
+        common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap();
 
     let uuid_v7 = UuidV7::new();
     let (doc, ..) = common::create_dummy_signed_doc(
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_COMMENT_DOC.clone(),
+            "type": doc_types::PROPOSAL_COMMENT.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {

rust/signed_doc/tests/decoding.rs

@@ -1,6 +1,6 @@
 //! Integration test for COSE decoding part.
 
-use catalyst_signed_doc::{providers::tests::TestVerifyingKeyProvider, *};
+use catalyst_signed_doc::{doc_types::deprecated, providers::tests::TestVerifyingKeyProvider, *};
 use catalyst_types::catalyst_id::role_index::RoleId;
 use common::create_dummy_key_pair;
 use coset::TaggedCborSerializable;
@@ -12,7 +12,7 @@ mod common;
 fn catalyst_signed_doc_cbor_roundtrip_kid_as_id_test() {
     catalyst_signed_doc_cbor_roundtrip_kid_as_id(common::test_metadata());
     catalyst_signed_doc_cbor_roundtrip_kid_as_id(common::test_metadata_specific_type(
-        Some(doc_types::PROPOSAL_UUID_TYPE.try_into().unwrap()),
+        Some(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE.try_into().unwrap()),
         None,
     ));
 }
@@ -41,7 +41,7 @@ fn catalyst_signed_doc_cbor_roundtrip_kid_as_id(data: (UuidV7, UuidV4, serde_jso
 async fn catalyst_signed_doc_parameters_aliases_test() {
     catalyst_signed_doc_parameters_aliases(common::test_metadata()).await;
     catalyst_signed_doc_parameters_aliases(common::test_metadata_specific_type(
-        Some(doc_types::PROPOSAL_UUID_TYPE.try_into().unwrap()),
+        Some(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE.try_into().unwrap()),
         None,
     ))
     .await;

rust/signed_doc/tests/proposal.rs

@@ -15,7 +15,7 @@ async fn test_valid_proposal_doc() {
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_DOC_TYPE.clone(),
+            "type": doc_types::PROPOSAL.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {
@@ -79,7 +79,7 @@ async fn test_valid_proposal_doc_with_empty_provider() {
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_DOC_TYPE.clone(),
+            "type": doc_types::PROPOSAL.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             "template": {
@@ -106,7 +106,7 @@ async fn test_invalid_proposal_doc() {
         serde_json::json!({
             "content-type": ContentType::Json.to_string(),
             "content-encoding": ContentEncoding::Brotli.to_string(),
-            "type": doc_types::PROPOSAL_DOC_TYPE.clone(),
+            "type": doc_types::PROPOSAL.clone(),
             "id": uuid_v7.to_string(),
             "ver": uuid_v7.to_string(),
             // without specifying template id