@carrot-foundation/schemas 0.2.4 → 0.3.0

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 (27) hide show
  1. package/README.md +144 -116
  2. package/dist/index.cjs +115 -113
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +7 -7
  5. package/dist/index.d.ts +7 -7
  6. package/dist/index.js +115 -113
  7. package/dist/index.js.map +1 -1
  8. package/package.json +1 -1
  9. package/schemas/ipfs/collection/collection.example.json +3 -3
  10. package/schemas/ipfs/collection/collection.schema.json +7 -7
  11. package/schemas/ipfs/credit/credit.example.json +4 -4
  12. package/schemas/ipfs/credit/credit.schema.json +6 -6
  13. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.example.json +15 -15
  14. package/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json +56 -56
  15. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.example.json +15 -15
  16. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json +54 -54
  17. package/schemas/ipfs/gas-id/gas-id.example.json +9 -9
  18. package/schemas/ipfs/gas-id/gas-id.schema.json +49 -41
  19. package/schemas/ipfs/mass-id/mass-id.example.json +7 -7
  20. package/schemas/ipfs/mass-id/mass-id.schema.json +60 -43
  21. package/schemas/ipfs/mass-id-audit/mass-id-audit.example.json +57 -57
  22. package/schemas/ipfs/mass-id-audit/mass-id-audit.schema.json +14 -14
  23. package/schemas/ipfs/methodology/methodology.example.json +5 -5
  24. package/schemas/ipfs/methodology/methodology.schema.json +7 -7
  25. package/schemas/ipfs/recycled-id/recycled-id.example.json +9 -9
  26. package/schemas/ipfs/recycled-id/recycled-id.schema.json +43 -35
  27. package/schemas/schema-hashes.json +10 -10
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@carrot-foundation/schemas",
3
- "version": "0.2.4",
3
+ "version": "0.3.0",
4
4
  "description": "Carrot schema definitions and zod validation schemas",
5
5
  "license": "Apache-2.0",
6
6
  "private": false,
@@ -1,9 +1,9 @@
1
1
  {
2
- "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/collection/collection.schema.json",
2
+ "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/collection/collection.schema.json",
3
3
  "schema": {
4
- "hash": "494bfbbd8e8721131571031aee97d23b825461e6c8c76de258b06c296ce30d60",
4
+ "hash": "2f8e7ae43fabfa0b8d4d18af1413fc375eca4622a4df75829b36492261a2a46d",
5
5
  "type": "Collection",
6
- "version": "0.2.4",
6
+ "version": "0.3.0",
7
7
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm"
8
8
  },
9
9
  "environment": {
@@ -25,7 +25,7 @@
25
25
  "type": "string",
26
26
  "const": "Collection",
27
27
  "title": "Collection Schema Type",
28
- "description": "Schema type identifier for this record"
28
+ "description": "Discriminator value identifying this record as a Collection grouping of credits and receipts"
29
29
  },
30
30
  "version": {
31
31
  "type": "string",
@@ -74,7 +74,7 @@
74
74
  "format": "uuid",
75
75
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
76
76
  "title": "External ID",
77
- "description": "UUID identifier for external system references",
77
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
78
78
  "examples": [
79
79
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
80
80
  ]
@@ -180,7 +180,7 @@
180
180
  "BOLD Brazil"
181
181
  ],
182
182
  "title": "Collection Name",
183
- "description": "Display name of the collection",
183
+ "description": "Human-readable display name for the environmental credit collection",
184
184
  "examples": [
185
185
  "BOLD Cold Start - Carazinho",
186
186
  "BOLD Brazil"
@@ -195,7 +195,7 @@
195
195
  "bold-brazil"
196
196
  ],
197
197
  "title": "Collection Slug",
198
- "description": "URL-friendly identifier for a collection",
198
+ "description": "URL-friendly identifier for an environmental credit collection, used in URIs and API references",
199
199
  "examples": [
200
200
  "bold-cold-start-carazinho",
201
201
  "bold-brazil"
@@ -236,6 +236,6 @@
236
236
  "additionalProperties": false,
237
237
  "title": "Collection IPFS Record",
238
238
  "description": "Collection metadata stored in IPFS, extending the base schema with collection-specific fields used to group and organize credit purchases and retirements in Carrot's ecosystem",
239
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/collection/collection.schema.json",
240
- "version": "0.2.4"
241
- }
239
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/collection/collection.schema.json",
240
+ "version": "0.3.0"
241
+ }
@@ -1,9 +1,9 @@
1
1
  {
2
- "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/credit/credit.schema.json",
2
+ "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/credit/credit.schema.json",
3
3
  "schema": {
4
- "hash": "e79bd7aba0a859d8c7c1864177629322603a105b8e68ad6c51d324ecc2c621b6",
4
+ "hash": "e043c3689a769dfad05f4d20a83821e659266a61d7bfa3a01462d24a91c26e5e",
5
5
  "type": "Credit",
6
- "version": "0.2.4",
6
+ "version": "0.3.0",
7
7
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm"
8
8
  },
9
9
  "environment": {
@@ -19,5 +19,5 @@
19
19
  "name": "Carrot Carbon (CH₄)",
20
20
  "decimals": 18,
21
21
  "image": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
22
- "description": "Carrot Carbon (C-CARB.CH4) represents verified carbon emissions reductions from organic waste composting projects. Each token equals one metric ton of CO2 equivalent prevented from entering the atmosphere through sustainable waste management practices. These credits are generated through the BOLD Carbon methodology and provide transparent, traceable environmental impact."
22
+ "description": "Carrot Carbon (C-CARB.CH4) represents verified prevented emissions from organic waste composting projects. Each token equals one metric ton of CO₂ equivalent (CO₂e) prevented from entering the atmosphere through sustainable waste management practices. These credits are generated through the BOLD Carbon methodology and provide transparent, traceable environmental impact."
23
23
  }
@@ -25,7 +25,7 @@
25
25
  "type": "string",
26
26
  "const": "Credit",
27
27
  "title": "Credit Schema Type",
28
- "description": "Schema type identifier for this record"
28
+ "description": "Discriminator value identifying this record as a Credit environmental-impact token"
29
29
  },
