@carrot-foundation/schemas 0.1.36 → 0.1.37

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

@@ -1,255 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/definitions/definitions.schema.json",
-  "title": "Carrot Shared Definitions",
-  "description": "Reusable atomic, domain, and composite definitions for Carrot IPFS JSON schemas.",
-  "type": "object",
-  "$defs": {
-    "uuid": {
-      "type": "string",
-      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
-      "description": "UUID v4 string in canonical format.",
-      "example": "6f520d88-864d-432d-bf9f-5c3166c4818f"
-    },
-    "ethereum_address": {
-      "type": "string",
-      "pattern": "^0x[a-f0-9]{40}$",
-      "title": "Ethereum Address",
-      "description": "Ethereum address in lowercase hexadecimal format.",
-      "example": "0xabc123def456789abcdef123456789abcdef1234"
-    },
-    "iso_timestamp": {
-      "type": "string",
-      "format": "date-time",
-      "title": "ISO 8601 Timestamp",
-      "description": "ISO 8601 timestamp with timezone.",
-      "example": "2024-12-05T11:02:47.000Z"
-    },
-    "iso_date": {
-      "type": "string",
-      "format": "date",
-      "title": "ISO 8601 Date",
-      "description": "ISO 8601 date (YYYY-MM-DD).",
-      "example": "2024-02-10"
-    },
-    "iso_country_code": {
-      "type": "string",
-      "pattern": "^[A-Z]{2}$",
-      "title": "Country Code",
-      "description": "ISO 3166-1 alpha-2 country code.",
-      "example": "BR"
-    },
-    "iso_administrative_division_code": {
-      "type": "string",
-      "pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$",
-      "title": "Administrative Division Code",
-      "description": "ISO 3166-2 administrative division code.",
-      "example": "BR-AP"
-    },
-    "latitude": {
-      "type": "number",
-      "minimum": -90,
-      "maximum": 90,
-      "description": "Latitude in decimal degrees.",
-      "example": -23.39
-    },
-    "longitude": {
-      "type": "number",
-      "minimum": -180,
-      "maximum": 180,
-      "description": "Longitude in decimal degrees.",
-      "example": -51.13
-    },
-    "weight_kg": {
-      "type": "number",
-      "minimum": 0,
-      "title": "Weight in Kilograms",
-      "description": "Weight measurement in kilograms.",
-      "example": 1500.5
-    },
-    "name": {
-      "$ref": "#/$defs/non_empty_string",
-      "maxLength": 200
-    },
-    "slug": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^[a-z0-9-]+$",
-      "maxLength": 100,
-      "title": "Slug",
-      "description": "URL-friendly identifier using lowercase letters, numbers, and hyphens only.",
-      "example": "bold-carbon-ch4"
-    },
-    "non_empty_string": {
-      "type": "string",
-      "minLength": 1
-    },
-    "waste_type": {
-      "$ref": "#/$defs/non_empty_string",
-      "title": "Waste Classification",
-      "description": "Primary waste material category following international standards.",
-      "example": "Organic"
-    },
-    "waste_subtype": {
-      "$ref": "#/$defs/non_empty_string",
-      "maxLength": 100,
-      "description": "Specific subcategory or detailed classification of the waste material.",
-      "example": "Food, Food Waste and Beverages"
-    },
-    "participant_role": {
-      "$ref": "#/$defs/non_empty_string",
-      "maxLength": 100,
-      "title": "Participant Role",
-      "description": "Role in the waste management supply chain.",
-      "example": "Transporter"
-    },
-    "participant_name": {
-      "$ref": "#/$defs/non_empty_string",
-      "maxLength": 100,
-      "title": "Participant Name",
-      "description": "Legal name of the participant.",
-      "example": "Eco Reciclagem"
-    },
-    "facility_type": {
-      "type": "string",
-      "enum": [
-        "Collection Point",
-        "Recycling Facility",
-        "Administrative Office",
-        "Other"
-      ],
-      "title": "Facility Type",
-      "description": "Type of facility in the waste management chain.",
-      "example": "Recycling Facility"
-    },
-    "chain_id": {
-      "type": "integer",
-      "minimum": 1,
-      "title": "Blockchain network chain ID",
-      "description": "Blockchain network chain ID where the NFT is deployed.",
-      "example": 137
-    },
-    "percentage": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 100,
-      "title": "Percentage Value",
-      "description": "Percentage value between 0 and 100.",
-      "example": 25.5
-    },
-    "non_negative_integer": {
-      "type": "integer",
-      "minimum": 0,
-      "title": "Non-Negative Integer",
-      "description": "Non-negative integer value.",
-      "example": 100
-    },
-    "positive_integer": {
-      "type": "integer",
-      "minimum": 1,
-      "title": "Positive Integer",
-      "description": "Positive integer value.",
-      "example": 100
-    },
-    "non_negative_float": {
-      "type": "number",
-      "minimum": 0,
-      "title": "Non-Negative Float",
-      "description": "Non-negative float value.",
-      "example": 100.5
-    },
-    "hours": {
-      "type": "number",
-      "minimum": 0,
-      "multipleOf": 0.1,
-      "title": "Hours",
-      "description": "Time in hours.",
-      "example": 72.5
-    },
-    "ipfs_uri": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^ipfs://[a-zA-Z0-9]+(/.*)?$",
-      "title": "IPFS URI",
-      "description": "IPFS URI pointing to content-addressed data using CID (Content Identifier). Format: ipfs://{CID}[/path]",
-      "examples": [
-        "ipfs://QmTy8w65yBXgyfG2ZBg5TrfB2hPjrDQH3RCQFJGkARStJb",
-        "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
-        "ipfs://QmHashExample/metadata.json"
-      ]
-    },
-    "semantic_version": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^v?\\d+\\.\\d+\\.\\d+(-[a-zA-Z0-9.-]+)?(\\+[a-zA-Z0-9.-]+)?$",
-      "title": "Semantic Version",
-      "description": "Semantic version string (semver.org).",
-      "example": "v1.2.3"
-    },
-    "token_id": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^[0-9]+$",
-      "title": "Token ID",
-      "description": "NFT token ID as numeric string (supports uint256).",
-      "example": "123"
-    },
-    "hex_color": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^#[0-9A-F]{6}$",
-      "title": "Hex Color",
-      "description": "Hex color code with # prefix and uppercase.",
-      "example": "#FFFFFF"
-    },
-    "sha256_hash": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^[a-f0-9]{64}$",
-      "title": "SHA-256 Hash",
-      "description": "SHA-256 cryptographic hash as hexadecimal string.",
-      "examples": [
-        "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
-        "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
-      ]
-    },
-    "keccak256_hash": {
-      "$ref": "#/$defs/non_empty_string",
-      "pattern": "^0x[a-fA-F0-9]{64}$",
-      "title": "Keccak256 Hash",
-      "description": "Keccak256 hash as 32-byte hex string.",
-      "example": "0x9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658"
-    },
-    "external_id": {
-      "$ref": "#/$defs/uuid",
-      "title": "External ID",
-      "description": "Off-chain reference ID (UUID from Carrot backend)."
-    },
-    "external_url": {
-      "$ref": "#/$defs/non_empty_string",
-      "format": "uri",
-      "title": "External URL",
-      "description": "External URL of the content.",
-      "example": "https://explore.carrot.eco/document/40e44dc8-75d4-4b6f-a5b2-420ab9482ee9"
-    },
-    "token_symbol": {
-      "$ref": "#/$defs/non_empty_string",
-      "maxLength": 10,
-      "pattern": "^[A-Z0-9-]+$",
-      "title": "Token Symbol",
-      "description": "ERC20 token symbol in uppercase letters and numbers only.",
-      "example": "C-CARB"
-    },
-    "relationship_type": {
-      "type": "string",
-      "enum": [
-        "collection",
-        "credit",
-        "gas-id",
-        "mass-id",
-        "mass-id-audit",
-        "methodology",
-        "purchase-id",
-        "recycled-id"
-      ],
-      "title": "Relationship Type",
-      "description": "Type of relationship between records.",
-      "example": "mass-id"
-    }
-  },
-  "additionalProperties": false
-}

