@privy-io/api-types 0.22.0 → 0.24.0

package/src/resources/users.ts

@@ -211,6 +211,11 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -218,11 +223,6 @@ export interface LinkedAccountBitcoinSegwitEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -256,6 +256,11 @@ export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -263,11 +268,6 @@ export interface LinkedAccountBitcoinTaprootEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -325,6 +325,11 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -332,11 +337,6 @@ export interface LinkedAccountCurveSigningEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -572,6 +572,11 @@ export interface LinkedAccountEthereumEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -579,11 +584,6 @@ export interface LinkedAccountEthereumEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -983,6 +983,11 @@ export interface LinkedAccountSolanaEmbeddedWallet {
 
   type: 'wallet';
 
+  /**
+   * Whether the user can unilaterally sign with this wallet.
+   */
+  user_can_sign: boolean;
+
   verified_at: number;
 
   wallet_client: 'privy';
@@ -990,11 +995,6 @@ export interface LinkedAccountSolanaEmbeddedWallet {
   wallet_client_type: 'privy';
 
   wallet_index: number;
-
-  /**
-   * Whether the user can unilaterally sign with this wallet.
-   */
-  user_can_sign?: boolean;
 }
 
 /**
@@ -1294,6 +1294,12 @@ export interface User {
    * Custom metadata associated with the user.
    */
   custom_metadata?: CustomMetadata;
+
+  /**
+   * Unix timestamp in seconds of when the user was frozen, or `null` if not frozen.
+   * Not included in every user response.
+   */
+  frozen_at?: number | null;
 }
 
 /**

package/src/resources/wallet-automations.ts

@@ -300,7 +300,7 @@ export interface WalletAutomationExecutionListResponse {
 }
 
 /**
- * A record of a single automation execution triggered by a deposit.
+ * A record of a single automation execution created by a deposit.
  */
 export interface WalletAutomationExecutionResponse {
   id: string;
@@ -320,6 +320,8 @@ export interface WalletAutomationExecutionResponse {
    */
   status: WalletAutomationExecutionStatus;
 
+  submitted_at: string | null;
+
   trigger_asset_address: string;
 
   trigger_block_number: string;
@@ -328,8 +330,6 @@ export interface WalletAutomationExecutionResponse {
 
   trigger_tx_hash: string;
 
-  triggered_at: string | null;
-
   updated_at: string;
 
   wallet_action_id: string | null;
@@ -340,7 +340,7 @@ export interface WalletAutomationExecutionResponse {
 /**
  * Execution lifecycle status.
  */
-export type WalletAutomationExecutionStatus = 'pending' | 'triggered' | 'completed' | 'failed' | 'skipped';
+export type WalletAutomationExecutionStatus = 'pending' | 'submitted' | 'completed' | 'failed' | 'skipped';
 
 /**
  * Paginated list of wallet automations.
@@ -373,23 +373,25 @@ export interface WalletAutomationReindexAssetResult {
   existing_execution_id: string | null;
 
   /**
-   * On-chain balance in base units. Populated when `status` is `triggered` or
+   * On-chain balance in base units. Populated when `status` is `submitted` or
    * `skipped_zero_balance`; `null` otherwise. For example, 1 OUSD is `1000000`.
    */
   raw_balance: string | null;
 
   /**
    * Outcome of checking a single asset during a wallet automation reindex. One of
-   * `triggered`, `skipped_zero_balance`, `skipped_no_match`,
-   * `skipped_existing_execution`, or `failed`.
+   * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
+   * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
+   * execution was enqueued.
    */
   status: WalletAutomationReindexAssetStatus;
 }
 
 /**
  * Outcome of checking a single asset during a wallet automation reindex. One of
- * `triggered`, `skipped_zero_balance`, `skipped_no_match`,
- * `skipped_existing_execution`, or `failed`.
+ * `submitted`, `skipped_zero_balance`, `skipped_no_match`,
+ * `skipped_existing_execution`, or `failed`. `submitted` confirms that an
+ * execution was enqueued.
  */
 export type WalletAutomationReindexAssetStatus = string;
 
@@ -413,6 +415,11 @@ export interface WalletAutomationReindexRequestBody {
    */
   asset_address: string;
 
+  /**
+   * Automation to target when more than one active automation matches the asset.
+   */
+  automation_id?: string;
+
   /**
    * An EVM, Solana, or Tron CAIP-2 chain identifier supported by wallet automation
    * reindex.

package/src/resources/wallets/actions.ts

@@ -27,8 +27,7 @@ export interface AaveVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -91,6 +90,14 @@ export interface CustodianTransactionWalletActionStep {
    */
   status: CustodianTransactionWalletActionStepStatus;
 
+  /**
+   * Identifier of the transaction the custodian last reported on the destination
+   * chain. Set on a settled transfer, and also on a failed one when the custodian
+   * had already broadcast a payout that was later returned. Null until the custodian
+   * reports one.
+   */
+  transaction_hash: string | null;
+
   type: 'custodian_transaction';
 
   /**
@@ -890,6 +897,9 @@ export interface FailureReason {
  * Query parameters for listing wallet actions.
  */
 export interface ListWalletActionsQuery {
+  /**
+   * Cursor returned by the previous page.
+   */
   cursor?: string;
 
   limit?: number | null;
@@ -929,8 +939,7 @@ export interface MorphoVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -998,6 +1007,12 @@ export interface PayoutResponse {
    */
   destination: FiatAPI.PayoutDestination;
 
+  /**
+   * A developer fee as a percentage string from 0 up to (not including) 100, e.g.
+   * "1.5" for 1.5%.
+   */
+  developer_fee_percent: FiatAPI.DeveloperFeePercent;
+
   /**
    * The Privy API environment.
    */
@@ -1253,8 +1268,7 @@ export interface TempoVaultDetails {
   admin_wallet_id: string | null;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -1297,6 +1311,34 @@ export interface TempoVaultDetails {
   vault_address: string;
 }
 
+/**
+ * A wallet action step representing a Tempo Zone settlement on its parent chain.
+ */
+export interface TempoZoneSettlementWalletActionStep {
+  /**
+   * CAIP-2 identifier of the Tempo parent chain, or null when unavailable.
+   */
+  caip2: string | null;
+
+  /**
+   * Status of an external transaction step in a wallet action.
+   */
+  status: ExternalTransactionWalletActionStepStatus;
+
+  /**
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
+   * bytes).
+   */
+  transaction_hash: WalletsAPI.Hex | null;
+
+  type: 'tempo_zone_settlement';
+
+  /**
+   * A description of why a wallet action (or a step within a wallet action) failed.
+   */
+  failure_reason?: FailureReason;
+}
+
 /**
  * Response for a transfer action.
  */
@@ -1439,8 +1481,7 @@ export interface VedaVaultDetails {
   admin_wallet_id: string;
 
   /**
-   * Annual percentage yield earned by the app from fee wrapper fees, in basis
-   * points.
+   * Annual percentage yield earned by the app from vault fees, in basis points.
    */
   app_apy: number | null;
 
@@ -1514,7 +1555,8 @@ export type WalletActionStep =
   | SvmTransactionWalletActionStep
   | TvmTransactionWalletActionStep
   | ExternalTransactionWalletActionStep
-  | CustodianTransactionWalletActionStep;
+  | CustodianTransactionWalletActionStep
+  | TempoZoneSettlementWalletActionStep;
 
 /**
  * Type of a wallet action step.
@@ -1525,7 +1567,8 @@ export type WalletActionStepType =
   | 'svm_transaction'
   | 'tvm_transaction'
   | 'external_transaction'
-  | 'custodian_transaction';
+  | 'custodian_transaction'
+  | 'tempo_zone_settlement';
 
 /**
  * Type of wallet action
@@ -1580,6 +1623,7 @@ export declare namespace Actions {
     type TvmTransactionWalletActionStep as TvmTransactionWalletActionStep,
     type TvmWalletActionStepStatus as TvmWalletActionStepStatus,
     type TempoVaultDetails as TempoVaultDetails,
+    type TempoZoneSettlementWalletActionStep as TempoZoneSettlementWalletActionStep,
     type TransferActionResponse as TransferActionResponse,
     type VedaVaultDetails as VedaVaultDetails,
     type WalletActionInclude as WalletActionInclude,

package/src/resources/wallets/balance.ts

@@ -42,6 +42,7 @@ export namespace BalanceGetResponse {
       | 'avax'
       | 'pol'
       | 'bnb'
+      | 'mon'
       | 'usdt'
       | 'eurc'
       | 'usdb'
@@ -84,6 +85,7 @@ export interface BalanceGetParams {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -119,6 +121,7 @@ export interface BalanceGetParams {
     | 'hyperevm'
     | 'hypercore'
     | 'arc'
+    | 'monad'
     | 'tempo_testnet'
     | 'hoodi'
     | 'sepolia'

package/src/resources/wallets/index.ts

@@ -41,6 +41,7 @@ export {
   type TvmTransactionWalletActionStep,
   type TvmWalletActionStepStatus,
   type TempoVaultDetails,
+  type TempoZoneSettlementWalletActionStep,
   type TransferActionResponse,
   type VedaVaultDetails,
   type WalletActionInclude,
@@ -82,9 +83,12 @@ export {
   type CryptoDepositAccountCaip2,
   type CryptoDepositAccountChain,
   type CryptoDepositAccountConfigResponse,
+  type CryptoDepositAccountConfigSearchResponse,
+  type CryptoDepositAccountSearchCurrency,
   type CryptoDepositAccountSourceChain,
   type CryptoDepositAccountSourceCurrency,
   type CryptoDepositAddressRoute,
+  type CryptoDepositAddressStrategy,
   type CryptoDepositAsset,
   type CryptoDepositAssetFilter,
   type CryptoDepositAssetFilterAll,
@@ -98,6 +102,11 @@ export {
   type CustodialWalletCreateInput,
   type CustodialWalletProvider,
   type CustomTokenTransferSource,
+  type DepositAccountCryptoQuoteAmount,
+  type DepositAccountCryptoQuoteAsset,
+  type DepositAccountCryptoQuoteRequestBody,
+  type DepositAccountCryptoQuoteResponse,
+  type DerivationInput,
   type DetachWalletAutomationRequestBody,
   type DeveloperFee,
   type EncryptedAuthorizationKey,
@@ -280,10 +289,19 @@ export {
   type TransactionChainNameInput,
   type TransactionDetail,
   type TransactionTokenAddressInput,
+  type TransferCustodyOptions,
+  type TransferInitiation,
+  type TransferInitiationAttestations,
+  type TransferInitiationChannel,
+  type TransferInitiationSubchannel,
   type TransferQuoteRequestBody,
   type TransferQuoteResponse,
   type TransferReceivedTransactionDetail,
   type TransferRequestBody,
+  type TransferScaAttestation,
+  type TransferScaAuthFactor,
+  type TransferScaAuthFactorCategory,
+  type TransferScaOutcome,
   type TransferSentTransactionDetail,
   type TronContract,
   type TronRawDataForSend,

package/src/resources/wallets/transactions.ts

@@ -104,6 +104,7 @@ export interface TransactionGetParams {
     | 'avax'
     | 'pol'
     | 'bnb'
+    | 'mon'
     | 'usdt'
     | 'eurc'
     | 'usdb'
@@ -113,6 +114,9 @@ export interface TransactionGetParams {
     | 'trx'
     | Array<WalletsAPI.WalletAsset>;
 
+  /**
+   * Cursor returned by the previous page.
+   */
   cursor?: string;
 
   /**