30
30
  "version": {
31
31
  "type": "string",
@@ -74,7 +74,7 @@
74
74
  "format": "uuid",
75
75
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
76
76
  "title": "External ID",
77
- "description": "UUID identifier for external system references",
77
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
78
78
  "examples": [
79
79
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
80
80
  ]
@@ -237,7 +237,7 @@
237
237
  "title": "Token Description",
238
238
  "description": "Comprehensive description of the credit token, its purpose, and impact",
239
239
  "examples": [
240
- "Carrot Carbon (C-CARB.CH4) represents verified carbon emissions reductions from organic waste composting projects. Each token equals one metric ton of CO2 equivalent prevented from entering the atmosphere through sustainable waste management practices."
240
+ "Carrot Carbon (C-CARB.CH4) represents verified prevented emissions from organic waste composting projects. Each token equals one metric ton of CO₂ equivalent (CO₂e) prevented from entering the atmosphere through sustainable waste management practices."
241
241
  ]
242
242
  }
243
243
  },
@@ -257,6 +257,6 @@
257
257
  "additionalProperties": false,
258
258
  "title": "Credit IPFS Record",
259
259
  "description": "Credit token metadata stored in IPFS, extending the base schema with ERC20-specific details",
260
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/credit/credit.schema.json",
261
- "version": "0.2.4"
262
- }
260
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/credit/credit.schema.json",
261
+ "version": "0.3.0"
262
+ }
@@ -1,9 +1,9 @@
1
1
  {
2
- "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
2
+ "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
3
3
  "schema": {
4
- "hash": "4c2acfb482d73246fc6bead2cbe0fe45c37d51ef6058eaba8da95501ec9a02e4",
4
+ "hash": "e8fb945c092cd457a352949a3aa2a12a8788ee9cc74d9196f17bd692c17121f1",
5
5
  "type": "CreditPurchaseReceipt",
6
- "version": "0.2.4",
6
+ "version": "0.3.0",
7
7
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm"
8
8
  },
9
9
  "environment": {
@@ -12,7 +12,7 @@
12
12
  "data_set_name": "TEST"
13
13
  },
14
14
  "blockchain": {
15
- "token_id": "987",
15
+ "token_id": "500001",
16
16
  "smart_contract_address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
17
17
  "chain_id": 80002,
18
18
  "network_name": "Amoy"
@@ -20,13 +20,13 @@
20
20
  "created_at": "2025-02-03T12:45:30.000Z",
21
21
  "external_id": "f1a2b3c4-d5e6-4789-9012-34567890abcd",
22
22
  "external_url": "https://explore.carrot.eco/document/f1a2b3c4-d5e6-4789-9012-34567890abcd",
23
- "audit_data_hash": "c49a39d9a4a265669682b8a147e5ecb439e8f31a304298db05b14497f064691b",
23
+ "audit_data_hash": "f0e1cc98d3ea5cb40e526e0ab601551c142f495609a6ac6c575a9c5550dfca03",
24
24
  "viewer_reference": {
25
25
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
26
26
  "integrity_hash": "87f633634cc4b02f628685651f0a29b7bfa22a0bd841f725c6772dd00a58d489"
27
27
  },
28
- "name": "Credit Purchase Receipt #987 • 8.5 Credits Purchased",
29
- "short_name": "Purchase Receipt #987",
28
+ "name": "Credit Purchase Receipt #500001 • 8.5 Credits Purchased",
29
+ "short_name": "Purchase Receipt #500001",
30
30
  "description": "Receipt for purchasing 8.5 credits (C-CARB.CH4 and C-BIOW) across 3 certificates, with 3.0 credits retired immediately on behalf of Climate Action Corp. Credits delivered to EcoTech Solutions Inc.",
31
31
  "image": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
32
32
  "background_color": "#2D5A27",
@@ -79,7 +79,7 @@
79
79
  },
80
80
  {
81
81
  "trait_type": "Retirement Receipt",
82
- "value": "#1200"
82
+ "value": "#600001"
83
83
  }
84
84
  ],
