@privy-io/api-types 0.20.0 → 0.22.0

package/src/resources/wallets/actions.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as FiatAPI from '../fiat';
+import * as SharedAPI from '../shared';
 import * as WalletsAPI from './wallets';
 
 export class Actions extends APIResource {}
@@ -141,6 +143,11 @@ export interface EvmTransactionWalletActionStep {
    * confirmed.
    */
   finalized?: boolean;
+
+  /**
+   * Amount charged in USD for gas sponsorship on this step.
+   */
+  gas_credits_charged_usd?: string;
 }
 
 /**
@@ -311,6 +318,11 @@ export interface EarnDepositActionResponse {
    */
   failure_reason?: FailureReason;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
@@ -333,11 +345,22 @@ export interface EarnDepositRequestBody {
    */
   amount?: string;
 
+  /**
+   * Unique caller-generated nonce used to prevent replaying a signed wallet action
+   * request. Must be at least 24 characters (e.g. a cuid2 or UUID).
+   */
+  nonce?: WalletsAPI.WalletActionNonce;
+
   /**
    * 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;
+
+  /**
+   * Developer-provided identifier for this request. Must be unique per app.
+   */
+  reference_id?: string;
 }
 
 /**
@@ -416,6 +439,11 @@ export interface EarnFeeCollectActionResponse {
    */
   failure_reason?: FailureReason;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
@@ -430,6 +458,17 @@ export interface EarnFeeCollectRequestBody {
    * The ID of the vault to collect fees from.
    */
   vault_id: string;
+
+  /**
+   * Unique caller-generated nonce used to prevent replaying a signed wallet action
+   * request. Must be at least 24 characters (e.g. a cuid2 or UUID).
+   */
+  nonce?: WalletsAPI.WalletActionNonce;
+
+  /**
+   * Developer-provided identifier for this request. Must be unique per app.
+   */
+  reference_id?: string;
 }
 
 /**
@@ -473,6 +512,11 @@ export interface EarnIncentiveClaimActionResponse {
    */
   failure_reason?: FailureReason;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
@@ -489,6 +533,17 @@ export interface EarnIncentiveClaimRequestBody {
    * along with their respective testnets.
    */
   chain: string;
+
+  /**
+   * Unique caller-generated nonce used to prevent replaying a signed wallet action
+   * request. Must be at least 24 characters (e.g. a cuid2 or UUID).
+   */
+  nonce?: WalletsAPI.WalletActionNonce;
+
+  /**
+   * Developer-provided identifier for this request. Must be unique per app.
+   */
+  reference_id?: string;
 }
 
 /**
@@ -567,6 +622,31 @@ export interface EarnIncetiveClaimRewardEntry {
   token_decimals?: number;
 }
 
+/**
+ * An APY allocation within a vault position.
+ */
+export interface EarnPositionApyAllocation {
+  /**
+   * Net APY in basis points, rounded to the nearest integer.
+   */
+  apy_bps: number;
+
+  /**
+   * Allocated assets in the smallest unit of the underlying asset.
+   */
+  assets_in_vault: string;
+
+  /**
+   * Whether an APY allocation earns the base or boosted rate.
+   */
+  type: EarnPositionApyType;
+}
+
+/**
+ * Whether an APY allocation earns the base or boosted rate.
+ */
+export type EarnPositionApyType = 'boost' | 'base';
+
 /**
  * Response for an earn withdraw action.
  */
@@ -646,6 +726,11 @@ export interface EarnWithdrawActionResponse {
    */
   failure_reason?: FailureReason;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
@@ -668,11 +753,22 @@ export interface EarnWithdrawRequestBody {
    */
   amount?: string;
 
+  /**
+   * Unique caller-generated nonce used to prevent replaying a signed wallet action
+   * request. Must be at least 24 characters (e.g. a cuid2 or UUID).
+   */
+  nonce?: WalletsAPI.WalletActionNonce;
+
   /**
    * 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;
+
+  /**
+   * Developer-provided identifier for this request. Must be unique per app.
+   */
+  reference_id?: string;
 }
 
 /**
@@ -718,18 +814,33 @@ export interface EthereumEarnPositionResponse {
    * Total amount withdrawn from the vault, in smallest unit.
    */
   total_withdrawn: string;
+
+  /**
+   * Vault APY allocations by origin, returned together with apy_bps when available.
+   */
+  apy_allocation?: Array<EarnPositionApyAllocation>;
+
+  /**
+   * Wallet-specific net APY in basis points, rounded to the nearest integer.
+   * Returned together with apy_allocation when available.
+   */
+  apy_bps?: number;
 }
 
 /**
  * Supported earn provider protocols.
  */
-export type EthereumEarnProvider = 'morpho' | 'aave' | 'veda';
+export type EthereumEarnProvider = 'morpho' | 'aave' | 'veda' | 'tempo';
 
 /**
  * Detailed vault information including current APY, liquidity, and asset metadata.
  * Discriminated on provider.
  */
