Merge branch 'main' into feat/use-catalyst-id

Author: saibatizoku

rust/signed_doc/src/doc_types/mod.rs

@@ -0,0 +1,116 @@
+//! An implementation of different defined document types
+//! <https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/signed_doc/types/>
+
+mod proposal_document;
+
+use catalyst_types::uuid::UuidV4;
+pub use proposal_document::{ProposalDocument, PROPOSAL_DOCUMENT_UUID_TYPE};
+
+/// Represents different types of documents.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum DocumentType {
+    /// A proposal document containing proposal details.
+    ProposalDocument,
+    /// A template for proposal documents, defining the expected structure.
+    ProposalTemplate,
+    /// A document representing a comment on a proposal.
+    CommentDocument,
+    /// A template for comment documents, defining the expected structure.
+    CommentTemplate,
+    /// A review document containing feedback on a proposal.
+    ReviewDocument,
+    /// A template for review documents, defining the expected structure.
+    ReviewTemplate,
+    /// A document defining parameters for a specific category.
+    CategoryParametersDocument,
+    /// A template for category parameter documents, defining the expected structure.
+    CategoryParametersTemplate,
+    /// A document containing parameters for a specific campaign.
+    CampaignParametersDocument,
+    /// A template for campaign parameter documents, defining the expected structure.
+    CampaignParametersTemplate,
+    /// A document containing brand-related parameters.
+    BrandParametersDocument,
+    /// A template for brand parameter documents, defining the expected structure.
+    BrandParametersTemplate,
+    /// A document representing an action related to a proposal.
+    ProposalActionDocument,
+    /// A public voting transaction version 2.
+    PublicVoteTxV2,
+    /// A private voting transaction version 2.
+    PrivateVoteTxV2,
+    /// A block in the immutable ledger.
+    ImmutableLedgerBlock,
+}
+
+/// Proposal template `UuidV4` type.
+const PROPOSAL_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x0CE8_AB38_9258_4FBC_A62E_7FAA_6E58_318F);
+/// Comment document `UuidV4` type.
+const COMMENT_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xB679_DED3_0E7C_41BA_89F8_DA62_A178_98EA);
+/// Comment template `UuidV4` type.
+const COMMENT_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x0B84_24D4_EBFD_46E3_9577_1775_A69D_290C);
+/// Review document `UuidV4` type.
+const REVIEW_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xE4CA_F5F0_098B_45FD_94F3_0702_A457_3DB5);
+/// Review template `UuidV4` type.
+const REVIEW_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xEBE5_D0BF_5D86_4577_AF4D_008F_DDBE_2EDC);
+/// Category parameters document `UuidV4` type.
+const CATEGORY_PARAMETERS_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x48C2_0109_362A_4D32_9BBA_E0A9_CF8B_45BE);
+/// Category parameters template `UuidV4` type.
+const CATEGORY_PARAMETERS_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x65B1_E8B0_51F1_46A5_9970_72CD_F268_84BE);
+/// Campaign parameters document `UuidV4` type.
+const CAMPAIGN_PARAMETERS_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x0110_EA96_A555_47CE_8408_36EF_E6ED_6F7C);
+/// Campaign parameters template `UuidV4` type.
+const CAMPAIGN_PARAMETERS_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x7E8F_5FA2_44CE_49C8_BFD5_02AF_42C1_79A3);
+/// Brand parameters document `UuidV4` type.
+const BRAND_PARAMETERS_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x3E48_08CC_C86E_467B_9702_D60B_AA9D_1FCA);
+/// Brand parameters template `UuidV4` type.
+const BRAND_PARAMETERS_TEMPLATE_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xFD3C_1735_80B1_4EEA_8D63_5F43_6D97_EA31);
+/// Proposal action document `UuidV4` type.
+const PROPOSAL_ACTION_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x5E60_E623_AD02_4A1B_A1AC_406D_B978_EE48);
+/// Public vote transaction v2 `UuidV4` type.
+const PUBLIC_VOTE_TX_V2_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x8DE5_586C_E998_4B95_8742_7BE3_C859_2803);
+/// Private vote transaction v2 `UuidV4` type.
+const PRIVATE_VOTE_TX_V2_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xE78E_E18D_F380_44C1_A852_80AA_6ECB_07FE);
+/// Immutable ledger block `UuidV4` type.
+const IMMUTABLE_LEDGER_BLOCK_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0xD9E7_E6CE_2401_4D7D_9492_F4F7_C642_41C3);
+
+impl TryFrom<UuidV4> for DocumentType {
+    type Error = anyhow::Error;
+
+    fn try_from(uuid: UuidV4) -> Result<Self, Self::Error> {
+        match uuid.uuid() {
+            PROPOSAL_DOCUMENT_UUID_TYPE => Ok(DocumentType::ProposalDocument),
+            PROPOSAL_TEMPLATE_UUID_TYPE => Ok(DocumentType::ProposalTemplate),
+            COMMENT_DOCUMENT_UUID_TYPE => Ok(DocumentType::CommentDocument),
+            COMMENT_TEMPLATE_UUID_TYPE => Ok(DocumentType::CommentTemplate),
+            REVIEW_DOCUMENT_UUID_TYPE => Ok(DocumentType::ReviewDocument),
+            REVIEW_TEMPLATE_UUID_TYPE => Ok(DocumentType::ReviewTemplate),
+            CATEGORY_PARAMETERS_DOCUMENT_UUID_TYPE => Ok(DocumentType::CategoryParametersDocument),
+            CATEGORY_PARAMETERS_TEMPLATE_UUID_TYPE => Ok(DocumentType::CategoryParametersTemplate),
+            CAMPAIGN_PARAMETERS_DOCUMENT_UUID_TYPE => Ok(DocumentType::CampaignParametersDocument),
+            CAMPAIGN_PARAMETERS_TEMPLATE_UUID_TYPE => Ok(DocumentType::CampaignParametersTemplate),
+            BRAND_PARAMETERS_DOCUMENT_UUID_TYPE => Ok(DocumentType::BrandParametersDocument),
+            BRAND_PARAMETERS_TEMPLATE_UUID_TYPE => Ok(DocumentType::BrandParametersTemplate),
+            PROPOSAL_ACTION_DOCUMENT_UUID_TYPE => Ok(DocumentType::ProposalActionDocument),
+            PUBLIC_VOTE_TX_V2_UUID_TYPE => Ok(DocumentType::PublicVoteTxV2),
+            PRIVATE_VOTE_TX_V2_UUID_TYPE => Ok(DocumentType::PrivateVoteTxV2),
+            IMMUTABLE_LEDGER_BLOCK_UUID_TYPE => Ok(DocumentType::ImmutableLedgerBlock),
+            _ => anyhow::bail!("Unsupported document type"),
+        }
+    }
+}

