@carrot-foundation/schemas 0.1.6

package/schemas/ipfs/recycled-id/recycled-id.attributes.schema.json

@@ -0,0 +1,202 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/recycled-id/recycled-id.attributes.schema.json",
+  "$defs": {
+    "attribute_methodology": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Methodology"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 100,
+          "description": "Name of the recycling methodology used for certification",
+          "example": "BOLD Recycling"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_recycled_mass_weight": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "const": "Recycled Mass Weight (kg)"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/weight_kg",
+          "description": "Total weight of recycled materials in kilograms"
+        },
+        "display_type": {
+          "const": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_credit_amount": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "const": "Credit Amount"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "description": "Amount of credits issued"
+        },
+        "display_type": {
+          "const": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_credit_type": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Credit Type"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 100,
+          "description": "Type of credit issued",
+          "example": "Carrot Organic"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_source_waste_type": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Source Waste Type"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/waste_type"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_source_weight": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "const": "Source Weight (kg)"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/weight_kg"
+        },
+        "display_type": {
+          "const": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_origin_country": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Origin Country"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 100,
+          "description": "Country where the waste was generated",
+          "example": "Brazil"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_origin_municipality": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Origin Municipality"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 100,
+          "description": "Municipality where the waste was generated",
+          "example": "Macapá"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_recycler": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Recycler"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "maxLength": 100,
+          "description": "Organization that processed the waste",
+          "example": "Eco Reciclagem"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_mass_id_token_id": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "MassID"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "pattern": "^#[0-9]+$",
+          "description": "Token ID of the source MassID NFT",
+          "example": "#123"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_mass_id_recycling_date": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "const": "MassID Recycling Date"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/iso_date",
+          "description": "Date when the source waste was recycled",
+          "example": "2025-02-22"
+        },
+        "display_type": {
+          "const": "date"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "title": "RecycledID NFT Attribute Array",
+  "description": "Schema for the fixed set of RecycledID NFT attributes, enforcing order and type for each trait.",
+  "type": "array",
+  "prefixItems": [
+    { "$ref": "#/$defs/attribute_methodology" },
+    { "$ref": "#/$defs/attribute_recycled_mass_weight" },
+    { "$ref": "#/$defs/attribute_credit_amount" },
+    { "$ref": "#/$defs/attribute_credit_type" },
+    { "$ref": "#/$defs/attribute_source_waste_type" },
+    { "$ref": "#/$defs/attribute_source_weight" },
+    { "$ref": "#/$defs/attribute_origin_country" },
+    { "$ref": "#/$defs/attribute_origin_municipality" },
+    { "$ref": "#/$defs/attribute_recycler" },
+    { "$ref": "#/$defs/attribute_mass_id_token_id" },
+    { "$ref": "#/$defs/attribute_mass_id_recycling_date" }
+  ],
+  "items": false,
+  "minItems": 11,
+  "maxItems": 11
+}

