@carrot-foundation/schemas 0.1.39 → 0.1.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrot-foundation/schemas",
-  "version": "0.1.39",
+  "version": "0.1.40",
   "description": "Carrot schema definitions and zod validation schemas",
   "license": "Apache-2.0",
   "private": false,

package/schemas/ipfs/collection/collection.schema.json

@@ -2,8 +2,8 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Collection IPFS Record",
   "description": "Collection metadata stored in IPFS, extending the base schema with collection-specific fields required for NFT collection definitions in Carrot's ecosystem",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.39/schemas/ipfs/collection/collection.schema.json",
-  "version": "0.1.39",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.40/schemas/ipfs/collection/collection.schema.json",
+  "version": "0.1.40",
   "type": "object",
   "properties": {
     "$schema": {

package/schemas/ipfs/credit/credit.schema.json

@@ -2,8 +2,8 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Credit IPFS Record",
   "description": "Credit token metadata stored in IPFS, extending the base schema with ERC20-specific details",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.39/schemas/ipfs/credit/credit.schema.json",
-  "version": "0.1.39",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.40/schemas/ipfs/credit/credit.schema.json",
+  "version": "0.1.40",
   "type": "object",
   "properties": {
     "$schema": {

package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json

@@ -2,8 +2,8 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "CreditPurchaseReceipt NFT IPFS Record",
   "description": "Complete CreditPurchaseReceipt NFT IPFS record including attributes and credit purchase data",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.39/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
-  "version": "0.1.39",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.40/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
+  "version": "0.1.40",
   "type": "object",
   "properties": {
     "$schema": {
@@ -700,9 +700,8 @@
                     "title": "Chain ID",
                     "description": "Blockchain network identifier",
                     "examples": [
-                      1,
                       137,
-                      11155111
+                      80002
                     ],
                     "type": "integer",
                     "minimum": 1,
@@ -713,8 +712,7 @@
                     "description": "Name of the blockchain network",
                     "examples": [
                       "Polygon",
-                      "Ethereum mainnet",
-                      "Sepolia"
+                      "Amoy"
                     ],
                     "type": "string",
                     "minLength": 1,
@@ -845,9 +843,8 @@
                     "title": "Chain ID",
                     "description": "Blockchain network identifier",
                     "examples": [
-                      1,
                       137,
-                      11155111
+                      80002
                     ],
                     "type": "integer",
                     "minimum": 1,
@@ -858,8 +855,7 @@
                     "description": "Name of the blockchain network",
                     "examples": [
                       "Polygon",
-                      "Ethereum mainnet",
-                      "Sepolia"
+                      "Amoy"
                     ],
                     "type": "string",
                     "minLength": 1,
@@ -964,9 +960,8 @@
                         "title": "Chain ID",
                         "description": "Blockchain network identifier",
                         "examples": [
-                          1,
                           137,
-                          11155111
+                          80002
                         ],
                         "type": "integer",
                         "minimum": 1,
@@ -977,8 +972,7 @@
                         "description": "Name of the blockchain network",
                         "examples": [
                           "Polygon",
-                          "Ethereum mainnet",
-                          "Sepolia"
+                          "Amoy"
                         ],
                         "type": "string",
                         "minLength": 1,
@@ -1209,9 +1203,8 @@
                       "title": "Chain ID",
                       "description": "Blockchain network identifier",
                       "examples": [
-                        1,
                         137,
-                        11155111
+                        80002
                       ],
                       "type": "integer",
                       "minimum": 1,
@@ -1222,8 +1215,7 @@
                       "description": "Name of the blockchain network",
                       "examples": [
                         "Polygon",
-                        "Ethereum mainnet",
-                        "Sepolia"
+                        "Amoy"
                       ],
                       "type": "string",
                       "minLength": 1,
@@ -1283,9 +1275,8 @@
           "title": "Chain ID",
           "description": "Blockchain chain ID",
           "examples": [
-            1,
             137,
-            11155111
+            80002
           ],
           "type": "integer",
           "minimum": 1,

package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json

@@ -2,8 +2,8 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "CreditRetirementReceipt NFT IPFS Record",
   "description": "Complete CreditRetirementReceipt NFT IPFS record including attributes and credit retirement data",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.39/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json",
-  "version": "0.1.39",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.40/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json",
+  "version": "0.1.40",
   "type": "object",
   "properties": {
     "$schema": {
@@ -657,9 +657,8 @@
                     "title": "Chain ID",
                     "description": "Blockchain network identifier",
                     "examples": [
-                      1,
                       137,
-                      11155111
+                      80002
                     ],
                     "type": "integer",
                     "minimum": 1,
@@ -670,8 +669,7 @@
                     "description": "Name of the blockchain network",
                     "examples": [
                       "Polygon",
-                      "Ethereum mainnet",
-                      "Sepolia"
+                      "Amoy"
                     ],
                     "type": "string",
                     "minLength": 1,
@@ -791,9 +789,8 @@
                     "title": "Chain ID",
                     "description": "Blockchain network identifier",
                     "examples": [
-                      1,
                       137,
-                      11155111
+                      80002
                     ],
                     "type": "integer",
                     "minimum": 1,
@@ -804,8 +801,7 @@
                     "description": "Name of the blockchain network",
                     "examples": [
                       "Polygon",
-                      "Ethereum mainnet",
-                      "Sepolia"
+                      "Amoy"
                     ],
                     "type": "string",
                     "minLength": 1,
@@ -910,9 +906,8 @@
                         "title": "Chain ID",
                         "description": "Blockchain network identifier",
                         "examples": [
-                          1,
                           137,
-                          11155111
+                          80002
                         ],
                         "type": "integer",
                         "minimum": 1,
@@ -923,8 +918,7 @@
                         "description": "Name of the blockchain network",
                         "examples": [
                           "Polygon",
-                          "Ethereum mainnet",
-                          "Sepolia"
+                          "Amoy"
                         ],
                         "type": "string",
                         "minLength": 1,
@@ -1121,9 +1115,8 @@
                   "title": "Chain ID",
                   "description": "Blockchain network identifier",
                   "examples": [
-                    1,
                     137,
-                    11155111
+                    80002
                   ],
                   "type": "integer",
                   "minimum": 1,
@@ -1134,8 +1127,7 @@
                   "description": "Name of the blockchain network",
                   "examples": [
                     "Polygon",
-                    "Ethereum mainnet",
-                    "Sepolia"
+                    "Amoy"
                   ],
                   "type": "string",
                   "minLength": 1,
@@ -1189,9 +1181,8 @@
           "title": "Chain ID",
           "description": "Blockchain chain ID",
           "examples": [
-            1,
             137,
-            11155111
+            80002
           ],
           "type": "integer",
           "minimum": 1,

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

@@ -12,7 +12,7 @@
   },
   "blockchain": {
     "smart_contract_address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
-    "chain_id": 1,
+    "chain_id": 137,
     "network_name": "Ethereum Mainnet",
     "token_id": "456"
   },
@@ -151,7 +151,6 @@
         "longitude": -51.070,
         "precision_level": "city"
       },
-      "facility_type": "Collection Point",
       "responsible_participant_id_hash": "5021ea455b3549498a8583dc0c6f7cbf1234567890abcdef1234567890abcdef"
     },
     "prevented_emissions_calculation": {

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

@@ -2,8 +2,8 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "GasID NFT IPFS Record",
   "description": "Complete GasID NFT IPFS record including fixed attributes and detailed carbon emissions prevention data",
-  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.39/schemas/ipfs/gas-id/gas-id.schema.json",
-  "version": "0.1.39",
+  "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.40/schemas/ipfs/gas-id/gas-id.schema.json",
+  "version": "0.1.40",
   "type": "object",
   "properties": {
     "$schema": {
@@ -715,22 +715,6 @@
                 "precision_level"
               ],
               "additionalProperties": false
-            },
-            "facility_type": {
-              "title": "Facility Type",
-              "description": "Type of facility in the waste management chain",
-              "examples": [
-                "Collection Point",
-                "Recycling Facility",
-                "Administrative Office"
-              ],
-              "type": "string",
-              "enum": [
-                "Collection Point",
-                "Recycling Facility",
-                "Administrative Office",
-                "Other"
-              ]
             }
           },
           "required": [
@@ -1088,9 +1072,8 @@
           "title": "Chain ID",
           "description": "Blockchain chain ID",
           "examples": [
-            1,
             137,
-            11155111
+            80002
           ],
           "type": "integer",
           "minimum": 1,

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

@@ -1,9 +1,9 @@
 {
-  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/mass-id/mass-id.schema.json",
+  "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.37/schemas/ipfs/mass-id/mass-id.schema.json",
   "schema": {
     "hash": "ac08c3cf2e175e55961d6affdb38bc24591b84ceef7f3707c69ae3d52c148b2f",
     "type": "MassID",
-    "version": "0.1.0"
+    "version": "0.1.37"
   },
   "environment": {
     "blockchain_network": "testnet",
@@ -13,7 +13,7 @@
   "blockchain": {
     "token_id": "123",
     "smart_contract_address": "0x1234567890abcdef1234567890abcdef12345678",
-    "chain_id": 1,
+    "chain_id": 137,
     "network_name": "Polygon"
   },
   "created_at": "2024-12-05T11:02:47.000Z",
@@ -63,49 +63,46 @@
       "value": "Amapá"
     },
     {
-      "trait_type": "Vehicle Type",
+      "trait_type": "Pick-up Vehicle Type",
       "value": "Truck"
     },
     {
       "trait_type": "Recycling Method",
       "value": "Composting"
     },
-    {
-      "trait_type": "Processing Time (hours)",
-      "value": 72.5
-    },
     {
       "trait_type": "Local Waste Classification ID",
       "value": "04 02 20"
     },
     {
-      "trait_type": "Recycling Manifest Code",
-      "value": "CDF-2353"
+      "trait_type": "Recycling Manifest Number",
+      "value": "2353"
     },
     {
-      "trait_type": "Transport Manifest Code",
-      "value": "MTR-4126"
+      "trait_type": "Transport Manifest Number",
+      "value": "4126"
     },
     {
       "trait_type": "Weighing Capture Method",
-      "value": "Digital"
+      "value": "Digital scale integration"
     },
     {
       "trait_type": "Scale Type",
       "value": "Weighbridge (Truck Scale)"
     },
-    {
-      "trait_type": "Container Type",
-      "value": "Truck"
-    },
     {
       "trait_type": "Pick-up Date",
       "value": 1733396567000,
       "display_type": "date"
     },
+    {
+      "trait_type": "Drop-off Date",
+      "value": 1733407367000,
+      "display_type": "date"
+    },
     {
       "trait_type": "Recycling Date",
-      "value": 1740182400000,
+      "value": 1733657567000,
       "display_type": "date"
     }
   ],
@@ -117,10 +114,8 @@
       "subtype": "Food, Food Waste and Beverages",
       "local_classification": {
         "code": "04 02 20",
-        "description": "Lodos do tratamento local de efluentes não abrangidas em 04 02 19",
-        "system": "IBAMA"
+        "system": "Ibama"
       },
-      "measurement_unit": "kg",
       "net_weight": 3000
     },
     "locations": [
@@ -131,7 +126,6 @@
         "administrative_division_code": "BR-AP",
         "country": "Brazil",
         "country_code": "BR",
-        "facility_type": "Collection Point",
         "coordinates": {
           "latitude": -0.02,
           "longitude": -51.06,
@@ -146,7 +140,6 @@
         "administrative_division_code": "BR-ES",
         "country": "Brazil",
         "country_code": "BR",
-        "facility_type": "Recycling Facility",
         "coordinates": {
           "latitude": -20.38,
           "longitude": -40.34,
@@ -167,170 +160,77 @@
         "roles": ["Hauler", "Recycler"]
       }
     ],
-    "chain_of_custody": {
-      "events": [
-        {
-          "event_id": "8f799606-4ed5-49ce-8310-83b0c56ac01e",
-          "event_name": "Pick-up",
-          "description": "Waste picked up by hauler Eco Reciclagem at Enlatados Produção",
-          "timestamp": 1733396567000,
-          "participant_id_hash": "a1b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcd",
-          "location_id_hash": "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
-          "attributes": [
-            {
-              "name": "Vehicle Type",
-              "value": "Truck"
-            },
-            {
-              "name": "Driver Identifier",
-              "value": "645eb901-bc17-497f-b53b-9bdd619ae2ec"
-            }
-          ]
-        },
-        {
-          "event_id": "9f6c6855-0a6b-4989-a3fc-1a8a38f919ec",
-          "event_name": "Transport",
-          "timestamp": 1733396567000,
-          "description": "Waste transported to recycling facility",
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-          "weight": 3000,
-          "attributes": [
-            {
-              "name": "Document Type",
-              "value": "MTR"
-            },
-            {
-              "name": "Document Number",
-              "value": "4126"
-            },
-            {
-              "name": "Issue Date",
-              "value": "2024-02-10",
-              "format": "DATE"
-            }
-          ],
-            "attachments": [
-              {
-                "type": "Transport Manifest",
-                "document_number": "MTR-4126",
-                "reference": "transport-manifest.pdf",
-                "issue_timestamp": 1707523200000
-              }
-            ]
-        },
-        {
-          "event_id": "591eb414-a678-486d-982c-3c25f3cb52de",
-          "event_name": "Weighing",
-          "timestamp": 1733396567000,
-          "description": "Waste weighed at recycling facility",
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-          "attributes": [
-            {
-              "name": "Weighing Capture Method",
-              "value": "Digital"
-            },
-            {
-              "name": "Scale Type",
-              "value": "Weighbridge (Truck Scale)"
-            },
-            {
-              "name": "Container Type",
-              "value": "Truck"
-            },
-            {
-              "name": "Container Capacity",
-              "value": 12000,
-              "format": "KILOGRAM"
-            },
-            {
-              "name": "Gross Weight",
-              "value": 22700,
-              "format": "KILOGRAM"
-            },
-            {
-              "name": "Tare",
-              "value": 19700,
-              "format": "KILOGRAM"
-            }
-          ]
-        },
-        {
-          "event_id": "5d4b0723-b3a6-4659-8d80-d74f5e842af7",
-          "event_name": "Drop-off",
-          "description": "Waste deposited in Windrow number 1",
-          "timestamp": 1733396567000,
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-          "attributes": [
-            {
-              "name": "Recycler Operator Identifier",
-              "value": "d596521f-8f98-401d-ba55-93246d57c6fb"
-            }
-          ]
-        },
-        {
-          "event_id": "ca509646-e35a-47b5-aff7-39595125effe",
-          "event_name": "Sorting",
-          "description": "This MassID sorting is being defined by the sorting factor calculated by a third party audit for Eco Reciclagem",
-          "timestamp": 1733396567000,
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-          "attributes": [
-            {
-              "name": "Sorting Factor",
-              "value": 0.5
-            }
-          ]
-        },
-        {
-          "event_id": "df7d3cac-81a1-46db-8486-b3fe4ec4ea32",
-          "event_name": "Documentation",
-          "description": "Attached the recycling manifest documentation",
-          "timestamp": 1733396567000,
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-          "attributes": [
-            {
-              "name": "Document Type",
-              "value": "CDF"
-            },
-            {
-              "name": "Document Number",
-              "value": "2353"
-            },
-            {
-              "name": "Issue Date",
-              "value": "2024-03-10",
-              "format": "DATE"
-            }
-          ],
-            "attachments": [
-              {
-                "type": "Recycling Certificate",
-                "document_number": "CDF-2353",
-                "reference": "recycling-manifest.pdf",
-                "issue_timestamp": 1710028800000
-              }
-            ]
-        },
-        {
-          "event_id": "b544695f-c3ba-4b97-9b24-c13dd32e4db8",
-          "event_name": "Recycling",
-          "description": "Composting process completed",
-          "timestamp": 1740213312000,
-          "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
-          "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
+    "events": [
+      {
+        "event_id": "8f799606-4ed5-49ce-8310-83b0c56ac01e",
+        "event_name": "Pick-up",
+        "description": "Waste picked up by hauler Eco Reciclagem at Enlatados Produção",
+        "timestamp": "2024-12-05T11:02:47.000Z",
+        "participant_id_hash": "a1b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcd",
+        "location_id_hash": "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
+        "data": {
+          "vehicle_type": "Truck"
         }
-      ],
-      "total_duration_minutes": 4350
-    },
-    "geographic_data": {
-      "from_location_id_hash": "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489",
-      "to_location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
-      "first_reported_timestamp": 1733396567000,
-      "last_reported_timestamp": 1740213312000
-    }
+      },
+      {
+        "event_id": "591eb414-a678-486d-982c-3c25f3cb52de",
+        "event_name": "Weighing",
+        "timestamp": "2024-12-05T13:02:47.000Z",
+        "description": "Waste weighed at recycling facility",
+        "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
+        "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
+        "data": {
+          "weighing_capture_method": "Digital scale integration",
+          "scale_type": "Weighbridge (Truck Scale)",
+          "container_type": "Roll-off container",
+          "vehicle_type": "Truck",
+          "container_capacity": 12000,
+          "gross_weight": 9500,
+          "tare": 3500
+        }
+      },
+      {
+        "event_id": "5d4b0723-b3a6-4659-8d80-d74f5e842af7",
+        "event_name": "Drop-off",
+        "description": "Waste deposited in Windrow number 1",
+        "timestamp": "2024-12-05T14:02:47.000Z",
+        "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
+        "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
+      },
+      {
+        "event_id": "ca509646-e35a-47b5-aff7-39595125effe",
+        "event_name": "Sorting",
+        "description": "This MassID sorting is being defined by the sorting factor calculated by a third party audit for Eco Reciclagem",
+        "timestamp": "2024-12-05T15:02:47.000Z",
+        "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
+        "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6",
+        "data": {
+          "initial_weight": 5000,
+          "deducted_weight": 250
+        }
+      },
+      {
+        "event_id": "b544695f-c3ba-4b97-9b24-c13dd32e4db8",
+        "event_name": "Recycling",
+        "description": "Composting process completed",
+        "timestamp": "2024-12-08T11:32:47.000Z",
+        "participant_id_hash": "b2c3d4e5f6789012345678901234567890abcdefabcdefabcdefabcdefabcdef",
+        "location_id_hash": "6e83b8e6373847bbdc056549bedda38dc88854ce41ba4fca11e0fc6ce3e07ef6"
+      }
+    ],
+    "attachments": [
+      {
+        "event_id": "5d4b0723-b3a6-4659-8d80-d74f5e842af7",
+        "type": "Transport Manifest",
+        "document_number": "4126",
+        "issued_at": "2024-02-10T00:00:00.000Z"
+      },
+      {
+        "event_id": "b544695f-c3ba-4b97-9b24-c13dd32e4db8",
+        "type": "Recycling Manifest",
+        "document_number": "2353",
+        "issued_at": "2024-03-10T00:00:00.000Z"
+      }
+    ]
   }
 }