@privy-io/api-types 0.9.0 → 0.11.0

package/resources/wallet-actions.d.ts

@@ -1,35 +1,6 @@
 import { APIResource } from "../core/resource.js";
 export declare class WalletActions extends APIResource {
 }
-/**
- * Type of wallet action
- */
-export type WalletActionType = 'swap' | 'transfer' | 'earn_deposit' | 'earn_withdraw' | 'earn_incentive_claim';
-/**
- * Status of a wallet action.
- */
-export type WalletActionStatus = 'pending' | 'succeeded' | 'rejected' | 'failed';
-/**
- * Type of a wallet action step.
- */
-export type WalletActionStepType = 'evm_transaction' | 'evm_user_operation';
-/**
- * Status of an EVM step in a wallet action.
- */
-export type EvmWalletActionStepStatus = 'preparing' | 'queued' | 'pending' | 'retrying' | 'confirmed' | 'rejected' | 'reverted' | 'replaced' | 'abandoned';
-/**
- * A description of why a wallet action (or a step within a wallet action) failed.
- */
-export interface FailureReason {
-    /**
-     * Human-readable failure message.
-     */
-    message: string;
-    /**
-     * Additional error details, if available.
-     */
-    details?: unknown;
-}
 /**
  * A wallet action step consisting of an EVM transaction.
  */
@@ -86,19 +57,40 @@ export interface EvmUserOperationWalletActionStep {
     failure_reason?: FailureReason;
 }
 /**
- * A step within a wallet action, representing a single onchain action.
+ * Status of an EVM step in a wallet action.
  */
-export type WalletActionStep = EvmTransactionWalletActionStep | EvmUserOperationWalletActionStep;
+export type EvmWalletActionStepStatus = 'preparing' | 'queued' | 'pending' | 'retrying' | 'confirmed' | 'rejected' | 'reverted' | 'replaced' | 'abandoned';
 /**
- * Response for a swap action.
+ * Asset metadata for an earn vault position.
  */
