docs: Update EVES-003 with reference metadata example (#21)

Signed-off-by: jdsika <carlo.van-driesten@bmw.de>

Author: jdsika

EVES/drafts/EVES-003/eves-003.md

@@ -29,8 +29,8 @@ This EVES addresses the need for clear guidelines to onboard assets and synchron
 
 ### 1. Asset Definition
 
-An asset is defined by the [Gaia-X 4 PLC-AAD Manifest Ontology](https://github.com/GAIA-X4PLC-AAD/ontology-management-base/tree/main/manifest/).
-The example implementation [here](https://github.com/ASCS-eV/smart-contracts/tree/main/contracts/marketplace/metadata) is based on release v0.1.6 from the [HD-Map Asset Example](https://github.com/GAIA-X4PLC-AAD/hd-map-asset-example).
+An asset is defined by the [Gaia-X 4 PLC-AAD Manifest Ontology](https://github.com/ASCS-eV/ontology-management-base/tree/main/manifest).
+The example implementation in the 📁 `metadata/` folder is based on release v0.1.8 of the [HD-Map Asset Example](https://github.com/ASCS-eV/hd-map-asset-example/releases/tag/v0.1.8).
 
 This EVES references the [Gaia-X Policy Rules Compliance Document (Release 24.11)](https://docs.gaia-x.eu/policy-rules-committee/compliance-document/24.11/). Compatibility with this release is **to be verified** in a future update of this EVES.
 
@@ -107,8 +107,8 @@ The ENVITED-X Data Space implements a three-tiered privacy model:
 #### CID as the Primary Identifier
 
 - The CID of the uploaded `asset.zip` serves as the unique identifier connecting data across all systems.
-- The CIDs are signed by the user according to EIP-712.
-- An additional UUID MUST be generated pre-mint to link the asset with the ENVITED-X database securely.
+- The CIDs MAY be signed by the user according to EIP-712.
+- A UUID MUST be generated pre-mint to link the asset with the ENVITED-X database securely.
 - The DID of the member associated with the user minting the asset MUST be known.
 
 #### Pre-Mint Information
@@ -120,7 +120,7 @@ If additional non-public information needs to be stored in the database before m
 The synchronization between the smart contract and the ENVITED-X database relies on:
 
 1. The contract DID (current Ghostnet contract):  
-   `did:tezos:NetXnHfVqm9iesp:KT1XC2fTBNqoafnrhEb7TuToRCzewgbHAhnA`
+   `did:tezos:NetXnHfVqm9iesp:KT1PCaD2kmgCHy15wQ1gpqZUy9RLxyBVJdTF`
 2. Search `CID` of `tzip21_token_metadata.json` in database.
 3. Compare if signature on CID is a `user` belonging to the `member` and if member is owner of token.
 4. Check: Uniqueness of CID in database.
@@ -162,10 +162,10 @@ No retroactive changes to previous assets are required.
 
 ## References
 
-1. [Gaia-X 4 PLC-AAD Manifest Ontology](https://github.com/GAIA-X4PLC-AAD/ontology-management-base/tree/main/manifest/)
-2. [HD-Map Asset Example](https://github.com/GAIA-X4PLC-AAD/hd-map-asset-example)
+1. [Gaia-X 4 PLC-AAD Manifest Ontology](https://github.com/ASCS-eV/ontology-management-base/tree/main/manifest)
+2. [HD-Map Asset Example](https://github.com/ASCS-eV/hd-map-asset-example)
 3. [Pinata Documentation](https://docs.pinata.cloud/web3/pinning/pinata-metadata#pinataoptions)
 4. [RFC 2119: Key Words for Use in RFCs to Indicate Requirement Levels](https://datatracker.ietf.org/doc/html/rfc2119)
 5. [Gaia-X Policy Rules Compliance Document (Release 24.11)](https://docs.gaia-x.eu/policy-rules-committee/compliance-document/24.11/)
-6. [Reference Implementation](https://github.com/ASCS-eV/smart-contracts/tree/main/contracts/marketplace/metadata)
+6. [Reference Implementation](https://github.com/ASCS-eV/smart-contracts/tree/main/contracts/marketplace/)
 7. [EIP-712](https://eips.ethereum.org/EIPS/eip-712)

EVES/drafts/EVES-003/metadata/Readme.md

@@ -0,0 +1,63 @@
+# Reference metadata for ENVITED-X Assets
+
+This folder contains the reference example for the metadata specifications outlined in [EVES-003](../eves-003.md) to demonstrate how metadata is structured ENVITED-X Data Space.
+
+## File Structure
+
+📁 `metadata/`
+
+- 📄 `bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip`  
+  *Example HD map renamed to CID v1.*
+- 📄 `tzip21_asset_manifest.json`  
+  *Generated metadata file for IPFS referenced in the TZIP21 token metadata containing remote URLs.*
+- 📄 `tzip21_token_metadata-schema.json`  
+  *TZIP21 json schema to validate the token metadata.*
+- 📄 `tzip21_token_metadata.json`  
+  *Token metadata for minting assets.*
+
+The shacles can be found [here](https://github.com/ASCS-eV/hd-map-asset-example/tree/v0.1.8/shacls-and-ontologies/used-shacls):
+
+📁 `shacls-and-ontologies/used-shacls/`
+
+- 📄 `manifest_shacl.ttl`  
+  *SHACL file for validating the `manifest.json`.*  
+- 📄 `domainMetadata_shacl.ttl`  
+  *SHACL file for validating the `domainMetadata.json`.*  
+
+## Key Concepts
+
+### Gaia-X Compliance
+
+The metadata files follow the [Gaia-X Policy Rules Compliance Document (Release 24.11)](https://docs.gaia-x.eu/policy-rules-committee/compliance-document/24.11/). Compatibility with this release is a **TODO** in [EVES-003](../eves-003.md).
+
+### CID-Based Identification
+
+All assets and metadata files are identified using CID v1, ensuring interoperability and immutability across the IPFS-based ENVITED-X Data Space.
+
+### TZIP-21 Metadata
+
+The `tzip21_asset_manifest.json` and `tzip21_token_metadata.json` demonstrate the mapping of asset information to TZIP-21 token metadata standards, as detailed in [EVES-003](../eves-003.md).
+
+## How to Use This Reference Implementation
+
+1. **Validate Metadata**:
+   - Use the referenced SHACL files in the `shacls-and-ontologies/used-shacls/` folder to validate `manifest.json` and `domainMetadata.json`.
+   - Ensure all required files and URLs referenced in the manifest are accessible.
+
+2. **Prepare Metadata for IPFS**:
+   - Upload the `tzip21_asset_manifest.json` and associated files to IPFS.
+   - Convert relative file paths in `manifest.json` to CID-based IPFS URLs using the `tzip21_asset_manifest.json`.
+
+3. **Integrate with ENVITED-X Data Space**:
+   - Mint tokens using `tzip21_token_metadata.json`.
+
+4. **Test and Debug**:
+   - Compare local CID calculations with those generated by Pinata to ensure consistency.
+   - Use this implementation as a baseline to adapt to your specific asset requirements.
+
+## Related Documentation
+
+- [EVES-003: ENVITED Asset Definition and Upload Process](../eves-003.md)
+- [Gaia-X 4 PLC-AAD Manifest Ontology](https://github.com/ASCS-eV/ontology-management-base/tree/main/manifest)
+- [Pinata Documentation: Pinning CIDs](https://docs.pinata.cloud/web3/pinning/pinata-metadata#pinataoptions)
+- [TZIP-21 Metadata Standard](https://tzip.tezos.com/proposal/tzip-21/)

EVES/drafts/EVES-003/metadata/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu.zip

@@ -0,0 +1,155 @@
+{
+  "@context": {
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "gx": "https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#",
+    "skos": "http://www.w3.org/2004/02/skos/core#",
+    "sh": "http://www.w3.org/ns/shacl#",
+    "manifest": "https://github.com/GAIA-X4PLC-AAD/ontology-management-base/tree/main/manifest/"
+  },
+  "@id": "urn:uuid:896f0b9d-5626-4ddb-9d28-568f4af63603",
+  "@type": "manifest:Manifest",
+  "manifest:data": {
+    "@type": "manifest:Data",
+    "manifest:assetData": [
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "owner",
+        "manifest:type": "assetData",
+        "manifest:format": "xodr",
+        "manifest:path": {
+          "@value": "https://assets.envited-x.net/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu/data/TestfeldNiedersachsen_ALKS_ODR_sample.xodr",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "owner",
+        "manifest:type": "assetData",
+        "manifest:format": "xodr",
+        "manifest:path": {
+          "@value": "https://assets.envited-x.net/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu/data/TestfeldNiedersachsen_ALKS_ODR_sample_offset.xodr",
+          "@type": "xsd:anyURI"
+        }
+      }
+    ],
+    "manifest:contentData": [
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "metadata",
+        "manifest:format": "json",
+        "manifest:path": {
+          "@value": "ipfs://bafkreifsu25wkyq7oecmtam3mguuoov2zmjp6xi3chuf5plajagdjfoule",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "registeredUser",
+        "manifest:type": "documentation",
+        "manifest:format": "pdf",
+        "manifest:path": {
+          "@value": "https://metadata.envited-x.net/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu/documentation/TestfeldNiedersachsen_ALKS_ODR_sample_Documentation.pdf",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "registeredUser",
+        "manifest:type": "documentation",
+        "manifest:format": "txt",
+        "manifest:path": {
+          "@value": "https://metadata.envited-x.net/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu/documentation/TestfeldNiedersachsen_ALKS_ODR_sample_Documentation_stats.txt",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "registeredUser",
+        "manifest:type": "validation",
+        "manifest:format": "txt",
+        "manifest:path": {
+          "@value": "https://metadata.envited-x.net/bafybeidhmknqn4cofjlphtrxpyvruur42t55bfmtcldyb74l2ob22kjjdu/validation/qcReport.txt",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "visualization",
+        "manifest:format": "png",
+        "manifest:path": {
+          "@value": "ipfs://bafybeief5r2xgciehzhx6c4kbooifsnbjpiifjei36lpi3kzcdmpr2wvue",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "visualization",
+        "manifest:format": "png",
+        "manifest:path": {
+          "@value": "ipfs://bafybeiezbvlzqsawb3dkoie2ka4aawj6kf52prbsnap23q7x4z7j6aufwe",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "visualization",
+        "manifest:format": "png",
+        "manifest:path": {
+          "@value": "ipfs://bafkreidk4peygis2nnxjvvj5s4fl62uw3cglxj3jkavfzn3qffaorrydyi",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "visualization",
+        "manifest:format": "geojson",
+        "manifest:path": {
+          "@value": "ipfs://bafkreigszlzol72wvmge3lnlmjx7z6enkshoxrw6d32kuezgao2hllqbtm",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "publicUser",
+        "manifest:type": "visualization",
+        "manifest:format": "geojson",
+        "manifest:path": {
+          "@value": "ipfs://bafkreiakpb3ajhljq6cgwizcyirsk6uz322szaxd6ynmovcwuu5jkx5isa",
+          "@type": "xsd:anyURI"
+        }
+      },
+      {
+        "@type": "manifest:Link",
+        "manifest:accessRole": "registeredUser",
+        "manifest:type": "visualization",
+        "manifest:format": "geojson",
+        "manifest:path": {
+          "@value": "ipfs://bafkreia3od7e5yezmp2hv7gduqpv4x4ildseyqj5x5flijitskqojrtrpm",
+          "@type": "xsd:anyURI"
+        }
+      }
+    ]
+  },
+  "manifest:license": {
+    "@type": "manifest:License",
+    "manifest:spdxIdentifier": {
+      "@value": "MPL-2.0",
+      "@type": "xsd:string"
+    },
+    "manifest:licenseData": {
+      "@type": "manifest:Link",
+      "manifest:accessRole": "publicUser",
+      "manifest:type": "license",
+      "manifest:format": "html",
+      "manifest:path": {
+        "@value": "https://www.mozilla.org/en-US/MPL/2.0/",
+        "@type": "xsd:anyURI"
+      }
+    }
+  }
+}