rust/signed_doc/src/doc_types/proposal_document.rs

@@ -0,0 +1,68 @@
+//! Proposal Document object implementation
+//! <https://input-output-hk.github.io/catalyst-libs/architecture/08_concepts/catalyst_docs/proposal/#proposal-document>
+
+use catalyst_types::problem_report::ProblemReport;
+
+use crate::{error::CatalystSignedDocError, CatalystSignedDocument};
+
+/// Proposal document `UuidV4` type.
+pub const PROPOSAL_DOCUMENT_UUID_TYPE: uuid::Uuid =
+    uuid::Uuid::from_u128(0x7808_D2BA_D511_40AF_84E8_C0D1_625F_DFDC);
+
+/// Proposal Document struct
+pub struct ProposalDocument {
+    /// Proposal document content data
+    /// TODO: change it to `serde_json::Value` type
+    #[allow(dead_code)]
+    content: Vec<u8>,
+}
+
+impl ProposalDocument {
+    /// Try to build `ProposalDocument` from `CatalystSignedDoc` doing all necessary
+    /// stateless verifications,
+    #[allow(dead_code)]
+    pub(crate) fn from_signed_doc(
+        doc: &CatalystSignedDocument, error_report: &ProblemReport,
+    ) -> anyhow::Result<Self> {
+        /// Context for error messages.
+        const CONTEXT: &str = "Catalyst Signed Document to Proposal Document";
+        let mut failed = false;
+
+        if doc.doc_type().uuid() != PROPOSAL_DOCUMENT_UUID_TYPE {
+            error_report.invalid_value(
+                "`type`",
+                &doc.doc_type().to_string(),
+                &format!("Proposal Document type UUID value is {PROPOSAL_DOCUMENT_UUID_TYPE}"),
+                CONTEXT,
+            );
+            failed = true;
+        }
+
+        // TODO add other validation
+
+        if failed {
+            anyhow::bail!("Failed to build `ProposalDocument` from `CatalystSignedDoc`");
+        }
+
+        let content = doc.doc_content().decoded_bytes().to_vec();
+        Ok(Self { content })
+    }
+
+    /// A comprehensive validation of the `ProposalDocument` content.
+    #[allow(clippy::unused_self)]
+    pub(crate) fn validate_with_report<F>(&self, _doc_getter: F, _error_report: &ProblemReport)
+    where F: FnMut() -> Option<CatalystSignedDocument> {
+        // TODO: implement the rest of the validation
+    }
+}
+
+impl TryFrom<CatalystSignedDocument> for ProposalDocument {
+    type Error = CatalystSignedDocError;
+
+    fn try_from(doc: CatalystSignedDocument) -> Result<Self, Self::Error> {
+        let error_report = ProblemReport::new("Proposal Document");
+        let res = Self::from_signed_doc(&doc, &error_report)
+            .map_err(|e| CatalystSignedDocError::new(error_report, e))?;
+        Ok(res)
+    }
+}

