@privy-io/react-auth 1.38.0-beta.4 → 1.38.0

package/dist/index.d.ts

@@ -17,7 +17,7 @@ import { FetchOptions } from 'ofetch';
  */
 
 declare const SUPPORTED_JSON_RPC_METHODS: readonly ["eth_sign", "eth_populateTransactionRequest", "eth_signTransaction", "personal_sign", "eth_signTypedData_v4"];
-type JsonRpcMethodType = (typeof SUPPORTED_JSON_RPC_METHODS)[number];
+type JsonRpcMethodType = typeof SUPPORTED_JSON_RPC_METHODS[number];
 type Quantity = string | number | bigint;
 type UnsignedTransactionRequest = {
     from?: string;
@@ -175,26 +175,16 @@ declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Ch
 
 type WalletCreateRequestDataType = {
     accessToken: string;
-    recoveryPassword?: string;
-    /**
-     * Will be deprecated in a future release, use `recoveryPassword` instead
-     * @deprecated
-     */
     recoveryPin?: string;
 };
-type WalletRecoverRequestDataType = {
-    address: string;
+type WalletConnectRequestDataType = {
     accessToken: string;
-    recoveryPassword?: string;
-    /**
-     * Will be deprecated in a future release, use `recoveryPassword` instead
-     * @deprecated
-     */
-    recoveryPin?: string;
+    address: string;
 };
-type WalletConnectRequestDataType = {
+type WalletRecoverRequestDataType = {
     accessToken: string;
     address: string;
+    recoveryPin?: string;
 };
 type WalletRpcRequestDataType = {
     accessToken: string;
@@ -256,7 +246,9 @@ declare enum PrivyErrorCode {
     UNKNOWN_CONNECT_WALLET_ERROR = "unknown_connect_wallet_error",
     GENERIC_CONNECT_WALLET_ERROR = "generic_connect_wallet_error",
     CLIENT_REQUEST_TIMEOUT = "client_request_timeout",
-    INVALID_CREDENTIALS = "invalid_credentials"
+    INVALID_CREDENTIALS = "invalid_credentials",
+    EMBEDDED_WALLET_ALREADY_EXISTS = "embedded_wallet_already_exists",
+    UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error"
 }
 
 /**
@@ -765,14 +757,14 @@ type MoonpaySignResponse = {
 };
 
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "apple"];
-type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
+type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 type EmbeddedWalletClientType = 'privy';
 type InjectedWalletClientType = 'metamask' | 'phantom';
 type CoinbaseWalletClientType = 'coinbase_wallet';
 type UnknownWalletClientType = 'unknown';
 type WalletClientType = InjectedWalletClientType | CoinbaseWalletClientType | WalletConnectWalletClientType | EmbeddedWalletClientType | UnknownWalletClientType;
 declare const SUPPORTED_CONNECTOR_TYPES: string[];
-type ConnectorType = (typeof SUPPORTED_CONNECTOR_TYPES)[number];
+type ConnectorType = typeof SUPPORTED_CONNECTOR_TYPES[number];
 /**
  * Wallet metadata currently for internal use only
  */
@@ -1605,7 +1597,7 @@ interface PrivyInterface {
      * This method will error if the user already has an embedded wallet or if they
      * exit in the middle of the flow.
      *
-     * If the `config.embeddedWallets.requireUserPasscodeOnCreate` property is set to true,
+     * If the `config.embeddedWallets.requireUserPasswordOnCreate` property is set to true,
      * this will prompt the user to enter a passcode to secure the recovery share of their
      * embedded wallet.
      *
@@ -1725,6 +1717,24 @@ type PrivyEvents = {
          */
         onError?: CallbackError;
     };
+    createWallet: {
+        /**
+         * Callback that will execute once on a successful embedded wallet creation.
+         * This will run when `createWallet` is called manually, or when `config.embeddedWallets.createOnLogin` triggers
+         * an automatic wallet creation.
+         *
+         * @param wallet {BaseConnectedWallet}- the created `wallet` object
+         *
+         */
+        onSuccess?: (wallet: Wallet) => void;
+        /**
+         * Callback that will execute in the case of a non-successful wallet creation.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         *
+         */
+        onError?: CallbackError;
+    };
 };
 
 /**
@@ -1772,4 +1782,29 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };
+/**
+ * Use this hook to create a privy wallet for a user, and to attach a callback after successful wallet creation.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute when a user successfully creates a privy wallet
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `cresteWallet`.
+ * @returns createWallet - creates a privy wallet for the user.
+ */
+declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
+    /**
+     * Creates an embedded wallet for the current user.
+     *
+     * This method will error if the user already has an embedded wallet
+     *
+     * If the `config.embeddedWallets.requireUserPasswordOnCreate` property is set to true,
+     * this will prompt the user to enter a passcode to secure the recovery share of their
+     * embedded wallet.
+     *
+     * Otherwise (the default), Privy will secure the recovery share, and the embedded wallet
+     * will be created without showing any UIs to the user.
+     *
+     * @returns Promise for the {@link Wallet} object for the newly created embedded wallet
+     */
+    createWallet: () => Promise<Wallet>;
+};
+
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLogout, usePrivy, useWallets };