@carrot-foundation/schemas 0.1.36 → 0.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/index.cjs +1124 -36
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +959 -13
  4. package/dist/index.d.ts +959 -13
  5. package/dist/index.js +1102 -37
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -1
  8. package/schemas/ipfs/collection/collection.example.json +1 -0
  9. package/schemas/ipfs/collection/collection.schema.json +305 -32
  10. package/schemas/ipfs/credit/credit.example.json +1 -0
  11. package/schemas/ipfs/credit/credit.schema.json +326 -45
  12. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.example.json +290 -0
  13. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json +1768 -0
  14. package/schemas/ipfs/gas-id/gas-id.schema.json +6 -6
  15. package/schemas/ipfs/mass-id/mass-id.schema.json +6 -6
  16. package/schemas/ipfs/mass-id-audit/mass-id-audit.example.json +30 -29
  17. package/schemas/ipfs/mass-id-audit/mass-id-audit.schema.json +636 -15
  18. package/schemas/ipfs/methodology/methodology.example.json +27 -26
  19. package/schemas/ipfs/methodology/methodology.schema.json +457 -15
  20. package/schemas/ipfs/recycled-id/recycled-id.schema.json +6 -6
  21. package/schemas/ipfs/gas-id/gas-id.attributes.schema.json +0 -219
  22. package/schemas/ipfs/gas-id/gas-id.data.schema.json +0 -120
  23. package/schemas/ipfs/mass-id-audit/mass-id-audit.data.schema.json +0 -130
  24. package/schemas/ipfs/methodology/methodology.data.schema.json +0 -121
  25. package/schemas/ipfs/purchase-id/purchase-id.attributes.schema.json +0 -91
  26. package/schemas/ipfs/purchase-id/purchase-id.data.schema.json +0 -337
  27. package/schemas/ipfs/purchase-id/purchase-id.example.json +0 -224
  28. package/schemas/ipfs/purchase-id/purchase-id.schema.json +0 -29
  29. package/schemas/ipfs/recycled-id/recycled-id.attributes.schema.json +0 -202
  30. package/schemas/ipfs/recycled-id/recycled-id.data.schema.json +0 -63
  31. package/schemas/ipfs/shared/base/base.schema.json +0 -163
  32. package/schemas/ipfs/shared/certificate/certificate.schema.json +0 -145
  33. package/schemas/ipfs/shared/definitions/definitions.schema.json +0 -255
  34. package/schemas/ipfs/shared/entities/location/location.schema.json +0 -90
  35. package/schemas/ipfs/shared/entities/participant/participant.schema.json +0 -28
  36. package/schemas/ipfs/shared/nft/nft.schema.json +0 -182
  37. package/schemas/ipfs/shared/references/audit-reference/audit-reference.schema.json +0 -42
  38. package/schemas/ipfs/shared/references/gas-id-reference/gas-id-reference.schema.json +0 -27
  39. package/schemas/ipfs/shared/references/mass-id-reference/mass-id-reference.schema.json +0 -27
  40. package/schemas/ipfs/shared/references/methodology-reference/methodology-reference.schema.json +0 -34
@@ -2,8 +2,8 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "title": "GasID NFT IPFS Record",
4
4
  "description": "Complete GasID NFT IPFS record including fixed attributes and detailed carbon emissions prevention data",
5
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.36/schemas/ipfs/gas-id/gas-id.schema.json",
6
- "version": "0.1.36",
5
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.37/schemas/ipfs/gas-id/gas-id.schema.json",
6
+ "version": "0.1.37",
7
7
  "type": "object",
8
8
  "properties": {
9
9
  "$schema": {
@@ -175,8 +175,8 @@
175
175
  "description": "Type of relationship to the referenced record",
176
176
  "examples": [
177
177
  "mass-id",
178
- "audit",
179
- "collection"
178
+ "collection",
179
+ "credit-purchase-receipt"
180
180
  ],
181
181
  "type": "string",
182
182
  "enum": [
@@ -186,7 +186,7 @@
186
186
  "mass-id",
187
187
  "mass-id-audit",
188
188
  "methodology",
189
- "purchase-id",
189
+ "credit-purchase-receipt",
190
190
  "recycled-id"
191
191
  ]
192
192
  },
@@ -1081,7 +1081,7 @@
1081
1081
  "0xabcdef1234567890abcdef1234567890abcdef12"
1082
1082
  ],
