@privy-io/api-types 0.3.4 → 0.5.0

package/src/resources/wallets/wallets.ts

@@ -17,7 +17,7 @@ export class Wallets extends APIResource {
   balance: BalanceAPI.Balance = new BalanceAPI.Balance(this._client);
 
   /**
-   * Create a new wallet.
+   * Creates a new wallet on the requested chain and for the requested owner.
    *
    * @example
    * ```ts
@@ -270,6 +270,13 @@ export class Wallets extends APIResource {
 
 export type WalletsCursor = Cursor<Wallet>;
 
+/**
+ * The response body from revoking a wallet delegation.
+ */
+export interface WalletRevokeResponse {
+  message: string;
+}
+
 /**
  * The wallet chain types that support curve-based signing.
  */
@@ -285,11 +292,171 @@ export type CurveSigningChainType =
   | '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.
+ */
+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 namespace CustodialWalletCreateInput {
+  export interface AdditionalSigner {
+    signer_id: string;
+
+    override_policy_ids?: Array<string>;
+  }
+
+  export interface UserID {
+    user_id: string;
+  }
+
+  export 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 namespace CustodialWallet {
+  export 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';
+
+/**
+ * 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
@@ -359,51 +526,136 @@ export namespace Wallet {
 }
 
 /**
- * The wallet chain types.
+ * Input for a single wallet in a batch creation request.
  */
-export type WalletChainType =
-  | 'ethereum'
-  | 'solana'
-  | 'cosmos'
-  | 'stellar'
-  | 'sui'
-  | 'aptos'
-  | 'movement'
-  | 'tron'
-  | 'bitcoin-segwit'
-  | 'near'
-  | 'ton'
-  | 'starknet'
-  | 'spark';
+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 namespace WalletBatchItemInput {
+  export 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.
+   */
+  export 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.
+   */
+  export interface UserOwner {
+    user_id: string;
+  }
+}
 
 /**
- * The response body from revoking a wallet delegation.
+ * Request body for batch wallet creation.
  */
-export interface WalletRevokeResponse {
-  message: string;
+export interface WalletBatchCreateInput {
+  /**
+   * Array of wallet creation requests. Minimum 1, maximum 100.
+   */
+  wallets: Array<WalletBatchItemInput>;
 }
 
 /**
- * The wallet chain types that are not first class chains.
+ * A single result from a batch wallet creation operation.
  */
-export type ExtendedChainType =
-  | 'cosmos'
-  | 'stellar'
-  | 'sui'
-  | 'aptos'
-  | 'movement'
-  | 'tron'
-  | 'bitcoin-segwit'
-  | 'near'
-  | 'ton'
-  | 'starknet'
-  | 'spark';
+export type WalletBatchCreateResult =
+  | WalletBatchCreateResult.WalletBatchCreateSuccess
+  | WalletBatchCreateResult.WalletBatchCreateFailure;
+
+export namespace WalletBatchCreateResult {
+  /**
+   * A successful wallet creation result within a batch operation.
+   */
+  export 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.
+   */
+  export 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;
+  }
+}
 
 /**
- * Information about the custodian managing this wallet.
+ * Response for a batch wallet creation request.
  */
-export interface WalletCustodian {
-  name: string;
+export interface WalletBatchCreateResponse {
+  /**
+   * Array of results for each wallet creation request, in the same order as input.
+   */
+  results: Array<WalletBatchCreateResult>;
 }
 
 /**
@@ -447,6 +699,8 @@ export namespace EthereumSignTransactionRpcInput {
 
   export namespace Params {
     export interface Transaction {
+      authorization_list?: Array<Transaction.AuthorizationList>;
+
       chain_id?: string | number;
 
       data?: string;
@@ -465,10 +719,26 @@ export namespace EthereumSignTransactionRpcInput {
 
       to?: string;
 
-      type?: 0 | 1 | 2;
+      type?: 0 | 1 | 2 | 4;
 
       value?: string | number;
     }
+
+    export namespace Transaction {
+      export interface AuthorizationList {
+        chain_id: string | number;
+
+        contract: string;
+
+        nonce: string | number;
+
+        r: string;
+
+        s: string;
+
+        y_parity: number;
+      }
+    }
   }
 }
 
@@ -496,6 +766,8 @@ export namespace EthereumSendTransactionRpcInput {
 
   export namespace Params {
     export interface Transaction {
+      authorization_list?: Array<Transaction.AuthorizationList>;
+
       chain_id?: string | number;
 
       data?: string;
@@ -514,10 +786,26 @@ export namespace EthereumSendTransactionRpcInput {
 
       to?: string;
 
-      type?: 0 | 1 | 2;
+      type?: 0 | 1 | 2 | 4;
 
       value?: string | number;
     }
+
+    export namespace Transaction {
+      export interface AuthorizationList {
+        chain_id: string | number;
+
+        contract: string;
+
+        nonce: string | number;
+
+        r: string;
+
+        s: string;
+
+        y_parity: number;
+      }
+    }
   }
 }
 
@@ -757,10 +1045,14 @@ export namespace EthereumSendTransactionRpcResponse {
     transaction_id?: string;
 
     transaction_request?: Data.TransactionRequest;
+
+    user_operation_hash?: string;
   }
 
   export namespace Data {
     export interface TransactionRequest {
+      authorization_list?: Array<TransactionRequest.AuthorizationList>;
+
       chain_id?: string | number;
 
       data?: string;
@@ -779,10 +1071,26 @@ export namespace EthereumSendTransactionRpcResponse {
 
       to?: string;
 
-      type?: 0 | 1 | 2;
+      type?: 0 | 1 | 2 | 4;
 
       value?: string | number;
     }
+
+    export namespace TransactionRequest {
+      export interface AuthorizationList {
+        chain_id: string | number;
+
+        contract: string;
+
+        nonce: string | number;
+
+        r: string;
+
+        s: string;
+
+        y_parity: number;
+      }
+    }
   }
 }
 
@@ -1135,11 +1443,21 @@ export 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;
 }
 
@@ -1259,12 +1577,12 @@ export 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';
   }
 }
 
@@ -1283,22 +1601,22 @@ export type WalletRpcParams =
 export declare namespace WalletRpcParams {
   export 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';
 
@@ -1325,22 +1643,22 @@ export declare namespace WalletRpcParams {
 
   export 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';
 
@@ -1385,22 +1703,22 @@ export declare namespace WalletRpcParams {
 
   export 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';
 
@@ -1424,6 +1742,8 @@ export declare namespace WalletRpcParams {
 
     export namespace Params {
       export interface Transaction {
+        authorization_list?: Array<Transaction.AuthorizationList>;
+
         chain_id?: string | number;
 
         data?: string;
@@ -1442,31 +1762,47 @@ export declare namespace WalletRpcParams {
 
         to?: string;
 
-        type?: 0 | 1 | 2;
+        type?: 0 | 1 | 2 | 4;
 
         value?: string | number;
       }
+
+      export namespace Transaction {
+        export interface AuthorizationList {
+          chain_id: string | number;
+
+          contract: string;
+
+          nonce: string | number;
+
+          r: string;
+
+          s: string;
+
+          y_parity: number;
+        }
+      }
     }
   }
 
   export 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';
 
@@ -1523,32 +1859,32 @@ export declare namespace WalletRpcParams {
 
   export 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;
 
@@ -1572,6 +1908,8 @@ export declare namespace WalletRpcParams {
 
     export namespace Params {
       export interface Transaction {
+        authorization_list?: Array<Transaction.AuthorizationList>;
+
         chain_id?: string | number;
 
         data?: string;
@@ -1590,31 +1928,47 @@ export declare namespace WalletRpcParams {
 
         to?: string;
 
-        type?: 0 | 1 | 2;
+        type?: 0 | 1 | 2 | 4;
 
         value?: string | number;
       }
+
+      export namespace Transaction {
+        export interface AuthorizationList {
+          chain_id: string | number;
+
+          contract: string;
+
+          nonce: string | number;
+
+          r: string;
+
+          s: string;
+
+          y_parity: number;
+        }
+      }
     }
   }
 
   export 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';
 
@@ -1643,22 +1997,22 @@ export declare namespace WalletRpcParams {
 
   export 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';
 
@@ -1683,22 +2037,22 @@ export declare namespace WalletRpcParams {
 
   export 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';
 
@@ -1725,22 +2079,22 @@ export declare namespace WalletRpcParams {
 
   export 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';
 
@@ -1767,32 +2121,32 @@ export declare namespace WalletRpcParams {
 
   export 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;
 
@@ -1868,6 +2222,13 @@ export 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;
   }
 
   export interface PrivateKeySubmitInput {
@@ -1899,6 +2260,13 @@ export 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;
   }
 
   export interface AdditionalSigner {
@@ -1930,8 +2298,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;
 
@@ -2056,13 +2423,23 @@ Wallets.Balance = Balance;
 
 export declare namespace Wallets {
   export {
+    type WalletRevokeResponse as WalletRevokeResponse,
     type CurveSigningChainType as CurveSigningChainType,
+    type ExtendedChainType as ExtendedChainType,
     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 Wallet as Wallet,
+    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,