@vaultsfyi/sdk 2.1.8 → 2.1.10

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/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @vaultsfyi/sdk
2
2
 
3
+ ## 2.1.10
4
+
5
+ ### Patch Changes
6
+
7
+ - e1ca978 Update OpenAPI types (#93)
8
+
9
+ ## 2.1.9
10
+
11
+ ### Patch Changes
12
+
13
+ - aadebdd Update OpenAPI types
14
+
3
15
  ## 2.1.8
4
16
 
5
17
  ### Patch Changes
package/dist/client.d.mts CHANGED
@@ -1591,6 +1591,8 @@ interface paths {
1591
1591
  onlyTransactional?: boolean;
1592
1592
  /** @description Include only vaults that are featured in app.vaults.fyi */
1593
1593
  onlyAppFeatured?: boolean;
1594
+ /** @description Whether to include vaults with warnings. Defaults to true. */
1595
+ allowVaultsWithWarnings?: boolean;
1594
1596
  /** @description Networks to be included (name or CAIP). */
1595
1597
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
1596
1598
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -1599,10 +1601,16 @@ interface paths {
1599
1601
  maxTvl?: number;
1600
1602
  /** @description Maximum APY (in decimal) of the vaults to be included */
1601
1603
  maxApy?: number;
1604
+ /** @description Minimum APY (in decimal) of the vaults to be included */
1605
+ minApy?: number;
1602
1606
  /** @description Tags to be included. */
1603
1607
  tags?: string[];
1604
1608
  /** @description Curators to be included. */
1605
1609
  curators?: string[];
1610
+ /** @description Sort order, either asc or desc. Ascending is default. */
1611
+ sortOrder?: 'asc' | 'desc';
1612
+ /** @description Field to sort by */
1613
+ sortBy?: 'tvl' | 'apy1day' | 'apy7day' | 'apy30day';
1606
1614
  };
1607
1615
  header?: never;
1608
1616
  path?: never;
@@ -2893,6 +2901,8 @@ interface paths {
2893
2901
  onlyTransactional?: boolean;
2894
2902
  /** @description Include only vaults that are featured in app.vaults.fyi */
2895
2903
  onlyAppFeatured?: boolean;
2904
+ /** @description Whether to include vaults with warnings. Defaults to true. */
2905
+ allowVaultsWithWarnings?: boolean;
2896
2906
  /** @description Networks to be included (name or CAIP). */
2897
2907
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
2898
2908
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3170,6 +3180,8 @@ interface paths {
3170
3180
  onlyTransactional?: boolean;
3171
3181
  /** @description Include only vaults that are featured in app.vaults.fyi */
3172
3182
  onlyAppFeatured?: boolean;
3183
+ /** @description Whether to include vaults with warnings. Defaults to true. */
3184
+ allowVaultsWithWarnings?: boolean;
3173
3185
  /** @description Networks to be included (name or CAIP). */
3174
3186
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
3175
3187
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3178,10 +3190,16 @@ interface paths {
3178
3190
  maxTvl?: number;
3179
3191
  /** @description Maximum APY (in decimal) of the vaults to be included */
3180
3192
  maxApy?: number;
3193
+ /** @description Minimum APY (in decimal) of the vaults to be included */
3194
+ minApy?: number;
3181
3195
  /** @description Tags to be included. */
3182
3196
  tags?: string[];
3183
3197
  /** @description Curators to be included. */
3184
3198
  curators?: string[];
3199
+ /** @description Sort order, either asc or desc. Ascending is default. */
3200
+ sortOrder?: 'asc' | 'desc';
3201
+ /** @description Field to sort by. */
3202
+ sortBy?: 'balanceUsd' | 'tvl' | 'apy1Day' | 'apy7Day' | 'apy30Day';
3185
3203
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
3186
3204
  apyInterval?: '1day' | '7day' | '30day';
3187
3205
  /** @description Minimum USD value of the vault to be included */
@@ -3983,6 +4001,8 @@ interface paths {
3983
4001
  onlyTransactional?: boolean;
3984
4002
  /** @description Include only vaults that are featured in app.vaults.fyi */
3985
4003
  onlyAppFeatured?: boolean;
4004
+ /** @description Whether to include vaults with warnings. Defaults to true. */
4005
+ allowVaultsWithWarnings?: boolean;
3986
4006
  /** @description Networks to be included (name or CAIP). */
3987
4007
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
3988
4008
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4258,6 +4278,10 @@ interface paths {
4258
4278
  disallowedAssets?: string[];
4259
4279
  /** @description Minimum USD value of the asset to be included */
4260
4280
  minUsdAssetValueThreshold?: number;
4281
+ /** @description Field to sort the results by. Currently, only "balanceUsd" is supported. */
4282
+ sortBy?: 'balanceUsd';
4283
+ /** @description Sort order, either asc or desc. Ascending is default. */
4284
+ sortDirection?: 'asc' | 'desc';
4261
4285
  /** @description Networks to be included (name or CAIP). */
4262
4286
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
4263
4287
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4955,6 +4979,8 @@ interface paths {
4955
4979
  unclaimedUsd?: string;
4956
4980
  /** @description Position value in asset denominated in asset wei */
4957
4981
  positionValueInAsset?: string;
4982
+ /** @description Maximum amount that can be deposited */
4983
+ depositLimit?: string;
4958
4984
  };
4959
4985
  /** @description Additional assets details */
4960
4986
  additionalAssets: {
@@ -4987,6 +5013,8 @@ interface paths {
4987
5013
  unclaimedUsd?: string;
4988
5014
  /** @description Position value in asset denominated in asset wei */
4989
5015
  positionValueInAsset?: string;
5016
+ /** @description Maximum amount that can be deposited */
5017
+ depositLimit?: string;
4990
5018
  }[];
4991
5019
  childrenPositions: {
4992
5020
  /** @description Address of the child vault */
@@ -5039,6 +5067,8 @@ interface paths {
5039
5067
  unclaimedUsd?: string;
5040
5068
  /** @description Position value in asset denominated in asset wei */
5041
5069
  positionValueInAsset?: string;
5070
+ /** @description Maximum amount that can be deposited */
5071
+ depositLimit?: string;
5042
5072
  };
5043
5073
  /** @description Additional assets details of the child vault */
5044
5074
  additionalAssets: {
@@ -5071,6 +5101,8 @@ interface paths {
5071
5101
  unclaimedUsd?: string;
5072
5102
  /** @description Position value in asset denominated in asset wei */
5073
5103
  positionValueInAsset?: string;
5104
+ /** @description Maximum amount that can be deposited */
5105
+ depositLimit?: string;
5074
5106
  }[];
5075
5107
  }[];
5076
5108
  /** @description Vault specific data */
@@ -8322,6 +8354,7 @@ declare class VaultsSdk {
8322
8354
  unclaimedNative?: string;
8323
8355
  unclaimedUsd?: string;
8324
8356
  positionValueInAsset?: string;
8357
+ depositLimit?: string;
8325
8358
  };
8326
8359
  additionalAssets: {
8327
8360
  address: string;
@@ -8337,6 +8370,7 @@ declare class VaultsSdk {
8337
8370
  unclaimedNative?: string;
8338
8371
  unclaimedUsd?: string;
8339
8372
  positionValueInAsset?: string;
8373
+ depositLimit?: string;
8340
8374
  }[];
8341
8375
  childrenPositions: {
8342
8376
  address: string;
@@ -8363,6 +8397,7 @@ declare class VaultsSdk {
8363
8397
  unclaimedNative?: string;
8364
8398
  unclaimedUsd?: string;
8365
8399
  positionValueInAsset?: string;
8400
+ depositLimit?: string;
8366
8401
  };
8367
8402
  additionalAssets: {
8368
8403
  address: string;
@@ -8378,6 +8413,7 @@ declare class VaultsSdk {
8378
8413
  unclaimedNative?: string;
8379
8414
  unclaimedUsd?: string;
8380
8415
  positionValueInAsset?: string;
8416
+ depositLimit?: string;
8381
8417
  }[];
8382
8418
  }[];
8383
8419
  vaultSpecificData?: unknown;
package/dist/client.d.ts CHANGED
@@ -1591,6 +1591,8 @@ interface paths {
1591
1591
  onlyTransactional?: boolean;
1592
1592
  /** @description Include only vaults that are featured in app.vaults.fyi */
1593
1593
  onlyAppFeatured?: boolean;
1594
+ /** @description Whether to include vaults with warnings. Defaults to true. */
1595
+ allowVaultsWithWarnings?: boolean;
1594
1596
  /** @description Networks to be included (name or CAIP). */
1595
1597
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
1596
1598
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -1599,10 +1601,16 @@ interface paths {
1599
1601
  maxTvl?: number;
1600
1602
  /** @description Maximum APY (in decimal) of the vaults to be included */
1601
1603
  maxApy?: number;
1604
+ /** @description Minimum APY (in decimal) of the vaults to be included */
1605
+ minApy?: number;
1602
1606
  /** @description Tags to be included. */
1603
1607
  tags?: string[];
1604
1608
  /** @description Curators to be included. */
1605
1609
  curators?: string[];
1610
+ /** @description Sort order, either asc or desc. Ascending is default. */
1611
+ sortOrder?: 'asc' | 'desc';
1612
+ /** @description Field to sort by */
1613
+ sortBy?: 'tvl' | 'apy1day' | 'apy7day' | 'apy30day';
1606
1614
  };
1607
1615
  header?: never;
1608
1616
  path?: never;
@@ -2893,6 +2901,8 @@ interface paths {
2893
2901
  onlyTransactional?: boolean;
2894
2902
  /** @description Include only vaults that are featured in app.vaults.fyi */
2895
2903
  onlyAppFeatured?: boolean;
2904
+ /** @description Whether to include vaults with warnings. Defaults to true. */
2905
+ allowVaultsWithWarnings?: boolean;
2896
2906
  /** @description Networks to be included (name or CAIP). */
2897
2907
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
2898
2908
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3170,6 +3180,8 @@ interface paths {
3170
3180
  onlyTransactional?: boolean;
3171
3181
  /** @description Include only vaults that are featured in app.vaults.fyi */
3172
3182
  onlyAppFeatured?: boolean;
3183
+ /** @description Whether to include vaults with warnings. Defaults to true. */
3184
+ allowVaultsWithWarnings?: boolean;
3173
3185
  /** @description Networks to be included (name or CAIP). */
3174
3186
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
3175
3187
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3178,10 +3190,16 @@ interface paths {
3178
3190
  maxTvl?: number;
3179
3191
  /** @description Maximum APY (in decimal) of the vaults to be included */
3180
3192
  maxApy?: number;
3193
+ /** @description Minimum APY (in decimal) of the vaults to be included */
3194
+ minApy?: number;
3181
3195
  /** @description Tags to be included. */
3182
3196
  tags?: string[];
3183
3197
  /** @description Curators to be included. */
3184
3198
  curators?: string[];
3199
+ /** @description Sort order, either asc or desc. Ascending is default. */
3200
+ sortOrder?: 'asc' | 'desc';
3201
+ /** @description Field to sort by. */
3202
+ sortBy?: 'balanceUsd' | 'tvl' | 'apy1Day' | 'apy7Day' | 'apy30Day';
3185
3203
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
3186
3204
  apyInterval?: '1day' | '7day' | '30day';
3187
3205
  /** @description Minimum USD value of the vault to be included */
@@ -3983,6 +4001,8 @@ interface paths {
3983
4001
  onlyTransactional?: boolean;
3984
4002
  /** @description Include only vaults that are featured in app.vaults.fyi */
3985
4003
  onlyAppFeatured?: boolean;
4004
+ /** @description Whether to include vaults with warnings. Defaults to true. */
4005
+ allowVaultsWithWarnings?: boolean;
3986
4006
  /** @description Networks to be included (name or CAIP). */
3987
4007
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
3988
4008
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4258,6 +4278,10 @@ interface paths {
4258
4278
  disallowedAssets?: string[];
4259
4279
  /** @description Minimum USD value of the asset to be included */
4260
4280
  minUsdAssetValueThreshold?: number;
4281
+ /** @description Field to sort the results by. Currently, only "balanceUsd" is supported. */
4282
+ sortBy?: 'balanceUsd';
4283
+ /** @description Sort order, either asc or desc. Ascending is default. */
4284
+ sortDirection?: 'asc' | 'desc';
4261
4285
  /** @description Networks to be included (name or CAIP). */
4262
4286
  allowedNetworks?: ('mainnet' | 'optimism' | 'arbitrum' | 'polygon' | 'gnosis' | 'base' | 'unichain' | 'swellchain' | 'celo' | 'worldchain' | 'berachain' | 'ink' | 'bsc' | 'hyperliquid' | 'plasma' | 'avalanche' | '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' | 'eip155:9745' | 'eip155:43114')[];
4263
4287
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4955,6 +4979,8 @@ interface paths {
4955
4979
  unclaimedUsd?: string;
4956
4980
  /** @description Position value in asset denominated in asset wei */
4957
4981
  positionValueInAsset?: string;
4982
+ /** @description Maximum amount that can be deposited */
4983
+ depositLimit?: string;
4958
4984
  };
4959
4985
  /** @description Additional assets details */
4960
4986
  additionalAssets: {
@@ -4987,6 +5013,8 @@ interface paths {
4987
5013
  unclaimedUsd?: string;
4988
5014
  /** @description Position value in asset denominated in asset wei */
4989
5015
  positionValueInAsset?: string;
5016
+ /** @description Maximum amount that can be deposited */
5017
+ depositLimit?: string;
4990
5018
  }[];
4991
5019
  childrenPositions: {
4992
5020
  /** @description Address of the child vault */
@@ -5039,6 +5067,8 @@ interface paths {
5039
5067
  unclaimedUsd?: string;
5040
5068
  /** @description Position value in asset denominated in asset wei */
5041
5069
  positionValueInAsset?: string;
5070
+ /** @description Maximum amount that can be deposited */
5071
+ depositLimit?: string;
5042
5072
  };
5043
5073
  /** @description Additional assets details of the child vault */
5044
5074
  additionalAssets: {
@@ -5071,6 +5101,8 @@ interface paths {
5071
5101
  unclaimedUsd?: string;
5072
5102
  /** @description Position value in asset denominated in asset wei */
5073
5103
  positionValueInAsset?: string;
5104
+ /** @description Maximum amount that can be deposited */
5105
+ depositLimit?: string;
5074
5106
  }[];
5075
5107
  }[];
5076
5108
  /** @description Vault specific data */
@@ -8322,6 +8354,7 @@ declare class VaultsSdk {
8322
8354
  unclaimedNative?: string;
8323
8355
  unclaimedUsd?: string;
8324
8356
  positionValueInAsset?: string;
8357
+ depositLimit?: string;
8325
8358
  };
8326
8359
  additionalAssets: {
8327
8360
  address: string;
@@ -8337,6 +8370,7 @@ declare class VaultsSdk {
8337
8370
  unclaimedNative?: string;
8338
8371
  unclaimedUsd?: string;
8339
8372
  positionValueInAsset?: string;
8373
+ depositLimit?: string;
8340
8374
  }[];
8341
8375
  childrenPositions: {
8342
8376
  address: string;
@@ -8363,6 +8397,7 @@ declare class VaultsSdk {
8363
8397
  unclaimedNative?: string;
8364
8398
  unclaimedUsd?: string;
8365
8399
  positionValueInAsset?: string;
8400
+ depositLimit?: string;
8366
8401
  };
8367
8402
  additionalAssets: {
8368
8403
  address: string;
@@ -8378,6 +8413,7 @@ declare class VaultsSdk {
8378
8413
  unclaimedNative?: string;
8379
8414
  unclaimedUsd?: string;
8380
8415
  positionValueInAsset?: string;
8416
+ depositLimit?: string;
8381
8417
  }[];
8382
8418
  }[];
8383
8419
  vaultSpecificData?: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaultsfyi/sdk",
3
- "version": "2.1.8",
3
+ "version": "2.1.10",
4
4
  "description": "An SDK for interacting with the Vaults.fyi API",
5
5
  "main": "./dist/client.js",
6
6
  "module": "./dist/client.mjs",