-export interface SwapActionResponse {
+export interface EarnAsset {
+    /**
+     * Token contract address.
+     */
+    address: string;
+    /**
+     * Number of decimals for the asset (e.g. 6 for USDC).
+     */
+    decimals: number;
+    /**
+     * Lowercase token symbol (e.g. "usdc").
+     */
+    symbol: string;
+}
+/**
+ * Response for an earn deposit action.
+ */
+export interface EarnDepositActionResponse {
     /**
      * The ID of the wallet action.
      */
     id: string;
     /**
-     * CAIP-2 chain identifier for the swap.
+     * Underlying asset token address.
+     */
+    asset_address: string;
+    /**
+     * CAIP-2 chain identifier.
      */
     caip2: string;
     /**
@@ -106,30 +98,45 @@ export interface SwapActionResponse {
      */
     created_at: string;
     /**
-     * Exact base-unit amount of input token. Populated after on-chain confirmation.
+     * Base-unit amount of asset deposited (e.g. "1500000").
      */
-    input_amount: string | null;
+    raw_amount: string;
     /**
-     * Token address or "native" for the token being sold.
+     * Vault shares received in base units. Populated after on-chain confirmation.
      */
-    input_token: string;
+    share_amount: string | null;
     /**
-     * Exact base-unit amount of output token. Populated after on-chain confirmation.
+     * Status of a wallet action.
      */
-    output_amount: string | null;
+    status: WalletActionStatus;
+    type: 'earn_deposit';
     /**
-     * Token address or "native" for the token being bought.
+     * ERC-4626 vault contract address.
      */
-    output_token: string;
+    vault_address: string;
     /**
-     * Status of a wallet action.
+     * The vault ID.
      */
-    status: WalletActionStatus;
-    type: 'swap';
+    vault_id: string;
     /**
      * The ID of the wallet involved in the action.
      */
     wallet_id: string;
+    /**
+     * Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
+     * the token is known in the asset registry.
+     */
+    amount?: string;
+    /**
+     * 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.
      */
@@ -140,38 +147,50 @@ export interface SwapActionResponse {
     steps?: Array<WalletActionStep>;
 }
 /**
- * Response for a transfer action.
+ * Input for depositing assets into an ERC-4626 vault. Exactly one of `amount` or
+ * `raw_amount` must be provided.
  */
-export interface TransferActionResponse {
+export interface EarnDepositRequestBody {
     /**
-     * The ID of the wallet action.
+     * The ID of the vault to deposit into.
      */
-    id: string;
+    vault_id: string;
     /**
-     * ISO 8601 timestamp of when the wallet action was created.
+     * Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
+     * of `amount` or `raw_amount` must be provided.
      */
-    created_at: string;
+    amount?: string;
     /**
-     * Recipient address.
+     * Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
+     * decimals). Exactly one of `amount` or `raw_amount` must be provided.
      */
-    destination_address: string;
+    raw_amount?: string;
+}
+/**
+ * Response for an earn incentive claim action.
+ */
+export interface EarnIncentiveClaimActionResponse {
     /**
-     * Decimal amount as the user provided (e.g. "1.5").
+     * The ID of the wallet action.
      */
-    source_amount: string;
+    id: string;
     /**
-     * Asset identifier (e.g. "usdc", "eth").
+     * EVM chain name (e.g. "base", "ethereum").
      */
-    source_asset: string;
+    chain: string;
     /**
-     * Chain name (e.g. "base", "ethereum").
+     * ISO 8601 timestamp of when the wallet action was created.
      */
-    source_chain: string;
+    created_at: string;
+    /**
+     * Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+     */
+    rewards: Array<EarnIncetiveClaimRewardEntry> | null;
     /**
      * Status of a wallet action.
      */
     status: WalletActionStatus;
-    type: 'transfer';
+    type: 'earn_incentive_claim';
     /**
      * The ID of the wallet involved in the action.
      */
@@ -185,6 +204,17 @@ export interface TransferActionResponse {
      */
     steps?: Array<WalletActionStep>;
 }
+/**
+ * Input for claiming incentive rewards.
+ */
+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.
+     */
+    chain: string;
+}
 /**
  * A specific reward token and amount associated with an earn incentive claim.
  */
@@ -201,11 +231,15 @@ export interface EarnIncetiveClaimRewardEntry {
      * Symbol of the reward token (e.g. "MORPHO").
      */
     token_symbol: string;
+    /**
+     * Number of decimal places for the reward token.
+     */
+    token_decimals?: number;
 }
 /**
- * Response for an earn deposit action.
+ * Response for an earn withdraw action.
  */
-export interface EarnDepositActionResponse {
+export interface EarnWithdrawActionResponse {
     /**
      * The ID of the wallet action.
      */
@@ -223,18 +257,18 @@ export interface EarnDepositActionResponse {
      */
     created_at: string;
     /**
-     * Base-unit amount of asset deposited (e.g. "1500000").
+     * Base-unit amount of asset withdrawn (e.g. "1500000").
      */
     raw_amount: string;
     /**
-     * Vault shares received in base units. Populated after on-chain confirmation.
+     * Vault shares burned in base units. Populated after on-chain confirmation.
      */
     share_amount: string | null;
     /**
      * Status of a wallet action.
      */
     status: WalletActionStatus;
-    type: 'earn_deposit';
+    type: 'earn_withdraw';
     /**
      * ERC-4626 vault contract address.
      */
@@ -248,7 +282,7 @@ export interface EarnDepositActionResponse {
      */
     wallet_id: string;
     /**
-     * Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
+     * Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
      * the token is known in the asset registry.
      */
     amount?: string;
@@ -272,99 +306,186 @@ export interface EarnDepositActionResponse {
     steps?: Array<WalletActionStep>;
 }
 /**
- * Response for an earn withdraw action.
+ * Input for withdrawing assets from an ERC-4626 vault. Exactly one of `amount` or
+ * `raw_amount` must be provided.
  */
-export interface EarnWithdrawActionResponse {
+export interface EarnWithdrawRequestBody {
     /**
-     * The ID of the wallet action.
+     * The ID of the vault to withdraw from.
+     */
+    vault_id: string;
+    /**
+     * Human-readable decimal amount to withdraw (e.g. "1.5" for 1.5 USDC). Exactly one
+     * of `amount` or `raw_amount` must be provided.
+     */
+    amount?: string;
+    /**
+     * Amount in smallest unit to withdraw (e.g. "1500000" for 1.5 USDC with 6
+     * decimals). Exactly one of `amount` or `raw_amount` must be provided.
+     */
+    raw_amount?: string;
+}
+/**
+ * Query parameters for fetching an earn vault position.
+ */
+export interface EthereumEarnPositionQuery {
+    /**
+     * The vault ID to get position for.
+     */
+    vault_id: string;
+}
+/**
+ * A wallet's position in an earn vault.
+ */
+export interface EthereumEarnPositionResponse {
+    /**
+     * Asset metadata for an earn vault position.
+     */
+    asset: EarnAsset;
+    /**
+     * Current asset value in the vault (realtime from ERC-4626), in smallest unit.
+     */
+    assets_in_vault: string;
+    /**
+     * Current vault shares held (realtime from ERC-4626).
+     */
+    shares_in_vault: string;
+    /**
+     * Total amount deposited into the vault, in smallest unit.
+     */
+    total_deposited: string;
+    /**
+     * Total amount withdrawn from the vault, in smallest unit.
+     */
+    total_withdrawn: string;
+}
+/**
+ * Supported earn provider protocols.
+ */
+export type EthereumEarnProvider = 'morpho' | 'aave';
+/**
+ * Detailed vault information including current APY, liquidity, and asset metadata.
+ */
+export interface EthereumEarnVaultDetailsResponse {
+    /**
+     * Vault identifier.
      */
     id: string;
     /**
-     * Underlying asset token address.
+     * Annual percentage yield earned by the app from fee wrapper fees, in basis
+     * points.
      */
-    asset_address: string;
+    app_apy: number | null;
     /**
-     * CAIP-2 chain identifier.
+     * 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;
     /**
-     * ISO 8601 timestamp of when the wallet action was created.
+     * Human-readable vault name from the yield provider.
      */
-    created_at: string;
+    name: string;
     /**
-     * Base-unit amount of asset withdrawn (e.g. "1500000").
+     * Supported earn provider protocols.
      */
-    raw_amount: string;
+    provider: EthereumEarnProvider;
     /**
-     * Vault shares burned in base units. Populated after on-chain confirmation.
+     * Total value locked in USD.
      */
-    share_amount: string | null;
+    tvl_usd: number | null;
     /**
-     * Status of a wallet action.
+     * Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point
+     * = 0.01%.
      */
-    status: WalletActionStatus;
-    type: 'earn_withdraw';
+    user_apy: number | null;
     /**
-     * ERC-4626 vault contract address.
+     * Onchain vault contract address.
      */
     vault_address: string;
+}
+/**
+ * A description of why a wallet action (or a step within a wallet action) failed.
+ */
+export interface FailureReason {
     /**
-     * The vault ID.
+     * Human-readable failure message.
      */
-    vault_id: string;
+    message: string;
     /**
-     * The ID of the wallet involved in the action.
+     * Additional error details, if available.
      */
-    wallet_id: string;
+    details?: unknown;
+}
+/**
+ * A wallet action step consisting of an SVM (Solana) transaction.
+ */
+export interface SvmTransactionWalletActionStep {
     /**
-     * Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
-     * the token is known in the asset registry.
+     * CAIP-2 chain identifier for the Solana network.
      */
-    amount?: string;
+    caip2: string;
     /**
-     * Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
-     * the asset registry.
+     * Status of an SVM step in a wallet action.
      */
-    asset?: string;
+    status: SvmWalletActionStepStatus;
     /**
-     * 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.
+     * The Solana transaction signature (base58-encoded). Null until broadcast.
      */
-    decimals?: number;
+    transaction_signature: string | null;
+    type: 'svm_transaction';
     /**
      * 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>;
 }
 /**
- * Response for an earn incentive claim action.
+ * Status of an SVM step in a wallet action.
  */
-export interface EarnIncentiveClaimActionResponse {
+export type SvmWalletActionStepStatus = 'preparing' | 'queued' | 'pending' | 'confirmed' | 'finalized' | 'rejected' | 'reverted' | 'failed';
+/**
+ * Response for a swap action.
+ */
+export interface SwapActionResponse {
     /**
      * The ID of the wallet action.
      */
     id: string;
     /**
-     * EVM chain name (e.g. "base", "ethereum").
+     * CAIP-2 chain identifier for the swap.
      */
-    chain: string;
+    caip2: string;
     /**
      * ISO 8601 timestamp of when the wallet action was created.
      */
     created_at: string;
     /**
-     * Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+     * Exact base-unit amount of input token. Populated after on-chain confirmation.
      */
-    rewards: Array<EarnIncetiveClaimRewardEntry> | null;
+    input_amount: string | null;
+    /**
+     * Token address or "native" for the token being sold.
+     */
+    input_token: string;
+    /**
+     * Exact base-unit amount of output token. Populated after on-chain confirmation.
+     */
+    output_amount: string | null;
+    /**
+     * Token address or "native" for the token being bought.
+     */
+    output_token: string;
     /**
      * Status of a wallet action.
      */
     status: WalletActionStatus;
-    type: 'earn_incentive_claim';
+    type: 'swap';
     /**
      * The ID of the wallet involved in the action.
      */
@@ -379,61 +500,97 @@ export interface EarnIncentiveClaimActionResponse {
     steps?: Array<WalletActionStep>;
 }
 /**
- * Response for a wallet action, discriminated on type.
- */
-export type WalletActionResponse = SwapActionResponse | TransferActionResponse | EarnDepositActionResponse | EarnWithdrawActionResponse | EarnIncentiveClaimActionResponse;
-/**
- * Input for depositing assets into an ERC-4626 vault. Exactly one of `amount` or
- * `raw_amount` must be provided.
+ * Response for a transfer action.
  */
-export interface EarnDepositRequestBody {
+export interface TransferActionResponse {
     /**
-     * The ID of the vault to deposit into.
+     * The ID of the wallet action.
      */
-    vault_id: string;
+    id: string;
     /**
-     * Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
-     * of `amount` or `raw_amount` must be provided.
+     * ISO 8601 timestamp of when the wallet action was created.
      */
-    amount?: string;
+    created_at: string;
     /**
-     * Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
-     * decimals). Exactly one of `amount` or `raw_amount` must be provided.
+     * Recipient address.
      */
-    raw_amount?: string;
-}
-/**
- * Input for withdrawing assets from an ERC-4626 vault. Exactly one of `amount` or
- * `raw_amount` must be provided.
- */
-export interface EarnWithdrawRequestBody {
+    destination_address: string;
     /**
-     * The ID of the vault to withdraw from.
+     * Chain name (e.g. "base", "ethereum").
      */
-    vault_id: string;
+    source_chain: string;
     /**
-     * Human-readable decimal amount to withdraw (e.g. "1.5" for 1.5 USDC). Exactly one
-     * of `amount` or `raw_amount` must be provided.
+     * Status of a wallet action.
      */
-    amount?: string;
+    status: WalletActionStatus;
+    type: 'transfer';
     /**
-     * Amount in smallest unit to withdraw (e.g. "1500000" for 1.5 USDC with 6
-     * decimals). Exactly one of `amount` or `raw_amount` must be provided.
+     * The ID of the wallet involved in the action.
      */
-    raw_amount?: string;
-}
-/**
- * Input for claiming incentive rewards.
- */
-export interface EarnIncentiveClaimRequestBody {
+    wallet_id: string;
     /**
-     * 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.
+     * Amount received on the destination chain. Populated immediately for exact_output
+     * transfers, or after fill confirmation for exact_input transfers.
      */
-    chain: string;
+    destination_amount?: string;
+    /**
+     * Destination asset for cross-asset transfers. Omitted for same-asset transfers.
+     */
+    destination_asset?: string;
+    /**
+     * Destination chain for cross-chain transfers. Omitted for same-chain transfers.
+     */
+    destination_chain?: string;
+    /**
+     * A description of why a wallet action (or a step within a wallet action) failed.
+     */
+    failure_reason?: FailureReason;
+    /**
+     * Decimal amount sent on the source chain (e.g. "1.5"). Omitted for exact_output
+     * cross-chain transfers until the source amount is determined.
+     */
+    source_amount?: string;
+    /**
+     * Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
+     * with a named asset; omitted for custom-token transfers.
+     */
+    source_asset?: string;
+    /**
+     * Token contract address (EVM) or mint address (Solana). Present when the transfer
+     * was initiated with `asset_address`.
+     */
+    source_asset_address?: string;
+    /**
+     * Number of decimals for the transferred token. Present when the transfer was
+     * initiated with `asset_address` and the decimals were resolved on-chain.
+     */
+    source_asset_decimals?: number;
+    /**
+     * The steps of the wallet action. Only returned if `?include=steps` is provided.
+     */
+    steps?: Array<WalletActionStep>;
 }
+/**
+ * Response for a wallet action, discriminated on type.
+ */
+export type WalletActionResponse = SwapActionResponse | TransferActionResponse | EarnDepositActionResponse | EarnWithdrawActionResponse | EarnIncentiveClaimActionResponse;
+/**
+ * Status of a wallet action.
+ */
+export type WalletActionStatus = 'pending' | 'succeeded' | 'rejected' | 'failed';
+/**
+ * A step within a wallet action, representing a single onchain action.
+ */
+export type WalletActionStep = EvmTransactionWalletActionStep | EvmUserOperationWalletActionStep | SvmTransactionWalletActionStep;
+/**
+ * Type of a wallet action step.
+ */
+export type WalletActionStepType = 'evm_transaction' | 'evm_user_operation' | 'svm_transaction';
+/**
+ * Type of wallet action
+ */
+export type WalletActionType = 'swap' | 'transfer' | 'earn_deposit' | 'earn_withdraw' | 'earn_incentive_claim';
 export declare namespace WalletActions {
-    export { type WalletActionType as WalletActionType, type WalletActionStatus as WalletActionStatus, type WalletActionStepType as WalletActionStepType, type EvmWalletActionStepStatus as EvmWalletActionStepStatus, type FailureReason as FailureReason, type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep, type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep, type WalletActionStep as WalletActionStep, type SwapActionResponse as SwapActionResponse, type TransferActionResponse as TransferActionResponse, type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry, type EarnDepositActionResponse as EarnDepositActionResponse, type EarnWithdrawActionResponse as EarnWithdrawActionResponse, type EarnIncentiveClaimActionResponse as EarnIncentiveClaimActionResponse, type WalletActionResponse as WalletActionResponse, type EarnDepositRequestBody as EarnDepositRequestBody, type EarnWithdrawRequestBody as EarnWithdrawRequestBody, type EarnIncentiveClaimRequestBody as EarnIncentiveClaimRequestBody, };
+    export { type EvmTransactionWalletActionStep as EvmTransactionWalletActionStep, type EvmUserOperationWalletActionStep as EvmUserOperationWalletActionStep, type EvmWalletActionStepStatus as EvmWalletActionStepStatus, type EarnAsset as EarnAsset, type EarnDepositActionResponse as EarnDepositActionResponse, type EarnDepositRequestBody as EarnDepositRequestBody, type EarnIncentiveClaimActionResponse as EarnIncentiveClaimActionResponse, type EarnIncentiveClaimRequestBody as EarnIncentiveClaimRequestBody, type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry, type EarnWithdrawActionResponse as EarnWithdrawActionResponse, type EarnWithdrawRequestBody as EarnWithdrawRequestBody, type EthereumEarnPositionQuery as EthereumEarnPositionQuery, type EthereumEarnPositionResponse as EthereumEarnPositionResponse, type EthereumEarnProvider as EthereumEarnProvider, type EthereumEarnVaultDetailsResponse as EthereumEarnVaultDetailsResponse, type FailureReason as FailureReason, type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep, type SvmWalletActionStepStatus as SvmWalletActionStepStatus, type SwapActionResponse as SwapActionResponse, type TransferActionResponse as TransferActionResponse, type WalletActionResponse as WalletActionResponse, type WalletActionStatus as WalletActionStatus, type WalletActionStep as WalletActionStep, type WalletActionStepType as WalletActionStepType, type WalletActionType as WalletActionType, };
 }
 //# sourceMappingURL=wallet-actions.d.ts.map