@dynamic-labs-sdk/react-hooks 1.7.0 → 1.8.0

package/dist/index.esm.js

@@ -1,5 +1,5 @@
 import { assertPackageVersion } from "@dynamic-labs-sdk/assert-package-version";
-import { BaseError, acknowledgeRecoveryCodes, addNetwork, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, consumeMfaToken, createCoinbaseOnrampOrder, createCryptoDotComPayment, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, executeSwapTransaction, getActiveNetworkData, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseBuyUrl, getGoogleDriveBackupReadiness, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMultichainTokenBalances, getNativeBalance, getNetworksData, getPasskeys, getRegisteredDevices, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, isCaptchaRequired, isUserMissingMfaAuth, isUserOnboardingComplete, logout, onEvent, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount, waitForClientInitialized } from "@dynamic-labs-sdk/client";
+import { BaseError, acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, checkStepUpAuth, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, consumeMfaToken, createCoinbaseOnrampOrder, createCryptoDotComPayment, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, executeSwapTransaction, getActiveNetworkData, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseBuyUrl, getGoogleDriveBackupReadiness, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMoonPayCurrencies, getMoonPayUrl, getMultichainTokenBalances, getNativeBalance, getNetworksData, getPasskeys, getRegisteredDevices, getSwapQuote, getSwapStatus, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, getWalletConnectCatalog, getWalletOptionsCatalogue, isCaptchaRequired, isUserMissingMfaAuth, isUserOnboardingComplete, logout, onEvent, onWalletProviderEvent, onceEvent, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount, waitForClientInitialized } from "@dynamic-labs-sdk/client";
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { createContext, useContext, useEffect, useMemo, useRef } from "react";
 import { jsx } from "react/jsx-runtime";
@@ -7,7 +7,7 @@ import { getCore } from "@dynamic-labs-sdk/client/core";
 
 //#region package.json
 var name = "@dynamic-labs-sdk/react-hooks";
-var version = "1.7.0";
+var version = "1.8.0";
 
 //#endregion
 //#region src/modules/DynamicContext/DynamicContext.ts
