@carrot-foundation/schemas 0.1.6

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

@@ -0,0 +1,337 @@
+{
+  "$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.data.schema.json",
+  "title": "PurchaseID Data",
+  "type": "object",
+  "required": [
+    "summary",
+    "buyer",
+    "collections",
+    "credits",
+    "items",
+    "participant_rewards"
+  ],
+  "properties": {
+    "summary": {
+      "type": "object",
+      "required": [
+        "total_usdc_amount",
+        "total_certificates",
+        "total_credits",
+        "purchase_date",
+        "credit_symbols",
+        "certificate_types"
+      ],
+      "properties": {
+        "total_usdc_amount": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "title": "Total USDC Amount",
+          "description": "Total amount paid in USDC for the purchase"
+        },
+        "total_certificates": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/positive_integer",
+          "title": "Total Certificates",
+          "description": "Total number of certificates purchased"
+        },
+        "total_credits": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+          "title": "Total Credits",
+          "description": "Total amount of credits purchased"
+        },
+        "purchase_date": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/iso_date",
+          "title": "Purchase Date",
+          "description": "Date when the purchase was made"
+        },
+        "credit_symbols": {
+          "type": "array",
+          "title": "Credit Symbols",
+          "description": "Array of credit token symbols included in the purchase",
+          "items": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/token_symbol"
+          },
+          "minItems": 1
+        },
+        "certificate_types": {
+          "type": "array",
+          "title": "Certificate Types",
+          "description": "Array of certificate types included in the purchase",
+          "items": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string"
+          },
+          "minItems": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "buyer": {
+      "type": "object",
+      "required": ["wallet_address"],
+      "properties": {
+        "wallet_address": {
+          "$ref": "../shared/definitions/definitions.schema.json#/$defs/ethereum_address",
+          "title": "Buyer Wallet Address",
+          "description": "Ethereum address of the buyer"
+        },
+        "identity": {
+          "type": "object",
+          "required": ["name", "external_id", "external_url"],
+          "properties": {
+            "name": {
+              "$ref": "../shared/definitions/definitions.schema.json#/$defs/participant_name",
+              "title": "Buyer Name",
+              "description": "Legal name of the buyer organization"
+            },
+            "external_id": {
+              "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_id",
+              "title": "Buyer External ID",
+              "description": "External identifier for the buyer"
+            },
+            "external_url": {
+              "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_url",
+              "title": "Buyer External URL",
+              "description": "External URL for the buyer profile"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "collections": {
+      "type": "array",
+      "title": "Collections",
+      "description": "Array of collections included in the purchase",
+      "items": {
+        "type": "object",
+        "required": ["slug", "external_id", "name", "external_url", "uri"],
+        "properties": {
+          "slug": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
+            "title": "Collection Slug",
+            "description": "URL-friendly identifier for the collection"
+          },
+          "external_id": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_id",
+            "title": "Collection External ID",
+            "description": "External identifier for the collection"
+          },
+          "name": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/name",
+            "title": "Collection Name",
+            "description": "Display name of the collection"
+          },
+          "external_url": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_url",
+            "title": "Collection External URL",
+            "description": "External URL for the collection"
+          },
+          "uri": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/ipfs_uri",
+            "title": "Collection URI",
+            "description": "IPFS URI for the collection metadata"
+          }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 1
+    },
+    "credits": {
+      "type": "array",
+      "title": "Credits",
+      "description": "Array of credits included in the purchase",
+      "items": {
+        "type": "object",
+        "required": [
+          "slug",
+          "symbol",
+          "external_id",
+          "external_url",
+          "uri",
+          "smart_contract"
+        ],
+        "properties": {
+          "slug": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
+            "title": "Credit Slug",
+            "description": "URL-friendly identifier for the credit"
+          },
+          "symbol": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/token_symbol",
+            "title": "Credit Token Symbol",
+            "description": "Symbol of the credit token (e.g., C-CARB, C-BIOW)"
+          },
+          "external_id": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_id",
+            "title": "Credit External ID",
+            "description": "External identifier for the credit"
+          },
+          "external_url": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_url",
+            "title": "Credit External URL",
+            "description": "External URL for the credit"
+          },
+          "uri": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/ipfs_uri",
+            "title": "Credit URI",
+            "description": "IPFS URI for the credit details"
+          },
+          "smart_contract": {
+            "type": "object",
+            "required": ["address", "chain_id", "network_name"],
+            "properties": {
+              "address": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/ethereum_address",
+                "title": "Smart Contract Address",
+                "description": "Address of the credit smart contract"
+              },
+              "chain_id": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/chain_id",
+                "title": "Chain ID",
+                "description": "Blockchain network chain ID"
+              },
+              "network_name": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+                "title": "Blockchain Network Name",
+                "description": "Name of the blockchain network"
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 1
+    },
+    "items": {
+      "type": "array",
+      "title": "Purchase Items",
+      "description": "Array of individual items purchased",
+      "items": {
+        "type": "object",
+        "required": [
+          "certificate",
+          "collection_slug",
+          "credit_slug",
+          "credit_amount",
+          "usdc_amount"
+        ],
+        "properties": {
+          "certificate": {
+            "type": "object",
+            "required": [
+              "token_id",
+              "type",
+              "external_id",
+              "external_url",
+              "uri",
+              "mass_id"
+            ],
+            "properties": {
+              "token_id": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/token_id",
+                "title": "Certificate Token ID",
+                "description": "Token ID of the certificate"
+              },
+              "type": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_empty_string",
+                "title": "Certificate Type",
+                "description": "Type of certificate (e.g., GasID, RecycledID)"
+              },
+              "external_id": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_id",
+                "title": "Certificate External ID",
+                "description": "External identifier for the certificate"
+              },
+              "external_url": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/external_url",
+                "title": "Certificate External URL",
+                "description": "External URL for the certificate"
+              },
+              "uri": {
+                "$ref": "../shared/definitions/definitions.schema.json#/$defs/ipfs_uri",
+                "title": "Certificate URI",
+                "description": "IPFS URI for the certificate metadata"
+              },
+              "mass_id": {
+                "$ref": "../shared/references/mass-id-reference/mass-id-reference.schema.json"
+              }
+            },
+            "additionalProperties": false
+          },
+          "collection_slug": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
+            "title": "Collection Slug",
+            "description": "Slug of the collection this item belongs to"
+          },
+          "credit_slug": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/slug",
+            "title": "Credit Slug",
+            "description": "Slug of the credit type for this item"
+          },
+          "credit_amount": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+            "title": "Credit Amount",
+            "description": "Amount of credits for this item"
+          },
+          "usdc_amount": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+            "title": "USDC Amount",
+            "description": "USDC amount paid for this item"
+          }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 1
+    },
+    "participant_rewards": {
+      "type": "array",
+      "title": "Participant Rewards",
+      "description": "Array of rewards distributed to participants in the supply chain",
+      "items": {
+        "type": "object",
+        "required": [
+          "participant_id",
+          "participant_name",
+          "roles",
+          "percentage",
+          "usdc_amount"
+        ],
+        "properties": {
+          "participant_id": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/uuid",
+            "title": "Participant ID",
+            "description": "Unique identifier for the participant"
+          },
+          "participant_name": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/participant_name",
+            "title": "Participant Name",
+            "description": "Legal name of the participant"
+          },
+          "roles": {
+            "type": "array",
+            "title": "Participant Roles",
+            "description": "Array of roles the participant has in the supply chain",
+            "items": {
+              "$ref": "../shared/definitions/definitions.schema.json#/$defs/participant_role"
+            },
+            "minItems": 1
+          },
+          "percentage": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/percentage",
+            "title": "Reward Percentage",
+            "description": "Percentage of the total purchase amount allocated to this participant"
+          },
+          "usdc_amount": {
+            "$ref": "../shared/definitions/definitions.schema.json#/$defs/non_negative_float",
+            "title": "USDC Reward Amount",
+            "description": "USDC amount allocated to this participant"
+          }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 1
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/ipfs/purchase-id/purchase-id.example.json