85
85
  "data": {
@@ -127,7 +127,7 @@
127
127
  "slug": "biowaste",
128
128
  "symbol": "C-BIOW",
129
129
  "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
130
- "external_url": "https://explore.carrot.eco/credit/9f3c4556-fg90-5ef8-9e06-8d925e6d9bg0",
130
+ "external_url": "https://explore.carrot.eco/credit/e710790f-5909-4a54-ab89-6a59819472ee",
131
131
  "ipfs_uri": "ipfs://bafybeicnuw2ytgukpr5uzmdyt6gdsbkq2xvula4odrqpnbx2ens4qfoywm",
132
132
  "smart_contract_address": "0xfedcba0987654321fedcba0987654321fedcba09"
133
133
  }
@@ -135,7 +135,7 @@
135
135
  "certificates": [
136
136
  {
137
137
  "type": "GasID",
138
- "token_id": "456",
138
+ "token_id": "200001",
139
139
  "total_amount": 10,
140
140
  "credit_slug": "carbon-methane",
141
141
  "external_id": "d2a7f8e4-9c61-4e35-b8f2-a5c9e7d1b4f6",
@@ -150,7 +150,7 @@
150
150
  }
151
151
  ],
152
152
  "mass_id": {
153
- "token_id": "1034",
153
+ "token_id": "100001",
154
154
  "external_id": "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
155
155
  "external_url": "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
156
156
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
@@ -159,7 +159,7 @@
159
159
  },
160
160
  {
161
161
  "type": "RecycledID",
162
- "token_id": "789",
162
+ "token_id": "300001",
163
163
  "total_amount": 6,
164
164
  "credit_slug": "biowaste",
165
165
  "external_id": "f47ac10b-58cc-4372-a567-0e02b2c3d489",
@@ -174,7 +174,7 @@
174
174
  }
175
175
  ],
176
176
  "mass_id": {
177
- "token_id": "1034",
177
+ "token_id": "100001",
178
178
  "external_id": "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
179
179
  "external_url": "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
180
180
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
@@ -198,7 +198,7 @@
198
198
  }
199
199
  ],
200
200
  "mass_id": {
201
- "token_id": "1034",
201
+ "token_id": "100001",
202
202
  "external_id": "ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
203
203
  "external_url": "https://explore.carrot.eco/document/ad44dd3f-f176-4b98-bf78-5ee6e77d0530",
204
204
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
@@ -207,7 +207,7 @@
207
207
  }
208
208
  ],
209
209
  "retirement_receipt": {
210
- "token_id": "1200",
210
+ "token_id": "600001",
211
211
  "external_id": "b2c3d4e5-f6a7-4c89-8a01-234567890abc",
212
212
  "external_url": "https://explore.carrot.eco/document/b2c3d4e5-f6a7-4c89-8a01-234567890abc",
213
213
  "ipfs_uri": "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
@@ -25,7 +25,7 @@
25
25
  "type": "string",
26
26
  "const": "CreditPurchaseReceipt",
27
27
  "title": "CreditPurchaseReceipt Schema Type",
28
- "description": "Schema type identifier for this record"
28
+ "description": "Discriminator value identifying this record as a CreditPurchaseReceipt transaction proof"
29
29
  },
