@carrot-foundation/schemas 0.1.6

package/schemas/ipfs/shared/nft/nft.schema.json

@@ -0,0 +1,182 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/nft/nft.schema.json",
+  "title": "Carrot NFT IPFS Record",
+  "description": "NFT-specific fields for Carrot IPFS records.",
+  "unevaluatedProperties": false,
+  "allOf": [
+    {
+      "$ref": "../base/base.schema.json"
+    },
+    {
+      "type": "object",
+      "required": [
+        "blockchain",
+        "name",
+        "short_name",
+        "description",
+        "image",
+          "attributes"
+      ],
+      "properties": {
+        "schema": {
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["MassID", "RecycledID", "GasID", "PurchaseID"],
+              "title": "NFT Metadata Type",
+              "description": "Type/category of this NFT schema.",
+              "example": "MassID"
+            }
+          }
+        },
+        "blockchain": {
+          "type": "object",
+          "title": "NFT Blockchain Information",
+          "description": "Blockchain-specific information for the NFT.",
+          "required": [
+            "smart_contract_address",
+            "chain_id",
+            "network_name",
+            "token_id"
+          ],
+          "properties": {
+            "smart_contract_address": {
+              "$ref": "../definitions/definitions.schema.json#/$defs/ethereum_address",
+              "title": "Smart Contract Address"
+            },
+            "chain_id": {
+              "$ref": "../definitions/definitions.schema.json#/$defs/chain_id"
+            },
+            "network_name": {
+              "type": "string",
+              "title": "Blockchain Network Name",
+              "description": "Name of the blockchain network.",
+              "minLength": 5,
+              "maxLength": 100,
+              "example": "Polygon"
+            },
+            "token_id": {
+              "$ref": "../definitions/definitions.schema.json#/$defs/token_id"
+            }
+          },
+          "additionalProperties": false
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 100,
+          "title": "NFT Name",
+          "description": "Full display name for this NFT, including extra context.",
+          "example": "MassID #123 • Organic • 1.79t"
+        },
+        "short_name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 50,
+          "title": "NFT Short Name",
+          "description": "Compact name for UI summaries, tables, or tooltips.",
+          "example": "MassID #123"
+        },
+        "description": {
+          "type": "string",
+          "minLength": 10,
+          "maxLength": 500,
+          "title": "NFT Description",
+          "description": "Human-readable summary of the NFT's role and context. Ideally, maximum 300 characters.",
+          "example": "This MassID represents a recorded and traceable mass of organic waste."
+        },
+        "image": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/ipfs_uri",
+          "title": "NFT Image",
+          "description": "IPFS URI pointing to the preview image."
+        },
+        "background_color": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/hex_color",
+          "title": "NFT Background Color",
+          "description": "Hex color code for marketplace background display."
+        },
+        "animation_url": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/ipfs_uri",
+          "title": "NFT Animation URL",
+          "description": "IPFS URI pointing to an animated or interactive media file."
+        },
+        "external_links": {
+          "type": "array",
+          "maxItems": 10,
+          "uniqueItems": true,
+          "title": "NFT External Links",
+          "description": "Optional list of public resource links with labels.",
+          "items": {
+            "type": "object",
+            "required": ["label", "url", "description"],
+            "properties": {
+              "label": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 50,
+                "title": "NFT External Link Label",
+                "description": "Display name for the external link.",
+                "example": "View on Carrot Explorer"
+              },
+              "url": {
+                "type": "string",
+                "format": "uri",
+                "title": "NFT External Link URL",
+                "description": "Direct URI to the linked resource.",
+                "example": "https://explorer.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
+              },
+              "description": {
+                "type": "string",
+                "minLength": 10,
+                "maxLength": 100,
+                "title": "NFT External Link Description",
+                "description": "Optional context about what the link provides.",
+                "example": "Complete chain of custody and audit trail"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "attributes": {
+          "type": "array",
+          "title": "NFT Attributes",
+          "description": "List of visual traits and filterable attributes compatible with NFT marketplaces.",
+          "items": {
+            "type": "object",
+            "required": ["trait_type", "value"],
+            "properties": {
+              "trait_type": {
+                "type": "string",
+                "maxLength": 50,
+                "description": "Name of the trait or attribute.",
+                "example": "Waste Type"
+              },
+              "value": {
+                "oneOf": [
+                  { "type": "string" },
+                  { "type": "number" },
+                  { "type": "boolean" }
+                ],
+                "description": "Value of the trait - can be string, number, or boolean.",
+                "example": "Organic"
+              },
+              "display_type": {
+                "type": "string",
+                "enum": ["number", "date", "boost_number", "boost_percentage"],
+                "description": "How the trait should be displayed in marketplace UIs.",
+                "example": "number"
+              },
+              "max_value": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/non_negative_float",
+                "description": "Maximum possible value for numeric traits.",
+                "example": 100.5
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      }
+    }
+  ]
+}

package/schemas/ipfs/shared/references/audit-reference/audit-reference.schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/references/audit-reference/audit-reference.schema.json",
+  "title": "Audit Reference",
+  "description": "Reference to Audit record.",
+  "type": "object",
+  "required": [
+    "date",
+    "external_id",
+    "external_url",
+    "methodology_compliance",
+    "rules_executed",
+    "report"
+  ],
+  "properties": {
+    "date": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/iso_date",
+      "title": "Audit Date",
+      "description": "Date when the audit was completed"
+    },
+    "external_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_id"
+    },
+    "external_url": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_url",
+      "description": "URL to view the audit on Carrot Explorer"
+    },
+    "report": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/ipfs_uri",
+      "title": "Audit Report",
+      "description": "IPFS URI of the audit report"
+    },
+    "methodology_compliance": {
+      "type": "string",
+      "enum": ["PASSED", "FAILED"]
+    },
+    "rules_executed": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/non_negative_integer"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/ipfs/shared/references/gas-id-reference/gas-id-reference.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/references/gas-id-reference/gas-id-reference.schema.json",
+  "title": "GasID Reference",
+  "description": "Reference to a GasID record.",
+  "type": "object",
+  "required": ["external_id", "token_id", "external_url", "uri"],
+  "properties": {
+    "external_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_id",
+      "description": "Unique identifier for the GasID."
+    },
+    "token_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/token_id",
+      "description": "NFT token ID of the GasID."
+    },
+    "external_url": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_url",
+      "description": "URL to view the GasID on Carrot Explorer."
+    },
+    "uri": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/ipfs_uri",
+      "description": "IPFS URI of the GasID record."
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/ipfs/shared/references/mass-id-reference/mass-id-reference.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/references/mass-id-reference/mass-id-reference.schema.json",
+  "title": "MassID Reference",
+  "description": "Reference to a MassID record.",
+  "type": "object",
+  "required": ["external_id", "token_id", "external_url", "uri"],
+  "properties": {
+    "external_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_id",
+      "description": "Unique identifier for the MassID."
+    },
+    "token_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/token_id",
+      "description": "NFT token ID of the MassID."
+    },
+    "external_url": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_url",
+      "description": "URL to view the MassID on Carrot Explorer."
+    },
+    "uri": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/ipfs_uri",
+      "description": "IPFS URI of the MassID record."
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/ipfs/shared/references/methodology-reference/methodology-reference.schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/references/methodology-reference/methodology-reference.schema.json",
+  "title": "Methodology Reference",
+  "description": "Reference to a methodology record.",
+  "type": "object",
+  "required": ["external_id", "name", "version", "external_url"],
+  "properties": {
+    "external_id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_id",
+      "description": "Unique identifier for the methodology."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 5,
+      "maxLength": 150,
+      "description": "Human-readable name of the methodology.",
+      "example": "BOLD Carbon (CH₄)"
+    },
+    "version": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/semantic_version",
+      "description": "Version of the methodology."
+    },
+    "external_url": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/external_url",
+      "description": "URL to view the methodology on Carrot Explorer."
+    },
+    "uri": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/ipfs_uri",
+      "description": "IPFS URI to the methodology record."
+    }
+  },
+  "additionalProperties": false
+}