rust/signed_doc/src/lib.rs

@@ -2,10 +2,12 @@
 
 mod builder;
 mod content;
+pub mod doc_types;
 pub mod error;
 mod metadata;
 mod signature;
 mod utils;
+pub mod validator;
 
 use std::{
     convert::TryFrom,
@@ -15,10 +17,11 @@ use std::{
 
 pub use builder::Builder;
 use catalyst_types::problem_report::ProblemReport;
+pub use catalyst_types::uuid::{UuidV4, UuidV7};
 pub use content::Content;
 use coset::{CborSerializable, Header};
 use error::CatalystSignedDocError;
-pub use metadata::{DocumentRef, ExtraFields, Metadata, UuidV4, UuidV7};
+pub use metadata::{DocumentRef, ExtraFields, Metadata};
 pub use minicbor::{decode, encode, Decode, Decoder, Encode};
 pub use rbac_registration::cardano::cip509::SimplePublicKeyType;
 pub use signature::{IdUri, Signatures};

rust/signed_doc/src/metadata/content_type.rs

@@ -40,8 +40,8 @@ impl ContentType {
 impl Display for ContentType {
     fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
         match self {
-            Self::Cbor => write!(f, "cbor"),
-            Self::Json => write!(f, "json"),
+            Self::Cbor => write!(f, "application/cbor"),
+            Self::Json => write!(f, "application/json"),
         }
     }
 }
@@ -51,8 +51,8 @@ impl FromStr for ContentType {
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         match s {
-            "cbor" => Ok(Self::Cbor),
-            "json" => Ok(Self::Json),
+            "application/cbor" => Ok(Self::Cbor),
+            "application/json" => Ok(Self::Json),
             _ => {
                 anyhow::bail!(
                     "Unsupported Content Type: {s:?}, Supported only: {:?}",
@@ -112,4 +112,24 @@ mod tests {
         assert!(ContentType::Json.validate(&cbor_bytes).is_err());
         assert!(ContentType::Cbor.validate(&cbor_bytes).is_ok());
     }
+
+    #[test]
+    fn content_type_string_test() {
+        assert_eq!(
+            ContentType::from_str("application/cbor").unwrap(),
+            ContentType::Cbor
+        );
+        assert_eq!(
+            ContentType::from_str("application/json").unwrap(),
+            ContentType::Json
+        );
+        assert_eq!(
+            "application/cbor".parse::<ContentType>().unwrap(),
+            ContentType::Cbor
+        );
+        assert_eq!(
+            "application/json".parse::<ContentType>().unwrap(),
+            ContentType::Json
+        );
+    }
 }

rust/signed_doc/src/metadata/document_id.rs

@@ -13,6 +13,17 @@ pub struct DocumentRef {
     pub ver: Option<UuidV7>,
 }
 
+impl DocumentRef {
+    /// Determine if internal `UUID`s are valid.
+    #[must_use]
+    pub fn is_valid(&self) -> bool {
+        match self.ver {
+            Some(ver) => self.id.is_valid() && ver.is_valid() && ver >= self.id,
+            None => self.id.is_valid(),
+        }
+    }
+}
+
 impl TryFrom<DocumentRef> for Value {
     type Error = anyhow::Error;