Merge branch 'main' into feat/cddl-schema

stevenj · web-flow · commit 58b15d800cca · 2025-11-06T21:00:59.000+07:00
diff --git a/.config/dictionaries/project.dic b/.config/dictionaries/project.dic
@@ -225,6 +225,7 @@ preopen
 preopened
 preopens
 preprod
+projectcatalyst
 Prokhorenko
 proptest
 psql
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,9 +18,9 @@ permissions:
 jobs:
   ci:
     if: ${{ !github.event.pull_request.draft }}
-    uses: input-output-hk/catalyst-forge/.github/workflows/ci.yml@ci/v1.8.1
+    uses: input-output-hk/catalyst-forge/.github/workflows/ci.yml@ci/v1.9.0
     with:
-      forge_version: 0.19.1
+      forge_version: 0.20.0
 
   test_reporting:
     if: ${{ !github.event.pull_request.draft }}
diff --git a/.github/workflows/generate-allure-report.yml b/.github/workflows/generate-allure-report.yml
@@ -27,16 +27,16 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install Forge
-        uses: input-output-hk/catalyst-forge/actions/install@ci/v1.8.1
+        uses: input-output-hk/catalyst-forge/actions/install@ci/v1.9.0
         with:
-          version: 0.19.1
+          version: 0.20.0
         if: always()
 
       - name: Setup CI
-        uses: input-output-hk/catalyst-forge/actions/setup@ci/v1.8.1
+        uses: input-output-hk/catalyst-forge/actions/setup@ci/v1.9.0
 
       - name: Get catalyst libs unit test report
-        uses: input-output-hk/catalyst-forge/actions/run@ci/v1.8.1
+        uses: input-output-hk/catalyst-forge/actions/run@ci/v1.9.0
         if: always()
         continue-on-error: true
         with:
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.17 AS mdlint-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.5.17 AS cspell-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.17 AS python-ci
-IMPORT github.com/input-output-hk/catalyst-ci:v3.5.17 AS cat-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/mdlint:v3.5.27 AS mdlint-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cspell:v3.5.27 AS cspell-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.27 AS python-ci
+IMPORT github.com/input-output-hk/catalyst-ci:v3.5.27 AS cat-ci
 
 FROM debian:stable-slim
 
