@privy-io/node 0.7.0 → 0.9.0

package/resources/wallets/wallets.d.ts

@@ -148,13 +148,8 @@ export declare class Wallets extends APIResource {
 }
 export type WalletsCursor = Cursor<Wallet>;
 /**
- * The wallet chain types that support curve-based signing.
- */
-export type CurveSigningChainType = 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'near' | 'ton' | 'starknet';
-/**
- * The wallet chain types that offer first class support.
+ * A wallet managed by Privy's wallet infrastructure.
  */
-export type FirstClassChainType = 'ethereum' | 'solana';
 export interface Wallet {
     /**
      * Unique ID of the wallet. This will be the primary identifier when using the
@@ -212,13 +207,21 @@ export declare namespace Wallet {
     }
 }
 /**
- * The wallet chain types.
+ * The wallet chain types that support curve-based signing.
  */
-export type WalletChainType = 'ethereum' | 'solana' | 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'near' | 'ton' | 'starknet' | 'spark';
+export type CurveSigningChainType = 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'near' | 'ton' | 'starknet';
 /**
  * The wallet chain types that are not first class chains.
  */
 export type ExtendedChainType = 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'near' | 'ton' | 'starknet' | 'spark';
+/**
+ * The wallet chain types that offer first class support.
+ */
+export type FirstClassChainType = 'ethereum' | 'solana';
+/**
+ * The wallet chain types.
+ */
+export type WalletChainType = 'ethereum' | 'solana' | 'cosmos' | 'stellar' | 'sui' | 'aptos' | 'movement' | 'tron' | 'bitcoin-segwit' | 'near' | 'ton' | 'starknet' | 'spark';
 /**
  * Information about the custodian managing this wallet.
  */
@@ -275,11 +278,20 @@ export interface CustodialWallet {
     /**
      * The chain type of the custodial wallet.
      */
-    chainType: CustodialWalletChainType;
+    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
@@ -307,6 +319,118 @@ export interface HpkeImportConfig {
  * SUI transaction commands allowlist for raw_sign endpoint policy evaluation
  */
 export type SuiCommandName = 'TransferObjects' | 'SplitCoins' | 'MergeCoins';
+/**
+ * Input for a single wallet in a batch creation request.
+ */
+export interface WalletBatchItemInput {
+    /**
+     * The wallet chain types.
+     */
+    chain_type: WalletChainType;
+    /**
+     * Additional signers for the wallet.
+     */
+    additional_signers?: Array<WalletBatchItemInput.AdditionalSigner>;
+    /**
+     * The owner of the resource. If you provide this, do not specify an owner_id as it
+     * will be generated automatically. When updating a wallet, you can set the owner
+     * to null to remove the owner.
+     */
+    owner?: WalletBatchItemInput.PublicKeyOwner | WalletBatchItemInput.UserOwner | null;
+    /**
+     * The key quorum ID to set as the owner of the resource. If you provide this, do
+     * not specify an owner.
+     */
+    owner_id?: string;
+    /**
+     * List of policy IDs for policies that should be enforced on the wallet.
+     * Currently, only one policy is supported per wallet.
+     */
+    policy_ids?: Array<string>;
+}
+export declare namespace WalletBatchItemInput {
+    interface AdditionalSigner {
+        signer_id: string;
+        /**
+         * The array of policy IDs that will be applied to wallet requests. If specified,
+         * this will override the base policy IDs set on the wallet.
+         */
+        override_policy_ids?: Array<string>;
+    }
+    /**
+     * The P-256 public key of the owner of the resource, in base64-encoded DER format.
+     * If you provide this, do not specify an owner_id as it will be generated
+     * automatically.
+     */
+    interface PublicKeyOwner {
+        public_key: string;
+    }
+    /**
+     * The user ID of the owner of the resource. The user must already exist, and this
+     * value must start with "did:privy:". If you provide this, do not specify an
+     * owner_id as it will be generated automatically.
+     */
+    interface UserOwner {
+        user_id: string;
+    }
+}
+/**
+ * Request body for batch wallet creation.
+ */
+export interface WalletBatchCreateInput {
+    /**
+     * Array of wallet creation requests. Minimum 1, maximum 100.
+     */
+    wallets: Array<WalletBatchItemInput>;
+}
+/**
+ * A single result from a batch wallet creation operation.
+ */
+export type WalletBatchCreateResult = WalletBatchCreateResult.WalletBatchCreateSuccess | WalletBatchCreateResult.WalletBatchCreateFailure;
+export declare namespace WalletBatchCreateResult {
+    /**
+     * A successful wallet creation result within a batch operation.
+     */
+    interface WalletBatchCreateSuccess {
+        /**
+         * The index of the wallet in the original request array.
+         */
+        index: number;
+        success: true;
+        /**
+         * A wallet managed by Privy's wallet infrastructure.
+         */
+        wallet: WalletsAPI.Wallet;
+    }
+    /**
+     * A failed wallet creation result within a batch operation.
+     */
+    interface WalletBatchCreateFailure {
+        /**
+         * A PrivyErrorCode string identifying the error type (e.g., "invalid_data",
+         * "resource_conflict").
+         */
+        code: string;
+        /**
+         * A human-readable error message with details about what went wrong.
+         */
+        error: string;
+        /**
+         * The index of the wallet in the original request array.
+         */
+        index: number;
+        success: false;
+    }
+}
+/**
+ * Response for a batch wallet creation request.
+ */
+export interface WalletBatchCreateResponse {
+    /**
+     * Array of results for each wallet creation request, in the same order as input.
+     */
+    results: Array<WalletBatchCreateResult>;
+}
 /**
  * Executes the EVM `personal_sign` RPC (EIP-191) to sign a message.
  */
@@ -337,6 +461,7 @@ export declare namespace EthereumSignTransactionRpcInput {
     }
     namespace Params {
         interface Transaction {
+            authorization_list?: Array<Transaction.AuthorizationList>;
             chain_id?: string | number;
             data?: string;
             from?: string;
@@ -346,9 +471,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;
+            }
+        }
     }
 }
 /**
@@ -368,6 +503,7 @@ export declare namespace EthereumSendTransactionRpcInput {
     }
     namespace Params {
         interface Transaction {
+            authorization_list?: Array<Transaction.AuthorizationList>;
             chain_id?: string | number;
             data?: string;
             from?: string;
@@ -377,9 +513,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;
+            }
+        }
     }
 }
 /**
@@ -553,9 +699,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;
@@ -565,9 +713,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;
+            }
+        }
     }
 }
 /**
@@ -837,10 +995,19 @@ export declare namespace WalletCreateParams {
     }
 }
 export interface WalletListParams extends CursorParams {
+    /**
+     * Filter wallets by authorization public key. Returns wallets owned by key quorums
+     * that include the specified P-256 public key (base64-encoded DER format). Cannot
+     * be used together with user_id.
+     */
+    authorization_key?: string;
     /**
      * The wallet chain types.
      */
     chain_type?: WalletChainType;
+    /**
+     * Filter wallets by user ID. Cannot be used together with authorization_key.
+     */
     user_id?: string;
 }
 export interface WalletExportParams {
@@ -950,19 +1117,19 @@ export type WalletRpcParams = WalletRpcParams.EthereumPersonalSignRpcInput | Wal
 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';
         /**
@@ -984,19 +1151,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';
         /**
@@ -1037,19 +1204,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';
         /**
@@ -1069,6 +1236,7 @@ export declare namespace WalletRpcParams {
         }
         namespace Params {
             interface Transaction {
+                authorization_list?: Array<Transaction.AuthorizationList>;
                 chain_id?: string | number;
                 data?: string;
                 from?: string;
@@ -1078,26 +1246,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';
         /**
@@ -1136,27 +1314,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;
         /**
@@ -1176,6 +1354,7 @@ export declare namespace WalletRpcParams {
         }
         namespace Params {
             interface Transaction {
+                authorization_list?: Array<Transaction.AuthorizationList>;
                 chain_id?: string | number;
                 data?: string;
                 from?: string;
@@ -1185,26 +1364,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';
         /**
@@ -1227,19 +1416,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';
         /**
@@ -1260,19 +1449,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';
         /**
@@ -1294,19 +1483,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';
         /**
@@ -1328,27 +1517,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;
         /**
@@ -1469,8 +1658,7 @@ export interface WalletUpdateParams {
      */
     owner?: WalletUpdateParams.PublicKeyOwner | WalletUpdateParams.UserOwner | null;
     /**
-     * Body param: The key quorum ID to set as the owner of the resource. If you
-     * provide this, do not specify an owner.
+     * Body param
      */
     owner_id?: string | null;
     /**
@@ -1570,7 +1758,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 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 { type Wallet as Wallet, type CurveSigningChainType as CurveSigningChainType, type ExtendedChainType as ExtendedChainType, type FirstClassChainType as FirstClassChainType, type WalletChainType as WalletChainType, 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 WalletBatchItemInput as WalletBatchItemInput, type WalletBatchCreateInput as WalletBatchCreateInput, type WalletBatchCreateResult as WalletBatchCreateResult, type WalletBatchCreateResponse as WalletBatchCreateResponse, 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, };
 }