@carrot-foundation/schemas 0.1.6

package/schemas/ipfs/methodology/methodology.example.json

@@ -0,0 +1,222 @@
+{
+  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/methodology/methodology.schema.json",
+  "schema": {
+    "hash": "0x9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
+    "type": "Methodology",
+    "version": "v0.1.0"
+  },
+  "environment": {
+    "blockchain_network": "testnet",
+    "deployment": "production",
+    "data_set_name": "TEST"
+  },
+  "created_at": "2025-03-12T10:00:00.000Z",
+  "external_id": "3f8c2443-df76-4ce9-9d94-6c813d4c9ef7",
+  "external_url": "https://explore.carrot.eco/document/bold-carbon-ch4",
+  "content_hash": "9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
+  "creator": {
+    "name": "Carrot Foundation",
+    "id": "b9ea8219-4be9-4b8a-b8e6-9e21df5f99f4"
+  },
+  "data": {
+    "name": "BOLD Carbon (CH₄)",
+    "short_name": "BOLD Carbon",
+    "slug": "bold-carbon-ch4",
+    "version": "1.3.0",
+    "description": "Certifies methane emissions prevented through organic waste composting using UNFCCC AMS-III.F methodology. Tracks complete chain of custody from waste generation through professional composting to quantify CO₂e emissions reductions. This methodology provides a comprehensive framework for measuring, reporting, and verifying the environmental benefits of diverting organic waste from landfills to composting facilities.",
+    "revision_date": "2025-06-30",
+    "publication_date": "2025-03-12",
+    "methodology_pdf": "ipfs://QmMethodologyHash/bold-carbon-ch4-v1.3.0.pdf",
+    "mass_id_audit_rules": [
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000000",
+        "rule_slug": "waste-mass-unique",
+        "rule_name": "Waste Mass is Unique",
+        "description": "Validates that each MassID is unique within the system to prevent duplicate entries",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/waste-mass-unique.js",
+        "mandatory": true,
+        "execution_order": 1
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000001",
+        "rule_slug": "no-conflicts",
+        "rule_name": "No Conflicting GasID or Credit",
+        "description": "Verifies that the MassID has not been previously registered in other carbon certificates or carbon credits",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/no-conflicts.js",
+        "mandatory": true,
+        "execution_order": 2
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000002",
+        "rule_slug": "project-period",
+        "rule_name": "Project Period Limit",
+        "description": "Confirms that the MassID processing occurred within the valid project timeframe",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/project-period.js",
+        "mandatory": true,
+        "execution_order": 3
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000003",
+        "rule_slug": "accreditations",
+        "rule_name": "Participant Accreditations Requirements",
+        "description": "Checks if all participating entities have valid certifications and permissions",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/accreditations.js",
+        "mandatory": true,
+        "execution_order": 4
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000004",
+        "rule_slug": "mass-id-qualifications",
+        "rule_name": "MassID Qualifications",
+        "description": "Validates the proper categorization and definition of the organic waste mass",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/mass-id-qualifications.js",
+        "mandatory": true,
+        "execution_order": 5
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000005",
+        "rule_slug": "regional-classification",
+        "rule_name": "Regional Waste Classification",
+        "description": "Ensures the waste is properly classified according to local regulations and standards",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/regional-classification.js",
+        "mandatory": true,
+        "execution_order": 6
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000006",
+        "rule_slug": "geolocation-precision",
+        "rule_name": "Geolocation and Address Precision",
+        "description": "Verifies the accuracy of geographical coordinates for waste collection and processing locations",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/geolocation-precision.js",
+        "mandatory": true,
+        "execution_order": 7
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000007",
+        "rule_slug": "waste-origin",
+        "rule_name": "Waste Origin Identification",
+        "description": "Validates the documented source and origin point of the organic waste",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/waste-origin.js",
+        "mandatory": true,
+        "execution_order": 8
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000008",
+        "rule_slug": "hauler-identification",
+        "rule_name": "Hauler Identification",
+        "description": "Confirms the identity and credentials of the waste transportation company",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/hauler-identification.js",
+        "mandatory": true,
+        "execution_order": 9
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000009",
+        "rule_slug": "vehicle-identification",
+        "rule_name": "Vehicle Identification",
+        "description": "Verifies the registration and compliance of vehicles used in waste transportation",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/vehicle-identification.js",
+        "mandatory": true,
+        "execution_order": 10
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000010",
+        "rule_slug": "driver-identification",
+        "rule_name": "Driver Identification",
+        "description": "Validates the identity and proper licensing of the waste transport driver",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/driver-identification.js",
+        "mandatory": true,
+        "execution_order": 11
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000011",
+        "rule_slug": "transport-manifest",
+        "rule_name": "Transport Manifest Data",
+        "description": "Checks the completeness and accuracy of waste transportation documentation",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/transport-manifest.js",
+        "mandatory": true,
+        "execution_order": 12
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000012",
+        "rule_slug": "processor-identification",
+        "rule_name": "Processor Identification",
+        "description": "Validates the identity and certification of the waste processing facility",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/processor-identification.js",
+        "mandatory": true,
+        "execution_order": 13
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000013",
+        "rule_slug": "recycler-identification",
+        "rule_name": "Recycler Identification",
+        "description": "Confirms the identity and credentials of the recycling facility operator",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/recycler-identification.js",
+        "mandatory": true,
+        "execution_order": 14
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000014",
+        "rule_slug": "weighing",
+        "rule_name": "Weighing",
+        "description": "Verifies the accurate measurement and recording of waste MassID quantities",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/weighing.js",
+        "mandatory": true,
+        "execution_order": 15
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000015",
+        "rule_slug": "drop-off-recycler",
+        "rule_name": "Drop-off at Recycler",
+        "description": "Validates the proper reception and documentation of waste at the recycling facility",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/drop-off-recycler.js",
+        "mandatory": true,
+        "execution_order": 16
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000016",
+        "rule_slug": "mass-id-sorting",
+        "rule_name": "MassID Sorting",
+        "description": "Confirms the proper segregation and classification of organic waste materials",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/mass-id-sorting.js",
+        "mandatory": true,
+        "execution_order": 17
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000017",
+        "rule_slug": "composting-cycle",
+        "rule_name": "Composting Cycle Timeframe",
+        "description": "Validates that the composting process follows required duration and conditions",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/composting-cycle.js",
+        "mandatory": true,
+        "execution_order": 18
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000018",
+        "rule_slug": "recycling-manifest",
+        "rule_name": "Recycling Manifest Data",
+        "description": "Verifies the completion and accuracy of final recycling documentation and outcomes",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/recycling-manifest.js",
+        "mandatory": true,
+        "execution_order": 19
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000019",
+        "rule_slug": "project-boundary",
+        "rule_name": "Project Boundary",
+        "description": "Validate if the MassID is in accordance with the project boundary",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/project-boundary.js",
+        "mandatory": true,
+        "execution_order": 20
+      },
+      {
+        "rule_id": "12345678-1234-1234-1234-000000000020",
+        "rule_slug": "calculate-co2e",
+        "rule_name": "Prevented CO₂e",
+        "description": "Calculate the prevented CO₂e based on the Emission Factor and the MassID value",
+        "source_code_url": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/calculate-co2e.js",
+        "mandatory": true,
+        "execution_order": 21
+      }
+    ]
+  }
+}