diff --git a/blueprint.cue b/blueprint.cue
@@ -9,6 +9,10 @@ global: {
 		registries: [
 			ci.providers.aws.ecr.registry,
 		]
+		release: docs: {
+			bucket: "docs.dev.projectcatalyst.io"
+			url:    "https://docs.dev.projectcatalyst.io/"
+		}
 		providers: {
 			aws: {
 				region: "eu-central-1"
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.17 AS docs-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.27 AS docs-ci
 
 IMPORT .. AS repo
 
diff --git a/docs/blueprint.cue b/docs/blueprint.cue
@@ -1,2 +1,18 @@
 version: "1.0.0"
-project: name: "libs-docs"
+project:
+{
+    name: "libs-docs"
+
+    release: {
+		docs: {
+			on: {
+				merge: {}
+				pr: {}
+			}
+
+			config: {
+				name: "libs"
+			}
+		}
+	}
+}
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.17 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.27 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.17 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.27 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.17 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.27 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.17 AS rust-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust:v3.5.27 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.17 AS rust-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/rust::v3.5.27 AS rust-ci
 
 IMPORT .. AS rust-local
 IMPORT ../.. AS repo
diff --git a/rust/catalyst-types/Cargo.toml b/rust/catalyst-types/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "catalyst-types"
-version = "0.0.10"
+version = "0.0.11"
 edition.workspace = true
 license.workspace = true
 authors.workspace = true
@@ -29,6 +29,8 @@ uuid = { version = "1.12.0", features = ["v4", "v7", "serde"] }
 chrono = "0.4.39"
 tracing = "0.1.41"
 strum = { version = "0.27.1", features = ["derive"] }
+jsonschema = "0.28.3"
+serde_json = { version = "1.0.134", features = ["raw_value"] }
 
 # Only include fmmap for non-wasm32 targets
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
diff --git a/rust/catalyst-types/src/json_schema.rs b/rust/catalyst-types/src/json_schema.rs
@@ -0,0 +1,147 @@
+//! A wrapper around a JSON Schema validator.
+
+use std::{ops::Deref, sync::Arc};
+
+use jsonschema::{options, Draft, ValidationError, Validator};
+use serde_json::Value;
+
+/// Wrapper around a JSON Schema validator.
+///
+/// Attempts to detect the draft version from the `$schema` field.
+/// If not specified, it tries Draft2020-12 first, then falls back to Draft7.
+/// Returns an error if schema is invalid for both.
+#[derive(Clone)]
+pub struct JsonSchema(Arc<Validator>);
+
+/// `JsonSchema` building error type.
+#[derive(Debug, thiserror::Error)]
+pub enum SchemaBuildError {
+    /// Invalid JSON Schema error.
+    #[error("{0}")]
+    InvalidSchema(#[from] ValidationError<'static>),
+    /// Undetectable JSON schema version.
+    #[error(
+        "Could not detect draft version and schema is not valid against Draft2020-12 or Draft7"
+    )]
+    UndetectableDraft,
+}
+
+impl Deref for JsonSchema {
+    type Target = Validator;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl TryFrom<&Value> for JsonSchema {
+    type Error = SchemaBuildError;
+
+    fn try_from(schema: &Value) -> std::result::Result<Self, Self::Error> {
+        let draft_version = if let Some(schema) = schema.get("$schema").and_then(|s| s.as_str()) {
+            if schema.contains("draft-07") {
+                Some(Draft::Draft7)
+            } else if schema.contains("2020-12") {
+                Some(Draft::Draft202012)
+            } else {
+                None
+            }
+        } else {
+            None
+        };
+
+        if let Some(draft) = draft_version {
+            let validator = options().with_draft(draft).build(schema)?;
+
+            Ok(JsonSchema(validator.into()))
+        } else {
+            // if draft not specified or not detectable:
+            // try draft2020-12
+            if let Ok(validator) = options().with_draft(Draft::Draft202012).build(schema) {
+                return Ok(JsonSchema(validator.into()));
+            }
+
+            // fallback to draft7
+            if let Ok(validator) = options().with_draft(Draft::Draft7).build(schema) {
+                return Ok(JsonSchema(validator.into()));
+            }
+
+            Err(SchemaBuildError::UndetectableDraft)
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use serde_json::json;
+
+    use super::*;
+
+    #[test]
+    fn valid_draft7_schema() {
+        let schema = json!({
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "type": "object",
+            "properties": {
+                "name": { "type": "string" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok(), "Expected Draft7 schema to be valid");
+    }
+
+    #[test]
+    fn valid_draft2020_12_schema() {
+        let schema = json!({
+            "$schema": "https://json-schema.org/draft/2020-12/schema",
+            "type": "object",
+            "properties": {
+                "age": { "type": "integer" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok(), "Expected Draft2020-12 schema to be valid");
+    }
+
+    #[test]
+    fn schema_without_draft_should_fallback() {
+        // Valid in both Draft2020-12 and Draft7
+        let schema = json!({
+            "type": "object",
+            "properties": {
+                "id": { "type": "number" }
+            }
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(
+            result.is_ok(),
+            "Expected schema without $schema to fallback and succeed"
+        );
+    }
+
+    #[test]
+    fn invalid_schema_should_error() {
+        // Invalid schema: "type" is not a valid keyword here
+        let schema = json!({
+            "$schema": "http://json-schema.org/draft-07/schema#",
+            "type": "not-a-valid-type"
+        });
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(
+            result.is_err(),
+            "Expected invalid schema to return an error"
+        );
+    }
+
+    #[test]
+    fn empty_object_schema() {
+        let schema = json!({});
+
+        let result = JsonSchema::try_from(&schema);
+        assert!(result.is_ok());
+    }
+}
diff --git a/rust/catalyst-types/src/lib.rs b/rust/catalyst-types/src/lib.rs
@@ -3,6 +3,7 @@
 pub mod catalyst_id;
 pub mod cbor_utils;
 pub mod conversion;
+pub mod json_schema;
 #[cfg(not(target_arch = "wasm32"))]
 pub mod mmap_file;
 pub mod problem_report;
diff --git a/rust/deny.toml b/rust/deny.toml
@@ -63,6 +63,8 @@ allow-git = [
     "https://github.com/input-output-hk/mithril",
     # Maintained fork of an archived crates-io version.
     "https://github.com/dariusc93/rust-ipfs",
+    # TODO(dt-iohk): remove this when changes from forked flutter_rust_bridge are merged into the official version
+    "https://github.com/input-output-hk/catalyst_flutter_rust_bridge",
 ]
 
 [licenses]
@@ -109,7 +111,6 @@ crate = "ring"
 expression = "MIT"
 license-files = [{ path = "LICENSE", hash = 0xbd0eed23 }]
 
-
 # SPDX considers OpenSSL to encompass both the OpenSSL and SSLeay licenses
 # https://spdx.org/licenses/OpenSSL.html
 # ISC - Both BoringSSL and ring use this for their new files
diff --git a/specs/Earthfile b/specs/Earthfile
@@ -1,8 +1,8 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.17 AS python-ci
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/debian:v3.5.17 AS debian
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cue:v3.5.17 AS cue
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.5.27 AS python-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/debian:v3.5.27 AS debian
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cue:v3.5.27 AS cue
 
 IMPORT ../docs AS docs
 
diff --git a/specs/generators/pages/signed_doc/cddl/Earthfile.jinja b/specs/generators/pages/signed_doc/cddl/Earthfile.jinja
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.17 AS cddl-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/cddl:v3.5.27 AS cddl-ci
 
 check-cddl:
     FROM cddl-ci+cddl-base
diff --git a/utilities/docs-preview/Earthfile b/utilities/docs-preview/Earthfile
@@ -1,6 +1,6 @@
 VERSION 0.8
 
-IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.17 AS docs-ci
+IMPORT github.com/input-output-hk/catalyst-ci/earthly/docs:v3.5.27 AS docs-ci
 
 # update-docs-dev-script: get the latest docs dev script from CI.
 update-docs-dev-script:
