@carrot-foundation/schemas 0.1.36 → 0.1.37

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

@@ -1,219 +0,0 @@
-{
-  "$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.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 carbon methodology used for certification",
-          "example": "BOLD Carbon (CH₄)"
-        }
-      },
-      "additionalProperties": false
-    },
-    "attribute_gas_type": {
-      "type": "object",
-      "required": ["trait_type", "value"],
-      "properties": {
-        "trait_type": {
-          "const": "Gas Type"
-        },
-        "value": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-          "maxLength": 100,
-          "description": "Type of gas emitted",
-          "example": "Methane (CH₄)"
-        }
-      },
-      "additionalProperties": false
-    },
-    "attribute_co2e_prevented": {
-      "type": "object",
-      "required": ["trait_type", "value", "display_type"],
-      "properties": {
-        "trait_type": {
-          "const": "CO₂e Prevented (kg)"
-        },
-        "value": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
-          "description": "Total CO₂ equivalent emissions prevented 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 Carbon"
-        }
-      },
-      "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": "GasID NFT Attribute Array",
-  "description": "Schema for the fixed set of GasID NFT attributes, enforcing order and type for each trait.",
-  "type": "array",
-  "prefixItems": [
-    { "$ref": "#/$defs/attribute_methodology" },
-    { "$ref": "#/$defs/attribute_gas_type" },
-    { "$ref": "#/$defs/attribute_co2e_prevented" },
-    { "$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": 12,
-  "maxItems": 12
-}

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

@@ -1,120 +0,0 @@
-{
-  "$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/mass-id-audit/mass-id-audit.data.schema.json

@@ -1,130 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/mass-id-audit/mass-id-audit.data.schema.json",
-  "title": "MassID Audit Data",
-  "type": "object",
-  "required": [
-    "methodology",
-    "mass_id",
-    "gas_id",
-    "audit_summary",
-    "rules_execution_results"
-  ],
-  "properties": {
-    "methodology": {
-      "$ref": "../shared/references/methodology-reference/methodology-reference.schema.json"
-    },
-    "mass_id": {
-      "$ref": "../shared/references/mass-id-reference/mass-id-reference.schema.json"
-    },
-    "gas_id": {
-      "$ref": "../shared/references/gas-id-reference/gas-id-reference.schema.json"
-    },
-    "audit_summary": {
-      "type": "object",
-      "title": "Audit Summary",
-      "required": [
-        "audit_date",
-        "methodology_compliance",
-        "total_rules_executed",
-        "passed_rules",
-        "failed_rules"
-      ],
-      "properties": {
-        "audit_date": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/iso_date",
-          "title": "Audit Date",
-          "description": "Date when the audit was completed"
-        },
-        "methodology_compliance": {
-          "type": "string",
-          "enum": ["PASSED", "FAILED"],
-          "title": "Methodology Compliance",
-          "description": "Overall outcome of the audit process"
-        },
-        "total_rules_executed": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_integer",
-          "title": "Total Rules Executed",
-          "description": "Total number of audit rules executed"
-        },
-        "passed_rules": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_integer",
-          "title": "Passed Rules Count",
-          "description": "Number of rules that passed verification"
-        },
-        "failed_rules": {
-          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_integer",
-          "title": "Failed Rules Count",
-          "description": "Number of rules that failed verification"
-        }
-      },
-      "additionalProperties": false
-    },
-    "rules_execution_results": {
-      "type": "array",
-      "title": "Rules Execution Results",
-      "description": "Detailed results of each audit rule execution.",
-      "items": {
-        "type": "object",
-        "required": [
-          "rule_name",
-          "rule_id",
-          "rule_slug",
-          "execution_order",
-          "result",
-          "description",
-          "rule_processor_checksum",
-          "rule_source_code_version"
-        ],
-        "properties": {
-          "rule_name": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-            "title": "Rule Name",
-            "description": "Human-readable name of the audit rule."
-          },
-          "rule_id": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/uuid",
-            "title": "Rule ID",
-            "description": "Unique identifier for the rule."
-          },
-          "rule_slug": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
-            "title": "Rule Slug"
-          },
-          "execution_order": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/positive_integer",
-            "title": "Rule Execution Order",
-            "description": "Sequential order in which this rule was executed."
-          },
-          "result": {
-            "type": "string",
-            "enum": ["PASSED", "FAILED"],
-            "title": "Rule Execution Result",
-            "description": "Result of this specific rule execution."
-          },
-          "description": {
-            "type": "string",
-            "minLength": 1,
-            "maxLength": 2000,
-            "title": "Rule Description",
-            "description": "Detailed description of what this rule validates."
-          },
-          "rule_processor_checksum": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-            "maxLength": 200,
-            "title": "Rule Processor Checksum",
-            "description": "Checksum for rule processor integrity verification."
-          },
-          "rule_source_code_version": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-            "maxLength": 200,
-            "title": "Rule Source Code Version",
-            "description": "Version identifier for the rule source code."
-          }
-        },
-        "additionalProperties": false
-      }
-    }
-  },
-  "additionalProperties": false
-}

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