30
30
  "version": {
31
31
  "type": "string",
@@ -74,7 +74,7 @@
74
74
  "format": "uuid",
75
75
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
76
76
  "title": "External ID",
77
- "description": "UUID identifier for external system references",
77
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
78
78
  "examples": [
79
79
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
80
80
  ]
@@ -173,7 +173,7 @@
173
173
  "minimum": 1,
174
174
  "maximum": 9007199254740991,
175
175
  "title": "Total Certificates",
176
- "description": "Total number of certificates represented in the receipt",
176
+ "description": "Total number of certificates (GasID or RecycledID) included in this receipt",
177
177
  "examples": [
178
178
  1,
179
179
  123,
@@ -184,7 +184,7 @@
184
184
  "type": "number",
185
185
  "minimum": 0,
186
186
  "title": "Total Amount (USDC)",
187
- "description": "Total amount paid in USDC for the purchase",
187
+ "description": "Total amount paid in USDC stablecoin for the credit purchase",
188
188
  "examples": [
189
189
  0,
190
190
  100.5,
@@ -196,11 +196,11 @@
196
196
  "type": "number",
197
197
  "minimum": 0,
198
198
  "title": "Total Credits",
199
- "description": "Total amount of credits purchased",
199
+ "description": "Total number of environmental impact credits purchased in this transaction",
200
200
  "examples": [
201
- 0,
202
- 45.2,
203
- 72.5
201
+ 1.5,
202
+ 100,
203
+ 2500.75
204
204
  ]
205
205
  },
206
206
  "purchased_at": {
@@ -222,7 +222,7 @@
222
222
  ],
223
223
  "additionalProperties": false,
224
224
  "title": "Credit Purchase Receipt Summary",
225
- "description": "Summary totals for the credit purchase including amounts and collections represented"
225
+ "description": "Summary totals for the credit purchase including payment amount, credit quantity, certificate count, and timestamp"
226
226
  },
227
227
  "buyer": {
228
228
  "type": "object",
@@ -254,7 +254,7 @@
254
254
  "minLength": 1,
255
255
  "maxLength": 100,
256
256
  "title": "Identity Name",
257
- "description": "Display name for the participant",
257
+ "description": "Display name of the buyer or beneficiary on the receipt",
258
258
  "examples": [
259
259
  "EcoTech Solutions Inc.",
260
260
  "Climate Action Corp"
@@ -265,7 +265,7 @@
265
265
  "format": "uuid",
266
266
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
267
267
  "title": "Identity External ID",
268
- "description": "External identifier for the participant",
268
+ "description": "Unique identifier for the buyer or beneficiary in the Carrot platform",
269
269
  "examples": [
270
270
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
271
271
  ]
@@ -274,7 +274,7 @@
274
274
  "type": "string",
275
275
  "format": "uri",
276
276
  "title": "Identity External URL",
277
- "description": "External URL for the participant profile",
277
+ "description": "Link to the buyer or beneficiary profile page on the Carrot platform",
278
278
  "examples": [
279
279
  "https://explore.carrot.eco/",
280
280
  "https://whitepaper.carrot.eco/"
@@ -288,7 +288,7 @@
288
288
  ],
289
289
  "additionalProperties": false,
290
290
  "title": "Identity",
291
- "description": "Participant identity information"
291
+ "description": "Identity information for the buyer or beneficiary associated with this receipt"
292
292
  }
293
293
  },
294
294
  "required": [
@@ -313,7 +313,7 @@
313
313
  "bold-brazil"
314
314
  ],
315
315
  "title": "Collection Slug",
316
- "description": "URL-friendly identifier for a collection",
316
+ "description": "URL-friendly identifier for an environmental credit collection, used in URIs and API references",
317
317
  "examples": [
318
318
  "bold-cold-start-carazinho",
319
319
  "bold-brazil"
@@ -324,7 +324,7 @@
324
324
  "format": "uuid",
325
325
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
326
326
  "title": "Collection External ID",
327
- "description": "External identifier for the collection",
327
+ "description": "Unique identifier for the collection in the Carrot platform",
328
328
  "examples": [
329
329
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
330
330
  ]
@@ -338,7 +338,7 @@
338
338
  "BOLD Brazil"
339
339
  ],
340
340
  "title": "Collection Name",
341
- "description": "Display name of the collection",
341
+ "description": "Human-readable display name for the environmental credit collection",
342
342
  "examples": [
343
343
  "BOLD Cold Start - Carazinho",
344
344
  "BOLD Brazil"
@@ -348,7 +348,7 @@
348
348
  "type": "string",
349
349
  "format": "uri",
350
350
  "title": "Collection External URL",
351
- "description": "External URL for the collection",
351
+ "description": "Link to the collection page on the Carrot platform",
352
352
  "examples": [
353
353
  "https://explore.carrot.eco/",
354
354
  "https://whitepaper.carrot.eco/"
@@ -359,7 +359,7 @@
359
359
  "minLength": 1,
360
360
  "pattern": "^ipfs:\\/\\/(?:Qm[1-9A-HJ-NP-Za-km-z]{44}|[bB][a-z2-7]{58,}|[zZ][1-9A-HJ-NP-Za-km-z]{48,})(?:\\/[^\\s]*)?$",
361
361
  "title": "Collection IPFS URI",
362
- "description": "IPFS URI for the collection metadata",
362
+ "description": "IPFS URI pointing to the immutable collection metadata record",
363
363
  "examples": [
364
364
  "ipfs://bafybeigdyrztvzl5cceubvaxob7iqh6f3f7s36c74ojav2xsz2uib2g3vm",
365
365
  "ipfs://bafybeihdwdcefgh4dqkjv67uzcmw7ojee6xedzdetojuzjevtenxquvyku"
@@ -378,7 +378,7 @@
378
378
  "description": "Collection included in the purchase"
379
379
  },
380
380
  "title": "Collections",
381
- "description": "Collections included in the purchase"
381
+ "description": "Impact collections referenced by this purchase, each identified by a unique slug"
382
382
  },
383
383
  "credits": {
384
384
  "minItems": 1,
@@ -391,7 +391,7 @@
391
391
  "format": "uuid",
392
392
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
393
393
  "title": "External ID",
394
- "description": "UUID identifier for external system references",
394
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
395
395
  "examples": [
396
396
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
397
397
  ]
@@ -466,7 +466,7 @@
466
466
  "description": "Credit token included in the purchase"
467
467
  },
468
468
  "title": "Credits",
469
- "description": "Credits included in the purchase"
469
+ "description": "Credit token types involved in this purchase, each identified by a unique slug and symbol"
470
470
  },
471
471
  "certificates": {
472
472
  "minItems": 1,
@@ -479,7 +479,7 @@
479
479
  "format": "uuid",
480
480
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
481
481
  "title": "External ID",
482
- "description": "UUID identifier for external system references",
482
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
483
483
  "examples": [
484
484
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
485
485
  ]
@@ -532,7 +532,7 @@
532
532
  "RecycledID"
533
533
  ],
534
534
  "title": "Certificate Type",
535
- "description": "Type of certificate (e.g., GasID, RecycledID)",
535
+ "description": "Type of certificate GasID for methane prevention, RecycledID for waste recycling",
536
536
  "examples": [
537
537
  "GasID",
538
538
  "RecycledID"
@@ -544,9 +544,9 @@
544
544
  "title": "Certificate Total Amount",
545
545
  "description": "Total credits available in this certificate",
546
546
  "examples": [
547
- 0,
548
- 45.2,
549
- 72.5
547
+ 1.5,
548
+ 100,
549
+ 2500.75
550
550
  ]
551
551
  },
552
552
  "mass_id": {
@@ -557,7 +557,7 @@
557
557
  "format": "uuid",
558
558
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
559
559
  "title": "External ID",
560
- "description": "UUID identifier for external system references",
560
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
561
561
  "examples": [
562
562
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
563
563
  ]
@@ -643,7 +643,7 @@
643
643
  "bold-brazil"
644
644
  ],
645
645
  "title": "Collection Slug",
646
- "description": "Slug of the collection",
646
+ "description": "URL-friendly identifier of the collection this certificate belongs to",
647
647
  "examples": [
648
648
  "bold-cold-start-carazinho",
649
649
  "bold-brazil"
@@ -652,12 +652,12 @@
652
652
  "purchased_amount": {
653
653
  "type": "number",
654
654
  "minimum": 0,
655
- "title": "Collection Purchased Amount",
656
- "description": "Credits purchased from this collection for this certificate",
655
+ "title": "Purchased Amount",
656
+ "description": "Number of credits purchased from this collection for this certificate",
657
657
  "examples": [
658
- 0,
659
- 45.2,
660
- 72.5
658
+ 1.5,
659
+ 100,
660
+ 2500.75
661
661
  ]
662
662
  },
663
663
  "retired_amount": {
@@ -666,9 +666,9 @@
666
666
  "title": "Collection Retired Amount",
667
667
  "description": "Credits retired from this collection for this certificate (0 if none)",
668
668
  "examples": [
669
- 0,
670
- 45.2,
671
- 72.5
669
+ 1.5,
670
+ 100,
671
+ 2500.75
672
672
  ]
673
673
  }
674
674
  },
@@ -702,7 +702,7 @@
702
702
  "description": "Certificate associated with the purchase"
703
703
  },
