@carrot-foundation/schemas 0.1.36 → 0.1.37

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

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

@@ -1,63 +0,0 @@
-{
-  "$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/shared/base/base.schema.json

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

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

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