@carrot-foundation/schemas 0.1.36 → 0.1.38

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 (42) hide show
  1. package/dist/index.cjs +1778 -36
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +1510 -14
  4. package/dist/index.d.ts +1510 -14
  5. package/dist/index.js +1735 -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 +306 -32
  10. package/schemas/ipfs/credit/credit.example.json +1 -0
  11. package/schemas/ipfs/credit/credit.schema.json +327 -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 +1772 -0
  14. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.example.json +280 -0
  15. package/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json +1704 -0
  16. package/schemas/ipfs/gas-id/gas-id.schema.json +7 -6
  17. package/schemas/ipfs/mass-id/mass-id.schema.json +7 -6
  18. package/schemas/ipfs/mass-id-audit/mass-id-audit.example.json +30 -29
  19. package/schemas/ipfs/mass-id-audit/mass-id-audit.schema.json +637 -15
  20. package/schemas/ipfs/methodology/methodology.example.json +27 -26
  21. package/schemas/ipfs/methodology/methodology.schema.json +458 -15
  22. package/schemas/ipfs/recycled-id/recycled-id.schema.json +7 -6
  23. package/schemas/ipfs/gas-id/gas-id.attributes.schema.json +0 -219
  24. package/schemas/ipfs/gas-id/gas-id.data.schema.json +0 -120
  25. package/schemas/ipfs/mass-id-audit/mass-id-audit.data.schema.json +0 -130
  26. package/schemas/ipfs/methodology/methodology.data.schema.json +0 -121
  27. package/schemas/ipfs/purchase-id/purchase-id.attributes.schema.json +0 -91
  28. package/schemas/ipfs/purchase-id/purchase-id.data.schema.json +0 -337
  29. package/schemas/ipfs/purchase-id/purchase-id.example.json +0 -224
  30. package/schemas/ipfs/purchase-id/purchase-id.schema.json +0 -29
  31. package/schemas/ipfs/recycled-id/recycled-id.attributes.schema.json +0 -202
  32. package/schemas/ipfs/recycled-id/recycled-id.data.schema.json +0 -63
  33. package/schemas/ipfs/shared/base/base.schema.json +0 -163
  34. package/schemas/ipfs/shared/certificate/certificate.schema.json +0 -145
  35. package/schemas/ipfs/shared/definitions/definitions.schema.json +0 -255
  36. package/schemas/ipfs/shared/entities/location/location.schema.json +0 -90
  37. package/schemas/ipfs/shared/entities/participant/participant.schema.json +0 -28
  38. package/schemas/ipfs/shared/nft/nft.schema.json +0 -182
  39. package/schemas/ipfs/shared/references/audit-reference/audit-reference.schema.json +0 -42
  40. package/schemas/ipfs/shared/references/gas-id-reference/gas-id-reference.schema.json +0 -27
  41. package/schemas/ipfs/shared/references/mass-id-reference/mass-id-reference.schema.json +0 -27
  42. package/schemas/ipfs/shared/references/methodology-reference/methodology-reference.schema.json +0 -34
