@privy-io/api-types 0.16.0 → 0.18.0

package/src/resources/{wallet-actions.ts → wallets/actions.ts}

@@ -1,9 +1,78 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import * as WalletsAPI from './wallets/wallets';
+import { APIResource } from '../../core/resource';
+import * as WalletsAPI from './wallets';
 
-export class WalletActions extends APIResource {}
+export class Actions extends APIResource {}
+
+/**
+ * Vault details for an Aave earn vault, including fee visibility.
+ */
+export interface AaveVaultDetails {
+  /**
+   * Vault identifier.
+   */
+  id: string;
+
+  /**
+   * EVM address of the vault admin wallet.
+   */
+  admin_wallet_address: string;
+
+  /**
+   * Privy wallet ID of the vault admin.
+   */
+  admin_wallet_id: string;
+
+  /**
+   * Annual percentage yield earned by the app from fee wrapper fees, in basis
+   * points.
+   */
+  app_apy: number | null;
+
+  /**
+   * Asset metadata for an earn vault position.
+   */
+  asset: EarnAsset;
+
+  /**
+   * Fees available to collect, in smallest unit of the underlying asset.
+   */
+  available_fees: string;
+
+  /**
+   * Available liquidity in USD.
+   */
+  available_liquidity_usd: number | null;
+
+  /**
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
+   */
+  caip2: string;
+
+  /**
+   * Human-readable vault name from the yield provider.
+   */
+  name: string;
+
+  provider: 'aave';
+
+  /**
+   * Total value locked in USD.
+   */
+  tvl_usd: number | null;
+
+  /**
+   * Annual percentage yield available to the user, after fees and excluding rewards,
+   * in basis points (e.g. 500 for 5%). 1 basis point = 0.01%.
+   */
+  user_apy: number | null;
+
+  /**
+   * Onchain vault contract address.
+   */
+  vault_address: string;
+}
 
 /**
  * A wallet action step representing a transaction executed by a custodian (e.g.
@@ -74,6 +143,11 @@ export interface EvmTransactionWalletActionStep {
   finalized?: boolean;
 }
 
+/**
+ * The ERC-4337 entrypoint contract version used by the user operation.
+ */
+export type EvmUserOperationEntrypointVersion = '0.6' | '0.7' | '0.8' | '0.9';
+
 /**
  * A wallet action step consisting of an EVM user operation.
  */