@@ -0,0 +1,224 @@
+{
+  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/purchase-id/purchase-id.schema.json",
+  "schema": {
+    "hash": "0x9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
+    "type": "PurchaseID",
+    "version": "v0.1.0"
+  },
+  "environment": {
+    "blockchain_network": "mainnet",
+    "deployment": "production",
+    "data_set_name": "TEST"
+  },
+  "blockchain": {
+    "smart_contract_address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
+    "chain_id": 137,
+    "network_name": "Polygon",
+    "token_id": "789"
+  },
+  "created_at": "2025-01-15T10:30:45.000Z",
+  "external_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
+  "external_url": "https://explore.carrot.eco/document/a1b2c3d4-e5f6-7890-1234-567890abcdef",
+  "content_hash": "9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
+  "creator": {
+    "name": "Carrot Foundation",
+    "id": "7f051e36-490c-420d-a59d-3bf73cc338af"
+  },
+  "name": "PurchaseID #789 • 5.5 Credits",
+  "short_name": "PurchaseID #789",
+  "description": "Purchase receipt for 5.5 credits across C-CARB and C-BIOW tokens from 2 collections, with rewards distributed to 4 accredited participants in the waste management supply chain.",
+  "image": "ipfs://QmPurchaseIdHash789/purchase-receipt.png",
+  "background_color": "#2D5016",
+  "external_links": [
+    {
+      "label": "View on Carrot Explorer",
+      "url": "https://explore.carrot.eco/document/a1b2c3d4-e5f6-7890-1234-567890abcdef",
+      "description": "Complete purchase details and audit trail"
+    },
+    {
+      "label": "Carrot Marketplace",
+      "url": "https://marketplace.carrot.eco/purchase/a1b2c3d4-e5f6-7890-1234-567890abcdef",
+      "description": "Original purchase transaction details"
+    }
+  ],
+  "attributes": [
+    {
+      "trait_type": "C-CARB",
+      "value": 2.5,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "C-BIOW",
+      "value": 3.0,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "Buyer",
+      "value": "EcoTech Solutions Inc."
+    },
+    {
+      "trait_type": "Purchase Date",
+      "value": "2025-01-15",
+      "display_type": "date"
+    },
+    {
+      "trait_type": "BOLD Cold Start - Carazinho",
+      "value": 4,
+      "display_type": "number"
+    },
+    {
+      "trait_type": "BOLD Brazil",
+      "value": 1.5,
+      "display_type": "number"
+    }
+  ],
+  "data": {
+    "summary": {
+      "total_usdc_amount": 1250.0,
+      "total_certificates": 3,
+      "total_credits": 5.5,
+      "purchase_date": "2025-01-15",
+      "credit_symbols": ["C-CARB", "C-BIOW"],
+      "certificate_types": ["GasID", "RecycledID"]
+    },
+    "buyer": {
+      "wallet_address": "0x1234567890abcdef1234567890abcdef12345678",
+      "identity": {
+        "name": "EcoTech Solutions Inc.",
+        "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
+        "external_url": "https://explore.carrot.eco/participant/buyer-corp-12345"
+      }
+    },
+    "collections": [
+      {
+        "slug": "bold-cold-start-carazinho",
+        "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
+        "name": "BOLD Cold Start - Carazinho",
+        "external_url": "https://explore.carrot.eco/collection/bold-cold-start-carazinho",
+        "uri": "ipfs://QmCollectionImageHash/bold-cold-start-carazinho.json"
+      },
+      {
+        "slug": "bold-brazil",
+        "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+        "name": "BOLD Brazil",
+        "external_url": "https://explore.carrot.eco/collection/bold-professional-series",
+        "uri": "ipfs://QmCollectionProfHash/bold-professional-series.json"
+      }
+    ],
+    "credits": [
+      {
+        "slug": "carbon",
+        "symbol": "C-CARB",
+        "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
+        "external_url": "https://explore.carrot.eco/credit/8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
+        "uri": "ipfs://QmCreditHash/c-carb.json",
+        "smart_contract": {
+          "address": "0xabcdef1234567890abcdef1234567890abcdef12",
+          "chain_id": 137,
+          "network_name": "Polygon"
+        }
+      },
+      {
+        "slug": "organic",
+        "symbol": "C-BIOW",
+        "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+        "external_url": "https://explore.carrot.eco/credit/9f3c4556-fg90-5ef8-9e06-8d925e6d9bg0",
+        "uri": "ipfs://QmCreditBiowHash/c-biow.json",
+        "smart_contract": {
+          "address": "0xfedcba0987654321fedcba0987654321fedcba09",
+          "chain_id": 137,
+          "network_name": "Polygon"
+        }
+      }
+    ],
+    "items": [
+      {
+        "certificate": {
+          "token_id": "456",
+          "type": "GasID",
+          "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+          "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d479",
+          "uri": "ipfs://QmGasIdHash456/gas-id.json",
+          "mass_id": {
+            "token_id": "123",
+            "external_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+            "external_url": "https://explore.carrot.eco/document/6f520d88-864d-432d-bf9f-5c3166c4818f",
+            "uri": "ipfs://QmYx8FdKl2mN9pQ7rS6tV8wB3cE4fG5hI9jK0lM1nO2pQ3r/mass-id.json"
+          }
+        },
+        "collection_slug": "bold-cold-start-carazinho",
+        "credit_slug": "carbon",
+        "credit_amount": 2.5,
+        "usdc_amount": 500.0
+      },
+      {
+        "certificate": {
+          "token_id": "789",
+          "type": "RecycledID",
+          "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+          "external_url": "https://explore.carrot.eco/document/r47ac10b-58cc-4372-a567-0e02b2c3d999",
+          "uri": "ipfs://QmRecycledIdHash789/recycled-id.json",
+          "mass_id": {
+            "token_id": "124",
+            "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+            "external_url": "https://explore.carrot.eco/document/7f520d88-864d-432d-bf9f-5c3166c4888f",
+            "uri": "ipfs://QmMassIdHash124/mass-id.json"
+          }
+        },
+        "collection_slug": "bold-cold-start-carazinho",
+        "credit_slug": "carbon",
+        "credit_amount": 1.5,
+        "usdc_amount": 300.0
+      },
+      {
+        "certificate": {
+          "token_id": "789",
+          "type": "RecycledID",
+          "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+          "external_url": "https://explore.carrot.eco/document/r47ac10b-58cc-4372-a567-0e02b2c3d999",
+          "uri": "ipfs://QmRecycledIdHash789/recycled-id.json",
+          "mass_id": {
+            "token_id": "124",
+            "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+            "external_url": "https://explore.carrot.eco/document/7f520d88-864d-432d-bf9f-5c3166c4888f",
+            "uri": "ipfs://QmMassIdHash124/mass-id.json"
+          }
+        },
+        "collection_slug": "bold-brazil",
+        "credit_slug": "organic",
+        "credit_amount": 1.5,
+        "usdc_amount": 450.0
+      }
+    ],
+    "participant_rewards": [
+      {
+        "participant_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
+        "participant_name": "Enlatados Produção",
+        "roles": ["Waste Generator"],
+        "percentage": 12.5,
+        "usdc_amount": 156.25
+      },
+      {
+        "participant_id": "5021ea45-5b35-4749-8a85-83dc0c6f7cbf",
+        "participant_name": "Eco Reciclagem",
+        "roles": ["Hauler", "Processor", "Recycler"],
+        "percentage": 60.0,
+        "usdc_amount": 750.0
+      },
+      {
+        "participant_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+        "participant_name": "Carrot Foundation",
+        "roles": ["Network Integrator"],
+        "percentage": 15.0,
+        "usdc_amount": 187.5
+      },
+      {
+        "participant_id": "e710790f-5909-4a54-ab89-6a59819472ee",
+        "participant_name": "Carrot Marketplace",
+        "roles": ["Platform"],
+        "percentage": 12.5,
+        "usdc_amount": 156.25
+      }
+    ]
+  }
+}

package/schemas/ipfs/purchase-id/purchase-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/purchase-id/purchase-id.schema.json",
+  "title": "PurchaseID NFT IPFS Record",
+  "unevaluatedProperties": false,
+  "allOf": [
+    {
+      "$ref": "../shared/nft/nft.schema.json"
+    },
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "properties": {
+            "type": {
+              "const": "PurchaseID"
+            }
+          }
+        },
+        "attributes": {
+          "$ref": "./purchase-id.attributes.schema.json"
+        },
+        "data": {
+          "$ref": "./purchase-id.data.schema.json"
+        }
+      }
+    }
+  ]
+}