@@ -0,0 +1,280 @@
1
+ {
2
+ "$schema": "https://raw.githubusercontent.com/carrot-foundation/schemas/refs/heads/main/schemas/ipfs/credit-retirement-receipt/credit-retirement-receipt.schema.json",
3
+ "schema": {
4
+ "hash": "0x9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
5
+ "type": "CreditRetirementReceipt",
6
+ "version": "0.1.0"
7
+ },
8
+ "environment": {
9
+ "blockchain_network": "mainnet",
10
+ "deployment": "production",
11
+ "data_set_name": "TEST"
12
+ },
13
+ "blockchain": {
14
+ "smart_contract_address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
15
+ "chain_id": 137,
16
+ "network_name": "Polygon",
17
+ "token_id": "1245"
18
+ },
19
+ "created_at": "2025-01-20T14:45:30.000Z",
20
+ "external_id": "b2c3d4e5-f6a7-4c89-8a01-234567890abc",
21
+ "external_url": "https://explore.carrot.eco/document/b2c3d4e5-f6a7-4c89-8a01-234567890abc",
22
+ "content_hash": "9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658",
23
+ "creator": {
24
+ "name": "Carrot Foundation",
25
+ "id": "7f051e36-490c-420d-a59d-3bf73cc338af"
26
+ },
27
+ "name": "Credit Retirement Receipt #1245 • 10.5 Credits Retired",
28
+ "short_name": "Credit Retirement Receipt #1245",
29
+ "description": "Permanent proof of credit retirement: 10.5 credits (C-CARB and C-BIOW) retired by EcoTech Solutions Inc. on behalf of beneficiary Climate Action Corp, from 3 certificates across 2 collections.",
30
+ "image": "ipfs://QmRetirementReceiptHash1245/retirement-receipt.png",
31
+ "background_color": "#1B4332",
32
+ "external_links": [
33
+ {
34
+ "label": "View on Carrot Explorer",
35
+ "url": "https://explore.carrot.eco/document/b2c3d4e5-f6a7-4c89-8a01-234567890abc",
36
+ "description": "Complete retirement details and audit trail"
37
+ },
38
+ {
39
+ "label": "Retirement Certificate",
40
+ "url": "https://explore.carrot.eco/retirement/b2c3d4e5-f6a7-4c89-8a01-234567890abc",
41
+ "description": "Official retirement certificate for compliance reporting"
42
+ }
43
+ ],
44
+ "attributes": [
45
+ {
46
+ "trait_type": "C-CARB",
47
+ "value": 6.5,
48
+ "display_type": "number"
49
+ },
50
+ {
51
+ "trait_type": "C-BIOW",
52
+ "value": 4.0,
53
+ "display_type": "number"
54
+ },
55
+ {
56
+ "trait_type": "Total Credits Retired",
57
+ "value": 10.5,
58
+ "display_type": "number"
59
+ },
60
+ {
61
+ "trait_type": "Beneficiary",
62
+ "value": "Climate Action Corp"
63
+ },
64
+ {
65
+ "trait_type": "Credit Holder",
66
+ "value": "EcoTech Solutions Inc."
67
+ },
68
+ {
69
+ "trait_type": "Retirement Date",
70
+ "value": 1737331200000,
71
+ "display_type": "date"
72
+ },
73
+ {
74
+ "trait_type": "Certificates Retired",
75
+ "value": 3,
76
+ "display_type": "number"
77
+ },
78
+ {
79
+ "trait_type": "BOLD Cold Start - Carazinho",
80
+ "value": 6.5,
81
+ "display_type": "number"
82
+ },
83
+ {
84
+ "trait_type": "BOLD Brazil",
85
+ "value": 4.0,
86
+ "display_type": "number"
87
+ }
88
+ ],
89
+ "data": {
90
+ "summary": {
91
+ "total_retirement_amount": 10.5,
92
+ "total_certificates": 3,
93
+ "retirement_date": "2025-01-20",
94
+ "credit_symbols": ["C-CARB", "C-BIOW"],
95
+ "certificate_types": ["GasID", "RecycledID"],
96
+ "collection_slugs": ["bold-cold-start-carazinho", "bold-brazil"]
97
+ },
98
+ "beneficiary": {
99
+ "beneficiary_id": "c3d4e5f6-a7b8-4d12-8b56-789012cdef01",
100
+ "identity": {
101
+ "name": "Climate Action Corp",
102
+ "external_id": "d4e5f6a7-b8c9-4e23-8c67-890123def012",
103
+ "external_url": "https://explore.carrot.eco/participant/climate-action-corp-78901"
104
+ }
105
+ },
106
+ "credit_holder": {
107
+ "wallet_address": "0x1234567890abcdef1234567890abcdef12345678",
108
+ "identity": {
109
+ "name": "EcoTech Solutions Inc.",
110
+ "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
111
+ "external_url": "https://explore.carrot.eco/participant/ecotech-solutions-inc-12345"
112
+ }
113
+ },
114
+ "collections": [
115
+ {
116
+ "slug": "bold-cold-start-carazinho",
117
+ "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
118
+ "name": "BOLD Cold Start - Carazinho",
119
+ "external_url": "https://explore.carrot.eco/collection/bold-cold-start-carazinho",
120
+ "uri": "ipfs://QmCollectionImageHash/bold-cold-start-carazinho.json",
121
+ "amount": 6.5
122
+ },
123
+ {
124
+ "slug": "bold-brazil",
125
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
126
+ "name": "BOLD Brazil",
127
+ "external_url": "https://explore.carrot.eco/collection/bold-brazil",
128
+ "uri": "ipfs://QmCollectionProfHash/bold-brazil.json",
129
+ "amount": 4.0
130
+ }
131
+ ],
132
+ "credits": [
133
+ {
134
+ "slug": "carbon",
135
+ "symbol": "C-CARB",
136
+ "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
137
+ "external_url": "https://explore.carrot.eco/credit/8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
138
+ "uri": "ipfs://QmCreditHash/c-carb.json",
139
+ "smart_contract": {
140
+ "address": "0xabcdef1234567890abcdef1234567890abcdef12",
141
+ "chain_id": 137,
142
+ "network_name": "Polygon"
143
+ },
144
+ "amount": 6.5
145
+ },
146
+ {
147
+ "slug": "organic",
148
+ "symbol": "C-BIOW",
149
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
150
+ "external_url": "https://explore.carrot.eco/credit/9f3c4556-fg90-5ef8-9e06-8d925e6d9bg0",
151
+ "uri": "ipfs://QmCreditBiowHash/c-biow.json",
152
+ "smart_contract": {
153
+ "address": "0xfedcba0987654321fedcba0987654321fedcba09",
154
+ "chain_id": 137,
155
+ "network_name": "Polygon"
156
+ },
157
+ "amount": 4.0
158
+ }
159
+ ],
160
+ "certificates": [
161
+ {
162
+ "token_id": "456",
163
+ "type": "GasID",
164
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
165
+ "external_url": "https://explore.carrot.eco/document/f47ac10b-58cc-4372-a567-0e02b2c3d479",
166
+ "uri": "ipfs://QmGasIdHash456/gas-id.json",
167
+ "smart_contract": {
168
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
169
+ "chain_id": 137,
170
+ "network_name": "Polygon"
171
+ },
172
+ "collection_slug": "bold-cold-start-carazinho",
173
+ "total_amount": 10.0,
174
+ "retired_amount": 4.5,
175
+ "credits_retired": [
176
+ {
177
+ "credit_symbol": "C-CARB",
178
+ "credit_slug": "carbon",
179
+ "amount": 4.5,
180
+ "external_id": "8f2c3445-ef89-4de7-8d95-7c814d5c8af9",
181
+ "external_url": "https://explore.carrot.eco/credit-retirement/credit-retired-456-c-carb"
182
+ }
183
+ ],
184
+ "mass_id": {
185
+ "token_id": "123",
186
+ "external_id": "6f520d88-864d-432d-bf9f-5c3166c4818f",
187
+ "external_url": "https://explore.carrot.eco/document/6f520d88-864d-432d-bf9f-5c3166c4818f",
188
+ "uri": "ipfs://QmYx8FdKl2mN9pQ7rS6tV8wB3cE4fG5hI9jK0lM1nO2pQ3r/mass-id.json",
189
+ "smart_contract": {
190
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
191
+ "chain_id": 137,
192
+ "network_name": "Polygon"
193
+ }
194
+ }
195
+ },
196
+ {
197
+ "token_id": "789",
198
+ "type": "RecycledID",
199
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
200
+ "external_url": "https://explore.carrot.eco/document/r47ac10b-58cc-4372-a567-0e02b2c3d999",
201
+ "uri": "ipfs://QmRecycledIdHash789/recycled-id.json",
202
+ "smart_contract": {
203
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
204
+ "chain_id": 137,
205
+ "network_name": "Polygon"
206
+ },
207
+ "collection_slug": "bold-cold-start-carazinho",
208
+ "total_amount": 5.0,
209
+ "retired_amount": 2.0,
210
+ "credits_retired": [
211
+ {
212
+ "credit_symbol": "C-CARB",
213
+ "credit_slug": "carbon",
214
+ "amount": 2.0,
215
+ "external_id": "a1b2c3d4-e5f6-4a90-8b34-567890abcedf",
216
+ "external_url": "https://explore.carrot.eco/credit-retirement/credit-retired-789-c-carb"
217
+ }
218
+ ],
219
+ "mass_id": {
220
+ "token_id": "124",
221
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
222
+ "external_url": "https://explore.carrot.eco/document/7f520d88-864d-432d-bf9f-5c3166c4888f",
223
+ "uri": "ipfs://QmMassIdHash124/mass-id.json",
224
+ "smart_contract": {
225
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
226
+ "chain_id": 137,
227
+ "network_name": "Polygon"
228
+ }
229
+ }
230
+ },
231
+ {
232
+ "token_id": "790",
233
+ "type": "RecycledID",
234
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
235
+ "external_url": "https://explore.carrot.eco/document/r47ac10b-58cc-4372-a567-0e02b2c3d999",
236
+ "uri": "ipfs://QmRecycledIdHash789/recycled-id.json",
237
+ "smart_contract": {
238
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
239
+ "chain_id": 137,
240
+ "network_name": "Polygon"
241
+ },
242
+ "collection_slug": "bold-brazil",
243
+ "total_amount": 8.0,
244
+ "retired_amount": 4.0,
245
+ "credits_retired": [
246
+ {
247
+ "credit_symbol": "C-BIOW",
248
+ "credit_slug": "organic",
249
+ "amount": 4.0,
250
+ "external_id": "b2c3d4e5-f6a7-4b01-8c45-678901bcdef1",
251
+ "external_url": "https://explore.carrot.eco/credit-retirement/credit-retired-790-c-biow"
252
+ }
253
+ ],
254
+ "mass_id": {
255
+ "token_id": "124",
256
+ "external_id": "e710790f-5909-4a54-ab89-6a59819472ee",
257
+ "external_url": "https://explore.carrot.eco/document/7f520d88-864d-432d-bf9f-5c3166c4888f",
258
+ "uri": "ipfs://QmMassIdHash124/mass-id.json",
259
+ "smart_contract": {
260
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
261
+ "chain_id": 137,
262
+ "network_name": "Polygon"
263
+ }
264
+ }
265
+ }
266
+ ],
267
+ "purchase_receipt": {
268
+ "token_id": "789",
269
+ "external_id": "a1b2c3d4-e5f6-4b90-8c34-567890abcdef",
270
+ "external_url": "https://explore.carrot.eco/document/a1b2c3d4-e5f6-4b90-8c34-567890abcdef",
271
+ "uri": "ipfs://QmPurchaseIdHash789/credit-purchase-receipt.json",
272
+ "smart_contract": {
273
+ "address": "0x742d35cc6634c0532925a3b8d8b5c2d4c7f8e1a9",
274
+ "chain_id": 137,
275
+ "network_name": "Polygon"
276
+ }
277
+ }
278
+ }
279
+ }
280
+