@privy-io/api-types 0.8.0 → 0.9.0

package/src/resources/wallet-actions.ts

@@ -7,7 +7,12 @@ export class WalletActions extends APIResource {}
 /**
  * Type of wallet action
  */
-export type WalletActionType = 'swap' | 'transfer';
+export type WalletActionType =
+  | 'swap'
+  | 'transfer'
+  | 'earn_deposit'
+  | 'earn_withdraw'
+  | 'earn_incentive_claim';
 
 /**
  * Status of a wallet action.
@@ -171,6 +176,11 @@ export interface SwapActionResponse {
    */
   wallet_id: string;
 
+  /**
+   * 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.
    */
@@ -223,6 +233,248 @@ export interface TransferActionResponse {
    */
   wallet_id: string;
 
+  /**
+   * 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>;
+}
+
+/**
+ * A specific reward token and amount associated with an earn incentive claim.
+ */
+export interface EarnIncetiveClaimRewardEntry {
+  /**
+   * Claimable amount in base units.
+   */
+  amount: string;
+
+  /**
+   * Address of the reward token.
+   */
+  token_address: string;
+
+  /**
+   * Symbol of the reward token (e.g. "MORPHO").
+   */
+  token_symbol: string;
+}
+
+/**
+ * Response for an earn deposit action.
+ */
+export interface EarnDepositActionResponse {
+  /**
+   * 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 asset deposited (e.g. "1500000").
+   */
+  raw_amount: string;
+
+  /**
+   * Vault shares received in base units. Populated after on-chain confirmation.
+   */
+  share_amount: string | null;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'earn_deposit';
+
+  /**
+   * 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 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.
+   */
+  failure_reason?: FailureReason;
+
+  /**
+   * The steps of the wallet action. Only returned if `?include=steps` is provided.
+   */
+  steps?: Array<WalletActionStep>;
+}
+
+/**
+ * Response for an earn withdraw action.
+ */
+export interface EarnWithdrawActionResponse {
+  /**
+   * 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 asset withdrawn (e.g. "1500000").
+   */
+  raw_amount: string;
+
+  /**
+   * Vault shares burned in base units. Populated after on-chain confirmation.
+   */
+  share_amount: string | null;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'earn_withdraw';
+
+  /**
+   * 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 asset withdrawn (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.
+   */
+  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.
+ */
+export interface EarnIncentiveClaimActionResponse {
+  /**
+   * The ID of the wallet action.
+   */
+  id: string;
+
+  /**
+   * EVM chain name (e.g. "base", "ethereum").
+   */
+  chain: 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.
+   */
+  rewards: Array<EarnIncetiveClaimRewardEntry> | null;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'earn_incentive_claim';
+
+  /**
+   * The ID of the wallet involved in the action.
+   */
+  wallet_id: string;
+
+  /**
+   * 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.
    */
@@ -232,7 +484,70 @@ export interface TransferActionResponse {
 /**
  * Response for a wallet action, discriminated on type.
  */
-export type WalletActionResponse = SwapActionResponse | TransferActionResponse;
+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.
+ */
+export interface EarnDepositRequestBody {
+  /**
+   * The ID of the vault to deposit into.
+   */
+  vault_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.
+   */
+  amount?: 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.
+   */
+  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 {
+  /**
+   * 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;
+}
+
+/**
+ * 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;
+}
 
 export declare namespace WalletActions {
   export {
@@ -246,6 +561,13 @@ export declare namespace WalletActions {
     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,
   };
 }

package/src/resources/wallets/balance.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as WalletsAPI from './wallets';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -80,7 +81,7 @@ export interface BalanceGetParams {
     | 'eurc'
     | 'usdb'
     | 'sol'
-    | Array<'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
+    | Array<WalletsAPI.WalletAsset>;
 
   chain?:
     | 'ethereum'

package/src/resources/wallets/index.ts

@@ -164,16 +164,27 @@ export {
   type WalletRpcRequestBody,
   type WalletRpcResponse,
   type WalletAuthenticateRequestBody,
+  type PrivateKeyInitInput,
+  type HDInitInput,
+  type PrivateKeySubmitInput,
+  type HDSubmitInput,
+  type WalletExportRequestBody,
+  type WalletExportResponseBody,
   type TokenTransferSource,
   type TokenTransferDestination,
-  type CreateTokenTransferRequest,
+  type TransferRequestBody,
   type SuiCommandName,
+  type WalletEthereumAsset,
+  type WalletSolanaAsset,
+  type WalletAsset,
+  type TransferSentTransactionDetail,
+  type TransferReceivedTransactionDetail,
+  type TransactionDetail,
   type WalletAPIRegisterAuthorizationKeyInput,
   type WalletAPIRevokeAuthorizationKeyInput,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
   type WalletAuthorizationHeaders,
-  type WalletExportResponse,
   type WalletInitImportResponse,
   type WalletAuthenticateWithJwtResponse,
   type WalletCreateWalletsWithRecoveryResponse,

package/src/resources/wallets/transactions.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as WalletsAPI from './wallets';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -41,7 +42,10 @@ export namespace TransactionGetResponse {
 
     created_at: number;
 
-    details: Transaction.UnionMember0 | Transaction.UnionMember1 | null;
+    /**
+     * Details of a wallet transaction, varying by transaction type.
+     */
+    details: Transaction.Details;
 
     privy_transaction_id: string;
 
@@ -65,97 +69,15 @@ export namespace TransactionGetResponse {
   }
 
   export namespace Transaction {
-    export interface UnionMember0 {
-      asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
-
-      chain:
-        | 'ethereum'
-        | 'arbitrum'
-        | 'base'
-        | 'tempo'
-        | 'linea'
-        | 'optimism'
-        | 'polygon'
-        | 'solana'
-        | 'zksync_era'
-        | 'sepolia'
-        | 'arbitrum_sepolia'
-        | 'base_sepolia'
-        | 'linea_testnet'
-        | 'optimism_sepolia'
-        | 'polygon_amoy'
-        | 'solana_devnet'
-        | 'solana_testnet';
-
-      display_values: { [key: string]: string };
-
-      raw_value: string;
-
-      raw_value_decimals: number;
-
-      recipient: string;
-
-      recipient_privy_user_id: string | null;
-
-      sender: string;
-
-      sender_privy_user_id: string | null;
-
-      type: 'transfer_sent';
-    }
-
-    export interface UnionMember1 {
-      asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | (string & {});
-
-      chain:
-        | 'ethereum'
-        | 'arbitrum'
-        | 'base'
-        | 'tempo'
-        | 'linea'
-        | 'optimism'
-        | 'polygon'
-        | 'solana'
-        | 'zksync_era'
-        | 'sepolia'
-        | 'arbitrum_sepolia'
-        | 'base_sepolia'
-        | 'linea_testnet'
-        | 'optimism_sepolia'
-        | 'polygon_amoy'
-        | 'solana_devnet'
-        | 'solana_testnet';
-
-      display_values: { [key: string]: string };
-
-      raw_value: string;
-
-      raw_value_decimals: number;
-
-      recipient: string;
-
-      recipient_privy_user_id: string | null;
-
-      sender: string;
-
-      sender_privy_user_id: string | null;
-
-      type: 'transfer_received';
-    }
+    /**
+     * Details of a wallet transaction, varying by transaction type.
+     */
+    export type Details = WalletsAPI.TransactionDetail & {};
   }
 }
 
 export interface TransactionGetParams {
-  asset:
-    | 'usdc'
-    | 'usdc.e'
-    | 'eth'
-    | 'pol'
-    | 'usdt'
-    | 'eurc'
-    | 'usdb'
-    | 'sol'
-    | Array<'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol'>;
+  asset: 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol' | Array<WalletsAPI.WalletAsset>;
 
   chain: 'ethereum' | 'arbitrum' | 'base' | 'tempo' | 'linea' | 'optimism' | 'polygon' | 'solana' | 'sepolia';