@privy-io/react-auth 3.6.1 → 3.7.0

package/dist/dts/index.d.ts

@@ -17,6 +17,8 @@ import { PublicKeyCredentialRequestOptionsJSON } from '@simplewebauthn/browser';
 import { FetchOptions } from 'ofetch';
 import { P as PrivyEvents } from './events-context-CCElA92Y.js';
 export { C as CallbackError } from './events-context-CCElA92Y.js';
+import { PaymentRequirementsSelector } from 'x402/client';
+import { X402Config } from 'x402/types';
 import * as viem_accounts from 'viem/accounts';
 import '@coinbase/wallet-sdk';
 import '@solana/kit';
@@ -580,6 +582,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_getTransactionByHash";
         Parameters: [hash: viem.Hash];
         ReturnType: viem.RpcTransaction | null;
+    }, {
+        Method: "eth_getTransactionBySenderAndNonce";
+        Parameters: [sender: Address, nonce: viem.Quantity];
+        ReturnType: viem.RpcTransaction | null;
     }, {
         Method: "eth_getTransactionCount";
         Parameters: [address: Address, block: viem.RpcBlockNumber | viem.BlockTag | viem.RpcBlockIdentifier];
@@ -633,6 +639,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_sendRawTransaction";
         Parameters: [signedTransaction: viem.Hex];
         ReturnType: viem.Hash;
+    }, {
+        Method: "eth_sendRawTransactionSync";
+        Parameters: [signedTransaction: viem.Hex] | [signedTransaction: viem.Hex, timeout: viem.Hex];
+        ReturnType: viem.RpcTransactionReceipt;
     }, {
         Method: "eth_simulateV1";
         Parameters: [{
@@ -715,6 +725,7 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
     prepareTransactionRequest: <const request extends viem.PrepareTransactionRequestRequest<Chain, chainOverride>, chainOverride extends viem.Chain | undefined = undefined, accountOverride extends viem.Account | Address | undefined = undefined>(args: viem.PrepareTransactionRequestParameters<Chain, viem.Account | undefined, chainOverride, accountOverride, request>) => Promise<viem.PrepareTransactionRequestReturnType<Chain, viem.Account | undefined, chainOverride, accountOverride, request>>;
     readContract: <const abi extends viem.Abi | readonly unknown[], functionName extends viem.ContractFunctionName<abi, "pure" | "view">, const args extends viem.ContractFunctionArgs<abi, "pure" | "view", functionName>>(args: viem.ReadContractParameters<abi, functionName, args>) => Promise<viem.ReadContractReturnType<abi, functionName, args>>;
     sendRawTransaction: (args: viem.SendRawTransactionParameters) => Promise<viem.SendRawTransactionReturnType>;
+    sendRawTransactionSync: (args: viem.SendRawTransactionSyncParameters) => Promise<viem.SendRawTransactionSyncReturnType<Chain>>;
     simulate: <const calls extends readonly unknown[]>(args: viem.SimulateBlocksParameters<calls>) => Promise<viem.SimulateBlocksReturnType<calls>>;
     simulateBlocks: <const calls extends readonly unknown[]>(args: viem.SimulateBlocksParameters<calls>) => Promise<viem.SimulateBlocksReturnType<calls>>;
     simulateCalls: <const calls extends readonly unknown[]>(args: viem.SimulateCallsParameters<calls>) => Promise<viem.SimulateCallsReturnType<calls>>;
@@ -890,6 +901,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_getTransactionByHash";
         Parameters: [hash: viem.Hash];
         ReturnType: viem.RpcTransaction | null;
+    }, {
+        Method: "eth_getTransactionBySenderAndNonce";
+        Parameters: [sender: Address, nonce: viem.Quantity];
+        ReturnType: viem.RpcTransaction | null;
     }, {
         Method: "eth_getTransactionCount";
         Parameters: [address: Address, block: viem.RpcBlockNumber | viem.BlockTag | viem.RpcBlockIdentifier];
@@ -943,6 +958,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_sendRawTransaction";
         Parameters: [signedTransaction: viem.Hex];
         ReturnType: viem.Hash;
+    }, {
+        Method: "eth_sendRawTransactionSync";
+        Parameters: [signedTransaction: viem.Hex] | [signedTransaction: viem.Hex, timeout: viem.Hex];
+        ReturnType: viem.RpcTransactionReceipt;
     }, {
         Method: "eth_simulateV1";
         Parameters: [{
@@ -1105,6 +1124,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_getTransactionByHash";
         Parameters: [hash: viem.Hash];
         ReturnType: viem.RpcTransaction | null;
+    }, {
+        Method: "eth_getTransactionBySenderAndNonce";
+        Parameters: [sender: Address, nonce: viem.Quantity];
+        ReturnType: viem.RpcTransaction | null;
     }, {
         Method: "eth_getTransactionCount";
         Parameters: [address: Address, block: viem.RpcBlockNumber | viem.BlockTag | viem.RpcBlockIdentifier];
@@ -1158,6 +1181,10 @@ declare const getPublicClient: (chainId: number, chains: Chain[], rpcConfig: Rpc
         Method: "eth_sendRawTransaction";
         Parameters: [signedTransaction: viem.Hex];
         ReturnType: viem.Hash;
+    }, {
+        Method: "eth_sendRawTransactionSync";
+        Parameters: [signedTransaction: viem.Hex] | [signedTransaction: viem.Hex, timeout: viem.Hex];
+        ReturnType: viem.RpcTransactionReceipt;
     }, {
         Method: "eth_simulateV1";
         Parameters: [{
@@ -1331,6 +1358,7 @@ type MobileWalletConfig = {
 };
 
 declare function getCustomerAccessToken(): Promise<string | null>;
+declare function getIdentityToken(): Promise<string | null>;
 /**
  * Properties to initialize the {@link PrivyProvider}.
  */
@@ -3858,6 +3886,58 @@ declare function useSignTypedData(callbacks?: PrivyEvents['signTypedData']): {
     }>;
 };
 
+/**
+ * Wraps a fetch function to automatically handle x402 payments.
+ *
+ * @param options - Configuration options for the wrapped fetch
+ * @param options.walletAddress - Optional: The address of the Privy wallet to use. Defaults to first connected wallet.
+ * @param options.fetch - The fetch function to wrap (typically globalThis.fetch)
+ * @param options.maxValue - Maximum allowed payment amount in base units (default: 100000 = 0.1 USDC)
+ * @param options.paymentRequirementsSelector - Function to select payment requirements from 402 response
+ * @param options.config - Optional x402 configuration
+ * @returns A wrapped fetch function that handles 402 responses automatically
+ */
+type WrapFetchWithPayment = (options: {
+    walletAddress?: string;
+    fetch: typeof globalThis.fetch;
+    maxValue?: bigint;
+    paymentRequirementsSelector?: PaymentRequirementsSelector;
+    config?: X402Config;
+}) => (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+/**
+ * Return type for the useX402Fetch hook
+ */
+type UseX402Fetch = {
+    /**
+     * Wraps a fetch function to automatically handle x402 payments.
+     * See {@link WrapFetchWithPayment} for details.
+     */
+    wrapFetchWithPayment: WrapFetchWithPayment;
+};
+/**
+ * Hook that provides x402 payment functionality for Privy embedded wallets.
+ *
+ * Returns a `wrapFetchWithPayment` function that wraps the native fetch API to automatically
+ * handle 402 Payment Required responses by creating and sending payment headers signed with
+ * Privy embedded wallets.
+ *
+ * @example
+ * ```typescript
+ * const {wallets} = useWallets();
+ * const {wrapFetchWithPayment} = useX402Fetch();
+ *
+ * const fetchWithPayment = wrapFetchWithPayment({
+ *   walletAddress: wallets[0].address,
+ *   fetch,
+ * });
+ * const response = await fetchWithPayment('https://api.example.com/premium');
+ * ```
+ *
+ * @experimental This API is experimental and may change in future versions
+ * @returns Object containing wrapFetchWithPayment function
+ */
+declare const useX402Fetch: () => UseX402Fetch;
+
 /**
  * Use this hook to check whether or not the Privy modal is currently visible.
  *
@@ -4258,10 +4338,17 @@ declare const useHeadlessDelegatedActions: () => UseHeadlessDelegatedActionsInte
  */
 declare function getEmbeddedConnectedWallet(wallets: ConnectedWallet[]): ConnectedWallet | null;
 
+/**
+ * @deprecated Use `PrivyModal` instead
+ */
 declare const LoginModal: ({ open }: {
     open: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
+declare const PrivyModal: ({ open }: {
+    open: boolean;
+}) => react_jsx_runtime.JSX.Element;
+
 /**
  * Helper function to create a viem Account instance given a connected Ethereum wallet.
  *
@@ -4282,7 +4369,7 @@ declare const toViemAccount: ({ wallet }: {
     }) => Promise<Hex>;
     signTransaction: <serializer extends viem.SerializeTransactionFn<viem.TransactionSerializable> = viem.SerializeTransactionFn<viem.TransactionSerializable>, transaction extends Parameters<serializer>[0] = Parameters<serializer>[0]>(transaction: transaction, options?: {
         serializer?: serializer | undefined;
-    } | undefined) => Promise<viem.IsNarrowable<viem.TransactionSerialized<viem.GetTransactionType<transaction>>, Hex> extends true ? viem.TransactionSerialized<viem.GetTransactionType<transaction>> : Hex>;
+    } | undefined) => Promise<Hex>;
     signTypedData: <const typedData extends viem.TypedData | Record<string, unknown>, primaryType extends keyof typedData | "EIP712Domain" = keyof typedData>(parameters: viem.TypedDataDefinition<typedData, primaryType>) => Promise<Hex>;
     publicKey: Hex;
     source: string;
@@ -4300,4 +4387,4 @@ declare const useMigrateWallets: () => {
     }>;
 };
 
-export { BaseConnectedWalletType, Captcha, ConnectWalletModalOptions, ConnectedWallet, ConnectorManager, type CustomAuthFlowState, EIP1193Provider, EthereumWalletConnector, FundWalletConfig, type JwtAuthFlowState, LinkedAccountWithMetadata, LoginModal, LoginModalOptions, LoginWithCode, MfaMethod, OAuthFlowState, OAuthTokens, OtpFlowState, PasskeyFlowState, PrivyClient, PrivyClientConfig, PrivyEvents, type PrivyInterface, PrivyProvider, type PrivyProviderProps, type SendCodeToEmail, type SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, SiweFlowState, TelegramAuthFlowState, UnsignedTransactionRequest, type UseAuthorizationSignatureInterface, type UseBaseAccountSdkInterface, type UseConnectBaseAccountInterface, type UseConnectCoinbaseSmartWalletInterface, type UseCustomAuth, type UseDelegatedActionsInterface, type UseFundWalletInterface, type UseGetAccessTokenForProvider, type UseImportWalletInterface, type UseLinkJwtAccount, type UseLinkWithPasskey, type UseLinkWithSiws, type UseLoginWithEmail, type UseLoginWithPasskey, type UseLoginWithSiws, type UseLoginWithSms, type UseLoginWithTelegram, type UseOAuthTokens, type UseRecoverEmbeddedWalletInterface, type UseSessionSignersInterface, type UseSignupWithPasskey, type UseSubscribeToJwtAuthWithFlagInput, type UseSyncJwtBasedAuthStateInput, type UseSyncJwtBasedAuthStateInterface, type UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getCustomerAccessToken as getAccessToken, getEmbeddedConnectedWallet, toViemAccount, useActiveWallet, useAuthMfa, useAuthMfaEnrollment, useAuthorizationSignature, useBaseAccountSdk, useConnectBaseAccount, useConnectCoinbaseSmartWallet, useConnectOrCreateWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useCustomAuth, useDelegatedActions, useFarcasterSigner, useFundWallet, useGetAccessTokenForProvider, useGuestAccounts, useHeadlessDelegatedActions, useIdentityToken, useImportWallet, useLinkAccount, useLinkJwtAccount, useLinkWithPasskey, useLinkWithSiwe, useLinkWithSiws, useLogin, useLoginWithEmail, useLoginWithFarcasterV2, useLoginWithOAuth, useLoginWithPasskey, useLoginWithSiwe, useLoginWithSiws, useLoginWithSms, useLoginWithTelegram, useLogout, useMfa, useMfaEnrollment, useMigrateWallets, useModalStatus, useOAuthTokens, usePrivy, useRecoverEmbeddedWallet, useRegisterMfaListener, useSendTransaction, useSessionSigners, useSetWalletRecovery, useSign7702Authorization, useSignMessage, useSignTransaction, useSignTypedData, useSignupWithPasskey, useSubscribeToJwtAuthWithFlag, useSyncJwtBasedAuthState, useToken, useUpdateAccount, useUpdateEmail, useUser, useWallets };
+export { BaseConnectedWalletType, Captcha, ConnectWalletModalOptions, ConnectedWallet, ConnectorManager, type CustomAuthFlowState, EIP1193Provider, EthereumWalletConnector, FundWalletConfig, type JwtAuthFlowState, LinkedAccountWithMetadata, LoginModal, LoginModalOptions, LoginWithCode, MfaMethod, OAuthFlowState, OAuthTokens, OtpFlowState, PasskeyFlowState, PrivyClient, PrivyClientConfig, PrivyEvents, type PrivyInterface, PrivyModal, PrivyProvider, type PrivyProviderProps, type SendCodeToEmail, type SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, SiweFlowState, TelegramAuthFlowState, UnsignedTransactionRequest, type UseAuthorizationSignatureInterface, type UseBaseAccountSdkInterface, type UseConnectBaseAccountInterface, type UseConnectCoinbaseSmartWalletInterface, type UseCustomAuth, type UseDelegatedActionsInterface, type UseFundWalletInterface, type UseGetAccessTokenForProvider, type UseImportWalletInterface, type UseLinkJwtAccount, type UseLinkWithPasskey, type UseLinkWithSiws, type UseLoginWithEmail, type UseLoginWithPasskey, type UseLoginWithSiws, type UseLoginWithSms, type UseLoginWithTelegram, type UseOAuthTokens, type UseRecoverEmbeddedWalletInterface, type UseSessionSignersInterface, type UseSignupWithPasskey, type UseSubscribeToJwtAuthWithFlagInput, type UseSyncJwtBasedAuthStateInput, type UseSyncJwtBasedAuthStateInterface, type UseWalletsInterface, type UseX402Fetch, User, VERSION, Wallet, WalletConnector, WalletListEntry, type WrapFetchWithPayment, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getCustomerAccessToken as getAccessToken, getEmbeddedConnectedWallet, getIdentityToken, toViemAccount, useActiveWallet, useAuthMfa, useAuthMfaEnrollment, useAuthorizationSignature, useBaseAccountSdk, useConnectBaseAccount, useConnectCoinbaseSmartWallet, useConnectOrCreateWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useCustomAuth, useDelegatedActions, useFarcasterSigner, useFundWallet, useGetAccessTokenForProvider, useGuestAccounts, useHeadlessDelegatedActions, useIdentityToken, useImportWallet, useLinkAccount, useLinkJwtAccount, useLinkWithPasskey, useLinkWithSiwe, useLinkWithSiws, useLogin, useLoginWithEmail, useLoginWithFarcasterV2, useLoginWithOAuth, useLoginWithPasskey, useLoginWithSiwe, useLoginWithSiws, useLoginWithSms, useLoginWithTelegram, useLogout, useMfa, useMfaEnrollment, useMigrateWallets, useModalStatus, useOAuthTokens, usePrivy, useRecoverEmbeddedWallet, useRegisterMfaListener, useSendTransaction, useSessionSigners, useSetWalletRecovery, useSign7702Authorization, useSignMessage, useSignTransaction, useSignTypedData, useSignupWithPasskey, useSubscribeToJwtAuthWithFlag, useSyncJwtBasedAuthState, useToken, useUpdateAccount, useUpdateEmail, useUser, useWallets, useX402Fetch };