@vaultsfyi/sdk 2.1.19 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/client.d.mts +148 -14
  3. package/dist/client.d.ts +148 -14
  4. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @vaultsfyi/sdk
2
2
 
3
+ ## 2.2.0
4
+
5
+ ### Patch Changes
6
+
7
+ - c78607d Update OpenAPI types (#315)
8
+
3
9
  ## 2.1.19
4
10
 
5
11
  ### Patch Changes
package/dist/client.d.mts CHANGED
@@ -2310,6 +2310,8 @@ interface paths {
2310
2310
  maxCapacity?: string;
2311
2311
  /** @description Indicates if the vault is corrupted */
2312
2312
  isCorrupted: boolean;
2313
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
2314
+ userEventsIndexed: boolean;
2313
2315
  /** @description List of child vaults */
2314
2316
  childrenVaults?: {
2315
2317
  /** @description Address of the child vault */
@@ -2434,10 +2436,49 @@ interface paths {
2434
2436
  /** @description Unix timestamp (seconds) when this flag expires */
2435
2437
  endDate: number;
2436
2438
  }[];
2437
- /** @description Intrinsic APY when vault asset is another vault LP token. When present the main vault's asset is equivalent of the underlying vault LP token */
2438
- intrinsic?: {
2439
- /** @description Intrinsic APY details */
2440
- apy: {
2439
+ /** @description Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY */
2440
+ apyComposite?: {
2441
+ /** @description Compounded APY details combining the vault and its underlying vault */
2442
+ totalApy: {
2443
+ /** @description 1day APY details */
2444
+ '1day': {
2445
+ /** @description Base APY */
2446
+ base: number;
2447
+ /** @description Reward APY */
2448
+ reward: number;
2449
+ /** @description Total APY */
2450
+ total: number;
2451
+ };
2452
+ /** @description 7day APY details */
2453
+ '7day': {
2454
+ /** @description Base APY */
2455
+ base: number;
2456
+ /** @description Reward APY */
2457
+ reward: number;
2458
+ /** @description Total APY */
2459
+ total: number;
2460
+ };
2461
+ /** @description 30day APY details */
2462
+ '30day': {
2463
+ /** @description Base APY */
2464
+ base: number;
2465
+ /** @description Reward APY */
2466
+ reward: number;
2467
+ /** @description Total APY */
2468
+ total: number;
2469
+ };
2470
+ /** @description 1hour APY details */
2471
+ '1hour': {
2472
+ /** @description Base APY */
2473
+ base: number;
2474
+ /** @description Reward APY */
2475
+ reward: number;
2476
+ /** @description Total APY */
2477
+ total: number;
2478
+ };
2479
+ };
2480
+ /** @description APY details of the underlying vault before compounding */
2481
+ intrinsicApy: {
2441
2482
  /** @description 1day APY details */
2442
2483
  '1day': {
2443
2484
  /** @description Base APY */
@@ -2475,7 +2516,7 @@ interface paths {
2475
2516
  total: number;
2476
2517
  };
2477
2518
  };
2478
- /** @description Lowest level underlying asset that is not a vault LP token */
2519
+ /** @description Asset details of the underlying vault */
2479
2520
  asset: {
2480
2521
  /** @description Address of the asset */
2481
2522
  address: string;
@@ -2886,6 +2927,8 @@ interface paths {
2886
2927
  maxCapacity?: string;
2887
2928
  /** @description Indicates if the vault is corrupted */
2888
2929
  isCorrupted: boolean;
2930
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
2931
+ userEventsIndexed: boolean;
2889
2932
  /** @description List of child vaults */
2890
2933
  childrenVaults?: {
2891
2934
  /** @description Address of the child vault */
@@ -3010,10 +3053,49 @@ interface paths {
3010
3053
  /** @description Unix timestamp (seconds) when this flag expires */
3011
3054
  endDate: number;
3012
3055
  }[];
3013
- /** @description Intrinsic APY when vault asset is another vault LP token. When present the main vault's asset is equivalent of the underlying vault LP token */
3014
- intrinsic?: {
3015
- /** @description Intrinsic APY details */
3016
- apy: {
3056
+ /** @description Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY */
3057
+ apyComposite?: {
3058
+ /** @description Compounded APY details combining the vault and its underlying vault */
3059
+ totalApy: {
3060
+ /** @description 1day APY details */
3061
+ '1day': {
3062
+ /** @description Base APY */
3063
+ base: number;
3064
+ /** @description Reward APY */
3065
+ reward: number;
3066
+ /** @description Total APY */
3067
+ total: number;
3068
+ };
3069
+ /** @description 7day APY details */
3070
+ '7day': {
3071
+ /** @description Base APY */
3072
+ base: number;
3073
+ /** @description Reward APY */
3074
+ reward: number;
3075
+ /** @description Total APY */
3076
+ total: number;
3077
+ };
3078
+ /** @description 30day APY details */
3079
+ '30day': {
3080
+ /** @description Base APY */
3081
+ base: number;
3082
+ /** @description Reward APY */
3083
+ reward: number;
3084
+ /** @description Total APY */
3085
+ total: number;
3086
+ };
3087
+ /** @description 1hour APY details */
3088
+ '1hour': {
3089
+ /** @description Base APY */
3090
+ base: number;
3091
+ /** @description Reward APY */
3092
+ reward: number;
3093
+ /** @description Total APY */
3094
+ total: number;
3095
+ };
3096
+ };
3097
+ /** @description APY details of the underlying vault before compounding */
3098
+ intrinsicApy: {
3017
3099
  /** @description 1day APY details */
3018
3100
  '1day': {
3019
3101
  /** @description Base APY */
@@ -3051,7 +3133,7 @@ interface paths {
3051
3133
  total: number;
3052
3134
  };
3053
3135
  };
3054
- /** @description Lowest level underlying asset that is not a vault LP token */
3136
+ /** @description Asset details of the underlying vault */
3055
3137
  asset: {
3056
3138
  /** @description Address of the asset */
3057
3139
  address: string;
@@ -4009,6 +4091,8 @@ interface paths {
4009
4091
  isTransactional: boolean;
4010
4092
  /** @description Indicates if the vault is featured in app.vaults.fyi */
4011
4093
  isAppFeatured: boolean;
4094
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
4095
+ userEventsIndexed: boolean;
4012
4096
  /** @description Name of the vault */
4013
4097
  name: string;
4014
4098
  /** @description Protocol details of the vault */
@@ -4419,6 +4503,8 @@ interface paths {
4419
4503
  isTransactional: boolean;
4420
4504
  /** @description Indicates if the vault is featured in app.vaults.fyi */
4421
4505
  isAppFeatured: boolean;
4506
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
4507
+ userEventsIndexed: boolean;
4422
4508
  /** @description Name of the vault */
4423
4509
  name: string;
4424
4510
  /** @description Protocol details of the vault */
@@ -9195,6 +9281,7 @@ declare class VaultsSdk {
9195
9281
  };
9196
9282
  isTransactional: boolean;
9197
9283
  isAppFeatured: boolean;
9284
+ userEventsIndexed: boolean;
9198
9285
  name: string;
9199
9286
  protocol: {
9200
9287
  name: string;
@@ -9314,6 +9401,7 @@ declare class VaultsSdk {
9314
9401
  };
9315
9402
  isTransactional: boolean;
9316
9403
  isAppFeatured: boolean;
9404
+ userEventsIndexed: boolean;
9317
9405
  name: string;
9318
9406
  protocol: {
9319
9407
  name: string;
@@ -9569,6 +9657,7 @@ declare class VaultsSdk {
9569
9657
  remainingCapacity?: string;
9570
9658
  maxCapacity?: string;
9571
9659
  isCorrupted: boolean;
9660
+ userEventsIndexed: boolean;
9572
9661
  childrenVaults?: {
9573
9662
  address: string;
9574
9663
  asset: {
@@ -9626,8 +9715,30 @@ declare class VaultsSdk {
9626
9715
  severity: "info" | "warning" | "critical";
9627
9716
  endDate: number;
9628
9717
  }[];
9629
- intrinsic?: {
9630
- apy: {
9718
+ apyComposite?: {
9719
+ totalApy: {
9720
+ "1day": {
9721
+ base: number;
9722
+ reward: number;
9723
+ total: number;
9724
+ };
9725
+ "7day": {
9726
+ base: number;
9727
+ reward: number;
9728
+ total: number;
9729
+ };
9730
+ "30day": {
9731
+ base: number;
9732
+ reward: number;
9733
+ total: number;
9734
+ };
9735
+ "1hour": {
9736
+ base: number;
9737
+ reward: number;
9738
+ total: number;
9739
+ };
9740
+ };
9741
+ intrinsicApy: {
9631
9742
  "1day": {
9632
9743
  base: number;
9633
9744
  reward: number;
@@ -9779,6 +9890,7 @@ declare class VaultsSdk {
9779
9890
  remainingCapacity?: string;
9780
9891
  maxCapacity?: string;
9781
9892
  isCorrupted: boolean;
9893
+ userEventsIndexed: boolean;
9782
9894
  childrenVaults?: {
9783
9895
  address: string;
9784
9896
  asset: {
@@ -9836,8 +9948,30 @@ declare class VaultsSdk {
9836
9948
  severity: "info" | "warning" | "critical";
9837
9949
  endDate: number;
9838
9950
  }[];
9839
- intrinsic?: {
9840
- apy: {
9951
+ apyComposite?: {
9952
+ totalApy: {
9953
+ "1day": {
9954
+ base: number;
9955
+ reward: number;
9956
+ total: number;
9957
+ };
9958
+ "7day": {
9959
+ base: number;
9960
+ reward: number;
9961
+ total: number;
9962
+ };
9963
+ "30day": {
9964
+ base: number;
9965
+ reward: number;
9966
+ total: number;
9967
+ };
9968
+ "1hour": {
9969
+ base: number;
9970
+ reward: number;
9971
+ total: number;
9972
+ };
9973
+ };
9974
+ intrinsicApy: {
9841
9975
  "1day": {
9842
9976
  base: number;
9843
9977
  reward: number;
package/dist/client.d.ts CHANGED
@@ -2310,6 +2310,8 @@ interface paths {
2310
2310
  maxCapacity?: string;
2311
2311
  /** @description Indicates if the vault is corrupted */
2312
2312
  isCorrupted: boolean;
2313
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
2314
+ userEventsIndexed: boolean;
2313
2315
  /** @description List of child vaults */
2314
2316
  childrenVaults?: {
2315
2317
  /** @description Address of the child vault */
@@ -2434,10 +2436,49 @@ interface paths {
2434
2436
  /** @description Unix timestamp (seconds) when this flag expires */
2435
2437
  endDate: number;
2436
2438
  }[];
2437
- /** @description Intrinsic APY when vault asset is another vault LP token. When present the main vault's asset is equivalent of the underlying vault LP token */
2438
- intrinsic?: {
2439
- /** @description Intrinsic APY details */
2440
- apy: {
2439
+ /** @description Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY */
2440
+ apyComposite?: {
2441
+ /** @description Compounded APY details combining the vault and its underlying vault */
2442
+ totalApy: {
2443
+ /** @description 1day APY details */
2444
+ '1day': {
2445
+ /** @description Base APY */
2446
+ base: number;
2447
+ /** @description Reward APY */
2448
+ reward: number;
2449
+ /** @description Total APY */
2450
+ total: number;
2451
+ };
2452
+ /** @description 7day APY details */
2453
+ '7day': {
2454
+ /** @description Base APY */
2455
+ base: number;
2456
+ /** @description Reward APY */
2457
+ reward: number;
2458
+ /** @description Total APY */
2459
+ total: number;
2460
+ };
2461
+ /** @description 30day APY details */
2462
+ '30day': {
2463
+ /** @description Base APY */
2464
+ base: number;
2465
+ /** @description Reward APY */
2466
+ reward: number;
2467
+ /** @description Total APY */
2468
+ total: number;
2469
+ };
2470
+ /** @description 1hour APY details */
2471
+ '1hour': {
2472
+ /** @description Base APY */
2473
+ base: number;
2474
+ /** @description Reward APY */
2475
+ reward: number;
2476
+ /** @description Total APY */
2477
+ total: number;
2478
+ };
2479
+ };
2480
+ /** @description APY details of the underlying vault before compounding */
2481
+ intrinsicApy: {
2441
2482
  /** @description 1day APY details */
2442
2483
  '1day': {
2443
2484
  /** @description Base APY */
@@ -2475,7 +2516,7 @@ interface paths {
2475
2516
  total: number;
2476
2517
  };
2477
2518
  };
2478
- /** @description Lowest level underlying asset that is not a vault LP token */
2519
+ /** @description Asset details of the underlying vault */
2479
2520
  asset: {
2480
2521
  /** @description Address of the asset */
2481
2522
  address: string;
@@ -2886,6 +2927,8 @@ interface paths {
2886
2927
  maxCapacity?: string;
2887
2928
  /** @description Indicates if the vault is corrupted */
2888
2929
  isCorrupted: boolean;
2930
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
2931
+ userEventsIndexed: boolean;
2889
2932
  /** @description List of child vaults */
2890
2933
  childrenVaults?: {
2891
2934
  /** @description Address of the child vault */
@@ -3010,10 +3053,49 @@ interface paths {
3010
3053
  /** @description Unix timestamp (seconds) when this flag expires */
3011
3054
  endDate: number;
3012
3055
  }[];
3013
- /** @description Intrinsic APY when vault asset is another vault LP token. When present the main vault's asset is equivalent of the underlying vault LP token */
3014
- intrinsic?: {
3015
- /** @description Intrinsic APY details */
3016
- apy: {
3056
+ /** @description Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY */
3057
+ apyComposite?: {
3058
+ /** @description Compounded APY details combining the vault and its underlying vault */
3059
+ totalApy: {
3060
+ /** @description 1day APY details */
3061
+ '1day': {
3062
+ /** @description Base APY */
3063
+ base: number;
3064
+ /** @description Reward APY */
3065
+ reward: number;
3066
+ /** @description Total APY */
3067
+ total: number;
3068
+ };
3069
+ /** @description 7day APY details */
3070
+ '7day': {
3071
+ /** @description Base APY */
3072
+ base: number;
3073
+ /** @description Reward APY */
3074
+ reward: number;
3075
+ /** @description Total APY */
3076
+ total: number;
3077
+ };
3078
+ /** @description 30day APY details */
3079
+ '30day': {
3080
+ /** @description Base APY */
3081
+ base: number;
3082
+ /** @description Reward APY */
3083
+ reward: number;
3084
+ /** @description Total APY */
3085
+ total: number;
3086
+ };
3087
+ /** @description 1hour APY details */
3088
+ '1hour': {
3089
+ /** @description Base APY */
3090
+ base: number;
3091
+ /** @description Reward APY */
3092
+ reward: number;
3093
+ /** @description Total APY */
3094
+ total: number;
3095
+ };
3096
+ };
3097
+ /** @description APY details of the underlying vault before compounding */
3098
+ intrinsicApy: {
3017
3099
  /** @description 1day APY details */
3018
3100
  '1day': {
3019
3101
  /** @description Base APY */
@@ -3051,7 +3133,7 @@ interface paths {
3051
3133
  total: number;
3052
3134
  };
3053
3135
  };
3054
- /** @description Lowest level underlying asset that is not a vault LP token */
3136
+ /** @description Asset details of the underlying vault */
3055
3137
  asset: {
3056
3138
  /** @description Address of the asset */
3057
3139
  address: string;
@@ -4009,6 +4091,8 @@ interface paths {
4009
4091
  isTransactional: boolean;
4010
4092
  /** @description Indicates if the vault is featured in app.vaults.fyi */
4011
4093
  isAppFeatured: boolean;
4094
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
4095
+ userEventsIndexed: boolean;
4012
4096
  /** @description Name of the vault */
4013
4097
  name: string;
4014
4098
  /** @description Protocol details of the vault */
@@ -4419,6 +4503,8 @@ interface paths {
4419
4503
  isTransactional: boolean;
4420
4504
  /** @description Indicates if the vault is featured in app.vaults.fyi */
4421
4505
  isAppFeatured: boolean;
4506
+ /** @description Indicates if user events related to the vault are indexed and available in the API */
4507
+ userEventsIndexed: boolean;
4422
4508
  /** @description Name of the vault */
4423
4509
  name: string;
4424
4510
  /** @description Protocol details of the vault */
@@ -9195,6 +9281,7 @@ declare class VaultsSdk {
9195
9281
  };
9196
9282
  isTransactional: boolean;
9197
9283
  isAppFeatured: boolean;
9284
+ userEventsIndexed: boolean;
9198
9285
  name: string;
9199
9286
  protocol: {
9200
9287
  name: string;
@@ -9314,6 +9401,7 @@ declare class VaultsSdk {
9314
9401
  };
9315
9402
  isTransactional: boolean;
9316
9403
  isAppFeatured: boolean;
9404
+ userEventsIndexed: boolean;
9317
9405
  name: string;
9318
9406
  protocol: {
9319
9407
  name: string;
@@ -9569,6 +9657,7 @@ declare class VaultsSdk {
9569
9657
  remainingCapacity?: string;
9570
9658
  maxCapacity?: string;
9571
9659
  isCorrupted: boolean;
9660
+ userEventsIndexed: boolean;
9572
9661
  childrenVaults?: {
9573
9662
  address: string;
9574
9663
  asset: {
@@ -9626,8 +9715,30 @@ declare class VaultsSdk {
9626
9715
  severity: "info" | "warning" | "critical";
9627
9716
  endDate: number;
9628
9717
  }[];
9629
- intrinsic?: {
9630
- apy: {
9718
+ apyComposite?: {
9719
+ totalApy: {
9720
+ "1day": {
9721
+ base: number;
9722
+ reward: number;
9723
+ total: number;
9724
+ };
9725
+ "7day": {
9726
+ base: number;
9727
+ reward: number;
9728
+ total: number;
9729
+ };
9730
+ "30day": {
9731
+ base: number;
9732
+ reward: number;
9733
+ total: number;
9734
+ };
9735
+ "1hour": {
9736
+ base: number;
9737
+ reward: number;
9738
+ total: number;
9739
+ };
9740
+ };
9741
+ intrinsicApy: {
9631
9742
  "1day": {
9632
9743
  base: number;
9633
9744
  reward: number;
@@ -9779,6 +9890,7 @@ declare class VaultsSdk {
9779
9890
  remainingCapacity?: string;
9780
9891
  maxCapacity?: string;
9781
9892
  isCorrupted: boolean;
9893
+ userEventsIndexed: boolean;
9782
9894
  childrenVaults?: {
9783
9895
  address: string;
9784
9896
  asset: {
@@ -9836,8 +9948,30 @@ declare class VaultsSdk {
9836
9948
  severity: "info" | "warning" | "critical";
9837
9949
  endDate: number;
9838
9950
  }[];
9839
- intrinsic?: {
9840
- apy: {
9951
+ apyComposite?: {
9952
+ totalApy: {
9953
+ "1day": {
9954
+ base: number;
9955
+ reward: number;
9956
+ total: number;
9957
+ };
9958
+ "7day": {
9959
+ base: number;
9960
+ reward: number;
9961
+ total: number;
9962
+ };
9963
+ "30day": {
9964
+ base: number;
9965
+ reward: number;
9966
+ total: number;
9967
+ };
9968
+ "1hour": {
9969
+ base: number;
9970
+ reward: number;
9971
+ total: number;
9972
+ };
9973
+ };
9974
+ intrinsicApy: {
9841
9975
  "1day": {
9842
9976
  base: number;
9843
9977
  reward: number;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@vaultsfyi/sdk",
3
3
  "license": "MIT",
4
- "version": "2.1.19",
4
+ "version": "2.2.0",
5
5
  "description": "An SDK for interacting with the Vaults.fyi API",
6
6
  "main": "./dist/client.js",
7
7
  "module": "./dist/client.mjs",