@@ -385,6 +385,30 @@ const useBalanceForAddress = ({ queryParams, ...args }) => useBaseQuery({
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/useCheckStepUpAuth/useCheckStepUpAuth.ts
+/**
+* Checks whether step-up authentication is required for a given scope and
+* returns the credentials available to satisfy it.
+*
+* Wraps `checkStepUpAuth` from `@dynamic-labs-sdk/client`. Use the returned
+* `isRequired` to decide whether to show a step-up UI before a sensitive
+* action (e.g. exporting a wallet).
+*
+* @example
+* ```tsx
+* const { data } = useCheckStepUpAuth({ scope: TokenScope.Walletexport });
+* if (data?.isRequired) {
+*   // render step-up UI using data.credentials
+* }
+* ```
+*/
+const useCheckStepUpAuth = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => checkStepUpAuth(args, client),
+	queryKey: ["useCheckStepUpAuth", args],
+	queryParams
+});
+
 //#endregion
 //#region src/hooks/useCoinbaseBuyUrl/useCoinbaseBuyUrl.ts
 /**
@@ -401,6 +425,31 @@ const useCoinbaseBuyUrl = ({ queryParams, ...args }) => useBaseQuery({
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/useCoinbaseOnrampOrderEventListener/useCoinbaseOnrampOrderEventListener.ts
+/**
+* Subscribes to Coinbase onramp order events for the duration of the component.
+*
+* Wraps `addCoinbaseOnrampOrderEventListener` from `@dynamic-labs-sdk/client`.
+* Uses a ref to always call the latest listener without re-subscribing, and
+* removes the listener on unmount.
+*
+* @example
+* ```tsx
+* useCoinbaseOnrampOrderEventListener({
+*   listener: ({ eventName, data }) => console.log(eventName, data),
+* });
+* ```
+*/
+const useCoinbaseOnrampOrderEventListener = ({ listener }) => {
+	const client = useDynamicClient();
+	const callbackRef = useRef(listener);
+	callbackRef.current = listener;
+	useEffect(() => addCoinbaseOnrampOrderEventListener({ listener: (...args) => {
+		callbackRef.current(...args);
+	} }, client), [client]);
+};
+
 //#endregion
 //#region src/hooks/useCompleteDeviceRegistration/useCompleteDeviceRegistration.ts
 /**
@@ -451,6 +500,63 @@ const useConfirmTransaction = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => confirmTransaction(variables, client)
 });
 
+//#endregion
+//#region src/hooks/useConnectAndVerifyWithWalletProvider/useConnectAndVerifyWithWalletProvider.ts
+/**
+* Connects to a wallet provider and verifies ownership in a single step.
+*
+* Wraps `connectAndVerifyWithWalletProvider` from `@dynamic-labs-sdk/client`.
+* Call `mutate({ walletProviderKey })` to connect and prompt the user to sign
+* a verification message, adding the verified account to their profile.
+*
+* Throws `DeeplinkConnectAndVerifyUnsupportedError` on mobile with deeplink
+* wallet providers — there, use `useConnectWithWalletProvider` followed by
+* `useVerifyWalletAccount` from a fresh user gesture instead.
+*
+* @example
+* ```tsx
+* const { mutate: connectAndVerify, isPending } =
+*   useConnectAndVerifyWithWalletProvider();
+* <button
+*   onClick={() => connectAndVerify({ walletProviderKey: 'metamaskevm' })}
+*   disabled={isPending}
+* >
+*   Connect & verify
+* </button>
+* ```
+*/
+const useConnectAndVerifyWithWalletProvider = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => connectAndVerifyWithWalletProvider(variables, client)
+});
+
+//#endregion
+//#region src/hooks/useConnectWithWalletProvider/useConnectWithWalletProvider.ts
+/**
+* Connects to a wallet provider and returns the connected wallet account.
+*
+* Wraps `connectWithWalletProvider` from `@dynamic-labs-sdk/client`. Call
+* `mutate({ walletProviderKey })` to trigger the connection — the wallet
+* provider will prompt the user via its native UI. The connected account is
+* not verified; pair with `useVerifyWalletAccount`, or use
+* `useConnectAndVerifyWithWalletProvider` to do both in one step.
+*
+* @example
+* ```tsx
+* const { mutate: connect, data, isPending } = useConnectWithWalletProvider();
+* <button
+*   onClick={() => connect({ walletProviderKey: 'metamaskevm' })}
+*   disabled={isPending}
+* >
+*   Connect
+* </button>
+* ```
+*/
+const useConnectWithWalletProvider = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => connectWithWalletProvider(variables, client)
+});
+
 //#endregion
 //#region src/hooks/useConsumeMfaToken/useConsumeMfaToken.ts
 /**
@@ -816,6 +922,38 @@ const useMfaRecoveryCodes = ({ queryParams } = {}) => useBaseQuery({
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/useMoonPayCurrencies/useMoonPayCurrencies.ts
+/**
+* Wraps `getMoonPayCurrencies` from `@dynamic-labs-sdk/client`. Returns the list of currencies MoonPay supports for the given parameters.
+*
+* @example
+* ```tsx
+* const { data: currencies, isLoading } = useMoonPayCurrencies(params);
+* ```
+*/
+const useMoonPayCurrencies = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => getMoonPayCurrencies(args, client),
+	queryKey: ["useMoonPayCurrencies", args],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/useMoonPayUrl/useMoonPayUrl.ts
+/**
+* Wraps `getMoonPayUrl` from `@dynamic-labs-sdk/client`. Returns a MoonPay widget URL for the given parameters.
+*
+* @example
+* ```tsx
+* const { data: moonPayUrl, isLoading } = useMoonPayUrl(params);
+* ```
+*/
+const useMoonPayUrl = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => getMoonPayUrl(args, client),
+	queryKey: ["useMoonPayUrl", args],
+	queryParams
+});
+
 //#endregion
 //#region src/hooks/useMultichainTokenBalances/useMultichainTokenBalances.ts
 /**
@@ -875,6 +1013,35 @@ const useNetworksData = () => useBaseState({
 	selector: (client) => getNetworksData(client)
 });
 
+//#endregion
+//#region src/hooks/useOnceEvent/useOnceEvent.ts
+/**
+* Subscribes to a Dynamic client event for a single occurrence.
+*
+* Wraps `onceEvent` from `@dynamic-labs-sdk/client` — the one-shot sibling of
+* `useEvent`. The listener fires at most once. Uses a ref to always call the
+* latest listener, and cleans up the subscription on unmount or event change.
+*
+* @example
+* ```tsx
+* useOnceEvent({
+*   event: 'authFlowCancelled',
+*   listener: () => console.log('auth flow cancelled'),
+* });
+* ```
+*/
+const useOnceEvent = ({ event, listener }) => {
+	const client = useDynamicClient();
+	const callbackRef = useRef(listener);
+	callbackRef.current = listener;
+	useEffect(() => onceEvent({
+		event,
+		listener: (...args) => {
+			callbackRef.current(...args);
+		}
+	}, client), [event, client]);
+};
+
 //#endregion
 //#region src/hooks/usePasskeys/usePasskeys.ts
 /**
@@ -1266,6 +1433,38 @@ const useSignMessage = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => signMessage(variables, client)
 });
 
+//#endregion
+//#region src/hooks/useSwapQuote/useSwapQuote.ts
+/**
+* Wraps `getSwapQuote` from `@dynamic-labs-sdk/client`. Returns a swap quote (including the signing payload consumed by {@link useExecuteSwapTransaction}).
+*
+* @example
+* ```tsx
+* const { data: quote, isLoading } = useSwapQuote(params);
+* ```
+*/
+const useSwapQuote = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => getSwapQuote(args, client),
+	queryKey: ["useSwapQuote", args],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/useSwapStatus/useSwapStatus.ts
+/**
+* Wraps `getSwapStatus` from `@dynamic-labs-sdk/client`. Returns the current status of a previously submitted swap.
+*
+* @example
+* ```tsx
+* const { data: status, isLoading } = useSwapStatus(params);
+* ```
+*/
+const useSwapStatus = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => getSwapStatus(args, client),
+	queryKey: ["useSwapStatus", args],
+	queryParams
+});
+
 //#endregion
 //#region src/hooks/useSwitchActiveNetwork/useSwitchActiveNetwork.ts
 /**
@@ -1552,10 +1751,80 @@ const useWalletAccounts = () => useBaseState({
 	selector: (client) => getWalletAccounts(client)
 });
 
+//#endregion
+//#region src/hooks/useWalletConnectCatalog/useWalletConnectCatalog.ts
+/**
+* Returns the WalletConnect catalog (groups and wallets) used for displaying
+* wallet information and building mobile wallet deeplinks.
+*
+* Wraps `getWalletConnectCatalog` from `@dynamic-labs-sdk/client`.
+*
+* @example
+* ```tsx
+* const { data: catalog, isLoading } = useWalletConnectCatalog();
+* ```
+*/
+const useWalletConnectCatalog = ({ queryParams } = {}) => useBaseQuery({
+	queryFn: (client) => getWalletConnectCatalog(client),
+	queryKey: ["useWalletConnectCatalog"],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/useWalletOptionsCatalogue/useWalletOptionsCatalogue.ts
+/**
+* Wraps `getWalletOptionsCatalogue` from `@dynamic-labs-sdk/client`. Returns the catalogue of wallet options the project supports.
+*
+* @example
+* ```tsx
+* const { data: catalogue, isLoading } = useWalletOptionsCatalogue();
+* ```
+*/
+const useWalletOptionsCatalogue = ({ queryParams, ...args } = {}) => useBaseQuery({
+	queryFn: (client) => getWalletOptionsCatalogue(args, client),
+	queryKey: ["useWalletOptionsCatalogue", args],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/useWalletProviderEvent/useWalletProviderEvent.ts
+/**
+* Subscribes to an event emitted by a specific wallet provider.
+*
+* Wraps `onWalletProviderEvent` from `@dynamic-labs-sdk/client`. Uses a ref to
+* always call the latest callback without re-subscribing, and cleans up the
+* subscription on unmount or when `event` / `walletProviderKey` change.
+*
+* @example
+* ```tsx
+* useWalletProviderEvent({
+*   walletProviderKey: 'metamaskevm',
+*   event: 'accountsChanged',
+*   callback: ({ addresses }) => console.log(addresses),
+* });
+* ```
+*/
+const useWalletProviderEvent = ({ callback, event, walletProviderKey }) => {
+	const client = useDynamicClient();
+	const callbackRef = useRef(callback);
+	callbackRef.current = callback;
+	useEffect(() => onWalletProviderEvent({
+		callback: ((...args) => {
+			callbackRef.current(...args);
+		}),
+		event,
+		walletProviderKey
+	}, client), [
+		event,
+		walletProviderKey,
+		client
+	]);
+};
+
 //#endregion
 //#region src/exports/index.ts
 assertPackageVersion(name, version);
 
 //#endregion
-export { DynamicProvider, useAcknowledgeRecoveryCodes, useActiveNetworkData, useAddNetwork, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMfa, useAuthenticateTotpMfaDevice, useAvailableWalletProvidersData, useBalanceForAddress, useCoinbaseBuyUrl, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConsumeMfaToken, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateNewMfaRecoveryCodes, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDynamicClient, useEvent, useExecuteSwapTransaction, useGoogleDriveBackupReadiness, useInitStatus, useIsCaptchaRequired, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useKrakenWhitelistedAddresses, useLogout, useMfaDevices, useMfaMethods, useMfaRecoveryCodes, useMultichainTokenBalances, useNativeBalance, useNetworksData, usePasskeys, useProveWalletAccountOwnership, useRefreshAuth, useRegisterPasskey, useRegisterTotpMfaDevice, useRegisteredDevices, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useSendEmailOtp, useSendSmsOtp, useSessionExpiresAt, useSetDefaultMfaDevice, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSwitchActiveNetwork, useTokenBalances, useTransactionHistory, useTransferAmount, useTransferWalletAccount, useUnlinkSocialAccount, useUpdateUser, useUser, useUserSocialAccounts, useVerifyOtp, useVerifyWalletAccount, useWalletAccounts };
+export { DynamicProvider, useAcknowledgeRecoveryCodes, useActiveNetworkData, useAddNetwork, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMfa, useAuthenticateTotpMfaDevice, useAvailableWalletProvidersData, useBalanceForAddress, useCheckStepUpAuth, useCoinbaseBuyUrl, useCoinbaseOnrampOrderEventListener, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useConsumeMfaToken, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateNewMfaRecoveryCodes, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDynamicClient, useEvent, useExecuteSwapTransaction, useGoogleDriveBackupReadiness, useInitStatus, useIsCaptchaRequired, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useKrakenWhitelistedAddresses, useLogout, useMfaDevices, useMfaMethods, useMfaRecoveryCodes, useMoonPayCurrencies, useMoonPayUrl, useMultichainTokenBalances, useNativeBalance, useNetworksData, useOnceEvent, usePasskeys, useProveWalletAccountOwnership, useRefreshAuth, useRegisterPasskey, useRegisterTotpMfaDevice, useRegisteredDevices, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useSendEmailOtp, useSendSmsOtp, useSessionExpiresAt, useSetDefaultMfaDevice, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSwapQuote, useSwapStatus, useSwitchActiveNetwork, useTokenBalances, useTransactionHistory, useTransferAmount, useTransferWalletAccount, useUnlinkSocialAccount, useUpdateUser, useUser, useUserSocialAccounts, useVerifyOtp, useVerifyWalletAccount, useWalletAccounts, useWalletConnectCatalog, useWalletOptionsCatalogue, useWalletProviderEvent };
 //# sourceMappingURL=index.esm.js.map