CIP-0072 | Off-chain schema versioning and schema adjustments

CIP-0072/README.md

@@ -83,7 +83,7 @@ The on-chain dApp registration certificate MUST follow canonical JSON and be ser
   - *`REGISTER`*: The certificate is asserting that the dApp is registered for the first time or is providing an update.
   - *`DE_REGISTER`*: The certificate is asserting that the dApp is deprecated / archived. So, no further dApp's on-chain update is expected.
 
-*`rootHash`*: The hash of the entire offchain metadata tree object. This hash is used by clients to verify the integrity of the metadata tree object. When reading a metadata tree object, the client should calculate the hash of the object and compare it with the `rootHash` property. If the two hashes don't match, the client should discard the object. The metadata tree object is a JSON object that contains the dApp's metadata. The metadata tree object is described in the next section. Please note that off-chain JSON must be converted into RFC 8765 canonical form before taking the hash!
+*`rootHash`*: The blake2b-256 hash of the entire offchain metadata tree object. This hash is used by clients to verify the integrity of the metadata tree object. When reading a metadata tree object, the client should calculate the hash of the object and compare it with the `rootHash` property. If the two hashes don't match, the client should discard the object. The metadata tree object is a JSON object that contains the dApp's metadata. The metadata tree object is described in the next section. Please note that off-chain JSON must be converted into RFC 8765 canonical form before taking the hash!
 
 *`metadata`*: An array of links to the dApp's metadata. The metadata is a JSON compatible RFC 8785 object that contains the dApp's metadata.
 

CIP-0072/version_1_offchain.json

@@ -2,6 +2,11 @@
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "type":"object",
     "properties": {
+      "version": {
+        "type": "integer",
+        "minimum": 1,
+        "description": "Off-chain schema version"
+      },
       "subject": {
         "type":"string",
         "minLength": 1,
@@ -11,63 +16,92 @@
       },
       "projectName": {
         "type":"string",
-        "description": "A project name, e.g. My dApp."
+        "description": "A project name, e.g. My dApp.",
+        "maxLength": 40
       },
       "link": {
         "type":"string",
         "description": "Website presenting a dApp.",
-        "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})"
-      },      
+        "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})",
+        "maxLength": 200
+      },
       "logo": {
-        "type":"string",
-        "description": "URL to the logo or the base64 encoded image."
+        "type": "string",
+        "description": "URL to the logo. Minimum resolution: 512x512px, supported formats: PNG/JPG/SVG, maximum file size: 0.5 MB",
+        "maxLength": 1000
       },
       "categories": {
         "type":"array",
         "items": {
           "type": "string",
-          "enum":["Games", "DeFi", "Gambling", "Exchanges", "Collectibles", "Marketplaces", "Social", "Other"]
+          "enum": ["DeFi", "Development", "Education", "Games", "Identity", "Marketplace", "NFT", "Other", "Security"]
         },
         "description": "One or more categories. Category MUST be one of the following schema definition."
       },
+      "screenshots": {
+        "type": "array",
+        "maxItems": 10,
+        "items": {
+          "type": "string",
+          "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})",
+          "maxLength": 1000,
+          "description": "Minimum resolution: 1920x1080px, supported formats: PNG/JPG/SVG, maximum file size: 1 MB"
+        },
+        "description": "URLs to screenshots of DApp actual pages. We recommend to share screenshots from the dApp usage itself."
+      },
       "social": {
         "type":"object",
         "properties": {
-          "website": {
-            "type":"string",
-            "description": "dApps website link.",
+          "companyName": {
+            "type": "string",
+            "description": "Name of the company developing/maintaining the dApp",
+            "maxLength": 50
+          },
+          "companyEmail": {
+            "type": "string",
+            "description": "Email of the company developing/maintaining the dApp",
+            "maxLength": 150,
+            "format": "email"
+          },
+          "companyWebsite": {
+            "type": "string",
+            "description": "Website of the company developing/maintaining the dApp",
+            "maxLength": 200,
             "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})"
           },
           "twitter": {
             "type":"string",
             "description": "An optional Twitter link.",
+            "maxLength": 200,
             "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})"
           },
           "github": {
             "type":"string",
             "description": "An optional Github link.",
+            "maxLength": 200,
             "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})"
           },
           "discord": {
             "type":"string",
             "description": "An optional Discord link.",
+            "maxLength": 200,
             "pattern": "(https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|www\\.[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}|https?:\/\/(?:www\\.|(?!www))[a-zA-Z0-9]+\\.[^\\s]{2,}|www\\.[a-zA-Z0-9]+\\.[^\\s]{2,})"
           }
         },
-        "required": ["website"]
+        "required": ["companyWebsite"]
       },
       "description": {
         "type": "object",
         "properties": {
           "short": {
             "type": "string",
-            "description": "Short dApp description (no less than 40 and no longer than 168 characters).",
+            "description": "Short dApp description.",
             "minLength": 40,
             "maxLength": 168
           },
           "long": {
             "type": "string",
-            "description": "An optional long dApp description (no less than 40 and no longer than 1008 characters).",
+            "description": "An optional long dApp description.",
             "minLength": 40,
             "maxLength": 1008
           }
@@ -143,8 +177,8 @@
               "purposes":{
                 "type":"array",
                 "items": {
-                    "type": "string",
-                      "enum":["SPEND", "MINT"]
+                  "type": "string",
+                  "enum":["SPEND", "MINT"]
                 },
                 "description": "Purpouses of the script, SPEND or MINT (notice it can be both for some modern Cardano languages)."
               },
@@ -201,7 +235,7 @@
       "link",
       "social",
       "categories",
-      "description"
+      "description",
+      "version"
     ]
   }
-