-export type EthereumEarnVaultDetailsResponse = AaveVaultDetails | MorphoVaultDetails | VedaVaultDetails;
+export type EthereumEarnVaultDetailsResponse =
+  | AaveVaultDetails
+  | MorphoVaultDetails
+  | TempoVaultDetails
+  | VedaVaultDetails;
 
 /**
  * A wallet action step representing a cross-chain/cross-asset fill by an external
@@ -867,6 +978,69 @@ export interface MorphoVaultDetails {
   vault_address: string;
 }
 
+/**
+ * A payout wallet action. Crypto is sent on-chain to a liquidation address that
+ * offramps to the destination bank account.
+ */
+export interface PayoutResponse {
+  /**
+   * The ID of the wallet action.
+   */
+  id: string;
+
+  /**
+   * ISO 8601 timestamp of when the wallet action was created.
+   */
+  created_at: string;
+
+  /**
+   * The destination bank account for a payout.
+   */
+  destination: FiatAPI.PayoutDestination;
+
+  /**
+   * The Privy API environment.
+   */
+  environment: SharedAPI.IntegrationEnvironment;
+
+  /**
+   * Supported fiat orchestration providers.
+   */
+  provider: SharedAPI.OrchestrationProvider;
+
+  /**
+   * The source crypto asset, chain, and amount for a payout.
+   */
+  source: FiatAPI.PayoutSource;
+
+  /**
+   * Status of a wallet action.
+   */
+  status: WalletActionStatus;
+
+  type: 'payout';
+
+  /**
+   * 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;
+
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
+  /**
+   * The steps of the wallet action. Only returned if `?include=steps` is provided.
+   */
+  steps?: Array<WalletActionStep>;
+}
+
 /**
  * A wallet action step consisting of an SVM (Solana) transaction.
  */
