feat: schema changes

packages/api-hooks/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@stakekit/api-hooks",
 	"description": "React hooks for StakeKit API",
-	"version": "0.0.109",
+	"version": "0.0.110",
 	"type": "module",
 	"types": "./dist/index.d.ts",
 	"main": "./dist/index.js",

packages/api-hooks/src/api/schemas/adaDetailsViewDto.ts

@@ -0,0 +1,5 @@
+export interface AdaDetailsViewDto {
+  activationDate: string;
+  activationEpoch: number;
+  poolId: string;
+}

packages/api-hooks/src/api/schemas/cosmosDetailsViewDto.ts

@@ -0,0 +1,11 @@
+export interface CosmosDetailsViewDto {
+  available_rewards: number;
+  balance: number;
+  delegated_at?: string;
+  delegator_address: string;
+  net_apy: number;
+  rewards: number;
+  undelegated_at?: string;
+  updated_at: string;
+  validator_address: string;
+}

packages/api-hooks/src/api/schemas/ethDeFiDetailsViewDto.ts

@@ -0,0 +1,4 @@
+export interface EthDeFiDetailsViewDto {
+  contract_address: string;
+  type?: string;
+}

packages/api-hooks/src/api/schemas/ethNativeDetailsViewDto.ts

@@ -0,0 +1,14 @@
+export interface EthNativeDetailsViewDto {
+  /** The total rewards earned from validating blocks and participating in consensus, represented in wei. */
+  consensus_rewards: string;
+  /** The Ethereum address that initiated the deposit transaction to the staking contract. This indicates the source of the staked ETH. */
+  deposit_tx_sender?: string;
+  /** The Ethereum address that will receive execution layer rewards, including transaction fees and Maximal Extractable Value (MEV). */
+  execution_fee_recipient?: string;
+  /** The total execution layer rewards earned from transaction fees and MEV, represented in wei. */
+  execution_rewards: string;
+  /** The Ethereum address of the validator. */
+  validator_address: string;
+  /** The withdrawal credentials for accessing staked ETH and rewards. This can be a BLS public key or an Ethereum address. */
+  withdrawal_credentials?: string;
+}

packages/api-hooks/src/api/schemas/evmNetworks.ts

@@ -31,4 +31,5 @@ export const EvmNetworks = {
   core: 'core',
   sonic: 'sonic',
   katana: 'katana',
+  hyperevm: 'hyperevm',
 } as const;

packages/api-hooks/src/api/schemas/failureViewDto.ts

@@ -0,0 +1,10 @@
+import type { FailureViewDtoDetails } from './failureViewDtoDetails';
+
+export interface FailureViewDto {
+  /** The error code */
+  code: number;
+  /** The error details */
+  details: FailureViewDtoDetails;
+  /** The error reason */
+  reason: string;
+}

packages/api-hooks/src/api/schemas/failureViewDtoDetails.ts

@@ -0,0 +1,4 @@
+/**
+ * The error details
+ */
+export type FailureViewDtoDetails = { [key: string]: any };

packages/api-hooks/src/api/schemas/index.ts

@@ -15,6 +15,7 @@ export * from './actionRequestDto';
 export * from './actionStatus';
 export * from './actionTypes';
 export * from './actionWithLivePriceDto';
+export * from './adaDetailsViewDto';
 export * from './addressArgumentsDto';
 export * from './addressWithTokenDto';
 export * from './addressWithTokenDtoAdditionalAddresses';
@@ -43,6 +44,7 @@ export * from './confirmUserMeDto';
 export * from './constructTransactionRequestDto';
 export * from './constructTransactionRequestDtoGasArgs';
 export * from './cosmosAdditionalAddressesDto';
+export * from './cosmosDetailsViewDto';
 export * from './cosmosGasArgsDto';
 export * from './createBannedRegionDto';
 export * from './createCustomUriDto';
@@ -75,11 +77,15 @@ export * from './deleteMasterBannedRegionsDto';
 export * from './durationArgumentOptionsDto';
 export * from './eRCStandards';
 export * from './enabledYieldDto';
+export * from './ethDeFiDetailsViewDto';
+export * from './ethNativeDetailsViewDto';
 export * from './evmEIP1559GasArgsDto';
 export * from './evmEIP1559GasArgsDtoType';
 export * from './evmLegacyGasArgsDto';
 export * from './evmLegacyGasArgsDtoType';
 export * from './evmNetworks';
