@privy-io/react-auth 1.57.1 → 1.57.2-beta-20240227212848

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import react, { ReactElement } from 'react';
-import { ExternalProvider, StaticJsonRpcProvider, Web3Provider } from '@ethersproject/providers';
+import { ExternalProvider, StaticJsonRpcProvider, Web3Provider, TransactionResponse } from '@ethersproject/providers';
 import { CountryCode } from 'libphonenumber-js/min';
 import { AbstractProvider } from 'web3-core';
 import EventEmitter from 'eventemitter3';
@@ -379,8 +379,11 @@ declare enum PrivyErrorCode {
     UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error",
     EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed",
     EMBEDDED_WALLET_PASSWORD_ALREADY_EXISTS = "embedded_wallet_password_already_exists",
+    TRANSACTION_FAILURE = "transaction_failure",
     UNSUPPORTED_CHAIN_ID = "unsupported_chain_id",
     CAPTCHA_TIMEOUT = "captcha_timeout",
+    INVALID_MESSAGE = "invalid_message",
+    UNABLE_TO_SIGN = "unable_to_sign",
     CAPTCHA_FAILURE = "captcha_failure",
     CAPTCHA_DISABLED = "captcha_disabled",
     SESSION_STORAGE_UNAVAILABLE = "session_storage_unavailable",
@@ -2538,7 +2541,7 @@ interface PrivyEvents {
     connectWallet: {
         /**
          * Callback that will execute once a successful `connectWallet` completes.
-         * This will not run in the case of a wallet-based authentication flow.
+         * This will not run in the case of a wallet-based authentication or link flow.
          *
          * @param wallet {@link BaseConnectedWallet} the `wallet` object correspending to the connection
          */
@@ -2588,6 +2591,47 @@ interface PrivyEvents {
          */
         onError?: CallbackError;
     };
+    signMessage: {
+        /**
+         * Callback that will execute once a successful `signMessage` completes.
+         * This will not run in the case of a wallet-based authentication or link flow.
+         * @param signature - the signature of the embedded wallet used to sign message
+         */
+        onSuccess?: (signature: string) => void;
+        /**
+         * Callback that will execute in the case of a non-successful signMessage.
+         *
+         * @param error {@link PrivyErrorCode} - the corresponding error code
+         *  */
+        onError?: CallbackError;
+    };
+    signTypedData: {
+        /**
+         * Callback that will execute once a successful `signTypedData` completes.
+         * @param signature - the signature of the embedded wallet used to sign
+         */
+        onSuccess?: (signature: string) => void;
+        /**
+         * Callback that will execute in the case of a non-successful signTypedData.
+         *
+         * @param error {@link PrivyErrorCode} - the corresponding error code
+         *  */
+        onError?: CallbackError;
+    };
+    sendTransaction: {
+        /**
+         * Callback that will execute once a successful `sendTransaction` completes.
+         * This will not run in the case of a wallet-based authentication or link flow.
+         * @param response - the response from the successful transaction
+         */
+        onSuccess?: (response: TransactionResponse) => void;
+        /**
+         * Callback that will execute in the case of a non-successful sendTransaction.
+         *
+         * @param error {@link PrivyErrorCode} - the corresponding error code
+         *  */
+        onError?: CallbackError;
+    };
     accessToken: {
         /**
          * Callback that will execute when a user's access token is granted.
@@ -2798,6 +2842,23 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
     createWallet: () => Promise<Wallet>;
 };
 
+/**
+ * Use this hook to send a transaction using the embedded wallet and to attach callbacks for success and errors.
+ * Note that the callbacks will only fire for explicit sendTransaction calls from the Privy SDK.
+ * Transactions sent from the embedded wallet using transaction functions from non-Privy libraries
+ * will not trigger the callbacks.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for a successful transaction sent
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `sendTransaction`
+ * @returns sendTransaction - prompts the user send a transaction using their embedded wallet
+ */
+declare function useSendTransaction(callbacks?: PrivyEvents['sendTransaction']): {
+    /**
+     * Prompts a user to send a transaction using their embedded wallet.
+     */
+    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions | undefined, fundWalletConfig?: FundWalletConfig | undefined) => Promise<TransactionReceipt>;
+};
+
 /**
  * Use this hook to set a password on the embedded wallet, and to attach callbacks
  * for successful `password set`s, and `password set` errors.
@@ -2814,6 +2875,36 @@ declare function useSetWalletPassword(callbacks?: PrivyEvents['setWalletPassword
     setWalletPassword: () => Promise<Wallet>;
 };
 
+/**
+ * Use this hook to sign a message using the embedded wallet, and to attach callbacks for success and errors.
+ * Note that the callbacks will only fire for explicit `signMessage` calls from the Privy SDK.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for a successful message signature
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `signMessage`
+ * @returns signMessage - prompts the user to sign a message with their embedded wallet
+ */
+declare function useSignMessage(callbacks?: PrivyEvents['signMessage']): {
+    /**
+     * Prompts a user to sign a message using their embedded wallet.
+     */
+    signMessage: (message: string, uiOptions?: SignMessageModalUIOptions | undefined) => Promise<string>;
+};
+
+/**
+ * Use this hook to sign typed data using the embedded wallet, and to attach callbacks for success and errors.
+ * Note that the callbacks will only fire for explicit `signTypedData` calls from the Privy SDK.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for a successful signature
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `signTypedData`
+ * @returns signTypedData - prompts the user to sign typed data with their embedded wallet
+ */
+declare function useSignTypedData(callbacks?: PrivyEvents['signTypedData']): {
+    /**
+     * Prompts a user to sign typed data using their embedded wallet.
+     */
+    signTypedData: (typedData: SignTypedDataParams, uiOptions?: SignMessageModalUIOptions | undefined) => Promise<string>;
+};
+
 /**
  * Use this hook to check whether or not the Privy modal is currently visible.
  *
@@ -2889,4 +2980,4 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
     testnet?: boolean | undefined;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSetWalletPassword, useToken, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSignMessage, useSignTypedData, useToken, useWallets };