-
Notifications
You must be signed in to change notification settings - Fork 158
/
assetlist.schema.json
414 lines (414 loc) · 13.4 KB
/
assetlist.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
{
"$schema": "https://json-schema.org/draft-07/schema",
"title": "Asset Lists",
"description": "Asset lists are a similar mechanism to allow frontends and other UIs to fetch metadata associated with Cosmos SDK denoms, especially for assets sent over IBC.",
"type": "object",
"required": ["chain_name", "assets"],
"properties": {
"$schema": {
"type": "string",
"pattern": "^(\\.\\./)+assetlist\\.schema\\.json$"
},
"chain_name": {
"type": "string"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/$defs/asset"
},
"minContains": 1
}
},
"additionalProperties": false,
"$defs": {
"asset": {
"type": "object",
"required": ["denom_units", "base", "display", "name", "symbol"],
"properties": {
"description": {
"type": "string",
"description": "[OPTIONAL] A short description of the asset"
},
"denom_units": {
"type": "array",
"items": {
"$ref": "#/$defs/denom_unit"
},
"minContains": 1
},
"type_asset": {
"type": "string",
"enum": ["sdk.coin", "cw20", "erc20", "ics20", "snip20", "snip25"],
"default": "sdk.coin",
"description": "[OPTIONAL] The potential options for type of asset. By default, assumes sdk.coin"
},
"address": {
"type": "string",
"description": "[OPTIONAL] The address of the asset. Only required for type_asset : cw20, snip20"
},
"base": {
"type": "string",
"description": "The base unit of the asset. Must be in denom_units."
},
"name": {
"type": "string",
"description": "The project name of the asset. For example Bitcoin.",
"maxLength": 42
},
"display": {
"type": "string",
"description": "The human friendly unit of the asset. Must be in denom_units."
},
"symbol": {
"type": "string",
"description": "The symbol of an asset. For example BTC."
},
"traces": {
"type": "array",
"description": "The origin of the asset, starting with the index, and capturing all transitions in form and location.",
"items": {
"anyOf": [
{
"$ref": "#/$defs/ibc_transition"
},
{
"$ref": "#/$defs/ibc_cw20_transition"
},
{
"$ref": "#/$defs/non_ibc_transition"
},
{
"$ref": "#/$defs/op_transition"
}
]
},
"minContains": 1
},
"ibc": {
"type": "object",
"description": "[OPTIONAL] IBC Channel between src and dst between chain",
"required": ["source_channel", "dst_channel", "source_denom"],
"properties": {
"source_channel": {
"type": "string"
},
"dst_channel": {
"type": "string"
},
"source_denom": {
"type": "string"
}
},
"additionalProperties": false
},
"logo_URIs": {
"type": "object",
"properties": {
"png": {
"type": "string",
"format": "uri-reference",
"pattern": "^https://.+\\.png$"
},
"svg": {
"type": "string",
"format": "uri-reference",
"pattern": "^https://.+\\.svg$"
}
},
"additionalProperties": false
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_sync": {
"$ref": "#/$defs/pointer"
},
"png": {
"type": "string",
"format": "uri-reference",
"pattern": "^https://.+\\.png$"
},
"svg": {
"type": "string",
"format": "uri-reference",
"pattern": "^https://.+\\.svg$"
},
"theme": {
"type": "object",
"properties": {
"primary_color_hex": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"circle": {
"type": "boolean"
},
"dark_mode": {
"type": "boolean"
}
},
"minProperties": 1,
"additionalProperties": false
}
},
"additionalProperties": false
},
"minItems": 1
},
"coingecko_id": {
"type": "string",
"description": "[OPTIONAL] The coingecko id to fetch asset data from coingecko v3 api. See https://api.coingecko.com/api/v3/coins/list"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"minContains": 1,
"maxContains": 20
}
},
"additionalProperties": false,
"if": {
"required": ["type_asset"],
"properties": {
"type_asset": {
"enum": ["erc20", "cw20", "snip20"]
}
}
},
"then": {
"required": ["address"]
}
},
"denom_unit": {
"type": "object",
"required": ["denom", "exponent"],
"properties": {
"denom": {
"type": "string"
},
"exponent": {
"type": "integer"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"minContains": 1
}
},
"additionalProperties": false
},
"pointer": {
"type": "object",
"description": "The (primary) key used to identify an object within the Chain Registry.",
"required": ["chain_name"],
"properties": {
"chain_name": {
"type": "string",
"description": "The chain name or platform from which the object resides. E.g., 'cosmoshub', 'ethereum', 'forex', or 'nasdaq'"
},
"base_denom": {
"type": "string",
"description": "The base denom of the asset from which the object originates. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform."
}
},
"additionalProperties": false
},
"ibc_transition": {
"type": "object",
"required": ["type", "counterparty", "chain"],
"properties": {
"type": {
"type": "string",
"enum": ["ibc"]
},
"counterparty": {
"type": "object",
"required": ["chain_name", "base_denom", "channel_id"],
"properties": {
"chain_name": {
"type": "string",
"description": "The name of the counterparty chain. (must match exactly the chain name used in the Chain Registry)"
},
"base_denom": {
"type": "string",
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform."
},
"channel_id": {
"type": "string",
"pattern": "^channel-\\d+$",
"description": "The counterparty IBC transfer channel(, e.g., 'channel-1')."
}
},
"additionalProperties": false
},
"chain": {
"type": "object",
"required": ["channel_id", "path"],
"properties": {
"channel_id": {
"type": "string",
"pattern": "^channel-\\d+$",
"description": "The chain's IBC transfer channel(, e.g., 'channel-1')."
},
"path": {
"type": "string",
"description": "The port/channel/denom input string that generates the 'ibc/...' denom."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"ibc_cw20_transition": {
"type": "object",
"required": ["type", "counterparty", "chain"],
"properties": {
"type": {
"type": "string",
"enum": ["ibc-cw20"]
},
"counterparty": {
"type": "object",
"required": ["chain_name", "base_denom", "port", "channel_id"],
"properties": {
"chain_name": {
"type": "string",
"description": "The name of the counterparty chain. (must match exactly the chain name used in the Chain Registry)"
},
"base_denom": {
"type": "string",
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform."
},
"port": {
"type": "string",
"description": "The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for outgoing cw20 transfers."
},
"channel_id": {
"type": "string",
"pattern": "^channel-\\d+$",
"description": "The counterparty IBC transfer channel(, e.g., 'channel-1')."
}
},
"additionalProperties": false
},
"chain": {
"type": "object",
"required": ["port", "channel_id", "path"],
"properties": {
"port": {
"type": "string",
"description": "The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for outgoing cw20 transfers."
},
"channel_id": {
"type": "string",
"pattern": "^channel-\\d+$",
"description": "The chain's IBC transfer channel(, e.g., 'channel-1')."
},
"path": {
"type": "string",
"description": "The port/channel/denom input string that generates the 'ibc/...' denom."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"op_transition": {
"type": "object",
"required": ["type", "counterparty", "chain"],
"properties": {
"type": {
"type": "string",
"enum": ["op"]
},
"counterparty": {
"type": "object",
"required": ["chain_name", "base_denom"],
"properties": {
"chain_name": {
"type": "string",
"description": "The name of the counterparty chain. (must match exactly the chain name used in the Chain Registry)"
},
"base_denom": {
"type": "string",
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform."
}
},
"additionalProperties": false
},
"chain": {
"type": "object",
"required": ["bridge_id"],
"properties": {
"bridge_id": {
"type": "string",
"description": "The identifier of the OPinit bridge used to transfer assets between L1 and L2."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"non_ibc_transition": {
"type": "object",
"required": ["type", "counterparty", "provider"],
"properties": {
"type": {
"type": "string",
"enum": [
"bridge",
"liquid-stake",
"synthetic",
"wrapped",
"additional-mintage",
"test-mintage"
]
},
"counterparty": {
"type": "object",
"required": ["chain_name", "base_denom"],
"properties": {
"chain_name": {
"type": "string",
"description": "The chain or platform from which the asset originates. E.g., 'cosmoshub', 'ethereum', 'forex', or 'nasdaq'"
},
"base_denom": {
"type": "string"
},
"contract": {
"type": "string",
"description": "The contract address where the transition takes place, where applicable. E.g., The Ethereum contract that locks up the asset while it's minted on another chain."
}
},
"additionalProperties": false
},
"chain": {
"type": "object",
"required": ["contract"],
"properties": {
"contract": {
"type": "string",
"description": "The contract address where the transition takes place, where applicable. E.g., The Ethereum contract that locks up the asset while it's minted on another chain."
}
},
"additionalProperties": false
},
"provider": {
"type": "string",
"description": "The entity offering the service. E.g., 'Gravity Bridge' [Network] or 'Tether' [Company]."
}
},
"additionalProperties": false
}
}
}