Merge branch 'main' into fix/validate-addr-uri-witness

bkioshn · web-flow · commit 730f0e5124d7 · 2025-09-02T14:35:00.000+07:00
diff --git a/Earthfile b/Earthfile
@@ -1,9 +1,9 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/mdlint:v3.5.7 AS mdlint-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.5.7 AS cspell-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.7 AS python-ci
-IMPORT github.com/input-output-hk/catalyst-ci:v3.5.7 AS cat-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/mdlint:v3.5.12 AS mdlint-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.5.12 AS cspell-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.12 AS python-ci
+IMPORT github.com/input-output-hk/catalyst-ci:v3.5.12 AS cat-ci
 
 FROM debian:stable-slim
 
diff --git a/docs/Earthfile b/docs/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.7 AS docs-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.12 AS docs-ci
 
 IMPORT .. AS repo
 
diff --git a/docs/src/architecture/08_concepts/catalyst_voting/cddl/Earthfile b/docs/src/architecture/08_concepts/catalyst_voting/cddl/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.7 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.12 AS cddl-ci
 
 check-cddl:
     FROM cddl-ci+cddl-base
diff --git a/docs/src/architecture/08_concepts/immutable_ledger/cddl/Earthfile b/docs/src/architecture/08_concepts/immutable_ledger/cddl/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.7 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.12 AS cddl-ci
 
 check-cddl:
     FROM cddl-ci+cddl-base
diff --git a/docs/src/architecture/08_concepts/signed_doc/cddl/Earthfile b/docs/src/architecture/08_concepts/signed_doc/cddl/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.7 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.12 AS cddl-ci
 
 check-cddl:
     FROM cddl-ci+cddl-base
diff --git a/rust/Earthfile b/rust/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.5.10 AS rust-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.5.12 AS rust-ci
 IMPORT ../ AS repo-ci
 
 COPY_SRC:
diff --git a/rust/c509-certificate/Earthfile b/rust/c509-certificate/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust::v3.5.10 AS rust-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust::v3.5.12 AS rust-ci
 
 IMPORT .. AS rust-local
 IMPORT ../.. AS repo
diff --git a/rust/catalyst-signed-doc-macro/src/rules/mod.rs b/rust/catalyst-signed-doc-macro/src/rules/mod.rs
@@ -36,6 +36,7 @@ pub(crate) fn catalyst_signed_documents_rules_impl() -> anyhow::Result<TokenStre
                 signature: crate::validator::rules::SignatureRule {
                     mutlisig: false
                 },
+                original_author: crate::validator::rules::OriginalAuthorRule,
             }
         };
 
diff --git a/rust/signed_doc/src/validator/mod.rs b/rust/signed_doc/src/validator/mod.rs
@@ -8,8 +8,8 @@ use std::{collections::HashMap, sync::LazyLock};
 use catalyst_signed_doc_macro;
 use catalyst_types::catalyst_id::role_index::RoleId;
 use rules::{
-    ContentEncodingRule, ContentRule, ContentSchema, ContentTypeRule, IdRule, ParametersRule,
-    RefRule, ReplyRule, Rules, SectionRule, SignatureKidRule, VerRule,
+    ContentEncodingRule, ContentRule, ContentSchema, ContentTypeRule, IdRule, OriginalAuthorRule,
+    ParametersRule, RefRule, ReplyRule, Rules, SectionRule, SignatureKidRule, VerRule,
 };
 
 use crate::{
@@ -62,6 +62,7 @@ fn proposal_rule() -> Rules {
             exp: &[RoleId::Proposer],
         },
         signature: SignatureRule { mutlisig: false },
+        original_author: OriginalAuthorRule,
     }
 }
 
@@ -90,6 +91,7 @@ fn proposal_comment_rule() -> Rules {
         },
         doc_ref: RefRule::Specified {
             exp_ref_types: vec![PROPOSAL.clone()],
+            multiple: false,
             optional: false,
         },
         reply: ReplyRule::Specified {
@@ -105,6 +107,7 @@ fn proposal_comment_rule() -> Rules {
             exp: &[RoleId::Role0],
         },
         signature: SignatureRule { mutlisig: false },
+        original_author: OriginalAuthorRule,
     }
 }
 
@@ -146,6 +149,7 @@ fn proposal_submission_action_rule() -> Rules {
         },
         doc_ref: RefRule::Specified {
             exp_ref_types: vec![PROPOSAL.clone()],
+            multiple: false,
             optional: false,
         },
         reply: ReplyRule::NotSpecified,
@@ -154,6 +158,7 @@ fn proposal_submission_action_rule() -> Rules {
             exp: &[RoleId::Proposer],
         },
         signature: SignatureRule { mutlisig: false },
+        original_author: OriginalAuthorRule,
     }
 }
 