+export * from './failureViewDto';
+export * from './failureViewDtoDetails';
 export * from './feeConfigurationDto';
 export * from './feeConfigurationStatus';
 export * from './feeConfigurationWithApyDto';
@@ -99,17 +105,22 @@ export * from './healthStatus';
 export * from './healthStatusDto';
 export * from './infinityPaginatedDto';
 export * from './infinityPaginatedDtoDataItem';
+export * from './injectiveDetailsViewDto';
+export * from './interestViewDto';
 export * from './invalidRequestDto';
 export * from './key';
 export * from './keyCategory';
+export * from './kilnEthereumPoolingDetailsViewDto';
 export * from './masterBannedRegionDto';
 export * from './masterBannedRegionDtoTagsItem';
 export * from './masterBannedYieldDto';
 export * from './masterBannedYieldDtoTagsItem';
+export * from './nearDetailsViewDto';
 export * from './networks';
 export * from './notFoundDto';
 export * from './oAVResponseDto';
 export * from './oAVStrategyDto';
+export * from './osmosisDetailsViewDto';
 export * from './payoutAddressDto';
 export * from './pendingActionArgumentsDto';
 export * from './pendingActionConstraintAmountDto';
@@ -149,10 +160,19 @@ export * from './role';
 export * from './serverErrorDto';
 export * from './signatureVerificationArgumentsDto';
 export * from './solanaAdditionalAddressesDto';
+export * from './solanaDetailsViewDto';
+export * from './stakeFailureDto';
 export * from './stakeKitErrorDto';
 export * from './stakeKitErrorDtoDetails';
+export * from './stakeKitStakeDetailsViewDto';
+export * from './stakeKitVaultDetailsViewDto';
 export * from './stakeResponseDto';
 export * from './stakeResponseDtoStake';
+export * from './stakeViewSuccessDto';
+export * from './stakeViewSuccessDtoCommission';
+export * from './stakeViewSuccessDtoDetails';
+export * from './stakeViewSuccessDtoRewardsItem';
+export * from './stakeViewSuccessDtoStatus';
 export * from './structuredTransactionTronDto';
 export * from './structuredTransactionTronDtoVotesItem';
 export * from './submitHashRequestDto';
@@ -165,6 +185,7 @@ export * from './teamDto';
 export * from './teamDtoContactDetails';
 export * from './teamType';
 export * from './tezosAdditionalAddressesDto';
+export * from './tezosDetailsViewDto';
 export * from './timePeriodDto';
 export * from './tokenBalanceScanDto';
 export * from './tokenBalanceScanResponseDto';

packages/api-hooks/src/api/schemas/injectiveDetailsViewDto.ts

@@ -0,0 +1,11 @@
+export interface InjectiveDetailsViewDto {
+  available_rewards: number;
+  balance: number;
+  delegated_at?: string;
+  delegator_address: string;
+  net_apy: number;
+  rewards: number;
+  undelegated_at?: string;
+  updated_at: string;
+  validator_address: string;
+}

packages/api-hooks/src/api/schemas/interestViewDto.ts

@@ -0,0 +1,6 @@
+export interface InterestViewDto {
+  /** The type of interest - APY */
+  type: string;
+  /** The Net APY interest rate. Interest user is getting from their staking position. Not the protocol's APY. */
+  value: string;
+}

packages/api-hooks/src/api/schemas/kilnEthereumPoolingDetailsViewDto.ts

@@ -0,0 +1,5 @@
+export interface KilnEthereumPoolingDetailsViewDto {
+  delegated_at: string;
+  delegated_block: number;
+  owner: string;
+}

packages/api-hooks/src/api/schemas/nearDetailsViewDto.ts

@@ -0,0 +1,9 @@
+export interface NearDetailsViewDto {
+  activatedAt: string;
+  activatedEpoch: number;
+  canWithdraw: boolean;
+  netApy: number;
+  stakeAccount: string;
+  updatedAt: string;
+  validator: string;
+}

packages/api-hooks/src/api/schemas/networks.ts

