@vaultsfyi/sdk 2.1.9 → 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,11 @@
1
1
  # @vaultsfyi/sdk
2
2
 
3
+ ## 2.1.10
4
+
5
+ ### Patch Changes
6
+
7
+ - e1ca978 Update OpenAPI types (#93)
8
+
3
9
  ## 2.1.9
4
10
 
5
11
  ### 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,6 +1601,8 @@ 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. */
@@ -2897,6 +2901,8 @@ interface paths {
2897
2901
  onlyTransactional?: boolean;
2898
2902
  /** @description Include only vaults that are featured in app.vaults.fyi */
2899
2903
  onlyAppFeatured?: boolean;
2904
+ /** @description Whether to include vaults with warnings. Defaults to true. */
2905
+ allowVaultsWithWarnings?: boolean;
2900
2906
  /** @description Networks to be included (name or CAIP). */
2901
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')[];
2902
2908
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3174,6 +3180,8 @@ interface paths {
3174
3180
  onlyTransactional?: boolean;
3175
3181
  /** @description Include only vaults that are featured in app.vaults.fyi */
3176
3182
  onlyAppFeatured?: boolean;
3183
+ /** @description Whether to include vaults with warnings. Defaults to true. */
3184
+ allowVaultsWithWarnings?: boolean;
3177
3185
  /** @description Networks to be included (name or CAIP). */
3178
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')[];
3179
3187
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3182,14 +3190,16 @@ interface paths {
3182
3190
  maxTvl?: number;
3183
3191
  /** @description Maximum APY (in decimal) of the vaults to be included */
3184
3192
  maxApy?: number;
3193
+ /** @description Minimum APY (in decimal) of the vaults to be included */
3194
+ minApy?: number;
3185
3195
  /** @description Tags to be included. */
3186
3196
  tags?: string[];
3187
3197
  /** @description Curators to be included. */
3188
3198
  curators?: string[];
3189
3199
  /** @description Sort order, either asc or desc. Ascending is default. */
3190
3200
  sortOrder?: 'asc' | 'desc';
3191
- /** @description Field to sort by */
3192
- sortBy?: 'tvl' | 'apy1day' | 'apy7day' | 'apy30day';
3201
+ /** @description Field to sort by. */
3202
+ sortBy?: 'balanceUsd' | 'tvl' | 'apy1Day' | 'apy7Day' | 'apy30Day';
3193
3203
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
3194
3204
  apyInterval?: '1day' | '7day' | '30day';
3195
3205
  /** @description Minimum USD value of the vault to be included */
@@ -3991,6 +4001,8 @@ interface paths {
3991
4001
  onlyTransactional?: boolean;
3992
4002
  /** @description Include only vaults that are featured in app.vaults.fyi */
3993
4003
  onlyAppFeatured?: boolean;
4004
+ /** @description Whether to include vaults with warnings. Defaults to true. */
4005
+ allowVaultsWithWarnings?: boolean;
3994
4006
  /** @description Networks to be included (name or CAIP). */
3995
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')[];
3996
4008
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4266,6 +4278,10 @@ interface paths {
4266
4278
  disallowedAssets?: string[];
4267
4279
  /** @description Minimum USD value of the asset to be included */
4268
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';
4269
4285
  /** @description Networks to be included (name or CAIP). */
4270
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')[];
4271
4287
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4963,6 +4979,8 @@ interface paths {
4963
4979
  unclaimedUsd?: string;
4964
4980
  /** @description Position value in asset denominated in asset wei */
4965
4981
  positionValueInAsset?: string;
4982
+ /** @description Maximum amount that can be deposited */
4983
+ depositLimit?: string;
4966
4984
  };
4967
4985
  /** @description Additional assets details */
4968
4986
  additionalAssets: {
@@ -4995,6 +5013,8 @@ interface paths {
4995
5013
  unclaimedUsd?: string;
4996
5014
  /** @description Position value in asset denominated in asset wei */
4997
5015
  positionValueInAsset?: string;
5016
+ /** @description Maximum amount that can be deposited */
5017
+ depositLimit?: string;
4998
5018
  }[];
4999
5019
  childrenPositions: {
5000
5020
  /** @description Address of the child vault */
@@ -5047,6 +5067,8 @@ interface paths {
5047
5067
  unclaimedUsd?: string;
5048
5068
  /** @description Position value in asset denominated in asset wei */
5049
5069
  positionValueInAsset?: string;
5070
+ /** @description Maximum amount that can be deposited */
5071
+ depositLimit?: string;
5050
5072
  };
5051
5073
  /** @description Additional assets details of the child vault */
5052
5074
  additionalAssets: {
@@ -5079,6 +5101,8 @@ interface paths {
5079
5101
  unclaimedUsd?: string;
5080
5102
  /** @description Position value in asset denominated in asset wei */
5081
5103
  positionValueInAsset?: string;
5104
+ /** @description Maximum amount that can be deposited */
5105
+ depositLimit?: string;
5082
5106
  }[];
5083
5107
  }[];
5084
5108
  /** @description Vault specific data */
@@ -8330,6 +8354,7 @@ declare class VaultsSdk {
8330
8354
  unclaimedNative?: string;
8331
8355
  unclaimedUsd?: string;
8332
8356
  positionValueInAsset?: string;
8357
+ depositLimit?: string;
8333
8358
  };
8334
8359
  additionalAssets: {
8335
8360
  address: string;
@@ -8345,6 +8370,7 @@ declare class VaultsSdk {
8345
8370
  unclaimedNative?: string;
8346
8371
  unclaimedUsd?: string;
8347
8372
  positionValueInAsset?: string;
8373
+ depositLimit?: string;
8348
8374
  }[];
8349
8375
  childrenPositions: {
8350
8376
  address: string;
@@ -8371,6 +8397,7 @@ declare class VaultsSdk {
8371
8397
  unclaimedNative?: string;
8372
8398
  unclaimedUsd?: string;
8373
8399
  positionValueInAsset?: string;
8400
+ depositLimit?: string;
8374
8401
  };
8375
8402
  additionalAssets: {
8376
8403
  address: string;
@@ -8386,6 +8413,7 @@ declare class VaultsSdk {
8386
8413
  unclaimedNative?: string;
8387
8414
  unclaimedUsd?: string;
8388
8415
  positionValueInAsset?: string;
8416
+ depositLimit?: string;
8389
8417
  }[];
8390
8418
  }[];
8391
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,6 +1601,8 @@ 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. */
@@ -2897,6 +2901,8 @@ interface paths {
2897
2901
  onlyTransactional?: boolean;
2898
2902
  /** @description Include only vaults that are featured in app.vaults.fyi */
2899
2903
  onlyAppFeatured?: boolean;
2904
+ /** @description Whether to include vaults with warnings. Defaults to true. */
2905
+ allowVaultsWithWarnings?: boolean;
2900
2906
  /** @description Networks to be included (name or CAIP). */
2901
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')[];
2902
2908
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3174,6 +3180,8 @@ interface paths {
3174
3180
  onlyTransactional?: boolean;
3175
3181
  /** @description Include only vaults that are featured in app.vaults.fyi */
3176
3182
  onlyAppFeatured?: boolean;
3183
+ /** @description Whether to include vaults with warnings. Defaults to true. */
3184
+ allowVaultsWithWarnings?: boolean;
3177
3185
  /** @description Networks to be included (name or CAIP). */
3178
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')[];
3179
3187
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -3182,14 +3190,16 @@ interface paths {
3182
3190
  maxTvl?: number;
3183
3191
  /** @description Maximum APY (in decimal) of the vaults to be included */
3184
3192
  maxApy?: number;
3193
+ /** @description Minimum APY (in decimal) of the vaults to be included */
3194
+ minApy?: number;
3185
3195
  /** @description Tags to be included. */
3186
3196
  tags?: string[];
3187
3197
  /** @description Curators to be included. */
3188
3198
  curators?: string[];
3189
3199
  /** @description Sort order, either asc or desc. Ascending is default. */
3190
3200
  sortOrder?: 'asc' | 'desc';
3191
- /** @description Field to sort by */
3192
- sortBy?: 'tvl' | 'apy1day' | 'apy7day' | 'apy30day';
3201
+ /** @description Field to sort by. */
3202
+ sortBy?: 'balanceUsd' | 'tvl' | 'apy1Day' | 'apy7Day' | 'apy30Day';
3193
3203
  /** @description Interval for APY data. Possible values: 1day, 7day, 30day */
3194
3204
  apyInterval?: '1day' | '7day' | '30day';
3195
3205
  /** @description Minimum USD value of the vault to be included */
@@ -3991,6 +4001,8 @@ interface paths {
3991
4001
  onlyTransactional?: boolean;
3992
4002
  /** @description Include only vaults that are featured in app.vaults.fyi */
3993
4003
  onlyAppFeatured?: boolean;
4004
+ /** @description Whether to include vaults with warnings. Defaults to true. */
4005
+ allowVaultsWithWarnings?: boolean;
3994
4006
  /** @description Networks to be included (name or CAIP). */
3995
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')[];
3996
4008
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4266,6 +4278,10 @@ interface paths {
4266
4278
  disallowedAssets?: string[];
4267
4279
  /** @description Minimum USD value of the asset to be included */
4268
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';
4269
4285
  /** @description Networks to be included (name or CAIP). */
4270
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')[];
4271
4287
  /** @description Networks to be excluded (name or CAIP). The parameter is ignored if "allowedNetworks" is specified. */
@@ -4963,6 +4979,8 @@ interface paths {
4963
4979
  unclaimedUsd?: string;
4964
4980
  /** @description Position value in asset denominated in asset wei */
4965
4981
  positionValueInAsset?: string;
4982
+ /** @description Maximum amount that can be deposited */
4983
+ depositLimit?: string;
4966
4984
  };
4967
4985
  /** @description Additional assets details */
4968
4986
  additionalAssets: {
@@ -4995,6 +5013,8 @@ interface paths {
4995
5013
  unclaimedUsd?: string;
4996
5014
  /** @description Position value in asset denominated in asset wei */
4997
5015
  positionValueInAsset?: string;
5016
+ /** @description Maximum amount that can be deposited */
5017
+ depositLimit?: string;
4998
5018
  }[];
4999
5019
  childrenPositions: {
5000
5020
  /** @description Address of the child vault */
@@ -5047,6 +5067,8 @@ interface paths {
5047
5067
  unclaimedUsd?: string;
5048
5068
  /** @description Position value in asset denominated in asset wei */
5049
5069
  positionValueInAsset?: string;
5070
+ /** @description Maximum amount that can be deposited */
5071
+ depositLimit?: string;
5050
5072
  };
5051
5073
  /** @description Additional assets details of the child vault */
5052
5074
  additionalAssets: {
@@ -5079,6 +5101,8 @@ interface paths {
5079
5101
  unclaimedUsd?: string;
5080
5102
  /** @description Position value in asset denominated in asset wei */
5081
5103
  positionValueInAsset?: string;
5104
+ /** @description Maximum amount that can be deposited */
5105
+ depositLimit?: string;
5082
5106
  }[];
5083
5107
  }[];
5084
5108
  /** @description Vault specific data */
@@ -8330,6 +8354,7 @@ declare class VaultsSdk {
8330
8354
  unclaimedNative?: string;
8331
8355
  unclaimedUsd?: string;
8332
8356
  positionValueInAsset?: string;
8357
+ depositLimit?: string;
8333
8358
  };
8334
8359
  additionalAssets: {
8335
8360
  address: string;
@@ -8345,6 +8370,7 @@ declare class VaultsSdk {
8345
8370
  unclaimedNative?: string;
8346
8371
  unclaimedUsd?: string;
8347
8372
  positionValueInAsset?: string;
8373
+ depositLimit?: string;
8348
8374
  }[];
8349
8375
  childrenPositions: {
8350
8376
  address: string;
@@ -8371,6 +8397,7 @@ declare class VaultsSdk {
8371
8397
  unclaimedNative?: string;
8372
8398
  unclaimedUsd?: string;
8373
8399
  positionValueInAsset?: string;
8400
+ depositLimit?: string;
8374
8401
  };
8375
8402
  additionalAssets: {
8376
8403
  address: string;
@@ -8386,6 +8413,7 @@ declare class VaultsSdk {
8386
8413
  unclaimedNative?: string;
8387
8414
  unclaimedUsd?: string;
8388
8415
  positionValueInAsset?: string;
8416
+ depositLimit?: string;
8389
8417
  }[];
8390
8418
  }[];
8391
8419
  vaultSpecificData?: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vaultsfyi/sdk",
3
- "version": "2.1.9",
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",