Skip to content

Commit

Permalink
feat: update schema files
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-anik committed Jun 17, 2024
1 parent ce0be53 commit e3dfa79
Show file tree
Hide file tree
Showing 24 changed files with 567 additions and 453 deletions.
2 changes: 1 addition & 1 deletion go/cognitarium-schema/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AXONE cognitarium schema

> Generated go types for [axone-cognitarium contract](https://github.com/axone-protocol/contracts/tree/v3.0.0-54-gb243e6d/contracts/axone-cognitarium).
> Generated go types for [axone-cognitarium contract](https://github.com/axone-protocol/contracts/tree//contracts/axone-cognitarium).
[![version](https://img.shields.io/github/v/release/axone-protocol/axone-contract-schema?style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/releases)
[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-contract-schema/build.yml?branch=main&label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/build.yml)
Expand Down
279 changes: 152 additions & 127 deletions go/cognitarium-schema/schema.go

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion go/dataverse-schema/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AXONE dataverse schema

> Generated go types for [axone-dataverse contract](https://github.com/axone-protocol/contracts/tree/v3.0.0-54-gb243e6d/contracts/axone-dataverse).
> Generated go types for [axone-dataverse contract](https://github.com/axone-protocol/contracts/tree//contracts/axone-dataverse).
[![version](https://img.shields.io/github/v/release/axone-protocol/axone-contract-schema?style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/releases)
[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-contract-schema/build.yml?branch=main&label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/build.yml)
Expand Down
70 changes: 31 additions & 39 deletions go/dataverse-schema/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,9 @@ func (r *DataverseResponse) Marshal() ([]byte, error) {
//
// #### Format
//
// Claims are injected into the dataverse through Verifiable Presentations (VPs). These
// presentations effectively amalgamate and showcase multiple credentials, thus providing a
// cohesive and comprehensive view of the assertions being made.
// Claims are injected into the dataverse through Verifiable Credentials (VCs).
//
// While the data in a VP typically revolves around a common subject, it accommodates an
// unlimited number of subjects and issuers. This flexibility allows for a broad spectrum of
// claims to be represented.
//
// Primarily, the claims leverage the OKP4 ontology, which facilitates articulating
// Primarily, the claims leverage the AXONE ontology, which facilitates articulating
// assertions about widely acknowledged resources in the dataverse, including digital
// services, digital resources, zones, governance, and more.
//
Expand All @@ -92,15 +86,28 @@ func (r *DataverseResponse) Marshal() ([]byte, error) {
// To maintain integrity and coherence in the dataverse, several preconditions are set for
// the submission of claims:
//
// 1. **Format Requirement**: Claims must be encapsulated within Verifiable Presentations
// (VPs).
// 1. **Format Requirement**: Claims must be encapsulated within Verifiable Credentials
// (VCs).
//
// 2. **Unique Identifier Mandate**: Each Verifiable Credential within the dataverse must
// possess a unique identifier.
//
// 3. **Issuer Signature**: Claims must bear the issuer's signature. This signature must be
// verifiable, ensuring authenticity and credibility.
//
// 4. **Content**: The actual implementation supports the submission of a single Verifiable
// Credential, containing a single claim.
//
// #### Supported cryptographic proofs
//
// - `Ed25519Signature2018`
//
// - `Ed25519Signature2020`
//
// - `EcdsaSecp256k1Signature2019`
//
// - `DataIntegrity` with the following cryptosuites: `eddsa-2022`, `eddsa-rdfc-2022`.
//
// Revoke or withdraw a previously submitted claims.
//
// #### Preconditions:
Expand All @@ -117,12 +124,12 @@ type RevokeClaims struct {
}

type SubmitClaims struct {
// RDF format in which the metadata is represented. If not provided, the default format is
// [Turtle](https://www.w3.org/TR/turtle/) format.
Format *RDFXML `json:"format"`
// The serialized metadata intended for attachment. This metadata should adhere to the
// format specified in the `format` field.
Metadata string `json:"metadata"`
// 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 *RDFDatasetFormat `json:"format"`
// The serialized metadata intended for attachment. This metadata should adhere to the
// format specified in the `format` field.
Metadata string `json:"metadata"`
}

// `InstantiateMsg` is used to initialize a new instance of the dataverse.
Expand Down Expand Up @@ -192,37 +199,22 @@ type Dataverse struct {

// DataverseResponse is the response of the Dataverse query.
type DataverseResponse struct {
// The name of the dataverse.
Name string `json:"name"`
// The name of the dataverse.
Name string `json:"name"`
// The cognitarium contract address.
TriplestoreAddress string `json:"triplestore_address"`
}

// RDF/XML Format
//
// RDF/XML is a syntax to express RDF information in XML. See the [official RDF/XML
// specification](https://www.w3.org/TR/rdf-syntax-grammar/).
//
// Turtle (Terse RDF Triple Language) Format
//
// Turtle is a textual format for representing RDF triples in a more compact and
// human-readable way compared to RDF/XML. See the [official Turtle
// specification](https://www.w3.org/TR/turtle/).
//
// N-Triples Format
//
// N-Triples is a line-based, plain text format for encoding an RDF graph. Each line
// corresponds to a single RDF triple. See the [official N-Triples
// specification](https://www.w3.org/TR/n-triples/).
// 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)).
//
// N-Quads Format
//
// N-Quads is an extension of N-Triples to support RDF datasets by adding an optional fourth
// element to represent the graph name. See the [official N-Quads
// specification](https://www.w3.org/TR/n-quads/).
type RDFXML string
type RDFDatasetFormat string

const (
NQuads RDFXML = "n_quads"
NTriples RDFXML = "n_triples"
RDFXMLRDFXML RDFXML = "rdf_xml"
Turtle RDFXML = "turtle"
NQuads RDFDatasetFormat = "n_quads"
)
2 changes: 1 addition & 1 deletion go/law-stone-schema/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AXONE law-stone schema

> Generated go types for [axone-law-stone contract](https://github.com/axone-protocol/contracts/tree/v3.0.0-54-gb243e6d/contracts/axone-law-stone).
> Generated go types for [axone-law-stone contract](https://github.com/axone-protocol/contracts/tree//contracts/axone-law-stone).
[![version](https://img.shields.io/github/v/release/axone-protocol/axone-contract-schema?style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/releases)
[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-contract-schema/build.yml?branch=main&label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-contract-schema/actions/workflows/build.yml)
Expand Down
Loading

0 comments on commit e3dfa79

Please sign in to comment.