@vaultsfyi/sdk 1.0.3 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.mts +1295 -559
- package/dist/client.d.ts +1295 -559
- package/dist/client.js +11 -15
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +11 -15
- 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' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
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' | 'bsc' | 'hyperliquid';
|
|
95
123
|
/** @description Chain ID of the network */
|
|
96
124
|
chainId: number;
|
|
97
125
|
/** @description CAIP-2 of the network */
|
|
@@ -116,6 +144,8 @@ interface paths {
|
|
|
116
144
|
assetLogo?: string;
|
|
117
145
|
/** @description Price of the asset in USD */
|
|
118
146
|
assetPriceInUsd?: string;
|
|
147
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
148
|
+
assetGroup: string;
|
|
119
149
|
};
|
|
120
150
|
/** @description Indicates if the vault supports transactional endpoints */
|
|
121
151
|
isTransactional: boolean;
|
|
@@ -132,11 +162,12 @@ interface paths {
|
|
|
132
162
|
};
|
|
133
163
|
content: {
|
|
134
164
|
'application/json': {
|
|
135
|
-
|
|
165
|
+
statusCode: number;
|
|
136
166
|
/** @enum {string} */
|
|
137
167
|
error: 'Bad Request';
|
|
138
168
|
message: string;
|
|
139
|
-
|
|
169
|
+
errorId?: string;
|
|
170
|
+
} | unknown;
|
|
140
171
|
};
|
|
141
172
|
};
|
|
142
173
|
/** @description Default Response */
|
|
@@ -150,7 +181,8 @@ interface paths {
|
|
|
150
181
|
error: 'Unauthorized';
|
|
151
182
|
/** @enum {string} */
|
|
152
183
|
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
|
-
|
|
184
|
+
errorId?: string;
|
|
185
|
+
} | unknown;
|
|
154
186
|
};
|
|
155
187
|
};
|
|
156
188
|
/** @description Default Response */
|
|
@@ -164,7 +196,8 @@ interface paths {
|
|
|
164
196
|
error: 'Forbidden';
|
|
165
197
|
/** @enum {string} */
|
|
166
198
|
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
|
-
|
|
199
|
+
errorId?: string;
|
|
200
|
+
} | unknown;
|
|
168
201
|
};
|
|
169
202
|
};
|
|
170
203
|
/** @description Default Response */
|
|
@@ -177,7 +210,22 @@ interface paths {
|
|
|
177
210
|
/** @enum {string} */
|
|
178
211
|
error: 'Internal Server Error';
|
|
179
212
|
message: string;
|
|
180
|
-
|
|
213
|
+
errorId?: string;
|
|
214
|
+
} | unknown;
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
/** @description Default Response */
|
|
218
|
+
503: {
|
|
219
|
+
headers: {
|
|
220
|
+
[name: string]: unknown;
|
|
221
|
+
};
|
|
222
|
+
content: {
|
|
223
|
+
'application/json': {
|
|
224
|
+
/** @enum {string} */
|
|
225
|
+
error: 'Service Unavailable';
|
|
226
|
+
message: string;
|
|
227
|
+
errorId?: string;
|
|
228
|
+
} | unknown;
|
|
181
229
|
};
|
|
182
230
|
};
|
|
183
231
|
};
|
|
@@ -206,7 +254,7 @@ interface paths {
|
|
|
206
254
|
/** @description Number of items per page */
|
|
207
255
|
perPage?: number;
|
|
208
256
|
/** @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';
|
|
257
|
+
network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
210
258
|
};
|
|
211
259
|
header?: never;
|
|
212
260
|
path?: never;
|
|
@@ -243,13 +291,15 @@ interface paths {
|
|
|
243
291
|
assetLogo?: string;
|
|
244
292
|
/** @description Price of the asset in USD */
|
|
245
293
|
assetPriceInUsd?: string;
|
|
294
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
295
|
+
assetGroup: string;
|
|
246
296
|
/** @description Network details of the asset */
|
|
247
297
|
network: {
|
|
248
298
|
/**
|
|
249
299
|
* @description Name of the network
|
|
250
300
|
* @enum {string}
|
|
251
301
|
*/
|
|
252
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
302
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
253
303
|
/** @description Chain ID of the network */
|
|
254
304
|
chainId: number;
|
|
255
305
|
/** @description CAIP-2 of the network */
|
|
@@ -266,11 +316,12 @@ interface paths {
|
|
|
266
316
|
};
|
|
267
317
|
content: {
|
|
268
318
|
'application/json': {
|
|
269
|
-
|
|
319
|
+
statusCode: number;
|
|
270
320
|
/** @enum {string} */
|
|
271
321
|
error: 'Bad Request';
|
|
272
322
|
message: string;
|
|
273
|
-
|
|
323
|
+
errorId?: string;
|
|
324
|
+
} | unknown;
|
|
274
325
|
};
|
|
275
326
|
};
|
|
276
327
|
/** @description Default Response */
|
|
@@ -284,7 +335,8 @@ interface paths {
|
|
|
284
335
|
error: 'Unauthorized';
|
|
285
336
|
/** @enum {string} */
|
|
286
337
|
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
|
-
|
|
338
|
+
errorId?: string;
|
|
339
|
+
} | unknown;
|
|
288
340
|
};
|
|
289
341
|
};
|
|
290
342
|
/** @description Default Response */
|
|
@@ -298,7 +350,8 @@ interface paths {
|
|
|
298
350
|
error: 'Forbidden';
|
|
299
351
|
/** @enum {string} */
|
|
300
352
|
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
|
-
|
|
353
|
+
errorId?: string;
|
|
354
|
+
} | unknown;
|
|
302
355
|
};
|
|
303
356
|
};
|
|
304
357
|
/** @description Default Response */
|
|
@@ -311,7 +364,22 @@ interface paths {
|
|
|
311
364
|
/** @enum {string} */
|
|
312
365
|
error: 'Internal Server Error';
|
|
313
366
|
message: string;
|
|
314
|
-
|
|
367
|
+
errorId?: string;
|
|
368
|
+
} | unknown;
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
/** @description Default Response */
|
|
372
|
+
503: {
|
|
373
|
+
headers: {
|
|
374
|
+
[name: string]: unknown;
|
|
375
|
+
};
|
|
376
|
+
content: {
|
|
377
|
+
'application/json': {
|
|
378
|
+
/** @enum {string} */
|
|
379
|
+
error: 'Service Unavailable';
|
|
380
|
+
message: string;
|
|
381
|
+
errorId?: string;
|
|
382
|
+
} | unknown;
|
|
315
383
|
};
|
|
316
384
|
};
|
|
317
385
|
};
|
|
@@ -351,6 +419,21 @@ interface paths {
|
|
|
351
419
|
};
|
|
352
420
|
};
|
|
353
421
|
/** @description Default Response */
|
|
422
|
+
400: {
|
|
423
|
+
headers: {
|
|
424
|
+
[name: string]: unknown;
|
|
425
|
+
};
|
|
426
|
+
content: {
|
|
427
|
+
'application/json': {
|
|
428
|
+
statusCode: number;
|
|
429
|
+
/** @enum {string} */
|
|
430
|
+
error: 'Bad Request';
|
|
431
|
+
message: string;
|
|
432
|
+
errorId?: string;
|
|
433
|
+
} | unknown;
|
|
434
|
+
};
|
|
435
|
+
};
|
|
436
|
+
/** @description Default Response */
|
|
354
437
|
401: {
|
|
355
438
|
headers: {
|
|
356
439
|
[name: string]: unknown;
|
|
@@ -361,7 +444,23 @@ interface paths {
|
|
|
361
444
|
error: 'Unauthorized';
|
|
362
445
|
/** @enum {string} */
|
|
363
446
|
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
|
-
|
|
447
|
+
errorId?: string;
|
|
448
|
+
} | unknown;
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
/** @description Default Response */
|
|
452
|
+
403: {
|
|
453
|
+
headers: {
|
|
454
|
+
[name: string]: unknown;
|
|
455
|
+
};
|
|
456
|
+
content: {
|
|
457
|
+
'application/json': {
|
|
458
|
+
/** @enum {string} */
|
|
459
|
+
error: 'Forbidden';
|
|
460
|
+
/** @enum {string} */
|
|
461
|
+
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.';
|
|
462
|
+
errorId?: string;
|
|
463
|
+
} | unknown;
|
|
365
464
|
};
|
|
366
465
|
};
|
|
367
466
|
/** @description Default Response */
|
|
@@ -374,7 +473,22 @@ interface paths {
|
|
|
374
473
|
/** @enum {string} */
|
|
375
474
|
error: 'Internal Server Error';
|
|
376
475
|
message: string;
|
|
377
|
-
|
|
476
|
+
errorId?: string;
|
|
477
|
+
} | unknown;
|
|
478
|
+
};
|
|
479
|
+
};
|
|
480
|
+
/** @description Default Response */
|
|
481
|
+
503: {
|
|
482
|
+
headers: {
|
|
483
|
+
[name: string]: unknown;
|
|
484
|
+
};
|
|
485
|
+
content: {
|
|
486
|
+
'application/json': {
|
|
487
|
+
/** @enum {string} */
|
|
488
|
+
error: 'Service Unavailable';
|
|
489
|
+
message: string;
|
|
490
|
+
errorId?: string;
|
|
491
|
+
} | unknown;
|
|
378
492
|
};
|
|
379
493
|
};
|
|
380
494
|
};
|
|
@@ -415,7 +529,7 @@ interface paths {
|
|
|
415
529
|
* @description Name of the network
|
|
416
530
|
* @enum {string}
|
|
417
531
|
*/
|
|
418
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
532
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
419
533
|
/** @description Chain ID of the network */
|
|
420
534
|
chainId: number;
|
|
421
535
|
/** @description CAIP-2 of the network */
|
|
@@ -424,6 +538,21 @@ interface paths {
|
|
|
424
538
|
};
|
|
425
539
|
};
|
|
426
540
|
/** @description Default Response */
|
|
541
|
+
400: {
|
|
542
|
+
headers: {
|
|
543
|
+
[name: string]: unknown;
|
|
544
|
+
};
|
|
545
|
+
content: {
|
|
546
|
+
'application/json': {
|
|
547
|
+
statusCode: number;
|
|
548
|
+
/** @enum {string} */
|
|
549
|
+
error: 'Bad Request';
|
|
550
|
+
message: string;
|
|
551
|
+
errorId?: string;
|
|
552
|
+
} | unknown;
|
|
553
|
+
};
|
|
554
|
+
};
|
|
555
|
+
/** @description Default Response */
|
|
427
556
|
401: {
|
|
428
557
|
headers: {
|
|
429
558
|
[name: string]: unknown;
|
|
@@ -434,7 +563,23 @@ interface paths {
|
|
|
434
563
|
error: 'Unauthorized';
|
|
435
564
|
/** @enum {string} */
|
|
436
565
|
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
|
-
|
|
566
|
+
errorId?: string;
|
|
567
|
+
} | unknown;
|
|
568
|
+
};
|
|
569
|
+
};
|
|
570
|
+
/** @description Default Response */
|
|
571
|
+
403: {
|
|
572
|
+
headers: {
|
|
573
|
+
[name: string]: unknown;
|
|
574
|
+
};
|
|
575
|
+
content: {
|
|
576
|
+
'application/json': {
|
|
577
|
+
/** @enum {string} */
|
|
578
|
+
error: 'Forbidden';
|
|
579
|
+
/** @enum {string} */
|
|
580
|
+
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.';
|
|
581
|
+
errorId?: string;
|
|
582
|
+
} | unknown;
|
|
438
583
|
};
|
|
439
584
|
};
|
|
440
585
|
/** @description Default Response */
|
|
@@ -447,7 +592,22 @@ interface paths {
|
|
|
447
592
|
/** @enum {string} */
|
|
448
593
|
error: 'Internal Server Error';
|
|
449
594
|
message: string;
|
|
450
|
-
|
|
595
|
+
errorId?: string;
|
|
596
|
+
} | unknown;
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
/** @description Default Response */
|
|
600
|
+
503: {
|
|
601
|
+
headers: {
|
|
602
|
+
[name: string]: unknown;
|
|
603
|
+
};
|
|
604
|
+
content: {
|
|
605
|
+
'application/json': {
|
|
606
|
+
/** @enum {string} */
|
|
607
|
+
error: 'Service Unavailable';
|
|
608
|
+
message: string;
|
|
609
|
+
errorId?: string;
|
|
610
|
+
} | unknown;
|
|
451
611
|
};
|
|
452
612
|
};
|
|
453
613
|
};
|
|
@@ -477,6 +637,8 @@ interface paths {
|
|
|
477
637
|
perPage?: number;
|
|
478
638
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
479
639
|
apyInterval?: '1day' | '7day' | '30day';
|
|
640
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
641
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
480
642
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
481
643
|
fromTimestamp?: number;
|
|
482
644
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -485,7 +647,7 @@ interface paths {
|
|
|
485
647
|
header?: never;
|
|
486
648
|
path: {
|
|
487
649
|
/** @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';
|
|
650
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
489
651
|
/** @description Address of the vault for which the data will be returned */
|
|
490
652
|
vaultAddress: string;
|
|
491
653
|
};
|
|
@@ -536,11 +698,12 @@ interface paths {
|
|
|
536
698
|
};
|
|
537
699
|
content: {
|
|
538
700
|
'application/json': {
|
|
539
|
-
|
|
701
|
+
statusCode: number;
|
|
540
702
|
/** @enum {string} */
|
|
541
703
|
error: 'Bad Request';
|
|
542
704
|
message: string;
|
|
543
|
-
|
|
705
|
+
errorId?: string;
|
|
706
|
+
} | unknown;
|
|
544
707
|
};
|
|
545
708
|
};
|
|
546
709
|
/** @description Default Response */
|
|
@@ -554,7 +717,8 @@ interface paths {
|
|
|
554
717
|
error: 'Unauthorized';
|
|
555
718
|
/** @enum {string} */
|
|
556
719
|
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
|
-
|
|
720
|
+
errorId?: string;
|
|
721
|
+
} | unknown;
|
|
558
722
|
};
|
|
559
723
|
};
|
|
560
724
|
/** @description Default Response */
|
|
@@ -568,7 +732,8 @@ interface paths {
|
|
|
568
732
|
error: 'Forbidden';
|
|
569
733
|
/** @enum {string} */
|
|
570
734
|
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
|
-
|
|
735
|
+
errorId?: string;
|
|
736
|
+
} | unknown;
|
|
572
737
|
};
|
|
573
738
|
};
|
|
574
739
|
/** @description Default Response */
|
|
@@ -581,7 +746,22 @@ interface paths {
|
|
|
581
746
|
/** @enum {string} */
|
|
582
747
|
error: 'Internal Server Error';
|
|
583
748
|
message: string;
|
|
584
|
-
|
|
749
|
+
errorId?: string;
|
|
750
|
+
} | unknown;
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
/** @description Default Response */
|
|
754
|
+
503: {
|
|
755
|
+
headers: {
|
|
756
|
+
[name: string]: unknown;
|
|
757
|
+
};
|
|
758
|
+
content: {
|
|
759
|
+
'application/json': {
|
|
760
|
+
/** @enum {string} */
|
|
761
|
+
error: 'Service Unavailable';
|
|
762
|
+
message: string;
|
|
763
|
+
errorId?: string;
|
|
764
|
+
} | unknown;
|
|
585
765
|
};
|
|
586
766
|
};
|
|
587
767
|
};
|
|
@@ -611,6 +791,8 @@ interface paths {
|
|
|
611
791
|
perPage?: number;
|
|
612
792
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
613
793
|
apyInterval?: '1day' | '7day' | '30day';
|
|
794
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
795
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
614
796
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
615
797
|
fromTimestamp?: number;
|
|
616
798
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -619,7 +801,7 @@ interface paths {
|
|
|
619
801
|
header?: never;
|
|
620
802
|
path: {
|
|
621
803
|
/** @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';
|
|
804
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
623
805
|
/** @description Address of the vault for which the data will be returned */
|
|
624
806
|
vaultAddress: string;
|
|
625
807
|
};
|
|
@@ -663,11 +845,12 @@ interface paths {
|
|
|
663
845
|
};
|
|
664
846
|
content: {
|
|
665
847
|
'application/json': {
|
|
666
|
-
|
|
848
|
+
statusCode: number;
|
|
667
849
|
/** @enum {string} */
|
|
668
850
|
error: 'Bad Request';
|
|
669
851
|
message: string;
|
|
670
|
-
|
|
852
|
+
errorId?: string;
|
|
853
|
+
} | unknown;
|
|
671
854
|
};
|
|
672
855
|
};
|
|
673
856
|
/** @description Default Response */
|
|
@@ -681,7 +864,8 @@ interface paths {
|
|
|
681
864
|
error: 'Unauthorized';
|
|
682
865
|
/** @enum {string} */
|
|
683
866
|
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
|
-
|
|
867
|
+
errorId?: string;
|
|
868
|
+
} | unknown;
|
|
685
869
|
};
|
|
686
870
|
};
|
|
687
871
|
/** @description Default Response */
|
|
@@ -695,7 +879,8 @@ interface paths {
|
|
|
695
879
|
error: 'Forbidden';
|
|
696
880
|
/** @enum {string} */
|
|
697
881
|
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
|
-
|
|
882
|
+
errorId?: string;
|
|
883
|
+
} | unknown;
|
|
699
884
|
};
|
|
700
885
|
};
|
|
701
886
|
/** @description Default Response */
|
|
@@ -708,7 +893,22 @@ interface paths {
|
|
|
708
893
|
/** @enum {string} */
|
|
709
894
|
error: 'Internal Server Error';
|
|
710
895
|
message: string;
|
|
711
|
-
|
|
896
|
+
errorId?: string;
|
|
897
|
+
} | unknown;
|
|
898
|
+
};
|
|
899
|
+
};
|
|
900
|
+
/** @description Default Response */
|
|
901
|
+
503: {
|
|
902
|
+
headers: {
|
|
903
|
+
[name: string]: unknown;
|
|
904
|
+
};
|
|
905
|
+
content: {
|
|
906
|
+
'application/json': {
|
|
907
|
+
/** @enum {string} */
|
|
908
|
+
error: 'Service Unavailable';
|
|
909
|
+
message: string;
|
|
910
|
+
errorId?: string;
|
|
911
|
+
} | unknown;
|
|
712
912
|
};
|
|
713
913
|
};
|
|
714
914
|
};
|
|
@@ -738,6 +938,8 @@ interface paths {
|
|
|
738
938
|
perPage?: number;
|
|
739
939
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
740
940
|
apyInterval?: '1day' | '7day' | '30day';
|
|
941
|
+
/** @description Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week */
|
|
942
|
+
granularity?: '1hour' | '1day' | '1week';
|
|
741
943
|
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
742
944
|
fromTimestamp?: number;
|
|
743
945
|
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
@@ -746,7 +948,7 @@ interface paths {
|
|
|
746
948
|
header?: never;
|
|
747
949
|
path: {
|
|
748
950
|
/** @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';
|
|
951
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
750
952
|
/** @description Address of the vault for which the data will be returned */
|
|
751
953
|
vaultAddress: string;
|
|
752
954
|
};
|
|
@@ -788,11 +990,12 @@ interface paths {
|
|
|
788
990
|
};
|
|
789
991
|
content: {
|
|
790
992
|
'application/json': {
|
|
791
|
-
|
|
993
|
+
statusCode: number;
|
|
792
994
|
/** @enum {string} */
|
|
793
995
|
error: 'Bad Request';
|
|
794
996
|
message: string;
|
|
795
|
-
|
|
997
|
+
errorId?: string;
|
|
998
|
+
} | unknown;
|
|
796
999
|
};
|
|
797
1000
|
};
|
|
798
1001
|
/** @description Default Response */
|
|
@@ -806,7 +1009,8 @@ interface paths {
|
|
|
806
1009
|
error: 'Unauthorized';
|
|
807
1010
|
/** @enum {string} */
|
|
808
1011
|
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
|
-
|
|
1012
|
+
errorId?: string;
|
|
1013
|
+
} | unknown;
|
|
810
1014
|
};
|
|
811
1015
|
};
|
|
812
1016
|
/** @description Default Response */
|
|
@@ -820,7 +1024,8 @@ interface paths {
|
|
|
820
1024
|
error: 'Forbidden';
|
|
821
1025
|
/** @enum {string} */
|
|
822
1026
|
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
|
-
|
|
1027
|
+
errorId?: string;
|
|
1028
|
+
} | unknown;
|
|
824
1029
|
};
|
|
825
1030
|
};
|
|
826
1031
|
/** @description Default Response */
|
|
@@ -833,7 +1038,22 @@ interface paths {
|
|
|
833
1038
|
/** @enum {string} */
|
|
834
1039
|
error: 'Internal Server Error';
|
|
835
1040
|
message: string;
|
|
836
|
-
|
|
1041
|
+
errorId?: string;
|
|
1042
|
+
} | unknown;
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
/** @description Default Response */
|
|
1046
|
+
503: {
|
|
1047
|
+
headers: {
|
|
1048
|
+
[name: string]: unknown;
|
|
1049
|
+
};
|
|
1050
|
+
content: {
|
|
1051
|
+
'application/json': {
|
|
1052
|
+
/** @enum {string} */
|
|
1053
|
+
error: 'Service Unavailable';
|
|
1054
|
+
message: string;
|
|
1055
|
+
errorId?: string;
|
|
1056
|
+
} | unknown;
|
|
837
1057
|
};
|
|
838
1058
|
};
|
|
839
1059
|
};
|
|
@@ -861,28 +1081,30 @@ interface paths {
|
|
|
861
1081
|
page?: number;
|
|
862
1082
|
/** @description Number of items per page */
|
|
863
1083
|
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
1084
|
/** @description Assets to be included by symbol(ticker). */
|
|
869
|
-
allowedAssets?: string[];
|
|
1085
|
+
allowedAssets?: string[] | string;
|
|
870
1086
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
871
|
-
disallowedAssets?: string[];
|
|
1087
|
+
disallowedAssets?: string[] | string;
|
|
872
1088
|
/** @description Protocols to be included by name. */
|
|
873
|
-
allowedProtocols?: string[];
|
|
1089
|
+
allowedProtocols?: string[] | string;
|
|
874
1090
|
/** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
|
|
875
|
-
disallowedProtocols?: string[];
|
|
1091
|
+
disallowedProtocols?: string[] | string;
|
|
876
1092
|
/** @description Minimum TVL in USD of the vaults to be included */
|
|
877
1093
|
minTvl?: number;
|
|
878
1094
|
/** @description Include only vaults that are supported in the transactional interface. */
|
|
879
1095
|
onlyTransactional?: boolean;
|
|
880
1096
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
881
1097
|
onlyAppFeatured?: boolean;
|
|
1098
|
+
/** @description Networks to be included (name or CAIP). */
|
|
1099
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
1100
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
1101
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
882
1102
|
/** @description Maximum TVL in USD of the vaults to be included */
|
|
883
1103
|
maxTvl?: number;
|
|
1104
|
+
/** @description Maximum APY (in decimal) of the vaults to be included */
|
|
1105
|
+
maxApy?: number;
|
|
884
1106
|
/** @description Tags to be included. */
|
|
885
|
-
tags?: string[];
|
|
1107
|
+
tags?: string[] | string;
|
|
886
1108
|
};
|
|
887
1109
|
header?: never;
|
|
888
1110
|
path?: never;
|
|
@@ -910,7 +1132,7 @@ interface paths {
|
|
|
910
1132
|
* @description Name of the network
|
|
911
1133
|
* @enum {string}
|
|
912
1134
|
*/
|
|
913
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
1135
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
914
1136
|
/** @description Chain ID of the network */
|
|
915
1137
|
chainId: number;
|
|
916
1138
|
/** @description CAIP-2 of the network */
|
|
@@ -935,6 +1157,8 @@ interface paths {
|
|
|
935
1157
|
assetLogo?: string;
|
|
936
1158
|
/** @description Price of the asset in USD */
|
|
937
1159
|
assetPriceInUsd?: string;
|
|
1160
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1161
|
+
assetGroup: string;
|
|
938
1162
|
};
|
|
939
1163
|
/** @description Indicates if the vault supports transactional endpoints */
|
|
940
1164
|
isTransactional: boolean;
|
|
@@ -980,7 +1204,7 @@ interface paths {
|
|
|
980
1204
|
};
|
|
981
1205
|
/** @description APY details of the vault */
|
|
982
1206
|
apy: {
|
|
983
|
-
/** @description 1day APY details
|
|
1207
|
+
/** @description 1day APY details */
|
|
984
1208
|
'1day': {
|
|
985
1209
|
/** @description Base APY */
|
|
986
1210
|
base: number;
|
|
@@ -989,7 +1213,7 @@ interface paths {
|
|
|
989
1213
|
/** @description Total APY */
|
|
990
1214
|
total: number;
|
|
991
1215
|
};
|
|
992
|
-
/** @description 7day APY details
|
|
1216
|
+
/** @description 7day APY details */
|
|
993
1217
|
'7day': {
|
|
994
1218
|
/** @description Base APY */
|
|
995
1219
|
base: number;
|
|
@@ -998,7 +1222,7 @@ interface paths {
|
|
|
998
1222
|
/** @description Total APY */
|
|
999
1223
|
total: number;
|
|
1000
1224
|
};
|
|
1001
|
-
/** @description 30day APY details
|
|
1225
|
+
/** @description 30day APY details */
|
|
1002
1226
|
'30day': {
|
|
1003
1227
|
/** @description Base APY */
|
|
1004
1228
|
base: number;
|
|
@@ -1036,6 +1260,8 @@ interface paths {
|
|
|
1036
1260
|
assetLogo?: string;
|
|
1037
1261
|
/** @description Price of the asset in USD */
|
|
1038
1262
|
assetPriceInUsd?: string;
|
|
1263
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1264
|
+
assetGroup: string;
|
|
1039
1265
|
};
|
|
1040
1266
|
apy: {
|
|
1041
1267
|
/** @description 1day APY of the reward asset */
|
|
@@ -1099,6 +1325,8 @@ interface paths {
|
|
|
1099
1325
|
assetLogo?: string;
|
|
1100
1326
|
/** @description Price of the asset in USD */
|
|
1101
1327
|
assetPriceInUsd?: string;
|
|
1328
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1329
|
+
assetGroup: string;
|
|
1102
1330
|
};
|
|
1103
1331
|
/** @description LP token details of the child vault */
|
|
1104
1332
|
lpToken?: {
|
|
@@ -1132,6 +1360,8 @@ interface paths {
|
|
|
1132
1360
|
assetLogo?: string;
|
|
1133
1361
|
/** @description Price of the asset in USD */
|
|
1134
1362
|
assetPriceInUsd?: string;
|
|
1363
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1364
|
+
assetGroup: string;
|
|
1135
1365
|
}[];
|
|
1136
1366
|
}[];
|
|
1137
1367
|
/** @description Additional assets of the vault */
|
|
@@ -1153,7 +1383,24 @@ interface paths {
|
|
|
1153
1383
|
assetLogo?: string;
|
|
1154
1384
|
/** @description Price of the asset in USD */
|
|
1155
1385
|
assetPriceInUsd?: string;
|
|
1386
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1387
|
+
assetGroup: string;
|
|
1156
1388
|
}[];
|
|
1389
|
+
/** @description Transactional properties of the vault */
|
|
1390
|
+
transactionalProperties?: {
|
|
1391
|
+
/**
|
|
1392
|
+
* @description Type of transaction steps, either "instant" or "complex"
|
|
1393
|
+
* @enum {string}
|
|
1394
|
+
*/
|
|
1395
|
+
depositStepsType: 'instant' | 'complex';
|
|
1396
|
+
/**
|
|
1397
|
+
* @description Type of transaction steps, either "instant" or "complex"
|
|
1398
|
+
* @enum {string}
|
|
1399
|
+
*/
|
|
1400
|
+
redeemStepsType: 'instant' | 'complex';
|
|
1401
|
+
/** @description Indicates if the vault supports rewards transaction flows */
|
|
1402
|
+
rewardsSupported: boolean;
|
|
1403
|
+
};
|
|
1157
1404
|
}[];
|
|
1158
1405
|
errors: {
|
|
1159
1406
|
unsupportedNetworks: string[];
|
|
@@ -1170,11 +1417,12 @@ interface paths {
|
|
|
1170
1417
|
};
|
|
1171
1418
|
content: {
|
|
1172
1419
|
'application/json': {
|
|
1173
|
-
|
|
1420
|
+
statusCode: number;
|
|
1174
1421
|
/** @enum {string} */
|
|
1175
1422
|
error: 'Bad Request';
|
|
1176
1423
|
message: string;
|
|
1177
|
-
|
|
1424
|
+
errorId?: string;
|
|
1425
|
+
} | unknown;
|
|
1178
1426
|
};
|
|
1179
1427
|
};
|
|
1180
1428
|
/** @description Default Response */
|
|
@@ -1188,7 +1436,8 @@ interface paths {
|
|
|
1188
1436
|
error: 'Unauthorized';
|
|
1189
1437
|
/** @enum {string} */
|
|
1190
1438
|
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
|
-
|
|
1439
|
+
errorId?: string;
|
|
1440
|
+
} | unknown;
|
|
1192
1441
|
};
|
|
1193
1442
|
};
|
|
1194
1443
|
/** @description Default Response */
|
|
@@ -1202,7 +1451,8 @@ interface paths {
|
|
|
1202
1451
|
error: 'Forbidden';
|
|
1203
1452
|
/** @enum {string} */
|
|
1204
1453
|
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
|
-
|
|
1454
|
+
errorId?: string;
|
|
1455
|
+
} | unknown;
|
|
1206
1456
|
};
|
|
1207
1457
|
};
|
|
1208
1458
|
/** @description Default Response */
|
|
@@ -1215,7 +1465,22 @@ interface paths {
|
|
|
1215
1465
|
/** @enum {string} */
|
|
1216
1466
|
error: 'Internal Server Error';
|
|
1217
1467
|
message: string;
|
|
1218
|
-
|
|
1468
|
+
errorId?: string;
|
|
1469
|
+
} | unknown;
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
/** @description Default Response */
|
|
1473
|
+
503: {
|
|
1474
|
+
headers: {
|
|
1475
|
+
[name: string]: unknown;
|
|
1476
|
+
};
|
|
1477
|
+
content: {
|
|
1478
|
+
'application/json': {
|
|
1479
|
+
/** @enum {string} */
|
|
1480
|
+
error: 'Service Unavailable';
|
|
1481
|
+
message: string;
|
|
1482
|
+
errorId?: string;
|
|
1483
|
+
} | unknown;
|
|
1219
1484
|
};
|
|
1220
1485
|
};
|
|
1221
1486
|
};
|
|
@@ -1242,7 +1507,7 @@ interface paths {
|
|
|
1242
1507
|
header?: never;
|
|
1243
1508
|
path: {
|
|
1244
1509
|
/** @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';
|
|
1510
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
1246
1511
|
/** @description Address of the vault for which the data will be returned */
|
|
1247
1512
|
vaultAddress: string;
|
|
1248
1513
|
};
|
|
@@ -1265,7 +1530,7 @@ interface paths {
|
|
|
1265
1530
|
* @description Name of the network
|
|
1266
1531
|
* @enum {string}
|
|
1267
1532
|
*/
|
|
1268
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
1533
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
1269
1534
|
/** @description Chain ID of the network */
|
|
1270
1535
|
chainId: number;
|
|
1271
1536
|
/** @description CAIP-2 of the network */
|
|
@@ -1290,6 +1555,8 @@ interface paths {
|
|
|
1290
1555
|
assetLogo?: string;
|
|
1291
1556
|
/** @description Price of the asset in USD */
|
|
1292
1557
|
assetPriceInUsd?: string;
|
|
1558
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1559
|
+
assetGroup: string;
|
|
1293
1560
|
};
|
|
1294
1561
|
/** @description Indicates if the vault supports transactional endpoints */
|
|
1295
1562
|
isTransactional: boolean;
|
|
@@ -1335,7 +1602,7 @@ interface paths {
|
|
|
1335
1602
|
};
|
|
1336
1603
|
/** @description APY details of the vault */
|
|
1337
1604
|
apy: {
|
|
1338
|
-
/** @description 1day APY details
|
|
1605
|
+
/** @description 1day APY details */
|
|
1339
1606
|
'1day': {
|
|
1340
1607
|
/** @description Base APY */
|
|
1341
1608
|
base: number;
|
|
@@ -1344,7 +1611,7 @@ interface paths {
|
|
|
1344
1611
|
/** @description Total APY */
|
|
1345
1612
|
total: number;
|
|
1346
1613
|
};
|
|
1347
|
-
/** @description 7day APY details
|
|
1614
|
+
/** @description 7day APY details */
|
|
1348
1615
|
'7day': {
|
|
1349
1616
|
/** @description Base APY */
|
|
1350
1617
|
base: number;
|
|
@@ -1353,7 +1620,7 @@ interface paths {
|
|
|
1353
1620
|
/** @description Total APY */
|
|
1354
1621
|
total: number;
|
|
1355
1622
|
};
|
|
1356
|
-
/** @description 30day APY details
|
|
1623
|
+
/** @description 30day APY details */
|
|
1357
1624
|
'30day': {
|
|
1358
1625
|
/** @description Base APY */
|
|
1359
1626
|
base: number;
|
|
@@ -1391,6 +1658,8 @@ interface paths {
|
|
|
1391
1658
|
assetLogo?: string;
|
|
1392
1659
|
/** @description Price of the asset in USD */
|
|
1393
1660
|
assetPriceInUsd?: string;
|
|
1661
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1662
|
+
assetGroup: string;
|
|
1394
1663
|
};
|
|
1395
1664
|
apy: {
|
|
1396
1665
|
/** @description 1day APY of the reward asset */
|
|
@@ -1454,6 +1723,8 @@ interface paths {
|
|
|
1454
1723
|
assetLogo?: string;
|
|
1455
1724
|
/** @description Price of the asset in USD */
|
|
1456
1725
|
assetPriceInUsd?: string;
|
|
1726
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1727
|
+
assetGroup: string;
|
|
1457
1728
|
};
|
|
1458
1729
|
/** @description LP token details of the child vault */
|
|
1459
1730
|
lpToken?: {
|
|
@@ -1487,6 +1758,8 @@ interface paths {
|
|
|
1487
1758
|
assetLogo?: string;
|
|
1488
1759
|
/** @description Price of the asset in USD */
|
|
1489
1760
|
assetPriceInUsd?: string;
|
|
1761
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1762
|
+
assetGroup: string;
|
|
1490
1763
|
}[];
|
|
1491
1764
|
}[];
|
|
1492
1765
|
/** @description Additional assets of the vault */
|
|
@@ -1508,7 +1781,24 @@ interface paths {
|
|
|
1508
1781
|
assetLogo?: string;
|
|
1509
1782
|
/** @description Price of the asset in USD */
|
|
1510
1783
|
assetPriceInUsd?: string;
|
|
1784
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
1785
|
+
assetGroup: string;
|
|
1511
1786
|
}[];
|
|
1787
|
+
/** @description Transactional properties of the vault */
|
|
1788
|
+
transactionalProperties?: {
|
|
1789
|
+
/**
|
|
1790
|
+
* @description Type of transaction steps, either "instant" or "complex"
|
|
1791
|
+
* @enum {string}
|
|
1792
|
+
*/
|
|
1793
|
+
depositStepsType: 'instant' | 'complex';
|
|
1794
|
+
/**
|
|
1795
|
+
* @description Type of transaction steps, either "instant" or "complex"
|
|
1796
|
+
* @enum {string}
|
|
1797
|
+
*/
|
|
1798
|
+
redeemStepsType: 'instant' | 'complex';
|
|
1799
|
+
/** @description Indicates if the vault supports rewards transaction flows */
|
|
1800
|
+
rewardsSupported: boolean;
|
|
1801
|
+
};
|
|
1512
1802
|
};
|
|
1513
1803
|
};
|
|
1514
1804
|
};
|
|
@@ -1519,11 +1809,12 @@ interface paths {
|
|
|
1519
1809
|
};
|
|
1520
1810
|
content: {
|
|
1521
1811
|
'application/json': {
|
|
1522
|
-
|
|
1812
|
+
statusCode: number;
|
|
1523
1813
|
/** @enum {string} */
|
|
1524
1814
|
error: 'Bad Request';
|
|
1525
1815
|
message: string;
|
|
1526
|
-
|
|
1816
|
+
errorId?: string;
|
|
1817
|
+
} | unknown;
|
|
1527
1818
|
};
|
|
1528
1819
|
};
|
|
1529
1820
|
/** @description Default Response */
|
|
@@ -1537,7 +1828,8 @@ interface paths {
|
|
|
1537
1828
|
error: 'Unauthorized';
|
|
1538
1829
|
/** @enum {string} */
|
|
1539
1830
|
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
|
-
|
|
1831
|
+
errorId?: string;
|
|
1832
|
+
} | unknown;
|
|
1541
1833
|
};
|
|
1542
1834
|
};
|
|
1543
1835
|
/** @description Default Response */
|
|
@@ -1551,7 +1843,8 @@ interface paths {
|
|
|
1551
1843
|
error: 'Forbidden';
|
|
1552
1844
|
/** @enum {string} */
|
|
1553
1845
|
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
|
-
|
|
1846
|
+
errorId?: string;
|
|
1847
|
+
} | unknown;
|
|
1555
1848
|
};
|
|
1556
1849
|
};
|
|
1557
1850
|
/** @description Default Response */
|
|
@@ -1564,7 +1857,22 @@ interface paths {
|
|
|
1564
1857
|
/** @enum {string} */
|
|
1565
1858
|
error: 'Internal Server Error';
|
|
1566
1859
|
message: string;
|
|
1567
|
-
|
|
1860
|
+
errorId?: string;
|
|
1861
|
+
} | unknown;
|
|
1862
|
+
};
|
|
1863
|
+
};
|
|
1864
|
+
/** @description Default Response */
|
|
1865
|
+
503: {
|
|
1866
|
+
headers: {
|
|
1867
|
+
[name: string]: unknown;
|
|
1868
|
+
};
|
|
1869
|
+
content: {
|
|
1870
|
+
'application/json': {
|
|
1871
|
+
/** @enum {string} */
|
|
1872
|
+
error: 'Service Unavailable';
|
|
1873
|
+
message: string;
|
|
1874
|
+
errorId?: string;
|
|
1875
|
+
} | unknown;
|
|
1568
1876
|
};
|
|
1569
1877
|
};
|
|
1570
1878
|
};
|
|
@@ -1591,7 +1899,7 @@ interface paths {
|
|
|
1591
1899
|
header?: never;
|
|
1592
1900
|
path: {
|
|
1593
1901
|
/** @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';
|
|
1902
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
1595
1903
|
/** @description Address of the vault for which the data will be returned */
|
|
1596
1904
|
vaultAddress: string;
|
|
1597
1905
|
};
|
|
@@ -1606,7 +1914,7 @@ interface paths {
|
|
|
1606
1914
|
};
|
|
1607
1915
|
content: {
|
|
1608
1916
|
'application/json': {
|
|
1609
|
-
/** @description 1day APY details
|
|
1917
|
+
/** @description 1day APY details */
|
|
1610
1918
|
'1day': {
|
|
1611
1919
|
/** @description Base APY */
|
|
1612
1920
|
base: number;
|
|
@@ -1615,7 +1923,7 @@ interface paths {
|
|
|
1615
1923
|
/** @description Total APY */
|
|
1616
1924
|
total: number;
|
|
1617
1925
|
};
|
|
1618
|
-
/** @description 7day APY details
|
|
1926
|
+
/** @description 7day APY details */
|
|
1619
1927
|
'7day': {
|
|
1620
1928
|
/** @description Base APY */
|
|
1621
1929
|
base: number;
|
|
@@ -1624,7 +1932,7 @@ interface paths {
|
|
|
1624
1932
|
/** @description Total APY */
|
|
1625
1933
|
total: number;
|
|
1626
1934
|
};
|
|
1627
|
-
/** @description 30day APY details
|
|
1935
|
+
/** @description 30day APY details */
|
|
1628
1936
|
'30day': {
|
|
1629
1937
|
/** @description Base APY */
|
|
1630
1938
|
base: number;
|
|
@@ -1643,11 +1951,12 @@ interface paths {
|
|
|
1643
1951
|
};
|
|
1644
1952
|
content: {
|
|
1645
1953
|
'application/json': {
|
|
1646
|
-
|
|
1954
|
+
statusCode: number;
|
|
1647
1955
|
/** @enum {string} */
|
|
1648
1956
|
error: 'Bad Request';
|
|
1649
1957
|
message: string;
|
|
1650
|
-
|
|
1958
|
+
errorId?: string;
|
|
1959
|
+
} | unknown;
|
|
1651
1960
|
};
|
|
1652
1961
|
};
|
|
1653
1962
|
/** @description Default Response */
|
|
@@ -1661,7 +1970,8 @@ interface paths {
|
|
|
1661
1970
|
error: 'Unauthorized';
|
|
1662
1971
|
/** @enum {string} */
|
|
1663
1972
|
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
|
-
|
|
1973
|
+
errorId?: string;
|
|
1974
|
+
} | unknown;
|
|
1665
1975
|
};
|
|
1666
1976
|
};
|
|
1667
1977
|
/** @description Default Response */
|
|
@@ -1675,7 +1985,8 @@ interface paths {
|
|
|
1675
1985
|
error: 'Forbidden';
|
|
1676
1986
|
/** @enum {string} */
|
|
1677
1987
|
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
|
-
|
|
1988
|
+
errorId?: string;
|
|
1989
|
+
} | unknown;
|
|
1679
1990
|
};
|
|
1680
1991
|
};
|
|
1681
1992
|
/** @description Default Response */
|
|
@@ -1688,7 +1999,22 @@ interface paths {
|
|
|
1688
1999
|
/** @enum {string} */
|
|
1689
2000
|
error: 'Internal Server Error';
|
|
1690
2001
|
message: string;
|
|
1691
|
-
|
|
2002
|
+
errorId?: string;
|
|
2003
|
+
} | unknown;
|
|
2004
|
+
};
|
|
2005
|
+
};
|
|
2006
|
+
/** @description Default Response */
|
|
2007
|
+
503: {
|
|
2008
|
+
headers: {
|
|
2009
|
+
[name: string]: unknown;
|
|
2010
|
+
};
|
|
2011
|
+
content: {
|
|
2012
|
+
'application/json': {
|
|
2013
|
+
/** @enum {string} */
|
|
2014
|
+
error: 'Service Unavailable';
|
|
2015
|
+
message: string;
|
|
2016
|
+
errorId?: string;
|
|
2017
|
+
} | unknown;
|
|
1692
2018
|
};
|
|
1693
2019
|
};
|
|
1694
2020
|
};
|
|
@@ -1715,7 +2041,7 @@ interface paths {
|
|
|
1715
2041
|
header?: never;
|
|
1716
2042
|
path: {
|
|
1717
2043
|
/** @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';
|
|
2044
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
1719
2045
|
/** @description Address of the vault for which the data will be returned */
|
|
1720
2046
|
vaultAddress: string;
|
|
1721
2047
|
};
|
|
@@ -1744,11 +2070,12 @@ interface paths {
|
|
|
1744
2070
|
};
|
|
1745
2071
|
content: {
|
|
1746
2072
|
'application/json': {
|
|
1747
|
-
|
|
2073
|
+
statusCode: number;
|
|
1748
2074
|
/** @enum {string} */
|
|
1749
2075
|
error: 'Bad Request';
|
|
1750
2076
|
message: string;
|
|
1751
|
-
|
|
2077
|
+
errorId?: string;
|
|
2078
|
+
} | unknown;
|
|
1752
2079
|
};
|
|
1753
2080
|
};
|
|
1754
2081
|
/** @description Default Response */
|
|
@@ -1762,7 +2089,8 @@ interface paths {
|
|
|
1762
2089
|
error: 'Unauthorized';
|
|
1763
2090
|
/** @enum {string} */
|
|
1764
2091
|
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
|
-
|
|
2092
|
+
errorId?: string;
|
|
2093
|
+
} | unknown;
|
|
1766
2094
|
};
|
|
1767
2095
|
};
|
|
1768
2096
|
/** @description Default Response */
|
|
@@ -1776,7 +2104,8 @@ interface paths {
|
|
|
1776
2104
|
error: 'Forbidden';
|
|
1777
2105
|
/** @enum {string} */
|
|
1778
2106
|
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
|
-
|
|
2107
|
+
errorId?: string;
|
|
2108
|
+
} | unknown;
|
|
1780
2109
|
};
|
|
1781
2110
|
};
|
|
1782
2111
|
/** @description Default Response */
|
|
@@ -1789,7 +2118,22 @@ interface paths {
|
|
|
1789
2118
|
/** @enum {string} */
|
|
1790
2119
|
error: 'Internal Server Error';
|
|
1791
2120
|
message: string;
|
|
1792
|
-
|
|
2121
|
+
errorId?: string;
|
|
2122
|
+
} | unknown;
|
|
2123
|
+
};
|
|
2124
|
+
};
|
|
2125
|
+
/** @description Default Response */
|
|
2126
|
+
503: {
|
|
2127
|
+
headers: {
|
|
2128
|
+
[name: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
content: {
|
|
2131
|
+
'application/json': {
|
|
2132
|
+
/** @enum {string} */
|
|
2133
|
+
error: 'Service Unavailable';
|
|
2134
|
+
message: string;
|
|
2135
|
+
errorId?: string;
|
|
2136
|
+
} | unknown;
|
|
1793
2137
|
};
|
|
1794
2138
|
};
|
|
1795
2139
|
};
|
|
@@ -1813,24 +2157,24 @@ interface paths {
|
|
|
1813
2157
|
get: {
|
|
1814
2158
|
parameters: {
|
|
1815
2159
|
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
2160
|
/** @description Assets to be included by symbol(ticker). */
|
|
1821
|
-
allowedAssets?: string[];
|
|
2161
|
+
allowedAssets?: string[] | string;
|
|
1822
2162
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
1823
|
-
disallowedAssets?: string[];
|
|
2163
|
+
disallowedAssets?: string[] | string;
|
|
1824
2164
|
/** @description Protocols to be included by name. */
|
|
1825
|
-
allowedProtocols?: string[];
|
|
2165
|
+
allowedProtocols?: string[] | string;
|
|
1826
2166
|
/** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
|
|
1827
|
-
disallowedProtocols?: string[];
|
|
2167
|
+
disallowedProtocols?: string[] | string;
|
|
1828
2168
|
/** @description Minimum TVL in USD of the vaults to be included */
|
|
1829
2169
|
minTvl?: number;
|
|
1830
2170
|
/** @description Include only vaults that are supported in the transactional interface. */
|
|
1831
2171
|
onlyTransactional?: boolean;
|
|
1832
2172
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
1833
2173
|
onlyAppFeatured?: boolean;
|
|
2174
|
+
/** @description Networks to be included (name or CAIP). */
|
|
2175
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
2176
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2177
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
1834
2178
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
1835
2179
|
apyInterval?: '1day' | '7day' | '30day';
|
|
1836
2180
|
/** @description Minimum APY of the vault to be included */
|
|
@@ -1875,6 +2219,8 @@ interface paths {
|
|
|
1875
2219
|
assetLogo?: string;
|
|
1876
2220
|
/** @description Price of the asset in USD */
|
|
1877
2221
|
assetPriceInUsd?: string;
|
|
2222
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2223
|
+
assetGroup: string;
|
|
1878
2224
|
/** @description Balance of the asset */
|
|
1879
2225
|
balanceNative: string;
|
|
1880
2226
|
/** @description USD value of the asset */
|
|
@@ -1892,7 +2238,7 @@ interface paths {
|
|
|
1892
2238
|
* @description Name of the network
|
|
1893
2239
|
* @enum {string}
|
|
1894
2240
|
*/
|
|
1895
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2241
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
1896
2242
|
/** @description Chain ID of the network */
|
|
1897
2243
|
chainId: number;
|
|
1898
2244
|
/** @description CAIP-2 of the network */
|
|
@@ -1957,11 +2303,12 @@ interface paths {
|
|
|
1957
2303
|
};
|
|
1958
2304
|
content: {
|
|
1959
2305
|
'application/json': {
|
|
1960
|
-
|
|
2306
|
+
statusCode: number;
|
|
1961
2307
|
/** @enum {string} */
|
|
1962
2308
|
error: 'Bad Request';
|
|
1963
2309
|
message: string;
|
|
1964
|
-
|
|
2310
|
+
errorId?: string;
|
|
2311
|
+
} | unknown;
|
|
1965
2312
|
};
|
|
1966
2313
|
};
|
|
1967
2314
|
/** @description Default Response */
|
|
@@ -1975,7 +2322,8 @@ interface paths {
|
|
|
1975
2322
|
error: 'Unauthorized';
|
|
1976
2323
|
/** @enum {string} */
|
|
1977
2324
|
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
|
-
|
|
2325
|
+
errorId?: string;
|
|
2326
|
+
} | unknown;
|
|
1979
2327
|
};
|
|
1980
2328
|
};
|
|
1981
2329
|
/** @description Default Response */
|
|
@@ -1989,7 +2337,8 @@ interface paths {
|
|
|
1989
2337
|
error: 'Forbidden';
|
|
1990
2338
|
/** @enum {string} */
|
|
1991
2339
|
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
|
-
|
|
2340
|
+
errorId?: string;
|
|
2341
|
+
} | unknown;
|
|
1993
2342
|
};
|
|
1994
2343
|
};
|
|
1995
2344
|
/** @description Default Response */
|
|
@@ -2002,17 +2351,32 @@ interface paths {
|
|
|
2002
2351
|
/** @enum {string} */
|
|
2003
2352
|
error: 'Internal Server Error';
|
|
2004
2353
|
message: string;
|
|
2005
|
-
|
|
2354
|
+
errorId?: string;
|
|
2355
|
+
} | unknown;
|
|
2006
2356
|
};
|
|
2007
2357
|
};
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2358
|
+
/** @description Default Response */
|
|
2359
|
+
503: {
|
|
2360
|
+
headers: {
|
|
2361
|
+
[name: string]: unknown;
|
|
2362
|
+
};
|
|
2363
|
+
content: {
|
|
2364
|
+
'application/json': {
|
|
2365
|
+
/** @enum {string} */
|
|
2366
|
+
error: 'Service Unavailable';
|
|
2367
|
+
message: string;
|
|
2368
|
+
errorId?: string;
|
|
2369
|
+
} | unknown;
|
|
2370
|
+
};
|
|
2371
|
+
};
|
|
2372
|
+
};
|
|
2373
|
+
};
|
|
2374
|
+
put?: never;
|
|
2375
|
+
post?: never;
|
|
2376
|
+
delete?: never;
|
|
2377
|
+
options?: never;
|
|
2378
|
+
head?: never;
|
|
2379
|
+
patch?: never;
|
|
2016
2380
|
trace?: never;
|
|
2017
2381
|
};
|
|
2018
2382
|
'/v2/portfolio/positions/{userAddress}': {
|
|
@@ -2026,28 +2390,30 @@ interface paths {
|
|
|
2026
2390
|
get: {
|
|
2027
2391
|
parameters: {
|
|
2028
2392
|
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
2393
|
/** @description Assets to be included by symbol(ticker). */
|
|
2034
|
-
allowedAssets?: string[];
|
|
2394
|
+
allowedAssets?: string[] | string;
|
|
2035
2395
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
2036
|
-
disallowedAssets?: string[];
|
|
2396
|
+
disallowedAssets?: string[] | string;
|
|
2037
2397
|
/** @description Protocols to be included by name. */
|
|
2038
|
-
allowedProtocols?: string[];
|
|
2398
|
+
allowedProtocols?: string[] | string;
|
|
2039
2399
|
/** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
|
|
2040
|
-
disallowedProtocols?: string[];
|
|
2400
|
+
disallowedProtocols?: string[] | string;
|
|
2041
2401
|
/** @description Minimum TVL in USD of the vaults to be included */
|
|
2042
2402
|
minTvl?: number;
|
|
2043
2403
|
/** @description Include only vaults that are supported in the transactional interface. */
|
|
2044
2404
|
onlyTransactional?: boolean;
|
|
2045
2405
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
2046
2406
|
onlyAppFeatured?: boolean;
|
|
2407
|
+
/** @description Networks to be included (name or CAIP). */
|
|
2408
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
2409
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
2410
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
2047
2411
|
/** @description Maximum TVL in USD of the vaults to be included */
|
|
2048
2412
|
maxTvl?: number;
|
|
2413
|
+
/** @description Maximum APY (in decimal) of the vaults to be included */
|
|
2414
|
+
maxApy?: number;
|
|
2049
2415
|
/** @description Tags to be included. */
|
|
2050
|
-
tags?: string[];
|
|
2416
|
+
tags?: string[] | string;
|
|
2051
2417
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
2052
2418
|
apyInterval?: '1day' | '7day' | '30day';
|
|
2053
2419
|
/** @description Minimum USD value of the vault to be included */
|
|
@@ -2078,7 +2444,7 @@ interface paths {
|
|
|
2078
2444
|
* @description Name of the network
|
|
2079
2445
|
* @enum {string}
|
|
2080
2446
|
*/
|
|
2081
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2447
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
2082
2448
|
/** @description Chain ID of the network */
|
|
2083
2449
|
chainId: number;
|
|
2084
2450
|
/** @description CAIP-2 of the network */
|
|
@@ -2103,6 +2469,8 @@ interface paths {
|
|
|
2103
2469
|
assetLogo?: string;
|
|
2104
2470
|
/** @description Price of the asset in USD */
|
|
2105
2471
|
assetPriceInUsd?: string;
|
|
2472
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2473
|
+
assetGroup: string;
|
|
2106
2474
|
/** @description Balance of the asset denominated in asset wei */
|
|
2107
2475
|
balanceNative: string;
|
|
2108
2476
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2163,6 +2531,8 @@ interface paths {
|
|
|
2163
2531
|
assetLogo?: string;
|
|
2164
2532
|
/** @description Price of the asset in USD */
|
|
2165
2533
|
assetPriceInUsd?: string;
|
|
2534
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2535
|
+
assetGroup: string;
|
|
2166
2536
|
/** @description Balance of the asset denominated in asset wei */
|
|
2167
2537
|
balanceNative: string;
|
|
2168
2538
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2222,6 +2592,8 @@ interface paths {
|
|
|
2222
2592
|
assetLogo?: string;
|
|
2223
2593
|
/** @description Price of the asset in USD */
|
|
2224
2594
|
assetPriceInUsd?: string;
|
|
2595
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2596
|
+
assetGroup: string;
|
|
2225
2597
|
/** @description Balance of the asset denominated in asset wei */
|
|
2226
2598
|
balanceNative: string;
|
|
2227
2599
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2277,6 +2649,8 @@ interface paths {
|
|
|
2277
2649
|
assetLogo?: string;
|
|
2278
2650
|
/** @description Price of the asset in USD */
|
|
2279
2651
|
assetPriceInUsd?: string;
|
|
2652
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2653
|
+
assetGroup: string;
|
|
2280
2654
|
/** @description Balance of the asset denominated in asset wei */
|
|
2281
2655
|
balanceNative: string;
|
|
2282
2656
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2305,11 +2679,12 @@ interface paths {
|
|
|
2305
2679
|
};
|
|
2306
2680
|
content: {
|
|
2307
2681
|
'application/json': {
|
|
2308
|
-
|
|
2682
|
+
statusCode: number;
|
|
2309
2683
|
/** @enum {string} */
|
|
2310
2684
|
error: 'Bad Request';
|
|
2311
2685
|
message: string;
|
|
2312
|
-
|
|
2686
|
+
errorId?: string;
|
|
2687
|
+
} | unknown;
|
|
2313
2688
|
};
|
|
2314
2689
|
};
|
|
2315
2690
|
/** @description Default Response */
|
|
@@ -2323,7 +2698,8 @@ interface paths {
|
|
|
2323
2698
|
error: 'Unauthorized';
|
|
2324
2699
|
/** @enum {string} */
|
|
2325
2700
|
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
|
-
|
|
2701
|
+
errorId?: string;
|
|
2702
|
+
} | unknown;
|
|
2327
2703
|
};
|
|
2328
2704
|
};
|
|
2329
2705
|
/** @description Default Response */
|
|
@@ -2337,7 +2713,8 @@ interface paths {
|
|
|
2337
2713
|
error: 'Forbidden';
|
|
2338
2714
|
/** @enum {string} */
|
|
2339
2715
|
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
|
-
|
|
2716
|
+
errorId?: string;
|
|
2717
|
+
} | unknown;
|
|
2341
2718
|
};
|
|
2342
2719
|
};
|
|
2343
2720
|
/** @description Default Response */
|
|
@@ -2350,7 +2727,22 @@ interface paths {
|
|
|
2350
2727
|
/** @enum {string} */
|
|
2351
2728
|
error: 'Internal Server Error';
|
|
2352
2729
|
message: string;
|
|
2353
|
-
|
|
2730
|
+
errorId?: string;
|
|
2731
|
+
} | unknown;
|
|
2732
|
+
};
|
|
2733
|
+
};
|
|
2734
|
+
/** @description Default Response */
|
|
2735
|
+
503: {
|
|
2736
|
+
headers: {
|
|
2737
|
+
[name: string]: unknown;
|
|
2738
|
+
};
|
|
2739
|
+
content: {
|
|
2740
|
+
'application/json': {
|
|
2741
|
+
/** @enum {string} */
|
|
2742
|
+
error: 'Service Unavailable';
|
|
2743
|
+
message: string;
|
|
2744
|
+
errorId?: string;
|
|
2745
|
+
} | unknown;
|
|
2354
2746
|
};
|
|
2355
2747
|
};
|
|
2356
2748
|
};
|
|
@@ -2382,7 +2774,7 @@ interface paths {
|
|
|
2382
2774
|
/** @description User address to be used for best vault calculation */
|
|
2383
2775
|
userAddress: string;
|
|
2384
2776
|
/** @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';
|
|
2777
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
2386
2778
|
/** @description Address of the vault for which the data will be returned */
|
|
2387
2779
|
vaultAddress: string;
|
|
2388
2780
|
};
|
|
@@ -2405,7 +2797,7 @@ interface paths {
|
|
|
2405
2797
|
* @description Name of the network
|
|
2406
2798
|
* @enum {string}
|
|
2407
2799
|
*/
|
|
2408
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
2800
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
2409
2801
|
/** @description Chain ID of the network */
|
|
2410
2802
|
chainId: number;
|
|
2411
2803
|
/** @description CAIP-2 of the network */
|
|
@@ -2430,6 +2822,8 @@ interface paths {
|
|
|
2430
2822
|
assetLogo?: string;
|
|
2431
2823
|
/** @description Price of the asset in USD */
|
|
2432
2824
|
assetPriceInUsd?: string;
|
|
2825
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2826
|
+
assetGroup: string;
|
|
2433
2827
|
/** @description Balance of the asset denominated in asset wei */
|
|
2434
2828
|
balanceNative: string;
|
|
2435
2829
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2490,6 +2884,8 @@ interface paths {
|
|
|
2490
2884
|
assetLogo?: string;
|
|
2491
2885
|
/** @description Price of the asset in USD */
|
|
2492
2886
|
assetPriceInUsd?: string;
|
|
2887
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2888
|
+
assetGroup: string;
|
|
2493
2889
|
/** @description Balance of the asset denominated in asset wei */
|
|
2494
2890
|
balanceNative: string;
|
|
2495
2891
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2549,6 +2945,8 @@ interface paths {
|
|
|
2549
2945
|
assetLogo?: string;
|
|
2550
2946
|
/** @description Price of the asset in USD */
|
|
2551
2947
|
assetPriceInUsd?: string;
|
|
2948
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
2949
|
+
assetGroup: string;
|
|
2552
2950
|
/** @description Balance of the asset denominated in asset wei */
|
|
2553
2951
|
balanceNative: string;
|
|
2554
2952
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2604,6 +3002,8 @@ interface paths {
|
|
|
2604
3002
|
assetLogo?: string;
|
|
2605
3003
|
/** @description Price of the asset in USD */
|
|
2606
3004
|
assetPriceInUsd?: string;
|
|
3005
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3006
|
+
assetGroup: string;
|
|
2607
3007
|
/** @description Balance of the asset denominated in asset wei */
|
|
2608
3008
|
balanceNative: string;
|
|
2609
3009
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -2626,11 +3026,12 @@ interface paths {
|
|
|
2626
3026
|
};
|
|
2627
3027
|
content: {
|
|
2628
3028
|
'application/json': {
|
|
2629
|
-
|
|
3029
|
+
statusCode: number;
|
|
2630
3030
|
/** @enum {string} */
|
|
2631
3031
|
error: 'Bad Request';
|
|
2632
3032
|
message: string;
|
|
2633
|
-
|
|
3033
|
+
errorId?: string;
|
|
3034
|
+
} | unknown;
|
|
2634
3035
|
};
|
|
2635
3036
|
};
|
|
2636
3037
|
/** @description Default Response */
|
|
@@ -2644,7 +3045,8 @@ interface paths {
|
|
|
2644
3045
|
error: 'Unauthorized';
|
|
2645
3046
|
/** @enum {string} */
|
|
2646
3047
|
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
|
-
|
|
3048
|
+
errorId?: string;
|
|
3049
|
+
} | unknown;
|
|
2648
3050
|
};
|
|
2649
3051
|
};
|
|
2650
3052
|
/** @description Default Response */
|
|
@@ -2658,7 +3060,8 @@ interface paths {
|
|
|
2658
3060
|
error: 'Forbidden';
|
|
2659
3061
|
/** @enum {string} */
|
|
2660
3062
|
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
|
-
|
|
3063
|
+
errorId?: string;
|
|
3064
|
+
} | unknown;
|
|
2662
3065
|
};
|
|
2663
3066
|
};
|
|
2664
3067
|
/** @description Default Response */
|
|
@@ -2671,7 +3074,22 @@ interface paths {
|
|
|
2671
3074
|
/** @enum {string} */
|
|
2672
3075
|
error: 'Internal Server Error';
|
|
2673
3076
|
message: string;
|
|
2674
|
-
|
|
3077
|
+
errorId?: string;
|
|
3078
|
+
} | unknown;
|
|
3079
|
+
};
|
|
3080
|
+
};
|
|
3081
|
+
/** @description Default Response */
|
|
3082
|
+
503: {
|
|
3083
|
+
headers: {
|
|
3084
|
+
[name: string]: unknown;
|
|
3085
|
+
};
|
|
3086
|
+
content: {
|
|
3087
|
+
'application/json': {
|
|
3088
|
+
/** @enum {string} */
|
|
3089
|
+
error: 'Service Unavailable';
|
|
3090
|
+
message: string;
|
|
3091
|
+
errorId?: string;
|
|
3092
|
+
} | unknown;
|
|
2675
3093
|
};
|
|
2676
3094
|
};
|
|
2677
3095
|
};
|
|
@@ -2695,24 +3113,24 @@ interface paths {
|
|
|
2695
3113
|
get: {
|
|
2696
3114
|
parameters: {
|
|
2697
3115
|
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
3116
|
/** @description Assets to be included by symbol(ticker). */
|
|
2703
|
-
allowedAssets?: string[];
|
|
3117
|
+
allowedAssets?: string[] | string;
|
|
2704
3118
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
2705
|
-
disallowedAssets?: string[];
|
|
3119
|
+
disallowedAssets?: string[] | string;
|
|
2706
3120
|
/** @description Protocols to be included by name. */
|
|
2707
|
-
allowedProtocols?: string[];
|
|
3121
|
+
allowedProtocols?: string[] | string;
|
|
2708
3122
|
/** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
|
|
2709
|
-
disallowedProtocols?: string[];
|
|
3123
|
+
disallowedProtocols?: string[] | string;
|
|
2710
3124
|
/** @description Minimum TVL in USD of the vaults to be included */
|
|
2711
3125
|
minTvl?: number;
|
|
2712
3126
|
/** @description Include only vaults that are supported in the transactional interface. */
|
|
2713
3127
|
onlyTransactional?: boolean;
|
|
2714
3128
|
/** @description Include only vaults that are featured in app.vaults.fyi */
|
|
2715
3129
|
onlyAppFeatured?: boolean;
|
|
3130
|
+
/** @description Networks to be included (name or CAIP). */
|
|
3131
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
3132
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
3133
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
2716
3134
|
/** @description Interval for APY data. Possible values: 1day, 7day, 30day */
|
|
2717
3135
|
apyInterval?: '1day' | '7day' | '30day';
|
|
2718
3136
|
/** @description Minimum APY of the vault to be included */
|
|
@@ -2720,7 +3138,7 @@ interface paths {
|
|
|
2720
3138
|
/** @description Minimum USD value of the vault to be included */
|
|
2721
3139
|
minUsdAssetValueThreshold?: number;
|
|
2722
3140
|
/** @description Assets to always be included in the response. */
|
|
2723
|
-
alwaysReturnAssets?: string[];
|
|
3141
|
+
alwaysReturnAssets?: string[] | string;
|
|
2724
3142
|
/** @description Maximum number of vaults to be included per asset. */
|
|
2725
3143
|
maxVaultsPerAsset?: number;
|
|
2726
3144
|
};
|
|
@@ -2763,6 +3181,8 @@ interface paths {
|
|
|
2763
3181
|
assetLogo?: string;
|
|
2764
3182
|
/** @description Price of the asset in USD */
|
|
2765
3183
|
assetPriceInUsd?: string;
|
|
3184
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3185
|
+
assetGroup: string;
|
|
2766
3186
|
/** @description Balance of the asset */
|
|
2767
3187
|
balanceNative: string;
|
|
2768
3188
|
/** @description USD value of the asset */
|
|
@@ -2779,7 +3199,7 @@ interface paths {
|
|
|
2779
3199
|
* @description Name of the network
|
|
2780
3200
|
* @enum {string}
|
|
2781
3201
|
*/
|
|
2782
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3202
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
2783
3203
|
/** @description Chain ID of the network */
|
|
2784
3204
|
chainId: number;
|
|
2785
3205
|
/** @description CAIP-2 of the network */
|
|
@@ -2845,11 +3265,12 @@ interface paths {
|
|
|
2845
3265
|
};
|
|
2846
3266
|
content: {
|
|
2847
3267
|
'application/json': {
|
|
2848
|
-
|
|
3268
|
+
statusCode: number;
|
|
2849
3269
|
/** @enum {string} */
|
|
2850
3270
|
error: 'Bad Request';
|
|
2851
3271
|
message: string;
|
|
2852
|
-
|
|
3272
|
+
errorId?: string;
|
|
3273
|
+
} | unknown;
|
|
2853
3274
|
};
|
|
2854
3275
|
};
|
|
2855
3276
|
/** @description Default Response */
|
|
@@ -2863,7 +3284,8 @@ interface paths {
|
|
|
2863
3284
|
error: 'Unauthorized';
|
|
2864
3285
|
/** @enum {string} */
|
|
2865
3286
|
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
|
-
|
|
3287
|
+
errorId?: string;
|
|
3288
|
+
} | unknown;
|
|
2867
3289
|
};
|
|
2868
3290
|
};
|
|
2869
3291
|
/** @description Default Response */
|
|
@@ -2877,7 +3299,8 @@ interface paths {
|
|
|
2877
3299
|
error: 'Forbidden';
|
|
2878
3300
|
/** @enum {string} */
|
|
2879
3301
|
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
|
-
|
|
3302
|
+
errorId?: string;
|
|
3303
|
+
} | unknown;
|
|
2881
3304
|
};
|
|
2882
3305
|
};
|
|
2883
3306
|
/** @description Default Response */
|
|
@@ -2890,110 +3313,22 @@ interface paths {
|
|
|
2890
3313
|
/** @enum {string} */
|
|
2891
3314
|
error: 'Internal Server Error';
|
|
2892
3315
|
message: string;
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
};
|
|
2896
|
-
};
|
|
2897
|
-
};
|
|
2898
|
-
put?: never;
|
|
2899
|
-
post?: never;
|
|
2900
|
-
delete?: never;
|
|
2901
|
-
options?: never;
|
|
2902
|
-
head?: never;
|
|
2903
|
-
patch?: never;
|
|
2904
|
-
trace?: never;
|
|
2905
|
-
};
|
|
2906
|
-
'/v2/portfolio/returns/{userAddress}/{network}/{vaultAddress}': {
|
|
2907
|
-
parameters: {
|
|
2908
|
-
query?: never;
|
|
2909
|
-
header?: never;
|
|
2910
|
-
path?: never;
|
|
2911
|
-
cookie?: never;
|
|
2912
|
-
};
|
|
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. */
|
|
2914
|
-
get: {
|
|
2915
|
-
parameters: {
|
|
2916
|
-
query?: never;
|
|
2917
|
-
header?: never;
|
|
2918
|
-
path: {
|
|
2919
|
-
/** @description User address to get returns for */
|
|
2920
|
-
userAddress: string;
|
|
2921
|
-
/** @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';
|
|
2923
|
-
/** @description Vault address to get returns for */
|
|
2924
|
-
vaultAddress: string;
|
|
2925
|
-
};
|
|
2926
|
-
cookie?: never;
|
|
2927
|
-
};
|
|
2928
|
-
requestBody?: never;
|
|
2929
|
-
responses: {
|
|
2930
|
-
/** @description Default Response */
|
|
2931
|
-
200: {
|
|
2932
|
-
headers: {
|
|
2933
|
-
[name: string]: unknown;
|
|
2934
|
-
};
|
|
2935
|
-
content: {
|
|
2936
|
-
'application/json': {
|
|
2937
|
-
/** @description TVL in USD */
|
|
2938
|
-
usd: string;
|
|
2939
|
-
/** @description Native TVL */
|
|
2940
|
-
native: string;
|
|
2941
|
-
};
|
|
2942
|
-
};
|
|
2943
|
-
};
|
|
2944
|
-
/** @description Default Response */
|
|
2945
|
-
400: {
|
|
2946
|
-
headers: {
|
|
2947
|
-
[name: string]: unknown;
|
|
2948
|
-
};
|
|
2949
|
-
content: {
|
|
2950
|
-
'application/json': {
|
|
2951
|
-
code: string;
|
|
2952
|
-
/** @enum {string} */
|
|
2953
|
-
error: 'Bad Request';
|
|
2954
|
-
message: string;
|
|
2955
|
-
};
|
|
2956
|
-
};
|
|
2957
|
-
};
|
|
2958
|
-
/** @description Default Response */
|
|
2959
|
-
401: {
|
|
2960
|
-
headers: {
|
|
2961
|
-
[name: string]: unknown;
|
|
2962
|
-
};
|
|
2963
|
-
content: {
|
|
2964
|
-
'application/json': {
|
|
2965
|
-
/** @enum {string} */
|
|
2966
|
-
error: 'Unauthorized';
|
|
2967
|
-
/** @enum {string} */
|
|
2968
|
-
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
|
-
};
|
|
2970
|
-
};
|
|
2971
|
-
};
|
|
2972
|
-
/** @description Default Response */
|
|
2973
|
-
403: {
|
|
2974
|
-
headers: {
|
|
2975
|
-
[name: string]: unknown;
|
|
2976
|
-
};
|
|
2977
|
-
content: {
|
|
2978
|
-
'application/json': {
|
|
2979
|
-
/** @enum {string} */
|
|
2980
|
-
error: 'Forbidden';
|
|
2981
|
-
/** @enum {string} */
|
|
2982
|
-
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
|
-
};
|
|
3316
|
+
errorId?: string;
|
|
3317
|
+
} | unknown;
|
|
2984
3318
|
};
|
|
2985
3319
|
};
|
|
2986
3320
|
/** @description Default Response */
|
|
2987
|
-
|
|
3321
|
+
503: {
|
|
2988
3322
|
headers: {
|
|
2989
3323
|
[name: string]: unknown;
|
|
2990
3324
|
};
|
|
2991
3325
|
content: {
|
|
2992
3326
|
'application/json': {
|
|
2993
3327
|
/** @enum {string} */
|
|
2994
|
-
error: '
|
|
3328
|
+
error: 'Service Unavailable';
|
|
2995
3329
|
message: string;
|
|
2996
|
-
|
|
3330
|
+
errorId?: string;
|
|
3331
|
+
} | unknown;
|
|
2997
3332
|
};
|
|
2998
3333
|
};
|
|
2999
3334
|
};
|
|
@@ -3017,16 +3352,16 @@ interface paths {
|
|
|
3017
3352
|
get: {
|
|
3018
3353
|
parameters: {
|
|
3019
3354
|
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
3355
|
/** @description Assets to be included by symbol(ticker). */
|
|
3025
|
-
allowedAssets?: string[];
|
|
3356
|
+
allowedAssets?: string[] | string;
|
|
3026
3357
|
/** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
|
|
3027
|
-
disallowedAssets?: string[];
|
|
3358
|
+
disallowedAssets?: string[] | string;
|
|
3028
3359
|
/** @description Minimum USD value of the asset to be included */
|
|
3029
3360
|
minUsdAssetValueThreshold?: number;
|
|
3361
|
+
/** @description Networks to be included (name or CAIP). */
|
|
3362
|
+
allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
3363
|
+
/** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
|
|
3364
|
+
disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999')[] | ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999');
|
|
3030
3365
|
};
|
|
3031
3366
|
header?: never;
|
|
3032
3367
|
path: {
|
|
@@ -3062,6 +3397,8 @@ interface paths {
|
|
|
3062
3397
|
assetLogo?: string;
|
|
3063
3398
|
/** @description Price of the asset in USD */
|
|
3064
3399
|
assetPriceInUsd?: string;
|
|
3400
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3401
|
+
assetGroup: string;
|
|
3065
3402
|
/** @description Balance of the asset */
|
|
3066
3403
|
balanceNative: string;
|
|
3067
3404
|
/** @description USD value of the asset */
|
|
@@ -3072,7 +3409,7 @@ interface paths {
|
|
|
3072
3409
|
* @description Name of the network
|
|
3073
3410
|
* @enum {string}
|
|
3074
3411
|
*/
|
|
3075
|
-
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3412
|
+
name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
3076
3413
|
/** @description Chain ID of the network */
|
|
3077
3414
|
chainId: number;
|
|
3078
3415
|
/** @description CAIP-2 of the network */
|
|
@@ -3093,11 +3430,12 @@ interface paths {
|
|
|
3093
3430
|
};
|
|
3094
3431
|
content: {
|
|
3095
3432
|
'application/json': {
|
|
3096
|
-
|
|
3433
|
+
statusCode: number;
|
|
3097
3434
|
/** @enum {string} */
|
|
3098
3435
|
error: 'Bad Request';
|
|
3099
3436
|
message: string;
|
|
3100
|
-
|
|
3437
|
+
errorId?: string;
|
|
3438
|
+
} | unknown;
|
|
3101
3439
|
};
|
|
3102
3440
|
};
|
|
3103
3441
|
/** @description Default Response */
|
|
@@ -3111,7 +3449,8 @@ interface paths {
|
|
|
3111
3449
|
error: 'Unauthorized';
|
|
3112
3450
|
/** @enum {string} */
|
|
3113
3451
|
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
|
-
|
|
3452
|
+
errorId?: string;
|
|
3453
|
+
} | unknown;
|
|
3115
3454
|
};
|
|
3116
3455
|
};
|
|
3117
3456
|
/** @description Default Response */
|
|
@@ -3125,7 +3464,8 @@ interface paths {
|
|
|
3125
3464
|
error: 'Forbidden';
|
|
3126
3465
|
/** @enum {string} */
|
|
3127
3466
|
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
|
-
|
|
3467
|
+
errorId?: string;
|
|
3468
|
+
} | unknown;
|
|
3129
3469
|
};
|
|
3130
3470
|
};
|
|
3131
3471
|
/** @description Default Response */
|
|
@@ -3138,7 +3478,22 @@ interface paths {
|
|
|
3138
3478
|
/** @enum {string} */
|
|
3139
3479
|
error: 'Internal Server Error';
|
|
3140
3480
|
message: string;
|
|
3141
|
-
|
|
3481
|
+
errorId?: string;
|
|
3482
|
+
} | unknown;
|
|
3483
|
+
};
|
|
3484
|
+
};
|
|
3485
|
+
/** @description Default Response */
|
|
3486
|
+
503: {
|
|
3487
|
+
headers: {
|
|
3488
|
+
[name: string]: unknown;
|
|
3489
|
+
};
|
|
3490
|
+
content: {
|
|
3491
|
+
'application/json': {
|
|
3492
|
+
/** @enum {string} */
|
|
3493
|
+
error: 'Service Unavailable';
|
|
3494
|
+
message: string;
|
|
3495
|
+
errorId?: string;
|
|
3496
|
+
} | unknown;
|
|
3142
3497
|
};
|
|
3143
3498
|
};
|
|
3144
3499
|
};
|
|
@@ -3151,234 +3506,99 @@ interface paths {
|
|
|
3151
3506
|
patch?: never;
|
|
3152
3507
|
trace?: never;
|
|
3153
3508
|
};
|
|
3154
|
-
'/v2/
|
|
3509
|
+
'/v2/transactions/context/{userAddress}/{network}/{vaultAddress}': {
|
|
3155
3510
|
parameters: {
|
|
3156
3511
|
query?: never;
|
|
3157
3512
|
header?: never;
|
|
3158
3513
|
path?: never;
|
|
3159
3514
|
cookie?: never;
|
|
3160
3515
|
};
|
|
3161
|
-
/** @description Retrieves
|
|
3516
|
+
/** @description Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards. */
|
|
3162
3517
|
get: {
|
|
3163
3518
|
parameters: {
|
|
3164
|
-
query?:
|
|
3165
|
-
/** @description Page number (starting from 0) */
|
|
3166
|
-
page?: number;
|
|
3167
|
-
/** @description Number of items per page */
|
|
3168
|
-
perPage?: number;
|
|
3169
|
-
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
3170
|
-
fromTimestamp?: number;
|
|
3171
|
-
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
3172
|
-
toTimestamp?: number;
|
|
3173
|
-
};
|
|
3519
|
+
query?: never;
|
|
3174
3520
|
header?: never;
|
|
3175
3521
|
path: {
|
|
3176
|
-
/** @description User address
|
|
3522
|
+
/** @description User address */
|
|
3177
3523
|
userAddress: string;
|
|
3178
|
-
/** @description Network
|
|
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';
|
|
3180
|
-
/** @description Vault address
|
|
3524
|
+
/** @description Network name or CAIP-2 identifier */
|
|
3525
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
3526
|
+
/** @description Vault address */
|
|
3181
3527
|
vaultAddress: string;
|
|
3182
3528
|
};
|
|
3183
3529
|
cookie?: never;
|
|
3184
3530
|
};
|
|
3185
3531
|
requestBody?: never;
|
|
3186
3532
|
responses: {
|
|
3187
|
-
/** @description
|
|
3533
|
+
/** @description Transaction context information for a user and vault */
|
|
3188
3534
|
200: {
|
|
3189
3535
|
headers: {
|
|
3190
3536
|
[name: string]: unknown;
|
|
3191
3537
|
};
|
|
3192
3538
|
content: {
|
|
3193
3539
|
'application/json': {
|
|
3194
|
-
/**
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
|
|
3540
|
+
/**
|
|
3541
|
+
* @description Current deposit step
|
|
3542
|
+
* @enum {string}
|
|
3543
|
+
*/
|
|
3544
|
+
currentDepositStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3545
|
+
/** @description Deposit steps */
|
|
3546
|
+
depositSteps: {
|
|
3547
|
+
actions: string[];
|
|
3548
|
+
actionsUrl: string;
|
|
3549
|
+
/** @enum {string} */
|
|
3550
|
+
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3551
|
+
}[];
|
|
3552
|
+
/**
|
|
3553
|
+
* @description Current redeem step
|
|
3554
|
+
* @enum {string}
|
|
3555
|
+
*/
|
|
3556
|
+
currentRedeemStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3557
|
+
/** @description Redeem steps */
|
|
3558
|
+
redeemSteps: {
|
|
3559
|
+
actions: string[];
|
|
3560
|
+
actionsUrl: string;
|
|
3561
|
+
/** @enum {string} */
|
|
3562
|
+
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3563
|
+
}[];
|
|
3564
|
+
/** @description LP token details */
|
|
3565
|
+
lpToken: {
|
|
3566
|
+
/** @description Address of the LP token */
|
|
3567
|
+
address: string;
|
|
3568
|
+
/** @description CAIP-2 of the LP token */
|
|
3569
|
+
tokenCaip: string;
|
|
3570
|
+
/** @description Name of the LP token */
|
|
3571
|
+
name: string;
|
|
3572
|
+
/** @description Symbol of the LP token */
|
|
3573
|
+
symbol: string;
|
|
3574
|
+
/** @description Number of decimals of the LP token */
|
|
3575
|
+
decimals: number;
|
|
3576
|
+
/** @description Balance of the LP token */
|
|
3577
|
+
balanceNative: string;
|
|
3578
|
+
/** @description USD value of the LP token */
|
|
3579
|
+
balanceUsd: string;
|
|
3580
|
+
};
|
|
3581
|
+
/** @description Asset details */
|
|
3582
|
+
asset: {
|
|
3583
|
+
/** @description Address of the asset */
|
|
3584
|
+
address: string;
|
|
3585
|
+
/** @description CAIP-2 of the asset */
|
|
3586
|
+
assetCaip: string;
|
|
3587
|
+
/** @description Name of the asset */
|
|
3588
|
+
name: string;
|
|
3589
|
+
/** @description Symbol of the asset */
|
|
3590
|
+
symbol: string;
|
|
3591
|
+
/** @description Number of decimals of the asset */
|
|
3592
|
+
decimals: number;
|
|
3203
3593
|
/**
|
|
3204
|
-
*
|
|
3205
|
-
* @
|
|
3206
|
-
*/
|
|
3207
|
-
eventType: 'Deposit' | 'Withdrawal' | 'Transfer';
|
|
3208
|
-
/** @description Asset amount involved in the event */
|
|
3209
|
-
eventAssetAmount: {
|
|
3210
|
-
/** @description USD value of the asset amount */
|
|
3211
|
-
usd: string;
|
|
3212
|
-
/** @description Native value of the asset amount */
|
|
3213
|
-
native: string;
|
|
3214
|
-
};
|
|
3215
|
-
/** @description Resulting position after the event */
|
|
3216
|
-
resultingPosition: {
|
|
3217
|
-
/** @description USD value of the resulting position */
|
|
3218
|
-
usd: string;
|
|
3219
|
-
/** @description Native value of the resulting position */
|
|
3220
|
-
native: string;
|
|
3221
|
-
};
|
|
3222
|
-
}[];
|
|
3223
|
-
};
|
|
3224
|
-
};
|
|
3225
|
-
};
|
|
3226
|
-
/** @description Default Response */
|
|
3227
|
-
400: {
|
|
3228
|
-
headers: {
|
|
3229
|
-
[name: string]: unknown;
|
|
3230
|
-
};
|
|
3231
|
-
content: {
|
|
3232
|
-
'application/json': {
|
|
3233
|
-
code: string;
|
|
3234
|
-
/** @enum {string} */
|
|
3235
|
-
error: 'Bad Request';
|
|
3236
|
-
message: string;
|
|
3237
|
-
};
|
|
3238
|
-
};
|
|
3239
|
-
};
|
|
3240
|
-
/** @description Default Response */
|
|
3241
|
-
401: {
|
|
3242
|
-
headers: {
|
|
3243
|
-
[name: string]: unknown;
|
|
3244
|
-
};
|
|
3245
|
-
content: {
|
|
3246
|
-
'application/json': {
|
|
3247
|
-
/** @enum {string} */
|
|
3248
|
-
error: 'Unauthorized';
|
|
3249
|
-
/** @enum {string} */
|
|
3250
|
-
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
|
-
};
|
|
3252
|
-
};
|
|
3253
|
-
};
|
|
3254
|
-
/** @description Default Response */
|
|
3255
|
-
403: {
|
|
3256
|
-
headers: {
|
|
3257
|
-
[name: string]: unknown;
|
|
3258
|
-
};
|
|
3259
|
-
content: {
|
|
3260
|
-
'application/json': {
|
|
3261
|
-
/** @enum {string} */
|
|
3262
|
-
error: 'Forbidden';
|
|
3263
|
-
/** @enum {string} */
|
|
3264
|
-
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
|
-
};
|
|
3266
|
-
};
|
|
3267
|
-
};
|
|
3268
|
-
/** @description Default Response */
|
|
3269
|
-
500: {
|
|
3270
|
-
headers: {
|
|
3271
|
-
[name: string]: unknown;
|
|
3272
|
-
};
|
|
3273
|
-
content: {
|
|
3274
|
-
'application/json': {
|
|
3275
|
-
/** @enum {string} */
|
|
3276
|
-
error: 'Internal Server Error';
|
|
3277
|
-
message: string;
|
|
3278
|
-
};
|
|
3279
|
-
};
|
|
3280
|
-
};
|
|
3281
|
-
};
|
|
3282
|
-
};
|
|
3283
|
-
put?: never;
|
|
3284
|
-
post?: never;
|
|
3285
|
-
delete?: never;
|
|
3286
|
-
options?: never;
|
|
3287
|
-
head?: never;
|
|
3288
|
-
patch?: never;
|
|
3289
|
-
trace?: never;
|
|
3290
|
-
};
|
|
3291
|
-
'/v2/transactions/context/{userAddress}/{network}/{vaultAddress}': {
|
|
3292
|
-
parameters: {
|
|
3293
|
-
query?: never;
|
|
3294
|
-
header?: never;
|
|
3295
|
-
path?: never;
|
|
3296
|
-
cookie?: never;
|
|
3297
|
-
};
|
|
3298
|
-
/** @description Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards. */
|
|
3299
|
-
get: {
|
|
3300
|
-
parameters: {
|
|
3301
|
-
query?: never;
|
|
3302
|
-
header?: never;
|
|
3303
|
-
path: {
|
|
3304
|
-
/** @description User address */
|
|
3305
|
-
userAddress: string;
|
|
3306
|
-
/** @description Network name */
|
|
3307
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3308
|
-
/** @description Vault address */
|
|
3309
|
-
vaultAddress: string;
|
|
3310
|
-
};
|
|
3311
|
-
cookie?: never;
|
|
3312
|
-
};
|
|
3313
|
-
requestBody?: never;
|
|
3314
|
-
responses: {
|
|
3315
|
-
/** @description Transaction context information for a user and vault */
|
|
3316
|
-
200: {
|
|
3317
|
-
headers: {
|
|
3318
|
-
[name: string]: unknown;
|
|
3319
|
-
};
|
|
3320
|
-
content: {
|
|
3321
|
-
'application/json': {
|
|
3322
|
-
/**
|
|
3323
|
-
* @description Current deposit step
|
|
3324
|
-
* @enum {string}
|
|
3325
|
-
*/
|
|
3326
|
-
currentDepositStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3327
|
-
/** @description Deposit steps */
|
|
3328
|
-
depositSteps: {
|
|
3329
|
-
actions: string[];
|
|
3330
|
-
actionsUrl: string;
|
|
3331
|
-
/** @enum {string} */
|
|
3332
|
-
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3333
|
-
}[];
|
|
3334
|
-
/**
|
|
3335
|
-
* @description Current redeem step
|
|
3336
|
-
* @enum {string}
|
|
3337
|
-
*/
|
|
3338
|
-
currentRedeemStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3339
|
-
/** @description Redeem steps */
|
|
3340
|
-
redeemSteps: {
|
|
3341
|
-
actions: string[];
|
|
3342
|
-
actionsUrl: string;
|
|
3343
|
-
/** @enum {string} */
|
|
3344
|
-
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3345
|
-
}[];
|
|
3346
|
-
/** @description LP token details */
|
|
3347
|
-
lpToken: {
|
|
3348
|
-
/** @description Address of the LP token */
|
|
3349
|
-
address: string;
|
|
3350
|
-
/** @description CAIP-2 of the LP token */
|
|
3351
|
-
tokenCaip: string;
|
|
3352
|
-
/** @description Name of the LP token */
|
|
3353
|
-
name: string;
|
|
3354
|
-
/** @description Symbol of the LP token */
|
|
3355
|
-
symbol: string;
|
|
3356
|
-
/** @description Number of decimals of the LP token */
|
|
3357
|
-
decimals: number;
|
|
3358
|
-
/** @description Balance of the LP token */
|
|
3359
|
-
balanceNative: string;
|
|
3360
|
-
/** @description USD value of the LP token */
|
|
3361
|
-
balanceUsd: string;
|
|
3362
|
-
};
|
|
3363
|
-
/** @description Asset details */
|
|
3364
|
-
asset: {
|
|
3365
|
-
/** @description Address of the asset */
|
|
3366
|
-
address: string;
|
|
3367
|
-
/** @description CAIP-2 of the asset */
|
|
3368
|
-
assetCaip: string;
|
|
3369
|
-
/** @description Name of the asset */
|
|
3370
|
-
name: string;
|
|
3371
|
-
/** @description Symbol of the asset */
|
|
3372
|
-
symbol: string;
|
|
3373
|
-
/** @description Number of decimals of the asset */
|
|
3374
|
-
decimals: number;
|
|
3375
|
-
/**
|
|
3376
|
-
* Format: uri
|
|
3377
|
-
* @description URL of the asset logo
|
|
3594
|
+
* Format: uri
|
|
3595
|
+
* @description URL of the asset logo
|
|
3378
3596
|
*/
|
|
3379
3597
|
assetLogo?: string;
|
|
3380
3598
|
/** @description Price of the asset in USD */
|
|
3381
3599
|
assetPriceInUsd?: string;
|
|
3600
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3601
|
+
assetGroup: string;
|
|
3382
3602
|
/** @description Balance of the asset denominated in asset wei */
|
|
3383
3603
|
balanceNative: string;
|
|
3384
3604
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -3409,6 +3629,8 @@ interface paths {
|
|
|
3409
3629
|
assetLogo?: string;
|
|
3410
3630
|
/** @description Price of the asset in USD */
|
|
3411
3631
|
assetPriceInUsd?: string;
|
|
3632
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3633
|
+
assetGroup: string;
|
|
3412
3634
|
/** @description Balance of the asset denominated in asset wei */
|
|
3413
3635
|
balanceNative: string;
|
|
3414
3636
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -3459,6 +3681,8 @@ interface paths {
|
|
|
3459
3681
|
assetLogo?: string;
|
|
3460
3682
|
/** @description Price of the asset in USD */
|
|
3461
3683
|
assetPriceInUsd?: string;
|
|
3684
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3685
|
+
assetGroup: string;
|
|
3462
3686
|
/** @description Balance of the asset denominated in asset wei */
|
|
3463
3687
|
balanceNative: string;
|
|
3464
3688
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -3489,6 +3713,8 @@ interface paths {
|
|
|
3489
3713
|
assetLogo?: string;
|
|
3490
3714
|
/** @description Price of the asset in USD */
|
|
3491
3715
|
assetPriceInUsd?: string;
|
|
3716
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3717
|
+
assetGroup: string;
|
|
3492
3718
|
/** @description Balance of the asset denominated in asset wei */
|
|
3493
3719
|
balanceNative: string;
|
|
3494
3720
|
/** @description Balance of the asset denominated in usd */
|
|
@@ -3525,30 +3751,47 @@ interface paths {
|
|
|
3525
3751
|
assetLogo?: string;
|
|
3526
3752
|
/** @description Price of the asset in USD */
|
|
3527
3753
|
assetPriceInUsd?: string;
|
|
3754
|
+
/** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
|
|
3755
|
+
assetGroup: string;
|
|
3528
3756
|
/**
|
|
3529
3757
|
* @description Network of the reward
|
|
3530
3758
|
* @enum {string}
|
|
3531
3759
|
*/
|
|
3532
|
-
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain';
|
|
3760
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
|
|
3533
3761
|
};
|
|
3534
3762
|
}[];
|
|
3535
3763
|
/**
|
|
3536
3764
|
* @description Current step for claiming rewards
|
|
3537
3765
|
* @enum {string}
|
|
3538
3766
|
*/
|
|
3539
|
-
currentStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3767
|
+
currentStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3540
3768
|
/** @description Steps for claiming rewards */
|
|
3541
3769
|
steps: {
|
|
3542
3770
|
actions: string[];
|
|
3543
3771
|
actionsUrl: string;
|
|
3544
3772
|
/** @enum {string} */
|
|
3545
|
-
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3773
|
+
name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3546
3774
|
}[];
|
|
3547
3775
|
};
|
|
3548
3776
|
};
|
|
3549
3777
|
};
|
|
3550
3778
|
};
|
|
3551
3779
|
/** @description Default Response */
|
|
3780
|
+
400: {
|
|
3781
|
+
headers: {
|
|
3782
|
+
[name: string]: unknown;
|
|
3783
|
+
};
|
|
3784
|
+
content: {
|
|
3785
|
+
'application/json': {
|
|
3786
|
+
statusCode: number;
|
|
3787
|
+
/** @enum {string} */
|
|
3788
|
+
error: 'Bad Request';
|
|
3789
|
+
message: string;
|
|
3790
|
+
errorId?: string;
|
|
3791
|
+
} | unknown;
|
|
3792
|
+
};
|
|
3793
|
+
};
|
|
3794
|
+
/** @description Default Response */
|
|
3552
3795
|
401: {
|
|
3553
3796
|
headers: {
|
|
3554
3797
|
[name: string]: unknown;
|
|
@@ -3559,7 +3802,8 @@ interface paths {
|
|
|
3559
3802
|
error: 'Unauthorized';
|
|
3560
3803
|
/** @enum {string} */
|
|
3561
3804
|
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
|
-
|
|
3805
|
+
errorId?: string;
|
|
3806
|
+
} | unknown;
|
|
3563
3807
|
};
|
|
3564
3808
|
};
|
|
3565
3809
|
/** @description Default Response */
|
|
@@ -3573,7 +3817,8 @@ interface paths {
|
|
|
3573
3817
|
error: 'Forbidden';
|
|
3574
3818
|
/** @enum {string} */
|
|
3575
3819
|
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
|
-
|
|
3820
|
+
errorId?: string;
|
|
3821
|
+
} | unknown;
|
|
3577
3822
|
};
|
|
3578
3823
|
};
|
|
3579
3824
|
/** @description Default Response */
|
|
@@ -3586,7 +3831,22 @@ interface paths {
|
|
|
3586
3831
|
/** @enum {string} */
|
|
3587
3832
|
error: 'Internal Server Error';
|
|
3588
3833
|
message: string;
|
|
3589
|
-
|
|
3834
|
+
errorId?: string;
|
|
3835
|
+
} | unknown;
|
|
3836
|
+
};
|
|
3837
|
+
};
|
|
3838
|
+
/** @description Default Response */
|
|
3839
|
+
503: {
|
|
3840
|
+
headers: {
|
|
3841
|
+
[name: string]: unknown;
|
|
3842
|
+
};
|
|
3843
|
+
content: {
|
|
3844
|
+
'application/json': {
|
|
3845
|
+
/** @enum {string} */
|
|
3846
|
+
error: 'Service Unavailable';
|
|
3847
|
+
message: string;
|
|
3848
|
+
errorId?: string;
|
|
3849
|
+
} | unknown;
|
|
3590
3850
|
};
|
|
3591
3851
|
};
|
|
3592
3852
|
};
|
|
@@ -3621,14 +3881,318 @@ interface paths {
|
|
|
3621
3881
|
};
|
|
3622
3882
|
header?: never;
|
|
3623
3883
|
path: {
|
|
3624
|
-
/** @description Action to be performed */
|
|
3625
|
-
action: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
|
|
3626
|
-
/** @description User address to get returns for */
|
|
3627
|
-
userAddress: string;
|
|
3628
|
-
/** @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';
|
|
3630
|
-
/** @description Vault address to get returns for */
|
|
3631
|
-
vaultAddress: string;
|
|
3884
|
+
/** @description Action to be performed */
|
|
3885
|
+
action: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
|
|
3886
|
+
/** @description User address to get returns for */
|
|
3887
|
+
userAddress: string;
|
|
3888
|
+
/** @description Network to get returns for */
|
|
3889
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
3890
|
+
/** @description Vault address to get returns for */
|
|
3891
|
+
vaultAddress: string;
|
|
3892
|
+
};
|
|
3893
|
+
cookie?: never;
|
|
3894
|
+
};
|
|
3895
|
+
requestBody?: never;
|
|
3896
|
+
responses: {
|
|
3897
|
+
/** @description Default Response */
|
|
3898
|
+
200: {
|
|
3899
|
+
headers: {
|
|
3900
|
+
[name: string]: unknown;
|
|
3901
|
+
};
|
|
3902
|
+
content: {
|
|
3903
|
+
'application/json': {
|
|
3904
|
+
currentActionIndex: number;
|
|
3905
|
+
actions: {
|
|
3906
|
+
/** @description Name of the action */
|
|
3907
|
+
name: string;
|
|
3908
|
+
tx: {
|
|
3909
|
+
/** @description Address of the transaction recipient */
|
|
3910
|
+
to: string;
|
|
3911
|
+
/** @description Chain ID of the transaction */
|
|
3912
|
+
chainId: number;
|
|
3913
|
+
/** @description Data to be sent with the transaction */
|
|
3914
|
+
data?: string;
|
|
3915
|
+
/** @description Value to be sent with the transaction */
|
|
3916
|
+
value?: string;
|
|
3917
|
+
};
|
|
3918
|
+
simulation?: {
|
|
3919
|
+
/** @description URL to simulated transaction */
|
|
3920
|
+
url: string;
|
|
3921
|
+
/**
|
|
3922
|
+
* @description Status of the simulation
|
|
3923
|
+
* @enum {string}
|
|
3924
|
+
*/
|
|
3925
|
+
status: 'success' | 'failure' | 'internal server error';
|
|
3926
|
+
/** @description Tokens received from the transaction */
|
|
3927
|
+
tokensReceived?: {
|
|
3928
|
+
[key: string]: string;
|
|
3929
|
+
};
|
|
3930
|
+
/** @description Tokens spent in the transaction */
|
|
3931
|
+
tokensSpent?: {
|
|
3932
|
+
[key: string]: string;
|
|
3933
|
+
};
|
|
3934
|
+
};
|
|
3935
|
+
}[];
|
|
3936
|
+
};
|
|
3937
|
+
};
|
|
3938
|
+
};
|
|
3939
|
+
/** @description Default Response */
|
|
3940
|
+
400: {
|
|
3941
|
+
headers: {
|
|
3942
|
+
[name: string]: unknown;
|
|
3943
|
+
};
|
|
3944
|
+
content: {
|
|
3945
|
+
'application/json': {
|
|
3946
|
+
statusCode: number;
|
|
3947
|
+
/** @enum {string} */
|
|
3948
|
+
error: 'Bad Request';
|
|
3949
|
+
message: string;
|
|
3950
|
+
errorId?: string;
|
|
3951
|
+
} | unknown;
|
|
3952
|
+
};
|
|
3953
|
+
};
|
|
3954
|
+
/** @description Default Response */
|
|
3955
|
+
401: {
|
|
3956
|
+
headers: {
|
|
3957
|
+
[name: string]: unknown;
|
|
3958
|
+
};
|
|
3959
|
+
content: {
|
|
3960
|
+
'application/json': {
|
|
3961
|
+
/** @enum {string} */
|
|
3962
|
+
error: 'Unauthorized';
|
|
3963
|
+
/** @enum {string} */
|
|
3964
|
+
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.';
|
|
3965
|
+
errorId?: string;
|
|
3966
|
+
} | unknown;
|
|
3967
|
+
};
|
|
3968
|
+
};
|
|
3969
|
+
/** @description Default Response */
|
|
3970
|
+
403: {
|
|
3971
|
+
headers: {
|
|
3972
|
+
[name: string]: unknown;
|
|
3973
|
+
};
|
|
3974
|
+
content: {
|
|
3975
|
+
'application/json': {
|
|
3976
|
+
/** @enum {string} */
|
|
3977
|
+
error: 'Forbidden';
|
|
3978
|
+
/** @enum {string} */
|
|
3979
|
+
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.';
|
|
3980
|
+
errorId?: string;
|
|
3981
|
+
} | unknown;
|
|
3982
|
+
};
|
|
3983
|
+
};
|
|
3984
|
+
/** @description Default Response */
|
|
3985
|
+
500: {
|
|
3986
|
+
headers: {
|
|
3987
|
+
[name: string]: unknown;
|
|
3988
|
+
};
|
|
3989
|
+
content: {
|
|
3990
|
+
'application/json': {
|
|
3991
|
+
/** @enum {string} */
|
|
3992
|
+
error: 'Internal Server Error';
|
|
3993
|
+
message: string;
|
|
3994
|
+
errorId?: string;
|
|
3995
|
+
} | unknown;
|
|
3996
|
+
};
|
|
3997
|
+
};
|
|
3998
|
+
/** @description Default Response */
|
|
3999
|
+
503: {
|
|
4000
|
+
headers: {
|
|
4001
|
+
[name: string]: unknown;
|
|
4002
|
+
};
|
|
4003
|
+
content: {
|
|
4004
|
+
'application/json': {
|
|
4005
|
+
/** @enum {string} */
|
|
4006
|
+
error: 'Service Unavailable';
|
|
4007
|
+
message: string;
|
|
4008
|
+
errorId?: string;
|
|
4009
|
+
} | unknown;
|
|
4010
|
+
};
|
|
4011
|
+
};
|
|
4012
|
+
};
|
|
4013
|
+
};
|
|
4014
|
+
put?: never;
|
|
4015
|
+
post?: never;
|
|
4016
|
+
delete?: never;
|
|
4017
|
+
options?: never;
|
|
4018
|
+
head?: never;
|
|
4019
|
+
patch?: never;
|
|
4020
|
+
trace?: never;
|
|
4021
|
+
};
|
|
4022
|
+
'/v2/benchmarks/{network}': {
|
|
4023
|
+
parameters: {
|
|
4024
|
+
query?: never;
|
|
4025
|
+
header?: never;
|
|
4026
|
+
path?: never;
|
|
4027
|
+
cookie?: never;
|
|
4028
|
+
};
|
|
4029
|
+
/** @description Retrieves benchmark APY data for the specified network and benchmark code. */
|
|
4030
|
+
get: {
|
|
4031
|
+
parameters: {
|
|
4032
|
+
query: {
|
|
4033
|
+
/** @description Benchmark code identifier. Available codes: usd, eth */
|
|
4034
|
+
code: 'usd' | 'eth';
|
|
4035
|
+
};
|
|
4036
|
+
header?: never;
|
|
4037
|
+
path: {
|
|
4038
|
+
/** @description Network name or CAIP-2 identifier */
|
|
4039
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
4040
|
+
};
|
|
4041
|
+
cookie?: never;
|
|
4042
|
+
};
|
|
4043
|
+
requestBody?: never;
|
|
4044
|
+
responses: {
|
|
4045
|
+
/** @description Default Response */
|
|
4046
|
+
200: {
|
|
4047
|
+
headers: {
|
|
4048
|
+
[name: string]: unknown;
|
|
4049
|
+
};
|
|
4050
|
+
content: {
|
|
4051
|
+
'application/json': {
|
|
4052
|
+
/** @description APY interval breakdown for the benchmark */
|
|
4053
|
+
apy: {
|
|
4054
|
+
/** @description 1day APY details */
|
|
4055
|
+
'1day': {
|
|
4056
|
+
/** @description Base APY */
|
|
4057
|
+
base: number;
|
|
4058
|
+
/** @description Reward APY */
|
|
4059
|
+
reward: number;
|
|
4060
|
+
/** @description Total APY */
|
|
4061
|
+
total: number;
|
|
4062
|
+
};
|
|
4063
|
+
/** @description 7day APY details */
|
|
4064
|
+
'7day': {
|
|
4065
|
+
/** @description Base APY */
|
|
4066
|
+
base: number;
|
|
4067
|
+
/** @description Reward APY */
|
|
4068
|
+
reward: number;
|
|
4069
|
+
/** @description Total APY */
|
|
4070
|
+
total: number;
|
|
4071
|
+
};
|
|
4072
|
+
/** @description 30day APY details */
|
|
4073
|
+
'30day': {
|
|
4074
|
+
/** @description Base APY */
|
|
4075
|
+
base: number;
|
|
4076
|
+
/** @description Reward APY */
|
|
4077
|
+
reward: number;
|
|
4078
|
+
/** @description Total APY */
|
|
4079
|
+
total: number;
|
|
4080
|
+
};
|
|
4081
|
+
} | null;
|
|
4082
|
+
/** @description Timestamp of the benchmark data point */
|
|
4083
|
+
timestamp: number;
|
|
4084
|
+
};
|
|
4085
|
+
};
|
|
4086
|
+
};
|
|
4087
|
+
/** @description Default Response */
|
|
4088
|
+
400: {
|
|
4089
|
+
headers: {
|
|
4090
|
+
[name: string]: unknown;
|
|
4091
|
+
};
|
|
4092
|
+
content: {
|
|
4093
|
+
'application/json': {
|
|
4094
|
+
statusCode: number;
|
|
4095
|
+
/** @enum {string} */
|
|
4096
|
+
error: 'Bad Request';
|
|
4097
|
+
message: string;
|
|
4098
|
+
errorId?: string;
|
|
4099
|
+
} | unknown;
|
|
4100
|
+
};
|
|
4101
|
+
};
|
|
4102
|
+
/** @description Default Response */
|
|
4103
|
+
401: {
|
|
4104
|
+
headers: {
|
|
4105
|
+
[name: string]: unknown;
|
|
4106
|
+
};
|
|
4107
|
+
content: {
|
|
4108
|
+
'application/json': {
|
|
4109
|
+
/** @enum {string} */
|
|
4110
|
+
error: 'Unauthorized';
|
|
4111
|
+
/** @enum {string} */
|
|
4112
|
+
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.';
|
|
4113
|
+
errorId?: string;
|
|
4114
|
+
} | unknown;
|
|
4115
|
+
};
|
|
4116
|
+
};
|
|
4117
|
+
/** @description Default Response */
|
|
4118
|
+
403: {
|
|
4119
|
+
headers: {
|
|
4120
|
+
[name: string]: unknown;
|
|
4121
|
+
};
|
|
4122
|
+
content: {
|
|
4123
|
+
'application/json': {
|
|
4124
|
+
/** @enum {string} */
|
|
4125
|
+
error: 'Forbidden';
|
|
4126
|
+
/** @enum {string} */
|
|
4127
|
+
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.';
|
|
4128
|
+
errorId?: string;
|
|
4129
|
+
} | unknown;
|
|
4130
|
+
};
|
|
4131
|
+
};
|
|
4132
|
+
/** @description Default Response */
|
|
4133
|
+
500: {
|
|
4134
|
+
headers: {
|
|
4135
|
+
[name: string]: unknown;
|
|
4136
|
+
};
|
|
4137
|
+
content: {
|
|
4138
|
+
'application/json': {
|
|
4139
|
+
/** @enum {string} */
|
|
4140
|
+
error: 'Internal Server Error';
|
|
4141
|
+
message: string;
|
|
4142
|
+
errorId?: string;
|
|
4143
|
+
} | unknown;
|
|
4144
|
+
};
|
|
4145
|
+
};
|
|
4146
|
+
/** @description Default Response */
|
|
4147
|
+
503: {
|
|
4148
|
+
headers: {
|
|
4149
|
+
[name: string]: unknown;
|
|
4150
|
+
};
|
|
4151
|
+
content: {
|
|
4152
|
+
'application/json': {
|
|
4153
|
+
/** @enum {string} */
|
|
4154
|
+
error: 'Service Unavailable';
|
|
4155
|
+
message: string;
|
|
4156
|
+
errorId?: string;
|
|
4157
|
+
} | unknown;
|
|
4158
|
+
};
|
|
4159
|
+
};
|
|
4160
|
+
};
|
|
4161
|
+
};
|
|
4162
|
+
put?: never;
|
|
4163
|
+
post?: never;
|
|
4164
|
+
delete?: never;
|
|
4165
|
+
options?: never;
|
|
4166
|
+
head?: never;
|
|
4167
|
+
patch?: never;
|
|
4168
|
+
trace?: never;
|
|
4169
|
+
};
|
|
4170
|
+
'/v2/historical-benchmarks/{network}': {
|
|
4171
|
+
parameters: {
|
|
4172
|
+
query?: never;
|
|
4173
|
+
header?: never;
|
|
4174
|
+
path?: never;
|
|
4175
|
+
cookie?: never;
|
|
4176
|
+
};
|
|
4177
|
+
/** @description Retrieves historical benchmark APY data for the specified network and benchmark code with pagination. */
|
|
4178
|
+
get: {
|
|
4179
|
+
parameters: {
|
|
4180
|
+
query: {
|
|
4181
|
+
/** @description Page number (starting from 0) */
|
|
4182
|
+
page?: number;
|
|
4183
|
+
/** @description Number of items per page */
|
|
4184
|
+
perPage?: number;
|
|
4185
|
+
/** @description Benchmark code identifier. Available codes: usd, eth */
|
|
4186
|
+
code: 'usd' | 'eth';
|
|
4187
|
+
/** @description Timestamp for the start of the time period for which data will be fetched */
|
|
4188
|
+
fromTimestamp?: number;
|
|
4189
|
+
/** @description Timestamp for the end of the time period for which data will be fetched */
|
|
4190
|
+
toTimestamp?: number;
|
|
4191
|
+
};
|
|
4192
|
+
header?: never;
|
|
4193
|
+
path: {
|
|
4194
|
+
/** @description Network name or CAIP-2 identifier */
|
|
4195
|
+
network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073' | 'eip155:56' | 'eip155:999';
|
|
3632
4196
|
};
|
|
3633
4197
|
cookie?: never;
|
|
3634
4198
|
};
|
|
@@ -3641,42 +4205,63 @@ interface paths {
|
|
|
3641
4205
|
};
|
|
3642
4206
|
content: {
|
|
3643
4207
|
'application/json': {
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
/** @description
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3658
|
-
|
|
3659
|
-
/** @description URL to simulated transaction */
|
|
3660
|
-
url: string;
|
|
3661
|
-
/**
|
|
3662
|
-
* @description Status of the simulation
|
|
3663
|
-
* @enum {string}
|
|
3664
|
-
*/
|
|
3665
|
-
status: 'success' | 'failure' | 'internal server error';
|
|
3666
|
-
/** @description Tokens received from the transaction */
|
|
3667
|
-
tokensReceived?: {
|
|
3668
|
-
[key: string]: string;
|
|
4208
|
+
/** @description Number of items on the current page */
|
|
4209
|
+
itemsOnPage: number;
|
|
4210
|
+
/** @description Next page number */
|
|
4211
|
+
nextPage?: number;
|
|
4212
|
+
data: {
|
|
4213
|
+
/** @description APY interval breakdown for the benchmark */
|
|
4214
|
+
apy: {
|
|
4215
|
+
/** @description 1day APY details */
|
|
4216
|
+
'1day': {
|
|
4217
|
+
/** @description Base APY */
|
|
4218
|
+
base: number;
|
|
4219
|
+
/** @description Reward APY */
|
|
4220
|
+
reward: number;
|
|
4221
|
+
/** @description Total APY */
|
|
4222
|
+
total: number;
|
|
3669
4223
|
};
|
|
3670
|
-
/** @description
|
|
3671
|
-
|
|
3672
|
-
|
|
4224
|
+
/** @description 7day APY details */
|
|
4225
|
+
'7day': {
|
|
4226
|
+
/** @description Base APY */
|
|
4227
|
+
base: number;
|
|
4228
|
+
/** @description Reward APY */
|
|
4229
|
+
reward: number;
|
|
4230
|
+
/** @description Total APY */
|
|
4231
|
+
total: number;
|
|
3673
4232
|
};
|
|
3674
|
-
|
|
4233
|
+
/** @description 30day APY details */
|
|
4234
|
+
'30day': {
|
|
4235
|
+
/** @description Base APY */
|
|
4236
|
+
base: number;
|
|
4237
|
+
/** @description Reward APY */
|
|
4238
|
+
reward: number;
|
|
4239
|
+
/** @description Total APY */
|
|
4240
|
+
total: number;
|
|
4241
|
+
};
|
|
4242
|
+
} | null;
|
|
4243
|
+
/** @description Timestamp of the benchmark data point */
|
|
4244
|
+
timestamp: number;
|
|
3675
4245
|
}[];
|
|
3676
4246
|
};
|
|
3677
4247
|
};
|
|
3678
4248
|
};
|
|
3679
4249
|
/** @description Default Response */
|
|
4250
|
+
400: {
|
|
4251
|
+
headers: {
|
|
4252
|
+
[name: string]: unknown;
|
|
4253
|
+
};
|
|
4254
|
+
content: {
|
|
4255
|
+
'application/json': {
|
|
4256
|
+
statusCode: number;
|
|
4257
|
+
/** @enum {string} */
|
|
4258
|
+
error: 'Bad Request';
|
|
4259
|
+
message: string;
|
|
4260
|
+
errorId?: string;
|
|
4261
|
+
} | unknown;
|
|
4262
|
+
};
|
|
4263
|
+
};
|
|
4264
|
+
/** @description Default Response */
|
|
3680
4265
|
401: {
|
|
3681
4266
|
headers: {
|
|
3682
4267
|
[name: string]: unknown;
|
|
@@ -3687,7 +4272,8 @@ interface paths {
|
|
|
3687
4272
|
error: 'Unauthorized';
|
|
3688
4273
|
/** @enum {string} */
|
|
3689
4274
|
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
|
-
|
|
4275
|
+
errorId?: string;
|
|
4276
|
+
} | unknown;
|
|
3691
4277
|
};
|
|
3692
4278
|
};
|
|
3693
4279
|
/** @description Default Response */
|
|
@@ -3701,7 +4287,8 @@ interface paths {
|
|
|
3701
4287
|
error: 'Forbidden';
|
|
3702
4288
|
/** @enum {string} */
|
|
3703
4289
|
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
|
-
|
|
4290
|
+
errorId?: string;
|
|
4291
|
+
} | unknown;
|
|
3705
4292
|
};
|
|
3706
4293
|
};
|
|
3707
4294
|
/** @description Default Response */
|
|
@@ -3714,7 +4301,22 @@ interface paths {
|
|
|
3714
4301
|
/** @enum {string} */
|
|
3715
4302
|
error: 'Internal Server Error';
|
|
3716
4303
|
message: string;
|
|
3717
|
-
|
|
4304
|
+
errorId?: string;
|
|
4305
|
+
} | unknown;
|
|
4306
|
+
};
|
|
4307
|
+
};
|
|
4308
|
+
/** @description Default Response */
|
|
4309
|
+
503: {
|
|
4310
|
+
headers: {
|
|
4311
|
+
[name: string]: unknown;
|
|
4312
|
+
};
|
|
4313
|
+
content: {
|
|
4314
|
+
'application/json': {
|
|
4315
|
+
/** @enum {string} */
|
|
4316
|
+
error: 'Service Unavailable';
|
|
4317
|
+
message: string;
|
|
4318
|
+
errorId?: string;
|
|
4319
|
+
} | unknown;
|
|
3718
4320
|
};
|
|
3719
4321
|
};
|
|
3720
4322
|
};
|
|
@@ -3735,14 +4337,14 @@ interface ConstructorOptions {
|
|
|
3735
4337
|
interface InternalOptions {
|
|
3736
4338
|
apiBaseUrl: string;
|
|
3737
4339
|
}
|
|
3738
|
-
type
|
|
3739
|
-
type
|
|
4340
|
+
type Endpoint = keyof paths;
|
|
4341
|
+
type ExtractParams<T> = T extends {
|
|
3740
4342
|
parameters: infer P extends {
|
|
3741
4343
|
path?: any;
|
|
3742
4344
|
query?: any;
|
|
3743
4345
|
};
|
|
3744
4346
|
} ? Pick<P, 'path' | 'query'> : never;
|
|
3745
|
-
type
|
|
4347
|
+
type Body<T extends Endpoint> = paths[T]['post'] extends {
|
|
3746
4348
|
requestBody: {
|
|
3747
4349
|
content: {
|
|
3748
4350
|
'application/json': infer R;
|
|
@@ -3759,42 +4361,53 @@ type BodyV2<T extends EndpointV2> = paths[T]['post'] extends {
|
|
|
3759
4361
|
} ? {
|
|
3760
4362
|
body?: R;
|
|
3761
4363
|
} : undefined;
|
|
3762
|
-
type
|
|
4364
|
+
type Params<T extends Endpoint> = Body<T> extends undefined ? ExtractParams<paths[T]['get' | 'post']> : ExtractParams<paths[T]['get' | 'post']> & Body<T>;
|
|
3763
4365
|
declare class VaultsSdk {
|
|
3764
4366
|
private apiBaseUrl;
|
|
3765
4367
|
private apiKey;
|
|
3766
4368
|
constructor(options: ConstructorOptions);
|
|
3767
4369
|
constructor(options: ConstructorOptions, internalOptions: InternalOptions);
|
|
3768
4370
|
private fetchData;
|
|
3769
|
-
|
|
3770
|
-
|
|
4371
|
+
getAssets(params: Params<'/v2/assets'>): Promise<{
|
|
4372
|
+
itemsOnPage: number;
|
|
4373
|
+
nextPage?: number;
|
|
4374
|
+
data: {
|
|
4375
|
+
address: string;
|
|
4376
|
+
assetCaip: string;
|
|
3771
4377
|
name: string;
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
4378
|
+
symbol: string;
|
|
4379
|
+
decimals: number;
|
|
4380
|
+
assetLogo?: string;
|
|
4381
|
+
assetPriceInUsd?: string;
|
|
4382
|
+
assetGroup: string;
|
|
4383
|
+
network: {
|
|
4384
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4385
|
+
chainId: number;
|
|
4386
|
+
networkCaip: string;
|
|
3776
4387
|
};
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
apy: {
|
|
3786
|
-
"1day": number;
|
|
3787
|
-
"7day": number;
|
|
3788
|
-
"30day": number;
|
|
4388
|
+
}[];
|
|
4389
|
+
}>;
|
|
4390
|
+
getBenchmarks(params: Params<'/v2/benchmarks/{network}'>): Promise<{
|
|
4391
|
+
apy: {
|
|
4392
|
+
"1day": {
|
|
4393
|
+
base: number;
|
|
4394
|
+
reward: number;
|
|
4395
|
+
total: number;
|
|
3789
4396
|
};
|
|
3790
|
-
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
}
|
|
3795
|
-
|
|
4397
|
+
"7day": {
|
|
4398
|
+
base: number;
|
|
4399
|
+
reward: number;
|
|
4400
|
+
total: number;
|
|
4401
|
+
};
|
|
4402
|
+
"30day": {
|
|
4403
|
+
base: number;
|
|
4404
|
+
reward: number;
|
|
4405
|
+
total: number;
|
|
4406
|
+
};
|
|
4407
|
+
} | null;
|
|
4408
|
+
timestamp: number;
|
|
3796
4409
|
}>;
|
|
3797
|
-
getVaultHistoricalData(params:
|
|
4410
|
+
getVaultHistoricalData(params: Params<'/v2/historical/{network}/{vaultAddress}'>): Promise<{
|
|
3798
4411
|
itemsOnPage: number;
|
|
3799
4412
|
nextPage?: number;
|
|
3800
4413
|
data: {
|
|
@@ -3811,15 +4424,11 @@ declare class VaultsSdk {
|
|
|
3811
4424
|
};
|
|
3812
4425
|
}[];
|
|
3813
4426
|
}>;
|
|
3814
|
-
|
|
3815
|
-
usd: string;
|
|
3816
|
-
native: string;
|
|
3817
|
-
}>;
|
|
3818
|
-
getPositions(params: ParamsV2<'/v2/portfolio/positions/{userAddress}'>): Promise<{
|
|
4427
|
+
getPositions(params: Params<'/v2/portfolio/positions/{userAddress}'>): Promise<{
|
|
3819
4428
|
data: {
|
|
3820
4429
|
address: string;
|
|
3821
4430
|
network: {
|
|
3822
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4431
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
3823
4432
|
chainId: number;
|
|
3824
4433
|
networkCaip: string;
|
|
3825
4434
|
};
|
|
@@ -3831,6 +4440,7 @@ declare class VaultsSdk {
|
|
|
3831
4440
|
decimals: number;
|
|
3832
4441
|
assetLogo?: string;
|
|
3833
4442
|
assetPriceInUsd?: string;
|
|
4443
|
+
assetGroup: string;
|
|
3834
4444
|
balanceNative: string;
|
|
3835
4445
|
balanceUsd: string;
|
|
3836
4446
|
unclaimedNative?: string;
|
|
@@ -3861,6 +4471,7 @@ declare class VaultsSdk {
|
|
|
3861
4471
|
decimals: number;
|
|
3862
4472
|
assetLogo?: string;
|
|
3863
4473
|
assetPriceInUsd?: string;
|
|
4474
|
+
assetGroup: string;
|
|
3864
4475
|
balanceNative: string;
|
|
3865
4476
|
balanceUsd: string;
|
|
3866
4477
|
unclaimedNative?: string;
|
|
@@ -3890,6 +4501,7 @@ declare class VaultsSdk {
|
|
|
3890
4501
|
decimals: number;
|
|
3891
4502
|
assetLogo?: string;
|
|
3892
4503
|
assetPriceInUsd?: string;
|
|
4504
|
+
assetGroup: string;
|
|
3893
4505
|
balanceNative: string;
|
|
3894
4506
|
balanceUsd: string;
|
|
3895
4507
|
unclaimedNative?: string;
|
|
@@ -3917,6 +4529,7 @@ declare class VaultsSdk {
|
|
|
3917
4529
|
decimals: number;
|
|
3918
4530
|
assetLogo?: string;
|
|
3919
4531
|
assetPriceInUsd?: string;
|
|
4532
|
+
assetGroup: string;
|
|
3920
4533
|
balanceNative: string;
|
|
3921
4534
|
balanceUsd: string;
|
|
3922
4535
|
unclaimedNative?: string;
|
|
@@ -3931,7 +4544,120 @@ declare class VaultsSdk {
|
|
|
3931
4544
|
unsupportedProtocols: string[];
|
|
3932
4545
|
};
|
|
3933
4546
|
}>;
|
|
3934
|
-
|
|
4547
|
+
getPosition(params: Params<'/v2/portfolio/positions/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4548
|
+
address: string;
|
|
4549
|
+
network: {
|
|
4550
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4551
|
+
chainId: number;
|
|
4552
|
+
networkCaip: string;
|
|
4553
|
+
};
|
|
4554
|
+
asset: {
|
|
4555
|
+
address: string;
|
|
4556
|
+
assetCaip: string;
|
|
4557
|
+
name: string;
|
|
4558
|
+
symbol: string;
|
|
4559
|
+
decimals: number;
|
|
4560
|
+
assetLogo?: string;
|
|
4561
|
+
assetPriceInUsd?: string;
|
|
4562
|
+
assetGroup: string;
|
|
4563
|
+
balanceNative: string;
|
|
4564
|
+
balanceUsd: string;
|
|
4565
|
+
unclaimedNative?: string;
|
|
4566
|
+
unclaimedUsd?: string;
|
|
4567
|
+
positionValueInAsset?: string;
|
|
4568
|
+
};
|
|
4569
|
+
isTransactional: boolean;
|
|
4570
|
+
isAppFeatured: boolean;
|
|
4571
|
+
name: string;
|
|
4572
|
+
protocol: {
|
|
4573
|
+
name: string;
|
|
4574
|
+
product?: string;
|
|
4575
|
+
version?: string;
|
|
4576
|
+
protocolUrl?: string;
|
|
4577
|
+
description?: string;
|
|
4578
|
+
protocolLogo?: string;
|
|
4579
|
+
};
|
|
4580
|
+
apy: {
|
|
4581
|
+
base: number;
|
|
4582
|
+
reward: number;
|
|
4583
|
+
total: number;
|
|
4584
|
+
};
|
|
4585
|
+
additionalAssets?: {
|
|
4586
|
+
address: string;
|
|
4587
|
+
assetCaip: string;
|
|
4588
|
+
name: string;
|
|
4589
|
+
symbol: string;
|
|
4590
|
+
decimals: number;
|
|
4591
|
+
assetLogo?: string;
|
|
4592
|
+
assetPriceInUsd?: string;
|
|
4593
|
+
assetGroup: string;
|
|
4594
|
+
balanceNative: string;
|
|
4595
|
+
balanceUsd: string;
|
|
4596
|
+
unclaimedNative?: string;
|
|
4597
|
+
unclaimedUsd?: string;
|
|
4598
|
+
positionValueInAsset?: string;
|
|
4599
|
+
}[];
|
|
4600
|
+
lpToken?: {
|
|
4601
|
+
address: string;
|
|
4602
|
+
tokenCaip: string;
|
|
4603
|
+
name: string;
|
|
4604
|
+
symbol: string;
|
|
4605
|
+
decimals: number;
|
|
4606
|
+
balanceNative: string;
|
|
4607
|
+
balanceUsd: string;
|
|
4608
|
+
unclaimedNative?: string;
|
|
4609
|
+
unclaimedUsd?: string;
|
|
4610
|
+
positionValueInAsset?: string;
|
|
4611
|
+
assetPriceInUsd?: string;
|
|
4612
|
+
};
|
|
4613
|
+
childrenVaults?: {
|
|
4614
|
+
address: string;
|
|
4615
|
+
asset: {
|
|
4616
|
+
address: string;
|
|
4617
|
+
assetCaip: string;
|
|
4618
|
+
name: string;
|
|
4619
|
+
symbol: string;
|
|
4620
|
+
decimals: number;
|
|
4621
|
+
assetLogo?: string;
|
|
4622
|
+
assetPriceInUsd?: string;
|
|
4623
|
+
assetGroup: string;
|
|
4624
|
+
balanceNative: string;
|
|
4625
|
+
balanceUsd: string;
|
|
4626
|
+
unclaimedNative?: string;
|
|
4627
|
+
unclaimedUsd?: string;
|
|
4628
|
+
positionValueInAsset?: string;
|
|
4629
|
+
};
|
|
4630
|
+
lpToken?: {
|
|
4631
|
+
address: string;
|
|
4632
|
+
tokenCaip: string;
|
|
4633
|
+
name: string;
|
|
4634
|
+
symbol: string;
|
|
4635
|
+
decimals: number;
|
|
4636
|
+
balanceNative: string;
|
|
4637
|
+
balanceUsd: string;
|
|
4638
|
+
unclaimedNative?: string;
|
|
4639
|
+
unclaimedUsd?: string;
|
|
4640
|
+
positionValueInAsset?: string;
|
|
4641
|
+
assetPriceInUsd?: string;
|
|
4642
|
+
};
|
|
4643
|
+
additionalAssets?: {
|
|
4644
|
+
address: string;
|
|
4645
|
+
assetCaip: string;
|
|
4646
|
+
name: string;
|
|
4647
|
+
symbol: string;
|
|
4648
|
+
decimals: number;
|
|
4649
|
+
assetLogo?: string;
|
|
4650
|
+
assetPriceInUsd?: string;
|
|
4651
|
+
assetGroup: string;
|
|
4652
|
+
balanceNative: string;
|
|
4653
|
+
balanceUsd: string;
|
|
4654
|
+
unclaimedNative?: string;
|
|
4655
|
+
unclaimedUsd?: string;
|
|
4656
|
+
positionValueInAsset?: string;
|
|
4657
|
+
}[];
|
|
4658
|
+
}[];
|
|
4659
|
+
}>;
|
|
4660
|
+
getDepositOptions(params: Params<'/v2/portfolio/best-deposit-options/{userAddress}'>): Promise<{
|
|
3935
4661
|
requestedAddress: string;
|
|
3936
4662
|
userBalances: {
|
|
3937
4663
|
asset?: {
|
|
@@ -3942,6 +4668,7 @@ declare class VaultsSdk {
|
|
|
3942
4668
|
decimals: number;
|
|
3943
4669
|
assetLogo?: string;
|
|
3944
4670
|
assetPriceInUsd?: string;
|
|
4671
|
+
assetGroup: string;
|
|
3945
4672
|
balanceNative: string;
|
|
3946
4673
|
balanceUsd: string;
|
|
3947
4674
|
};
|
|
@@ -3949,7 +4676,7 @@ declare class VaultsSdk {
|
|
|
3949
4676
|
name: string;
|
|
3950
4677
|
address: string;
|
|
3951
4678
|
network: {
|
|
3952
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4679
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
3953
4680
|
chainId: number;
|
|
3954
4681
|
networkCaip: string;
|
|
3955
4682
|
};
|
|
@@ -3984,30 +4711,13 @@ declare class VaultsSdk {
|
|
|
3984
4711
|
unsupportedProtocols: string[];
|
|
3985
4712
|
};
|
|
3986
4713
|
}>;
|
|
3987
|
-
|
|
3988
|
-
itemsOnPage: number;
|
|
3989
|
-
nextPage?: number;
|
|
3990
|
-
data: {
|
|
3991
|
-
timestamp: number;
|
|
3992
|
-
blockNumber: string;
|
|
3993
|
-
eventType: "Deposit" | "Withdrawal" | "Transfer";
|
|
3994
|
-
eventAssetAmount: {
|
|
3995
|
-
usd: string;
|
|
3996
|
-
native: string;
|
|
3997
|
-
};
|
|
3998
|
-
resultingPosition: {
|
|
3999
|
-
usd: string;
|
|
4000
|
-
native: string;
|
|
4001
|
-
};
|
|
4002
|
-
}[];
|
|
4003
|
-
}>;
|
|
4004
|
-
getAllVaults(params?: ParamsV2<'/v2/detailed-vaults'>): Promise<{
|
|
4714
|
+
getAllVaults(params?: Params<'/v2/detailed-vaults'>): Promise<{
|
|
4005
4715
|
itemsOnPage: number;
|
|
4006
4716
|
nextPage?: number;
|
|
4007
4717
|
data: {
|
|
4008
4718
|
address: string;
|
|
4009
4719
|
network: {
|
|
4010
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4720
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4011
4721
|
chainId: number;
|
|
4012
4722
|
networkCaip: string;
|
|
4013
4723
|
};
|
|
@@ -4019,6 +4729,7 @@ declare class VaultsSdk {
|
|
|
4019
4729
|
decimals: number;
|
|
4020
4730
|
assetLogo?: string;
|
|
4021
4731
|
assetPriceInUsd?: string;
|
|
4732
|
+
assetGroup: string;
|
|
4022
4733
|
};
|
|
4023
4734
|
isTransactional: boolean;
|
|
4024
4735
|
isAppFeatured: boolean;
|
|
@@ -4073,6 +4784,7 @@ declare class VaultsSdk {
|
|
|
4073
4784
|
decimals: number;
|
|
4074
4785
|
assetLogo?: string;
|
|
4075
4786
|
assetPriceInUsd?: string;
|
|
4787
|
+
assetGroup: string;
|
|
4076
4788
|
};
|
|
4077
4789
|
apy: {
|
|
4078
4790
|
"1day": number;
|
|
@@ -4106,6 +4818,7 @@ declare class VaultsSdk {
|
|
|
4106
4818
|
decimals: number;
|
|
4107
4819
|
assetLogo?: string;
|
|
4108
4820
|
assetPriceInUsd?: string;
|
|
4821
|
+
assetGroup: string;
|
|
4109
4822
|
};
|
|
4110
4823
|
lpToken?: {
|
|
4111
4824
|
address: string;
|
|
@@ -4122,6 +4835,7 @@ declare class VaultsSdk {
|
|
|
4122
4835
|
decimals: number;
|
|
4123
4836
|
assetLogo?: string;
|
|
4124
4837
|
assetPriceInUsd?: string;
|
|
4838
|
+
assetGroup: string;
|
|
4125
4839
|
}[];
|
|
4126
4840
|
}[];
|
|
4127
4841
|
additionalAssets?: {
|
|
@@ -4132,7 +4846,13 @@ declare class VaultsSdk {
|
|
|
4132
4846
|
decimals: number;
|
|
4133
4847
|
assetLogo?: string;
|
|
4134
4848
|
assetPriceInUsd?: string;
|
|
4849
|
+
assetGroup: string;
|
|
4135
4850
|
}[];
|
|
4851
|
+
transactionalProperties?: {
|
|
4852
|
+
depositStepsType: "instant" | "complex";
|
|
4853
|
+
redeemStepsType: "instant" | "complex";
|
|
4854
|
+
rewardsSupported: boolean;
|
|
4855
|
+
};
|
|
4136
4856
|
}[];
|
|
4137
4857
|
errors: {
|
|
4138
4858
|
unsupportedNetworks: string[];
|
|
@@ -4140,10 +4860,10 @@ declare class VaultsSdk {
|
|
|
4140
4860
|
unsupportedProtocols: string[];
|
|
4141
4861
|
};
|
|
4142
4862
|
}>;
|
|
4143
|
-
getVault(params:
|
|
4863
|
+
getVault(params: Params<'/v2/detailed-vaults/{network}/{vaultAddress}'>): Promise<{
|
|
4144
4864
|
address: string;
|
|
4145
4865
|
network: {
|
|
4146
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
4866
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4147
4867
|
chainId: number;
|
|
4148
4868
|
networkCaip: string;
|
|
4149
4869
|
};
|
|
@@ -4155,6 +4875,7 @@ declare class VaultsSdk {
|
|
|
4155
4875
|
decimals: number;
|
|
4156
4876
|
assetLogo?: string;
|
|
4157
4877
|
assetPriceInUsd?: string;
|
|
4878
|
+
assetGroup: string;
|
|
4158
4879
|
};
|
|
4159
4880
|
isTransactional: boolean;
|
|
4160
4881
|
isAppFeatured: boolean;
|
|
@@ -4209,6 +4930,7 @@ declare class VaultsSdk {
|
|
|
4209
4930
|
decimals: number;
|
|
4210
4931
|
assetLogo?: string;
|
|
4211
4932
|
assetPriceInUsd?: string;
|
|
4933
|
+
assetGroup: string;
|
|
4212
4934
|
};
|
|
4213
4935
|
apy: {
|
|
4214
4936
|
"1day": number;
|
|
@@ -4242,6 +4964,7 @@ declare class VaultsSdk {
|
|
|
4242
4964
|
decimals: number;
|
|
4243
4965
|
assetLogo?: string;
|
|
4244
4966
|
assetPriceInUsd?: string;
|
|
4967
|
+
assetGroup: string;
|
|
4245
4968
|
};
|
|
4246
4969
|
lpToken?: {
|
|
4247
4970
|
address: string;
|
|
@@ -4258,6 +4981,7 @@ declare class VaultsSdk {
|
|
|
4258
4981
|
decimals: number;
|
|
4259
4982
|
assetLogo?: string;
|
|
4260
4983
|
assetPriceInUsd?: string;
|
|
4984
|
+
assetGroup: string;
|
|
4261
4985
|
}[];
|
|
4262
4986
|
}[];
|
|
4263
4987
|
additionalAssets?: {
|
|
@@ -4268,9 +4992,15 @@ declare class VaultsSdk {
|
|
|
4268
4992
|
decimals: number;
|
|
4269
4993
|
assetLogo?: string;
|
|
4270
4994
|
assetPriceInUsd?: string;
|
|
4995
|
+
assetGroup: string;
|
|
4271
4996
|
}[];
|
|
4997
|
+
transactionalProperties?: {
|
|
4998
|
+
depositStepsType: "instant" | "complex";
|
|
4999
|
+
redeemStepsType: "instant" | "complex";
|
|
5000
|
+
rewardsSupported: boolean;
|
|
5001
|
+
};
|
|
4272
5002
|
}>;
|
|
4273
|
-
getIdleAssets(params:
|
|
5003
|
+
getIdleAssets(params: Params<'/v2/portfolio/idle-assets/{userAddress}'>): Promise<{
|
|
4274
5004
|
data: {
|
|
4275
5005
|
address: string;
|
|
4276
5006
|
assetCaip: string;
|
|
@@ -4279,10 +5009,11 @@ declare class VaultsSdk {
|
|
|
4279
5009
|
decimals: number;
|
|
4280
5010
|
assetLogo?: string;
|
|
4281
5011
|
assetPriceInUsd?: string;
|
|
5012
|
+
assetGroup: string;
|
|
4282
5013
|
balanceNative: string;
|
|
4283
5014
|
balanceUsd: string;
|
|
4284
5015
|
network: {
|
|
4285
|
-
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain";
|
|
5016
|
+
name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4286
5017
|
chainId: number;
|
|
4287
5018
|
networkCaip: string;
|
|
4288
5019
|
};
|
|
@@ -4292,18 +5023,18 @@ declare class VaultsSdk {
|
|
|
4292
5023
|
unsupportedAssets: string[];
|
|
4293
5024
|
};
|
|
4294
5025
|
}>;
|
|
4295
|
-
getTransactionsContext(params:
|
|
4296
|
-
currentDepositStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5026
|
+
getTransactionsContext(params: Params<'/v2/transactions/context/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
5027
|
+
currentDepositStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4297
5028
|
depositSteps: {
|
|
4298
5029
|
actions: string[];
|
|
4299
5030
|
actionsUrl: string;
|
|
4300
|
-
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5031
|
+
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4301
5032
|
}[];
|
|
4302
|
-
currentRedeemStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5033
|
+
currentRedeemStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4303
5034
|
redeemSteps: {
|
|
4304
5035
|
actions: string[];
|
|
4305
5036
|
actionsUrl: string;
|
|
4306
|
-
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5037
|
+
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4307
5038
|
}[];
|
|
4308
5039
|
lpToken: {
|
|
4309
5040
|
address: string;
|
|
@@ -4322,6 +5053,7 @@ declare class VaultsSdk {
|
|
|
4322
5053
|
decimals: number;
|
|
4323
5054
|
assetLogo?: string;
|
|
4324
5055
|
assetPriceInUsd?: string;
|
|
5056
|
+
assetGroup: string;
|
|
4325
5057
|
balanceNative: string;
|
|
4326
5058
|
balanceUsd: string;
|
|
4327
5059
|
unclaimedNative?: string;
|
|
@@ -4336,6 +5068,7 @@ declare class VaultsSdk {
|
|
|
4336
5068
|
decimals: number;
|
|
4337
5069
|
assetLogo?: string;
|
|
4338
5070
|
assetPriceInUsd?: string;
|
|
5071
|
+
assetGroup: string;
|
|
4339
5072
|
balanceNative: string;
|
|
4340
5073
|
balanceUsd: string;
|
|
4341
5074
|
unclaimedNative?: string;
|
|
@@ -4361,6 +5094,7 @@ declare class VaultsSdk {
|
|
|
4361
5094
|
decimals: number;
|
|
4362
5095
|
assetLogo?: string;
|
|
4363
5096
|
assetPriceInUsd?: string;
|
|
5097
|
+
assetGroup: string;
|
|
4364
5098
|
balanceNative: string;
|
|
4365
5099
|
balanceUsd: string;
|
|
4366
5100
|
unclaimedNative?: string;
|
|
@@ -4375,6 +5109,7 @@ declare class VaultsSdk {
|
|
|
4375
5109
|
decimals: number;
|
|
4376
5110
|
assetLogo?: string;
|
|
4377
5111
|
assetPriceInUsd?: string;
|
|
5112
|
+
assetGroup: string;
|
|
4378
5113
|
balanceNative: string;
|
|
4379
5114
|
balanceUsd: string;
|
|
4380
5115
|
unclaimedNative?: string;
|
|
@@ -4394,18 +5129,19 @@ declare class VaultsSdk {
|
|
|
4394
5129
|
decimals: number;
|
|
4395
5130
|
assetLogo?: string;
|
|
4396
5131
|
assetPriceInUsd?: string;
|
|
4397
|
-
|
|
5132
|
+
assetGroup: string;
|
|
5133
|
+
network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
|
|
4398
5134
|
};
|
|
4399
5135
|
}[];
|
|
4400
|
-
currentStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5136
|
+
currentStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4401
5137
|
steps: {
|
|
4402
5138
|
actions: string[];
|
|
4403
5139
|
actionsUrl: string;
|
|
4404
|
-
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
|
|
5140
|
+
name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
|
|
4405
5141
|
}[];
|
|
4406
5142
|
};
|
|
4407
5143
|
}>;
|
|
4408
|
-
getActions(params:
|
|
5144
|
+
getActions(params: Params<'/v2/transactions/{action}/{userAddress}/{network}/{vaultAddress}'>): Promise<{
|
|
4409
5145
|
currentActionIndex: number;
|
|
4410
5146
|
actions: {
|
|
4411
5147
|
name: string;
|