@carrot-foundation/schemas 0.1.36 → 0.1.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-foundation/schemas",
-  "version": "0.1.36",
+  "version": "0.1.37",
   "description": "Carrot schema definitions and zod validation schemas",
   "license": "Apache-2.0",
   "private": false,

package/schemas/ipfs/collection/collection.example.json

@@ -13,6 +13,7 @@
   "created_at": "2024-12-05T14:30:00.000Z",
   "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
   "external_url": "https://explore.carrot.eco/collection/bold-cold-start-carazinho",
+  "original_content_hash": "8b33fe7f20e0b71c003e63f7db6da83fedef22b4229b5089b78554fc8a2cb987",
   "content_hash": "8b33fe7f20e0b71c003e63f7db6da83fedef22b4229b5089b78554fc8a2cb987",
   "creator": {
     "name": "Carrot Foundation",

package/schemas/ipfs/collection/collection.schema.json

@@ -1,47 +1,320 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/collection/collection.schema.json",
   "title": "Collection IPFS Record",
-  "unevaluatedProperties": false,
-  "allOf": [
-    {
-      "$ref": "../shared/base/base.schema.json"
+  "description": "Collection metadata stored in IPFS, extending the base schema with collection-specific fields required for NFT collection definitions in Carrot's ecosystem",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.37/schemas/ipfs/collection/collection.schema.json",
+  "version": "0.1.37",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "title": "JSON Schema URI",
+      "description": "URI of the JSON Schema used to validate this record",
+      "example": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/base/base.schema.json",
+      "type": "string",
+      "format": "uri"
     },
-    {
+    "schema": {
       "type": "object",
-      "required": ["name", "description", "image"],
       "properties": {
-        "schema": {
-          "properties": {
-            "type": {
-              "const": "Collection"
+        "hash": {
+          "title": "Schema Hash",
+          "description": "Keccak256 hash of the JSON Schema this record was validated against",
+          "examples": [
+            "ac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f",
+            "0xac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f"
+          ],
+          "anyOf": [
+            {
+              "title": "Keccak256 Hash",
+              "description": "Keccak256 cryptographic hash as hexadecimal string",
+              "examples": [
+                "ac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f",
+                "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2"
+              ],
+              "type": "string",
+              "pattern": "^[0-9a-fA-F]{64}$"
+            },
+            {
+              "type": "string",
+              "pattern": "^0x[a-fA-F0-9]{64}$"
             }
-          }
+          ]
+        },
+        "type": {
+          "title": "Collection Schema Type",
+          "description": "Collection schema type",
+          "type": "string",
+          "const": "Collection"
         },
+        "version": {
+          "title": "Schema Version",
+          "description": "Version of the schema, using semantic versioning",
+          "examples": [
+            "0.1.0",
+            "1.0.0",
+            "2.1.3"
+          ],
+          "type": "string",
+          "minLength": 1,
+          "pattern": "^v?\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$"
+        }
+      },
+      "required": [
+        "hash",
+        "type",
+        "version"
+      ],
+      "additionalProperties": false
+    },
+    "created_at": {
+      "title": "Created At",
+      "description": "ISO 8601 creation timestamp for this record",
+      "examples": [
+        "2024-12-05T11:02:47.000Z",
+        "2025-02-22T10:35:12.000Z"
+      ],
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+    },
+    "external_id": {
+      "title": "External ID",
+      "description": "Off-chain reference ID (UUID from Carrot backend)",
+      "examples": [
+        "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
+        "b2c4e6f8-a1b3-4c5d-9e8f-123456789abc"
+      ],
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$"
+    },
+    "external_url": {
+      "title": "External URL",
+      "description": "External URL of the content",
+      "examples": [
+        "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
+        "https://carrot.eco/whitepaper.pdf"
+      ],
+      "type": "string",
+      "format": "uri"
+    },
+    "original_content_hash": {
+      "title": "Original Content Hash",
+      "description": "SHA-256 hash of the original JSON content including private data before schema validation",
+      "examples": [
+        "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
+        "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
+      ],
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{64}$"
+    },
+    "content_hash": {
+      "title": "Content Hash",
+      "description": "SHA-256 hash of RFC 8785 canonicalized JSON after schema validation",
+      "examples": [
+        "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
+        "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
+      ],
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{64}$"
+    },
+    "creator": {
+      "title": "Creator",
+      "description": "Entity that created this record",
+      "type": "object",
+      "properties": {
         "name": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-          "title": "Collection Name",
-          "example": "BOLD Cold Start - Carazinho"
+          "title": "Creator Name",
+          "description": "Company or individual name that created this record",
+          "examples": [
+            "Carrot Foundation"
+          ],
+          "type": "string"
         },
-        "slug": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
-          "title": "Collection Slug",
-          "example": "bold-cold-start-carazinho"
+        "id": {
+          "title": "Creator ID",
+          "description": "Unique identifier for the creator",
+          "examples": [
+            "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
+            "6f520d88-864d-432d-bf9f-5c3166c4818f",
+            "f77afa89-1c58-40fd-9bf5-8a86703a8af4"
+          ],
+          "type": "string",
+          "format": "uuid",
+          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$"
+        }
+      },
+      "required": [
+        "name",
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "relationships": {
+      "title": "Relationships",
+      "description": "References to other IPFS records this record relates to",
+      "type": "array",
+      "items": {
+        "title": "Relationship",
+        "description": "Relationship to another IPFS record",
+        "type": "object",
+        "properties": {
+          "target_uri": {
+            "title": "Target IPFS URI",
+            "description": "Target IPFS URI of the referenced record",
+            "examples": [
+              "ipfs://QmTy8w65yBXgyfG2ZBg5TrfB2hPjrDQH3RCQFJGkARStJb/mass-id-organic.png",
+              "ipfs://QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o"
+            ],
+            "type": "string",
+            "minLength": 1,
+            "pattern": "^ipfs:\\/\\/[a-zA-Z0-9]+(\\/.*)?$"
+          },
+          "type": {
+            "title": "Relationship Type",
+            "description": "Type of relationship to the referenced record",
+            "examples": [
+              "mass-id",
+              "collection",
+              "credit-purchase-receipt"
+            ],
+            "type": "string",
+            "enum": [
+              "collection",
+              "credit",
+              "gas-id",
+              "mass-id",
+              "mass-id-audit",
+              "methodology",
+              "credit-purchase-receipt",
+              "recycled-id"
+            ]
+          },
+          "description": {
+            "title": "Relationship Description",
+            "description": "Human-readable description of the relationship",
+            "examples": [
+              "This record supersedes the previous version",
+              "Related carbon credit batch",
+              "Source document for this verification",
+              "Child record derived from this parent",
+              "Updated version of original record"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "target_uri",
+          "type"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "environment": {
+      "title": "Environment",
+      "description": "Environment information",
+      "type": "object",
+      "properties": {
+        "blockchain_network": {
+          "title": "Blockchain Network",
+          "description": "Blockchain Network Environment",
+          "type": "string",
+          "enum": [
+            "mainnet",
+            "testnet"
+          ]
         },
-        "image": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/ipfs_uri",
-          "title": "Collection Image",
-          "description": "IPFS URI pointing to the collection's visual representation image.",
-          "example": "ipfs://QmCollectionImageHash/collection-icon.png"
+        "deployment": {
+          "title": "Deployment Environment",
+          "description": "System environment where this record was generated",
+          "type": "string",
+          "enum": [
+            "production",
+            "development",
+            "testing"
+          ]
         },
-        "description": {
+        "data_set_name": {
+          "title": "Data Set Name",
+          "description": "Name of the data set for this record",
           "type": "string",
-          "minLength": 50,
-          "maxLength": 1000,
-          "title": "Collection Description",
-          "example": "Cold Start is a limited-edition collection created for early supporters of BOLD - Breakthrough in Organic Landfill Diversion. This purchase contributes to reducing global waste and promoting circularity, with funds distributed via smart contract to local recycling operations and communities."
+          "enum": [
+            "TEST",
+            "PROD"
+          ]
         }
-      }
+      },
+      "required": [
+        "blockchain_network",
+        "deployment",
+        "data_set_name"
+      ],
+      "additionalProperties": false
+    },
+    "data": {
+      "title": "Custom Data",
+      "description": "Custom data block that includes the record's data",
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "name": {
+      "title": "Collection Name",
+      "description": "Display name of the collection",
+      "examples": [
+        "BOLD Cold Start - Carazinho",
+        "BOLD Brazil"
+      ],
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 150
+    },
+    "slug": {
+      "title": "Collection Slug",
+      "description": "URL-friendly identifier for a collection",
+      "examples": [
+        "bold-cold-start-carazinho",
+        "bold-brazil"
+      ],
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 100,
+      "pattern": "^[a-z0-9-]+$"
+    },
+    "image": {
+      "title": "Collection Image",
+      "description": "IPFS URI pointing to the collection's visual representation",
+      "examples": [
+        "ipfs://QmCollectionImageHash/collection-icon.png"
+      ],
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^ipfs:\\/\\/[a-zA-Z0-9]+(\\/.*)?$"
+    },
+    "description": {
+      "title": "Collection Description",
+      "description": "Comprehensive description of the collection, its purpose, and context",
+      "examples": [
+        "Cold Start is a limited-edition collection created for early supporters of BOLD - Breakthrough in Organic Landfill Diversion. This purchase contributes to reducing global waste and promoting circularity, with funds distributed via smart contract to local recycling operations and communities."
+      ],
+      "type": "string",
+      "minLength": 50,
+      "maxLength": 1000
     }
-  ]
-}
+  },
+  "required": [
+    "$schema",
+    "schema",
+    "created_at",
+    "external_id",
+    "external_url",
+    "original_content_hash",
+    "content_hash",
+    "name",
+    "image",
+    "description"
+  ],
+  "additionalProperties": false
+}

package/schemas/ipfs/credit/credit.example.json

@@ -13,6 +13,7 @@
   "created_at": "2024-12-05T14:30:00.000Z",
   "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
   "external_url": "https://explore.carrot.eco/credit/carrot-carbon",
+  "original_content_hash": "8b33fe7f20e0b71c003e63f7db6da83fedef22b4229b5089b78554fc8a2cb987",
   "content_hash": "8b33fe7f20e0b71c003e63f7db6da83fedef22b4229b5089b78554fc8a2cb987",
   "creator": {
     "name": "Carrot Foundation",