@@ -1,121 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/methodology/methodology.data.schema.json",
-  "title": "Methodology Data",
-  "type": "object",
-  "required": [
-    "name",
-    "short_name",
-    "slug",
-    "version",
-    "description",
-    "revision_date",
-    "publication_date",
-    "methodology_pdf",
-    "mass_id_audit_rules"
-  ],
-  "properties": {
-    "name": {
-      "$ref": "../shared/definitions/definitions.schema.json#/$defs/name",
-      "title": "Methodology Name",
-      "description": "Full official name of the methodology.",
-      "example": "BOLD Carbon (CH₄)"
-    },
-    "short_name": {
-      "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-      "maxLength": 50,
-      "title": "Methodology Short Name",
-      "description": "Abbreviated name for UI display and references.",
-      "example": "BOLD Carbon"
-    },
-    "slug": {
-      "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
-      "title": "Methodology Slug"
-    },
-    "version": {
-      "$ref": "../shared/definitions/definitions.schema.json#/$defs/semantic_version",
-      "title": "Methodology Version"
-    },
-    "description": {
-      "type": "string",
-      "minLength": 50,
-      "maxLength": 2000,
-      "description": "Comprehensive methodology description including purpose, scope, and implementation approach.",
-      "example": "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."
-    },
-    "revision_date": {
-      "$ref": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/definitions/definitions.schema.json#/$defs/iso_date",
-      "description": "ISO 8601 date of the last revision to this methodology."
-    },
-    "publication_date": {
-      "$ref": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/definitions/definitions.schema.json#/$defs/iso_date",
-      "description": "ISO 8601 date of the original publication of this methodology."
-    },
-    "methodology_pdf": {
-      "$ref": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/shared/definitions/definitions.schema.json#/$defs/ipfs_uri",
-      "description": "IPFS URI pointing to the complete methodology PDF document."
-    },
-    "mass_id_audit_rules": {
-      "type": "array",
-      "minItems": 1,
-      "title": "MassID Audit Rules",
-      "description": "Array of audit rules that must be executed to check MassID compliance with the methodology.",
-      "items": {
-        "type": "object",
-        "required": [
-          "rule_id",
-          "rule_slug",
-          "rule_name",
-          "description",
-          "source_code_url",
-          "mandatory",
-          "execution_order"
-        ],
-        "properties": {
-          "rule_id": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/uuid",
-            "title": "Rule ID"
-          },
-          "rule_slug": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
-            "title": "Rule Slug"
-          },
-          "rule_name": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
-            "maxLength": 100,
-            "title": "Rule Name",
-            "description": "Human-readable name of the rule.",
-            "example": "Waste Mass is Unique"
-          },
-          "description": {
-            "type": "string",
-            "minLength": 10,
-            "maxLength": 500,
-            "title": "Rule Description",
-            "description": "Detailed description of what the rule validates and why it's necessary.",
-            "example": "Validates that each MassID is unique within the system to prevent duplicate entries"
-          },
-          "source_code_url": {
-            "type": "string",
-            "format": "uri",
-            "pattern": "^https://github\\.com/.*$",
-            "title": "Rule Source Code URL",
-            "description": "GitHub URL pointing to the implementation source code for this rule.",
-            "example": "https://github.com/carrot-foundation/methodologies/blob/main/bold-carbon/rules/waste-mass-unique.js"
-          },
-          "mandatory": {
-            "type": "boolean",
-            "description": "Whether this rule is mandatory for methodology compliance.",
-            "example": true
-          },
-          "execution_order": {
-            "$ref": "../shared/definitions/definitions.schema.json#/$defs/positive_integer",
-            "title": "Rule Execution Order"
-          }
-        },
-        "additionalProperties": false
-      }
-    }
-  },
-  "additionalProperties": false
-}