@vaultsfyi/sdk 2.0.0 → 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.
Files changed (7) hide show
  1. package/dist/client.d.mts +220 -375
  2. package/dist/client.d.ts +220 -375
  3. package/dist/client.js +3 -14
  4. package/dist/client.js.map +1 -1
  5. package/dist/client.mjs +3 -14
  6. package/dist/client.mjs.map +1 -1
  7. package/package.json +1 -1
package/dist/client.d.mts CHANGED
@@ -85,7 +85,7 @@ interface paths {
85
85
  /** @description Number of items per page */
86
86
  perPage?: number;
87
87
  /** @description Include only vaults with provided network(name or CAIP) */
88
- network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
89
89
  /** @description Include only vaults with an asset of provided symbol(ticker) */
90
90
  assetSymbol?: string;
91
91
  /** @description Include only vaults that are supported in the transactional interface. */
@@ -119,7 +119,7 @@ interface paths {
119
119
  * @description Name of the network
120
120
  * @enum {string}
121
121
  */
122
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
122
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
123
123
  /** @description Chain ID of the network */
124
124
  chainId: number;
125
125
  /** @description CAIP-2 of the network */
@@ -144,6 +144,8 @@ interface paths {
144
144
  assetLogo?: string;
145
145
  /** @description Price of the asset in USD */
146
146
  assetPriceInUsd?: string;
147
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
148
+ assetGroup: string;
147
149
  };
148
150
  /** @description Indicates if the vault supports transactional endpoints */
149
151
  isTransactional: boolean;
@@ -252,7 +254,7 @@ interface paths {
252
254
  /** @description Number of items per page */
253
255
  perPage?: number;
254
256
  /** @description Include only vaults with provided network(name or CAIP) */
255
- network?: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
256
258
  };
257
259
  header?: never;
258
260
  path?: never;
@@ -289,13 +291,15 @@ interface paths {
289
291
  assetLogo?: string;
290
292
  /** @description Price of the asset in USD */
291
293
  assetPriceInUsd?: string;
294
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
295
+ assetGroup: string;
292
296
  /** @description Network details of the asset */
293
297
  network: {
294
298
  /**
295
299
  * @description Name of the network
296
300
  * @enum {string}
297
301
  */
298
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
302
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
299
303
  /** @description Chain ID of the network */
300
304
  chainId: number;
301
305
  /** @description CAIP-2 of the network */
@@ -525,7 +529,7 @@ interface paths {
525
529
  * @description Name of the network
526
530
  * @enum {string}
527
531
  */
528
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
532
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
529
533
  /** @description Chain ID of the network */
530
534
  chainId: number;
531
535
  /** @description CAIP-2 of the network */
@@ -643,7 +647,7 @@ interface paths {
643
647
  header?: never;
644
648
  path: {
645
649
  /** @description Include only vaults with provided network(name or CAIP) */
646
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
647
651
  /** @description Address of the vault for which the data will be returned */
648
652
  vaultAddress: string;
649
653
  };
@@ -797,7 +801,7 @@ interface paths {
797
801
  header?: never;
798
802
  path: {
799
803
  /** @description Include only vaults with provided network(name or CAIP) */
800
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
801
805
  /** @description Address of the vault for which the data will be returned */
802
806
  vaultAddress: string;
803
807
  };
@@ -944,7 +948,7 @@ interface paths {
944
948
  header?: never;
945
949
  path: {
946
950
  /** @description Include only vaults with provided network(name or CAIP) */
947
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
948
952
  /** @description Address of the vault for which the data will be returned */
949
953
  vaultAddress: string;
950
954
  };
@@ -1078,13 +1082,13 @@ interface paths {
1078
1082
  /** @description Number of items per page */
1079
1083
  perPage?: number;
1080
1084
  /** @description Assets to be included by symbol(ticker). */
1081
- allowedAssets?: string[];
1085
+ allowedAssets?: string[] | string;
1082
1086
  /** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
1083
- disallowedAssets?: string[];
1087
+ disallowedAssets?: string[] | string;
1084
1088
  /** @description Protocols to be included by name. */
1085
- allowedProtocols?: string[];
1089
+ allowedProtocols?: string[] | string;
1086
1090
  /** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
1087
- disallowedProtocols?: string[];
1091
+ disallowedProtocols?: string[] | string;
1088
1092
  /** @description Minimum TVL in USD of the vaults to be included */
1089
1093
  minTvl?: number;
1090
1094
  /** @description Include only vaults that are supported in the transactional interface. */
@@ -1092,13 +1096,15 @@ interface paths {
1092
1096
  /** @description Include only vaults that are featured in app.vaults.fyi */
1093
1097
  onlyAppFeatured?: boolean;
1094
1098
  /** @description Networks to be included (name or CAIP). */
1095
- allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
1096
1100
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
1097
- disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
1098
1102
  /** @description Maximum TVL in USD of the vaults to be included */
1099
1103
  maxTvl?: number;
1104
+ /** @description Maximum APY (in decimal) of the vaults to be included */
1105
+ maxApy?: number;
1100
1106
  /** @description Tags to be included. */
1101
- tags?: string[];
1107
+ tags?: string[] | string;
1102
1108
  };
1103
1109
  header?: never;
1104
1110
  path?: never;
@@ -1126,7 +1132,7 @@ interface paths {
1126
1132
  * @description Name of the network
1127
1133
  * @enum {string}
1128
1134
  */
1129
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
1135
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
1130
1136
  /** @description Chain ID of the network */
1131
1137
  chainId: number;
1132
1138
  /** @description CAIP-2 of the network */
@@ -1151,6 +1157,8 @@ interface paths {
1151
1157
  assetLogo?: string;
1152
1158
  /** @description Price of the asset in USD */
1153
1159
  assetPriceInUsd?: string;
1160
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1161
+ assetGroup: string;
1154
1162
  };
1155
1163
  /** @description Indicates if the vault supports transactional endpoints */
1156
1164
  isTransactional: boolean;
@@ -1252,6 +1260,8 @@ interface paths {
1252
1260
  assetLogo?: string;
1253
1261
  /** @description Price of the asset in USD */
1254
1262
  assetPriceInUsd?: string;
1263
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1264
+ assetGroup: string;
1255
1265
  };
1256
1266
  apy: {
1257
1267
  /** @description 1day APY of the reward asset */
@@ -1315,6 +1325,8 @@ interface paths {
1315
1325
  assetLogo?: string;
1316
1326
  /** @description Price of the asset in USD */
1317
1327
  assetPriceInUsd?: string;
1328
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1329
+ assetGroup: string;
1318
1330
  };
1319
1331
  /** @description LP token details of the child vault */
1320
1332
  lpToken?: {
@@ -1348,6 +1360,8 @@ interface paths {
1348
1360
  assetLogo?: string;
1349
1361
  /** @description Price of the asset in USD */
1350
1362
  assetPriceInUsd?: string;
1363
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1364
+ assetGroup: string;
1351
1365
  }[];
1352
1366
  }[];
1353
1367
  /** @description Additional assets of the vault */
@@ -1369,7 +1383,24 @@ interface paths {
1369
1383
  assetLogo?: string;
1370
1384
  /** @description Price of the asset in USD */
1371
1385
  assetPriceInUsd?: string;
1386
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1387
+ assetGroup: string;
1372
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
+ };
1373
1404
  }[];
1374
1405
  errors: {
1375
1406
  unsupportedNetworks: string[];
@@ -1476,7 +1507,7 @@ interface paths {
1476
1507
  header?: never;
1477
1508
  path: {
1478
1509
  /** @description Include only vaults with provided network(name or CAIP) */
1479
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
1480
1511
  /** @description Address of the vault for which the data will be returned */
1481
1512
  vaultAddress: string;
1482
1513
  };
@@ -1499,7 +1530,7 @@ interface paths {
1499
1530
  * @description Name of the network
1500
1531
  * @enum {string}
1501
1532
  */
1502
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
1533
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
1503
1534
  /** @description Chain ID of the network */
1504
1535
  chainId: number;
1505
1536
  /** @description CAIP-2 of the network */
@@ -1524,6 +1555,8 @@ interface paths {
1524
1555
  assetLogo?: string;
1525
1556
  /** @description Price of the asset in USD */
1526
1557
  assetPriceInUsd?: string;
1558
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1559
+ assetGroup: string;
1527
1560
  };
1528
1561
  /** @description Indicates if the vault supports transactional endpoints */
1529
1562
  isTransactional: boolean;
@@ -1625,6 +1658,8 @@ interface paths {
1625
1658
  assetLogo?: string;
1626
1659
  /** @description Price of the asset in USD */
1627
1660
  assetPriceInUsd?: string;
1661
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1662
+ assetGroup: string;
1628
1663
  };
1629
1664
  apy: {
1630
1665
  /** @description 1day APY of the reward asset */
@@ -1688,6 +1723,8 @@ interface paths {
1688
1723
  assetLogo?: string;
1689
1724
  /** @description Price of the asset in USD */
1690
1725
  assetPriceInUsd?: string;
1726
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1727
+ assetGroup: string;
1691
1728
  };
1692
1729
  /** @description LP token details of the child vault */
1693
1730
  lpToken?: {
@@ -1721,6 +1758,8 @@ interface paths {
1721
1758
  assetLogo?: string;
1722
1759
  /** @description Price of the asset in USD */
1723
1760
  assetPriceInUsd?: string;
1761
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1762
+ assetGroup: string;
1724
1763
  }[];
1725
1764
  }[];
1726
1765
  /** @description Additional assets of the vault */
@@ -1742,7 +1781,24 @@ interface paths {
1742
1781
  assetLogo?: string;
1743
1782
  /** @description Price of the asset in USD */
1744
1783
  assetPriceInUsd?: string;
1784
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
1785
+ assetGroup: string;
1745
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
+ };
1746
1802
  };
1747
1803
  };
1748
1804
  };
@@ -1843,7 +1899,7 @@ interface paths {
1843
1899
  header?: never;
1844
1900
  path: {
1845
1901
  /** @description Include only vaults with provided network(name or CAIP) */
1846
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
1847
1903
  /** @description Address of the vault for which the data will be returned */
1848
1904
  vaultAddress: string;
1849
1905
  };
@@ -1985,7 +2041,7 @@ interface paths {
1985
2041
  header?: never;
1986
2042
  path: {
1987
2043
  /** @description Include only vaults with provided network(name or CAIP) */
1988
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
1989
2045
  /** @description Address of the vault for which the data will be returned */
1990
2046
  vaultAddress: string;
1991
2047
  };
@@ -2102,13 +2158,13 @@ interface paths {
2102
2158
  parameters: {
2103
2159
  query?: {
2104
2160
  /** @description Assets to be included by symbol(ticker). */
2105
- allowedAssets?: string[];
2161
+ allowedAssets?: string[] | string;
2106
2162
  /** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
2107
- disallowedAssets?: string[];
2163
+ disallowedAssets?: string[] | string;
2108
2164
  /** @description Protocols to be included by name. */
2109
- allowedProtocols?: string[];
2165
+ allowedProtocols?: string[] | string;
2110
2166
  /** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
2111
- disallowedProtocols?: string[];
2167
+ disallowedProtocols?: string[] | string;
2112
2168
  /** @description Minimum TVL in USD of the vaults to be included */
2113
2169
  minTvl?: number;
2114
2170
  /** @description Include only vaults that are supported in the transactional interface. */
@@ -2116,9 +2172,9 @@ interface paths {
2116
2172
  /** @description Include only vaults that are featured in app.vaults.fyi */
2117
2173
  onlyAppFeatured?: boolean;
2118
2174
  /** @description Networks to be included (name or CAIP). */
2119
- allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
2120
2176
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
2121
- disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
2122
2178
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
2123
2179
  apyInterval?: '1day' | '7day' | '30day';
2124
2180
  /** @description Minimum APY of the vault to be included */
@@ -2163,6 +2219,8 @@ interface paths {
2163
2219
  assetLogo?: string;
2164
2220
  /** @description Price of the asset in USD */
2165
2221
  assetPriceInUsd?: string;
2222
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2223
+ assetGroup: string;
2166
2224
  /** @description Balance of the asset */
2167
2225
  balanceNative: string;
2168
2226
  /** @description USD value of the asset */
@@ -2180,7 +2238,7 @@ interface paths {
2180
2238
  * @description Name of the network
2181
2239
  * @enum {string}
2182
2240
  */
2183
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
2241
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
2184
2242
  /** @description Chain ID of the network */
2185
2243
  chainId: number;
2186
2244
  /** @description CAIP-2 of the network */
@@ -2333,13 +2391,13 @@ interface paths {
2333
2391
  parameters: {
2334
2392
  query?: {
2335
2393
  /** @description Assets to be included by symbol(ticker). */
2336
- allowedAssets?: string[];
2394
+ allowedAssets?: string[] | string;
2337
2395
  /** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
2338
- disallowedAssets?: string[];
2396
+ disallowedAssets?: string[] | string;
2339
2397
  /** @description Protocols to be included by name. */
2340
- allowedProtocols?: string[];
2398
+ allowedProtocols?: string[] | string;
2341
2399
  /** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
2342
- disallowedProtocols?: string[];
2400
+ disallowedProtocols?: string[] | string;
2343
2401
  /** @description Minimum TVL in USD of the vaults to be included */
2344
2402
  minTvl?: number;
2345
2403
  /** @description Include only vaults that are supported in the transactional interface. */
@@ -2347,13 +2405,15 @@ interface paths {
2347
2405
  /** @description Include only vaults that are featured in app.vaults.fyi */
2348
2406
  onlyAppFeatured?: boolean;
2349
2407
  /** @description Networks to be included (name or CAIP). */
2350
- allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
2351
2409
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
2352
- disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
2353
2411
  /** @description Maximum TVL in USD of the vaults to be included */
2354
2412
  maxTvl?: number;
2413
+ /** @description Maximum APY (in decimal) of the vaults to be included */
2414
+ maxApy?: number;
2355
2415
  /** @description Tags to be included. */
2356
- tags?: string[];
2416
+ tags?: string[] | string;
2357
2417
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
2358
2418
  apyInterval?: '1day' | '7day' | '30day';
2359
2419
  /** @description Minimum USD value of the vault to be included */
@@ -2384,7 +2444,7 @@ interface paths {
2384
2444
  * @description Name of the network
2385
2445
  * @enum {string}
2386
2446
  */
2387
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
2447
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
2388
2448
  /** @description Chain ID of the network */
2389
2449
  chainId: number;
2390
2450
  /** @description CAIP-2 of the network */
@@ -2409,6 +2469,8 @@ interface paths {
2409
2469
  assetLogo?: string;
2410
2470
  /** @description Price of the asset in USD */
2411
2471
  assetPriceInUsd?: string;
2472
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2473
+ assetGroup: string;
2412
2474
  /** @description Balance of the asset denominated in asset wei */
2413
2475
  balanceNative: string;
2414
2476
  /** @description Balance of the asset denominated in usd */
@@ -2469,6 +2531,8 @@ interface paths {
2469
2531
  assetLogo?: string;
2470
2532
  /** @description Price of the asset in USD */
2471
2533
  assetPriceInUsd?: string;
2534
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2535
+ assetGroup: string;
2472
2536
  /** @description Balance of the asset denominated in asset wei */
2473
2537
  balanceNative: string;
2474
2538
  /** @description Balance of the asset denominated in usd */
@@ -2528,6 +2592,8 @@ interface paths {
2528
2592
  assetLogo?: string;
2529
2593
  /** @description Price of the asset in USD */
2530
2594
  assetPriceInUsd?: string;
2595
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2596
+ assetGroup: string;
2531
2597
  /** @description Balance of the asset denominated in asset wei */
2532
2598
  balanceNative: string;
2533
2599
  /** @description Balance of the asset denominated in usd */
@@ -2583,6 +2649,8 @@ interface paths {
2583
2649
  assetLogo?: string;
2584
2650
  /** @description Price of the asset in USD */
2585
2651
  assetPriceInUsd?: string;
2652
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2653
+ assetGroup: string;
2586
2654
  /** @description Balance of the asset denominated in asset wei */
2587
2655
  balanceNative: string;
2588
2656
  /** @description Balance of the asset denominated in usd */
@@ -2706,7 +2774,7 @@ interface paths {
2706
2774
  /** @description User address to be used for best vault calculation */
2707
2775
  userAddress: string;
2708
2776
  /** @description Include only vaults with provided network(name or CAIP) */
2709
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
2710
2778
  /** @description Address of the vault for which the data will be returned */
2711
2779
  vaultAddress: string;
2712
2780
  };
@@ -2729,7 +2797,7 @@ interface paths {
2729
2797
  * @description Name of the network
2730
2798
  * @enum {string}
2731
2799
  */
2732
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
2800
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
2733
2801
  /** @description Chain ID of the network */
2734
2802
  chainId: number;
2735
2803
  /** @description CAIP-2 of the network */
@@ -2754,6 +2822,8 @@ interface paths {
2754
2822
  assetLogo?: string;
2755
2823
  /** @description Price of the asset in USD */
2756
2824
  assetPriceInUsd?: string;
2825
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2826
+ assetGroup: string;
2757
2827
  /** @description Balance of the asset denominated in asset wei */
2758
2828
  balanceNative: string;
2759
2829
  /** @description Balance of the asset denominated in usd */
@@ -2814,6 +2884,8 @@ interface paths {
2814
2884
  assetLogo?: string;
2815
2885
  /** @description Price of the asset in USD */
2816
2886
  assetPriceInUsd?: string;
2887
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2888
+ assetGroup: string;
2817
2889
  /** @description Balance of the asset denominated in asset wei */
2818
2890
  balanceNative: string;
2819
2891
  /** @description Balance of the asset denominated in usd */
@@ -2873,6 +2945,8 @@ interface paths {
2873
2945
  assetLogo?: string;
2874
2946
  /** @description Price of the asset in USD */
2875
2947
  assetPriceInUsd?: string;
2948
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
2949
+ assetGroup: string;
2876
2950
  /** @description Balance of the asset denominated in asset wei */
2877
2951
  balanceNative: string;
2878
2952
  /** @description Balance of the asset denominated in usd */
@@ -2928,6 +3002,8 @@ interface paths {
2928
3002
  assetLogo?: string;
2929
3003
  /** @description Price of the asset in USD */
2930
3004
  assetPriceInUsd?: string;
3005
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3006
+ assetGroup: string;
2931
3007
  /** @description Balance of the asset denominated in asset wei */
2932
3008
  balanceNative: string;
2933
3009
  /** @description Balance of the asset denominated in usd */
@@ -3038,13 +3114,13 @@ interface paths {
3038
3114
  parameters: {
3039
3115
  query?: {
3040
3116
  /** @description Assets to be included by symbol(ticker). */
3041
- allowedAssets?: string[];
3117
+ allowedAssets?: string[] | string;
3042
3118
  /** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
3043
- disallowedAssets?: string[];
3119
+ disallowedAssets?: string[] | string;
3044
3120
  /** @description Protocols to be included by name. */
3045
- allowedProtocols?: string[];
3121
+ allowedProtocols?: string[] | string;
3046
3122
  /** @description Protocols to be excluded by name. The parameter is ignored if "allowedProtocols" is specified. */
3047
- disallowedProtocols?: string[];
3123
+ disallowedProtocols?: string[] | string;
3048
3124
  /** @description Minimum TVL in USD of the vaults to be included */
3049
3125
  minTvl?: number;
3050
3126
  /** @description Include only vaults that are supported in the transactional interface. */
@@ -3052,9 +3128,9 @@ interface paths {
3052
3128
  /** @description Include only vaults that are featured in app.vaults.fyi */
3053
3129
  onlyAppFeatured?: boolean;
3054
3130
  /** @description Networks to be included (name or CAIP). */
3055
- allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
3056
3132
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
3057
- disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
3058
3134
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
3059
3135
  apyInterval?: '1day' | '7day' | '30day';
3060
3136
  /** @description Minimum APY of the vault to be included */
@@ -3062,7 +3138,7 @@ interface paths {
3062
3138
  /** @description Minimum USD value of the vault to be included */
3063
3139
  minUsdAssetValueThreshold?: number;
3064
3140
  /** @description Assets to always be included in the response. */
3065
- alwaysReturnAssets?: string[];
3141
+ alwaysReturnAssets?: string[] | string;
3066
3142
  /** @description Maximum number of vaults to be included per asset. */
3067
3143
  maxVaultsPerAsset?: number;
3068
3144
  };
@@ -3105,6 +3181,8 @@ interface paths {
3105
3181
  assetLogo?: string;
3106
3182
  /** @description Price of the asset in USD */
3107
3183
  assetPriceInUsd?: string;
3184
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3185
+ assetGroup: string;
3108
3186
  /** @description Balance of the asset */
3109
3187
  balanceNative: string;
3110
3188
  /** @description USD value of the asset */
@@ -3121,7 +3199,7 @@ interface paths {
3121
3199
  * @description Name of the network
3122
3200
  * @enum {string}
3123
3201
  */
3124
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
3202
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
3125
3203
  /** @description Chain ID of the network */
3126
3204
  chainId: number;
3127
3205
  /** @description CAIP-2 of the network */
@@ -3263,128 +3341,6 @@ interface paths {
3263
3341
  patch?: never;
3264
3342
  trace?: never;
3265
3343
  };
3266
- '/v2/portfolio/returns/{userAddress}/{network}/{vaultAddress}': {
3267
- parameters: {
3268
- query?: never;
3269
- header?: never;
3270
- path?: never;
3271
- cookie?: never;
3272
- };
3273
- /** @description Retrieves the cumulative investment returns for a user's position in a specific vault, showing total yield earned in both native token amount and USD value.
3274
- * Supported networks: arbitrum, base, mainnet, optimism, polygon, gnosis, celo, swellchain, unichain */
3275
- get: {
3276
- parameters: {
3277
- query?: never;
3278
- header?: never;
3279
- path: {
3280
- /** @description User address to get returns for */
3281
- userAddress: string;
3282
- /** @description Network to get returns for */
3283
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
3284
- /** @description Vault address to get returns for */
3285
- vaultAddress: string;
3286
- };
3287
- cookie?: never;
3288
- };
3289
- requestBody?: never;
3290
- responses: {
3291
- /** @description Default Response */
3292
- 200: {
3293
- headers: {
3294
- [name: string]: unknown;
3295
- };
3296
- content: {
3297
- 'application/json': {
3298
- /** @description TVL in USD */
3299
- usd: string;
3300
- /** @description Native TVL */
3301
- native: string;
3302
- };
3303
- };
3304
- };
3305
- /** @description Default Response */
3306
- 400: {
3307
- headers: {
3308
- [name: string]: unknown;
3309
- };
3310
- content: {
3311
- 'application/json': {
3312
- statusCode: number;
3313
- /** @enum {string} */
3314
- error: 'Bad Request';
3315
- message: string;
3316
- errorId?: string;
3317
- } | unknown;
3318
- };
3319
- };
3320
- /** @description Default Response */
3321
- 401: {
3322
- headers: {
3323
- [name: string]: unknown;
3324
- };
3325
- content: {
3326
- 'application/json': {
3327
- /** @enum {string} */
3328
- error: 'Unauthorized';
3329
- /** @enum {string} */
3330
- message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
3331
- errorId?: string;
3332
- } | unknown;
3333
- };
3334
- };
3335
- /** @description Default Response */
3336
- 403: {
3337
- headers: {
3338
- [name: string]: unknown;
3339
- };
3340
- content: {
3341
- 'application/json': {
3342
- /** @enum {string} */
3343
- error: 'Forbidden';
3344
- /** @enum {string} */
3345
- message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
3346
- errorId?: string;
3347
- } | unknown;
3348
- };
3349
- };
3350
- /** @description Default Response */
3351
- 500: {
3352
- headers: {
3353
- [name: string]: unknown;
3354
- };
3355
- content: {
3356
- 'application/json': {
3357
- /** @enum {string} */
3358
- error: 'Internal Server Error';
3359
- message: string;
3360
- errorId?: string;
3361
- } | unknown;
3362
- };
3363
- };
3364
- /** @description Default Response */
3365
- 503: {
3366
- headers: {
3367
- [name: string]: unknown;
3368
- };
3369
- content: {
3370
- 'application/json': {
3371
- /** @enum {string} */
3372
- error: 'Service Unavailable';
3373
- message: string;
3374
- errorId?: string;
3375
- } | unknown;
3376
- };
3377
- };
3378
- };
3379
- };
3380
- put?: never;
3381
- post?: never;
3382
- delete?: never;
3383
- options?: never;
3384
- head?: never;
3385
- patch?: never;
3386
- trace?: never;
3387
- };
3388
3344
  '/v2/portfolio/idle-assets/{userAddress}': {
3389
3345
  parameters: {
3390
3346
  query?: never;
@@ -3397,15 +3353,15 @@ interface paths {
3397
3353
  parameters: {
3398
3354
  query?: {
3399
3355
  /** @description Assets to be included by symbol(ticker). */
3400
- allowedAssets?: string[];
3356
+ allowedAssets?: string[] | string;
3401
3357
  /** @description Assets to be excluded by symbol(ticker). The parameter is ignored if "allowedAssets" is specified. */
3402
- disallowedAssets?: string[];
3358
+ disallowedAssets?: string[] | string;
3403
3359
  /** @description Minimum USD value of the asset to be included */
3404
3360
  minUsdAssetValueThreshold?: number;
3405
3361
  /** @description Networks to be included (name or CAIP). */
3406
- allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
3407
3363
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
3408
- disallowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073')[];
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');
3409
3365
  };
3410
3366
  header?: never;
3411
3367
  path: {
@@ -3441,6 +3397,8 @@ interface paths {
3441
3397
  assetLogo?: string;
3442
3398
  /** @description Price of the asset in USD */
3443
3399
  assetPriceInUsd?: string;
3400
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3401
+ assetGroup: string;
3444
3402
  /** @description Balance of the asset */
3445
3403
  balanceNative: string;
3446
3404
  /** @description USD value of the asset */
@@ -3451,7 +3409,7 @@ interface paths {
3451
3409
  * @description Name of the network
3452
3410
  * @enum {string}
3453
3411
  */
3454
- name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
3412
+ name: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
3455
3413
  /** @description Chain ID of the network */
3456
3414
  chainId: number;
3457
3415
  /** @description CAIP-2 of the network */
@@ -3548,162 +3506,6 @@ interface paths {
3548
3506
  patch?: never;
3549
3507
  trace?: never;
3550
3508
  };
3551
- '/v2/portfolio/events/{userAddress}/{network}/{vaultAddress}': {
3552
- parameters: {
3553
- query?: never;
3554
- header?: never;
3555
- path?: never;
3556
- cookie?: never;
3557
- };
3558
- /** @description Retrieves chronological event history for a user's interactions with a specific vault, including deposits, withdrawals, and transfers with timestamp and block number information.
3559
- * Supported networks: arbitrum, base, mainnet, optimism, polygon, gnosis, celo, swellchain, unichain */
3560
- get: {
3561
- parameters: {
3562
- query?: {
3563
- /** @description Page number (starting from 0) */
3564
- page?: number;
3565
- /** @description Number of items per page */
3566
- perPage?: number;
3567
- /** @description Timestamp for the start of the time period for which data will be fetched */
3568
- fromTimestamp?: number;
3569
- /** @description Timestamp for the end of the time period for which data will be fetched */
3570
- toTimestamp?: number;
3571
- };
3572
- header?: never;
3573
- path: {
3574
- /** @description User address to get returns for */
3575
- userAddress: string;
3576
- /** @description Network to get returns for */
3577
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
3578
- /** @description Vault address to get returns for */
3579
- vaultAddress: string;
3580
- };
3581
- cookie?: never;
3582
- };
3583
- requestBody?: never;
3584
- responses: {
3585
- /** @description Portfolio events for a user, paginated by timestamp */
3586
- 200: {
3587
- headers: {
3588
- [name: string]: unknown;
3589
- };
3590
- content: {
3591
- 'application/json': {
3592
- /** @description Number of items on the current page */
3593
- itemsOnPage: number;
3594
- /** @description Next page number */
3595
- nextPage?: number;
3596
- data: {
3597
- /** @description Timestamp of the event */
3598
- timestamp: number;
3599
- /** @description Block number of the event */
3600
- blockNumber: string;
3601
- /**
3602
- * @description Type of the event
3603
- * @enum {string}
3604
- */
3605
- eventType: 'Deposit' | 'Withdrawal' | 'Transfer';
3606
- /** @description Asset amount involved in the event */
3607
- eventAssetAmount: {
3608
- /** @description USD value of the asset amount */
3609
- usd: string;
3610
- /** @description Native value of the asset amount */
3611
- native: string;
3612
- };
3613
- /** @description Resulting position after the event */
3614
- resultingPosition: {
3615
- /** @description USD value of the resulting position */
3616
- usd: string;
3617
- /** @description Native value of the resulting position */
3618
- native: string;
3619
- };
3620
- }[];
3621
- };
3622
- };
3623
- };
3624
- /** @description Default Response */
3625
- 400: {
3626
- headers: {
3627
- [name: string]: unknown;
3628
- };
3629
- content: {
3630
- 'application/json': {
3631
- statusCode: number;
3632
- /** @enum {string} */
3633
- error: 'Bad Request';
3634
- message: string;
3635
- errorId?: string;
3636
- } | unknown;
3637
- };
3638
- };
3639
- /** @description Default Response */
3640
- 401: {
3641
- headers: {
3642
- [name: string]: unknown;
3643
- };
3644
- content: {
3645
- 'application/json': {
3646
- /** @enum {string} */
3647
- error: 'Unauthorized';
3648
- /** @enum {string} */
3649
- message: 'API key required. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.' | 'This endpoint is only available to vaults.fyi PRO subscribers. Please upgrade your API key to access this feature.';
3650
- errorId?: string;
3651
- } | unknown;
3652
- };
3653
- };
3654
- /** @description Default Response */
3655
- 403: {
3656
- headers: {
3657
- [name: string]: unknown;
3658
- };
3659
- content: {
3660
- 'application/json': {
3661
- /** @enum {string} */
3662
- error: 'Forbidden';
3663
- /** @enum {string} */
3664
- message: 'The provided API key has exhausted its available credits. Please contact vaults.fyi support at https://t.me/vaultsfyisupport or email (support@wallfacer.io) for further assistance.';
3665
- errorId?: string;
3666
- } | unknown;
3667
- };
3668
- };
3669
- /** @description Default Response */
3670
- 500: {
3671
- headers: {
3672
- [name: string]: unknown;
3673
- };
3674
- content: {
3675
- 'application/json': {
3676
- /** @enum {string} */
3677
- error: 'Internal Server Error';
3678
- message: string;
3679
- errorId?: string;
3680
- } | unknown;
3681
- };
3682
- };
3683
- /** @description Default Response */
3684
- 503: {
3685
- headers: {
3686
- [name: string]: unknown;
3687
- };
3688
- content: {
3689
- 'application/json': {
3690
- /** @enum {string} */
3691
- error: 'Service Unavailable';
3692
- message: string;
3693
- errorId?: string;
3694
- } | unknown;
3695
- };
3696
- };
3697
- };
3698
- };
3699
- put?: never;
3700
- post?: never;
3701
- delete?: never;
3702
- options?: never;
3703
- head?: never;
3704
- patch?: never;
3705
- trace?: never;
3706
- };
3707
3509
  '/v2/transactions/context/{userAddress}/{network}/{vaultAddress}': {
3708
3510
  parameters: {
3709
3511
  query?: never;
@@ -3719,8 +3521,8 @@ interface paths {
3719
3521
  path: {
3720
3522
  /** @description User address */
3721
3523
  userAddress: string;
3722
- /** @description Network name */
3723
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
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';
3724
3526
  /** @description Vault address */
3725
3527
  vaultAddress: string;
3726
3528
  };
@@ -3739,25 +3541,25 @@ interface paths {
3739
3541
  * @description Current deposit step
3740
3542
  * @enum {string}
3741
3543
  */
3742
- currentDepositStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3544
+ currentDepositStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3743
3545
  /** @description Deposit steps */
3744
3546
  depositSteps: {
3745
3547
  actions: string[];
3746
3548
  actionsUrl: string;
3747
3549
  /** @enum {string} */
3748
- name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3550
+ name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3749
3551
  }[];
3750
3552
  /**
3751
3553
  * @description Current redeem step
3752
3554
  * @enum {string}
3753
3555
  */
3754
- currentRedeemStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3556
+ currentRedeemStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3755
3557
  /** @description Redeem steps */
3756
3558
  redeemSteps: {
3757
3559
  actions: string[];
3758
3560
  actionsUrl: string;
3759
3561
  /** @enum {string} */
3760
- name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3562
+ name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3761
3563
  }[];
3762
3564
  /** @description LP token details */
3763
3565
  lpToken: {
@@ -3795,6 +3597,8 @@ interface paths {
3795
3597
  assetLogo?: string;
3796
3598
  /** @description Price of the asset in USD */
3797
3599
  assetPriceInUsd?: string;
3600
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3601
+ assetGroup: string;
3798
3602
  /** @description Balance of the asset denominated in asset wei */
3799
3603
  balanceNative: string;
3800
3604
  /** @description Balance of the asset denominated in usd */
@@ -3825,6 +3629,8 @@ interface paths {
3825
3629
  assetLogo?: string;
3826
3630
  /** @description Price of the asset in USD */
3827
3631
  assetPriceInUsd?: string;
3632
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3633
+ assetGroup: string;
3828
3634
  /** @description Balance of the asset denominated in asset wei */
3829
3635
  balanceNative: string;
3830
3636
  /** @description Balance of the asset denominated in usd */
@@ -3875,6 +3681,8 @@ interface paths {
3875
3681
  assetLogo?: string;
3876
3682
  /** @description Price of the asset in USD */
3877
3683
  assetPriceInUsd?: string;
3684
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3685
+ assetGroup: string;
3878
3686
  /** @description Balance of the asset denominated in asset wei */
3879
3687
  balanceNative: string;
3880
3688
  /** @description Balance of the asset denominated in usd */
@@ -3905,6 +3713,8 @@ interface paths {
3905
3713
  assetLogo?: string;
3906
3714
  /** @description Price of the asset in USD */
3907
3715
  assetPriceInUsd?: string;
3716
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3717
+ assetGroup: string;
3908
3718
  /** @description Balance of the asset denominated in asset wei */
3909
3719
  balanceNative: string;
3910
3720
  /** @description Balance of the asset denominated in usd */
@@ -3941,24 +3751,26 @@ interface paths {
3941
3751
  assetLogo?: string;
3942
3752
  /** @description Price of the asset in USD */
3943
3753
  assetPriceInUsd?: string;
3754
+ /** @description Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER */
3755
+ assetGroup: string;
3944
3756
  /**
3945
3757
  * @description Network of the reward
3946
3758
  * @enum {string}
3947
3759
  */
3948
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink';
3760
+ network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid';
3949
3761
  };
3950
3762
  }[];
3951
3763
  /**
3952
3764
  * @description Current step for claiming rewards
3953
3765
  * @enum {string}
3954
3766
  */
3955
- currentStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3767
+ currentStep: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3956
3768
  /** @description Steps for claiming rewards */
3957
3769
  steps: {
3958
3770
  actions: string[];
3959
3771
  actionsUrl: string;
3960
3772
  /** @enum {string} */
3961
- name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3773
+ name: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
3962
3774
  }[];
3963
3775
  };
3964
3776
  };
@@ -4070,11 +3882,11 @@ interface paths {
4070
3882
  header?: never;
4071
3883
  path: {
4072
3884
  /** @description Action to be performed */
4073
- action: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards';
3885
+ action: 'deposit' | 'redeem' | 'request-redeem' | 'claim-redeem' | 'claim-rewards' | 'start-redeem-cooldown';
4074
3886
  /** @description User address to get returns for */
4075
3887
  userAddress: string;
4076
3888
  /** @description Network to get returns for */
4077
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
4078
3890
  /** @description Vault address to get returns for */
4079
3891
  vaultAddress: string;
4080
3892
  };
@@ -4224,7 +4036,7 @@ interface paths {
4224
4036
  header?: never;
4225
4037
  path: {
4226
4038
  /** @description Network name or CAIP-2 identifier */
4227
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
4228
4040
  };
4229
4041
  cookie?: never;
4230
4042
  };
@@ -4380,7 +4192,7 @@ interface paths {
4380
4192
  header?: never;
4381
4193
  path: {
4382
4194
  /** @description Network name or CAIP-2 identifier */
4383
- network: 'mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'eip155:1' | 'eip155:10' | 'eip155:42161' | 'eip155:137' | 'eip155:100' | 'eip155:8453' | 'eip155:130' | 'eip155:1923' | 'eip155:42220' | 'eip155:480' | 'eip155:80094' | 'eip155:57073';
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';
4384
4196
  };
4385
4197
  cookie?: never;
4386
4198
  };
@@ -4556,6 +4368,25 @@ declare class VaultsSdk {
4556
4368
  constructor(options: ConstructorOptions);
4557
4369
  constructor(options: ConstructorOptions, internalOptions: InternalOptions);
4558
4370
  private fetchData;
4371
+ getAssets(params: Params<'/v2/assets'>): Promise<{
4372
+ itemsOnPage: number;
4373
+ nextPage?: number;
4374
+ data: {
4375
+ address: string;
4376
+ assetCaip: string;
4377
+ name: string;
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;
4387
+ };
4388
+ }[];
4389
+ }>;
4559
4390
  getBenchmarks(params: Params<'/v2/benchmarks/{network}'>): Promise<{
4560
4391
  apy: {
4561
4392
  "1day": {
@@ -4593,15 +4424,11 @@ declare class VaultsSdk {
4593
4424
  };
4594
4425
  }[];
4595
4426
  }>;
4596
- getVaultTotalReturns(params: Params<'/v2/portfolio/returns/{userAddress}/{network}/{vaultAddress}'>): Promise<{
4597
- usd: string;
4598
- native: string;
4599
- }>;
4600
4427
  getPositions(params: Params<'/v2/portfolio/positions/{userAddress}'>): Promise<{
4601
4428
  data: {
4602
4429
  address: string;
4603
4430
  network: {
4604
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
4431
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
4605
4432
  chainId: number;
4606
4433
  networkCaip: string;
4607
4434
  };
@@ -4613,6 +4440,7 @@ declare class VaultsSdk {
4613
4440
  decimals: number;
4614
4441
  assetLogo?: string;
4615
4442
  assetPriceInUsd?: string;
4443
+ assetGroup: string;
4616
4444
  balanceNative: string;
4617
4445
  balanceUsd: string;
4618
4446
  unclaimedNative?: string;
@@ -4643,6 +4471,7 @@ declare class VaultsSdk {
4643
4471
  decimals: number;
4644
4472
  assetLogo?: string;
4645
4473
  assetPriceInUsd?: string;
4474
+ assetGroup: string;
4646
4475
  balanceNative: string;
4647
4476
  balanceUsd: string;
4648
4477
  unclaimedNative?: string;
@@ -4672,6 +4501,7 @@ declare class VaultsSdk {
4672
4501
  decimals: number;
4673
4502
  assetLogo?: string;
4674
4503
  assetPriceInUsd?: string;
4504
+ assetGroup: string;
4675
4505
  balanceNative: string;
4676
4506
  balanceUsd: string;
4677
4507
  unclaimedNative?: string;
@@ -4699,6 +4529,7 @@ declare class VaultsSdk {
4699
4529
  decimals: number;
4700
4530
  assetLogo?: string;
4701
4531
  assetPriceInUsd?: string;
4532
+ assetGroup: string;
4702
4533
  balanceNative: string;
4703
4534
  balanceUsd: string;
4704
4535
  unclaimedNative?: string;
@@ -4716,7 +4547,7 @@ declare class VaultsSdk {
4716
4547
  getPosition(params: Params<'/v2/portfolio/positions/{userAddress}/{network}/{vaultAddress}'>): Promise<{
4717
4548
  address: string;
4718
4549
  network: {
4719
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
4550
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
4720
4551
  chainId: number;
4721
4552
  networkCaip: string;
4722
4553
  };
@@ -4728,6 +4559,7 @@ declare class VaultsSdk {
4728
4559
  decimals: number;
4729
4560
  assetLogo?: string;
4730
4561
  assetPriceInUsd?: string;
4562
+ assetGroup: string;
4731
4563
  balanceNative: string;
4732
4564
  balanceUsd: string;
4733
4565
  unclaimedNative?: string;
@@ -4758,6 +4590,7 @@ declare class VaultsSdk {
4758
4590
  decimals: number;
4759
4591
  assetLogo?: string;
4760
4592
  assetPriceInUsd?: string;
4593
+ assetGroup: string;
4761
4594
  balanceNative: string;
4762
4595
  balanceUsd: string;
4763
4596
  unclaimedNative?: string;
@@ -4787,6 +4620,7 @@ declare class VaultsSdk {
4787
4620
  decimals: number;
4788
4621
  assetLogo?: string;
4789
4622
  assetPriceInUsd?: string;
4623
+ assetGroup: string;
4790
4624
  balanceNative: string;
4791
4625
  balanceUsd: string;
4792
4626
  unclaimedNative?: string;
@@ -4814,6 +4648,7 @@ declare class VaultsSdk {
4814
4648
  decimals: number;
4815
4649
  assetLogo?: string;
4816
4650
  assetPriceInUsd?: string;
4651
+ assetGroup: string;
4817
4652
  balanceNative: string;
4818
4653
  balanceUsd: string;
4819
4654
  unclaimedNative?: string;
@@ -4833,6 +4668,7 @@ declare class VaultsSdk {
4833
4668
  decimals: number;
4834
4669
  assetLogo?: string;
4835
4670
  assetPriceInUsd?: string;
4671
+ assetGroup: string;
4836
4672
  balanceNative: string;
4837
4673
  balanceUsd: string;
4838
4674
  };
@@ -4840,7 +4676,7 @@ declare class VaultsSdk {
4840
4676
  name: string;
4841
4677
  address: string;
4842
4678
  network: {
4843
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
4679
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
4844
4680
  chainId: number;
4845
4681
  networkCaip: string;
4846
4682
  };
@@ -4875,30 +4711,13 @@ declare class VaultsSdk {
4875
4711
  unsupportedProtocols: string[];
4876
4712
  };
4877
4713
  }>;
4878
- getVaultHolderEvents(params: Params<'/v2/portfolio/events/{userAddress}/{network}/{vaultAddress}'>): Promise<{
4879
- itemsOnPage: number;
4880
- nextPage?: number;
4881
- data: {
4882
- timestamp: number;
4883
- blockNumber: string;
4884
- eventType: "Deposit" | "Withdrawal" | "Transfer";
4885
- eventAssetAmount: {
4886
- usd: string;
4887
- native: string;
4888
- };
4889
- resultingPosition: {
4890
- usd: string;
4891
- native: string;
4892
- };
4893
- }[];
4894
- }>;
4895
4714
  getAllVaults(params?: Params<'/v2/detailed-vaults'>): Promise<{
4896
4715
  itemsOnPage: number;
4897
4716
  nextPage?: number;
4898
4717
  data: {
4899
4718
  address: string;
4900
4719
  network: {
4901
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
4720
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
4902
4721
  chainId: number;
4903
4722
  networkCaip: string;
4904
4723
  };
@@ -4910,6 +4729,7 @@ declare class VaultsSdk {
4910
4729
  decimals: number;
4911
4730
  assetLogo?: string;
4912
4731
  assetPriceInUsd?: string;
4732
+ assetGroup: string;
4913
4733
  };
4914
4734
  isTransactional: boolean;
4915
4735
  isAppFeatured: boolean;
@@ -4964,6 +4784,7 @@ declare class VaultsSdk {
4964
4784
  decimals: number;
4965
4785
  assetLogo?: string;
4966
4786
  assetPriceInUsd?: string;
4787
+ assetGroup: string;
4967
4788
  };
4968
4789
  apy: {
4969
4790
  "1day": number;
@@ -4997,6 +4818,7 @@ declare class VaultsSdk {
4997
4818
  decimals: number;
4998
4819
  assetLogo?: string;
4999
4820
  assetPriceInUsd?: string;
4821
+ assetGroup: string;
5000
4822
  };
5001
4823
  lpToken?: {
5002
4824
  address: string;
@@ -5013,6 +4835,7 @@ declare class VaultsSdk {
5013
4835
  decimals: number;
5014
4836
  assetLogo?: string;
5015
4837
  assetPriceInUsd?: string;
4838
+ assetGroup: string;
5016
4839
  }[];
5017
4840
  }[];
5018
4841
  additionalAssets?: {
@@ -5023,7 +4846,13 @@ declare class VaultsSdk {
5023
4846
  decimals: number;
5024
4847
  assetLogo?: string;
5025
4848
  assetPriceInUsd?: string;
4849
+ assetGroup: string;
5026
4850
  }[];
4851
+ transactionalProperties?: {
4852
+ depositStepsType: "instant" | "complex";
4853
+ redeemStepsType: "instant" | "complex";
4854
+ rewardsSupported: boolean;
4855
+ };
5027
4856
  }[];
5028
4857
  errors: {
5029
4858
  unsupportedNetworks: string[];
@@ -5034,7 +4863,7 @@ declare class VaultsSdk {
5034
4863
  getVault(params: Params<'/v2/detailed-vaults/{network}/{vaultAddress}'>): Promise<{
5035
4864
  address: string;
5036
4865
  network: {
5037
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
4866
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
5038
4867
  chainId: number;
5039
4868
  networkCaip: string;
5040
4869
  };
@@ -5046,6 +4875,7 @@ declare class VaultsSdk {
5046
4875
  decimals: number;
5047
4876
  assetLogo?: string;
5048
4877
  assetPriceInUsd?: string;
4878
+ assetGroup: string;
5049
4879
  };
5050
4880
  isTransactional: boolean;
5051
4881
  isAppFeatured: boolean;
@@ -5100,6 +4930,7 @@ declare class VaultsSdk {
5100
4930
  decimals: number;
5101
4931
  assetLogo?: string;
5102
4932
  assetPriceInUsd?: string;
4933
+ assetGroup: string;
5103
4934
  };
5104
4935
  apy: {
5105
4936
  "1day": number;
@@ -5133,6 +4964,7 @@ declare class VaultsSdk {
5133
4964
  decimals: number;
5134
4965
  assetLogo?: string;
5135
4966
  assetPriceInUsd?: string;
4967
+ assetGroup: string;
5136
4968
  };
5137
4969
  lpToken?: {
5138
4970
  address: string;
@@ -5149,6 +4981,7 @@ declare class VaultsSdk {
5149
4981
  decimals: number;
5150
4982
  assetLogo?: string;
5151
4983
  assetPriceInUsd?: string;
4984
+ assetGroup: string;
5152
4985
  }[];
5153
4986
  }[];
5154
4987
  additionalAssets?: {
@@ -5159,7 +4992,13 @@ declare class VaultsSdk {
5159
4992
  decimals: number;
5160
4993
  assetLogo?: string;
5161
4994
  assetPriceInUsd?: string;
4995
+ assetGroup: string;
5162
4996
  }[];
4997
+ transactionalProperties?: {
4998
+ depositStepsType: "instant" | "complex";
4999
+ redeemStepsType: "instant" | "complex";
5000
+ rewardsSupported: boolean;
5001
+ };
5163
5002
  }>;
5164
5003
  getIdleAssets(params: Params<'/v2/portfolio/idle-assets/{userAddress}'>): Promise<{
5165
5004
  data: {
@@ -5170,10 +5009,11 @@ declare class VaultsSdk {
5170
5009
  decimals: number;
5171
5010
  assetLogo?: string;
5172
5011
  assetPriceInUsd?: string;
5012
+ assetGroup: string;
5173
5013
  balanceNative: string;
5174
5014
  balanceUsd: string;
5175
5015
  network: {
5176
- name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
5016
+ name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
5177
5017
  chainId: number;
5178
5018
  networkCaip: string;
5179
5019
  };
@@ -5184,17 +5024,17 @@ declare class VaultsSdk {
5184
5024
  };
5185
5025
  }>;
5186
5026
  getTransactionsContext(params: Params<'/v2/transactions/context/{userAddress}/{network}/{vaultAddress}'>): Promise<{
5187
- currentDepositStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5027
+ currentDepositStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5188
5028
  depositSteps: {
5189
5029
  actions: string[];
5190
5030
  actionsUrl: string;
5191
- name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5031
+ name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5192
5032
  }[];
5193
- currentRedeemStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5033
+ currentRedeemStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5194
5034
  redeemSteps: {
5195
5035
  actions: string[];
5196
5036
  actionsUrl: string;
5197
- name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5037
+ name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5198
5038
  }[];
5199
5039
  lpToken: {
5200
5040
  address: string;
@@ -5213,6 +5053,7 @@ declare class VaultsSdk {
5213
5053
  decimals: number;
5214
5054
  assetLogo?: string;
5215
5055
  assetPriceInUsd?: string;
5056
+ assetGroup: string;
5216
5057
  balanceNative: string;
5217
5058
  balanceUsd: string;
5218
5059
  unclaimedNative?: string;
@@ -5227,6 +5068,7 @@ declare class VaultsSdk {
5227
5068
  decimals: number;
5228
5069
  assetLogo?: string;
5229
5070
  assetPriceInUsd?: string;
5071
+ assetGroup: string;
5230
5072
  balanceNative: string;
5231
5073
  balanceUsd: string;
5232
5074
  unclaimedNative?: string;
@@ -5252,6 +5094,7 @@ declare class VaultsSdk {
5252
5094
  decimals: number;
5253
5095
  assetLogo?: string;
5254
5096
  assetPriceInUsd?: string;
5097
+ assetGroup: string;
5255
5098
  balanceNative: string;
5256
5099
  balanceUsd: string;
5257
5100
  unclaimedNative?: string;
@@ -5266,6 +5109,7 @@ declare class VaultsSdk {
5266
5109
  decimals: number;
5267
5110
  assetLogo?: string;
5268
5111
  assetPriceInUsd?: string;
5112
+ assetGroup: string;
5269
5113
  balanceNative: string;
5270
5114
  balanceUsd: string;
5271
5115
  unclaimedNative?: string;
@@ -5285,14 +5129,15 @@ declare class VaultsSdk {
5285
5129
  decimals: number;
5286
5130
  assetLogo?: string;
5287
5131
  assetPriceInUsd?: string;
5288
- network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink";
5132
+ assetGroup: string;
5133
+ network: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid";
5289
5134
  };
5290
5135
  }[];
5291
- currentStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5136
+ currentStep: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5292
5137
  steps: {
5293
5138
  actions: string[];
5294
5139
  actionsUrl: string;
5295
- name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards";
5140
+ name: "deposit" | "redeem" | "request-redeem" | "claim-redeem" | "claim-rewards" | "start-redeem-cooldown";
5296
5141
  }[];
5297
5142
  };
5298
5143
  }>;