@privy-io/node 0.6.2 → 0.8.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
@@ -290,6 +290,9 @@ export type CurveSigningChainType =
  */
 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
@@ -399,6 +402,122 @@ 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';
+
 /**
  * Executes the EVM `personal_sign` RPC (EIP-191) to sign a message.
  */
@@ -440,6 +559,8 @@ export namespace EthereumSignTransactionRpcInput {
 
   export namespace Params {
     export interface Transaction {
+      authorization_list?: Array<Transaction.AuthorizationList>;
+
       chain_id?: string | number;
 
       data?: string;
@@ -458,10 +579,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;
+      }
+    }
   }
 }
 
@@ -489,6 +626,8 @@ export namespace EthereumSendTransactionRpcInput {
 
   export namespace Params {
     export interface Transaction {
+      authorization_list?: Array<Transaction.AuthorizationList>;
+
       chain_id?: string | number;
 
       data?: string;
@@ -507,10 +646,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;
+      }
+    }
   }
 }
 
@@ -750,10 +905,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;
@@ -772,10 +931,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;
+      }
+    }
   }
 }
 
@@ -1252,12 +1427,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';
   }
 }
 
@@ -1276,22 +1451,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';
 
@@ -1318,22 +1493,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';
 
@@ -1378,22 +1553,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';
 
@@ -1417,6 +1592,8 @@ export declare namespace WalletRpcParams {
 
     export namespace Params {
       export interface Transaction {
+        authorization_list?: Array<Transaction.AuthorizationList>;
+
         chain_id?: string | number;
 
         data?: string;
@@ -1435,31 +1612,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';
 
@@ -1516,32 +1709,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;
 
@@ -1565,6 +1758,8 @@ export declare namespace WalletRpcParams {
 
     export namespace Params {
       export interface Transaction {
+        authorization_list?: Array<Transaction.AuthorizationList>;
+
         chain_id?: string | number;
 
         data?: string;
@@ -1583,31 +1778,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';
 
@@ -1636,22 +1847,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';
 
@@ -1676,22 +1887,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';
 
@@ -1718,22 +1929,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';
 
@@ -1760,32 +1971,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;
 
@@ -1861,6 +2072,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 {
@@ -1892,6 +2110,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 {
@@ -2055,6 +2280,12 @@ export declare namespace Wallets {
     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,