1083
1083
  "type": "string",
1084
- "pattern": "^0x[a-fA-F0-9]{40}$"
1084
+ "pattern": "^0x[a-f0-9]{40}$"
1085
1085
  },
1086
1086
  "chain_id": {
1087
1087
  "title": "Chain ID",
@@ -2,8 +2,8 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "title": "MassID NFT IPFS Record",
4
4
  "description": "Complete MassID NFT IPFS record including fixed attributes and detailed waste tracking data",
5
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.36/schemas/ipfs/mass-id/mass-id.schema.json",
6
- "version": "0.1.36",
5
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.1.37/schemas/ipfs/mass-id/mass-id.schema.json",
6
+ "version": "0.1.37",
7
7
  "type": "object",
8
8
  "properties": {
9
9
  "$schema": {
@@ -175,8 +175,8 @@
175
175
  "description": "Type of relationship to the referenced record",
176
176
  "examples": [
177
177
  "mass-id",
178
- "audit",
179
- "collection"
178
+ "collection",
179
+ "credit-purchase-receipt"
180
180
  ],
181
181
  "type": "string",
182
182
  "enum": [
@@ -186,7 +186,7 @@
186
186
  "mass-id",
187
187
  "mass-id-audit",
188
188
  "methodology",
189
- "purchase-id",
189
+ "credit-purchase-receipt",
190
190
  "recycled-id"
191
191
  ]
192
192
  },
@@ -980,7 +980,7 @@
980
980
  "0xabcdef1234567890abcdef1234567890abcdef12"
981
981
  ],
982
982
  "type": "string",
983
- "pattern": "^0x[a-fA-F0-9]{40}$"
983
+ "pattern": "^0x[a-f0-9]{40}$"
984
984
  },
985
985
  "chain_id": {
986
986
  "title": "Chain ID",
@@ -28,7 +28,7 @@
28
28
  },
