@privy-io/api-types 0.3.4 → 0.4.0

package/resources/wallets/wallets.d.ts

@@ -11,7 +11,7 @@ export declare class Wallets extends APIResource {
     transactions: TransactionsAPI.Transactions;
     balance: BalanceAPI.Balance;
     /**
-     * Create a new wallet.
+     * Creates a new wallet on the requested chain and for the requested owner.
      *
      * @example
      * ```ts
@@ -155,6 +155,9 @@ export type CurveSigningChainType = 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'mo
  * The wallet chain types that offer first class support.
  */
 export type FirstClassChainType = 'ethereum' | 'solana';
+/**
+ * A wallet managed by Privy's wallet infrastructure.
+ */
 export interface Wallet {
     /**
      * Unique ID of the wallet. This will be the primary identifier when using the
@@ -231,6 +234,97 @@ export type ExtendedChainType = 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'moveme
 export interface WalletCustodian {
     name: string;
 }
+/**
+ * The provider of the custodial wallet.
+ */
+export type CustodialWalletProvider = 'bridge';
+/**
+ * The chain type of the custodial wallet.
+ */
+export type CustodialWalletChainType = 'ethereum';
+/**
+ * The input for creating a custodial wallet.
+ */
+export interface CustodialWalletCreateInput {
+    /**
+     * The chain type of the custodial wallet.
+     */
+    chain_type: CustodialWalletChainType;
+    /**
+     * The provider of the custodial wallet.
+     */
+    provider: CustodialWalletProvider;
+    /**
+     * The resource ID of the beneficiary of the custodial wallet, given by the
+     * licensing provider.
+     */
+    provider_user_id: string;
+    additional_signers?: Array<CustodialWalletCreateInput.AdditionalSigner>;
+    owner?: CustodialWalletCreateInput.UserID | CustodialWalletCreateInput.PublicKey | null;
+    policy_ids?: Array<string>;
+}
+export declare namespace CustodialWalletCreateInput {
+    interface AdditionalSigner {
+        signer_id: string;
+        override_policy_ids?: Array<string>;
+    }
+    interface UserID {
+        user_id: string;
+    }
+    interface PublicKey {
+        public_key: string;
+    }
+}
+/**
+ * Information about a custodial wallet.
+ */
+export interface CustodialWallet {
+    id: string;
+    address: string;
+    /**
+     * The chain type of the custodial wallet.
+     */
+    chain_type: CustodialWalletChainType;
+    owner_id: string | null;
+    /**
+     * The provider of the custodial wallet.
+     */
+    provider: CustodialWalletProvider;
+    additional_signers?: Array<CustodialWallet.AdditionalSigner>;
+    policy_ids?: Array<string>;
+}
+export declare namespace CustodialWallet {
+    interface AdditionalSigner {
+        signer_id: string;
+        override_policy_ids?: Array<string>;
+    }
+}
+/**
+ * Optional HPKE configuration for wallet import decryption. These parameters allow
+ * importing wallets encrypted by external providers that use different HPKE
+ * configurations.
+ */
+export interface HpkeImportConfig {
+    /**
+     * Additional Authenticated Data (AAD) used during encryption. Should be
+     * base64-encoded bytes.
+     */
+    aad?: string;
+    /**
+     * The AEAD algorithm used for encryption. Defaults to CHACHA20_POLY1305 if not
+     * specified.
+     */
+    aead_algorithm?: 'CHACHA20_POLY1305' | 'AES_GCM256';
+    /**
+     * Application-specific context information (INFO) used during HPKE encryption.
+     * Should be base64-encoded bytes.
+     */
+    info?: string;
+}
+/**
+ * SUI transaction commands allowlist for raw_sign endpoint policy evaluation
+ */
+export type SuiCommandName = 'TransferObjects' | 'SplitCoins' | 'MergeCoins';
 /**
  * Executes the EVM `personal_sign` RPC (EIP-191) to sign a message.
  */
@@ -261,6 +355,7 @@ export declare namespace EthereumSignTransactionRpcInput {
     }
     namespace Params {
         interface Transaction {
+            authorization_list?: Array<Transaction.AuthorizationList>;
             chain_id?: string | number;
             data?: string;
             from?: string;
@@ -270,9 +365,19 @@ export declare namespace EthereumSignTransactionRpcInput {
             max_priority_fee_per_gas?: string | number;
             nonce?: string | number;
             to?: string;
-            type?: 0 | 1 | 2;
+            type?: 0 | 1 | 2 | 4;
             value?: string | number;
         }
+        namespace Transaction {
+            interface AuthorizationList {
+                chain_id: string | number;
+                contract: string;
+                nonce: string | number;
+                r: string;
+                s: string;
+                y_parity: number;
+            }
+        }
     }
 }
 /**
@@ -292,6 +397,7 @@ export declare namespace EthereumSendTransactionRpcInput {
     }
     namespace Params {
         interface Transaction {
+            authorization_list?: Array<Transaction.AuthorizationList>;
             chain_id?: string | number;
             data?: string;
             from?: string;
@@ -301,9 +407,19 @@ export declare namespace EthereumSendTransactionRpcInput {
             max_priority_fee_per_gas?: string | number;
             nonce?: string | number;
             to?: string;
-            type?: 0 | 1 | 2;
+            type?: 0 | 1 | 2 | 4;
             value?: string | number;
         }
+        namespace Transaction {
+            interface AuthorizationList {
+                chain_id: string | number;
+                contract: string;
+                nonce: string | number;
+                r: string;
+                s: string;
+                y_parity: number;
+            }
+        }
     }
 }
 /**
@@ -477,9 +593,11 @@ export declare namespace EthereumSendTransactionRpcResponse {
         hash: string;
         transaction_id?: string;
         transaction_request?: Data.TransactionRequest;
+        user_operation_hash?: string;
     }
     namespace Data {
         interface TransactionRequest {
+            authorization_list?: Array<TransactionRequest.AuthorizationList>;
             chain_id?: string | number;
             data?: string;
             from?: string;
@@ -489,9 +607,19 @@ export declare namespace EthereumSendTransactionRpcResponse {
             max_priority_fee_per_gas?: string | number;
             nonce?: string | number;
             to?: string;
-            type?: 0 | 1 | 2;
+            type?: 0 | 1 | 2 | 4;
             value?: string | number;
         }
+        namespace TransactionRequest {
+            interface AuthorizationList {
+                chain_id: string | number;
+                contract: string;
+                nonce: string | number;
+                r: string;
+                s: string;
+                y_parity: number;
+            }
+        }
     }
 }
 /**
@@ -863,30 +991,30 @@ export declare namespace WalletRawSignParams {
         /**
          * The encoding scheme for the bytes.
          */
-        encoding: 'utf-8' | 'hex';
+        encoding: 'utf-8' | 'hex' | 'base64';
         /**
          * The hash function to hash the bytes.
          */
-        hash_function: 'keccak256' | 'sha256';
+        hash_function: 'keccak256' | 'sha256' | 'blake2b256';
     }
 }
 export type WalletRpcParams = WalletRpcParams.EthereumPersonalSignRpcInput | WalletRpcParams.EthereumSignTypedDataRpcInput | WalletRpcParams.EthereumSignTransactionRpcInput | WalletRpcParams.EthereumSignUserOperationRpcInput | WalletRpcParams.EthereumSendTransactionRpcInput | WalletRpcParams.EthereumSign7702AuthorizationRpcInput | WalletRpcParams.EthereumSecp256k1SignRpcInput | WalletRpcParams.SolanaSignMessageRpcInput | WalletRpcParams.SolanaSignTransactionRpcInput | WalletRpcParams.SolanaSignAndSendTransactionRpcInput;
 export declare namespace WalletRpcParams {
     interface EthereumPersonalSignRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'personal_sign';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumPersonalSignRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -908,19 +1036,19 @@ export declare namespace WalletRpcParams {
     }
     interface EthereumSignTypedDataRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'eth_signTypedData_v4';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSignTypedDataRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -961,19 +1089,19 @@ export declare namespace WalletRpcParams {
     }
     interface EthereumSignTransactionRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'eth_signTransaction';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSignTransactionRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -993,6 +1121,7 @@ export declare namespace WalletRpcParams {
         }
         namespace Params {
             interface Transaction {
+                authorization_list?: Array<Transaction.AuthorizationList>;
                 chain_id?: string | number;
                 data?: string;
                 from?: string;
@@ -1002,26 +1131,36 @@ export declare namespace WalletRpcParams {
                 max_priority_fee_per_gas?: string | number;
                 nonce?: string | number;
                 to?: string;
-                type?: 0 | 1 | 2;
+                type?: 0 | 1 | 2 | 4;
                 value?: string | number;
             }
+            namespace Transaction {
+                interface AuthorizationList {
+                    chain_id: string | number;
+                    contract: string;
+                    nonce: string | number;
+                    r: string;
+                    s: string;
+                    y_parity: number;
+                }
+            }
         }
     }
     interface EthereumSignUserOperationRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'eth_signUserOperation';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSignUserOperationRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -1060,27 +1199,27 @@ export declare namespace WalletRpcParams {
     }
     interface EthereumSendTransactionRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         caip2: string;
         /**
-         * Body param:
+         * Body param
          */
         method: 'eth_sendTransaction';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSendTransactionRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
-         * Body param:
+         * Body param
          */
         sponsor?: boolean;
         /**
@@ -1100,6 +1239,7 @@ export declare namespace WalletRpcParams {
         }
         namespace Params {
             interface Transaction {
+                authorization_list?: Array<Transaction.AuthorizationList>;
                 chain_id?: string | number;
                 data?: string;
                 from?: string;
@@ -1109,26 +1249,36 @@ export declare namespace WalletRpcParams {
                 max_priority_fee_per_gas?: string | number;
                 nonce?: string | number;
                 to?: string;
-                type?: 0 | 1 | 2;
+                type?: 0 | 1 | 2 | 4;
                 value?: string | number;
             }
+            namespace Transaction {
+                interface AuthorizationList {
+                    chain_id: string | number;
+                    contract: string;
+                    nonce: string | number;
+                    r: string;
+                    s: string;
+                    y_parity: number;
+                }
+            }
         }
     }
     interface EthereumSign7702AuthorizationRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'eth_sign7702Authorization';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSign7702AuthorizationRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -1151,19 +1301,19 @@ export declare namespace WalletRpcParams {
     }
     interface EthereumSecp256k1SignRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'secp256k1_sign';
         /**
-         * Body param:
+         * Body param
          */
         params: EthereumSecp256k1SignRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'ethereum';
         /**
@@ -1184,19 +1334,19 @@ export declare namespace WalletRpcParams {
     }
     interface SolanaSignMessageRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'signMessage';
         /**
-         * Body param:
+         * Body param
          */
         params: SolanaSignMessageRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'solana';
         /**
@@ -1218,19 +1368,19 @@ export declare namespace WalletRpcParams {
     }
     interface SolanaSignTransactionRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         method: 'signTransaction';
         /**
-         * Body param:
+         * Body param
          */
         params: SolanaSignTransactionRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'solana';
         /**
@@ -1252,27 +1402,27 @@ export declare namespace WalletRpcParams {
     }
     interface SolanaSignAndSendTransactionRpcInput {
         /**
-         * Body param:
+         * Body param
          */
         caip2: string;
         /**
-         * Body param:
+         * Body param
          */
         method: 'signAndSendTransaction';
         /**
-         * Body param:
+         * Body param
          */
         params: SolanaSignAndSendTransactionRpcInput.Params;
         /**
-         * Body param:
+         * Body param
          */
         address?: string;
         /**
-         * Body param:
+         * Body param
          */
         chain_type?: 'solana';
         /**
-         * Body param:
+         * Body param
          */
         sponsor?: boolean;
         /**
@@ -1332,6 +1482,12 @@ export declare namespace WalletSubmitImportParams {
          * 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;
     }
     interface PrivateKeySubmitInput {
         /**
@@ -1357,6 +1513,12 @@ export declare namespace WalletSubmitImportParams {
          */
         encryption_type: 'HPKE';
         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;
     }
     interface AdditionalSigner {
         signer_id: string;
@@ -1482,7 +1644,7 @@ export declare namespace WalletCreateWalletsWithRecoveryParams {
     }
 }
 export declare namespace Wallets {
-    export { type CurveSigningChainType as CurveSigningChainType, type FirstClassChainType as FirstClassChainType, type Wallet as Wallet, type WalletChainType as WalletChainType, type WalletRevokeResponse as WalletRevokeResponse, type ExtendedChainType as ExtendedChainType, type WalletCustodian as WalletCustodian, type EthereumPersonalSignRpcInput as EthereumPersonalSignRpcInput, type EthereumSignTransactionRpcInput as EthereumSignTransactionRpcInput, type EthereumSendTransactionRpcInput as EthereumSendTransactionRpcInput, type EthereumSignTypedDataRpcInput as EthereumSignTypedDataRpcInput, type EthereumSignUserOperationRpcInput as EthereumSignUserOperationRpcInput, type EthereumSign7702AuthorizationRpcInput as EthereumSign7702AuthorizationRpcInput, type EthereumSecp256k1SignRpcInput as EthereumSecp256k1SignRpcInput, type SolanaSignTransactionRpcInput as SolanaSignTransactionRpcInput, type SolanaSignAndSendTransactionRpcInput as SolanaSignAndSendTransactionRpcInput, type SolanaSignMessageRpcInput as SolanaSignMessageRpcInput, type EthereumSignTransactionRpcResponse as EthereumSignTransactionRpcResponse, type EthereumSendTransactionRpcResponse as EthereumSendTransactionRpcResponse, type EthereumPersonalSignRpcResponse as EthereumPersonalSignRpcResponse, type EthereumSignTypedDataRpcResponse as EthereumSignTypedDataRpcResponse, type EthereumSignUserOperationRpcResponse as EthereumSignUserOperationRpcResponse, type EthereumSign7702AuthorizationRpcResponse as EthereumSign7702AuthorizationRpcResponse, type EthereumSecp256k1SignRpcResponse as EthereumSecp256k1SignRpcResponse, type SolanaSignTransactionRpcResponse as SolanaSignTransactionRpcResponse, type SolanaSignAndSendTransactionRpcResponse as SolanaSignAndSendTransactionRpcResponse, type SolanaSignMessageRpcResponse as SolanaSignMessageRpcResponse, type WalletExportResponse as WalletExportResponse, type WalletInitImportResponse as WalletInitImportResponse, type WalletRawSignResponse as WalletRawSignResponse, type WalletRpcResponse as WalletRpcResponse, type WalletAuthenticateWithJwtResponse as WalletAuthenticateWithJwtResponse, type WalletCreateWalletsWithRecoveryResponse as WalletCreateWalletsWithRecoveryResponse, type WalletsCursor as WalletsCursor, type WalletCreateParams as WalletCreateParams, type WalletListParams as WalletListParams, type WalletExportParams as WalletExportParams, type WalletInitImportParams as WalletInitImportParams, type WalletRawSignParams as WalletRawSignParams, type WalletRpcParams as WalletRpcParams, type WalletSubmitImportParams as WalletSubmitImportParams, type WalletUpdateParams as WalletUpdateParams, type WalletAuthenticateWithJwtParams as WalletAuthenticateWithJwtParams, type WalletCreateWalletsWithRecoveryParams as WalletCreateWalletsWithRecoveryParams, };
+    export { type CurveSigningChainType as CurveSigningChainType, type FirstClassChainType as FirstClassChainType, type Wallet as Wallet, type WalletChainType as WalletChainType, type WalletRevokeResponse as WalletRevokeResponse, type ExtendedChainType as ExtendedChainType, type WalletCustodian as WalletCustodian, type CustodialWalletProvider as CustodialWalletProvider, type CustodialWalletChainType as CustodialWalletChainType, type CustodialWalletCreateInput as CustodialWalletCreateInput, type CustodialWallet as CustodialWallet, type HpkeImportConfig as HpkeImportConfig, type SuiCommandName as SuiCommandName, type EthereumPersonalSignRpcInput as EthereumPersonalSignRpcInput, type EthereumSignTransactionRpcInput as EthereumSignTransactionRpcInput, type EthereumSendTransactionRpcInput as EthereumSendTransactionRpcInput, type EthereumSignTypedDataRpcInput as EthereumSignTypedDataRpcInput, type EthereumSignUserOperationRpcInput as EthereumSignUserOperationRpcInput, type EthereumSign7702AuthorizationRpcInput as EthereumSign7702AuthorizationRpcInput, type EthereumSecp256k1SignRpcInput as EthereumSecp256k1SignRpcInput, type SolanaSignTransactionRpcInput as SolanaSignTransactionRpcInput, type SolanaSignAndSendTransactionRpcInput as SolanaSignAndSendTransactionRpcInput, type SolanaSignMessageRpcInput as SolanaSignMessageRpcInput, type EthereumSignTransactionRpcResponse as EthereumSignTransactionRpcResponse, type EthereumSendTransactionRpcResponse as EthereumSendTransactionRpcResponse, type EthereumPersonalSignRpcResponse as EthereumPersonalSignRpcResponse, type EthereumSignTypedDataRpcResponse as EthereumSignTypedDataRpcResponse, type EthereumSignUserOperationRpcResponse as EthereumSignUserOperationRpcResponse, type EthereumSign7702AuthorizationRpcResponse as EthereumSign7702AuthorizationRpcResponse, type EthereumSecp256k1SignRpcResponse as EthereumSecp256k1SignRpcResponse, type SolanaSignTransactionRpcResponse as SolanaSignTransactionRpcResponse, type SolanaSignAndSendTransactionRpcResponse as SolanaSignAndSendTransactionRpcResponse, type SolanaSignMessageRpcResponse as SolanaSignMessageRpcResponse, type WalletExportResponse as WalletExportResponse, type WalletInitImportResponse as WalletInitImportResponse, type WalletRawSignResponse as WalletRawSignResponse, type WalletRpcResponse as WalletRpcResponse, type WalletAuthenticateWithJwtResponse as WalletAuthenticateWithJwtResponse, type WalletCreateWalletsWithRecoveryResponse as WalletCreateWalletsWithRecoveryResponse, type WalletsCursor as WalletsCursor, type WalletCreateParams as WalletCreateParams, type WalletListParams as WalletListParams, type WalletExportParams as WalletExportParams, type WalletInitImportParams as WalletInitImportParams, type WalletRawSignParams as WalletRawSignParams, type WalletRpcParams as WalletRpcParams, type WalletSubmitImportParams as WalletSubmitImportParams, type WalletUpdateParams as WalletUpdateParams, type WalletAuthenticateWithJwtParams as WalletAuthenticateWithJwtParams, type WalletCreateWalletsWithRecoveryParams as WalletCreateWalletsWithRecoveryParams, };
     export { Transactions as Transactions, type TransactionGetResponse as TransactionGetResponse, type TransactionGetParams as TransactionGetParams, };
     export { Balance as Balance, type BalanceGetResponse as BalanceGetResponse, type BalanceGetParams as BalanceGetParams, };
 }