add Proposal Document type

Author: Mr-Leshiy

rust/signed_doc/src/doc_types/mod.rs

@@ -1,7 +1,10 @@
 //! An implmenetation 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;
 
 /// Represents different types of documents.
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]

rust/signed_doc/src/doc_types/proposal_document.rs

@@ -0,0 +1,60 @@
+//! 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.
+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` collecting report
+    #[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 })
+    }
+}
+
+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/validator/mod.rs

@@ -2,7 +2,11 @@
 
 use catalyst_types::problem_report::ProblemReport;
 
-use crate::{doc_types::DocumentType, error::CatalystSignedDocError, CatalystSignedDocument};
+use crate::{
+    doc_types::{DocumentType, ProposalDocument},
+    error::CatalystSignedDocError,
+    CatalystSignedDocument,
+};
 
 /// `CatalystSignedDocument` type based specific validation
 ///
@@ -16,7 +20,7 @@ pub fn validate(doc: &CatalystSignedDocument) -> Result<(), CatalystSignedDocErr
         Ok(doc_type) => doc_type,
         Err(e) => {
             error_report.invalid_value(
-                "document `type`",
+                "`type`",
                 &doc.doc_type().to_string(),
                 &e.to_string(),
                 "verifying document type",
@@ -30,7 +34,9 @@ pub fn validate(doc: &CatalystSignedDocument) -> Result<(), CatalystSignedDocErr
 
     #[allow(clippy::match_same_arms)]
     match doc_type {
-        DocumentType::ProposalDocument => {},
+        DocumentType::ProposalDocument => {
+            drop(ProposalDocument::from_signed_doc(doc, &error_report));
+        },
         DocumentType::ProposalTemplate => {},
         DocumentType::CommentDocument => {},
         DocumentType::CommentTemplate => {},