package/schemas/ipfs/recycled-id/recycled-id.data.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/recycled-id/recycled-id.data.schema.json",
+  "title": "RecycledID Data",
+  "type": "object",
+  "required": [
+    "summary",
+    "methodology",
+    "audit",
+    "mass_id",
+    "waste_classification",
+    "origin_location",
+    "accredited_participants"
+  ],
+  "properties": {
+    "summary": {
+      "type": "object",
+      "required": ["recycled_mass_kg", "credit_type", "credit_amount"],
+      "properties": {
+        "recycled_mass_kg": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/weight_kg",
+          "title": "Recycled Mass Weight",
+          "description": "Total weight of materials successfully recycled"
+        },
+        "credit_type": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "title": "Credit Type",
+          "description": "Type of credit issued"
+        },
+        "credit_amount": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "title": "Credit Amount",
+          "description": "Amount of credits issued"
+        }
+      },
+      "additionalProperties": false
+    },
+    "methodology": {
+      "$ref": "../shared/references/methodology-reference/methodology-reference.schema.json"
+    },
+    "audit": {
+      "$ref": "../shared/references/audit-reference/audit-reference.schema.json"
+    },
+    "mass_id": {
+      "$ref": "../shared/references/mass-id-reference/mass-id-reference.schema.json"
+    },
+    "waste_classification": {
+      "$ref": "../shared/certificate/certificate.schema.json#/$defs/waste_classification"
+    },
+    "origin_location": {
+      "$ref": "../shared/entities/location/location.schema.json",
+      "title": "Source Waste Origin Location",
+      "description": "Location of the waste origin"
+    },
+    "accredited_participants": {
+      "$ref": "../shared/certificate/certificate.schema.json#/$defs/accredited_participants"
+    },
+    "participant_rewards": {
+      "$ref": "../shared/certificate/certificate.schema.json#/$defs/participant_rewards"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/ipfs/recycled-id/recycled-id.example.json

@@ -0,0 +1,213 @@
+{
+  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/recycled-id/recycled-id.schema.json",
+  "schema": {
+    "hash": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
+    "type": "RecycledID",
+    "version": "v0.1.0"
+  },
+  "environment": {
+    "blockchain_network": "mainnet",
+    "deployment": "production",
+    "data_set_name": "TEST"
+  },
+  "blockchain": {
+    "smart_contract_address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
+    "chain_id": 1,
+    "network_name": "Ethereum Mainnet",
+    "token_id": "789"
+  },
+  "created_at": "2025-06-24T13:02:25.000Z",
+  "external_id": "f47ac10b-58cc-4372-a567-0e02b2c3d489",
+  "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d489",
+  "content_hash": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
+  "creator": {
+    "name": "Carrot Foundation",
+    "id": "7601e741-8c05-4b6f-b3af-dba92e1b4ed2"
+  },
+  "name": "RecycledID #789 • BOLD Recycling • 3.0t Recycled",
+  "short_name": "RecycledID #789",
+  "description": "This RecycledID certifies 3.0 metric tons of organic waste successfully recycled through BOLD Recycling methodology from Macapá, Brazil, producing high-quality compost and organic fertilizer.",
+  "image": "ipfs://QmRecycledIdHash789/recycled-id-bold-recycling.png",
+  "background_color": "#2D5016",
+  "external_links": [
+    {
+      "label": "View on Carrot Explorer",
+      "url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d489",
+      "description": "Complete RecycledID details and audit trail"
+    },
+    {
+      "label": "MassID",
+      "url": "https://explore.carrot.eco/document/6f520d88-864d-432d-bf9f-5c3166c4818f",
+      "description": "Originating waste batch with full chain of custody"
+    },
+    {
+      "label": "BOLD Recycling Methodology",
+      "url": "https://explore.carrot.eco/document/bold-recycling",
+      "description": "Complete methodology specification and rules"
+    },
+    {
+      "label": "Carrot White Paper",
+      "url": "https://carrot.eco/whitepaper",
+      "description": "Carrot ecosystem overview and technical foundation"
+    }
+  ],
+  "attributes": [
+    {
+      "trait_type": "Methodology",
+      "value": "BOLD Recycling"
+    },
+    {
+      "trait_type": "Recycled Mass Weight (kg)",
+      "value": 3000,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Credit Amount",
+      "value": 3,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Credit Type",
+      "value": "Carrot Organic"
+    },
+    {
+      "trait_type": "Source Waste Type",
+      "value": "Organic"
+    },
+    {
+      "trait_type": "Source Weight (kg)",
+      "value": 3000,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Origin Country",
+      "value": "Brazil"
+    },
+    {
+      "trait_type": "Origin Municipality",
+      "value": "Macapá"
+    },
+    {
+      "trait_type": "Recycler",
+      "value": "Eco Reciclagem"
+    },
+    {
+      "trait_type": "MassID",
+      "value": "#123"
+    },
+    {
+      "trait_type": "MassID Recycling Date",
+      "value": "2025-02-22",
+      "display_type": "date"
+    }
+  ],
+  "data": {
+    "summary": {
+      "recycled_mass_kg": 3000,
+      "credit_type": "Carrot Organic (C-BIOW)",
+      "credit_amount": 3
+    },
+    "methodology": {
+      "external_id": "f47ac10b-58cc-4372-a567-0e02b2c3d490",
+      "name": "BOLD Recycling",
+      "version": "1.2.0",
+      "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d490",
+      "uri": "ipfs://QmMethodologyHash/bold-recycling-v1.2.0.pdf"
+    },
+    "audit": {
+      "date": "2025-06-24",
+      "external_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+      "external_url": "https://explore.carrot.eco/document/a1b2c3d4-e5f6-7890-1234-567890abcdef",
+      "methodology_compliance": "PASSED",
+      "rules_executed": 18,
+      "report": "ipfs://QmVerificationHash/recycled-id-audit.json"
+    },
+    "mass_id": {
+      "external_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+      "token_id": "123",
+      "external_url": "https://explore.carrot.eco/document/6f520d88-864d-432d-bf9f-5c3166c4818f",
+      "uri": "ipfs://QmYx8FdKl2mN9pQ7rS6tV8wB3cE4fG5hI9jK0lM1nO2pQ3r/mass-id.json"
+    },
+    "waste_classification": {
+      "primary_type": "Organic",
+      "subtype": "Food, Food Waste and Beverages",
+      "net_weight_kg": 3000
+    },
+    "origin_location": {
+      "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+      "municipality": "Macapá",
+      "administrative_division": "Amapá",
+      "administrative_division_code": "BR-AP",
+      "country": "Brazil",
+      "country_code": "BR",
+      "coordinates": {
+        "latitude": -0.034934,
+        "longitude": -51.07045,
+        "precision_level": "city"
+      },
+      "facility_type": "Waste Generation",
+      "responsible_participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf"
+    },
+    "accredited_participants": [
+      {
+        "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+        "name": "Eco Reciclagem",
+        "role": "Recycler",
+        "accreditation_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+        "external_url": "https://explore.carrot.eco/document/acc-5021ea45-5b35-4749-8a85-83dc0c6f7cbf"
+      },
+      {
+        "participant_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+        "name": "Enlatados Produção",
+        "role": "Waste Generator",
+        "accreditation_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+        "external_url": "https://explore.carrot.eco/document/acc-6f520d88-864d-432d-bf9f-5c3166c4818f"
+      }
+    ],
+    "participant_rewards": {
+      "distribution_basis": "BOLD Recycling methodology rewards calculation",
+      "reward_allocations": [
+        {
+          "participant_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+          "participant_name": "Enlatados Produção",
+          "role": "Waste Generator",
+          "reward_percentage": 30.0,
+          "large_business_discount_applied": true,
+          "effective_percentage": 15.0
+        },
+        {
+          "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+          "participant_name": "Eco Reciclagem",
+          "role": "Hauler",
+          "reward_percentage": 20.0,
+          "effective_percentage": 20.0
+        },
+        {
+          "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+          "participant_name": "Eco Reciclagem",
+          "role": "Processor",
+          "reward_percentage": 20.0,
+          "effective_percentage": 20.0
+        },
+        {
+          "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+          "participant_name": "Eco Reciclagem",
+          "role": "Recycler",
+          "reward_percentage": 15.0,
+          "effective_percentage": 15.0
+        },
+        {
+          "participant_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+          "participant_name": "Carrot Foundation",
+          "role": "Network Integrator",
+          "reward_percentage": 15.0,
+          "effective_percentage": 15.0
+        }
+      ],
+      "distribution_notes": {
+        "large_business_discount_applied": "50% reduction applied to participants with >$4M annual revenue",
+        "redirected_rewards": "Discounted rewards from large businesses redirected to accredited NGOs"
+      }
+    }
+  }
+}

package/schemas/ipfs/recycled-id/recycled-id.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/recycled-id/recycled-id.schema.json",
+  "title": "RecycledID NFT IPFS Record",
+  "unevaluatedProperties": false,
+  "allOf": [
+    {
+      "$ref": "../shared/nft/nft.schema.json"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "properties": {
+            "type": {
+              "const": "RecycledID"
+            }
+          }
+        },
+        "attributes": {
+          "$ref": "./recycled-id.attributes.schema.json"
+        },
+        "data": {
+          "$ref": "./recycled-id.data.schema.json"
+        }
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/base/base.schema.json",
+  "title": "Carrot Base IPFS Record",
+  "description": "Base fields for all Carrot IPFS records, providing common structure for any JSON content stored in IPFS.",
+  "type": "object",
+  "required": [
+    "$schema",
+    "schema",
+    "created_at",
+    "external_id",
+    "external_url",
+    "content_hash",
+    "creator"
+  ],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "format": "uri",
+      "title": "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/mass-id/mass-id.schema.json"
+    },
+    "schema": {
+      "type": "object",
+      "description": "Schema information.",
+      "required": ["hash", "type", "version"],
+      "properties": {
+        "hash": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/keccak256_hash",
+          "title": "Schema Hash",
+          "description": "Keccak256 hash of the JSON Schema this record was validated against (32 bytes as hex string)."
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "MassID",
+            "MassID Audit",
+            "RecycledID",
+            "GasID",
+            "PurchaseID",
+            "Methodology",
+            "Credit",
+            "Collection"
+          ],
+          "title": "Schema Type",
+          "description": "Type/category of this schema.",
+          "example": "MassID"
+        },
+        "version": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/semantic_version",
+          "title": "Schema Version",
+          "description": "Version of the schema, using semantic versioning (https://semver.org/)."
+        }
+      },
+      "additionalProperties": false
+    },
+    "created_at": {
+      "$ref": "../definitions/definitions.schema.json#/$defs/iso_timestamp",
+      "title": "Record Creation Timestamp",
+      "description": "ISO 8601 creation timestamp for this record."
+    },
+    "external_id": {
+      "$ref": "../definitions/definitions.schema.json#/$defs/external_id"
+    },
+    "external_url": {
+      "$ref": "../definitions/definitions.schema.json#/$defs/external_url"
+    },
+    "content_hash": {
+      "type": "string",
+      "pattern": "^[a-fA-F0-9]{64}$",
+      "title": "Content Hash",
+      "description": "SHA-256 hash of RFC 8785 canonicalized JSON after schema validation."
+    },
+    "original_content_hash": {
+      "type": "string",
+      "pattern": "^[a-fA-F0-9]{64}$",
+      "title": "Original Content Hash",
+      "description": "SHA-256 hash of the original JSON content including private data before schema validation."
+    },
+    "creator": {
+      "type": "object",
+      "description": "Entity that created this record.",
+      "required": ["name", "id"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Company or individual name that created this record."
+        },
+        "id": {
+          "$ref": "../definitions/definitions.schema.json#/$defs/uuid",
+          "description": "Unique identifier for the creator."
+        }
+      },
+      "additionalProperties": false
+    },
+    "relationships": {
+      "type": "array",
+      "description": "References to other IPFS records this record relates to.",
+      "items": {
+        "type": "object",
+        "required": ["target_cid", "type"],
+        "properties": {
+          "target_cid": {
+            "type": "string",
+            "pattern": "^(Qm[1-9A-HJ-NP-Za-km-z]{44}|b[a-z2-7]{58,}|z[1-9A-HJ-NP-Za-km-z]+)$",
+            "description": "IPFS Content Identifier (CID) of the referenced record."
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "collection",
+              "credit",
+              "audit",
+              "update",
+              "derivation",
+              "reference"
+            ],
+            "description": "Type of relationship to the referenced record."
+          },
+          "description": {
+            "type": "string",
+            "description": "Human-readable description of the relationship."
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "environment": {
+      "type": "object",
+      "description": "Environment information.",
+      "required": ["blockchain_network", "deployment", "data_set_name"],
+      "properties": {
+        "blockchain_network": {
+          "type": "string",
+          "enum": ["mainnet", "testnet"],
+          "title": "Blockchain Network Environment",
+          "example": "mainnet"
+        },
+        "deployment": {
+          "type": "string",
+          "enum": ["production", "development", "testing"],
+          "title": "Deployment Environment",
+          "description": "System environment where this record was generated.",
+          "example": "production"
+        },
+        "data_set_name": {
+          "type": "string",
+          "enum": ["TEST", "PROD"],
+          "title": "Data Set Name",
+          "description": "Name of the data set for this record.",
+          "example": "TEST"
+        }
+      },
+      "additionalProperties": false
+    },
+    "data": {
+      "type": "object",
+      "description": "Custom data block that includes the record's data.",
+      "additionalProperties": true
+    }
+  }
+}