704
704
  "title": "Certificates",
705
- "description": "Certificates involved in the purchase"
705
+ "description": "Environmental certificates allocated in this purchase, each linking a credit type to collection-level purchased and retired amounts"
706
706
  },
707
707
  "retirement_receipt": {
708
708
  "type": "object",
@@ -712,7 +712,7 @@
712
712
  "format": "uuid",
713
713
  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
714
714
  "title": "External ID",
715
- "description": "UUID identifier for external system references",
715
+ "description": "UUID v4 identifier linking this IPFS record to its counterpart in the Carrot platform and other consuming systems",
716
716
  "examples": [
717
717
  "ad44dd3f-f176-4b98-bf78-5ee6e77d0530"
718
718
  ]
@@ -938,8 +938,8 @@
938
938
  "title": "Link Label",
939
939
  "description": "Display name for the external link",
940
940
  "examples": [
941
- "Example text",
942
- "Sample value"
941
+ "example-value",
942
+ "Hello World"
943
943
  ]
944
944
  },
945
945
  "url": {
@@ -987,9 +987,9 @@
987
987
  "title": "Total Credits Purchased",
988
988
  "description": "Total number of credits purchased across all tokens",
989
989
  "examples": [
990
- 0,
991
- 45.2,
992
- 72.5
990
+ 1.5,
991
+ 100,
992
+ 2500.75
993
993
  ]
994
994
  },