29
29
  "methodology": {
30
30
  "external_id": "8a1f5c92-e847-4b6d-9f23-d4e7a8b1c5e9",
31
- "name": "BOLD Carbon (CH)",
31
+ "name": "BOLD Carbon (CH\u2084)",
32
32
  "version": "v1.4.2",
33
33
  "external_url": "https://explore.carrot.eco/document/bold-carbon-ch4",
34
34
  "uri": "ipfs://QmYx8FdKl2mN9pQ7rS6tV8wB3cE4fG5hI9jK0lM1nO2pQ3r/bold-carbon-ch4-v1.4.2.json"
@@ -49,7 +49,7 @@
49
49
  {
50
50
  "rule_name": "Waste Mass is Unique",
51
51
  "rule_slug": "waste-mass-is-unique",
52
- "rule_id": "12345678-1234-1234-1234-000000000001",
52
+ "rule_id": "00000000-0000-4000-8000-000000000001",
53
53
  "execution_order": 1,
54
54
  "result": "PASSED",
55
55
  "description": "Validates that each MassID is unique within the system to prevent duplicate entries and double counting",
@@ -59,7 +59,7 @@
59
59
  {
60
60
  "rule_name": "No Conflicting GasID or Credit",
61
61
  "rule_slug": "no-conflicting-gas-id-or-credit",
62
- "rule_id": "12345678-1234-1234-1234-000000000002",
62
+ "rule_id": "00000000-0000-4000-8000-000000000002",
63
63
  "execution_order": 2,
64
64
  "result": "PASSED",
65
65
  "description": "Verifies that the MassID has not been previously registered in other carbon certificates or carbon credits to prevent double issuance",
@@ -69,7 +69,7 @@
69
69
  {
70
70
  "rule_name": "Project Period Limit",
71
71
  "rule_slug": "project-period-limit",
72
- "rule_id": "12345678-1234-1234-1234-000000000003",
72
+ "rule_id": "00000000-0000-4000-8000-000000000003",
73
73
  "execution_order": 3,
74
74
  "result": "PASSED",
75
75
  "description": "Confirms that the MassID processing occurred within the valid project timeframe as defined by methodology guidelines",
@@ -79,7 +79,7 @@
79
79
  {
80
80
  "rule_name": "Participant Accreditations Requirements",
81
81
  "rule_slug": "participant-accreditations-requirements",
82
- "rule_id": "12345678-1234-1234-1234-000000000004",
82
+ "rule_id": "00000000-0000-4000-8000-000000000004",
83
83
  "execution_order": 4,
84
84
  "result": "PASSED",
85
85
  "description": "Checks if all participating entities (waste generator, hauler, recycler) have valid certifications and environmental permits",
@@ -89,7 +89,7 @@
89
89
  {
90
90
  "rule_name": "MassID Qualifications",
91
91
  "rule_slug": "mass-id-qualifications",
92
- "rule_id": "12345678-1234-1234-1234-000000000005",
92
+ "rule_id": "00000000-0000-4000-8000-000000000005",
93
93
  "execution_order": 5,
94
94
  "result": "PASSED",
95
95
  "description": "Validates the proper categorization, composition analysis, and definition of the organic waste mass according to methodology standards",
@@ -99,7 +99,7 @@
99
99
  {
100
100
  "rule_name": "Regional Waste Classification",
101
101
  "rule_slug": "regional-waste-classification",
102
- "rule_id": "12345678-1234-1234-1234-000000000006",
102
+ "rule_id": "00000000-0000-4000-8000-000000000006",
103
103
  "execution_order": 6,
104
104
  "result": "PASSED",
105
105
  "description": "Ensures the waste is properly classified according to Brazilian ABNT NBR 10004 standards and local municipal regulations",
@@ -109,7 +109,7 @@
109
109
  {
110
110
  "rule_name": "Geolocation and Address Precision",
111
111
  "rule_slug": "geolocation-and-address-precision",
112
- "rule_id": "12345678-1234-1234-1234-000000000007",
112
+ "rule_id": "00000000-0000-4000-8000-000000000007",
113
113
  "execution_order": 7,
114
114
  "result": "PASSED",
115
115
  "description": "Verifies the accuracy of geographical coordinates for waste collection and processing locations within 10-meter precision",
@@ -119,7 +119,7 @@
119
119
  {
120
120
  "rule_name": "Waste Origin Identification",
121
121
  "rule_slug": "waste-origin-identification",
122
- "rule_id": "12345678-1234-1234-1234-000000000008",
122
+ "rule_id": "00000000-0000-4000-8000-000000000008",
123
123
  "execution_order": 8,
124
124
  "result": "PASSED",
125
125
  "description": "Validates the documented source and origin point of the organic waste with complete chain of custody documentation",
@@ -129,7 +129,7 @@
129
129
  {
130
130
  "rule_name": "Hauler Identification",
131
131
  "rule_slug": "hauler-identification",
132
- "rule_id": "12345678-1234-1234-1234-000000000009",
132
+ "rule_id": "00000000-0000-4000-8000-000000000009",
133
133
  "execution_order": 9,
134
134
  "result": "PASSED",
135
135
  "description": "Confirms the identity, ANTT registration, and environmental credentials of the waste transportation company",
@@ -139,7 +139,7 @@
139
139
  {
140
140
  "rule_name": "Vehicle Identification",
141
141
  "rule_slug": "vehicle-identification",
142
- "rule_id": "12345678-1234-1234-1234-000000000010",
142
+ "rule_id": "00000000-0000-4000-8000-000000000010",
143
143
  "execution_order": 10,
144
144
  "result": "PASSED",
145
145
  "description": "Verifies the registration, inspection certificates, and environmental compliance of vehicles used in waste transportation",
@@ -149,7 +149,7 @@
149
149
  {
150
150
  "rule_name": "Driver Identification",
151
151
  "rule_slug": "driver-identification",
152
- "rule_id": "12345678-1234-1234-1234-000000000011",
152
+ "rule_id": "00000000-0000-4000-8000-000000000011",
153
153
  "execution_order": 11,
154
154
  "result": "PASSED",
155
155
  "description": "Validates the identity, CNH (driver's license), and proper licensing of the waste transport driver",
@@ -159,7 +159,7 @@
159
159
  {
160
160
  "rule_name": "Transport Manifest Data",
161
161
  "rule_slug": "transport-manifest-data",
162
- "rule_id": "12345678-1234-1234-1234-000000000012",
162
+ "rule_id": "00000000-0000-4000-8000-000000000012",
163
163
  "execution_order": 12,
164
164
  "result": "PASSED",
165
165
  "description": "Checks the completeness and accuracy of MTR (Waste Transport Manifest) documentation and digital signatures",
@@ -169,7 +169,7 @@
169
169
  {
170
170
  "rule_name": "Processor Identification",
171
171
  "rule_slug": "processor-identification",
172
- "rule_id": "12345678-1234-1234-1234-000000000013",
172
+ "rule_id": "00000000-0000-4000-8000-000000000013",
173
173
  "execution_order": 13,
174
174
  "result": "PASSED",
175
175
  "description": "Validates the identity, environmental licensing, and ISO 14001 certification of the waste processing facility",
@@ -179,7 +179,7 @@
179
179
  {
180
180
  "rule_name": "Recycler Identification",
181
181
  "rule_slug": "recycler-identification",
182
- "rule_id": "12345678-1234-1234-1234-000000000014",
182
+ "rule_id": "00000000-0000-4000-8000-000000000014",
183
183
  "execution_order": 14,
184
184
  "result": "PASSED",
185
185
  "description": "Confirms the identity, CETESB licensing, and operational credentials of the composting facility operator",
@@ -189,7 +189,7 @@
189
189
  {
190
190
  "rule_name": "Weighing Verification",
191
191
  "rule_slug": "weighing-verification",
192
- "rule_id": "12345678-1234-1234-1234-000000000015",
192
+ "rule_id": "00000000-0000-4000-8000-000000000015",
193
193
  "execution_order": 15,
194
194
  "result": "PASSED",
195
195
  "description": "Verifies the accurate measurement using INMETRO-certified scales and recording of waste MassID quantities with traceability",
@@ -199,7 +199,7 @@
199
199
  {
200
200
  "rule_name": "Drop-off at Recycler",
201
201
  "rule_slug": "drop-off-at-recycler",
202
- "rule_id": "12345678-1234-1234-1234-000000000016",
202
+ "rule_id": "00000000-0000-4000-8000-000000000016",
203
203
  "execution_order": 16,
204
204
  "result": "PASSED",
205
205
  "description": "Validates the proper reception, inspection, and documentation of waste material at the composting facility with photographic evidence",
@@ -209,7 +209,7 @@
209
209
  {
210
210
  "rule_name": "MassID Sorting and Classification",
211
211
  "rule_slug": "mass-id-sorting-classification",
212
- "rule_id": "12345678-1234-1234-1234-000000000017",
212
+ "rule_id": "00000000-0000-4000-8000-000000000017",
213
213
  "execution_order": 17,
214
214
  "result": "PASSED",
215
215
  "description": "Confirms the proper segregation, contamination analysis, and classification of organic waste materials according to composting requirements",
@@ -219,7 +219,7 @@
219
219
  {
220
220
  "rule_name": "Composting Process Initiation",
221
221
  "rule_slug": "composting-process-initiation",
222
- "rule_id": "12345678-1234-1234-1234-000000000018",
222
+ "rule_id": "00000000-0000-4000-8000-000000000018",
223
223
  "execution_order": 18,
224
224
  "result": "PASSED",
225
225
  "description": "Validates the proper start of aerobic composting process with correct carbon-nitrogen ratio and moisture content monitoring",
@@ -229,17 +229,17 @@
229
229
  {
230
230
  "rule_name": "Temperature Monitoring Compliance",
231
231
  "rule_slug": "temperature-monitoring-compliance",
232
- "rule_id": "12345678-1234-1234-1234-000000000019",
232
+ "rule_id": "00000000-0000-4000-8000-000000000019",
233
233
  "execution_order": 19,
234
234
  "result": "PASSED",
235
- "description": "Ensures continuous temperature monitoring during thermophilic phase (55-65°C) for pathogen elimination and process optimization",
235
+ "description": "Ensures continuous temperature monitoring during thermophilic phase (55-65\u00b0C) for pathogen elimination and process optimization",
236
236
  "rule_processor_checksum": "a9b0c1d2-e3f4-f012-3456-789012345678",
237
237
  "rule_source_code_version": "v2.1.3-e6d7c8cd-c0d1-6789-0123-456789012345"
238
238
  },
239
239
  {
240
240
  "rule_name": "Composting Cycle Timeframe",
241
241
  "rule_slug": "composting-cycle-timeframe",
242
- "rule_id": "12345678-1234-1234-1234-000000000020",
242
+ "rule_id": "00000000-0000-4000-8000-000000000020",
243
243
  "execution_order": 20,
244
244
  "result": "PASSED",
245
245
  "description": "Validates that the complete composting process follows required 90-120 day duration with proper turning schedule and maturation",
@@ -249,7 +249,7 @@
249
249
  {
250
250
  "rule_name": "Compost Quality Assessment",
251
251
  "rule_slug": "compost-quality-assessment",
252
- "rule_id": "12345678-1234-1234-1234-000000000021",
252
+ "rule_id": "00000000-0000-4000-8000-000000000021",
253
253
  "execution_order": 21,
254
254
  "result": "PASSED",
255
255
  "description": "Verifies the final compost meets quality standards including pH, conductivity, germination index, and pathogen absence",
@@ -259,7 +259,7 @@
259
259
  {
260
260
  "rule_name": "Recycling Manifest Data",
261
261
  "rule_slug": "recycling-manifest-data",
262
- "rule_id": "12345678-1234-1234-1234-000000000022",
262
+ "rule_id": "00000000-0000-4000-8000-000000000022",
263
263
  "execution_order": 22,
264
264
  "result": "PASSED",
265
265
  "description": "Verifies the completion, accuracy, and digital signatures of final recycling documentation including compost analysis and outcomes",
@@ -269,7 +269,7 @@
269
269
  {
270
270
  "rule_name": "Project Boundary Compliance",
271
271
  "rule_slug": "project-boundary-compliance",
272
- "rule_id": "12345678-1234-1234-1234-000000000023",
272
+ "rule_id": "00000000-0000-4000-8000-000000000023",
273
273
  "execution_order": 23,
274
274
  "result": "PASSED",
275
275
  "description": "Validate that the MassID processing activities are within the approved project geographical and operational boundaries",
@@ -277,15 +277,16 @@
277
277
  "rule_source_code_version": "v2.1.3-c0b1a2ab-a4b5-abcd-0123-89012345ef01"
278
278
  },
279
279
  {
280
- "rule_name": "CO₂e Emissions Calculation",
280
+ "rule_name": "CO\u2082e Emissions Calculation",
281
281
  "rule_slug": "co2e-emissions-calculation",
282
- "rule_id": "12345678-1234-1234-1234-000000000024",
282
+ "rule_id": "00000000-0000-4000-8000-000000000024",
283
283
  "execution_order": 24,
284
284
  "result": "PASSED",
285
- "description": "Calculate the prevented CO₂e emissions based on methane emission factors and the processed organic waste mass using IPCC 2019 guidelines",
285
+ "description": "Calculate the prevented CO\u2082e emissions based on methane emission factors and the processed organic waste mass using IPCC 2019 guidelines",
286
286
  "rule_processor_checksum": "f4a5b6c7-d8e9-4567-89ab-012345678ef0",
287
287
  "rule_source_code_version": "v2.1.3-d1c2b3bc-b5c6-bcde-0123-9012345f0123"
288
288
  }
289
289
  ]
290
- }
290
+ },
291
+ "original_content_hash": "7d9f82c4e1b6a5f3d8e2c1b9a8f7e6d5c4b3a2f1e0d9c8b7a6f5e4d3c2b1a0f9"
291
292
  }