package/schemas/ipfs/shared/entities/location/location.schema.json

@@ -1,90 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/entities/location/location.schema.json",
-  "title": "Geographic Location",
-  "description": "Geographic location with address and coordinate information.",
-  "type": "object",
-  "required": [
-    "id_hash",
-    "municipality",
-    "administrative_division",
-    "administrative_division_code",
-    "country",
-    "country_code",
-    "responsible_participant_id_hash",
-    "coordinates",
-    "facility_type"
-  ],
-  "properties": {
-    "id_hash": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/sha256_hash",
-      "title": "Location ID Hash",
-      "description": "Anonymized identifier for the location."
-    },
-    "municipality": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/non_empty_string",
-      "maxLength": 50,
-      "description": "Municipality or city name.",
-      "example": "Macapá"
-    },
-    "administrative_division": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/non_empty_string",
-      "title": "Administrative Division",
-      "maxLength": 50,
-      "description": "State, province, or administrative region.",
-      "example": "Amapá"
-    },
-    "administrative_division_code": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/iso_administrative_division_code"
-    },
-    "country": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/non_empty_string",
-      "maxLength": 50,
-      "description": "Full country name in English.",
-      "example": "Brazil"
-    },
-    "country_code": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/iso_country_code"
-    },
-    "responsible_participant_id_hash": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/sha256_hash",
-      "title": "Responsible Participant ID Hash",
-      "description": "Anonymized ID of the participant responsible for this location."
-    },
-    "coordinates": {
-      "type": "object",
-      "title": "Location Coordinates",
-      "description": "GPS coordinates of the location.",
-      "required": ["latitude", "longitude", "precision_level"],
-      "properties": {
-        "latitude": {
-          "$ref": "../../definitions/definitions.schema.json#/$defs/latitude"
-        },
-        "longitude": {
-          "$ref": "../../definitions/definitions.schema.json#/$defs/longitude"
-        },
-        "precision_level": {
-          "type": "string",
-          "enum": ["exact", "neighborhood", "city", "region", "country"],
-          "title": "Coordinate Precision Level",
-          "description": "Level of coordinate precision.",
-          "example": "city"
-        }
-      },
-      "additionalProperties": false
-    },
-    "facility_type": {
-      "type": "string",
-      "enum": [
-        "Collection Point",
-        "Recycling Facility",
-        "Administrative Office",
-        "Other"
-      ],
-      "title": "Facility Type",
-      "description": "Type of facility in the waste management chain.",
-      "example": "Recycling Facility"
-    }
-  },
-  "additionalProperties": false
-}

package/schemas/ipfs/shared/entities/participant/participant.schema.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/entities/participant/participant.schema.json",
-  "title": "Participant",
-  "description": "A participant in the waste management supply chain.",
-  "type": "object",
-  "required": ["id", "name", "roles"],
-  "properties": {
-    "id": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/uuid",
-      "description": "Unique identifier for the participant."
-    },
-    "name": {
-      "$ref": "../../definitions/definitions.schema.json#/$defs/participant_name"
-    },
-    "roles": {
-      "type": "array",
-      "minItems": 1,
-      "uniqueItems": true,
-      "description": "Roles of the participant in the waste management supply chain.",
-      "items": {
-        "$ref": "../../definitions/definitions.schema.json#/$defs/participant_role"
-      },
-      "example": ["Waste Generator", "Transporter"]
-    }
-  },
-  "additionalProperties": false
-}

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

@@ -1,182 +0,0 @@
-{
-  "$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

@@ -1,42 +0,0 @@
-{
-  "$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

@@ -1,27 +0,0 @@
-{
-  "$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

@@ -1,27 +0,0 @@
-{
-  "$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
-}