Skip to content

Commit 67e01b9

Browse files
ccamelccamel
authored
Merge pull request #579 from axone-protocol/refactor/rdf-dataset-format
Refactor/rdf dataset format
2 parents 4a94c5b + 11aa397 commit 67e01b9

File tree

3 files changed

+24
-21
lines changed

3 files changed

+24
-21
lines changed

‎contracts/axone-dataverse/src/contract.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ pub mod query {
138138
#[cfg(test)]
139139
mod tests {
140140
use super::*;
141-
use crate::msg::{DataverseResponse, RdfFormat, TripleStoreConfig, TripleStoreLimitsInput};
141+
use crate::msg::{
142+
DataverseResponse, RdfDatasetFormat, TripleStoreConfig, TripleStoreLimitsInput,
143+
};
142144
use crate::testutil::testutil::read_test_data;
143145
use axone_cognitarium::msg::{
144146
DataFormat, Head, Node, Results, SelectItem, SelectQuery, SelectResponse,
@@ -271,7 +273,7 @@ mod tests {
271273

272274
let msg = ExecuteMsg::SubmitClaims {
273275
metadata: Binary::from("data".as_bytes()),
274-
format: Some(RdfFormat::NQuads),
276+
format: Some(RdfDatasetFormat::NQuads),
275277
};
276278

277279
let result = execute(deps.as_mut(), env, info, msg);
@@ -338,7 +340,7 @@ mod tests {
338340
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
339341
ExecuteMsg::SubmitClaims {
340342
metadata: Binary(read_test_data("vc-eddsa-2020-ok.nq")),
341-
format: Some(RdfFormat::NQuads),
343+
format: Some(RdfDatasetFormat::NQuads),
342344
},
343345
);
344346

@@ -400,7 +402,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
400402
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
401403
ExecuteMsg::SubmitClaims {
402404
metadata: Binary("notrdf".as_bytes().to_vec()),
403-
format: Some(RdfFormat::NQuads),
405+
format: Some(RdfDatasetFormat::NQuads),
404406
},
405407
);
406408

@@ -416,7 +418,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
416418
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
417419
ExecuteMsg::SubmitClaims {
418420
metadata: Binary(vec![]),
419-
format: Some(RdfFormat::NQuads),
421+
format: Some(RdfDatasetFormat::NQuads),
420422
},
421423
);
422424

@@ -435,7 +437,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
435437
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
436438
ExecuteMsg::SubmitClaims {
437439
metadata: Binary(read_test_data("vc-eddsa-2020-ok-unsecured.nq")),
438-
format: Some(RdfFormat::NQuads),
440+
format: Some(RdfDatasetFormat::NQuads),
439441
},
440442
);
441443

@@ -454,7 +456,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
454456
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
455457
ExecuteMsg::SubmitClaims {
456458
metadata: Binary(read_test_data("vc-unsupported-1.nq")),
457-
format: Some(RdfFormat::NQuads),
459+
format: Some(RdfDatasetFormat::NQuads),
458460
},
459461
);
460462

@@ -502,7 +504,7 @@ _:b0 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <https://example.org/exam
502504
mock_info("axone1072nc6egexqr2v6vpp7yxwm68plvqnkf5uemr0", &[]),
503505
ExecuteMsg::SubmitClaims {
504506
metadata: Binary(read_test_data("vc-eddsa-2020-ok.nq")),
505-
format: Some(RdfFormat::NQuads),
507+
format: Some(RdfDatasetFormat::NQuads),
506508
},
507509
);
508510

‎contracts/axone-dataverse/src/msg.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ pub enum ExecuteMsg {
5959
/// The serialized metadata intended for attachment.
6060
/// This metadata should adhere to the format specified in the `format` field.
6161
metadata: Binary,
62-
/// RDF format in which the metadata is represented.
62+
/// RDF dataset serialization format for the metadata.
6363
/// If not provided, the default format is [N-Quads](https://www.w3.org/TR/n-quads/) format.
64-
format: Option<RdfFormat>,
64+
format: Option<RdfDatasetFormat>,
6565
},
6666

6767
/// # RevokeClaims
@@ -150,11 +150,12 @@ impl From<TripleStoreLimitsInput> for axone_cognitarium::msg::StoreLimitsInput {
150150
}
151151
}
152152

153-
/// # RdfFormat
154-
/// `RdfFormat` represents the various serialization formats for RDF (Resource Description Framework) data.
153+
/// # RdfDatasetFormat
154+
/// Represents the various serialization formats for an RDF dataset, i.e. a collection of RDF graphs
155+
/// ([RDF Dataset](https://www.w3.org/TR/rdf11-concepts/#section-dataset)).
155156
#[cw_serde]
156157
#[derive(Default)]
157-
pub enum RdfFormat {
158+
pub enum RdfDatasetFormat {
158159
/// # NQuads
159160
/// N-Quads Format
160161
///

‎docs/axone-dataverse.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ To maintain integrity and coherence in the dataverse, several preconditions are
9696

9797
- `DataIntegrity` with the following cryptosuites: `eddsa-2022`, `eddsa-rdfc-2022`.
9898

99-
| parameter | description |
100-
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
101-
| `submit_claims` | _(Required.) _ **object**. |
102-
| `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. |
103-
| `submit_claims.metadata` | _(Required.) _ **[Binary](#binary)**. The serialized metadata intended for attachment. This metadata should adhere to the format specified in the `format` field. |
99+
| parameter | description |
100+
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
101+
| `submit_claims` | _(Required.) _ **object**. |
102+
| `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. |
103+
| `submit_claims.metadata` | _(Required.) _ **[Binary](#binary)**. The serialized metadata intended for attachment. This metadata should adhere to the format specified in the `format` field. |
104104

105105
### ExecuteMsg::RevokeClaims
106106

@@ -174,9 +174,9 @@ N-Quads is an extension of N-Triples to support RDF datasets by adding an option
174174
| ----------- |
175175
| `"n_quads"` |
176176

177-
### RdfFormat
177+
### RdfDatasetFormat
178178

179-
`RdfFormat` represents the various serialization formats for RDF (Resource Description Framework) data.
179+
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)).
180180

181181
| variant | description |
182182
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -238,5 +238,5 @@ let b = Uint64::from(70u32); assert_eq!(b.u64(), 70); ```
238238
239239
---
240240
241-
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`daa1f5839f39568e`)*
241+
*Rendered by [Fadroma](https://fadroma.tech) ([@fadroma/schema 1.1.0](https://www.npmjs.com/package/@fadroma/schema)) from `axone-dataverse.json` (`6c036ea055d1bbb8`)*
242242
````

0 commit comments

Comments
 (0)