@carrot-foundation/schemas 0.1.6

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

@@ -0,0 +1,145 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/certificate/certificate.schema.json",
+  "title": "Carrot Certificate Definitions",
+  "description": "Reusable certificate definitions for Carrot IPFS JSON schemas.",
+  "type": "object",
+  "$defs": {
+    "waste_classification": {
+      "type": "object",
+      "required": ["primary_type", "subtype", "net_weight_kg"],
+      "title": "Waste Classification",
+      "description": "Classification of the source waste (MassID)",
+      "properties": {
+        "primary_type": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/waste_type",
+          "title": "Source Waste Primary Type",
+          "description": "Primary type of the source waste"
+        },
+        "subtype": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/waste_subtype",
+          "title": "Source Waste Subtype",
+          "description": "Subtype of the source waste"
+        },
+        "net_weight_kg": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/weight_kg",
+          "title": "Source Waste Net Weight",
+          "description": "Net weight of the source waste"
+        }
+      },
+      "additionalProperties": false
+    },
+    "accredited_participants": {
+      "type": "array",
+      "minItems": 1,
+      "title": "Accredited Participants",
+      "items": {
+        "type": "object",
+        "required": [
+          "participant_id",
+          "name",
+          "role",
+          "external_url",
+          "accreditation_id"
+        ],
+        "properties": {
+          "participant_id": {
+            "$ref": "../definitions/definitions.schema.json#/$defs/uuid",
+            "title": "Participant ID"
+          },
+          "name": {
+            "$ref": "../definitions/definitions.schema.json#/$defs/participant_name"
+          },
+          "role": {
+            "$ref": "../definitions/definitions.schema.json#/$defs/participant_role"
+          },
+          "accreditation_id": {
+            "$ref": "../definitions/definitions.schema.json#/$defs/uuid",
+            "title": "Accreditation ID"
+          },
+          "external_url": {
+            "$ref": "../definitions/definitions.schema.json#/$defs/external_url",
+            "title": "Participant Accreditation External URL"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "participant_rewards": {
+      "type": "object",
+      "required": ["distribution_basis", "reward_allocations"],
+      "title": "Participant Rewards",
+      "description": "Rewards distribution to participants",
+      "properties": {
+        "distribution_basis": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 200,
+          "title": "Distribution Basis",
+          "description": "Basis for the rewards distribution"
+        },
+        "reward_allocations": {
+          "type": "array",
+          "minItems": 1,
+          "title": "Reward Allocations",
+          "description": "Rewards percentage allocated to each participant",
+          "items": {
+            "type": "object",
+            "required": [
+              "participant_id",
+              "participant_name",
+              "role",
+              "reward_percentage",
+              "effective_percentage"
+            ],
+            "properties": {
+              "participant_id": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/uuid",
+                "title": "Participant ID"
+              },
+              "participant_name": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/participant_name"
+              },
+              "role": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/participant_role"
+              },
+              "reward_percentage": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/percentage",
+                "title": "Reward Percentage",
+                "description": "Reward percentage allocated to the participant"
+              },
+              "large_business_discount_applied": {
+                "type": "boolean",
+                "title": "Large Business Discount Applied",
+                "description": "Whether the large business discount was applied"
+              },
+              "effective_percentage": {
+                "$ref": "../definitions/definitions.schema.json#/$defs/percentage",
+                "title": "Effective Percentage",
+                "description": "Effective percentage of the reward"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "distribution_notes": {
+          "type": "object",
+          "properties": {
+            "large_business_discount_applied": {
+              "$ref": "../definitions/definitions.schema.json#/$defs/non_empty_string",
+              "description": "Description of the large business discount applied",
+              "example": "50% reduction applied to participants with >$4M annual revenue"
+            },
+            "redirected_rewards": {
+              "$ref": "../definitions/definitions.schema.json#/$defs/non_empty_string",
+              "description": "Description of the redirected rewards",
+              "example": "Discounted rewards from large businesses redirected to accredited NGOs"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,250 @@
+{
+  "$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": [
+        "Waste Generation",
+        "Collection Point",
+        "Transfer Station",
+        "Sorting Facility",
+        "Composting Facility",
+        "Recycling Facility",
+        "Processing Facility",
+        "Disposal Facility",
+        "Administrative Office"
+      ],
+      "title": "Facility Type",
+      "description": "Type of facility at a location.",
+      "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"
+    },
+    "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

@@ -0,0 +1,95 @@
+{
+  "$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",
+    "municipality",
+    "administrative_division",
+    "administrative_division_code",
+    "country",
+    "country_code",
+    "responsible_participant_id",
+    "coordinates",
+    "facility_type"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/uuid",
+      "title": "Location ID",
+      "description": "Unique 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": {
+      "$ref": "../../definitions/definitions.schema.json#/$defs/uuid",
+      "title": "Responsible Participant ID",
+      "description": "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": [
+        "Waste Generation",
+        "Collection Point",
+        "Transfer Station",
+        "Sorting Facility",
+        "Composting Facility",
+        "Recycling Facility",
+        "Processing Facility",
+        "Disposal Facility",
+        "Administrative Office"
+      ],
+      "title": "Facility Type",
+      "description": "Type of facility at a location.",
+      "example": "Recycling Facility"
+    }
+  },
+  "additionalProperties": false
+}

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

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