@@ -90,9 +164,9 @@ export interface EvmUserOperationWalletActionStep {
   caip2: string;
 
   /**
-   * The entrypoint version of the user operation.
+   * The ERC-4337 entrypoint contract version used by the user operation.
    */
-  entrypoint_version: '0.6' | '0.7' | '0.8' | '0.9';
+  entrypoint_version: EvmUserOperationEntrypointVersion;
 
   /**
    * Status of an EVM step in a wallet action.
@@ -266,6 +340,98 @@ export interface EarnDepositRequestBody {
   raw_amount?: string;
 }
 
+/**
+ * Response for an earn fee collect action.
+ */
+export interface EarnFeeCollectActionResponse {
+  /**
+   * The ID of the wallet action.
+   */
+  id: string;
+
+  /**
+   * Underlying asset token address.
+   */
+  asset_address: string;
+
+  /**
+   * CAIP-2 chain identifier.
+   */
+  caip2: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * Base-unit amount of fees collected (e.g. "1500000"). Populated after on-chain
+   * confirmation.
+   */
+  raw_amount: string | null;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'earn_fee_collect';
+
+  /**
+   * ERC-4626 vault contract address.
+   */
+  vault_address: string;
+
+  /**
+   * The vault ID.
+   */
+  vault_id: string;
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * Human-readable decimal amount of fees collected (e.g. "1.5"). Omitted when the
+   * token is not in the asset registry. Null while the action is pending; populated
+   * after on-chain confirmation.
+   */
+  amount?: string | null;
+
+  /**
+   * Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+   * the asset registry.
+   */
+  asset?: string;
+
+  /**
+   * Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+   * present when the token is known in the asset registry.
+   */
+  decimals?: number;
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+
+  /**
+   * The steps of the wallet action. Only returned if `?include=steps` is provided.
+   */
+  steps?: Array<WalletActionStep>;
+}
+
+/**
+ * Input for collecting accumulated fees from an Aave vault.
+ */
+export interface EarnFeeCollectRequestBody {
+  /**
+   * The ID of the vault to collect fees from.
+   */
+  vault_id: string;
+}
+
 /**
  * Response for an earn incentive claim action.
  */
@@ -276,7 +442,7 @@ export interface EarnIncentiveClaimActionResponse {
   id: string;
 
   /**
-   * EVM chain name (e.g. "base", "ethereum").
+   * EVM chain name (e.g. "tempo", "base").
    */
   chain: string;
 
@@ -319,8 +485,8 @@ export interface EarnIncentiveClaimActionResponse {
 export interface EarnIncentiveClaimRequestBody {
   /**
    * The blockchain network on which to perform the incentive claim. Supported chains
-   * include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more, along
-   * with their respective testnets.
+   * include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more,
+   * along with their respective testnets.
    */
   chain: string;
 }
@@ -360,7 +526,7 @@ export interface EarnIncentiveRewardEntry {
  */
 export interface EarnIncentiveRewardsQuery {
   /**
-   * Chain name to fetch rewards for (e.g. "base", "ethereum").
+   * Chain name to fetch rewards for (e.g. "tempo", "base").
    */
   chain: string;
 }
@@ -557,64 +723,13 @@ export interface EthereumEarnPositionResponse {
 /**
  * Supported earn provider protocols.
  */
-export type EthereumEarnProvider = 'morpho' | 'aave';
+export type EthereumEarnProvider = 'morpho' | 'aave' | 'veda';
 
 /**
  * Detailed vault information including current APY, liquidity, and asset metadata.
+ * Discriminated on provider.
  */
-export interface EthereumEarnVaultDetailsResponse {
-  /**
-   * Vault identifier.
-   */
-  id: string;
-
-  /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
-   */
-  app_apy: number | null;
-
-  /**
-   * Asset metadata for an earn vault position.
-   */
-  asset: EarnAsset;
-
-  /**
-   * Available liquidity in USD.
-   */
-  available_liquidity_usd: number | null;
-
-  /**
-   * CAIP-2 chain identifier (e.g. "eip155:8453").
-   */
-  caip2: string;
-
-  /**
-   * Human-readable vault name from the yield provider.
-   */
-  name: string;
-
-  /**
-   * Supported earn provider protocols.
-   */
-  provider: EthereumEarnProvider;
-
-  /**
-   * Total value locked in USD.
-   */
-  tvl_usd: number | null;
-
-  /**
-   * Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point
-   * = 0.01%.
-   */
-  user_apy: number | null;
-
-  /**
-   * Onchain vault contract address.
-   */
-  vault_address: string;
-}
+export type EthereumEarnVaultDetailsResponse = AaveVaultDetails | MorphoVaultDetails | VedaVaultDetails;
 
 /**
  * A wallet action step representing a cross-chain/cross-asset fill by an external
@@ -683,6 +798,75 @@ export interface ListWalletActionsResponse {
   next_cursor: string | null;
 }
 
+/**
+ * Vault details for a Morpho earn vault.
+ */
+export interface MorphoVaultDetails {
+  /**
+   * Vault identifier.
+   */
+  id: string;
+
+  /**
+   * EVM address of the vault admin wallet.
+   */
+  admin_wallet_address: string;
+
+  /**
+   * Privy wallet ID of the vault admin.
+   */
+  admin_wallet_id: string;
+
+  /**
+   * Annual percentage yield earned by the app from fee wrapper fees, in basis
+   * points.
+   */
+  app_apy: number | null;
+
+  /**
+   * Asset metadata for an earn vault position.
+   */
+  asset: EarnAsset;
+
+  /**
+   * Available liquidity in USD.
+   */
+  available_liquidity_usd: number | null;
+
+  /**
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
+   */
+  caip2: string;
+
+  /**
+   * Human-readable vault name from the yield provider.
+   */
+  name: string;
+
+  provider: 'morpho';
+
+  /**
+   * Total rewards annual percentage rate in basis points.
+   */
+  total_rewards_apr: number;
+
+  /**
+   * Total value locked in USD.
+   */
+  tvl_usd: number | null;
+
+  /**
+   * Annual percentage yield available to the user, after fees and excluding rewards,
+   * in basis points (e.g. 500 for 5%). 1 basis point = 0.01%.
+   */
+  user_apy: number | null;
+
+  /**
+   * Onchain vault contract address.
+   */
+  vault_address: string;
+}
+
 /**
  * A wallet action step consisting of an SVM (Solana) transaction.
  */
@@ -897,7 +1081,7 @@ export interface TransferActionResponse {
   destination_amount: string | null;
 
   /**
-   * Chain name (e.g. "base", "ethereum").
+   * Chain name (e.g. "tempo", "base").
    */
   source_chain: string;
 
@@ -987,6 +1171,70 @@ export interface TransferActionResponse {
   steps?: Array<WalletActionStep>;
 }
 
+/**
+ * Vault details for a Veda (BoringVault) earn vault.
+ */
+export interface VedaVaultDetails {
+  /**
+   * Vault identifier.
+   */
+  id: string;
+
+  /**
+   * EVM address of the vault admin wallet.
+   */
+  admin_wallet_address: string;
+
+  /**
+   * Privy wallet ID of the vault admin.
+   */
+  admin_wallet_id: string;
+
+  /**
+   * Annual percentage yield earned by the app from fee wrapper fees, in basis
+   * points.
+   */
+  app_apy: number | null;
+
+  /**
+   * Asset metadata for an earn vault position.
+   */
+  asset: EarnAsset;
+
+  /**
+   * Available liquidity in USD.
+   */
+  available_liquidity_usd: number | null;
+
+  /**
+   * CAIP-2 chain identifier (e.g. "eip155:4217" for Tempo, "eip155:8453" for Base).
+   */
+  caip2: string;
+
+  /**
+   * Human-readable vault name from the yield provider.
+   */
+  name: string;
+
+  provider: 'veda';
+
+  /**
+   * Total value locked in USD.
+   */
+  tvl_usd: number | null;
+
+  /**
+   * Annual percentage yield available to the user, after fees and excluding rewards,
+   * in basis points (e.g. 500 for 5%). 1 basis point = 0.01%.
+   */
+  user_apy: number | null;
+
+  /**
+   * Onchain vault contract address.
+   */
+  vault_address: string;
+}
+
 /**
  * Expandable relations to include on a wallet action response.
  */
@@ -1000,7 +1248,8 @@ export type WalletActionResponse =
   | TransferActionResponse
   | EarnDepositActionResponse
   | EarnWithdrawActionResponse
-  | EarnIncentiveClaimActionResponse;
+  | EarnIncentiveClaimActionResponse
+  | EarnFeeCollectActionResponse;
 
 /**
  * Status of a wallet action.
@@ -1037,18 +1286,23 @@ export type WalletActionType =
   | 'transfer'
   | 'earn_deposit'
   | 'earn_withdraw'
-  | 'earn_incentive_claim';
+  | 'earn_incentive_claim'
+  | 'earn_fee_collect';
 
-export declare namespace WalletActions {
+export declare namespace Actions {
   export {
+    type AaveVaultDetails as AaveVaultDetails,
     type CustodianTransactionWalletActionStep as CustodianTransactionWalletActionStep,
     type CustodianTransactionWalletActionStepStatus as CustodianTransactionWalletActionStepStatus,
     type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep,
+    type EvmUserOperationEntrypointVersion as EvmUserOperationEntrypointVersion,
     type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep,
     type EvmWalletActionStepStatus as EvmWalletActionStepStatus,
     type EarnAsset as EarnAsset,
     type EarnDepositActionResponse as EarnDepositActionResponse,
     type EarnDepositRequestBody as EarnDepositRequestBody,
+    type EarnFeeCollectActionResponse as EarnFeeCollectActionResponse,
+    type EarnFeeCollectRequestBody as EarnFeeCollectRequestBody,
     type EarnIncentiveClaimActionResponse as EarnIncentiveClaimActionResponse,
     type EarnIncentiveClaimRequestBody as EarnIncentiveClaimRequestBody,
     type EarnIncentiveRewardEntry as EarnIncentiveRewardEntry,
@@ -1066,12 +1320,14 @@ export declare namespace WalletActions {
     type FailureReason as FailureReason,
     type ListWalletActionsQuery as ListWalletActionsQuery,
     type ListWalletActionsResponse as ListWalletActionsResponse,
+    type MorphoVaultDetails as MorphoVaultDetails,
     type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep,
     type SvmWalletActionStepStatus as SvmWalletActionStepStatus,
     type SwapActionResponse as SwapActionResponse,
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TransferActionResponse as TransferActionResponse,
+    type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,
     type WalletActionResponse as WalletActionResponse,
     type WalletActionStatus as WalletActionStatus,

package/src/resources/wallets/balance.ts

@@ -35,28 +35,25 @@ export interface BalanceGetResponse {
 
 export namespace BalanceGetResponse {
   export interface Balance {
-    asset: 'usdc' | 'usdc.e' | 'eth' | 'avax' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
+    asset:
+      | 'usdc'
+      | 'usdc.e'
+      | 'eth'
+      | 'avax'
+      | 'pol'
+      | 'bnb'
+      | 'usdt'
+      | 'eurc'
+      | 'usdb'
+      | 'pathusd'
+      | 'sol'
+      | 'trx'
+      | (string & {});
 
-    chain:
-      | 'ethereum'
-      | 'arbitrum'
-      | 'avalanche'
-      | 'base'
-      | 'tempo'
-      | 'linea'
-      | 'optimism'
-      | 'polygon'
-      | 'solana'
-      | 'zksync_era'
-      | 'sepolia'
-      | 'arbitrum_sepolia'
-      | 'avalanche_fuji'
-      | 'base_sepolia'
-      | 'linea_testnet'
-      | 'optimism_sepolia'
-      | 'polygon_amoy'
-      | 'solana_devnet'
-      | 'solana_testnet';
+    /**
+     * Supported blockchain network names for wallet balance and transaction queries.
+     */
+    chain: WalletsAPI.WalletAssetChainNameInput;
 
     display_values: { [key: string]: string };
 
@@ -69,7 +66,7 @@ export namespace BalanceGetResponse {
 export interface BalanceGetParams {
   /**
    * The token contract address(es) to query in format "chain:address" (e.g.,
-   * "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or
+   * "tempo:0x20c000000000000000000000b9537d11c60e8b50" or
    * "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"). Cannot be used together
    * with `asset`/`chain` or with `include_currency`.
    */
@@ -85,57 +82,20 @@ export interface BalanceGetParams {
     | 'eth'
     | 'avax'
     | 'pol'
+    | 'bnb'
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'pathusd'
     | 'sol'
+    | 'trx'
     | Array<WalletsAPI.WalletAsset>;
 
   /**
-   * Chain(s) to query named assets on (e.g. `base`, `ethereum`). Use together with
+   * Chain(s) to query named assets on (e.g. `tempo`, `base`). Use together with
    * `asset`. Cannot be used with `token`.
    */
-  chain?:
-    | 'ethereum'
-    | 'arbitrum'
-    | 'avalanche'
-    | 'base'
-    | 'tempo'
-    | 'linea'
-    | 'optimism'
-    | 'polygon'
-    | 'solana'
-    | 'zksync_era'
-    | 'sepolia'
-    | 'arbitrum_sepolia'
-    | 'avalanche_fuji'
-    | 'base_sepolia'
-    | 'linea_testnet'
-    | 'optimism_sepolia'
-    | 'polygon_amoy'
-    | 'solana_devnet'
-    | 'solana_testnet'
-    | Array<
-        | 'ethereum'
-        | 'arbitrum'
-        | 'avalanche'
-        | 'base'
-        | 'tempo'
-        | 'linea'
-        | 'optimism'
-        | 'polygon'
-        | 'solana'
-        | 'zksync_era'
-        | 'sepolia'
-        | 'arbitrum_sepolia'
-        | 'avalanche_fuji'
-        | 'base_sepolia'
-        | 'linea_testnet'
-        | 'optimism_sepolia'
-        | 'polygon_amoy'
-        | 'solana_devnet'
-        | 'solana_testnet'
-      >;
+  chain?: WalletsAPI.WalletAssetChainNameInput | Array<WalletsAPI.WalletAssetChainNameInput>;
 
   /**
    * Include archived wallets in lookup. Defaults to false.