@vaultsfyi/sdk 1.0.3 → 2.0.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.
- package/dist/client.d.mts +1168 -277
- package/dist/client.d.ts +1168 -277
- package/dist/client.js +9 -2
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +9 -2
- package/dist/client.mjs.map +1 -1
- package/package.json +3 -3
package/dist/client.d.mts
CHANGED
|
@@ -31,6 +31,34 @@ interface paths {
|
|
|
31
31
|
};
|
|
32
32
|
};
|
|
33
33
|
};
|
|
34
|
+
/** @description Default Response */
|
|
35
|
+
500: {
|
|
36
|
+
headers: {
|
|
37
|
+
[name: string]: unknown;
|
|
38
|
+
};
|
|
39
|
+
content: {
|
|
40
|
+
'application/json': {
|
|
41
|
+
/** @enum {string} */
|
|
42
|
+
error: 'Internal Server Error';
|
|
43
|
+
message: string;
|
|
44
|
+
errorId?: string;
|
|
45
|
+
} | unknown;
|
|
46
|
+
};
|
|
47
|
+
};
|
|
48
|
+
/** @description Default Response */
|
|
49
|
+
503: {
|
|
50
|
+
headers: {
|
|
51
|
+
[name: string]: unknown;
|
|
52
|
+
};
|
|
53
|
+
content: {
|
|
54
|
+
'application/json': {
|
|
55
|
+
/** @enum {string} */
|
|
56
|
+
error: 'Service Unavailable';
|
|
57
|
+
message: string;
|
|
58
|
+
errorId?: string;
|
|
59
|
+
} | unknown;
|
|
60
|
+
};
|
|
61
|
+
};
|
|
34
62
|
};
|
|
35
63
|
};
|
|
36
64
|
put?: never;
|
|
@@ -57,7 +85,7 @@ interface paths {
|
|
|
57
85
|
/** @description Number of items per page */
|
|
58
86
|
perPage?: number;
|
|
59
87
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
60
|
-
network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
88
|
+
network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
61
89
|
/** @description Include only vaults with an asset of provided symbol(ticker) */
|
|
62
90
|
assetSymbol?: string;
|
|
63
91
|
/** @description Include only vaults that are supported in the transactional interface. */
|
|
@@ -91,7 +119,7 @@ interface paths {
|
|
|
91
119
|
* @description Name of the network
|
|
92
120
|
* @enum {string}
|
|
93
121
|
*/
|
|
94
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
122
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
95
123
|
/** @description Chain ID of the network */
|
|
96
124
|
chainId: number;
|
|
97
125
|
/** @description CAIP-2 of the network */
|
|
@@ -132,11 +160,12 @@ interface paths {
|
|
|
132
160
|
};
|
|
133
161
|
content: {
|
|
134
162
|
'application/json': {
|
|
135
|
-
|
|
163
|
+
statusCode: number;
|
|
136
164
|
/** @enum {string} */
|
|
137
165
|
error: 'Bad Request';
|
|
138
166
|
message: string;
|
|
139
|
-
|
|
167
|
+
errorId?: string;
|
|
168
|
+
} | unknown;
|
|
140
169
|
};
|
|
141
170
|
};
|
|
142
171
|
/** @description Default Response */
|
|
@@ -150,7 +179,8 @@ interface paths {
|
|
|
150
179
|
error: 'Unauthorized';
|
|
151
180
|
/** @enum {string} */
|
|
152
181
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
153
|
-
|
|
182
|
+
errorId?: string;
|
|
183
|
+
} | unknown;
|
|
154
184
|
};
|
|
155
185
|
};
|
|
156
186
|
/** @description Default Response */
|
|
@@ -164,7 +194,8 @@ interface paths {
|
|
|
164
194
|
error: 'Forbidden';
|
|
165
195
|
/** @enum {string} */
|
|
166
196
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
167
|
-
|
|
197
|
+
errorId?: string;
|
|
198
|
+
} | unknown;
|
|
168
199
|
};
|
|
169
200
|
};
|
|
170
201
|
/** @description Default Response */
|
|
@@ -177,7 +208,22 @@ interface paths {
|
|
|
177
208
|
/** @enum {string} */
|
|
178
209
|
error: 'Internal Server Error';
|
|
179
210
|
message: string;
|
|
180
|
-
|
|
211
|
+
errorId?: string;
|
|
212
|
+
} | unknown;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
/** @description Default Response */
|
|
216
|
+
503: {
|
|
217
|
+
headers: {
|
|
218
|
+
[name: string]: unknown;
|
|
219
|
+
};
|
|
220
|
+
content: {
|
|
221
|
+
'application/json': {
|
|
222
|
+
/** @enum {string} */
|
|
223
|
+
error: 'Service Unavailable';
|
|
224
|
+
message: string;
|
|
225
|
+
errorId?: string;
|
|
226
|
+
} | unknown;
|
|
181
227
|
};
|
|
182
228
|
};
|
|
183
229
|
};
|
|
@@ -206,7 +252,7 @@ interface paths {
|
|
|
206
252
|
/** @description Number of items per page */
|
|
207
253
|
perPage?: number;
|
|
208
254
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
209
|
-
network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
255
|
+
network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
210
256
|
};
|
|
211
257
|
header?: never;
|
|
212
258
|
path?: never;
|
|
@@ -249,7 +295,7 @@ interface paths {
|
|
|
249
295
|
* @description Name of the network
|
|
250
296
|
* @enum {string}
|
|
251
297
|
*/
|
|
252
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
298
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
253
299
|
/** @description Chain ID of the network */
|
|
254
300
|
chainId: number;
|
|
255
301
|
/** @description CAIP-2 of the network */
|
|
@@ -266,11 +312,12 @@ interface paths {
|
|
|
266
312
|
};
|
|
267
313
|
content: {
|
|
268
314
|
'application/json': {
|
|
269
|
-
|
|
315
|
+
statusCode: number;
|
|
270
316
|
/** @enum {string} */
|
|
271
317
|
error: 'Bad Request';
|
|
272
318
|
message: string;
|
|
273
|
-
|
|
319
|
+
errorId?: string;
|
|
320
|
+
} | unknown;
|
|
274
321
|
};
|
|
275
322
|
};
|
|
276
323
|
/** @description Default Response */
|
|
@@ -284,7 +331,8 @@ interface paths {
|
|
|
284
331
|
error: 'Unauthorized';
|
|
285
332
|
/** @enum {string} */
|
|
286
333
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
287
|
-
|
|
334
|
+
errorId?: string;
|
|
335
|
+
} | unknown;
|
|
288
336
|
};
|
|
289
337
|
};
|
|
290
338
|
/** @description Default Response */
|
|
@@ -298,7 +346,8 @@ interface paths {
|
|
|
298
346
|
error: 'Forbidden';
|
|
299
347
|
/** @enum {string} */
|
|
300
348
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
301
|
-
|
|
349
|
+
errorId?: string;
|
|
350
|
+
} | unknown;
|
|
302
351
|
};
|
|
303
352
|
};
|
|
304
353
|
/** @description Default Response */
|
|
@@ -311,7 +360,22 @@ interface paths {
|
|
|
311
360
|
/** @enum {string} */
|
|
312
361
|
error: 'Internal Server Error';
|
|
313
362
|
message: string;
|
|
314
|
-
|
|
363
|
+
errorId?: string;
|
|
364
|
+
} | unknown;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
/** @description Default Response */
|
|
368
|
+
503: {
|
|
369
|
+
headers: {
|
|
370
|
+
[name: string]: unknown;
|
|
371
|
+
};
|
|
372
|
+
content: {
|
|
373
|
+
'application/json': {
|
|
374
|
+
/** @enum {string} */
|
|
375
|
+
error: 'Service Unavailable';
|
|
376
|
+
message: string;
|
|
377
|
+
errorId?: string;
|
|
378
|
+
} | unknown;
|
|
315
379
|
};
|
|
316
380
|
};
|
|
317
381
|
};
|
|
@@ -351,6 +415,21 @@ interface paths {
|
|
|
351
415
|
};
|
|
352
416
|
};
|
|
353
417
|
/** @description Default Response */
|
|
418
|
+
400: {
|
|
419
|
+
headers: {
|
|
420
|
+
[name: string]: unknown;
|
|
421
|
+
};
|
|
422
|
+
content: {
|
|
423
|
+
'application/json': {
|
|
424
|
+
statusCode: number;
|
|
425
|
+
/** @enum {string} */
|
|
426
|
+
error: 'Bad Request';
|
|
427
|
+
message: string;
|
|
428
|
+
errorId?: string;
|
|
429
|
+
} | unknown;
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
/** @description Default Response */
|
|
354
433
|
401: {
|
|
355
434
|
headers: {
|
|
356
435
|
[name: string]: unknown;
|
|
@@ -361,7 +440,23 @@ interface paths {
|
|
|
361
440
|
error: 'Unauthorized';
|
|
362
441
|
/** @enum {string} */
|
|
363
442
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
364
|
-
|
|
443
|
+
errorId?: string;
|
|
444
|
+
} | unknown;
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
/** @description Default Response */
|
|
448
|
+
403: {
|
|
449
|
+
headers: {
|
|
450
|
+
[name: string]: unknown;
|
|
451
|
+
};
|
|
452
|
+
content: {
|
|
453
|
+
'application/json': {
|
|
454
|
+
/** @enum {string} */
|
|
455
|
+
error: 'Forbidden';
|
|
456
|
+
/** @enum {string} */
|
|
457
|
+
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
458
|
+
errorId?: string;
|
|
459
|
+
} | unknown;
|
|
365
460
|
};
|
|
366
461
|
};
|
|
367
462
|
/** @description Default Response */
|
|
@@ -374,7 +469,22 @@ interface paths {
|
|
|
374
469
|
/** @enum {string} */
|
|
375
470
|
error: 'Internal Server Error';
|
|
376
471
|
message: string;
|
|
377
|
-
|
|
472
|
+
errorId?: string;
|
|
473
|
+
} | unknown;
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
/** @description Default Response */
|
|
477
|
+
503: {
|
|
478
|
+
headers: {
|
|
479
|
+
[name: string]: unknown;
|
|
480
|
+
};
|
|
481
|
+
content: {
|
|
482
|
+
'application/json': {
|
|
483
|
+
/** @enum {string} */
|
|
484
|
+
error: 'Service Unavailable';
|
|
485
|
+
message: string;
|
|
486
|
+
errorId?: string;
|
|
487
|
+
} | unknown;
|
|
378
488
|
};
|
|
379
489
|
};
|
|
380
490
|
};
|
|
@@ -415,7 +525,7 @@ interface paths {
|
|
|
415
525
|
* @description Name of the network
|
|
416
526
|
* @enum {string}
|
|
417
527
|
*/
|
|
418
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
528
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
419
529
|
/** @description Chain ID of the network */
|
|
420
530
|
chainId: number;
|
|
421
531
|
/** @description CAIP-2 of the network */
|
|
@@ -424,6 +534,21 @@ interface paths {
|
|
|
424
534
|
};
|
|
425
535
|
};
|
|
426
536
|
/** @description Default Response */
|
|
537
|
+
400: {
|
|
538
|
+
headers: {
|
|
539
|
+
[name: string]: unknown;
|
|
540
|
+
};
|
|
541
|
+
content: {
|
|
542
|
+
'application/json': {
|
|
543
|
+
statusCode: number;
|
|
544
|
+
/** @enum {string} */
|
|
545
|
+
error: 'Bad Request';
|
|
546
|
+
message: string;
|
|
547
|
+
errorId?: string;
|
|
548
|
+
} | unknown;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
/** @description Default Response */
|
|
427
552
|
401: {
|
|
428
553
|
headers: {
|
|
429
554
|
[name: string]: unknown;
|
|
@@ -434,7 +559,23 @@ interface paths {
|
|
|
434
559
|
error: 'Unauthorized';
|
|
435
560
|
/** @enum {string} */
|
|
436
561
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
437
|
-
|
|
562
|
+
errorId?: string;
|
|
563
|
+
} | unknown;
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
/** @description Default Response */
|
|
567
|
+
403: {
|
|
568
|
+
headers: {
|
|
569
|
+
[name: string]: unknown;
|
|
570
|
+
};
|
|
571
|
+
content: {
|
|
572
|
+
'application/json': {
|
|
573
|
+
/** @enum {string} */
|
|
574
|
+
error: 'Forbidden';
|
|
575
|
+
/** @enum {string} */
|
|
576
|
+
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
577
|
+
errorId?: string;
|
|
578
|
+
} | unknown;
|
|
438
579
|
};
|
|
439
580
|
};
|
|
440
581
|
/** @description Default Response */
|
|
@@ -447,7 +588,22 @@ interface paths {
|
|
|
447
588
|
/** @enum {string} */
|
|
448
589
|
error: 'Internal Server Error';
|
|
449
590
|
message: string;
|
|
450
|
-
|
|
591
|
+
errorId?: string;
|
|
592
|
+
} | unknown;
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
/** @description Default Response */
|
|
596
|
+
503: {
|
|
597
|
+
headers: {
|
|
598
|
+
[name: string]: unknown;
|
|
599
|
+
};
|
|
600
|
+
content: {
|
|
601
|
+
'application/json': {
|
|
602
|
+
/** @enum {string} */
|
|
603
|
+
error: 'Service Unavailable';
|
|
604
|
+
message: string;
|
|
605
|
+
errorId?: string;
|
|
606
|
+
} | unknown;
|
|
451
607
|
};
|
|
452
608
|
};
|
|
453
609
|
};
|
|
@@ -477,6 +633,8 @@ interface paths {
|
|
|
477
633
|
perPage?: number;
|
|
478
634
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
479
635
|
apyInterval?: '1day' | '7day' | '30day';
|
|
636
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
637
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
480
638
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
481
639
|
fromTimestamp?: number;
|
|
482
640
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -485,7 +643,7 @@ interface paths {
|
|
|
485
643
|
header?: never;
|
|
486
644
|
path: {
|
|
487
645
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
488
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
646
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
489
647
|
/** @description Address of the vault for which the data will be returned */
|
|
490
648
|
vaultAddress: string;
|
|
491
649
|
};
|
|
@@ -536,11 +694,12 @@ interface paths {
|
|
|
536
694
|
};
|
|
537
695
|
content: {
|
|
538
696
|
'application/json': {
|
|
539
|
-
|
|
697
|
+
statusCode: number;
|
|
540
698
|
/** @enum {string} */
|
|
541
699
|
error: 'Bad Request';
|
|
542
700
|
message: string;
|
|
543
|
-
|
|
701
|
+
errorId?: string;
|
|
702
|
+
} | unknown;
|
|
544
703
|
};
|
|
545
704
|
};
|
|
546
705
|
/** @description Default Response */
|
|
@@ -554,7 +713,8 @@ interface paths {
|
|
|
554
713
|
error: 'Unauthorized';
|
|
555
714
|
/** @enum {string} */
|
|
556
715
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
557
|
-
|
|
716
|
+
errorId?: string;
|
|
717
|
+
} | unknown;
|
|
558
718
|
};
|
|
559
719
|
};
|
|
560
720
|
/** @description Default Response */
|
|
@@ -568,7 +728,8 @@ interface paths {
|
|
|
568
728
|
error: 'Forbidden';
|
|
569
729
|
/** @enum {string} */
|
|
570
730
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
571
|
-
|
|
731
|
+
errorId?: string;
|
|
732
|
+
} | unknown;
|
|
572
733
|
};
|
|
573
734
|
};
|
|
574
735
|
/** @description Default Response */
|
|
@@ -581,7 +742,22 @@ interface paths {
|
|
|
581
742
|
/** @enum {string} */
|
|
582
743
|
error: 'Internal Server Error';
|
|
583
744
|
message: string;
|
|
584
|
-
|
|
745
|
+
errorId?: string;
|
|
746
|
+
} | unknown;
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
/** @description Default Response */
|
|
750
|
+
503: {
|
|
751
|
+
headers: {
|
|
752
|
+
[name: string]: unknown;
|
|
753
|
+
};
|
|
754
|
+
content: {
|
|
755
|
+
'application/json': {
|
|
756
|
+
/** @enum {string} */
|
|
757
|
+
error: 'Service Unavailable';
|
|
758
|
+
message: string;
|
|
759
|
+
errorId?: string;
|
|
760
|
+
} | unknown;
|
|
585
761
|
};
|
|
586
762
|
};
|
|
587
763
|
};
|
|
@@ -611,6 +787,8 @@ interface paths {
|
|
|
611
787
|
perPage?: number;
|
|
612
788
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
613
789
|
apyInterval?: '1day' | '7day' | '30day';
|
|
790
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
791
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
614
792
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
615
793
|
fromTimestamp?: number;
|
|
616
794
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -619,7 +797,7 @@ interface paths {
|
|
|
619
797
|
header?: never;
|
|
620
798
|
path: {
|
|
621
799
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
622
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
800
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
623
801
|
/** @description Address of the vault for which the data will be returned */
|
|
624
802
|
vaultAddress: string;
|
|
625
803
|
};
|
|
@@ -663,11 +841,12 @@ interface paths {
|
|
|
663
841
|
};
|
|
664
842
|
content: {
|
|
665
843
|
'application/json': {
|
|
666
|
-
|
|
844
|
+
statusCode: number;
|
|
667
845
|
/** @enum {string} */
|
|
668
846
|
error: 'Bad Request';
|
|
669
847
|
message: string;
|
|
670
|
-
|
|
848
|
+
errorId?: string;
|
|
849
|
+
} | unknown;
|
|
671
850
|
};
|
|
672
851
|
};
|
|
673
852
|
/** @description Default Response */
|
|
@@ -681,7 +860,8 @@ interface paths {
|
|
|
681
860
|
error: 'Unauthorized';
|
|
682
861
|
/** @enum {string} */
|
|
683
862
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
684
|
-
|
|
863
|
+
errorId?: string;
|
|
864
|
+
} | unknown;
|
|
685
865
|
};
|
|
686
866
|
};
|
|
687
867
|
/** @description Default Response */
|
|
@@ -695,7 +875,8 @@ interface paths {
|
|
|
695
875
|
error: 'Forbidden';
|
|
696
876
|
/** @enum {string} */
|
|
697
877
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
698
|
-
|
|
878
|
+
errorId?: string;
|
|
879
|
+
} | unknown;
|
|
699
880
|
};
|
|
700
881
|
};
|
|
701
882
|
/** @description Default Response */
|
|
@@ -708,7 +889,22 @@ interface paths {
|
|
|
708
889
|
/** @enum {string} */
|
|
709
890
|
error: 'Internal Server Error';
|
|
710
891
|
message: string;
|
|
711
|
-
|
|
892
|
+
errorId?: string;
|
|
893
|
+
} | unknown;
|
|
894
|
+
};
|
|
895
|
+
};
|
|
896
|
+
/** @description Default Response */
|
|
897
|
+
503: {
|
|
898
|
+
headers: {
|
|
899
|
+
[name: string]: unknown;
|
|
900
|
+
};
|
|
901
|
+
content: {
|
|
902
|
+
'application/json': {
|
|
903
|
+
/** @enum {string} */
|
|
904
|
+
error: 'Service Unavailable';
|
|
905
|
+
message: string;
|
|
906
|
+
errorId?: string;
|
|
907
|
+
} | unknown;
|
|
712
908
|
};
|
|
713
909
|
};
|
|
714
910
|
};
|
|
@@ -738,6 +934,8 @@ interface paths {
|
|
|
738
934
|
perPage?: number;
|
|
739
935
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
740
936
|
apyInterval?: '1day' | '7day' | '30day';
|
|
937
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
938
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
741
939
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
742
940
|
fromTimestamp?: number;
|
|
743
941
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -746,7 +944,7 @@ interface paths {
|
|
|
746
944
|
header?: never;
|
|
747
945
|
path: {
|
|
748
946
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
749
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
947
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
750
948
|
/** @description Address of the vault for which the data will be returned */
|
|
751
949
|
vaultAddress: string;
|
|
752
950
|
};
|
|
@@ -788,11 +986,12 @@ interface paths {
|
|
|
788
986
|
};
|
|
789
987
|
content: {
|
|
790
988
|
'application/json': {
|
|
791
|
-
|
|
989
|
+
statusCode: number;
|
|
792
990
|
/** @enum {string} */
|
|
793
991
|
error: 'Bad Request';
|
|
794
992
|
message: string;
|
|
795
|
-
|
|
993
|
+
errorId?: string;
|
|
994
|
+
} | unknown;
|
|
796
995
|
};
|
|
797
996
|
};
|
|
798
997
|
/** @description Default Response */
|
|
@@ -806,7 +1005,8 @@ interface paths {
|
|
|
806
1005
|
error: 'Unauthorized';
|
|
807
1006
|
/** @enum {string} */
|
|
808
1007
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
809
|
-
|
|
1008
|
+
errorId?: string;
|
|
1009
|
+
} | unknown;
|
|
810
1010
|
};
|
|
811
1011
|
};
|
|
812
1012
|
/** @description Default Response */
|
|
@@ -820,7 +1020,8 @@ interface paths {
|
|
|
820
1020
|
error: 'Forbidden';
|
|
821
1021
|
/** @enum {string} */
|
|
822
1022
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
823
|
-
|
|
1023
|
+
errorId?: string;
|
|
1024
|
+
} | unknown;
|
|
824
1025
|
};
|
|
825
1026
|
};
|
|
826
1027
|
/** @description Default Response */
|
|
@@ -833,7 +1034,22 @@ interface paths {
|
|
|
833
1034
|
/** @enum {string} */
|
|
834
1035
|
error: 'Internal Server Error';
|
|
835
1036
|
message: string;
|
|
836
|
-
|
|
1037
|
+
errorId?: string;
|
|
1038
|
+
} | unknown;
|
|
1039
|
+
};
|
|
1040
|
+
};
|
|
1041
|
+
/** @description Default Response */
|
|
1042
|
+
503: {
|
|
1043
|
+
headers: {
|
|
1044
|
+
[name: string]: unknown;
|
|
1045
|
+
};
|
|
1046
|
+
content: {
|
|
1047
|
+
'application/json': {
|
|
1048
|
+
/** @enum {string} */
|
|
1049
|
+
error: 'Service Unavailable';
|
|
1050
|
+
message: string;
|
|
1051
|
+
errorId?: string;
|
|
1052
|
+
} | unknown;
|
|
837
1053
|
};
|
|
838
1054
|
};
|
|
839
1055
|
};
|
|
@@ -861,10 +1077,6 @@ interface paths {
|
|
|
861
1077
|
page?: number;
|
|
862
1078
|
/** @description Number of items per page */
|
|
863
1079
|
perPage?: number;
|
|
864
|
-
/** @description Networks to be included (name or CAIP). */
|
|
865
|
-
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
866
|
-
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
867
|
-
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
868
1080
|
/** @description Assets to be included by symbol(ticker). */
|
|
869
1081
|
allowedAssets?: string[];
|
|
870
1082
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
@@ -879,6 +1091,10 @@ interface paths {
|
|
|
879
1091
|
onlyTransactional?: boolean;
|
|
880
1092
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
881
1093
|
onlyAppFeatured?: boolean;
|
|
1094
|
+
/** @description Networks to be included (name or CAIP). */
|
|
1095
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
1096
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
1097
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
882
1098
|
/** @description Maximum TVL in USD of the vaults to be included */
|
|
883
1099
|
maxTvl?: number;
|
|
884
1100
|
/** @description Tags to be included. */
|
|
@@ -910,7 +1126,7 @@ interface paths {
|
|
|
910
1126
|
* @description Name of the network
|
|
911
1127
|
* @enum {string}
|
|
912
1128
|
*/
|
|
913
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
1129
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
914
1130
|
/** @description Chain ID of the network */
|
|
915
1131
|
chainId: number;
|
|
916
1132
|
/** @description CAIP-2 of the network */
|
|
@@ -980,7 +1196,7 @@ interface paths {
|
|
|
980
1196
|
};
|
|
981
1197
|
/** @description APY details of the vault */
|
|
982
1198
|
apy: {
|
|
983
|
-
/** @description 1day APY details
|
|
1199
|
+
/** @description 1day APY details */
|
|
984
1200
|
'1day': {
|
|
985
1201
|
/** @description Base APY */
|
|
986
1202
|
base: number;
|
|
@@ -989,7 +1205,7 @@ interface paths {
|
|
|
989
1205
|
/** @description Total APY */
|
|
990
1206
|
total: number;
|
|
991
1207
|
};
|
|
992
|
-
/** @description 7day APY details
|
|
1208
|
+
/** @description 7day APY details */
|
|
993
1209
|
'7day': {
|
|
994
1210
|
/** @description Base APY */
|
|
995
1211
|
base: number;
|
|
@@ -998,7 +1214,7 @@ interface paths {
|
|
|
998
1214
|
/** @description Total APY */
|
|
999
1215
|
total: number;
|
|
1000
1216
|
};
|
|
1001
|
-
/** @description 30day APY details
|
|
1217
|
+
/** @description 30day APY details */
|
|
1002
1218
|
'30day': {
|
|
1003
1219
|
/** @description Base APY */
|
|
1004
1220
|
base: number;
|
|
@@ -1170,11 +1386,12 @@ interface paths {
|
|
|
1170
1386
|
};
|
|
1171
1387
|
content: {
|
|
1172
1388
|
'application/json': {
|
|
1173
|
-
|
|
1389
|
+
statusCode: number;
|
|
1174
1390
|
/** @enum {string} */
|
|
1175
1391
|
error: 'Bad Request';
|
|
1176
1392
|
message: string;
|
|
1177
|
-
|
|
1393
|
+
errorId?: string;
|
|
1394
|
+
} | unknown;
|
|
1178
1395
|
};
|
|
1179
1396
|
};
|
|
1180
1397
|
/** @description Default Response */
|
|
@@ -1188,7 +1405,8 @@ interface paths {
|
|
|
1188
1405
|
error: 'Unauthorized';
|
|
1189
1406
|
/** @enum {string} */
|
|
1190
1407
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
1191
|
-
|
|
1408
|
+
errorId?: string;
|
|
1409
|
+
} | unknown;
|
|
1192
1410
|
};
|
|
1193
1411
|
};
|
|
1194
1412
|
/** @description Default Response */
|
|
@@ -1202,7 +1420,8 @@ interface paths {
|
|
|
1202
1420
|
error: 'Forbidden';
|
|
1203
1421
|
/** @enum {string} */
|
|
1204
1422
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
1205
|
-
|
|
1423
|
+
errorId?: string;
|
|
1424
|
+
} | unknown;
|
|
1206
1425
|
};
|
|
1207
1426
|
};
|
|
1208
1427
|
/** @description Default Response */
|
|
@@ -1215,7 +1434,22 @@ interface paths {
|
|
|
1215
1434
|
/** @enum {string} */
|
|
1216
1435
|
error: 'Internal Server Error';
|
|
1217
1436
|
message: string;
|
|
1218
|
-
|
|
1437
|
+
errorId?: string;
|
|
1438
|
+
} | unknown;
|
|
1439
|
+
};
|
|
1440
|
+
};
|
|
1441
|
+
/** @description Default Response */
|
|
1442
|
+
503: {
|
|
1443
|
+
headers: {
|
|
1444
|
+
[name: string]: unknown;
|
|
1445
|
+
};
|
|
1446
|
+
content: {
|
|
1447
|
+
'application/json': {
|
|
1448
|
+
/** @enum {string} */
|
|
1449
|
+
error: 'Service Unavailable';
|
|
1450
|
+
message: string;
|
|
1451
|
+
errorId?: string;
|
|
1452
|
+
} | unknown;
|
|
1219
1453
|
};
|
|
1220
1454
|
};
|
|
1221
1455
|
};
|
|
@@ -1242,7 +1476,7 @@ interface paths {
|
|
|
1242
1476
|
header?: never;
|
|
1243
1477
|
path: {
|
|
1244
1478
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
1245
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
1479
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
1246
1480
|
/** @description Address of the vault for which the data will be returned */
|
|
1247
1481
|
vaultAddress: string;
|
|
1248
1482
|
};
|
|
@@ -1265,7 +1499,7 @@ interface paths {
|
|
|
1265
1499
|
* @description Name of the network
|
|
1266
1500
|
* @enum {string}
|
|
1267
1501
|
*/
|
|
1268
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
1502
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
1269
1503
|
/** @description Chain ID of the network */
|
|
1270
1504
|
chainId: number;
|
|
1271
1505
|
/** @description CAIP-2 of the network */
|
|
@@ -1335,7 +1569,7 @@ interface paths {
|
|
|
1335
1569
|
};
|
|
1336
1570
|
/** @description APY details of the vault */
|
|
1337
1571
|
apy: {
|
|
1338
|
-
/** @description 1day APY details
|
|
1572
|
+
/** @description 1day APY details */
|
|
1339
1573
|
'1day': {
|
|
1340
1574
|
/** @description Base APY */
|
|
1341
1575
|
base: number;
|
|
@@ -1344,7 +1578,7 @@ interface paths {
|
|
|
1344
1578
|
/** @description Total APY */
|
|
1345
1579
|
total: number;
|
|
1346
1580
|
};
|
|
1347
|
-
/** @description 7day APY details
|
|
1581
|
+
/** @description 7day APY details */
|
|
1348
1582
|
'7day': {
|
|
1349
1583
|
/** @description Base APY */
|
|
1350
1584
|
base: number;
|
|
@@ -1353,7 +1587,7 @@ interface paths {
|
|
|
1353
1587
|
/** @description Total APY */
|
|
1354
1588
|
total: number;
|
|
1355
1589
|
};
|
|
1356
|
-
/** @description 30day APY details
|
|
1590
|
+
/** @description 30day APY details */
|
|
1357
1591
|
'30day': {
|
|
1358
1592
|
/** @description Base APY */
|
|
1359
1593
|
base: number;
|
|
@@ -1519,11 +1753,12 @@ interface paths {
|
|
|
1519
1753
|
};
|
|
1520
1754
|
content: {
|
|
1521
1755
|
'application/json': {
|
|
1522
|
-
|
|
1756
|
+
statusCode: number;
|
|
1523
1757
|
/** @enum {string} */
|
|
1524
1758
|
error: 'Bad Request';
|
|
1525
1759
|
message: string;
|
|
1526
|
-
|
|
1760
|
+
errorId?: string;
|
|
1761
|
+
} | unknown;
|
|
1527
1762
|
};
|
|
1528
1763
|
};
|
|
1529
1764
|
/** @description Default Response */
|
|
@@ -1537,7 +1772,8 @@ interface paths {
|
|
|
1537
1772
|
error: 'Unauthorized';
|
|
1538
1773
|
/** @enum {string} */
|
|
1539
1774
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
1540
|
-
|
|
1775
|
+
errorId?: string;
|
|
1776
|
+
} | unknown;
|
|
1541
1777
|
};
|
|
1542
1778
|
};
|
|
1543
1779
|
/** @description Default Response */
|
|
@@ -1551,7 +1787,8 @@ interface paths {
|
|
|
1551
1787
|
error: 'Forbidden';
|
|
1552
1788
|
/** @enum {string} */
|
|
1553
1789
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
1554
|
-
|
|
1790
|
+
errorId?: string;
|
|
1791
|
+
} | unknown;
|
|
1555
1792
|
};
|
|
1556
1793
|
};
|
|
1557
1794
|
/** @description Default Response */
|
|
@@ -1564,7 +1801,22 @@ interface paths {
|
|
|
1564
1801
|
/** @enum {string} */
|
|
1565
1802
|
error: 'Internal Server Error';
|
|
1566
1803
|
message: string;
|
|
1567
|
-
|
|
1804
|
+
errorId?: string;
|
|
1805
|
+
} | unknown;
|
|
1806
|
+
};
|
|
1807
|
+
};
|
|
1808
|
+
/** @description Default Response */
|
|
1809
|
+
503: {
|
|
1810
|
+
headers: {
|
|
1811
|
+
[name: string]: unknown;
|
|
1812
|
+
};
|
|
1813
|
+
content: {
|
|
1814
|
+
'application/json': {
|
|
1815
|
+
/** @enum {string} */
|
|
1816
|
+
error: 'Service Unavailable';
|
|
1817
|
+
message: string;
|
|
1818
|
+
errorId?: string;
|
|
1819
|
+
} | unknown;
|
|
1568
1820
|
};
|
|
1569
1821
|
};
|
|
1570
1822
|
};
|
|
@@ -1591,7 +1843,7 @@ interface paths {
|
|
|
1591
1843
|
header?: never;
|
|
1592
1844
|
path: {
|
|
1593
1845
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
1594
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
1846
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
1595
1847
|
/** @description Address of the vault for which the data will be returned */
|
|
1596
1848
|
vaultAddress: string;
|
|
1597
1849
|
};
|
|
@@ -1606,7 +1858,7 @@ interface paths {
|
|
|
1606
1858
|
};
|
|
1607
1859
|
content: {
|
|
1608
1860
|
'application/json': {
|
|
1609
|
-
/** @description 1day APY details
|
|
1861
|
+
/** @description 1day APY details */
|
|
1610
1862
|
'1day': {
|
|
1611
1863
|
/** @description Base APY */
|
|
1612
1864
|
base: number;
|
|
@@ -1615,7 +1867,7 @@ interface paths {
|
|
|
1615
1867
|
/** @description Total APY */
|
|
1616
1868
|
total: number;
|
|
1617
1869
|
};
|
|
1618
|
-
/** @description 7day APY details
|
|
1870
|
+
/** @description 7day APY details */
|
|
1619
1871
|
'7day': {
|
|
1620
1872
|
/** @description Base APY */
|
|
1621
1873
|
base: number;
|
|
@@ -1624,7 +1876,7 @@ interface paths {
|
|
|
1624
1876
|
/** @description Total APY */
|
|
1625
1877
|
total: number;
|
|
1626
1878
|
};
|
|
1627
|
-
/** @description 30day APY details
|
|
1879
|
+
/** @description 30day APY details */
|
|
1628
1880
|
'30day': {
|
|
1629
1881
|
/** @description Base APY */
|
|
1630
1882
|
base: number;
|
|
@@ -1643,11 +1895,12 @@ interface paths {
|
|
|
1643
1895
|
};
|
|
1644
1896
|
content: {
|
|
1645
1897
|
'application/json': {
|
|
1646
|
-
|
|
1898
|
+
statusCode: number;
|
|
1647
1899
|
/** @enum {string} */
|
|
1648
1900
|
error: 'Bad Request';
|
|
1649
1901
|
message: string;
|
|
1650
|
-
|
|
1902
|
+
errorId?: string;
|
|
1903
|
+
} | unknown;
|
|
1651
1904
|
};
|
|
1652
1905
|
};
|
|
1653
1906
|
/** @description Default Response */
|
|
@@ -1661,7 +1914,8 @@ interface paths {
|
|
|
1661
1914
|
error: 'Unauthorized';
|
|
1662
1915
|
/** @enum {string} */
|
|
1663
1916
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
1664
|
-
|
|
1917
|
+
errorId?: string;
|
|
1918
|
+
} | unknown;
|
|
1665
1919
|
};
|
|
1666
1920
|
};
|
|
1667
1921
|
/** @description Default Response */
|
|
@@ -1675,7 +1929,8 @@ interface paths {
|
|
|
1675
1929
|
error: 'Forbidden';
|
|
1676
1930
|
/** @enum {string} */
|
|
1677
1931
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
1678
|
-
|
|
1932
|
+
errorId?: string;
|
|
1933
|
+
} | unknown;
|
|
1679
1934
|
};
|
|
1680
1935
|
};
|
|
1681
1936
|
/** @description Default Response */
|
|
@@ -1688,7 +1943,22 @@ interface paths {
|
|
|
1688
1943
|
/** @enum {string} */
|
|
1689
1944
|
error: 'Internal Server Error';
|
|
1690
1945
|
message: string;
|
|
1691
|
-
|
|
1946
|
+
errorId?: string;
|
|
1947
|
+
} | unknown;
|
|
1948
|
+
};
|
|
1949
|
+
};
|
|
1950
|
+
/** @description Default Response */
|
|
1951
|
+
503: {
|
|
1952
|
+
headers: {
|
|
1953
|
+
[name: string]: unknown;
|
|
1954
|
+
};
|
|
1955
|
+
content: {
|
|
1956
|
+
'application/json': {
|
|
1957
|
+
/** @enum {string} */
|
|
1958
|
+
error: 'Service Unavailable';
|
|
1959
|
+
message: string;
|
|
1960
|
+
errorId?: string;
|
|
1961
|
+
} | unknown;
|
|
1692
1962
|
};
|
|
1693
1963
|
};
|
|
1694
1964
|
};
|
|
@@ -1715,7 +1985,7 @@ interface paths {
|
|
|
1715
1985
|
header?: never;
|
|
1716
1986
|
path: {
|
|
1717
1987
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
1718
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
1988
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
1719
1989
|
/** @description Address of the vault for which the data will be returned */
|
|
1720
1990
|
vaultAddress: string;
|
|
1721
1991
|
};
|
|
@@ -1744,11 +2014,12 @@ interface paths {
|
|
|
1744
2014
|
};
|
|
1745
2015
|
content: {
|
|
1746
2016
|
'application/json': {
|
|
1747
|
-
|
|
2017
|
+
statusCode: number;
|
|
1748
2018
|
/** @enum {string} */
|
|
1749
2019
|
error: 'Bad Request';
|
|
1750
2020
|
message: string;
|
|
1751
|
-
|
|
2021
|
+
errorId?: string;
|
|
2022
|
+
} | unknown;
|
|
1752
2023
|
};
|
|
1753
2024
|
};
|
|
1754
2025
|
/** @description Default Response */
|
|
@@ -1762,7 +2033,8 @@ interface paths {
|
|
|
1762
2033
|
error: 'Unauthorized';
|
|
1763
2034
|
/** @enum {string} */
|
|
1764
2035
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
1765
|
-
|
|
2036
|
+
errorId?: string;
|
|
2037
|
+
} | unknown;
|
|
1766
2038
|
};
|
|
1767
2039
|
};
|
|
1768
2040
|
/** @description Default Response */
|
|
@@ -1776,7 +2048,8 @@ interface paths {
|
|
|
1776
2048
|
error: 'Forbidden';
|
|
1777
2049
|
/** @enum {string} */
|
|
1778
2050
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
1779
|
-
|
|
2051
|
+
errorId?: string;
|
|
2052
|
+
} | unknown;
|
|
1780
2053
|
};
|
|
1781
2054
|
};
|
|
1782
2055
|
/** @description Default Response */
|
|
@@ -1789,7 +2062,22 @@ interface paths {
|
|
|
1789
2062
|
/** @enum {string} */
|
|
1790
2063
|
error: 'Internal Server Error';
|
|
1791
2064
|
message: string;
|
|
1792
|
-
|
|
2065
|
+
errorId?: string;
|
|
2066
|
+
} | unknown;
|
|
2067
|
+
};
|
|
2068
|
+
};
|
|
2069
|
+
/** @description Default Response */
|
|
2070
|
+
503: {
|
|
2071
|
+
headers: {
|
|
2072
|
+
[name: string]: unknown;
|
|
2073
|
+
};
|
|
2074
|
+
content: {
|
|
2075
|
+
'application/json': {
|
|
2076
|
+
/** @enum {string} */
|
|
2077
|
+
error: 'Service Unavailable';
|
|
2078
|
+
message: string;
|
|
2079
|
+
errorId?: string;
|
|
2080
|
+
} | unknown;
|
|
1793
2081
|
};
|
|
1794
2082
|
};
|
|
1795
2083
|
};
|
|
@@ -1813,10 +2101,6 @@ interface paths {
|
|
|
1813
2101
|
get: {
|
|
1814
2102
|
parameters: {
|
|
1815
2103
|
query?: {
|
|
1816
|
-
/** @description Networks to be included (name or CAIP). */
|
|
1817
|
-
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
1818
|
-
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
1819
|
-
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
1820
2104
|
/** @description Assets to be included by symbol(ticker). */
|
|
1821
2105
|
allowedAssets?: string[];
|
|
1822
2106
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
@@ -1831,6 +2115,10 @@ interface paths {
|
|
|
1831
2115
|
onlyTransactional?: boolean;
|
|
1832
2116
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
1833
2117
|
onlyAppFeatured?: boolean;
|
|
2118
|
+
/** @description Networks to be included (name or CAIP). */
|
|
2119
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
2120
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2121
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
1834
2122
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
1835
2123
|
apyInterval?: '1day' | '7day' | '30day';
|
|
1836
2124
|
/** @description Minimum APY of the vault to be included */
|
|
@@ -1892,7 +2180,7 @@ interface paths {
|
|
|
1892
2180
|
* @description Name of the network
|
|
1893
2181
|
* @enum {string}
|
|
1894
2182
|
*/
|
|
1895
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2183
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
1896
2184
|
/** @description Chain ID of the network */
|
|
1897
2185
|
chainId: number;
|
|
1898
2186
|
/** @description CAIP-2 of the network */
|
|
@@ -1957,11 +2245,12 @@ interface paths {
|
|
|
1957
2245
|
};
|
|
1958
2246
|
content: {
|
|
1959
2247
|
'application/json': {
|
|
1960
|
-
|
|
2248
|
+
statusCode: number;
|
|
1961
2249
|
/** @enum {string} */
|
|
1962
2250
|
error: 'Bad Request';
|
|
1963
2251
|
message: string;
|
|
1964
|
-
|
|
2252
|
+
errorId?: string;
|
|
2253
|
+
} | unknown;
|
|
1965
2254
|
};
|
|
1966
2255
|
};
|
|
1967
2256
|
/** @description Default Response */
|
|
@@ -1975,7 +2264,8 @@ interface paths {
|
|
|
1975
2264
|
error: 'Unauthorized';
|
|
1976
2265
|
/** @enum {string} */
|
|
1977
2266
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
1978
|
-
|
|
2267
|
+
errorId?: string;
|
|
2268
|
+
} | unknown;
|
|
1979
2269
|
};
|
|
1980
2270
|
};
|
|
1981
2271
|
/** @description Default Response */
|
|
@@ -1989,7 +2279,8 @@ interface paths {
|
|
|
1989
2279
|
error: 'Forbidden';
|
|
1990
2280
|
/** @enum {string} */
|
|
1991
2281
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
1992
|
-
|
|
2282
|
+
errorId?: string;
|
|
2283
|
+
} | unknown;
|
|
1993
2284
|
};
|
|
1994
2285
|
};
|
|
1995
2286
|
/** @description Default Response */
|
|
@@ -2002,7 +2293,22 @@ interface paths {
|
|
|
2002
2293
|
/** @enum {string} */
|
|
2003
2294
|
error: 'Internal Server Error';
|
|
2004
2295
|
message: string;
|
|
2005
|
-
|
|
2296
|
+
errorId?: string;
|
|
2297
|
+
} | unknown;
|
|
2298
|
+
};
|
|
2299
|
+
};
|
|
2300
|
+
/** @description Default Response */
|
|
2301
|
+
503: {
|
|
2302
|
+
headers: {
|
|
2303
|
+
[name: string]: unknown;
|
|
2304
|
+
};
|
|
2305
|
+
content: {
|
|
2306
|
+
'application/json': {
|
|
2307
|
+
/** @enum {string} */
|
|
2308
|
+
error: 'Service Unavailable';
|
|
2309
|
+
message: string;
|
|
2310
|
+
errorId?: string;
|
|
2311
|
+
} | unknown;
|
|
2006
2312
|
};
|
|
2007
2313
|
};
|
|
2008
2314
|
};
|
|
@@ -2026,10 +2332,6 @@ interface paths {
|
|
|
2026
2332
|
get: {
|
|
2027
2333
|
parameters: {
|
|
2028
2334
|
query?: {
|
|
2029
|
-
/** @description Networks to be included (name or CAIP). */
|
|
2030
|
-
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
2031
|
-
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2032
|
-
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
2033
2335
|
/** @description Assets to be included by symbol(ticker). */
|
|
2034
2336
|
allowedAssets?: string[];
|
|
2035
2337
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
@@ -2044,6 +2346,10 @@ interface paths {
|
|
|
2044
2346
|
onlyTransactional?: boolean;
|
|
2045
2347
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
2046
2348
|
onlyAppFeatured?: boolean;
|
|
2349
|
+
/** @description Networks to be included (name or CAIP). */
|
|
2350
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
2351
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2352
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
2047
2353
|
/** @description Maximum TVL in USD of the vaults to be included */
|
|
2048
2354
|
maxTvl?: number;
|
|
2049
2355
|
/** @description Tags to be included. */
|
|
@@ -2078,7 +2384,7 @@ interface paths {
|
|
|
2078
2384
|
* @description Name of the network
|
|
2079
2385
|
* @enum {string}
|
|
2080
2386
|
*/
|
|
2081
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2387
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
2082
2388
|
/** @description Chain ID of the network */
|
|
2083
2389
|
chainId: number;
|
|
2084
2390
|
/** @description CAIP-2 of the network */
|
|
@@ -2305,11 +2611,12 @@ interface paths {
|
|
|
2305
2611
|
};
|
|
2306
2612
|
content: {
|
|
2307
2613
|
'application/json': {
|
|
2308
|
-
|
|
2614
|
+
statusCode: number;
|
|
2309
2615
|
/** @enum {string} */
|
|
2310
2616
|
error: 'Bad Request';
|
|
2311
2617
|
message: string;
|
|
2312
|
-
|
|
2618
|
+
errorId?: string;
|
|
2619
|
+
} | unknown;
|
|
2313
2620
|
};
|
|
2314
2621
|
};
|
|
2315
2622
|
/** @description Default Response */
|
|
@@ -2323,7 +2630,8 @@ interface paths {
|
|
|
2323
2630
|
error: 'Unauthorized';
|
|
2324
2631
|
/** @enum {string} */
|
|
2325
2632
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
2326
|
-
|
|
2633
|
+
errorId?: string;
|
|
2634
|
+
} | unknown;
|
|
2327
2635
|
};
|
|
2328
2636
|
};
|
|
2329
2637
|
/** @description Default Response */
|
|
@@ -2337,7 +2645,8 @@ interface paths {
|
|
|
2337
2645
|
error: 'Forbidden';
|
|
2338
2646
|
/** @enum {string} */
|
|
2339
2647
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
2340
|
-
|
|
2648
|
+
errorId?: string;
|
|
2649
|
+
} | unknown;
|
|
2341
2650
|
};
|
|
2342
2651
|
};
|
|
2343
2652
|
/** @description Default Response */
|
|
@@ -2350,13 +2659,28 @@ interface paths {
|
|
|
2350
2659
|
/** @enum {string} */
|
|
2351
2660
|
error: 'Internal Server Error';
|
|
2352
2661
|
message: string;
|
|
2353
|
-
|
|
2662
|
+
errorId?: string;
|
|
2663
|
+
} | unknown;
|
|
2354
2664
|
};
|
|
2355
2665
|
};
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2666
|
+
/** @description Default Response */
|
|
2667
|
+
503: {
|
|
2668
|
+
headers: {
|
|
2669
|
+
[name: string]: unknown;
|
|
2670
|
+
};
|
|
2671
|
+
content: {
|
|
2672
|
+
'application/json': {
|
|
2673
|
+
/** @enum {string} */
|
|
2674
|
+
error: 'Service Unavailable';
|
|
2675
|
+
message: string;
|
|
2676
|
+
errorId?: string;
|
|
2677
|
+
} | unknown;
|
|
2678
|
+
};
|
|
2679
|
+
};
|
|
2680
|
+
};
|
|
2681
|
+
};
|
|
2682
|
+
put?: never;
|
|
2683
|
+
post?: never;
|
|
2360
2684
|
delete?: never;
|
|
2361
2685
|
options?: never;
|
|
2362
2686
|
head?: never;
|
|
@@ -2382,7 +2706,7 @@ interface paths {
|
|
|
2382
2706
|
/** @description User address to be used for best vault calculation */
|
|
2383
2707
|
userAddress: string;
|
|
2384
2708
|
/** @description Include only vaults with provided network(name or CAIP) */
|
|
2385
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
2709
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
2386
2710
|
/** @description Address of the vault for which the data will be returned */
|
|
2387
2711
|
vaultAddress: string;
|
|
2388
2712
|
};
|
|
@@ -2405,7 +2729,7 @@ interface paths {
|
|
|
2405
2729
|
* @description Name of the network
|
|
2406
2730
|
* @enum {string}
|
|
2407
2731
|
*/
|
|
2408
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2732
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
2409
2733
|
/** @description Chain ID of the network */
|
|
2410
2734
|
chainId: number;
|
|
2411
2735
|
/** @description CAIP-2 of the network */
|
|
@@ -2626,11 +2950,12 @@ interface paths {
|
|
|
2626
2950
|
};
|
|
2627
2951
|
content: {
|
|
2628
2952
|
'application/json': {
|
|
2629
|
-
|
|
2953
|
+
statusCode: number;
|
|
2630
2954
|
/** @enum {string} */
|
|
2631
2955
|
error: 'Bad Request';
|
|
2632
2956
|
message: string;
|
|
2633
|
-
|
|
2957
|
+
errorId?: string;
|
|
2958
|
+
} | unknown;
|
|
2634
2959
|
};
|
|
2635
2960
|
};
|
|
2636
2961
|
/** @description Default Response */
|
|
@@ -2644,7 +2969,8 @@ interface paths {
|
|
|
2644
2969
|
error: 'Unauthorized';
|
|
2645
2970
|
/** @enum {string} */
|
|
2646
2971
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
2647
|
-
|
|
2972
|
+
errorId?: string;
|
|
2973
|
+
} | unknown;
|
|
2648
2974
|
};
|
|
2649
2975
|
};
|
|
2650
2976
|
/** @description Default Response */
|
|
@@ -2658,7 +2984,8 @@ interface paths {
|
|
|
2658
2984
|
error: 'Forbidden';
|
|
2659
2985
|
/** @enum {string} */
|
|
2660
2986
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
2661
|
-
|
|
2987
|
+
errorId?: string;
|
|
2988
|
+
} | unknown;
|
|
2662
2989
|
};
|
|
2663
2990
|
};
|
|
2664
2991
|
/** @description Default Response */
|
|
@@ -2671,7 +2998,22 @@ interface paths {
|
|
|
2671
2998
|
/** @enum {string} */
|
|
2672
2999
|
error: 'Internal Server Error';
|
|
2673
3000
|
message: string;
|
|
2674
|
-
|
|
3001
|
+
errorId?: string;
|
|
3002
|
+
} | unknown;
|
|
3003
|
+
};
|
|
3004
|
+
};
|
|
3005
|
+
/** @description Default Response */
|
|
3006
|
+
503: {
|
|
3007
|
+
headers: {
|
|
3008
|
+
[name: string]: unknown;
|
|
3009
|
+
};
|
|
3010
|
+
content: {
|
|
3011
|
+
'application/json': {
|
|
3012
|
+
/** @enum {string} */
|
|
3013
|
+
error: 'Service Unavailable';
|
|
3014
|
+
message: string;
|
|
3015
|
+
errorId?: string;
|
|
3016
|
+
} | unknown;
|
|
2675
3017
|
};
|
|
2676
3018
|
};
|
|
2677
3019
|
};
|
|
@@ -2695,10 +3037,6 @@ interface paths {
|
|
|
2695
3037
|
get: {
|
|
2696
3038
|
parameters: {
|
|
2697
3039
|
query?: {
|
|
2698
|
-
/** @description Networks to be included (name or CAIP). */
|
|
2699
|
-
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
2700
|
-
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2701
|
-
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
2702
3040
|
/** @description Assets to be included by symbol(ticker). */
|
|
2703
3041
|
allowedAssets?: string[];
|
|
2704
3042
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
@@ -2713,6 +3051,10 @@ interface paths {
|
|
|
2713
3051
|
onlyTransactional?: boolean;
|
|
2714
3052
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
2715
3053
|
onlyAppFeatured?: boolean;
|
|
3054
|
+
/** @description Networks to be included (name or CAIP). */
|
|
3055
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
3056
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
3057
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
2716
3058
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
2717
3059
|
apyInterval?: '1day' | '7day' | '30day';
|
|
2718
3060
|
/** @description Minimum APY of the vault to be included */
|
|
@@ -2779,7 +3121,7 @@ interface paths {
|
|
|
2779
3121
|
* @description Name of the network
|
|
2780
3122
|
* @enum {string}
|
|
2781
3123
|
*/
|
|
2782
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3124
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
2783
3125
|
/** @description Chain ID of the network */
|
|
2784
3126
|
chainId: number;
|
|
2785
3127
|
/** @description CAIP-2 of the network */
|
|
@@ -2845,11 +3187,12 @@ interface paths {
|
|
|
2845
3187
|
};
|
|
2846
3188
|
content: {
|
|
2847
3189
|
'application/json': {
|
|
2848
|
-
|
|
3190
|
+
statusCode: number;
|
|
2849
3191
|
/** @enum {string} */
|
|
2850
3192
|
error: 'Bad Request';
|
|
2851
3193
|
message: string;
|
|
2852
|
-
|
|
3194
|
+
errorId?: string;
|
|
3195
|
+
} | unknown;
|
|
2853
3196
|
};
|
|
2854
3197
|
};
|
|
2855
3198
|
/** @description Default Response */
|
|
@@ -2863,7 +3206,8 @@ interface paths {
|
|
|
2863
3206
|
error: 'Unauthorized';
|
|
2864
3207
|
/** @enum {string} */
|
|
2865
3208
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
2866
|
-
|
|
3209
|
+
errorId?: string;
|
|
3210
|
+
} | unknown;
|
|
2867
3211
|
};
|
|
2868
3212
|
};
|
|
2869
3213
|
/** @description Default Response */
|
|
@@ -2877,7 +3221,8 @@ interface paths {
|
|
|
2877
3221
|
error: 'Forbidden';
|
|
2878
3222
|
/** @enum {string} */
|
|
2879
3223
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
2880
|
-
|
|
3224
|
+
errorId?: string;
|
|
3225
|
+
} | unknown;
|
|
2881
3226
|
};
|
|
2882
3227
|
};
|
|
2883
3228
|
/** @description Default Response */
|
|
@@ -2890,7 +3235,22 @@ interface paths {
|
|
|
2890
3235
|
/** @enum {string} */
|
|
2891
3236
|
error: 'Internal Server Error';
|
|
2892
3237
|
message: string;
|
|
2893
|
-
|
|
3238
|
+
errorId?: string;
|
|
3239
|
+
} | unknown;
|
|
3240
|
+
};
|
|
3241
|
+
};
|
|
3242
|
+
/** @description Default Response */
|
|
3243
|
+
503: {
|
|
3244
|
+
headers: {
|
|
3245
|
+
[name: string]: unknown;
|
|
3246
|
+
};
|
|
3247
|
+
content: {
|
|
3248
|
+
'application/json': {
|
|
3249
|
+
/** @enum {string} */
|
|
3250
|
+
error: 'Service Unavailable';
|
|
3251
|
+
message: string;
|
|
3252
|
+
errorId?: string;
|
|
3253
|
+
} | unknown;
|
|
2894
3254
|
};
|
|
2895
3255
|
};
|
|
2896
3256
|
};
|
|
@@ -2910,7 +3270,8 @@ interface paths {
|
|
|
2910
3270
|
path?: never;
|
|
2911
3271
|
cookie?: never;
|
|
2912
3272
|
};
|
|
2913
|
-
/** @description Retrieves the cumulative investment returns for a user's position in a specific vault, showing total yield earned in both native token amount and USD value.
|
|
3273
|
+
/** @description Retrieves the cumulative investment returns for a user's position in a specific vault, showing total yield earned in both native token amount and USD value.
|
|
3274
|
+
* Supported networks: arbitrum, base, mainnet, optimism, polygon, gnosis, celo, swellchain, unichain */
|
|
2914
3275
|
get: {
|
|
2915
3276
|
parameters: {
|
|
2916
3277
|
query?: never;
|
|
@@ -2919,7 +3280,7 @@ interface paths {
|
|
|
2919
3280
|
/** @description User address to get returns for */
|
|
2920
3281
|
userAddress: string;
|
|
2921
3282
|
/** @description Network to get returns for */
|
|
2922
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
3283
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
2923
3284
|
/** @description Vault address to get returns for */
|
|
2924
3285
|
vaultAddress: string;
|
|
2925
3286
|
};
|
|
@@ -2948,11 +3309,12 @@ interface paths {
|
|
|
2948
3309
|
};
|
|
2949
3310
|
content: {
|
|
2950
3311
|
'application/json': {
|
|
2951
|
-
|
|
3312
|
+
statusCode: number;
|
|
2952
3313
|
/** @enum {string} */
|
|
2953
3314
|
error: 'Bad Request';
|
|
2954
3315
|
message: string;
|
|
2955
|
-
|
|
3316
|
+
errorId?: string;
|
|
3317
|
+
} | unknown;
|
|
2956
3318
|
};
|
|
2957
3319
|
};
|
|
2958
3320
|
/** @description Default Response */
|
|
@@ -2966,7 +3328,8 @@ interface paths {
|
|
|
2966
3328
|
error: 'Unauthorized';
|
|
2967
3329
|
/** @enum {string} */
|
|
2968
3330
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
2969
|
-
|
|
3331
|
+
errorId?: string;
|
|
3332
|
+
} | unknown;
|
|
2970
3333
|
};
|
|
2971
3334
|
};
|
|
2972
3335
|
/** @description Default Response */
|
|
@@ -2980,7 +3343,8 @@ interface paths {
|
|
|
2980
3343
|
error: 'Forbidden';
|
|
2981
3344
|
/** @enum {string} */
|
|
2982
3345
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
2983
|
-
|
|
3346
|
+
errorId?: string;
|
|
3347
|
+
} | unknown;
|
|
2984
3348
|
};
|
|
2985
3349
|
};
|
|
2986
3350
|
/** @description Default Response */
|
|
@@ -2993,7 +3357,22 @@ interface paths {
|
|
|
2993
3357
|
/** @enum {string} */
|
|
2994
3358
|
error: 'Internal Server Error';
|
|
2995
3359
|
message: string;
|
|
2996
|
-
|
|
3360
|
+
errorId?: string;
|
|
3361
|
+
} | unknown;
|
|
3362
|
+
};
|
|
3363
|
+
};
|
|
3364
|
+
/** @description Default Response */
|
|
3365
|
+
503: {
|
|
3366
|
+
headers: {
|
|
3367
|
+
[name: string]: unknown;
|
|
3368
|
+
};
|
|
3369
|
+
content: {
|
|
3370
|
+
'application/json': {
|
|
3371
|
+
/** @enum {string} */
|
|
3372
|
+
error: 'Service Unavailable';
|
|
3373
|
+
message: string;
|
|
3374
|
+
errorId?: string;
|
|
3375
|
+
} | unknown;
|
|
2997
3376
|
};
|
|
2998
3377
|
};
|
|
2999
3378
|
};
|
|
@@ -3017,16 +3396,16 @@ interface paths {
|
|
|
3017
3396
|
get: {
|
|
3018
3397
|
parameters: {
|
|
3019
3398
|
query?: {
|
|
3020
|
-
/** @description Networks to be included (name or CAIP). */
|
|
3021
|
-
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
3022
|
-
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
3023
|
-
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094')[];
|
|
3024
3399
|
/** @description Assets to be included by symbol(ticker). */
|
|
3025
3400
|
allowedAssets?: string[];
|
|
3026
3401
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
3027
3402
|
disallowedAssets?: string[];
|
|
3028
3403
|
/** @description Minimum USD value of the asset to be included */
|
|
3029
3404
|
minUsdAssetValueThreshold?: number;
|
|
3405
|
+
/** @description Networks to be included (name or CAIP). */
|
|
3406
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
3407
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
3408
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
|
|
3030
3409
|
};
|
|
3031
3410
|
header?: never;
|
|
3032
3411
|
path: {
|
|
@@ -3072,7 +3451,7 @@ interface paths {
|
|
|
3072
3451
|
* @description Name of the network
|
|
3073
3452
|
* @enum {string}
|
|
3074
3453
|
*/
|
|
3075
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3454
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
3076
3455
|
/** @description Chain ID of the network */
|
|
3077
3456
|
chainId: number;
|
|
3078
3457
|
/** @description CAIP-2 of the network */
|
|
@@ -3093,11 +3472,12 @@ interface paths {
|
|
|
3093
3472
|
};
|
|
3094
3473
|
content: {
|
|
3095
3474
|
'application/json': {
|
|
3096
|
-
|
|
3475
|
+
statusCode: number;
|
|
3097
3476
|
/** @enum {string} */
|
|
3098
3477
|
error: 'Bad Request';
|
|
3099
3478
|
message: string;
|
|
3100
|
-
|
|
3479
|
+
errorId?: string;
|
|
3480
|
+
} | unknown;
|
|
3101
3481
|
};
|
|
3102
3482
|
};
|
|
3103
3483
|
/** @description Default Response */
|
|
@@ -3111,7 +3491,8 @@ interface paths {
|
|
|
3111
3491
|
error: 'Unauthorized';
|
|
3112
3492
|
/** @enum {string} */
|
|
3113
3493
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
3114
|
-
|
|
3494
|
+
errorId?: string;
|
|
3495
|
+
} | unknown;
|
|
3115
3496
|
};
|
|
3116
3497
|
};
|
|
3117
3498
|
/** @description Default Response */
|
|
@@ -3125,7 +3506,8 @@ interface paths {
|
|
|
3125
3506
|
error: 'Forbidden';
|
|
3126
3507
|
/** @enum {string} */
|
|
3127
3508
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
3128
|
-
|
|
3509
|
+
errorId?: string;
|
|
3510
|
+
} | unknown;
|
|
3129
3511
|
};
|
|
3130
3512
|
};
|
|
3131
3513
|
/** @description Default Response */
|
|
@@ -3138,7 +3520,22 @@ interface paths {
|
|
|
3138
3520
|
/** @enum {string} */
|
|
3139
3521
|
error: 'Internal Server Error';
|
|
3140
3522
|
message: string;
|
|
3141
|
-
|
|
3523
|
+
errorId?: string;
|
|
3524
|
+
} | unknown;
|
|
3525
|
+
};
|
|
3526
|
+
};
|
|
3527
|
+
/** @description Default Response */
|
|
3528
|
+
503: {
|
|
3529
|
+
headers: {
|
|
3530
|
+
[name: string]: unknown;
|
|
3531
|
+
};
|
|
3532
|
+
content: {
|
|
3533
|
+
'application/json': {
|
|
3534
|
+
/** @enum {string} */
|
|
3535
|
+
error: 'Service Unavailable';
|
|
3536
|
+
message: string;
|
|
3537
|
+
errorId?: string;
|
|
3538
|
+
} | unknown;
|
|
3142
3539
|
};
|
|
3143
3540
|
};
|
|
3144
3541
|
};
|
|
@@ -3158,7 +3555,8 @@ interface paths {
|
|
|
3158
3555
|
path?: never;
|
|
3159
3556
|
cookie?: never;
|
|
3160
3557
|
};
|
|
3161
|
-
/** @description Retrieves chronological event history for a user's interactions with a specific vault, including deposits, withdrawals, and transfers with timestamp and block number information.
|
|
3558
|
+
/** @description Retrieves chronological event history for a user's interactions with a specific vault, including deposits, withdrawals, and transfers with timestamp and block number information.
|
|
3559
|
+
* Supported networks: arbitrum, base, mainnet, optimism, polygon, gnosis, celo, swellchain, unichain */
|
|
3162
3560
|
get: {
|
|
3163
3561
|
parameters: {
|
|
3164
3562
|
query?: {
|
|
@@ -3176,7 +3574,7 @@ interface paths {
|
|
|
3176
3574
|
/** @description User address to get returns for */
|
|
3177
3575
|
userAddress: string;
|
|
3178
3576
|
/** @description Network to get returns for */
|
|
3179
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
3577
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
3180
3578
|
/** @description Vault address to get returns for */
|
|
3181
3579
|
vaultAddress: string;
|
|
3182
3580
|
};
|
|
@@ -3230,11 +3628,12 @@ interface paths {
|
|
|
3230
3628
|
};
|
|
3231
3629
|
content: {
|
|
3232
3630
|
'application/json': {
|
|
3233
|
-
|
|
3631
|
+
statusCode: number;
|
|
3234
3632
|
/** @enum {string} */
|
|
3235
3633
|
error: 'Bad Request';
|
|
3236
3634
|
message: string;
|
|
3237
|
-
|
|
3635
|
+
errorId?: string;
|
|
3636
|
+
} | unknown;
|
|
3238
3637
|
};
|
|
3239
3638
|
};
|
|
3240
3639
|
/** @description Default Response */
|
|
@@ -3248,7 +3647,8 @@ interface paths {
|
|
|
3248
3647
|
error: 'Unauthorized';
|
|
3249
3648
|
/** @enum {string} */
|
|
3250
3649
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
3251
|
-
|
|
3650
|
+
errorId?: string;
|
|
3651
|
+
} | unknown;
|
|
3252
3652
|
};
|
|
3253
3653
|
};
|
|
3254
3654
|
/** @description Default Response */
|
|
@@ -3262,7 +3662,8 @@ interface paths {
|
|
|
3262
3662
|
error: 'Forbidden';
|
|
3263
3663
|
/** @enum {string} */
|
|
3264
3664
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
3265
|
-
|
|
3665
|
+
errorId?: string;
|
|
3666
|
+
} | unknown;
|
|
3266
3667
|
};
|
|
3267
3668
|
};
|
|
3268
3669
|
/** @description Default Response */
|
|
@@ -3275,7 +3676,22 @@ interface paths {
|
|
|
3275
3676
|
/** @enum {string} */
|
|
3276
3677
|
error: 'Internal Server Error';
|
|
3277
3678
|
message: string;
|
|
3278
|
-
|
|
3679
|
+
errorId?: string;
|
|
3680
|
+
} | unknown;
|
|
3681
|
+
};
|
|
3682
|
+
};
|
|
3683
|
+
/** @description Default Response */
|
|
3684
|
+
503: {
|
|
3685
|
+
headers: {
|
|
3686
|
+
[name: string]: unknown;
|
|
3687
|
+
};
|
|
3688
|
+
content: {
|
|
3689
|
+
'application/json': {
|
|
3690
|
+
/** @enum {string} */
|
|
3691
|
+
error: 'Service Unavailable';
|
|
3692
|
+
message: string;
|
|
3693
|
+
errorId?: string;
|
|
3694
|
+
} | unknown;
|
|
3279
3695
|
};
|
|
3280
3696
|
};
|
|
3281
3697
|
};
|
|
@@ -3304,7 +3720,7 @@ interface paths {
|
|
|
3304
3720
|
/** @description User address */
|
|
3305
3721
|
userAddress: string;
|
|
3306
3722
|
/** @description Network name */
|
|
3307
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3723
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
3308
3724
|
/** @description Vault address */
|
|
3309
3725
|
vaultAddress: string;
|
|
3310
3726
|
};
|
|
@@ -3529,7 +3945,7 @@ interface paths {
|
|
|
3529
3945
|
* @description Network of the reward
|
|
3530
3946
|
* @enum {string}
|
|
3531
3947
|
*/
|
|
3532
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3948
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
|
|
3533
3949
|
};
|
|
3534
3950
|
}[];
|
|
3535
3951
|
/**
|
|
@@ -3549,6 +3965,21 @@ interface paths {
|
|
|
3549
3965
|
};
|
|
3550
3966
|
};
|
|
3551
3967
|
/** @description Default Response */
|
|
3968
|
+
400: {
|
|
3969
|
+
headers: {
|
|
3970
|
+
[name: string]: unknown;
|
|
3971
|
+
};
|
|
3972
|
+
content: {
|
|
3973
|
+
'application/json': {
|
|
3974
|
+
statusCode: number;
|
|
3975
|
+
/** @enum {string} */
|
|
3976
|
+
error: 'Bad Request';
|
|
3977
|
+
message: string;
|
|
3978
|
+
errorId?: string;
|
|
3979
|
+
} | unknown;
|
|
3980
|
+
};
|
|
3981
|
+
};
|
|
3982
|
+
/** @description Default Response */
|
|
3552
3983
|
401: {
|
|
3553
3984
|
headers: {
|
|
3554
3985
|
[name: string]: unknown;
|
|
@@ -3559,7 +3990,8 @@ interface paths {
|
|
|
3559
3990
|
error: 'Unauthorized';
|
|
3560
3991
|
/** @enum {string} */
|
|
3561
3992
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
3562
|
-
|
|
3993
|
+
errorId?: string;
|
|
3994
|
+
} | unknown;
|
|
3563
3995
|
};
|
|
3564
3996
|
};
|
|
3565
3997
|
/** @description Default Response */
|
|
@@ -3573,7 +4005,8 @@ interface paths {
|
|
|
3573
4005
|
error: 'Forbidden';
|
|
3574
4006
|
/** @enum {string} */
|
|
3575
4007
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
3576
|
-
|
|
4008
|
+
errorId?: string;
|
|
4009
|
+
} | unknown;
|
|
3577
4010
|
};
|
|
3578
4011
|
};
|
|
3579
4012
|
/** @description Default Response */
|
|
@@ -3586,7 +4019,22 @@ interface paths {
|
|
|
3586
4019
|
/** @enum {string} */
|
|
3587
4020
|
error: 'Internal Server Error';
|
|
3588
4021
|
message: string;
|
|
3589
|
-
|
|
4022
|
+
errorId?: string;
|
|
4023
|
+
} | unknown;
|
|
4024
|
+
};
|
|
4025
|
+
};
|
|
4026
|
+
/** @description Default Response */
|
|
4027
|
+
503: {
|
|
4028
|
+
headers: {
|
|
4029
|
+
[name: string]: unknown;
|
|
4030
|
+
};
|
|
4031
|
+
content: {
|
|
4032
|
+
'application/json': {
|
|
4033
|
+
/** @enum {string} */
|
|
4034
|
+
error: 'Service Unavailable';
|
|
4035
|
+
message: string;
|
|
4036
|
+
errorId?: string;
|
|
4037
|
+
} | unknown;
|
|
3590
4038
|
};
|
|
3591
4039
|
};
|
|
3592
4040
|
};
|
|
@@ -3626,7 +4074,7 @@ interface paths {
|
|
|
3626
4074
|
/** @description User address to get returns for */
|
|
3627
4075
|
userAddress: string;
|
|
3628
4076
|
/** @description Network to get returns for */
|
|
3629
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094';
|
|
4077
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
3630
4078
|
/** @description Vault address to get returns for */
|
|
3631
4079
|
vaultAddress: string;
|
|
3632
4080
|
};
|
|
@@ -3677,6 +4125,21 @@ interface paths {
|
|
|
3677
4125
|
};
|
|
3678
4126
|
};
|
|
3679
4127
|
/** @description Default Response */
|
|
4128
|
+
400: {
|
|
4129
|
+
headers: {
|
|
4130
|
+
[name: string]: unknown;
|
|
4131
|
+
};
|
|
4132
|
+
content: {
|
|
4133
|
+
'application/json': {
|
|
4134
|
+
statusCode: number;
|
|
4135
|
+
/** @enum {string} */
|
|
4136
|
+
error: 'Bad Request';
|
|
4137
|
+
message: string;
|
|
4138
|
+
errorId?: string;
|
|
4139
|
+
} | unknown;
|
|
4140
|
+
};
|
|
4141
|
+
};
|
|
4142
|
+
/** @description Default Response */
|
|
3680
4143
|
401: {
|
|
3681
4144
|
headers: {
|
|
3682
4145
|
[name: string]: unknown;
|
|
@@ -3687,7 +4150,8 @@ interface paths {
|
|
|
3687
4150
|
error: 'Unauthorized';
|
|
3688
4151
|
/** @enum {string} */
|
|
3689
4152
|
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
3690
|
-
|
|
4153
|
+
errorId?: string;
|
|
4154
|
+
} | unknown;
|
|
3691
4155
|
};
|
|
3692
4156
|
};
|
|
3693
4157
|
/** @description Default Response */
|
|
@@ -3701,7 +4165,8 @@ interface paths {
|
|
|
3701
4165
|
error: 'Forbidden';
|
|
3702
4166
|
/** @enum {string} */
|
|
3703
4167
|
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
3704
|
-
|
|
4168
|
+
errorId?: string;
|
|
4169
|
+
} | unknown;
|
|
3705
4170
|
};
|
|
3706
4171
|
};
|
|
3707
4172
|
/** @description Default Response */
|
|
@@ -3714,7 +4179,22 @@ interface paths {
|
|
|
3714
4179
|
/** @enum {string} */
|
|
3715
4180
|
error: 'Internal Server Error';
|
|
3716
4181
|
message: string;
|
|
3717
|
-
|
|
4182
|
+
errorId?: string;
|
|
4183
|
+
} | unknown;
|
|
4184
|
+
};
|
|
4185
|
+
};
|
|
4186
|
+
/** @description Default Response */
|
|
4187
|
+
503: {
|
|
4188
|
+
headers: {
|
|
4189
|
+
[name: string]: unknown;
|
|
4190
|
+
};
|
|
4191
|
+
content: {
|
|
4192
|
+
'application/json': {
|
|
4193
|
+
/** @enum {string} */
|
|
4194
|
+
error: 'Service Unavailable';
|
|
4195
|
+
message: string;
|
|
4196
|
+
errorId?: string;
|
|
4197
|
+
} | unknown;
|
|
3718
4198
|
};
|
|
3719
4199
|
};
|
|
3720
4200
|
};
|
|
@@ -3727,124 +4207,426 @@ interface paths {
|
|
|
3727
4207
|
patch?: never;
|
|
3728
4208
|
trace?: never;
|
|
3729
4209
|
};
|
|
3730
|
-
}
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
apiBaseUrl: string;
|
|
3737
|
-
}
|
|
3738
|
-
type EndpointV2 = keyof paths;
|
|
3739
|
-
type ExtractParamsV2<T> = T extends {
|
|
3740
|
-
parameters: infer P extends {
|
|
3741
|
-
path?: any;
|
|
3742
|
-
query?: any;
|
|
3743
|
-
};
|
|
3744
|
-
} ? Pick<P, 'path' | 'query'> : never;
|
|
3745
|
-
type BodyV2<T extends EndpointV2> = paths[T]['post'] extends {
|
|
3746
|
-
requestBody: {
|
|
3747
|
-
content: {
|
|
3748
|
-
'application/json': infer R;
|
|
3749
|
-
};
|
|
3750
|
-
};
|
|
3751
|
-
} ? {
|
|
3752
|
-
body: R;
|
|
3753
|
-
} : paths[T]['post'] extends {
|
|
3754
|
-
requestBody?: {
|
|
3755
|
-
content: {
|
|
3756
|
-
'application/json': infer R;
|
|
3757
|
-
};
|
|
3758
|
-
};
|
|
3759
|
-
} ? {
|
|
3760
|
-
body?: R;
|
|
3761
|
-
} : undefined;
|
|
3762
|
-
type ParamsV2<T extends EndpointV2> = BodyV2<T> extends undefined ? ExtractParamsV2<paths[T]['get' | 'post']> : ExtractParamsV2<paths[T]['get' | 'post']> & BodyV2<T>;
|
|
3763
|
-
declare class VaultsSdk {
|
|
3764
|
-
private apiBaseUrl;
|
|
3765
|
-
private apiKey;
|
|
3766
|
-
constructor(options: ConstructorOptions);
|
|
3767
|
-
constructor(options: ConstructorOptions, internalOptions: InternalOptions);
|
|
3768
|
-
private fetchData;
|
|
3769
|
-
getBenchmarks(): Promise<{
|
|
3770
|
-
usd: {
|
|
3771
|
-
name: string;
|
|
3772
|
-
apy: {
|
|
3773
|
-
"1day": number;
|
|
3774
|
-
"7day": number;
|
|
3775
|
-
"30day": number;
|
|
3776
|
-
};
|
|
3777
|
-
vaults: {
|
|
3778
|
-
name: string;
|
|
3779
|
-
network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
3780
|
-
address: string;
|
|
3781
|
-
}[];
|
|
3782
|
-
};
|
|
3783
|
-
eth: {
|
|
3784
|
-
name: string;
|
|
3785
|
-
apy: {
|
|
3786
|
-
"1day": number;
|
|
3787
|
-
"7day": number;
|
|
3788
|
-
"30day": number;
|
|
3789
|
-
};
|
|
3790
|
-
vaults: {
|
|
3791
|
-
name: string;
|
|
3792
|
-
network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
3793
|
-
address: string;
|
|
3794
|
-
}[];
|
|
4210
|
+
'/v2/benchmarks/{network}': {
|
|
4211
|
+
parameters: {
|
|
4212
|
+
query?: never;
|
|
4213
|
+
header?: never;
|
|
4214
|
+
path?: never;
|
|
4215
|
+
cookie?: never;
|
|
3795
4216
|
};
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
usd: string;
|
|
3810
|
-
native: string;
|
|
3811
|
-
};
|
|
3812
|
-
}[];
|
|
3813
|
-
}>;
|
|
3814
|
-
getVaultTotalReturns(params: ParamsV2<'/v2/portfolio/returns/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
3815
|
-
usd: string;
|
|
3816
|
-
native: string;
|
|
3817
|
-
}>;
|
|
3818
|
-
getPositions(params: ParamsV2<'/v2/portfolio/positions/{userAddress}'>): Promise<{
|
|
3819
|
-
data: {
|
|
3820
|
-
address: string;
|
|
3821
|
-
network: {
|
|
3822
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
3823
|
-
chainId: number;
|
|
3824
|
-
networkCaip: string;
|
|
3825
|
-
};
|
|
3826
|
-
asset: {
|
|
3827
|
-
address: string;
|
|
3828
|
-
assetCaip: string;
|
|
3829
|
-
name: string;
|
|
3830
|
-
symbol: string;
|
|
3831
|
-
decimals: number;
|
|
3832
|
-
assetLogo?: string;
|
|
3833
|
-
assetPriceInUsd?: string;
|
|
3834
|
-
balanceNative: string;
|
|
3835
|
-
balanceUsd: string;
|
|
3836
|
-
unclaimedNative?: string;
|
|
3837
|
-
unclaimedUsd?: string;
|
|
3838
|
-
positionValueInAsset?: string;
|
|
4217
|
+
/** @description Retrieves benchmark APY data for the specified network and benchmark code. */
|
|
4218
|
+
get: {
|
|
4219
|
+
parameters: {
|
|
4220
|
+
query: {
|
|
4221
|
+
/** @description Benchmark code identifier. Available codes: usd, eth */
|
|
4222
|
+
code: 'usd' | 'eth';
|
|
4223
|
+
};
|
|
4224
|
+
header?: never;
|
|
4225
|
+
path: {
|
|
4226
|
+
/** @description Network name or CAIP-2 identifier */
|
|
4227
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
4228
|
+
};
|
|
4229
|
+
cookie?: never;
|
|
3839
4230
|
};
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
|
|
4231
|
+
requestBody?: never;
|
|
4232
|
+
responses: {
|
|
4233
|
+
/** @description Default Response */
|
|
4234
|
+
200: {
|
|
4235
|
+
headers: {
|
|
4236
|
+
[name: string]: unknown;
|
|
4237
|
+
};
|
|
4238
|
+
content: {
|
|
4239
|
+
'application/json': {
|
|
4240
|
+
/** @description APY interval breakdown for the benchmark */
|
|
4241
|
+
apy: {
|
|
4242
|
+
/** @description 1day APY details */
|
|
4243
|
+
'1day': {
|
|
4244
|
+
/** @description Base APY */
|
|
4245
|
+
base: number;
|
|
4246
|
+
/** @description Reward APY */
|
|
4247
|
+
reward: number;
|
|
4248
|
+
/** @description Total APY */
|
|
4249
|
+
total: number;
|
|
4250
|
+
};
|
|
4251
|
+
/** @description 7day APY details */
|
|
4252
|
+
'7day': {
|
|
4253
|
+
/** @description Base APY */
|
|
4254
|
+
base: number;
|
|
4255
|
+
/** @description Reward APY */
|
|
4256
|
+
reward: number;
|
|
4257
|
+
/** @description Total APY */
|
|
4258
|
+
total: number;
|
|
4259
|
+
};
|
|
4260
|
+
/** @description 30day APY details */
|
|
4261
|
+
'30day': {
|
|
4262
|
+
/** @description Base APY */
|
|
4263
|
+
base: number;
|
|
4264
|
+
/** @description Reward APY */
|
|
4265
|
+
reward: number;
|
|
4266
|
+
/** @description Total APY */
|
|
4267
|
+
total: number;
|
|
4268
|
+
};
|
|
4269
|
+
} | null;
|
|
4270
|
+
/** @description Timestamp of the benchmark data point */
|
|
4271
|
+
timestamp: number;
|
|
4272
|
+
};
|
|
4273
|
+
};
|
|
4274
|
+
};
|
|
4275
|
+
/** @description Default Response */
|
|
4276
|
+
400: {
|
|
4277
|
+
headers: {
|
|
4278
|
+
[name: string]: unknown;
|
|
4279
|
+
};
|
|
4280
|
+
content: {
|
|
4281
|
+
'application/json': {
|
|
4282
|
+
statusCode: number;
|
|
4283
|
+
/** @enum {string} */
|
|
4284
|
+
error: 'Bad Request';
|
|
4285
|
+
message: string;
|
|
4286
|
+
errorId?: string;
|
|
4287
|
+
} | unknown;
|
|
4288
|
+
};
|
|
4289
|
+
};
|
|
4290
|
+
/** @description Default Response */
|
|
4291
|
+
401: {
|
|
4292
|
+
headers: {
|
|
4293
|
+
[name: string]: unknown;
|
|
4294
|
+
};
|
|
4295
|
+
content: {
|
|
4296
|
+
'application/json': {
|
|
4297
|
+
/** @enum {string} */
|
|
4298
|
+
error: 'Unauthorized';
|
|
4299
|
+
/** @enum {string} */
|
|
4300
|
+
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
4301
|
+
errorId?: string;
|
|
4302
|
+
} | unknown;
|
|
4303
|
+
};
|
|
4304
|
+
};
|
|
4305
|
+
/** @description Default Response */
|
|
4306
|
+
403: {
|
|
4307
|
+
headers: {
|
|
4308
|
+
[name: string]: unknown;
|
|
4309
|
+
};
|
|
4310
|
+
content: {
|
|
4311
|
+
'application/json': {
|
|
4312
|
+
/** @enum {string} */
|
|
4313
|
+
error: 'Forbidden';
|
|
4314
|
+
/** @enum {string} */
|
|
4315
|
+
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
4316
|
+
errorId?: string;
|
|
4317
|
+
} | unknown;
|
|
4318
|
+
};
|
|
4319
|
+
};
|
|
4320
|
+
/** @description Default Response */
|
|
4321
|
+
500: {
|
|
4322
|
+
headers: {
|
|
4323
|
+
[name: string]: unknown;
|
|
4324
|
+
};
|
|
4325
|
+
content: {
|
|
4326
|
+
'application/json': {
|
|
4327
|
+
/** @enum {string} */
|
|
4328
|
+
error: 'Internal Server Error';
|
|
4329
|
+
message: string;
|
|
4330
|
+
errorId?: string;
|
|
4331
|
+
} | unknown;
|
|
4332
|
+
};
|
|
4333
|
+
};
|
|
4334
|
+
/** @description Default Response */
|
|
4335
|
+
503: {
|
|
4336
|
+
headers: {
|
|
4337
|
+
[name: string]: unknown;
|
|
4338
|
+
};
|
|
4339
|
+
content: {
|
|
4340
|
+
'application/json': {
|
|
4341
|
+
/** @enum {string} */
|
|
4342
|
+
error: 'Service Unavailable';
|
|
4343
|
+
message: string;
|
|
4344
|
+
errorId?: string;
|
|
4345
|
+
} | unknown;
|
|
4346
|
+
};
|
|
4347
|
+
};
|
|
4348
|
+
};
|
|
4349
|
+
};
|
|
4350
|
+
put?: never;
|
|
4351
|
+
post?: never;
|
|
4352
|
+
delete?: never;
|
|
4353
|
+
options?: never;
|
|
4354
|
+
head?: never;
|
|
4355
|
+
patch?: never;
|
|
4356
|
+
trace?: never;
|
|
4357
|
+
};
|
|
4358
|
+
'/v2/historical-benchmarks/{network}': {
|
|
4359
|
+
parameters: {
|
|
4360
|
+
query?: never;
|
|
4361
|
+
header?: never;
|
|
4362
|
+
path?: never;
|
|
4363
|
+
cookie?: never;
|
|
4364
|
+
};
|
|
4365
|
+
/** @description Retrieves historical benchmark APY data for the specified network and benchmark code with pagination. */
|
|
4366
|
+
get: {
|
|
4367
|
+
parameters: {
|
|
4368
|
+
query: {
|
|
4369
|
+
/** @description Page number (starting from 0) */
|
|
4370
|
+
page?: number;
|
|
4371
|
+
/** @description Number of items per page */
|
|
4372
|
+
perPage?: number;
|
|
4373
|
+
/** @description Benchmark code identifier. Available codes: usd, eth */
|
|
4374
|
+
code: 'usd' | 'eth';
|
|
4375
|
+
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
4376
|
+
fromTimestamp?: number;
|
|
4377
|
+
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
4378
|
+
toTimestamp?: number;
|
|
4379
|
+
};
|
|
4380
|
+
header?: never;
|
|
4381
|
+
path: {
|
|
4382
|
+
/** @description Network name or CAIP-2 identifier */
|
|
4383
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
|
|
4384
|
+
};
|
|
4385
|
+
cookie?: never;
|
|
4386
|
+
};
|
|
4387
|
+
requestBody?: never;
|
|
4388
|
+
responses: {
|
|
4389
|
+
/** @description Default Response */
|
|
4390
|
+
200: {
|
|
4391
|
+
headers: {
|
|
4392
|
+
[name: string]: unknown;
|
|
4393
|
+
};
|
|
4394
|
+
content: {
|
|
4395
|
+
'application/json': {
|
|
4396
|
+
/** @description Number of items on the current page */
|
|
4397
|
+
itemsOnPage: number;
|
|
4398
|
+
/** @description Next page number */
|
|
4399
|
+
nextPage?: number;
|
|
4400
|
+
data: {
|
|
4401
|
+
/** @description APY interval breakdown for the benchmark */
|
|
4402
|
+
apy: {
|
|
4403
|
+
/** @description 1day APY details */
|
|
4404
|
+
'1day': {
|
|
4405
|
+
/** @description Base APY */
|
|
4406
|
+
base: number;
|
|
4407
|
+
/** @description Reward APY */
|
|
4408
|
+
reward: number;
|
|
4409
|
+
/** @description Total APY */
|
|
4410
|
+
total: number;
|
|
4411
|
+
};
|
|
4412
|
+
/** @description 7day APY details */
|
|
4413
|
+
'7day': {
|
|
4414
|
+
/** @description Base APY */
|
|
4415
|
+
base: number;
|
|
4416
|
+
/** @description Reward APY */
|
|
4417
|
+
reward: number;
|
|
4418
|
+
/** @description Total APY */
|
|
4419
|
+
total: number;
|
|
4420
|
+
};
|
|
4421
|
+
/** @description 30day APY details */
|
|
4422
|
+
'30day': {
|
|
4423
|
+
/** @description Base APY */
|
|
4424
|
+
base: number;
|
|
4425
|
+
/** @description Reward APY */
|
|
4426
|
+
reward: number;
|
|
4427
|
+
/** @description Total APY */
|
|
4428
|
+
total: number;
|
|
4429
|
+
};
|
|
4430
|
+
} | null;
|
|
4431
|
+
/** @description Timestamp of the benchmark data point */
|
|
4432
|
+
timestamp: number;
|
|
4433
|
+
}[];
|
|
4434
|
+
};
|
|
4435
|
+
};
|
|
4436
|
+
};
|
|
4437
|
+
/** @description Default Response */
|
|
4438
|
+
400: {
|
|
4439
|
+
headers: {
|
|
4440
|
+
[name: string]: unknown;
|
|
4441
|
+
};
|
|
4442
|
+
content: {
|
|
4443
|
+
'application/json': {
|
|
4444
|
+
statusCode: number;
|
|
4445
|
+
/** @enum {string} */
|
|
4446
|
+
error: 'Bad Request';
|
|
4447
|
+
message: string;
|
|
4448
|
+
errorId?: string;
|
|
4449
|
+
} | unknown;
|
|
4450
|
+
};
|
|
4451
|
+
};
|
|
4452
|
+
/** @description Default Response */
|
|
4453
|
+
401: {
|
|
4454
|
+
headers: {
|
|
4455
|
+
[name: string]: unknown;
|
|
4456
|
+
};
|
|
4457
|
+
content: {
|
|
4458
|
+
'application/json': {
|
|
4459
|
+
/** @enum {string} */
|
|
4460
|
+
error: 'Unauthorized';
|
|
4461
|
+
/** @enum {string} */
|
|
4462
|
+
message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
|
|
4463
|
+
errorId?: string;
|
|
4464
|
+
} | unknown;
|
|
4465
|
+
};
|
|
4466
|
+
};
|
|
4467
|
+
/** @description Default Response */
|
|
4468
|
+
403: {
|
|
4469
|
+
headers: {
|
|
4470
|
+
[name: string]: unknown;
|
|
4471
|
+
};
|
|
4472
|
+
content: {
|
|
4473
|
+
'application/json': {
|
|
4474
|
+
/** @enum {string} */
|
|
4475
|
+
error: 'Forbidden';
|
|
4476
|
+
/** @enum {string} */
|
|
4477
|
+
message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
|
|
4478
|
+
errorId?: string;
|
|
4479
|
+
} | unknown;
|
|
4480
|
+
};
|
|
4481
|
+
};
|
|
4482
|
+
/** @description Default Response */
|
|
4483
|
+
500: {
|
|
4484
|
+
headers: {
|
|
4485
|
+
[name: string]: unknown;
|
|
4486
|
+
};
|
|
4487
|
+
content: {
|
|
4488
|
+
'application/json': {
|
|
4489
|
+
/** @enum {string} */
|
|
4490
|
+
error: 'Internal Server Error';
|
|
4491
|
+
message: string;
|
|
4492
|
+
errorId?: string;
|
|
4493
|
+
} | unknown;
|
|
4494
|
+
};
|
|
4495
|
+
};
|
|
4496
|
+
/** @description Default Response */
|
|
4497
|
+
503: {
|
|
4498
|
+
headers: {
|
|
4499
|
+
[name: string]: unknown;
|
|
4500
|
+
};
|
|
4501
|
+
content: {
|
|
4502
|
+
'application/json': {
|
|
4503
|
+
/** @enum {string} */
|
|
4504
|
+
error: 'Service Unavailable';
|
|
4505
|
+
message: string;
|
|
4506
|
+
errorId?: string;
|
|
4507
|
+
} | unknown;
|
|
4508
|
+
};
|
|
4509
|
+
};
|
|
4510
|
+
};
|
|
4511
|
+
};
|
|
4512
|
+
put?: never;
|
|
4513
|
+
post?: never;
|
|
4514
|
+
delete?: never;
|
|
4515
|
+
options?: never;
|
|
4516
|
+
head?: never;
|
|
4517
|
+
patch?: never;
|
|
4518
|
+
trace?: never;
|
|
4519
|
+
};
|
|
4520
|
+
}
|
|
4521
|
+
|
|
4522
|
+
interface ConstructorOptions {
|
|
4523
|
+
apiKey: string;
|
|
4524
|
+
}
|
|
4525
|
+
interface InternalOptions {
|
|
4526
|
+
apiBaseUrl: string;
|
|
4527
|
+
}
|
|
4528
|
+
type Endpoint = keyof paths;
|
|
4529
|
+
type ExtractParams<T> = T extends {
|
|
4530
|
+
parameters: infer P extends {
|
|
4531
|
+
path?: any;
|
|
4532
|
+
query?: any;
|
|
4533
|
+
};
|
|
4534
|
+
} ? Pick<P, 'path' | 'query'> : never;
|
|
4535
|
+
type Body<T extends Endpoint> = paths[T]['post'] extends {
|
|
4536
|
+
requestBody: {
|
|
4537
|
+
content: {
|
|
4538
|
+
'application/json': infer R;
|
|
4539
|
+
};
|
|
4540
|
+
};
|
|
4541
|
+
} ? {
|
|
4542
|
+
body: R;
|
|
4543
|
+
} : paths[T]['post'] extends {
|
|
4544
|
+
requestBody?: {
|
|
4545
|
+
content: {
|
|
4546
|
+
'application/json': infer R;
|
|
4547
|
+
};
|
|
4548
|
+
};
|
|
4549
|
+
} ? {
|
|
4550
|
+
body?: R;
|
|
4551
|
+
} : undefined;
|
|
4552
|
+
type Params<T extends Endpoint> = Body<T> extends undefined ? ExtractParams<paths[T]['get' | 'post']> : ExtractParams<paths[T]['get' | 'post']> & Body<T>;
|
|
4553
|
+
declare class VaultsSdk {
|
|
4554
|
+
private apiBaseUrl;
|
|
4555
|
+
private apiKey;
|
|
4556
|
+
constructor(options: ConstructorOptions);
|
|
4557
|
+
constructor(options: ConstructorOptions, internalOptions: InternalOptions);
|
|
4558
|
+
private fetchData;
|
|
4559
|
+
getBenchmarks(params: Params<'/v2/benchmarks/{network}'>): Promise<{
|
|
4560
|
+
apy: {
|
|
4561
|
+
"1day": {
|
|
4562
|
+
base: number;
|
|
4563
|
+
reward: number;
|
|
4564
|
+
total: number;
|
|
4565
|
+
};
|
|
4566
|
+
"7day": {
|
|
4567
|
+
base: number;
|
|
4568
|
+
reward: number;
|
|
4569
|
+
total: number;
|
|
4570
|
+
};
|
|
4571
|
+
"30day": {
|
|
4572
|
+
base: number;
|
|
4573
|
+
reward: number;
|
|
4574
|
+
total: number;
|
|
4575
|
+
};
|
|
4576
|
+
} | null;
|
|
4577
|
+
timestamp: number;
|
|
4578
|
+
}>;
|
|
4579
|
+
getVaultHistoricalData(params: Params<'/v2/historical/{network}/{vaultAddress}'>): Promise<{
|
|
4580
|
+
itemsOnPage: number;
|
|
4581
|
+
nextPage?: number;
|
|
4582
|
+
data: {
|
|
4583
|
+
timestamp: number;
|
|
4584
|
+
blockNumber: string;
|
|
4585
|
+
apy: {
|
|
4586
|
+
base: number;
|
|
4587
|
+
reward: number;
|
|
4588
|
+
total: number;
|
|
4589
|
+
};
|
|
4590
|
+
tvl: {
|
|
4591
|
+
usd: string;
|
|
4592
|
+
native: string;
|
|
4593
|
+
};
|
|
4594
|
+
}[];
|
|
4595
|
+
}>;
|
|
4596
|
+
getVaultTotalReturns(params: Params<'/v2/portfolio/returns/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4597
|
+
usd: string;
|
|
4598
|
+
native: string;
|
|
4599
|
+
}>;
|
|
4600
|
+
getPositions(params: Params<'/v2/portfolio/positions/{userAddress}'>): Promise<{
|
|
4601
|
+
data: {
|
|
4602
|
+
address: string;
|
|
4603
|
+
network: {
|
|
4604
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4605
|
+
chainId: number;
|
|
4606
|
+
networkCaip: string;
|
|
4607
|
+
};
|
|
4608
|
+
asset: {
|
|
4609
|
+
address: string;
|
|
4610
|
+
assetCaip: string;
|
|
4611
|
+
name: string;
|
|
4612
|
+
symbol: string;
|
|
4613
|
+
decimals: number;
|
|
4614
|
+
assetLogo?: string;
|
|
4615
|
+
assetPriceInUsd?: string;
|
|
4616
|
+
balanceNative: string;
|
|
4617
|
+
balanceUsd: string;
|
|
4618
|
+
unclaimedNative?: string;
|
|
4619
|
+
unclaimedUsd?: string;
|
|
4620
|
+
positionValueInAsset?: string;
|
|
4621
|
+
};
|
|
4622
|
+
isTransactional: boolean;
|
|
4623
|
+
isAppFeatured: boolean;
|
|
4624
|
+
name: string;
|
|
4625
|
+
protocol: {
|
|
4626
|
+
name: string;
|
|
4627
|
+
product?: string;
|
|
4628
|
+
version?: string;
|
|
4629
|
+
protocolUrl?: string;
|
|
3848
4630
|
description?: string;
|
|
3849
4631
|
protocolLogo?: string;
|
|
3850
4632
|
};
|
|
@@ -3931,7 +4713,116 @@ declare class VaultsSdk {
|
|
|
3931
4713
|
unsupportedProtocols: string[];
|
|
3932
4714
|
};
|
|
3933
4715
|
}>;
|
|
3934
|
-
|
|
4716
|
+
getPosition(params: Params<'/v2/portfolio/positions/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4717
|
+
address: string;
|
|
4718
|
+
network: {
|
|
4719
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4720
|
+
chainId: number;
|
|
4721
|
+
networkCaip: string;
|
|
4722
|
+
};
|
|
4723
|
+
asset: {
|
|
4724
|
+
address: string;
|
|
4725
|
+
assetCaip: string;
|
|
4726
|
+
name: string;
|
|
4727
|
+
symbol: string;
|
|
4728
|
+
decimals: number;
|
|
4729
|
+
assetLogo?: string;
|
|
4730
|
+
assetPriceInUsd?: string;
|
|
4731
|
+
balanceNative: string;
|
|
4732
|
+
balanceUsd: string;
|
|
4733
|
+
unclaimedNative?: string;
|
|
4734
|
+
unclaimedUsd?: string;
|
|
4735
|
+
positionValueInAsset?: string;
|
|
4736
|
+
};
|
|
4737
|
+
isTransactional: boolean;
|
|
4738
|
+
isAppFeatured: boolean;
|
|
4739
|
+
name: string;
|
|
4740
|
+
protocol: {
|
|
4741
|
+
name: string;
|
|
4742
|
+
product?: string;
|
|
4743
|
+
version?: string;
|
|
4744
|
+
protocolUrl?: string;
|
|
4745
|
+
description?: string;
|
|
4746
|
+
protocolLogo?: string;
|
|
4747
|
+
};
|
|
4748
|
+
apy: {
|
|
4749
|
+
base: number;
|
|
4750
|
+
reward: number;
|
|
4751
|
+
total: number;
|
|
4752
|
+
};
|
|
4753
|
+
additionalAssets?: {
|
|
4754
|
+
address: string;
|
|
4755
|
+
assetCaip: string;
|
|
4756
|
+
name: string;
|
|
4757
|
+
symbol: string;
|
|
4758
|
+
decimals: number;
|
|
4759
|
+
assetLogo?: string;
|
|
4760
|
+
assetPriceInUsd?: string;
|
|
4761
|
+
balanceNative: string;
|
|
4762
|
+
balanceUsd: string;
|
|
4763
|
+
unclaimedNative?: string;
|
|
4764
|
+
unclaimedUsd?: string;
|
|
4765
|
+
positionValueInAsset?: string;
|
|
4766
|
+
}[];
|
|
4767
|
+
lpToken?: {
|
|
4768
|
+
address: string;
|
|
4769
|
+
tokenCaip: string;
|
|
4770
|
+
name: string;
|
|
4771
|
+
symbol: string;
|
|
4772
|
+
decimals: number;
|
|
4773
|
+
balanceNative: string;
|
|
4774
|
+
balanceUsd: string;
|
|
4775
|
+
unclaimedNative?: string;
|
|
4776
|
+
unclaimedUsd?: string;
|
|
4777
|
+
positionValueInAsset?: string;
|
|
4778
|
+
assetPriceInUsd?: string;
|
|
4779
|
+
};
|
|
4780
|
+
childrenVaults?: {
|
|
4781
|
+
address: string;
|
|
4782
|
+
asset: {
|
|
4783
|
+
address: string;
|
|
4784
|
+
assetCaip: string;
|
|
4785
|
+
name: string;
|
|
4786
|
+
symbol: string;
|
|
4787
|
+
decimals: number;
|
|
4788
|
+
assetLogo?: string;
|
|
4789
|
+
assetPriceInUsd?: string;
|
|
4790
|
+
balanceNative: string;
|
|
4791
|
+
balanceUsd: string;
|
|
4792
|
+
unclaimedNative?: string;
|
|
4793
|
+
unclaimedUsd?: string;
|
|
4794
|
+
positionValueInAsset?: string;
|
|
4795
|
+
};
|
|
4796
|
+
lpToken?: {
|
|
4797
|
+
address: string;
|
|
4798
|
+
tokenCaip: string;
|
|
4799
|
+
name: string;
|
|
4800
|
+
symbol: string;
|
|
4801
|
+
decimals: number;
|
|
4802
|
+
balanceNative: string;
|
|
4803
|
+
balanceUsd: string;
|
|
4804
|
+
unclaimedNative?: string;
|
|
4805
|
+
unclaimedUsd?: string;
|
|
4806
|
+
positionValueInAsset?: string;
|
|
4807
|
+
assetPriceInUsd?: string;
|
|
4808
|
+
};
|
|
4809
|
+
additionalAssets?: {
|
|
4810
|
+
address: string;
|
|
4811
|
+
assetCaip: string;
|
|
4812
|
+
name: string;
|
|
4813
|
+
symbol: string;
|
|
4814
|
+
decimals: number;
|
|
4815
|
+
assetLogo?: string;
|
|
4816
|
+
assetPriceInUsd?: string;
|
|
4817
|
+
balanceNative: string;
|
|
4818
|
+
balanceUsd: string;
|
|
4819
|
+
unclaimedNative?: string;
|
|
4820
|
+
unclaimedUsd?: string;
|
|
4821
|
+
positionValueInAsset?: string;
|
|
4822
|
+
}[];
|
|
4823
|
+
}[];
|
|
4824
|
+
}>;
|
|
4825
|
+
getDepositOptions(params: Params<'/v2/portfolio/best-deposit-options/{userAddress}'>): Promise<{
|
|
3935
4826
|
requestedAddress: string;
|
|
3936
4827
|
userBalances: {
|
|
3937
4828
|
asset?: {
|
|
@@ -3949,7 +4840,7 @@ declare class VaultsSdk {
|
|
|
3949
4840
|
name: string;
|
|
3950
4841
|
address: string;
|
|
3951
4842
|
network: {
|
|
3952
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4843
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
3953
4844
|
chainId: number;
|
|
3954
4845
|
networkCaip: string;
|
|
3955
4846
|
};
|
|
@@ -3984,7 +4875,7 @@ declare class VaultsSdk {
|
|
|
3984
4875
|
unsupportedProtocols: string[];
|
|
3985
4876
|
};
|
|
3986
4877
|
}>;
|
|
3987
|
-
getVaultHolderEvents(params:
|
|
4878
|
+
getVaultHolderEvents(params: Params<'/v2/portfolio/events/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
3988
4879
|
itemsOnPage: number;
|
|
3989
4880
|
nextPage?: number;
|
|
3990
4881
|
data: {
|
|
@@ -4001,13 +4892,13 @@ declare class VaultsSdk {
|
|
|
4001
4892
|
};
|
|
4002
4893
|
}[];
|
|
4003
4894
|
}>;
|
|
4004
|
-
getAllVaults(params?:
|
|
4895
|
+
getAllVaults(params?: Params<'/v2/detailed-vaults'>): Promise<{
|
|
4005
4896
|
itemsOnPage: number;
|
|
4006
4897
|
nextPage?: number;
|
|
4007
4898
|
data: {
|
|
4008
4899
|
address: string;
|
|
4009
4900
|
network: {
|
|
4010
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4901
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4011
4902
|
chainId: number;
|
|
4012
4903
|
networkCaip: string;
|
|
4013
4904
|
};
|
|
@@ -4140,10 +5031,10 @@ declare class VaultsSdk {
|
|
|
4140
5031
|
unsupportedProtocols: string[];
|
|
4141
5032
|
};
|
|
4142
5033
|
}>;
|
|
4143
|
-
getVault(params:
|
|
5034
|
+
getVault(params: Params<'/v2/detailed-vaults/{network}/{vaultAddress}'>): Promise<{
|
|
4144
5035
|
address: string;
|
|
4145
5036
|
network: {
|
|
4146
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
5037
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4147
5038
|
chainId: number;
|
|
4148
5039
|
networkCaip: string;
|
|
4149
5040
|
};
|
|
@@ -4270,7 +5161,7 @@ declare class VaultsSdk {
|
|
|
4270
5161
|
assetPriceInUsd?: string;
|
|
4271
5162
|
}[];
|
|
4272
5163
|
}>;
|
|
4273
|
-
getIdleAssets(params:
|
|
5164
|
+
getIdleAssets(params: Params<'/v2/portfolio/idle-assets/{userAddress}'>): Promise<{
|
|
4274
5165
|
data: {
|
|
4275
5166
|
address: string;
|
|
4276
5167
|
assetCaip: string;
|
|
@@ -4282,7 +5173,7 @@ declare class VaultsSdk {
|
|
|
4282
5173
|
balanceNative: string;
|
|
4283
5174
|
balanceUsd: string;
|
|
4284
5175
|
network: {
|
|
4285
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
5176
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4286
5177
|
chainId: number;
|
|
4287
5178
|
networkCaip: string;
|
|
4288
5179
|
};
|
|
@@ -4292,7 +5183,7 @@ declare class VaultsSdk {
|
|
|
4292
5183
|
unsupportedAssets: string[];
|
|
4293
5184
|
};
|
|
4294
5185
|
}>;
|
|
4295
|
-
getTransactionsContext(params:
|
|
5186
|
+
getTransactionsContext(params: Params<'/v2/transactions/context/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4296
5187
|
currentDepositStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
4297
5188
|
depositSteps: {
|
|
4298
5189
|
actions: string[];
|
|
@@ -4394,7 +5285,7 @@ declare class VaultsSdk {
|
|
|
4394
5285
|
decimals: number;
|
|
4395
5286
|
assetLogo?: string;
|
|
4396
5287
|
assetPriceInUsd?: string;
|
|
4397
|
-
network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
5288
|
+
network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
|
|
4398
5289
|
};
|
|
4399
5290
|
}[];
|
|
4400
5291
|
currentStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
@@ -4405,7 +5296,7 @@ declare class VaultsSdk {
|
|
|
4405
5296
|
}[];
|
|
4406
5297
|
};
|
|
4407
5298
|
}>;
|
|
4408
|
-
getActions(params:
|
|
5299
|
+
getActions(params: Params<'/v2/transactions/{action}/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4409
5300
|
currentActionIndex: number;
|
|
4410
5301
|
actions: {
|
|
4411
5302
|
name: string;
|