@privy-io/api-types 0.8.0 → 0.9.0

package/src/resources/wallets/wallets.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../../core/resource';
 import * as WalletsAPI from './wallets';
 import * as AppsAPI from '../apps';
 import * as SharedAPI from '../shared';
+import * as UsersAPI from '../users';
 import * as BalanceAPI from './balance';
 import { Balance, BalanceGetParams, BalanceGetResponse } from './balance';
 import * as TransactionsAPI from './transactions';
@@ -63,18 +64,19 @@ export class Wallets extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.wallets._export('wallet_id', {
-   *   encryption_type: 'HPKE',
-   *   recipient_public_key:
-   *     'BDAZLOIdTaPycEYkgG0MvCzbIKJLli/yWkAV5yCa9yOsZ4JsrLweA5MnP8YIiY4k/RRzC+APhhO+P+Hoz/rt7Go=',
-   * });
+   * const walletExportResponseBody =
+   *   await client.wallets._export('wallet_id', {
+   *     encryption_type: 'HPKE',
+   *     recipient_public_key:
+   *       'BDAZLOIdTaPycEYkgG0MvCzbIKJLli/yWkAV5yCa9yOsZ4JsrLweA5MnP8YIiY4k/RRzC+APhhO+P+Hoz/rt7Go=',
+   *   });
    * ```
    */
   _export(
     walletID: string,
     params: WalletExportParams,
     options?: RequestOptions,
-  ): APIPromise<WalletExportResponse> {
+  ): APIPromise<WalletExportResponseBody> {
     const {
       'privy-authorization-signature': privyAuthorizationSignature,
       'privy-request-expiry': privyRequestExpiry,
@@ -318,6 +320,7 @@ export type CurveSigningChainType =
   | 'movement'
   | 'tron'
   | 'bitcoin-segwit'
+  | 'bitcoin-taproot'
   | 'near'
   | 'ton'
   | 'starknet';
@@ -333,6 +336,7 @@ export type ExtendedChainType =
   | 'movement'
   | 'tron'
   | 'bitcoin-segwit'
+  | 'bitcoin-taproot'
   | 'near'
   | 'ton'
   | 'starknet'
@@ -356,6 +360,7 @@ export type WalletChainType =
   | 'movement'
   | 'tron'
   | 'bitcoin-segwit'
+  | 'bitcoin-taproot'
   | 'near'
   | 'ton'
   | 'starknet'
@@ -633,6 +638,8 @@ export interface WalletImportInitResponse {
    * The encryption type of the wallet to import. Currently only supports `HPKE`.
    */
   encryption_type: HpkeEncryption;
+
+  import_id?: string;
 }
 
 /**
@@ -677,7 +684,7 @@ export type HDPath = string;
 /**
  * The signing algorithm used by the wallet.
  */
-export type SigningAlgorithm = 'ECDSA' | 'EdDSA';
+export type SigningAlgorithm = 'ECDSA' | 'EdDSA' | 'Schnorr';
 
 /**
  * A hex-encoded string prefixed with '0x'.
@@ -2642,6 +2649,188 @@ export interface WalletAuthenticateRequestBody {
   user_jwt: string;
 }
 
+/**
+ * The input for private key wallets.
+ */
+export interface PrivateKeyInitInput {
+  /**
+   * The address of the wallet to import.
+   */
+  address: string;
+
+  /**
+   * The chain type of the wallet to import. Currently supports `ethereum` and
+   * `solana`.
+   */
+  chain_type: WalletImportSupportedChains;
+
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+
+  entropy_type: 'private-key';
+}
+
+/**
+ * The input for HD wallets.
+ */
+export interface HDInitInput {
+  /**
+   * The address of the wallet to import.
+   */
+  address: string;
+
+  /**
+   * The chain type of the wallet to import. Currently supports `ethereum` and
+   * `solana`.
+   */
+  chain_type: WalletImportSupportedChains;
+
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+
+  /**
+   * The entropy type of the wallet to import.
+   */
+  entropy_type: 'hd';
+
+  /**
+   * The index of the wallet to import.
+   */
+  index: number;
+}
+
+/**
+ * The submission input for importing a private key wallet.
+ */
+export interface PrivateKeySubmitInput {
+  /**
+   * The address of the wallet to import.
+   */
+  address: string;
+
+  /**
+   * The chain type of the wallet to import. Currently supports `ethereum` and
+   * `solana`.
+   */
+  chain_type: WalletImportSupportedChains;
+
+  /**
+   * The encrypted entropy of the wallet to import.
+   */
+  ciphertext: string;
+
+  /**
+   * The base64-encoded encapsulated key that was generated during encryption, for
+   * use during decryption inside the TEE.
+   */
+  encapsulated_key: string;
+
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+
+  entropy_type: 'private-key';
+
+  /**
+   * Optional HPKE configuration for wallet import decryption. These parameters allow
+   * importing wallets encrypted by external providers that use different HPKE
+   * configurations.
+   */
+  hpke_config?: HpkeImportConfig;
+}
+
+/**
+ * The submission input for importing an HD wallet.
+ */
+export interface HDSubmitInput {
+  /**
+   * The address of the wallet to import.
+   */
+  address: string;
+
+  /**
+   * The chain type of the wallet to import. Currently supports `ethereum` and
+   * `solana`.
+   */
+  chain_type: WalletImportSupportedChains;
+
+  /**
+   * The encrypted entropy of the wallet to import.
+   */
+  ciphertext: string;
+
+  /**
+   * The base64-encoded encapsulated key that was generated during encryption, for
+   * use during decryption inside the TEE.
+   */
+  encapsulated_key: string;
+
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+
+  /**
+   * The entropy type of the wallet to import.
+   */
+  entropy_type: 'hd';
+
+  /**
+   * The index of the wallet to import.
+   */
+  index: number;
+
+  /**
+   * Optional HPKE configuration for wallet import decryption. These parameters allow
+   * importing wallets encrypted by external providers that use different HPKE
+   * configurations.
+   */
+  hpke_config?: HpkeImportConfig;
+}
+
+/**
+ * Request body for exporting a wallet private key.
+ */
+export interface WalletExportRequestBody {
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+
+  /**
+   * The base64-encoded encryption public key to encrypt the wallet private key with.
+   */
+  recipient_public_key: string;
+
+  export_seed_phrase?: boolean;
+}
+
+/**
+ * Response body containing the encrypted wallet private key.
+ */
+export interface WalletExportResponseBody {
+  /**
+   * The encrypted private key.
+   */
+  ciphertext: string;
+
+  /**
+   * The base64-encoded encapsulated key that was generated during encryption, for
+   * use during decryption.
+   */
+  encapsulated_key: string;
+
+  /**
+   * The encryption type of the wallet to import. Currently only supports `HPKE`.
+   */
+  encryption_type: HpkeEncryption;
+}
+
 /**
  * The source asset, amount, and chain for a token transfer.
  */
@@ -2680,7 +2869,7 @@ export interface TokenTransferDestination {
 /**
  * Request body for initiating a sponsored token transfer from an embedded wallet.
  */
-export interface CreateTokenTransferRequest {
+export interface TransferRequestBody {
   /**
    * The destination address for a token transfer.
    */
@@ -2697,6 +2886,110 @@ export interface CreateTokenTransferRequest {
  */
 export type SuiCommandName = 'TransferObjects' | 'SplitCoins' | 'MergeCoins';
 
+/**
+ * A named asset on Ethereum-compatible chains.
+ */
+export type WalletEthereumAsset = 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb';
+
+/**
+ * A named asset on Solana.
+ */
+export type WalletSolanaAsset = 'sol' | 'usdc' | 'eurc' | 'usdb';
+
+/**
+ * A named asset supported across all chains.
+ */
+export type WalletAsset = 'usdc' | 'usdc.e' | 'eth' | 'pol' | 'usdt' | 'eurc' | 'usdb' | 'sol';
+
+/**
+ * Details for a sent transfer transaction.
+ */
+export interface TransferSentTransactionDetail {
+  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';
+}
+
+/**
+ * Details for a received transfer transaction.
+ */
+export interface TransferReceivedTransactionDetail {
+  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 TransactionDetail = TransferSentTransactionDetail | TransferReceivedTransactionDetail;
+
 /**
  * Input for registering or updating an application public signing key for
  * API-based wallet actions.
@@ -2775,24 +3068,6 @@ export interface WalletAuthorizationHeaders {
   'privy-request-expiry'?: string;
 }
 
-export interface WalletExportResponse {
-  /**
-   * The encrypted private key.
-   */
-  ciphertext: string;
-
-  /**
-   * The base64-encoded encapsulated key that was generated during encryption, for
-   * use during decryption.
-   */
-  encapsulated_key: string;
-
-  /**
-   * The encryption type of the wallet to import. Currently only supports `HPKE`.
-   */
-  encryption_type: HpkeEncryption;
-}
-
 export interface WalletInitImportResponse {
   /**
    * The base64-encoded encryption public key to encrypt the wallet entropy with.
@@ -3995,7 +4270,10 @@ export declare namespace WalletRpcParams {
 }
 
 export interface WalletSubmitImportParams {
-  wallet: WalletSubmitImportParams.HDSubmitInput | WalletSubmitImportParams.PrivateKeySubmitInput;
+  /**
+   * The submission input for importing an HD wallet.
+   */
+  wallet: HDSubmitInput | PrivateKeySubmitInput;
 
   /**
    * Additional signers for the wallet.
@@ -4032,92 +4310,6 @@ export interface WalletSubmitImportParams {
   policy_ids?: PolicyInput;
 }
 
-export namespace WalletSubmitImportParams {
-  export interface HDSubmitInput {
-    /**
-     * The address of the wallet to import.
-     */
-    address: string;
-
-    /**
-     * The chain type of the wallet to import. Currently supports `ethereum` and
-     * `solana`.
-     */
-    chain_type: WalletsAPI.WalletImportSupportedChains;
-
-    /**
-     * The encrypted entropy of the wallet to import.
-     */
-    ciphertext: string;
-
-    /**
-     * The base64-encoded encapsulated key that was generated during encryption, for
-     * use during decryption inside the TEE.
-     */
-    encapsulated_key: string;
-
-    /**
-     * The encryption type of the wallet to import. Currently only supports `HPKE`.
-     */
-    encryption_type: WalletsAPI.HpkeEncryption;
-
-    /**
-     * The entropy type of the wallet to import.
-     */
-    entropy_type: 'hd';
-
-    /**
-     * The index of the wallet to import.
-     */
-    index: number;
-
-    /**
-     * Optional HPKE configuration for wallet import decryption. These parameters allow
-     * importing wallets encrypted by external providers that use different HPKE
-     * configurations.
-     */
-    hpke_config?: WalletsAPI.HpkeImportConfig;
-  }
-
-  export interface PrivateKeySubmitInput {
-    /**
-     * The address of the wallet to import.
-     */
-    address: string;
-
-    /**
-     * The chain type of the wallet to import. Currently supports `ethereum` and
-     * `solana`.
-     */
-    chain_type: WalletsAPI.WalletImportSupportedChains;
-
-    /**
-     * The encrypted entropy of the wallet to import.
-     */
-    ciphertext: string;
-
-    /**
-     * The base64-encoded encapsulated key that was generated during encryption, for
-     * use during decryption inside the TEE.
-     */
-    encapsulated_key: string;
-
-    /**
-     * The encryption type of the wallet to import. Currently only supports `HPKE`.
-     */
-    encryption_type: WalletsAPI.HpkeEncryption;
-
-    entropy_type: 'private-key';
-
-    /**
-     * Optional HPKE configuration for wallet import decryption. These parameters allow
-     * importing wallets encrypted by external providers that use different HPKE
-     * configurations.
-     */
-    hpke_config?: WalletsAPI.HpkeImportConfig;
-  }
-}
-
 export interface WalletUpdateParams {
   /**
    * Body param: Additional signers for the wallet.
@@ -4196,27 +4388,7 @@ export namespace WalletCreateWalletsWithRecoveryParams {
   }
 
   export interface RecoveryUser {
-    linked_accounts: Array<RecoveryUser.UnionMember0 | RecoveryUser.UnionMember1>;
-  }
-
-  export namespace RecoveryUser {
-    export interface UnionMember0 {
-      /**
-       * The email address of the user.
-       */
-      address: string;
-
-      type: 'email';
-    }
-
-    export interface UnionMember1 {
-      /**
-       * The JWT subject ID of the user.
-       */
-      custom_user_id: string;
-
-      type: 'custom_auth';
-    }
+    linked_accounts: Array<UsersAPI.LinkedAccountEmailInput | UsersAPI.LinkedAccountCustomJwtInput>;
   }
 
   export interface Wallet {
@@ -4409,16 +4581,27 @@ export declare namespace Wallets {
     type WalletRpcRequestBody as WalletRpcRequestBody,
     type WalletRpcResponse as WalletRpcResponse,
     type WalletAuthenticateRequestBody as WalletAuthenticateRequestBody,
+    type PrivateKeyInitInput as PrivateKeyInitInput,
+    type HDInitInput as HDInitInput,
+    type PrivateKeySubmitInput as PrivateKeySubmitInput,
+    type HDSubmitInput as HDSubmitInput,
+    type WalletExportRequestBody as WalletExportRequestBody,
+    type WalletExportResponseBody as WalletExportResponseBody,
     type TokenTransferSource as TokenTransferSource,
     type TokenTransferDestination as TokenTransferDestination,
-    type CreateTokenTransferRequest as CreateTokenTransferRequest,
+    type TransferRequestBody as TransferRequestBody,
     type SuiCommandName as SuiCommandName,
+    type WalletEthereumAsset as WalletEthereumAsset,
+    type WalletSolanaAsset as WalletSolanaAsset,
+    type WalletAsset as WalletAsset,
+    type TransferSentTransactionDetail as TransferSentTransactionDetail,
+    type TransferReceivedTransactionDetail as TransferReceivedTransactionDetail,
+    type TransactionDetail as TransactionDetail,
     type WalletAPIRegisterAuthorizationKeyInput as WalletAPIRegisterAuthorizationKeyInput,
     type WalletAPIRevokeAuthorizationKeyInput as WalletAPIRevokeAuthorizationKeyInput,
     type AuthorizationKeyDashboardResponse as AuthorizationKeyDashboardResponse,
     type AuthorizationKeyResponse as AuthorizationKeyResponse,
     type WalletAuthorizationHeaders as WalletAuthorizationHeaders,
-    type WalletExportResponse as WalletExportResponse,
     type WalletInitImportResponse as WalletInitImportResponse,
     type WalletAuthenticateWithJwtResponse as WalletAuthenticateWithJwtResponse,
     type WalletCreateWalletsWithRecoveryResponse as WalletCreateWalletsWithRecoveryResponse,