@@ -969,9 +1143,8 @@ export interface SwapActionResponse {
   wallet_id: string;
 
   /**
-   * Recipient address on the destination chain. Present for cross-chain swaps. May
-   * differ from the source wallet address when swapping between chain types (e.g.
-   * EVM to Solana).
+   * Recipient address for the swap. Present for newly created swaps; may be absent
+   * for older swap actions.
    */
   destination_address?: string;
 
@@ -1009,6 +1182,11 @@ export interface SwapActionResponse {
    */
   gas?: WalletsAPI.Gas | null;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * The steps of the wallet action. Only returned if `?include=steps` is provided.
    */
@@ -1054,6 +1232,71 @@ export type TvmWalletActionStepStatus =
   | 'reverted'
   | 'failed';
 
+/**
+ * Vault details for a Tempo earn vault.
+ */
+export interface TempoVaultDetails {
+  /**
+   * Vault identifier.
+   */
+  id: string;
+
+  /**
+   * EVM address of the vault admin wallet.
+   */
+  admin_wallet_address: string;
+
+  /**
+   * Privy wallet ID of the vault admin, or null when the Tempo vault admin is not
+   * Privy-managed.
+   */
+  admin_wallet_id: string | null;
+
+  /**
+   * 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: 'tempo';
+
+  /**
+   * 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;
+}
+
 /**
  * Response for a transfer action.
  */
@@ -1141,6 +1384,11 @@ export interface TransferActionResponse {
    */
   gas?: WalletsAPI.Gas | null;
 
+  /**
+   * Developer-provided reference ID, if one was included in the request.
+   */
+  reference_id?: string | null;
+
   /**
    * Decimal amount sent on the source chain (e.g. "1.5"). For exact_output
    * cross-chain transfers, null until fill confirmation.
@@ -1249,7 +1497,8 @@ export type WalletActionResponse =
   | EarnDepositActionResponse
   | EarnWithdrawActionResponse
   | EarnIncentiveClaimActionResponse
-  | EarnFeeCollectActionResponse;
+  | EarnFeeCollectActionResponse
+  | PayoutResponse;
 
 /**
  * Status of a wallet action.
@@ -1287,7 +1536,8 @@ export type WalletActionType =
   | 'earn_deposit'
   | 'earn_withdraw'
   | 'earn_incentive_claim'
-  | 'earn_fee_collect';
+  | 'earn_fee_collect'
+  | 'payout';
 
 export declare namespace Actions {
   export {
@@ -1309,6 +1559,8 @@ export declare namespace Actions {
     type EarnIncentiveRewardsQuery as EarnIncentiveRewardsQuery,
     type EarnIncentiveRewardsResponse as EarnIncentiveRewardsResponse,
     type EarnIncetiveClaimRewardEntry as EarnIncetiveClaimRewardEntry,
+    type EarnPositionApyAllocation as EarnPositionApyAllocation,
+    type EarnPositionApyType as EarnPositionApyType,
     type EarnWithdrawActionResponse as EarnWithdrawActionResponse,
     type EarnWithdrawRequestBody as EarnWithdrawRequestBody,
     type EthereumEarnPositionQuery as EthereumEarnPositionQuery,
@@ -1321,11 +1573,13 @@ export declare namespace Actions {
     type ListWalletActionsQuery as ListWalletActionsQuery,
     type ListWalletActionsResponse as ListWalletActionsResponse,
     type MorphoVaultDetails as MorphoVaultDetails,
+    type PayoutResponse as PayoutResponse,
     type SvmTransactionWalletActionStep as SvmTransactionWalletActionStep,
     type SvmWalletActionStepStatus as SvmWalletActionStepStatus,
     type SwapActionResponse as SwapActionResponse,
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
+    type TempoVaultDetails as TempoVaultDetails,
     type TransferActionResponse as TransferActionResponse,
     type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,

package/src/resources/wallets/balance.ts

@@ -45,6 +45,7 @@ export namespace BalanceGetResponse {
       | 'usdt'
       | 'eurc'
       | 'usdb'
+      | 'ousd'
       | 'pathusd'
       | 'sol'
       | 'trx'
@@ -86,6 +87,7 @@ export interface BalanceGetParams {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'ousd'
     | 'pathusd'
     | 'sol'
     | 'trx'
@@ -95,7 +97,45 @@ export interface BalanceGetParams {
    * Chain(s) to query named assets on (e.g. `tempo`, `base`). Use together with
    * `asset`. Cannot be used with `token`.
    */
-  chain?: WalletsAPI.WalletAssetChainNameInput | Array<WalletsAPI.WalletAssetChainNameInput>;
+  chain?:
+    | 'ethereum'
+    | 'arbitrum'
+    | 'avalanche'
+    | 'base'
+    | 'tempo'
+    | 'linea'
+    | 'optimism'
+    | 'polygon'
+    | 'bsc'
+    | 'solana'
+    | 'tron'
+    | 'zksync_era'
+    | 'robinhood'
+    | 'unichain'
+    | 'worldchain'
+    | 'ink'
+    | 'soneium'
+    | 'megaeth'
+    | 'hyperevm'
+    | 'hypercore'
+    | 'arc'
+    | 'tempo_testnet'
+    | 'hoodi'
+    | 'sepolia'
+    | 'arbitrum_sepolia'
+    | 'avalanche_fuji'
+    | 'base_sepolia'
+    | 'linea_testnet'
+    | 'optimism_sepolia'
+    | 'polygon_amoy'
+    | 'bsc_testnet'
+    | 'solana_devnet'
+    | 'solana_testnet'
+    | 'tron_nile'
+    | 'robinhood_testnet'
+    | 'ink_sepolia'
+    | string
+    | Array<WalletsAPI.WalletAssetChainNameInput>;
 
   /**
    * Include archived wallets in lookup. Defaults to false.

package/src/resources/wallets/index.ts

@@ -20,6 +20,8 @@ export {
   type EarnIncentiveRewardsQuery,
   type EarnIncentiveRewardsResponse,
   type EarnIncetiveClaimRewardEntry,
+  type EarnPositionApyAllocation,
+  type EarnPositionApyType,
   type EarnWithdrawActionResponse,
   type EarnWithdrawRequestBody,
   type EthereumEarnPositionQuery,
@@ -32,11 +34,13 @@ export {
   type ListWalletActionsQuery,
   type ListWalletActionsResponse,
   type MorphoVaultDetails,
+  type PayoutResponse,
   type SvmTransactionWalletActionStep,
   type SvmWalletActionStepStatus,
   type SwapActionResponse,
   type TvmTransactionWalletActionStep,
   type TvmWalletActionStepStatus,
+  type TempoVaultDetails,
   type TransferActionResponse,
   type VedaVaultDetails,
   type WalletActionInclude,
@@ -58,20 +62,48 @@ export {
   type AdvancedSwapRequestBody,
   type AdvancedSwapResponse,
   type AmountType,
+  type AptosBcsHex,
+  type AptosRpcInput,
+  type AptosRpcResponse,
+  type AptosSignTransactionRpcInput,
+  type AptosSignTransactionRpcInputParams,
+  type AptosSignTransactionRpcResponse,
+  type AptosSignTransactionRpcResponseData,
+  type AptosSignedTransactionBcsHex,
+  type AttachWalletAutomationRequestBody,
+  type AttachedWalletAutomation,
   type AuthorizationKeyDashboardResponse,
   type AuthorizationKeyResponse,
   type AuthorizationKeyRole,
+  type CreateCryptoDepositAccountRequestBody,
+  type CreateCryptoDepositAccountResponse,
+  type CreateCryptoDepositAccountWithConfigRequestBody,
+  type CreateCryptoDepositAccountWithRouteRequestBody,
+  type CryptoDepositAccountCaip2,
+  type CryptoDepositAccountChain,
+  type CryptoDepositAccountConfigResponse,
+  type CryptoDepositAccountSourceChain,
+  type CryptoDepositAccountSourceCurrency,
+  type CryptoDepositAddressRoute,
+  type CryptoDepositAsset,
+  type CryptoDepositAssetFilter,
+  type CryptoDepositAssetFilterAll,
+  type CryptoDepositAssetFilterExclude,
+  type CryptoDepositAssetFilterInclude,
   type CurveSigningChainType,
   type CurveType,
   type CustodialWallet,
+  type CustodialWalletChain,
   type CustodialWalletChainType,
   type CustodialWalletCreateInput,
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
+  type DetachWalletAutomationRequestBody,
   type DeveloperFee,
   type EncryptedAuthorizationKey,
   type EncryptedBoundAuthenticateResponse,
   type EncryptedWalletAuthenticateResponse,
+  type EntityID,
   type EthereumPersonalSignRpcInput,
   type EthereumPersonalSignRpcInputParams,
   type EthereumPersonalSignRpcResponse,
@@ -120,6 +152,8 @@ export {
   type FirstClassChainType,
   type Gas,
   type GetByWalletAddressRequestBody,
+  type GetCryptoDepositAccountNextOrderResponse,
+  type GetCryptoDepositAccountOrderResponse,
   type HDInitInput,
   type HDPath,
   type HDSubmitInput,
@@ -128,7 +162,16 @@ export {
   type HpkeImportConfig,
   type Hex,
   type IntentBinding,
+  type ListCryptoDepositAccountsResponse,
   type NamedTokenTransferSource,
+  type NearRpcRequestBody,
+  type NearRpcResponse,
+  type NearSignTransactionRpcRequestBody,
+  type NearSignTransactionRpcRequestBodyParams,
+  type NearSignTransactionRpcResponse,
+  type NearSignTransactionRpcResponseData,
+  type NearSignedTransactionBorshBase64,
+  type NearUnsignedTransactionBorshBase64,
   type OutputWithPreviousTransactionData,
   type PolicyInput,
   type PrivateKeyExportInput,
@@ -266,6 +309,7 @@ export {
   type UserOperationInput,
   type UserSigningKeyBinding,
   type Wallet,
+  type WalletActionNonce,
   type WalletAdditionalSigner,
   type WalletAdditionalSignerItem,
   type WalletAPIRegisterAuthorizationKeyInput,
@@ -279,6 +323,8 @@ export {
   type WalletAuthenticateRequestBody,
   type WalletAuthenticateWithJwtResponse,
   type WalletAuthorizationHeaders,
+  type WalletAutomationAttachmentListResponse,
+  type WalletAutomationAttachmentResponse,
   type WalletBatchCreateInput,
   type WalletBatchCreateResponse,
   type WalletBatchCreateResult,
@@ -287,6 +333,9 @@ export {
   type WalletCreateWalletsWithRecoveryResponse,
   type WalletCustodian,
   type WalletEntity,
+  type WalletEntityAssignmentRequestBody,
+  type WalletEntityAssignmentResponse,
+  type WalletEntityType,
   type WalletEntropyType,
   type WalletEthereumAsset,
   type WalletExportRequestBody,
@@ -300,6 +349,12 @@ export {
   type WalletSolanaAsset,
   type WalletTronAsset,
   type WalletUpdateRequestBody,
+  type XrplRpcInput,
+  type XrplRpcResponse,
+  type XrplSignTransactionRpcInput,
+  type XrplSignTransactionRpcInputParams,
+  type XrplSignTransactionRpcResponse,
+  type XrplSignTransactionRpcResponseData,
   type WalletCreateParams,
   type WalletUpdateParams,
   type WalletListParams,

package/src/resources/wallets/transactions.ts

@@ -48,7 +48,11 @@ export namespace TransactionGetResponse {
      */
     details: Transaction.Details;
 
-    privy_transaction_id: string;
+    /**
+     * Privy's ID for the transaction, or `null` if the transaction was not broadcasted
+     * through Privy.
+     */
+    privy_transaction_id: string | null;
 
     /**
      * Status of a blockchain transaction submitted by Privy.
@@ -57,6 +61,11 @@ export namespace TransactionGetResponse {
 
     transaction_hash: string | null;
 
+    /**
+     * The wallet whose history this transaction belongs to. The sending wallet for
+     * outbound transactions, including every transaction Privy broadcasted, and the
+     * receiving wallet for inbound transfers.
+     */
     wallet_id: string;
 
     sponsored?: boolean;
@@ -98,6 +107,7 @@ export interface TransactionGetParams {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'ousd'
     | 'pathusd'
     | 'sol'
     | 'trx'