diff --git a/rust/signed_doc/src/validator/rules/content.rs b/rust/signed_doc/src/validator/rules/content.rs
@@ -91,6 +91,7 @@ impl ContentRule {
             return doc_refs_check(
                 template_ref,
                 std::slice::from_ref(exp_template_type),
+                false,
                 "template",
                 provider,
                 doc.report(),
diff --git a/rust/signed_doc/src/validator/rules/doc_ref.rs b/rust/signed_doc/src/validator/rules/doc_ref.rs
@@ -14,6 +14,8 @@ pub(crate) enum RefRule {
     Specified {
         /// expected `type` field of the referenced doc
         exp_ref_types: Vec<DocType>,
+        /// allows multiple document references or only one
+        multiple: bool,
         /// optional flag for the `ref` field
         optional: bool,
     },
@@ -33,13 +35,15 @@ impl RefRule {
         let context: &str = "Ref rule check";
         if let Self::Specified {
             exp_ref_types,
+            multiple,
             optional,
         } = self
         {
             if let Some(doc_refs) = doc.doc_meta().doc_ref() {
                 return doc_refs_check(
                     doc_refs,
                     exp_ref_types,
+                    *multiple,
                     "ref",
                     provider,
                     doc.report(),
@@ -73,6 +77,7 @@ impl RefRule {
 pub(crate) async fn doc_refs_check<Provider, Validator>(
     doc_refs: &DocumentRefs,
     exp_ref_types: &[DocType],
+    multiple: bool,
     field_name: &str,
     provider: &Provider,
     report: &ProblemReport,
@@ -84,6 +89,18 @@ where
 {
     let mut all_valid = true;
 
+    if !multiple && doc_refs.len() > 1 {
+        report.other(
+            format!(
+                "Only ONE document reference is allowed, found {} document references",
+                doc_refs.len()
+            )
+            .as_str(),
+            &format!("Referenced document validation for the `{field_name}` field"),
+        );
+        return Ok(false);
+    }
+
     for dr in doc_refs.iter() {
         if let Some(ref ref_doc) = provider.try_get_doc(dr).await? {
             let is_valid = referenced_doc_type_check(ref_doc, exp_ref_types, field_name, report)
@@ -396,7 +413,109 @@ mod tests {
         "valid reference to the missing one document"
     )]
     #[tokio::test]
-    async fn ref_specified_test(
+    async fn ref_multiple_specified_test(
+        doc_gen: impl FnOnce(&[DocType; 2], &mut TestCatalystProvider) -> CatalystSignedDocument
+    ) -> bool {
+        let mut provider = TestCatalystProvider::default();
+
+        let exp_types: [DocType; 2] = [UuidV4::new().into(), UuidV4::new().into()];
+
+        let doc = doc_gen(&exp_types, &mut provider);
+
+        let non_optional_res = RefRule::Specified {
+            exp_ref_types: exp_types.to_vec(),
+            multiple: true,
+            optional: false,
+        }
+        .check(&doc, &provider)
+        .await
+        .unwrap();
+
+        let optional_res = RefRule::Specified {
+            exp_ref_types: exp_types.to_vec(),
+            multiple: true,
+            optional: true,
+        }
+        .check(&doc, &provider)
+        .await
+        .unwrap();
+
+        assert_eq!(non_optional_res, optional_res);
+        non_optional_res
+    }
+
+    #[test_case(
+        |exp_types, provider| {
+            let ref_doc = Builder::new()
+                .with_metadata_field(SupportedField::Id(UuidV7::new()))
+                .with_metadata_field(SupportedField::Ver(UuidV7::new()))
+                .with_metadata_field(SupportedField::Type(exp_types[0].clone()))
+                .build();
+            provider.add_document(None, &ref_doc).unwrap();
+
+            Builder::new()
+                .with_metadata_field(SupportedField::Ref(
+                    vec![DocumentRef::new(
+                        ref_doc.doc_id().unwrap(),
+                        ref_doc.doc_ver().unwrap(),
+                        DocLocator::default(),
+                    )]
+                    .into(),
+                ))
+                .build()
+        }
+        => true
+        ;
+        "valid document with a single reference"
+    )]
+    #[test_case(
+        |exp_types, provider| {
+            let ref_doc_1 = Builder::new()
+                .with_metadata_field(SupportedField::Id(UuidV7::new()))
+                .with_metadata_field(SupportedField::Ver(UuidV7::new()))
+                .with_metadata_field(SupportedField::Type(exp_types[0].clone()))
+                .build();
+            provider.add_document(None, &ref_doc_1).unwrap();
+            let ref_doc_2 = Builder::new()
+                .with_metadata_field(SupportedField::Id(UuidV7::new()))
+                .with_metadata_field(SupportedField::Ver(UuidV7::new()))
+                .with_metadata_field(SupportedField::Type(exp_types[1].clone()))
+                .build();
+            provider.add_document(None, &ref_doc_2).unwrap();
+            let ref_doc_3 = Builder::new()
+            .with_metadata_field(SupportedField::Id(UuidV7::new()))
+            .with_metadata_field(SupportedField::Ver(UuidV7::new()))
+            .with_metadata_field(SupportedField::Type(exp_types[0].clone()))
+            .build();
+            provider.add_document(None, &ref_doc_3).unwrap();
+
+            Builder::new()
+                .with_metadata_field(SupportedField::Ref(
+                    vec![DocumentRef::new(
+                        ref_doc_1.doc_id().unwrap(),
+                        ref_doc_1.doc_ver().unwrap(),
+                        DocLocator::default(),
+                    ),
+                    DocumentRef::new(
+                        ref_doc_2.doc_id().unwrap(),
+                        ref_doc_2.doc_ver().unwrap(),
+                        DocLocator::default(),
+                    ),
+                    DocumentRef::new(
+                        ref_doc_3.doc_id().unwrap(),
+                        ref_doc_3.doc_ver().unwrap(),
+                        DocLocator::default(),
+                    )]
+                    .into(),
+                ))
+                .build()
+        }
+        => false
+        ;
+        "valid document with multiple references"
+    )]
+    #[tokio::test]
+    async fn ref_non_multiple_specified_test(
         doc_gen: impl FnOnce(&[DocType; 2], &mut TestCatalystProvider) -> CatalystSignedDocument
     ) -> bool {
         let mut provider = TestCatalystProvider::default();
@@ -407,6 +526,7 @@ mod tests {
 
         let non_optional_res = RefRule::Specified {
             exp_ref_types: exp_types.to_vec(),
+            multiple: false,
             optional: false,
         }
         .check(&doc, &provider)
@@ -415,6 +535,7 @@ mod tests {
 
         let optional_res = RefRule::Specified {
             exp_ref_types: exp_types.to_vec(),
+            multiple: false,
             optional: true,
         }
         .check(&doc, &provider)
@@ -430,6 +551,7 @@ mod tests {
         let provider = TestCatalystProvider::default();
         let rule = RefRule::Specified {
             exp_ref_types: vec![UuidV4::new().into()],
+            multiple: true,
             optional: true,
         };
 
@@ -439,6 +561,7 @@ mod tests {
         let provider = TestCatalystProvider::default();
         let rule = RefRule::Specified {
             exp_ref_types: vec![UuidV4::new().into()],
+            multiple: true,
             optional: false,
         };
 
diff --git a/rust/signed_doc/src/validator/rules/mod.rs b/rust/signed_doc/src/validator/rules/mod.rs
@@ -13,6 +13,7 @@ mod content_encoding;
 mod content_type;
 mod doc_ref;
 mod id;
+mod original_author;
 mod parameters;
 mod reply;
 mod section;
@@ -25,6 +26,7 @@ pub(crate) use content_encoding::ContentEncodingRule;
 pub(crate) use content_type::ContentTypeRule;
 pub(crate) use doc_ref::RefRule;
 pub(crate) use id::IdRule;
+pub(crate) use original_author::OriginalAuthorRule;
 pub(crate) use parameters::ParametersRule;
 pub(crate) use reply::ReplyRule;
 pub(crate) use section::SectionRule;
@@ -57,6 +59,8 @@ pub(crate) struct Rules {
     pub(crate) kid: SignatureKidRule,
     /// document's signatures validation rule
     pub(crate) signature: SignatureRule,
+    /// Original Author validation rule.
+    pub(crate) original_author: OriginalAuthorRule,
 }
 
 impl Rules {
@@ -81,6 +85,7 @@ impl Rules {
             self.parameters.check(doc, provider).boxed(),
             self.kid.check(doc).boxed(),
             self.signature.check(doc, provider).boxed(),
+            self.original_author.check(doc, provider).boxed(),
         ];
 
         let res = futures::future::join_all(rules)
diff --git a/rust/signed_doc/src/validator/rules/original_author.rs b/rust/signed_doc/src/validator/rules/original_author.rs
diff --git a/rust/signed_doc/src/validator/rules/parameters.rs b/rust/signed_doc/src/validator/rules/parameters.rs
diff --git a/rust/signed_doc/src/validator/rules/reply.rs b/rust/signed_doc/src/validator/rules/reply.rs
diff --git a/specs/Earthfile b/specs/Earthfile
diff --git a/specs/generators/pages/signed_doc/cddl/Earthfile.jinja b/specs/generators/pages/signed_doc/cddl/Earthfile.jinja
diff --git a/utilities/docs-preview/Earthfile b/utilities/docs-preview/Earthfile

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ pub(crate) fn catalyst_signed_documents_rules_impl() -> anyhow::Result<TokenStre`
`36`	`36`	`signature: crate::validator::rules::SignatureRule {`
`37`	`37`	`mutlisig: false`
`38`	`38`	`},`
	`39`	`+ original_author: crate::validator::rules::OriginalAuthorRule,`
`39`	`40`	`}`
`40`	`41`	`};`
`41`	`42`