@privy-io/api-types 0.17.0 → 0.19.0

package/src/resources/wallets/wallets.ts

@@ -625,7 +625,7 @@ export interface CustomTokenTransferSource {
 
   /**
    * The blockchain network on which to perform the transfer. Supported chains
-   * include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and their
+   * include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and their
    * respective testnets.
    */
   chain: string;
@@ -723,7 +723,7 @@ export interface EthereumPersonalSignRpcInput {
   address?: string;
 
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2?: AppsAPI.Caip2;
 
@@ -817,7 +817,7 @@ export interface EthereumSecp256k1SignRpcInput {
  */
 export interface EthereumSecp256k1SignRpcInputParams {
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   hash: Hex;
@@ -842,7 +842,7 @@ export interface EthereumSecp256k1SignRpcResponseData {
   encoding: 'hex';
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   signature: Hex;
@@ -855,7 +855,7 @@ export interface EthereumSendCallsCall {
   to: string;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   data?: Hex;
@@ -873,7 +873,7 @@ export interface EthereumSendCallsCall {
  */
 export interface EthereumSendCallsRpcInput {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -889,13 +889,19 @@ export interface EthereumSendCallsRpcInput {
   chain_type?: 'ethereum';
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   experimental_data_suffix?: Hex;
 
   sponsor?: boolean;
 
+  /**
+   * Options for user-pays gas sponsorship on the RPC endpoint. When provided
+   * alongside `sponsor: true`, controls which token asset the user pays gas with.
+   */
+  sponsor_options?: RpcSponsorOptions;
+
   wallet_id?: string;
 }
 
@@ -923,7 +929,7 @@ export interface EthereumSendCallsRpcResponse {
  */
 export interface EthereumSendCallsRpcResponseData {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -935,7 +941,7 @@ export interface EthereumSendCallsRpcResponseData {
  */
 export interface EthereumSendTransactionRpcInput {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -951,7 +957,7 @@ export interface EthereumSendTransactionRpcInput {
   chain_type?: 'ethereum';
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   experimental_data_suffix?: Hex;
@@ -960,6 +966,12 @@ export interface EthereumSendTransactionRpcInput {
 
   sponsor?: boolean;
 
+  /**
+   * Options for user-pays gas sponsorship on the RPC endpoint. When provided
+   * alongside `sponsor: true`, controls which token asset the user pays gas with.
+   */
+  sponsor_options?: RpcSponsorOptions;
+
   wallet_id?: string;
 }
 
@@ -991,7 +1003,7 @@ export interface EthereumSendTransactionRpcResponse {
  */
 export interface EthereumSendTransactionRpcResponseData {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -1030,13 +1042,13 @@ export interface EthereumSign7702Authorization {
   nonce: Quantity;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   r: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   s: Hex;
@@ -1171,7 +1183,7 @@ export interface EthereumSignTypedDataRpcInput {
   address?: string;
 
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2?: AppsAPI.Caip2;
 
@@ -1553,7 +1565,7 @@ export interface HpkeImportConfig {
 }
 
 /**
- * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+ * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
  * bytes).
  */
 export type Hex = string;
@@ -1573,14 +1585,14 @@ export interface IntentBinding {
  */
 export interface NamedTokenTransferSource {
   /**
-   * The asset to transfer. Supported: 'usdc', 'usdb', 'usdt' (stablecoins), 'eth'
-   * (native Ethereum), 'sol' (native Solana).
+   * The asset to transfer. Supported: 'usdc', 'usdb', 'usdt', 'pathusd'
+   * (stablecoins), 'eth' (native Ethereum), 'sol' (native Solana).
    */
   asset: string;
 
   /**
    * The blockchain network on which to perform the transfer. Supported chains
-   * include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and their
+   * include: 'tempo', 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and their
    * respective testnets.
    */
   chain: string;
@@ -1783,7 +1795,7 @@ export interface RawSignBytesParams {
  */
 export interface RawSignHashParams {
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   hash: Hex;
@@ -1824,7 +1836,7 @@ export interface RawSignResponseData {
   encoding: 'hex';
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   signature: Hex;
@@ -1868,6 +1880,24 @@ export interface RelayerFee {
   recipient?: string;
 }
 
+/**
+ * Token asset identifier for user-pays gas sponsorship. Common values: 'usdc',
+ * 'usdt', 'eurc', 'usdg', 'usdc_e'. Available tokens vary by chain.
+ */
+export type RpcSponsorAsset = string;
+
+/**
+ * Options for user-pays gas sponsorship on the RPC endpoint. When provided
+ * alongside `sponsor: true`, controls which token asset the user pays gas with.
+ */
+export interface RpcSponsorOptions {
+  /**
+   * Token asset identifier for user-pays gas sponsorship. Common values: 'usdc',
+   * 'usdt', 'eurc', 'usdg', 'usdc_e'. Available tokens vary by chain.
+   */
+  asset: RpcSponsorAsset;
+}
+
 /**
  * Input for exporting a wallet (private key or seed phrase) with HPKE encryption.
  */
@@ -1953,7 +1983,7 @@ export type SolanaRpcResponse =
  */
 export interface SolanaSignAndSendTransactionRpcInput {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -1974,6 +2004,12 @@ export interface SolanaSignAndSendTransactionRpcInput {
 
   sponsor?: boolean;
 
+  /**
+   * Options for user-pays gas sponsorship on the RPC endpoint. When provided
+   * alongside `sponsor: true`, controls which token asset the user pays gas with.
+   */
+  sponsor_options?: RpcSponsorOptions;
+
   wallet_id?: string;
 }
 
@@ -2003,7 +2039,7 @@ export interface SolanaSignAndSendTransactionRpcResponse {
  */
 export interface SolanaSignAndSendTransactionRpcResponseData {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -2953,7 +2989,7 @@ export interface TempoAaAuthorization {
   nonce: Quantity;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   signature: Hex;
@@ -2966,7 +3002,7 @@ export interface TempoCall {
   to: string;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   data?: Hex;
@@ -2983,13 +3019,13 @@ export interface TempoCall {
  */
 export interface TempoFeePayerSignature {
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   r: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   s: Hex;
@@ -3036,7 +3072,7 @@ export interface TokenTransferDestination {
 
   /**
    * The destination blockchain network. Required for cross-chain transfers (e.g.,
-   * source 'base' to destination 'arbitrum').
+   * source 'tempo' to destination 'base').
    */
   chain?: string;
 }
@@ -3070,6 +3106,7 @@ export type TransactionChainNameInput =
   | 'arbitrum'
   | 'avalanche'
   | 'base'
+  | 'base_sepolia'
   | 'bsc'
   | 'tempo'
   | 'linea'
@@ -3195,6 +3232,7 @@ export interface TransferReceivedTransactionDetail {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'pathusd'
     | 'sol'
     | 'trx'
     | (string & {});
@@ -3275,6 +3313,7 @@ export interface TransferSentTransactionDetail {
     | 'usdt'
     | 'eurc'
     | 'usdb'
+    | 'pathusd'
     | 'sol'
     | 'trx'
     | (string & {});
@@ -3370,7 +3409,7 @@ export interface TronSendTransactionRpcInput {
   params: TronSendTransactionRpcInputParams;
 
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2?: AppsAPI.Caip2;
 }
@@ -3405,7 +3444,7 @@ export interface TronSendTransactionRpcResponse {
  */
 export interface TronSendTransactionRpcResponseData {
   /**
-   * A valid CAIP-2 chain ID (e.g. 'eip155:1').
+   * A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1' for Ethereum).
    */
   caip2: AppsAPI.Caip2;
 
@@ -3548,7 +3587,7 @@ export interface UnsignedStandardEthereumTransaction {
   chain_id?: Quantity;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   data?: Hex;
@@ -3671,37 +3710,37 @@ export interface UnsignedTempoTransaction {
  */
 export interface UserOperationInput {
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   call_data: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   call_gas_limit: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   max_fee_per_gas: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   max_priority_fee_per_gas: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   nonce: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   pre_verification_gas: Hex;
@@ -3709,27 +3748,35 @@ export interface UserOperationInput {
   sender: string;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   verification_gas_limit: Hex;
 
+  factory?: string;
+
+  /**
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
+   * bytes).
+   */
+  factory_data?: Hex;
+
   paymaster?: string;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   paymaster_data?: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   paymaster_post_op_gas_limit?: Hex;
 
   /**
-   * A hex-encoded string prefixed with '0x', capped at 100002 characters (50,000
+   * A hex-encoded string prefixed with '0x', capped at 300002 characters (150,000
    * bytes).
    */
   paymaster_verification_gas_limit?: Hex;
@@ -3817,6 +3864,11 @@ export interface Wallet {
    */
   display_name?: string;
 
+  /**
+   * The entity a wallet is attributed to.
+   */
+  entity?: WalletEntity | null;
+
   /**
    * A customer-provided identifier for mapping to external systems. Write-once, set
    * only at creation.
@@ -3886,6 +3938,7 @@ export type WalletAsset =
   | 'usdt'
   | 'eurc'
   | 'usdb'
+  | 'pathusd'
   | 'sol'
   | 'trx';
 
@@ -3905,6 +3958,7 @@ export type WalletAssetChainNameInput =
   | 'solana'
   | 'tron'
   | 'zksync_era'
+  | 'hoodi'
   | 'sepolia'
   | 'arbitrum_sepolia'
   | 'avalanche_fuji'
@@ -4177,6 +4231,18 @@ export interface WalletCustodian {
   provider_user_id: string;
 }
 
+/**
+ * The entity a wallet is attributed to.
+ */
+export interface WalletEntity {
+  /**
+   * The Privy DID of the entity.
+   */
+  id: string;
+
+  type: 'user';
+}
+
 /**
  * The entropy type of the wallet.
  */
@@ -4194,7 +4260,8 @@ export type WalletEthereumAsset =
   | 'bnb'
   | 'usdt'
   | 'eurc'
-  | 'usdb';
+  | 'usdb'
+  | 'pathusd';
 
 /**
  * Request body for exporting a wallet private key.
@@ -4390,6 +4457,11 @@ export interface WalletCreateParams {
    */
   display_name?: string;
 
+  /**
+   * Body param: The entity the wallet is attributed to.
+   */
+  entity?: WalletCreateParams.Entity;
+
   /**
    * Body param: A customer-provided identifier for mapping to external systems.
    * URL-safe characters only ([a-zA-Z0-9_-]), max 64 chars. Write-once: cannot be
@@ -4421,6 +4493,17 @@ export interface WalletCreateParams {
   'privy-idempotency-key'?: string;
 }
 
+export namespace WalletCreateParams {
+  /**
+   * The entity the wallet is attributed to.
+   */
+  export interface Entity {
+    id: string;
+
+    type: 'user';
+  }
+}
+
 export interface WalletUpdateParams {
   /**
    * Body param: Additional signers for the wallet.
@@ -4483,6 +4566,11 @@ export interface WalletListParams extends CursorParams {
    */
   chain_type?: WalletChainType;
 
+  /**
+   * Filter wallets by the entity ID the wallet is attributed to.
+   */
+  entity_id?: string;
+
   /**
    * Filter wallets by external ID.
    */
@@ -4638,7 +4726,8 @@ export declare namespace WalletRpcParams {
 
   export interface EthereumSendTransactionRpcInput {
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2: AppsAPI.Caip2;
 
@@ -4663,8 +4752,8 @@ export declare namespace WalletRpcParams {
     chain_type?: 'ethereum';
 
     /**
-     * Body param: A hex-encoded string prefixed with '0x', capped at 100002 characters
-     * (50,000 bytes).
+     * Body param: A hex-encoded string prefixed with '0x', capped at 300002 characters
+     * (150,000 bytes).
      */
     experimental_data_suffix?: Hex;
 
@@ -4678,6 +4767,13 @@ export declare namespace WalletRpcParams {
      */
     sponsor?: boolean;
 
+    /**
+     * Body param: Options for user-pays gas sponsorship on the RPC endpoint. When
+     * provided alongside `sponsor: true`, controls which token asset the user pays gas
+     * with.
+     */
+    sponsor_options?: RpcSponsorOptions;
+
     /**
      * Body param
      */
@@ -4719,7 +4815,8 @@ export declare namespace WalletRpcParams {
     address?: string;
 
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2?: AppsAPI.Caip2;
 
@@ -4775,7 +4872,8 @@ export declare namespace WalletRpcParams {
     address?: string;
 
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2?: AppsAPI.Caip2;
 
@@ -4951,7 +5049,8 @@ export declare namespace WalletRpcParams {
 
   export interface EthereumSendCallsRpcInput {
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2: AppsAPI.Caip2;
 
@@ -4976,8 +5075,8 @@ export declare namespace WalletRpcParams {
     chain_type?: 'ethereum';
 
     /**
-     * Body param: A hex-encoded string prefixed with '0x', capped at 100002 characters
-     * (50,000 bytes).
+     * Body param: A hex-encoded string prefixed with '0x', capped at 300002 characters
+     * (150,000 bytes).
      */
     experimental_data_suffix?: Hex;
 
@@ -4986,6 +5085,13 @@ export declare namespace WalletRpcParams {
      */
     sponsor?: boolean;
 
+    /**
+     * Body param: Options for user-pays gas sponsorship on the RPC endpoint. When
+     * provided alongside `sponsor: true`, controls which token asset the user pays gas
+     * with.
+     */
+    sponsor_options?: RpcSponsorOptions;
+
     /**
      * Body param
      */
@@ -5057,7 +5163,8 @@ export declare namespace WalletRpcParams {
 
   export interface SolanaSignAndSendTransactionRpcInput {
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2: AppsAPI.Caip2;
 
@@ -5096,6 +5203,13 @@ export declare namespace WalletRpcParams {
      */
     sponsor?: boolean;
 
+    /**
+     * Body param: Options for user-pays gas sponsorship on the RPC endpoint. When
+     * provided alongside `sponsor: true`, controls which token asset the user pays gas
+     * with.
+     */
+    sponsor_options?: RpcSponsorOptions;
+
     /**
      * Body param
      */
@@ -5582,7 +5696,8 @@ export declare namespace WalletRpcParams {
     params: TronSendTransactionRpcInputParams;
 
     /**
-     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:1').
+     * Body param: A valid CAIP-2 chain ID (e.g. 'eip155:4217' for Tempo, 'eip155:1'
+     * for Ethereum).
      */
     caip2?: AppsAPI.Caip2;
 
@@ -5783,6 +5898,8 @@ export declare namespace Wallets {
     type RawWalletAuthenticateResponse as RawWalletAuthenticateResponse,
     type RecipientPublicKey as RecipientPublicKey,
     type RelayerFee as RelayerFee,
+    type RpcSponsorAsset as RpcSponsorAsset,
+    type RpcSponsorOptions as RpcSponsorOptions,
     type SeedPhraseExportInput as SeedPhraseExportInput,
     type SeedPhraseExportResponse as SeedPhraseExportResponse,
     type SignatureOptions as SignatureOptions,
@@ -5918,6 +6035,7 @@ export declare namespace Wallets {
     type WalletChainType as WalletChainType,
     type WalletCreateWalletsWithRecoveryResponse as WalletCreateWalletsWithRecoveryResponse,
     type WalletCustodian as WalletCustodian,
+    type WalletEntity as WalletEntity,
     type WalletEntropyType as WalletEntropyType,
     type WalletEthereumAsset as WalletEthereumAsset,
     type WalletExportRequestBody as WalletExportRequestBody,