995
995
  "display_type": {
@@ -1030,9 +1030,9 @@
1030
1030
  "title": "Total Amount (USDC)",
1031
1031
  "description": "Total USDC amount paid for the purchase",
1032
1032
  "examples": [
1033
- 0,
1034
- 45.2,
1035
- 72.5
1033
+ 1.5,
1034
+ 100,
1035
+ 2500.75
1036
1036
  ]
1037
1037
  },
1038
1038
  "display_type": {
@@ -1206,10 +1206,10 @@
1206
1206
  "title": "Retirement Receipt Token ID",
1207
1207
  "description": "Token ID of the retirement receipt NFT as #<token_id> (if retirement occurred)",
1208
1208
  "examples": [
1209
- "Example text",
1210
- "Sample value"
1209
+ "#456789",
1210
+ "#1000000"
1211
1211
  ],
1212
- "example": "#123"
1212
+ "example": "#456789"
1213
1213
  },
1214
1214
  "display_type": {
1215
1215
  "title": "Display Type",
@@ -1264,9 +1264,9 @@
1264
1264
  "title": "Credit Amount",
1265
1265
  "description": "Amount of credits purchased for the token symbol",
1266
1266
  "examples": [
1267
- 0,
1268
- 45.2,
1269
- 72.5
1267
+ 1.5,
1268
+ 100,
1269
+ 2500.75
1270
1270
  ]
1271
1271
  },
1272
1272
  "display_type": {
@@ -1319,7 +1319,7 @@
1319
1319
  ],
1320
1320
  "additionalProperties": false,
1321
1321
  "title": "CreditPurchaseReceipt NFT IPFS Record",
1322
- "description": "Complete CreditPurchaseReceipt NFT IPFS record including attributes and credit purchase data",
1323
- "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.2.4/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
1324
- "version": "0.2.4"
1325
- }
1322
+ "description": "Complete CreditPurchaseReceipt NFT IPFS record including purchase summary, buyer details, credit breakdowns, certificate allocations, and NFT display attributes",
1323
+ "$id": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/tags/0.3.0/schemas/ipfs/credit-purchase-receipt/credit-purchase-receipt.schema.json",
1324
+ "version": "0.3.0"
1325
+ }