@@ -34,6 +34,7 @@ export const Networks = {
   core: 'core',
   sonic: 'sonic',
   katana: 'katana',
+  hyperevm: 'hyperevm',
   agoric: 'agoric',
   akash: 'akash',
   axelar: 'axelar',

packages/api-hooks/src/api/schemas/osmosisDetailsViewDto.ts

@@ -0,0 +1,8 @@
+export interface OsmosisDetailsViewDto {
+  available_rewards: number;
+  balance: number;
+  delegator_address: string;
+  net_apy: number;
+  rewards: number;
+  updated_at: string;
+}

packages/api-hooks/src/api/schemas/solanaDetailsViewDto.ts

@@ -0,0 +1,10 @@
+export interface SolanaDetailsViewDto {
+  activated_at: string;
+  activated_epoch: number;
+  balance: number;
+  net_apy: number;
+  stake_account: string;
+  updated_at: string;
+  validator_address: string;
+  withdraw_pubkey: string;
+}

packages/api-hooks/src/api/schemas/stakeFailureDto.ts

@@ -0,0 +1,5 @@
+import type { FailureViewDto } from './failureViewDto';
+
+export interface StakeFailureDto {
+  error: FailureViewDto;
+}

packages/api-hooks/src/api/schemas/stakeKitStakeDetailsViewDto.ts

@@ -0,0 +1,16 @@
+export interface StakeKitStakeDetailsViewDto {
+  /** Total current stake balance. */
+  balance: number;
+  /** Net annual percentage yield. */
+  net_apy: number;
+  /** Total stake rewards. */
+  rewards: number;
+  /** The symbol of the token held by the user. */
+  symbol: string;
+  /** The address of the validator the user delegated assets to. */
+  validator?: string;
+  /** Array of validator addresses (for multi-validator integrations like TRON). */
+  validators?: string[];
+  /** Stakekit Integration ID. */
+  yield_id: string;
+}

packages/api-hooks/src/api/schemas/stakeKitVaultDetailsViewDto.ts

@@ -0,0 +1,14 @@
+export interface StakeKitVaultDetailsViewDto {
+  /** The URL pointing to the asset's icon in PNG format. */
+  asset_icon: string;
+  /** Address of the token held in the user's wallet. */
+  contract_address: string;
+  /** The name of the protocol. */
+  protocol: string;
+  /** The name of the protocol to display. */
+  protocol_display_name: string;
+  /** The URL pointing to the protocol's icon in PNG format. */
+  protocol_icon: string;
+  /** The symbol of the asset held in the user's wallet. */
+  shared_symbol: string;
+}

packages/api-hooks/src/api/schemas/stakeResponseDto.ts

@@ -3,5 +3,6 @@ import type { StakeResponseDtoStake } from './stakeResponseDtoStake';
 
 export interface StakeResponseDto {
   id: WalletViewDto;
+  /** Stake information */
   stake: StakeResponseDtoStake;
 }

packages/api-hooks/src/api/schemas/stakeResponseDtoStake.ts

@@ -1 +1,7 @@
-export type StakeResponseDtoStake = { [key: string]: any };
+import type { StakeViewSuccessDto } from './stakeViewSuccessDto';
+import type { StakeFailureDto } from './stakeFailureDto';
+
+/**
+ * Stake information
+ */
+export type StakeResponseDtoStake = StakeViewSuccessDto | StakeFailureDto;

packages/api-hooks/src/api/schemas/stakeViewSuccessDto.ts

@@ -0,0 +1,28 @@
+import type { StakeViewSuccessDtoCommission } from './stakeViewSuccessDtoCommission';
+import type { StakeViewSuccessDtoDetails } from './stakeViewSuccessDtoDetails';
+import type { InterestViewDto } from './interestViewDto';
+import type { StakeViewSuccessDtoRewardsItem } from './stakeViewSuccessDtoRewardsItem';
+import type { StakeViewSuccessDtoStatus } from './stakeViewSuccessDtoStatus';
+
+export interface StakeViewSuccessDto {
+  /** The commission type */
+  commission: StakeViewSuccessDtoCommission;
+  /** The currency of the staked asset in Ledger's crypto currency ID */
+  currency: string;
+  /** Details view */
+  details: StakeViewSuccessDtoDetails;
+  /** The interest rate */
+  interest: InterestViewDto;
+  /** The logo of the protocol (path to logo in .svg format) */
+  logo?: string;
+  /** The name of the protocol */
+  protocol_name: string;
+  /** Rewards information */
+  rewards: StakeViewSuccessDtoRewardsItem[];
+  /** The date when the stake was created */
+  since?: string;
+  /** The staked balance, denominated in the smallest unit of the currency (e.g., wei for ETH). */
+  staked_balance: string;
+  /** The status of the stake */
+  status: StakeViewSuccessDtoStatus;
+}

packages/api-hooks/src/api/schemas/stakeViewSuccessDtoCommission.ts

@@ -0,0 +1,10 @@
+/**
+ * The commission type
+ */
+export type StakeViewSuccessDtoCommission =
+  (typeof StakeViewSuccessDtoCommission)[keyof typeof StakeViewSuccessDtoCommission];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const StakeViewSuccessDtoCommission = {
+  Net: 'Net',
+} as const;

packages/api-hooks/src/api/schemas/stakeViewSuccessDtoDetails.ts

@@ -0,0 +1,29 @@
+import type { EthDeFiDetailsViewDto } from './ethDeFiDetailsViewDto';
+import type { AdaDetailsViewDto } from './adaDetailsViewDto';
+import type { CosmosDetailsViewDto } from './cosmosDetailsViewDto';
+import type { EthNativeDetailsViewDto } from './ethNativeDetailsViewDto';
+import type { InjectiveDetailsViewDto } from './injectiveDetailsViewDto';
+import type { KilnEthereumPoolingDetailsViewDto } from './kilnEthereumPoolingDetailsViewDto';
+import type { NearDetailsViewDto } from './nearDetailsViewDto';
+import type { OsmosisDetailsViewDto } from './osmosisDetailsViewDto';
+import type { SolanaDetailsViewDto } from './solanaDetailsViewDto';
+import type { StakeKitStakeDetailsViewDto } from './stakeKitStakeDetailsViewDto';
+import type { StakeKitVaultDetailsViewDto } from './stakeKitVaultDetailsViewDto';
+import type { TezosDetailsViewDto } from './tezosDetailsViewDto';
+
+/**
+ * Details view
+ */
+export type StakeViewSuccessDtoDetails =
+  | EthDeFiDetailsViewDto
+  | AdaDetailsViewDto
+  | CosmosDetailsViewDto
+  | EthNativeDetailsViewDto
+  | InjectiveDetailsViewDto
+  | KilnEthereumPoolingDetailsViewDto
+  | NearDetailsViewDto
+  | OsmosisDetailsViewDto
+  | SolanaDetailsViewDto
+  | StakeKitStakeDetailsViewDto
+  | StakeKitVaultDetailsViewDto
+  | TezosDetailsViewDto;

packages/api-hooks/src/api/schemas/stakeViewSuccessDtoRewardsItem.ts

@@ -0,0 +1 @@
+export type StakeViewSuccessDtoRewardsItem = { [key: string]: any };

packages/api-hooks/src/api/schemas/stakeViewSuccessDtoStatus.ts

@@ -0,0 +1,14 @@
+/**
+ * The status of the stake
+ */
+export type StakeViewSuccessDtoStatus =
+  (typeof StakeViewSuccessDtoStatus)[keyof typeof StakeViewSuccessDtoStatus];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const StakeViewSuccessDtoStatus = {
+  activated: 'activated',
+  activating: 'activating',
+  archived: 'archived',
+  deactivated: 'deactivated',
+  deactivating: 'deactivating',
+} as const;

packages/api-hooks/src/api/schemas/tezosDetailsViewDto.ts

@@ -0,0 +1,13 @@
+export interface TezosDetailsViewDto {
+  activated_at?: string;
+  activated_cycle?: number;
+  backer_address: string;
+  balance: number;
+  delegated_at?: string;
+  delegated_block?: number;
+  delegated_cycle: number;
+  gross_apy: number;
+  rewards: number;
+  stake_address: string;
+  updated_at: string;
+}

packages/api-hooks/src/api/schemas/yieldProviders.ts

@@ -44,4 +44,12 @@ export const YieldProviders = {
   blend: 'blend',
   synthetix: 'synthetix',
   euler: 'euler',
+  maple: 'maple',
+  sky: 'sky',
+  'yo-protocol': 'yo-protocol',
+  meria: 'meria',
+  stakin: 'stakin',
+  globalstake: 'globalstake',
+  simplystaking: 'simplystaking',
+  coinbase: 'coinbase',
 } as const;

packages/api-hooks/src/api/schemas/yieldV2YieldsNetwork.ts

@@ -32,6 +32,7 @@ export const YieldV2YieldsNetwork = {
   core: 'core',
   sonic: 'sonic',
   katana: 'katana',
+  hyperevm: 'hyperevm',
   agoric: 'agoric',
   akash: 'akash',
   axelar: 'axelar',