Merge pull request #579 from axone-protocol/refactor/rdf-dataset-format

Refactor/rdf dataset format
axone-protocol · Jun 15, 2024 · 67e01b9 · 67e01b9
2 parents 4a94c5b + 11aa397
commit 67e01b9
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 21 deletions.
diff --git a/contracts/axone-dataverse/src/contract.rs b/contracts/axone-dataverse/src/contract.rs
@@ -138,7 +138,9 @@ pub mod query {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::msg::{DataverseResponse, RdfFormat, TripleStoreConfig, TripleStoreLimitsInput};
+    use crate::msg::{
+        DataverseResponse, RdfDatasetFormat, TripleStoreConfig, TripleStoreLimitsInput,
+    };
     use crate::testutil::testutil::read_test_data;
     use axone_cognitarium::msg::{
         DataFormat, Head, Node, Results, SelectItem, SelectQuery, SelectResponse,
@@ -271,7 +273,7 @@ mod tests {
 
         let msg = ExecuteMsg::SubmitClaims {
             metadata: Binary::from("data".as_bytes()),
-            format: Some(RdfFormat::NQuads),
+            format: Some(RdfDatasetFormat::NQuads),
         };
 
         let result = execute(deps.as_mut(), env, info, msg);
@@ -338,7 +340,7 @@ mod tests {
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary(read_test_data("vc-eddsa-2020-ok.nq")),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 
@@ -400,7 +402,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary("notrdf".as_bytes().to_vec()),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 
@@ -416,7 +418,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary(vec![]),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 
@@ -435,7 +437,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary(read_test_data("vc-eddsa-2020-ok-unsecured.nq")),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 
@@ -454,7 +456,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary(read_test_data("vc-unsupported-1.nq")),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 
@@ -502,7 +504,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
             mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
             ExecuteMsg::SubmitClaims {
                 metadata: Binary(read_test_data("vc-eddsa-2020-ok.nq")),
-                format: Some(RdfFormat::NQuads),
+                format: Some(RdfDatasetFormat::NQuads),
             },
         );
 

diff --git a/contracts/axone-dataverse/src/msg.rs b/contracts/axone-dataverse/src/msg.rs
@@ -59,9 +59,9 @@ pub enum ExecuteMsg {
         /// The serialized metadata intended for attachment.
         /// This metadata should adhere to the format specified in the `format` field.
         metadata: Binary,
-        /// RDF format in which the metadata is represented.
+        /// RDF dataset serialization format for the metadata.
         /// If not provided, the default format is [N-Quads](https://www.w3.org/TR/n-quads/) format.
-        format: Option<RdfFormat>,
+        format: Option<RdfDatasetFormat>,
     },
 
     /// # RevokeClaims
@@ -150,11 +150,12 @@ impl From<TripleStoreLimitsInput> for axone_cognitarium::msg::StoreLimitsInput {
     }
 }
 
-/// # RdfFormat
-/// `RdfFormat` represents the various serialization formats for RDF (Resource Description Framework) data.
+/// # RdfDatasetFormat
+/// Represents the various serialization formats for an RDF dataset, i.e. a collection of RDF graphs
+/// ([RDF Dataset](https://www.w3.org/TR/rdf11-concepts/#section-dataset)).
 #[cw_serde]
 #[derive(Default)]
-pub enum RdfFormat {
+pub enum RdfDatasetFormat {
     /// # NQuads
     /// N-Quads Format
     ///

diff --git a/docs/axone-dataverse.md b/docs/axone-dataverse.md
@@ -96,11 +96,11 @@ To maintain integrity and coherence in the dataverse, several preconditions are
 
 - `DataIntegrity` with the following cryptosuites: `eddsa-2022`, `eddsa-rdfc-2022`.
 
-| parameter                | description                                                                                                                                                                  |
-| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `submit_claims`          | _(Required.) _ **object**.                                                                                                                                                   |
-| `submit_claims.format`   | **[RdfFormat](#rdfformat)\|null**. RDF format in which the metadata is represented. If not provided, the default format is [N-Quads](https://www.w3.org/TR/n-quads/) format. |
-| `submit_claims.metadata` | _(Required.) _ **[Binary](#binary)**. The serialized metadata intended for attachment. This metadata should adhere to the format specified in the `format` field.            |
+| parameter                | description                                                                                                                                                                                  |
+| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `submit_claims`          | _(Required.) _ **object**.                                                                                                                                                                   |
+| `submit_claims.format`   | **[RdfDatasetFormat](#rdfdatasetformat)\|null**. RDF dataset serialization format for the metadata. If not provided, the default format is [N-Quads](https://www.w3.org/TR/n-quads/) format. |
+| `submit_claims.metadata` | _(Required.) _ **[Binary](#binary)**. The serialized metadata intended for attachment. This metadata should adhere to the format specified in the `format` field.                            |
 
 ### ExecuteMsg::RevokeClaims
 
@@ -174,9 +174,9 @@ N-Quads is an extension of N-Triples to support RDF datasets by adding an option
 | ----------- |
 | `"n_quads"` |
 
-### RdfFormat
+### RdfDatasetFormat
 
-`RdfFormat` represents the various serialization formats for RDF (Resource Description Framework) data.
+Represents the various serialization formats for an RDF dataset, i.e. a collection of RDF graphs ([RDF Dataset](https://www.w3.org/TR/rdf11-concepts/#section-dataset)).
 
 | variant           | description                                                                                                                                                                                                                                               |
 | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -238,5 +238,5 @@ let b = Uint64::from(70u32); assert_eq!(b.u64(), 70); ```
 
 ---
 
-*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`daa1f5839f39568e`)*
+*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`6c036ea055d1bbb8`)*
 ````