@carrot-foundation/schemas 0.1.6

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

@@ -0,0 +1,120 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/gas-id/gas-id.data.schema.json",
+  "title": "GasID Data",
+  "type": "object",
+  "required": [
+    "summary",
+    "methodology",
+    "audit",
+    "mass_id",
+    "waste_classification",
+    "origin_location",
+    "prevented_emissions_calculation",
+    "accredited_participants"
+  ],
+  "properties": {
+    "summary": {
+      "type": "object",
+      "required": [
+        "gas_type",
+        "credit_type",
+        "credit_amount",
+        "prevented_co2e_kg"
+      ],
+      "properties": {
+        "gas_type": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "title": "Gas Type",
+          "description": "Type of gas prevented"
+        },
+        "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"
+        },
+        "prevented_co2e_kg": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/weight_kg",
+          "title": "Prevented Emissions (CO₂e kg)",
+          "description": "CO₂e weight of the prevented emissions"
+        }
+      },
+      "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"
+    },
+    "prevented_emissions_calculation": {
+      "type": "object",
+      "required": ["formula", "method", "date", "values"],
+      "properties": {
+        "formula": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "title": "Calculation Formula",
+          "description": "Formula used to calculate the prevented emissions",
+          "maxLength": 100
+        },
+        "method": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+          "title": "Calculation Method",
+          "description": "Method used to calculate the prevented emissions",
+          "maxLength": 100
+        },
+        "date": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/iso_date",
+          "title": "Calculation Date",
+          "description": "Date when the calculation was performed"
+        },
+        "values": {
+          "type": "array",
+          "title": "Calculation Values",
+          "description": "Values used to calculate the prevented emissions",
+          "items": {
+            "type": "object",
+            "required": ["reference", "value", "label"],
+            "properties": {
+              "reference": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+                "maxLength": 3
+              },
+              "value": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float"
+              },
+              "label": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+                "maxLength": 100
+              }
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "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/gas-id/gas-id.example.json

@@ -0,0 +1,245 @@
+{
+  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/gas-id/gas-id.schema.json",
+  "schema": {
+    "hash": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
+    "type": "GasID",
+    "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": "456"
+  },
+  "created_at": "2025-06-24T13:02:25.000Z",
+  "external_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+  "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d479",
+  "content_hash": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
+  "creator": {
+    "name": "Carrot Foundation",
+    "id": "1f060fa2-7b80-462f-888d-253a79912717"
+  },
+  "name": "GasID #456 • BOLD Carbon (CH₄) • 2.09t CO₂e",
+  "short_name": "GasID #456",
+  "description": "This GasID certifies 2.09 metric tons of CO₂e emissions prevented through BOLD Carbon (CH₄) methodology composting of 3 metric tons of organic waste from Macapá, Brazil.",
+  "image": "ipfs://QmGasIdHash456/gas-id-bold-carbon.png",
+  "background_color": "#1B4332",
+  "external_links": [
+    {
+      "label": "View on Carrot Explorer",
+      "url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d479",
+      "description": "Complete GasID 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 Carbon (CH₄) Methodology",
+      "url": "https://explore.carrot.eco/document/bold-carbon-ch4",
+      "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 Carbon (CH₄)"
+    },
+    {
+      "trait_type": "Gas Type",
+      "value": "Methane (CH₄)"
+    },
+    {
+      "trait_type": "CO₂e Prevented (kg)",
+      "value": 2089.74,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Credit Amount",
+      "value": 2.08974,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Credit Type",
+      "value": "Carrot Carbon"
+    },
+    {
+      "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": {
+      "gas_type": "Methane (CH₄)",
+      "credit_type": "Carrot Carbon (C-CARB)",
+      "credit_amount": 0.85615,
+      "prevented_co2e_kg": 856.15012
+    },
+    "methodology": {
+      "external_id": "f47ac10b-58cc-4372-a567-0e02b2c3d480",
+      "name": "BOLD Carbon (CH₄)",
+      "version": "1.3.0",
+      "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d480",
+      "uri": "ipfs://QmMethodologyHash/bold-carbon-ch4-v1.3.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": 21,
+      "report": "ipfs://QmVerificationHash/mass-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"
+    },
+    "prevented_emissions_calculation": {
+      "formula": "(1 - B) * W * E = R",
+      "method": "UNFCCC AMS-III.F",
+      "date": "2025-06-24",
+      "values": [
+        {
+          "reference": "E",
+          "value": 0.029,
+          "label": "Exceeding Emission Coefficient"
+        },
+        {
+          "reference": "B",
+          "value": 0.067,
+          "label": "Prevented Emissions by Waste Subtype and Baseline Per Ton"
+        },
+        {
+          "reference": "W",
+          "value": 13160,
+          "label": "Waste Weight"
+        },
+        {
+          "reference": "R",
+          "value": 856.15012,
+          "label": "Prevented Emissions (CO₂e kg)"
+        }
+      ]
+    },
+    "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 Carbon (CH₄) methodology rewards calculation",
+      "reward_allocations": [
+        {
+          "participant_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+          "participant_name": "Enlatados Produção",
+          "role": "Waste Generator",
+          "reward_percentage": 25.0,
+          "large_business_discount_applied": true,
+          "effective_percentage": 12.5
+        },
+        {
+          "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": 15.0,
+          "effective_percentage": 15.0
+        },
+        {
+          "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+          "participant_name": "Eco Reciclagem",
+          "role": "Recycler",
+          "reward_percentage": 25.0,
+          "effective_percentage": 25.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/gas-id/gas-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/gas-id/gas-id.schema.json",
+  "title": "GasID NFT IPFS Record",
+  "unevaluatedProperties": false,
+  "allOf": [
+    {
+      "$ref": "../shared/nft/nft.schema.json"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "properties": {
+            "type": {
+              "const": "GasID"
+            }
+          }
+        },
+        "attributes": {
+          "$ref": "./gas-id.attributes.schema.json"
+        },
+        "data": {
+          "$ref": "./gas-id.data.schema.json"
+        }
+      }
+    }
+  ]
+}