@dynamic-labs/sdk-api-core 0.125.0 → 0.127.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.
- package/package.json +1 -1
- package/src/apis/SDKApi.d.ts +13 -12
- package/src/apis/SDKApi.js +15 -12
- package/src/apis/SDKApi.js.map +1 -1
- package/src/models/YieldEarnings.d.ts +1 -1
- package/src/models/YieldVaultEarnings.d.ts +5 -5
- package/src/models/YieldVaultPositionPerformance.d.ts +1 -1
- package/src/version.js +1 -1
package/package.json
CHANGED
package/src/apis/SDKApi.d.ts
CHANGED
|
@@ -742,6 +742,7 @@ export interface GetYieldEarningsRequest {
|
|
|
742
742
|
environmentId: string;
|
|
743
743
|
ownerAddress: string;
|
|
744
744
|
chainId: number;
|
|
745
|
+
chainName?: ChainEnum;
|
|
745
746
|
}
|
|
746
747
|
export interface GetYieldVaultDetailsRequest {
|
|
747
748
|
environmentId: string;
|
|
@@ -3388,22 +3389,22 @@ export declare class SDKApi extends runtime.BaseAPI {
|
|
|
3388
3389
|
*/
|
|
3389
3390
|
getWalletTransactionsOptions(requestParameters: GetWalletTransactionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
|
|
3390
3391
|
/**
|
|
3391
|
-
* Returns the wallet\'s earnings across every
|
|
3392
|
+
* Returns the wallet\'s earnings across every yield-vault position it holds on the given chain, as a per-vault breakdown plus USD totals. `chainName` selects the chain family — `EVM` covers Morpho and Aave vaults, `SOL` covers Kamino vaults — and defaults to `EVM`; `chainId` selects the chain within it. Providers only aggregate within a single chain, so `chainId` is required. Totals are USD-denominated because each vault\'s earnings are expressed in its own underlying asset and are therefore not additive. Positions in vaults this environment does not offer are still included, with a null `vaultId`. Aave reports no earnings, so its positions carry null `pnl`, `pnlUsd` and `roe`; Kamino reports no time-weighted return, so its positions carry a null `roe`.
|
|
3392
3393
|
* Get a wallet\'s earnings across all vaults on one chain
|
|
3393
3394
|
*/
|
|
3394
3395
|
getYieldEarningsRaw(requestParameters: GetYieldEarningsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldEarnings>>;
|
|
3395
3396
|
/**
|
|
3396
|
-
* Returns the wallet\'s earnings across every
|
|
3397
|
+
* Returns the wallet\'s earnings across every yield-vault position it holds on the given chain, as a per-vault breakdown plus USD totals. `chainName` selects the chain family — `EVM` covers Morpho and Aave vaults, `SOL` covers Kamino vaults — and defaults to `EVM`; `chainId` selects the chain within it. Providers only aggregate within a single chain, so `chainId` is required. Totals are USD-denominated because each vault\'s earnings are expressed in its own underlying asset and are therefore not additive. Positions in vaults this environment does not offer are still included, with a null `vaultId`. Aave reports no earnings, so its positions carry null `pnl`, `pnlUsd` and `roe`; Kamino reports no time-weighted return, so its positions carry a null `roe`.
|
|
3397
3398
|
* Get a wallet\'s earnings across all vaults on one chain
|
|
3398
3399
|
*/
|
|
3399
3400
|
getYieldEarnings(requestParameters: GetYieldEarningsRequest, initOverrides?: RequestInit): Promise<YieldEarnings>;
|
|
3400
3401
|
/**
|
|
3401
|
-
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live
|
|
3402
|
+
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live data from the vault\'s provider on a best-effort basis.
|
|
3402
3403
|
* Get vault details
|
|
3403
3404
|
*/
|
|
3404
3405
|
getYieldVaultDetailsRaw(requestParameters: GetYieldVaultDetailsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultDetails>>;
|
|
3405
3406
|
/**
|
|
3406
|
-
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live
|
|
3407
|
+
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live data from the vault\'s provider on a best-effort basis.
|
|
3407
3408
|
* Get vault details
|
|
3408
3409
|
*/
|
|
3409
3410
|
getYieldVaultDetails(requestParameters: GetYieldVaultDetailsRequest, initOverrides?: RequestInit): Promise<YieldVaultDetails>;
|
|
@@ -3418,22 +3419,22 @@ export declare class SDKApi extends runtime.BaseAPI {
|
|
|
3418
3419
|
*/
|
|
3419
3420
|
getYieldVaultPosition(requestParameters: GetYieldVaultPositionRequest, initOverrides?: RequestInit): Promise<YieldVaultPosition>;
|
|
3420
3421
|
/**
|
|
3421
|
-
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by Morpho. Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now.
|
|
3422
|
+
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by the vault\'s provider (Morpho and Kamino). Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now. Kamino does not report a time-weighted return, so `returnOnCapital` is always null for Kamino vaults. Responds 400 for Aave vaults, which report no earnings.
|
|
3422
3423
|
* Get earnings for a user position in a vault
|
|
3423
3424
|
*/
|
|
3424
3425
|
getYieldVaultPositionPerformanceRaw(requestParameters: GetYieldVaultPositionPerformanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultPositionPerformance>>;
|
|
3425
3426
|
/**
|
|
3426
|
-
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by Morpho. Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now.
|
|
3427
|
+
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by the vault\'s provider (Morpho and Kamino). Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now. Kamino does not report a time-weighted return, so `returnOnCapital` is always null for Kamino vaults. Responds 400 for Aave vaults, which report no earnings.
|
|
3427
3428
|
* Get earnings for a user position in a vault
|
|
3428
3429
|
*/
|
|
3429
3430
|
getYieldVaultPositionPerformance(requestParameters: GetYieldVaultPositionPerformanceRequest, initOverrides?: RequestInit): Promise<YieldVaultPositionPerformance>;
|
|
3430
3431
|
/**
|
|
3431
|
-
* Returns accrued
|
|
3432
|
+
* Returns accrued rewards for the given wallet address in the specified vault: Merkl campaign rewards for Morpho vaults and farm rewards for Kamino vaults. Returns an empty rewards array when none exist. Responds 400 for Aave vaults, which have no rewards.
|
|
3432
3433
|
* Get user rewards in vault
|
|
3433
3434
|
*/
|
|
3434
3435
|
getYieldVaultRewardsRaw(requestParameters: GetYieldVaultRewardsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultRewardsResponse>>;
|
|
3435
3436
|
/**
|
|
3436
|
-
* Returns accrued
|
|
3437
|
+
* Returns accrued rewards for the given wallet address in the specified vault: Merkl campaign rewards for Morpho vaults and farm rewards for Kamino vaults. Returns an empty rewards array when none exist. Responds 400 for Aave vaults, which have no rewards.
|
|
3437
3438
|
* Get user rewards in vault
|
|
3438
3439
|
*/
|
|
3439
3440
|
getYieldVaultRewards(requestParameters: GetYieldVaultRewardsRequest, initOverrides?: RequestInit): Promise<YieldVaultRewardsResponse>;
|
|
@@ -3590,12 +3591,12 @@ export declare class SDKApi extends runtime.BaseAPI {
|
|
|
3590
3591
|
*/
|
|
3591
3592
|
listMfaMethodsOptions(requestParameters: ListMfaMethodsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
|
|
3592
3593
|
/**
|
|
3593
|
-
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from
|
|
3594
|
+
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from its provider on a best-effort basis.
|
|
3594
3595
|
* List yield vaults
|
|
3595
3596
|
*/
|
|
3596
3597
|
listYieldVaultsRaw(requestParameters: ListYieldVaultsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultListResponse>>;
|
|
3597
3598
|
/**
|
|
3598
|
-
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from
|
|
3599
|
+
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from its provider on a best-effort basis.
|
|
3599
3600
|
* List yield vaults
|
|
3600
3601
|
*/
|
|
3601
3602
|
listYieldVaults(requestParameters: ListYieldVaultsRequest, initOverrides?: RequestInit): Promise<YieldVaultListResponse>;
|
|
@@ -5574,12 +5575,12 @@ export declare class SDKApi extends runtime.BaseAPI {
|
|
|
5574
5575
|
*/
|
|
5575
5576
|
yieldEarningsOptions(requestParameters: YieldEarningsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
|
|
5576
5577
|
/**
|
|
5577
|
-
* Builds an unsigned
|
|
5578
|
+
* Builds an unsigned claim signing payload for the reward token(s) earned through this vault: a Merkl Distributor claim for Morpho vaults, or an ordered sequence of Solana transactions, one per reward farm, for Kamino vaults. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed. Responds 400 for Aave vaults, which have no rewards.
|
|
5578
5579
|
* Build a vault reward-claim signing payload
|
|
5579
5580
|
*/
|
|
5580
5581
|
yieldVaultClaimRaw(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultActionResponse>>;
|
|
5581
5582
|
/**
|
|
5582
|
-
* Builds an unsigned
|
|
5583
|
+
* Builds an unsigned claim signing payload for the reward token(s) earned through this vault: a Merkl Distributor claim for Morpho vaults, or an ordered sequence of Solana transactions, one per reward farm, for Kamino vaults. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed. Responds 400 for Aave vaults, which have no rewards.
|
|
5583
5584
|
* Build a vault reward-claim signing payload
|
|
5584
5585
|
*/
|
|
5585
5586
|
yieldVaultClaim(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<YieldVaultActionResponse>;
|
package/src/apis/SDKApi.js
CHANGED
|
@@ -5921,7 +5921,7 @@ class SDKApi extends BaseAPI {
|
|
|
5921
5921
|
await this.getWalletTransactionsOptionsRaw(requestParameters, initOverrides);
|
|
5922
5922
|
}
|
|
5923
5923
|
/**
|
|
5924
|
-
* Returns the wallet\'s earnings across every
|
|
5924
|
+
* Returns the wallet\'s earnings across every yield-vault position it holds on the given chain, as a per-vault breakdown plus USD totals. `chainName` selects the chain family — `EVM` covers Morpho and Aave vaults, `SOL` covers Kamino vaults — and defaults to `EVM`; `chainId` selects the chain within it. Providers only aggregate within a single chain, so `chainId` is required. Totals are USD-denominated because each vault\'s earnings are expressed in its own underlying asset and are therefore not additive. Positions in vaults this environment does not offer are still included, with a null `vaultId`. Aave reports no earnings, so its positions carry null `pnl`, `pnlUsd` and `roe`; Kamino reports no time-weighted return, so its positions carry a null `roe`.
|
|
5925
5925
|
* Get a wallet\'s earnings across all vaults on one chain
|
|
5926
5926
|
*/
|
|
5927
5927
|
async getYieldEarningsRaw(requestParameters, initOverrides) {
|
|
@@ -5941,6 +5941,9 @@ class SDKApi extends BaseAPI {
|
|
|
5941
5941
|
if (requestParameters.chainId !== undefined) {
|
|
5942
5942
|
queryParameters['chainId'] = requestParameters.chainId;
|
|
5943
5943
|
}
|
|
5944
|
+
if (requestParameters.chainName !== undefined) {
|
|
5945
|
+
queryParameters['chainName'] = requestParameters.chainName;
|
|
5946
|
+
}
|
|
5944
5947
|
const headerParameters = {};
|
|
5945
5948
|
const response = await this.request({
|
|
5946
5949
|
path: `/sdk/{environmentId}/yield/earnings`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))),
|
|
@@ -5951,7 +5954,7 @@ class SDKApi extends BaseAPI {
|
|
|
5951
5954
|
return new JSONApiResponse(response, (jsonValue) => YieldEarningsFromJSON(jsonValue));
|
|
5952
5955
|
}
|
|
5953
5956
|
/**
|
|
5954
|
-
* Returns the wallet\'s earnings across every
|
|
5957
|
+
* Returns the wallet\'s earnings across every yield-vault position it holds on the given chain, as a per-vault breakdown plus USD totals. `chainName` selects the chain family — `EVM` covers Morpho and Aave vaults, `SOL` covers Kamino vaults — and defaults to `EVM`; `chainId` selects the chain within it. Providers only aggregate within a single chain, so `chainId` is required. Totals are USD-denominated because each vault\'s earnings are expressed in its own underlying asset and are therefore not additive. Positions in vaults this environment does not offer are still included, with a null `vaultId`. Aave reports no earnings, so its positions carry null `pnl`, `pnlUsd` and `roe`; Kamino reports no time-weighted return, so its positions carry a null `roe`.
|
|
5955
5958
|
* Get a wallet\'s earnings across all vaults on one chain
|
|
5956
5959
|
*/
|
|
5957
5960
|
async getYieldEarnings(requestParameters, initOverrides) {
|
|
@@ -5959,7 +5962,7 @@ class SDKApi extends BaseAPI {
|
|
|
5959
5962
|
return await response.value();
|
|
5960
5963
|
}
|
|
5961
5964
|
/**
|
|
5962
|
-
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live
|
|
5965
|
+
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live data from the vault\'s provider on a best-effort basis.
|
|
5963
5966
|
* Get vault details
|
|
5964
5967
|
*/
|
|
5965
5968
|
async getYieldVaultDetailsRaw(requestParameters, initOverrides) {
|
|
@@ -5980,7 +5983,7 @@ class SDKApi extends BaseAPI {
|
|
|
5980
5983
|
return new JSONApiResponse(response, (jsonValue) => YieldVaultDetailsFromJSON(jsonValue));
|
|
5981
5984
|
}
|
|
5982
5985
|
/**
|
|
5983
|
-
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live
|
|
5986
|
+
* Returns full details for a single vault identified by its opaque vaultId. Vault must be accessible to the environment (public or org-private match). Enriched with live data from the vault\'s provider on a best-effort basis.
|
|
5984
5987
|
* Get vault details
|
|
5985
5988
|
*/
|
|
5986
5989
|
async getYieldVaultDetails(requestParameters, initOverrides) {
|
|
@@ -6023,7 +6026,7 @@ class SDKApi extends BaseAPI {
|
|
|
6023
6026
|
return await response.value();
|
|
6024
6027
|
}
|
|
6025
6028
|
/**
|
|
6026
|
-
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by Morpho. Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now.
|
|
6029
|
+
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by the vault\'s provider (Morpho and Kamino). Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now. Kamino does not report a time-weighted return, so `returnOnCapital` is always null for Kamino vaults. Responds 400 for Aave vaults, which report no earnings.
|
|
6027
6030
|
* Get earnings for a user position in a vault
|
|
6028
6031
|
*/
|
|
6029
6032
|
async getYieldVaultPositionPerformanceRaw(requestParameters, initOverrides) {
|
|
@@ -6050,7 +6053,7 @@ class SDKApi extends BaseAPI {
|
|
|
6050
6053
|
return new JSONApiResponse(response, (jsonValue) => YieldVaultPositionPerformanceFromJSON(jsonValue));
|
|
6051
6054
|
}
|
|
6052
6055
|
/**
|
|
6053
|
-
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by Morpho. Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now.
|
|
6056
|
+
* Returns net earnings and return on capital for the given wallet address in the specified vault, as indexed by the vault\'s provider (Morpho and Kamino). Indexed figures trail the chain head, so the balances from the position endpoint remain the live source of truth for what a position is worth now. Kamino does not report a time-weighted return, so `returnOnCapital` is always null for Kamino vaults. Responds 400 for Aave vaults, which report no earnings.
|
|
6054
6057
|
* Get earnings for a user position in a vault
|
|
6055
6058
|
*/
|
|
6056
6059
|
async getYieldVaultPositionPerformance(requestParameters, initOverrides) {
|
|
@@ -6058,7 +6061,7 @@ class SDKApi extends BaseAPI {
|
|
|
6058
6061
|
return await response.value();
|
|
6059
6062
|
}
|
|
6060
6063
|
/**
|
|
6061
|
-
* Returns accrued
|
|
6064
|
+
* Returns accrued rewards for the given wallet address in the specified vault: Merkl campaign rewards for Morpho vaults and farm rewards for Kamino vaults. Returns an empty rewards array when none exist. Responds 400 for Aave vaults, which have no rewards.
|
|
6062
6065
|
* Get user rewards in vault
|
|
6063
6066
|
*/
|
|
6064
6067
|
async getYieldVaultRewardsRaw(requestParameters, initOverrides) {
|
|
@@ -6085,7 +6088,7 @@ class SDKApi extends BaseAPI {
|
|
|
6085
6088
|
return new JSONApiResponse(response, (jsonValue) => YieldVaultRewardsResponseFromJSON(jsonValue));
|
|
6086
6089
|
}
|
|
6087
6090
|
/**
|
|
6088
|
-
* Returns accrued
|
|
6091
|
+
* Returns accrued rewards for the given wallet address in the specified vault: Merkl campaign rewards for Morpho vaults and farm rewards for Kamino vaults. Returns an empty rewards array when none exist. Responds 400 for Aave vaults, which have no rewards.
|
|
6089
6092
|
* Get user rewards in vault
|
|
6090
6093
|
*/
|
|
6091
6094
|
async getYieldVaultRewards(requestParameters, initOverrides) {
|
|
@@ -6602,7 +6605,7 @@ class SDKApi extends BaseAPI {
|
|
|
6602
6605
|
await this.listMfaMethodsOptionsRaw(requestParameters, initOverrides);
|
|
6603
6606
|
}
|
|
6604
6607
|
/**
|
|
6605
|
-
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from
|
|
6608
|
+
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from its provider on a best-effort basis.
|
|
6606
6609
|
* List yield vaults
|
|
6607
6610
|
*/
|
|
6608
6611
|
async listYieldVaultsRaw(requestParameters, initOverrides) {
|
|
@@ -6620,7 +6623,7 @@ class SDKApi extends BaseAPI {
|
|
|
6620
6623
|
return new JSONApiResponse(response, (jsonValue) => YieldVaultListResponseFromJSON(jsonValue));
|
|
6621
6624
|
}
|
|
6622
6625
|
/**
|
|
6623
|
-
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from
|
|
6626
|
+
* Returns the yield vaults available to this environment. Public vaults (project_environment_id IS NULL) are included for every caller; private vaults are included only for the matching environment. Each vault is enriched with live net APY and TVL from its provider on a best-effort basis.
|
|
6624
6627
|
* List yield vaults
|
|
6625
6628
|
*/
|
|
6626
6629
|
async listYieldVaults(requestParameters, initOverrides) {
|
|
@@ -13318,7 +13321,7 @@ class SDKApi extends BaseAPI {
|
|
|
13318
13321
|
await this.yieldEarningsOptionsRaw(requestParameters, initOverrides);
|
|
13319
13322
|
}
|
|
13320
13323
|
/**
|
|
13321
|
-
* Builds an unsigned
|
|
13324
|
+
* Builds an unsigned claim signing payload for the reward token(s) earned through this vault: a Merkl Distributor claim for Morpho vaults, or an ordered sequence of Solana transactions, one per reward farm, for Kamino vaults. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed. Responds 400 for Aave vaults, which have no rewards.
|
|
13322
13325
|
* Build a vault reward-claim signing payload
|
|
13323
13326
|
*/
|
|
13324
13327
|
async yieldVaultClaimRaw(requestParameters, initOverrides) {
|
|
@@ -13344,7 +13347,7 @@ class SDKApi extends BaseAPI {
|
|
|
13344
13347
|
return new JSONApiResponse(response, (jsonValue) => YieldVaultActionResponseFromJSON(jsonValue));
|
|
13345
13348
|
}
|
|
13346
13349
|
/**
|
|
13347
|
-
* Builds an unsigned
|
|
13350
|
+
* Builds an unsigned claim signing payload for the reward token(s) earned through this vault: a Merkl Distributor claim for Morpho vaults, or an ordered sequence of Solana transactions, one per reward farm, for Kamino vaults. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed. Responds 400 for Aave vaults, which have no rewards.
|
|
13348
13351
|
* Build a vault reward-claim signing payload
|
|
13349
13352
|
*/
|
|
13350
13353
|
async yieldVaultClaim(requestParameters, initOverrides) {
|