@carrot-foundation/ipfs-schemas
v0.1.6
Published
JSON Schema definitions and Zod validation schemas for Carrot IPFS records
Downloads
20
Readme
🥕 Carrot IPFS Schemas
This repository contains all JSON Schemas used across the Carrot ecosystem.
These schemas define the structure of IPFS metadata for tokenized assets. They are versioned, publicly referenceable, and used for validation, traceability, and frontend/backend integration.
📦 Structure
- Schemas are organized by type (e.g.,
mass-id,gas-id,shared) and follow Semantic Versioning, but folder names are not versioned. - Each schema lives in its own folder and includes an
example.jsonfor testing and documentation. - Shared components like
signature,attribute, and therootschema are located inschemas/ipfs/shared.
🔖 Versioning
- Schemas are versioned using Git tags (
vX.Y.Z); directory names are not versioned. - For released versions, each schema’s
$idmust point to the tagged raw URL to remain immutable. - During development on
main,$idmay referencerefs/heads/main, but consumers should pin to tags in production. - Keep
$refpaths relative; they resolve against the$idbase (the tag) at validation time.
Example $id pinned to a tag:
"$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/v0.1.0/schemas/ipfs/collection/collection.schema.json"✅ Usage
You may:
- Reference any schema via its
$id(e.g. in IPFS metadata) - Validate metadata files using these schemas
- Link to them from applications, dashboards, or traceability tools
You may not:
- Redistribute, rebrand, or fork these schemas for other ecosystems
- Create derivative schemas that use Carrot's identity
See NOTICE for full usage guidance.
🔐 License
Licensed under the Apache License 2.0. See NOTICE for additional terms and usage intentions.