package/schemas/ipfs/methodology/methodology.schema.json

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

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

@@ -0,0 +1,91 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/purchase-id/purchase-id.attributes.schema.json",
+  "$defs": {
+    "attribute_credit": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/token_symbol",
+          "description": "Symbol of the credit token (e.g., C-CARB, C-BIOW)",
+          "example": "C-CARB"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "description": "Amount of credits purchased",
+          "example": 2.5
+        },
+        "display_type": {
+          "const": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_buyer": {
+      "type": "object",
+      "required": ["trait_type", "value"],
+      "properties": {
+        "trait_type": {
+          "const": "Buyer"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/participant_name",
+          "description": "Organization or individual that purchased the credits",
+          "example": "EcoTech Solutions Inc."
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_purchase_date": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "const": "Purchase Date"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/iso_date",
+          "description": "Date when the purchase was completed",
+          "example": "2025-01-15"
+        },
+        "display_type": {
+          "const": "date"
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute_collection": {
+      "type": "object",
+      "required": ["trait_type", "value", "display_type"],
+      "properties": {
+        "trait_type": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "description": "Name of the collection",
+          "example": "BOLD Cold Start - Carazinho"
+        },
+        "value": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "description": "Amount of credits from the collection",
+          "example": 4.0
+        },
+        "display_type": {
+          "const": "number"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "title": "PurchaseID NFT Attribute Array",
+  "description": "Schema for the fixed set of PurchaseID NFT attributes, enforcing order and type for each trait.",
+  "type": "array",
+  "items": {
+    "anyOf": [
+      { "$ref": "#/$defs/attribute_credit" },
+      { "$ref": "#/$defs/attribute_buyer" },
+      { "$ref": "#/$defs/attribute_purchase_date" },
+      { "$ref": "#/$defs/attribute_collection" }
+    ]
+  },
+  "minItems": 4
+}