@dynamic-labs/sdk-api 0.126.0 → 0.127.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api",
-  "version": "0.126.0",
+  "version": "0.127.0",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/apis/SDKApi.d.ts

@@ -747,6 +747,7 @@ export interface GetYieldEarningsRequest {
     environmentId: string;
     ownerAddress: string;
     chainId: number;
+    chainName?: ChainEnum;
 }
 export interface GetYieldVaultDetailsRequest {
     environmentId: string;
@@ -3421,22 +3422,22 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     getWalletTransactionsOptions(requestParameters: GetWalletTransactionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
-     * Returns the wallet\'s earnings across every Morpho Vault V2 position it holds on the given chain, as a per-vault breakdown plus USD totals. Morpho only aggregates 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`.
+     * 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`.
      * Get a wallet\'s earnings across all vaults on one chain
      */
     getYieldEarningsRaw(requestParameters: GetYieldEarningsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldEarnings>>;
     /**
-     * Returns the wallet\'s earnings across every Morpho Vault V2 position it holds on the given chain, as a per-vault breakdown plus USD totals. Morpho only aggregates 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`.
+     * 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`.
      * Get a wallet\'s earnings across all vaults on one chain
      */
     getYieldEarnings(requestParameters: GetYieldEarningsRequest, initOverrides?: RequestInit): Promise<YieldEarnings>;
     /**
-     * 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 Morpho data on a best-effort basis.
+     * 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.
      * Get vault details
      */
     getYieldVaultDetailsRaw(requestParameters: GetYieldVaultDetailsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultDetails>>;
     /**
-     * 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 Morpho data on a best-effort basis.
+     * 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.
      * Get vault details
      */
     getYieldVaultDetails(requestParameters: GetYieldVaultDetailsRequest, initOverrides?: RequestInit): Promise<YieldVaultDetails>;
@@ -3451,22 +3452,22 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     getYieldVaultPosition(requestParameters: GetYieldVaultPositionRequest, initOverrides?: RequestInit): Promise<YieldVaultPosition>;
     /**
-     * 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.
+     * 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.
      * Get earnings for a user position in a vault
      */
     getYieldVaultPositionPerformanceRaw(requestParameters: GetYieldVaultPositionPerformanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultPositionPerformance>>;
     /**
-     * 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.
+     * 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.
      * Get earnings for a user position in a vault
      */
     getYieldVaultPositionPerformance(requestParameters: GetYieldVaultPositionPerformanceRequest, initOverrides?: RequestInit): Promise<YieldVaultPositionPerformance>;
     /**
-     * Returns accrued Morpho rewards for the given wallet address in the specified vault. Returns an empty rewards array when none exist.
+     * 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.
      * Get user rewards in vault
      */
     getYieldVaultRewardsRaw(requestParameters: GetYieldVaultRewardsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultRewardsResponse>>;
     /**
-     * Returns accrued Morpho rewards for the given wallet address in the specified vault. Returns an empty rewards array when none exist.
+     * 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.
      * Get user rewards in vault
      */
     getYieldVaultRewards(requestParameters: GetYieldVaultRewardsRequest, initOverrides?: RequestInit): Promise<YieldVaultRewardsResponse>;
@@ -3623,12 +3624,12 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     listMfaMethodsOptions(requestParameters: ListMfaMethodsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
-     * 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 Morpho on a best-effort basis.
+     * 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.
      * List yield vaults
      */
     listYieldVaultsRaw(requestParameters: ListYieldVaultsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultListResponse>>;
     /**
-     * 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 Morpho on a best-effort basis.
+     * 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.
      * List yield vaults
      */
     listYieldVaults(requestParameters: ListYieldVaultsRequest, initOverrides?: RequestInit): Promise<YieldVaultListResponse>;
@@ -5607,12 +5608,12 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     yieldEarningsOptions(requestParameters: YieldEarningsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
-     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * 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.
      * Build a vault reward-claim signing payload
      */
     yieldVaultClaimRaw(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<YieldVaultActionResponse>>;
     /**
-     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * 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.
      * Build a vault reward-claim signing payload
      */
     yieldVaultClaim(requestParameters: YieldVaultClaimOperationRequest, initOverrides?: RequestInit): Promise<YieldVaultActionResponse>;

package/src/apis/SDKApi.js

@@ -6062,7 +6062,7 @@ class SDKApi extends BaseAPI {
         await this.getWalletTransactionsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * Returns the wallet\'s earnings across every Morpho Vault V2 position it holds on the given chain, as a per-vault breakdown plus USD totals. Morpho only aggregates 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`.
+     * 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`.
      * Get a wallet\'s earnings across all vaults on one chain
      */
     async getYieldEarningsRaw(requestParameters, initOverrides) {
@@ -6082,6 +6082,9 @@ class SDKApi extends BaseAPI {
         if (requestParameters.chainId !== undefined) {
             queryParameters['chainId'] = requestParameters.chainId;
         }
+        if (requestParameters.chainName !== undefined) {
+            queryParameters['chainName'] = requestParameters.chainName;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/sdk/{environmentId}/yield/earnings`.replace(`{${"environmentId"}}`, encodeURIComponent(String(requestParameters.environmentId))),
@@ -6092,7 +6095,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldEarningsFromJSON(jsonValue));
     }
     /**
-     * Returns the wallet\'s earnings across every Morpho Vault V2 position it holds on the given chain, as a per-vault breakdown plus USD totals. Morpho only aggregates 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`.
+     * 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`.
      * Get a wallet\'s earnings across all vaults on one chain
      */
     async getYieldEarnings(requestParameters, initOverrides) {
@@ -6100,7 +6103,7 @@ class SDKApi extends BaseAPI {
         return await response.value();
     }
     /**
-     * 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 Morpho data on a best-effort basis.
+     * 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.
      * Get vault details
      */
     async getYieldVaultDetailsRaw(requestParameters, initOverrides) {
@@ -6121,7 +6124,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultDetailsFromJSON(jsonValue));
     }
     /**
-     * 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 Morpho data on a best-effort basis.
+     * 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.
      * Get vault details
      */
     async getYieldVaultDetails(requestParameters, initOverrides) {
@@ -6164,7 +6167,7 @@ class SDKApi extends BaseAPI {
         return await response.value();
     }
     /**
-     * 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.
+     * 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.
      * Get earnings for a user position in a vault
      */
     async getYieldVaultPositionPerformanceRaw(requestParameters, initOverrides) {
@@ -6191,7 +6194,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultPositionPerformanceFromJSON(jsonValue));
     }
     /**
-     * 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.
+     * 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.
      * Get earnings for a user position in a vault
      */
     async getYieldVaultPositionPerformance(requestParameters, initOverrides) {
@@ -6199,7 +6202,7 @@ class SDKApi extends BaseAPI {
         return await response.value();
     }
     /**
-     * Returns accrued Morpho rewards for the given wallet address in the specified vault. Returns an empty rewards array when none exist.
+     * 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.
      * Get user rewards in vault
      */
     async getYieldVaultRewardsRaw(requestParameters, initOverrides) {
@@ -6226,7 +6229,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultRewardsResponseFromJSON(jsonValue));
     }
     /**
-     * Returns accrued Morpho rewards for the given wallet address in the specified vault. Returns an empty rewards array when none exist.
+     * 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.
      * Get user rewards in vault
      */
     async getYieldVaultRewards(requestParameters, initOverrides) {
@@ -6743,7 +6746,7 @@ class SDKApi extends BaseAPI {
         await this.listMfaMethodsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * 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 Morpho on a best-effort basis.
+     * 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.
      * List yield vaults
      */
     async listYieldVaultsRaw(requestParameters, initOverrides) {
@@ -6761,7 +6764,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultListResponseFromJSON(jsonValue));
     }
     /**
-     * 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 Morpho on a best-effort basis.
+     * 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.
      * List yield vaults
      */
     async listYieldVaults(requestParameters, initOverrides) {
@@ -13459,7 +13462,7 @@ class SDKApi extends BaseAPI {
         await this.yieldEarningsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * 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.
      * Build a vault reward-claim signing payload
      */
     async yieldVaultClaimRaw(requestParameters, initOverrides) {
@@ -13485,7 +13488,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => YieldVaultActionResponseFromJSON(jsonValue));
     }
     /**
-     * Builds an unsigned Merkl Distributor claim signing payload for the reward token(s) earned through this vault. Responds 422 when there is nothing to claim right now — no reward campaign for this vault, or every attributable token is already fully claimed.
+     * 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.
      * Build a vault reward-claim signing payload
      */
     async yieldVaultClaim(requestParameters, initOverrides) {

package/src/models/YieldEarnings.d.ts

@@ -17,7 +17,7 @@ import { YieldVaultEarnings } from './YieldVaultEarnings';
  */
 export interface YieldEarnings {
     /**
-     * EVM chain id the earnings were aggregated on.
+     * Chain id the earnings were aggregated on: an EVM chain id, or the Solana cluster id.
      * @type {number}
      * @memberof YieldEarnings
      */

package/src/models/YieldVaultEarnings.d.ts

@@ -22,31 +22,31 @@ export interface YieldVaultEarnings {
      */
     assets: string;
     /**
-     * Position size in USD. Null when Morpho has no price for the underlying token.
+     * Position size in USD. Null when the provider has no price for the underlying token.
      * @type {number}
      * @memberof YieldVaultEarnings
      */
     assetsUsd: number | null;
     /**
-     * Earnings on the position, in raw units of the vault's underlying token. Null while the position has too little history to compute it.
+     * Earnings on the position, in raw units of the vault's underlying token. Null while the position has too little history to compute it, or when the provider reports no earnings (Aave).
      * @type {string}
      * @memberof YieldVaultEarnings
      */
     pnl: string | null;
     /**
-     * Earnings on the position in USD. Null when Morpho has no price for the underlying token.
+     * Earnings on the position in USD. Null when the provider has no price for the underlying token, or reports no earnings (Aave).
      * @type {number}
      * @memberof YieldVaultEarnings
      */
     pnlUsd: number | null;
     /**
-     * Time-weighted, non-annualized return on equity since inception, as a decimal. Null while the position has too little history to compute it.
+     * Time-weighted, non-annualized return on equity since inception, as a decimal. Null while the position has too little history to compute it, or when the provider reports none (Aave, Kamino).
      * @type {number}
      * @memberof YieldVaultEarnings
      */
     roe: number | null;
     /**
-     * Vault contract address as reported by Morpho.
+     * Vault address as reported by the provider.
      * @type {string}
      * @memberof YieldVaultEarnings
      */

package/src/models/YieldVaultPositionPerformance.d.ts

@@ -28,7 +28,7 @@ export interface YieldVaultPositionPerformance {
      */
     ownerAddress: string;
     /**
-     * Time-weighted, non-annualized return on capital since inception, as a decimal. Null while the position has too little history to compute it.
+     * Time-weighted, non-annualized return on capital since inception, as a decimal. Null while the position has too little history to compute it, or when the provider reports none (Kamino).
      * @type {number}
      * @memberof YieldVaultPositionPerformance
      */