@reserve-protocol/dtf-catalog 0.0.1

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.
package/README.md ADDED
@@ -0,0 +1,65 @@
1
+ # @reserve-protocol/dtf-catalog
2
+
3
+ Curated catalog for DTFs.
4
+
5
+ This replaces the old `@reserve-protocol/rtokens` naming. RTokens are now called Yield DTFs.
6
+
7
+ ## Usage
8
+
9
+ ```ts
10
+ import dtfs, { indexDtfs, yieldDtfs } from "@reserve-protocol/dtf-catalog";
11
+ import type { CatalogIndexDTF, CatalogYieldDTF } from "@reserve-protocol/dtf-catalog";
12
+
13
+ const baseDtfs = dtfs[8453];
14
+ const baseIndexDtfs = indexDtfs[8453];
15
+ const baseYieldDtfs = yieldDtfs[8453];
16
+ ```
17
+
18
+ The package follows the old `@reserve-protocol/rtokens` shape:
19
+
20
+ ```ts
21
+ {
22
+ [chainId]: {
23
+ [tokenAddress]: {
24
+ address,
25
+ name,
26
+ symbol,
27
+ decimals,
28
+ logo,
29
+ status
30
+ }
31
+ }
32
+ }
33
+ ```
34
+
35
+ The raw JSON files are also exported:
36
+
37
+ ```ts
38
+ import baseIndexDtfs from "@reserve-protocol/dtf-catalog/index-dtf/base.json";
39
+ import baseYieldDtfs from "@reserve-protocol/dtf-catalog/yield-dtf/base.json";
40
+ ```
41
+
42
+ Logos live in `images`. Index DTF logos are WebP files, and Yield DTF logos currently keep the legacy SVG files.
43
+
44
+ ## Status
45
+
46
+ - `active`: supported and visible by default.
47
+ - `unsupported`: marked as unsupported in the UI, but not fully deprecated onchain yet.
48
+ - `deprecated`: officially deprecated or paused onchain.
49
+
50
+ The normal lifecycle is:
51
+
52
+ ```text
53
+ active -> unsupported -> deprecated
54
+ ```
55
+
56
+ ## Publishing
57
+
58
+ The package is structured for npm publishing, but `"private": true` is set intentionally while the catalog is still being integrated.
59
+
60
+ To publish later:
61
+
62
+ 1. Remove `"private": true` from `package.json`.
63
+ 2. Set the package version.
64
+ 3. Run `pnpm --filter @reserve-protocol/dtf-catalog build`.
65
+ 4. Publish with public access.
@@ -0,0 +1,443 @@
1
+ //#region src/types.d.ts
2
+ type CatalogYieldDTF = {
3
+ readonly address: `0x${string}`;
4
+ readonly decimals: number;
5
+ readonly logo?: string;
6
+ readonly name: string;
7
+ readonly status: "active" | "unsupported" | "deprecated";
8
+ readonly symbol: string;
9
+ readonly about?: string;
10
+ readonly website?: string;
11
+ readonly governance?: {
12
+ readonly voting?: string;
13
+ readonly discussion?: string;
14
+ };
15
+ readonly support?: {
16
+ readonly email?: string;
17
+ readonly url?: string;
18
+ };
19
+ readonly social?: {
20
+ readonly blog?: string;
21
+ readonly chat?: string;
22
+ readonly facebook?: string;
23
+ readonly forum?: string;
24
+ readonly github?: string;
25
+ readonly gitter?: string;
26
+ readonly instagram?: string;
27
+ readonly linkedin?: string;
28
+ readonly reddit?: string;
29
+ readonly slack?: string;
30
+ readonly telegram?: string;
31
+ readonly twitter?: string;
32
+ readonly youtube?: string;
33
+ };
34
+ };
35
+ type CatalogIndexDTF = CatalogYieldDTF & {
36
+ readonly chainId: 1 | 8453 | 56;
37
+ readonly tags?: readonly string[];
38
+ };
39
+ //#endregion
40
+ //#region index-dtf/base.json.d.ts
41
+ declare const _exports: {
42
+ "0x4da9a0f397db1397902070f93a4d6ddbc0e0e6e8": {
43
+ chainId: number;
44
+ address: string;
45
+ name: string;
46
+ symbol: string;
47
+ logo: string;
48
+ decimals: number;
49
+ status: string;
50
+ tags: string[];
51
+ };
52
+ "0xe00cfa595841fb331105b93c19827797c925e3e4": {
53
+ chainId: number;
54
+ address: string;
55
+ name: string;
56
+ symbol: string;
57
+ logo: string;
58
+ decimals: number;
59
+ status: string;
60
+ tags: string[];
61
+ };
62
+ "0x23418de10d422ad71c9d5713a2b8991a9c586443": {
63
+ chainId: number;
64
+ address: string;
65
+ name: string;
66
+ symbol: string;
67
+ logo: string;
68
+ decimals: number;
69
+ status: string;
70
+ tags: string[];
71
+ };
72
+ "0xebcda5b80f62dd4dd2a96357b42bb6facbf30267": {
73
+ chainId: number;
74
+ address: string;
75
+ name: string;
76
+ symbol: string;
77
+ logo: string;
78
+ decimals: number;
79
+ status: string;
80
+ tags: string[];
81
+ };
82
+ "0x44551ca46fa5592bb572e20043f7c3d54c85cad7": {
83
+ chainId: number;
84
+ address: string;
85
+ name: string;
86
+ symbol: string;
87
+ logo: string;
88
+ decimals: number;
89
+ status: string;
90
+ tags: string[];
91
+ };
92
+ "0xe8b46b116d3bdfa787ce9cf3f5acc78dc7ca380e": {
93
+ chainId: number;
94
+ address: string;
95
+ name: string;
96
+ symbol: string;
97
+ logo: string;
98
+ decimals: number;
99
+ status: string;
100
+ tags: string[];
101
+ };
102
+ "0x47686106181b3cefe4eaf94c4c10b48ac750370b": {
103
+ chainId: number;
104
+ address: string;
105
+ name: string;
106
+ symbol: string;
107
+ logo: string;
108
+ decimals: number;
109
+ status: string;
110
+ tags: string[];
111
+ };
112
+ "0xfe45eda533e97198d9f3deeda9ae6c147141f6f9": {
113
+ chainId: number;
114
+ address: string;
115
+ name: string;
116
+ symbol: string;
117
+ logo: string;
118
+ decimals: number;
119
+ status: string;
120
+ tags: string[];
121
+ };
122
+ "0xb8753941196692e322846cfee9c14c97ac81928a": {
123
+ chainId: number;
124
+ address: string;
125
+ name: string;
126
+ symbol: string;
127
+ logo: string;
128
+ decimals: number;
129
+ status: string;
130
+ tags: string[];
131
+ };
132
+ "0xf8ef6e785473e82527908b06023ac3e401ccfdcd": {
133
+ chainId: number;
134
+ address: string;
135
+ name: string;
136
+ symbol: string;
137
+ logo: string;
138
+ decimals: number;
139
+ status: string;
140
+ };
141
+ "0xd600e748c17ca237fcb5967fa13d688aff17be78": {
142
+ chainId: number;
143
+ address: string;
144
+ name: string;
145
+ symbol: string;
146
+ logo: string;
147
+ decimals: number;
148
+ status: string;
149
+ tags: string[];
150
+ };
151
+ "0x89ff8f639d402839205a6bf03cc01bdffa4768b7": {
152
+ chainId: number;
153
+ address: string;
154
+ name: string;
155
+ symbol: string;
156
+ logo: string;
157
+ decimals: number;
158
+ status: string;
159
+ tags: string[];
160
+ };
161
+ "0x160c18476f6f5099f374033fbc695c9234cda495": {
162
+ chainId: number;
163
+ address: string;
164
+ name: string;
165
+ symbol: string;
166
+ logo: string;
167
+ decimals: number;
168
+ status: string;
169
+ tags: string[];
170
+ };
171
+ };
172
+ //#endregion
173
+ //#region index-dtf/bnb.json.d.ts
174
+ declare const _exports$1: {
175
+ "0x2f8a339b5889ffac4c5a956787cda593b3c36867": {
176
+ chainId: number;
177
+ address: string;
178
+ name: string;
179
+ symbol: string;
180
+ logo: string;
181
+ decimals: number;
182
+ status: string;
183
+ tags: string[];
184
+ };
185
+ };
186
+ //#endregion
187
+ //#region index-dtf/mainnet.json.d.ts
188
+ declare const _exports$2: {
189
+ "0x323c03c48660fe31186fa82c289b0766d331ce21": {
190
+ chainId: number;
191
+ address: string;
192
+ name: string;
193
+ symbol: string;
194
+ logo: string;
195
+ decimals: number;
196
+ status: string;
197
+ tags: string[];
198
+ };
199
+ "0x4e3b170dcbe704b248df5f56d488114ace01b1c5": {
200
+ chainId: number;
201
+ address: string;
202
+ name: string;
203
+ symbol: string;
204
+ logo: string;
205
+ decimals: number;
206
+ status: string;
207
+ tags: string[];
208
+ };
209
+ "0xf91384484f4717314798e8975bcd904a35fc2bf1": {
210
+ chainId: number;
211
+ address: string;
212
+ name: string;
213
+ symbol: string;
214
+ logo: string;
215
+ decimals: number;
216
+ status: string;
217
+ tags: string[];
218
+ };
219
+ "0x188d12eb13a5eadd0867074ce8354b1ad6f4790b": {
220
+ chainId: number;
221
+ address: string;
222
+ name: string;
223
+ symbol: string;
224
+ logo: string;
225
+ decimals: number;
226
+ status: string;
227
+ tags: string[];
228
+ };
229
+ "0x9a1741e151233a82cf69209a2f1bc7442b1fb29c": {
230
+ chainId: number;
231
+ address: string;
232
+ name: string;
233
+ symbol: string;
234
+ logo: string;
235
+ decimals: number;
236
+ status: string;
237
+ tags: string[];
238
+ };
239
+ "0xe4a10951f962e6cb93cb843a4ef05d2f99db1f94": {
240
+ chainId: number;
241
+ address: string;
242
+ name: string;
243
+ symbol: string;
244
+ logo: string;
245
+ decimals: number;
246
+ status: string;
247
+ tags: string[];
248
+ };
249
+ "0xa5cdea03b11042fc10b52af9eca48bb17a2107d2": {
250
+ chainId: number;
251
+ address: string;
252
+ name: string;
253
+ symbol: string;
254
+ logo: string;
255
+ decimals: number;
256
+ status: string;
257
+ tags: string[];
258
+ };
259
+ "0x20d81101d254729a6e689418526be31e2c544290": {
260
+ chainId: number;
261
+ address: string;
262
+ name: string;
263
+ symbol: string;
264
+ logo: string;
265
+ decimals: number;
266
+ status: string;
267
+ tags: string[];
268
+ };
269
+ };
270
+ //#endregion
271
+ //#region yield-dtf/base.json.d.ts
272
+ declare const _exports$3: {
273
+ "0xCb327b99fF831bF8223cCEd12B1338FF3aA322Ff": {
274
+ address: string;
275
+ name: string;
276
+ symbol: string;
277
+ logo: string;
278
+ decimals: number;
279
+ about: string;
280
+ status: string;
281
+ };
282
+ "0xCc7FF230365bD730eE4B352cC2492CEdAC49383e": {
283
+ address: string;
284
+ name: string;
285
+ symbol: string;
286
+ logo: string;
287
+ decimals: number;
288
+ about: string;
289
+ website: string;
290
+ support: {
291
+ email: string;
292
+ url: string;
293
+ };
294
+ social: {
295
+ twitter: string;
296
+ };
297
+ status: string;
298
+ };
299
+ "0x8f0987DDb485219c767770e2080E5cC01ddc772a": {
300
+ address: string;
301
+ name: string;
302
+ symbol: string;
303
+ logo: string;
304
+ decimals: number;
305
+ status: string;
306
+ };
307
+ "0xC9a3e2B3064c1c0546D3D0edc0A748E9f93Cf18d": {
308
+ address: string;
309
+ name: string;
310
+ symbol: string;
311
+ logo: string;
312
+ decimals: number;
313
+ about: string;
314
+ website: string;
315
+ support: {
316
+ url: string;
317
+ };
318
+ social: {
319
+ twitter: string;
320
+ };
321
+ status: string;
322
+ };
323
+ "0x641B0453487C9D14c5df96d45a481ef1dc84e31f": {
324
+ address: string;
325
+ name: string;
326
+ symbol: string;
327
+ logo: string;
328
+ decimals: number;
329
+ about: string;
330
+ support: {
331
+ email: string;
332
+ };
333
+ social: {
334
+ twitter: string;
335
+ };
336
+ status: string;
337
+ };
338
+ };
339
+ //#endregion
340
+ //#region yield-dtf/mainnet.json.d.ts
341
+ declare const _exports$4: {
342
+ "0xA0d69E286B938e21CBf7E51D71F6A4c8918f482F": {
343
+ address: string;
344
+ name: string;
345
+ symbol: string;
346
+ logo: string;
347
+ decimals: number;
348
+ about: string;
349
+ status: string;
350
+ };
351
+ "0xE72B141DF173b999AE7c1aDcbF60Cc9833Ce56a8": {
352
+ address: string;
353
+ name: string;
354
+ symbol: string;
355
+ logo: string;
356
+ decimals: number;
357
+ about: string;
358
+ website: string;
359
+ support: {
360
+ url: string;
361
+ };
362
+ social: {
363
+ twitter: string;
364
+ };
365
+ status: string;
366
+ };
367
+ "0x0d86883FAf4FfD7aEb116390af37746F45b6f378": {
368
+ address: string;
369
+ name: string;
370
+ symbol: string;
371
+ logo: string;
372
+ decimals: number;
373
+ about: string;
374
+ support: {
375
+ email: string;
376
+ url: string;
377
+ };
378
+ social: {
379
+ twitter: string;
380
+ };
381
+ status: string;
382
+ };
383
+ "0x005F893EcD7bF9667195642f7649DA8163e23658": {
384
+ address: string;
385
+ name: string;
386
+ symbol: string;
387
+ logo: string;
388
+ decimals: number;
389
+ about: string;
390
+ website: string;
391
+ support: {
392
+ email: string;
393
+ url: string;
394
+ };
395
+ social: {
396
+ twitter: string;
397
+ };
398
+ status: string;
399
+ };
400
+ "0xaCdf0DBA4B9839b96221a8487e9ca660a48212be": {
401
+ address: string;
402
+ name: string;
403
+ symbol: string;
404
+ logo: string;
405
+ decimals: number;
406
+ about: string;
407
+ website: string;
408
+ support: {
409
+ email: string;
410
+ url: string;
411
+ };
412
+ social: {
413
+ twitter: string;
414
+ };
415
+ status: string;
416
+ };
417
+ "0xFc0B1EEf20e4c68B3DCF36c4537Cfa7Ce46CA70b": {
418
+ address: string;
419
+ name: string;
420
+ symbol: string;
421
+ logo: string;
422
+ decimals: number;
423
+ about: string;
424
+ website: string;
425
+ status: string;
426
+ };
427
+ "0x78da5799CF427Fee11e9996982F4150eCe7a99A7": {
428
+ address: string;
429
+ name: string;
430
+ symbol: string;
431
+ logo: string;
432
+ decimals: number;
433
+ about: string;
434
+ status: string;
435
+ };
436
+ };
437
+ //#endregion
438
+ //#region src/index.d.ts
439
+ declare const indexDtfs: Record<1 | 56 | 8453, Record<string, CatalogIndexDTF>>;
440
+ declare const yieldDtfs: Partial<Record<1 | 56 | 8453, Record<string, CatalogYieldDTF>>>;
441
+ declare const dtfs: Record<1 | 56 | 8453, Record<string, CatalogIndexDTF | CatalogYieldDTF>>;
442
+ //#endregion
443
+ export { type CatalogIndexDTF, type CatalogYieldDTF, dtfs as default, _exports as indexBase, _exports$1 as indexBnb, indexDtfs, _exports$2 as indexMainnet, _exports$3 as yieldBase, yieldDtfs, _exports$4 as yieldMainnet };