@dynamic-labs-sdk/react-hooks 1.25.0 → 1.27.0

package/dist/index.esm.js

@@ -1,10 +1,10 @@
-import { a as useDynamicClient, c as version, i as useBaseMutation, n as useBaseQuery, o as DynamicProvider, r as QUERY_KEY_PREFIX, s as name, t as useBaseState } from "./useBaseState-DcRIixKH.esm.js";
+import { a as useDynamicClient, c as version, i as useBaseMutation, n as useBaseQuery, o as DynamicProvider, r as QUERY_KEY_PREFIX, s as name, t as useBaseState } from "./useBaseState-CA8Djp4O.esm.js";
 import { assertPackageVersion } from "@dynamic-labs-sdk/assert-package-version";
-import { acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, assertWalletAccountSigningAvailability, attachFlowSource, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, broadcastFlow, cancelFlow, checkStepUpAuth, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, createCoinbaseOnrampOrder, createCryptoDotComPayment, createKrakenExchangeTransfer, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, detectSocialRedirectUrl, executeSwapTransaction, getActiveNetworkData, getActiveNetworkId, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseBuyUrl, getConnectedAddresses, getFlow, getFlowQuote, getGoogleDriveBackupReadiness, getKrakenAccounts, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMoonPayCurrencies, getMoonPayUrl, getMultichainTokenBalances, getNativeBalance, getPasskeys, getRegisteredDevices, getSwapQuote, getSwapStatus, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, getWalletConnectCatalog, getWalletConnectCatalogWalletByWalletProviderKey, getWalletOptionsCatalogue, getWalletProviderDataByKey, isDeviceRegistrationRequired, isMfaRequiredForAction, isPendingRecoveryCodesAcknowledgment, isUserMissingMfaAuth, isUserOnboardingComplete, logout, mergeUserAccounts, onEvent, onWalletProviderEvent, onceEvent, prepareFlowSigning, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, submitFlowTransaction, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount } from "@dynamic-labs-sdk/client";
+import { acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, assertWalletAccountSigningAvailability, attachFlowSource, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, broadcastFlow, cancelFlow, checkStepUpAuth, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, createCoinbaseExchangeTransfer, createCoinbaseOnrampOrder, createCryptoDotComPayment, createKrakenExchangeTransfer, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, detectSocialRedirectUrl, executeSwapTransaction, getActiveNetworkData, getActiveNetworkId, getAvailableWalletProvidersData, getBalanceForAddress, getCoinbaseAccounts, getCoinbaseBuyUrl, getConnectedAddresses, getFlow, getFlowQuote, getGoogleDriveBackupReadiness, getKrakenAccounts, getKrakenWhitelistedAddresses, getMfaDevices, getMfaMethods, getMfaRecoveryCodes, getMoonPayCurrencies, getMoonPayUrl, getMultichainTokenBalances, getNativeBalance, getPasskeys, getRegisteredDevices, getSwapQuote, getSwapStatus, getTokenBalances, getTransactionHistory, getUserSocialAccounts, getWalletAccounts, getWalletConnectCatalog, getWalletConnectCatalogWalletByWalletProviderKey, getWalletOptionsCatalogue, getWalletProviderDataByKey, getYieldDetails, getYieldPosition, getYieldRewards, isDeviceRegistrationRequired, isMfaRequiredForAction, isPendingRecoveryCodesAcknowledgment, isUserMissingMfaAuth, isUserOnboardingComplete, listYieldVaults, logout, mergeUserAccounts, onEvent, onWalletProviderEvent, onceEvent, prepareFlowSigning, proveWalletAccountOwnership, refreshAuth, registerPasskey, registerTotpMfaDevice, removeWalletAccount, requestExternalAuthElevatedToken, revokeAllRegisteredDevices, revokeRegisteredDevice, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, submitFlowTransaction, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount } from "@dynamic-labs-sdk/client";
 import { useQueryClient } from "@tanstack/react-query";
 import { useEffect, useRef } from "react";
 import { getCore } from "@dynamic-labs-sdk/client/core";
-import { addBusinessAccountMember, addBusinessAccountSigner, addWalletToBusinessAccount, backupWaasKeySharesToGoogleDrive, createBusinessAccount, createWaasWalletAccounts, createWalletForBusinessAccount, delegateWaasKeyShares, exportWaasClientKeyshares, exportWaasPrivateKey, getBusinessAccount, getWalletRecoveryState, importWaasPrivateKey, listBusinessAccounts, migrateFromFireblocks, refreshWaasWalletAccountShares, removeBusinessAccountMember, removeBusinessAccountSigner, removeBusinessAccountWallet, revokeWaasDelegation, setWaasWalletAccountPassword, transferBusinessAccountOwnership, unlockWallet, updateBusinessAccount, updateBusinessAccountMemberRole, updateWaasPassword } from "@dynamic-labs-sdk/client/waas";
+import { addBusinessAccountMember, addBusinessAccountSigner, addWalletToBusinessAccount, backupWaasKeySharesToGoogleDrive, createBusinessAccount, createWaasOfflineRecoveryShares, createWaasWalletAccounts, createWalletForBusinessAccount, delegateWaasKeyShares, exportWaasClientKeyshares, exportWaasPrivateKey, getBusinessAccount, getWalletRecoveryState, importWaasPrivateKey, listBusinessAccounts, migrateFromFireblocks, refreshWaasWalletAccountShares, removeBusinessAccountMember, removeBusinessAccountSigner, removeBusinessAccountWallet, revokeWaasDelegation, setWaasWalletAccountPassword, transferBusinessAccountOwnership, unlockWallet, updateBusinessAccount, updateBusinessAccountMemberRole, updateWaasPassword } from "@dynamic-labs-sdk/client/waas";
 
 //#region src/hooks/wrappers/functions/useAcknowledgeRecoveryCodes/useAcknowledgeRecoveryCodes.ts
 /**
@@ -1148,6 +1148,50 @@ const useGetKrakenWhitelistedAddresses = ({ queryParams } = {}) => useBaseQuery(
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useGetCoinbaseAccounts/useGetCoinbaseAccounts.ts
+/**
+* Wraps `getCoinbaseAccounts` from `@dynamic-labs-sdk/client`. Returns the authenticated user's
+* Coinbase accounts (with balances), optionally filtered by chain/network.
+*
+* Automatically refetches when a different user becomes current (login or
+* account switch), so consumers don't have to pair it with a manual
+* `userChanged` listener.
+*
+* @example
+* ```tsx
+* const { data: accounts, isLoading } = useGetCoinbaseAccounts();
+* ```
+* @returns A react-query result whose `data` is the array of Coinbase accounts resolved by `getCoinbaseAccounts`.
+* @see getCoinbaseAccounts
+* @see UseGetCoinbaseAccountsParams
+*/
+const useGetCoinbaseAccounts = ({ queryParams, ...args } = {}) => useBaseQuery({
+	middlewares: [invalidateOnUserSwitch()],
+	queryFn: (client) => getCoinbaseAccounts(args, client),
+	queryKey: ["useGetCoinbaseAccounts", args],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/useCreateCoinbaseExchangeTransfer.ts
+/**
+* Wraps `createCoinbaseExchangeTransfer` from `@dynamic-labs-sdk/client`. Call `mutate({ accountId, ... })` to send crypto from a Coinbase account (see `useGetCoinbaseAccounts`) to an address; the resolved `data` is the created transfer.
+*
+* @example
+* ```tsx
+* const { mutate: transfer } = useCreateCoinbaseExchangeTransfer();
+* transfer({ accountId, amount: 0.5, currency: 'USDC', to: '0x...' });
+* ```
+* @returns A react-query mutation result whose `data` is the transfer resolved by `createCoinbaseExchangeTransfer`.
+* @see createCoinbaseExchangeTransfer
+* @see UseCreateCoinbaseExchangeTransferParams
+*/
+const useCreateCoinbaseExchangeTransfer = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => createCoinbaseExchangeTransfer(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useListBusinessAccounts/useListBusinessAccounts.ts
 /**
@@ -1157,15 +1201,17 @@ const useGetKrakenWhitelistedAddresses = ({ queryParams } = {}) => useBaseQuery(
 * @example
 * ```tsx
 * const { data: businessAccounts, isLoading } = useListBusinessAccounts();
+* // or filter by a developer-supplied externalRef:
+* const { data } = useListBusinessAccounts({ externalRefs: ['acme-org-42'] });
 * ```
 *
 * @returns A react-query result whose `data` is the paginated list resolved by `listBusinessAccounts`.
 * @see listBusinessAccounts
 * @see UseListBusinessAccountsParams
 */
-const useListBusinessAccounts = ({ queryParams } = {}) => useBaseQuery({
-	queryFn: (client) => listBusinessAccounts(client),
-	queryKey: ["useListBusinessAccounts"],
+const useListBusinessAccounts = ({ externalRefs, queryParams } = {}) => useBaseQuery({
+	queryFn: (client) => listBusinessAccounts({ externalRefs }, client),
+	queryKey: ["useListBusinessAccounts", externalRefs],
 	queryParams
 });
 
@@ -2464,6 +2510,29 @@ const useBackupWaasKeySharesToGoogleDrive = ({ mutateParams } = {}) => useBaseMu
 	mutationFn: ({ client, variables }) => backupWaasKeySharesToGoogleDrive(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/useCreateWaasOfflineRecoveryShares.ts
+/**
+* Wraps `createWaasOfflineRecoveryShares` from `@dynamic-labs-sdk/client/waas`. Call `mutate(variables)` to
+* mint a recovery share set for an embedded wallet available for recovery outside of Dynamic.
+*
+* @example
+* ```tsx
+* const { mutate, isPending } = useCreateWaasOfflineRecoveryShares();
+* <button onClick={() => mutate(variables)} disabled={isPending}>
+*   Continue
+* </button>
+* ```
+*
+* @returns A react-query mutation whose `mutate`/`mutateAsync` calls `createWaasOfflineRecoveryShares` and whose `data` is its resolved value.
+* @see createWaasOfflineRecoveryShares
+* @see UseCreateWaasOfflineRecoverySharesParams
+*/
+const useCreateWaasOfflineRecoveryShares = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => createWaasOfflineRecoveryShares(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useCreateWaasWalletAccounts/useCreateWaasWalletAccounts.ts
 /**
@@ -2768,6 +2837,106 @@ const useUpdateWaasPassword = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => updateWaasPassword(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useGetYieldDetails/useGetYieldDetails.ts
+/**
+* Wraps `getYieldDetails` from `@dynamic-labs-sdk/client`. Returns full details for one yield vault.
+*
+* @example
+* ```tsx
+* const { data: details, isLoading } = useGetYieldDetails({ vaultId });
+* ```
+*
+* @returns A react-query result whose `data` is the vault's full details.
+* @see getYieldDetails
+* @see UseGetYieldDetailsParams
+*/
+const useGetYieldDetails = ({ queryParams, ...args }) => useBaseQuery({
+	queryFn: (client) => getYieldDetails(args, client),
+	queryKey: ["useGetYieldDetails", args],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useGetYieldPosition/useGetYieldPosition.ts
+/**
+* Wraps `getYieldPosition` from `@dynamic-labs-sdk/client`. Returns the
+* wallet account's share balance and asset value in a yield vault. The
+* hook stays disabled until `walletAccount` is defined.
+*
+* @example
+* ```tsx
+* const { data: position, isLoading } = useGetYieldPosition({ vaultId, walletAccount });
+* ```
+*
+* @returns A react-query result whose `data` is the wallet's share balance and asset value; it stays disabled until `walletAccount` is defined.
+* @see getYieldPosition
+* @see UseGetYieldPositionParams
+*/
+const useGetYieldPosition = ({ vaultId, walletAccount, queryParams }) => useBaseQuery({
+	enabled: walletAccount !== void 0,
+	queryFn: (client) => getYieldPosition({
+		vaultId,
+		walletAccount
+	}, client),
+	queryKey: [
+		"useGetYieldPosition",
+		vaultId,
+		walletAccount?.id
+	],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useGetYieldRewards/useGetYieldRewards.ts
+/**
+* Wraps `getYieldRewards` from `@dynamic-labs-sdk/client`. Returns the
+* wallet account's accrued rewards in a yield vault. The hook stays
+* disabled until `walletAccount` is defined.
+*
+* @example
+* ```tsx
+* const { data: rewards, isLoading } = useGetYieldRewards({ vaultId, walletAccount });
+* ```
+*
+* @returns A react-query result whose `data` is the wallet's accrued rewards; it stays disabled until `walletAccount` is defined.
+* @see getYieldRewards
+* @see UseGetYieldRewardsParams
+*/
+const useGetYieldRewards = ({ vaultId, walletAccount, queryParams }) => useBaseQuery({
+	enabled: walletAccount !== void 0,
+	queryFn: (client) => getYieldRewards({
+		vaultId,
+		walletAccount
+	}, client),
+	queryKey: [
+		"useGetYieldRewards",
+		vaultId,
+		walletAccount?.id
+	],
+	queryParams
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useListYieldVaults/useListYieldVaults.ts
+/**
+* Wraps `listYieldVaults` from `@dynamic-labs-sdk/client`. Returns the yield vaults available to the current environment.
+*
+* @example
+* ```tsx
+* const { data: vaults, isLoading } = useListYieldVaults();
+* ```
+*
+* @returns A react-query result whose `data` is the yield vaults accessible to this environment.
+* @see listYieldVaults
+* @see UseListYieldVaultsParams
+*/
+const useListYieldVaults = ({ queryParams } = {}) => useBaseQuery({
+	queryFn: (client) => listYieldVaults(client),
+	queryKey: ["useListYieldVaults"],
+	queryParams
+});
+
 //#endregion
 //#region src/hooks/wrappers/state/useInitStatus/useInitStatus.ts
 /**
@@ -2844,5 +3013,5 @@ const useUser = () => useBaseState({
 assertPackageVersion(name, version);
 
 //#endregion
-export { DynamicProvider, useAcknowledgeRecoveryCodes, useAddBusinessAccountMember, useAddBusinessAccountSigner, useAddCoinbaseOnrampOrderEventListener, useAddNetwork, useAddWalletToBusinessAccount, useAssertWalletAccountSigningAvailability, useAttachFlowSource, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMFA, useAuthenticateTotpMfaDevice, useBackupWaasKeySharesToGoogleDrive, useBroadcastFlow, useCancelFlow, useCheckStepUpAuth, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useCreateBusinessAccount, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateKrakenExchangeTransfer, useCreateNewMfaRecoveryCodes, useCreateWaasWalletAccounts, useCreateWalletForBusinessAccount, useDelegateWaasKeyShares, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDetectSocialRedirectUrl, useDynamicClient, useExecuteSwapTransaction, useExportWaasClientKeyshares, useExportWaasPrivateKey, useGetActiveNetworkData, useGetActiveNetworkId, useGetAvailableWalletProvidersData, useGetBalanceForAddress, useGetBusinessAccount, useGetCoinbaseBuyUrl, useGetConnectedAddresses, useGetFlow, useGetFlowQuote, useGetGoogleDriveBackupReadiness, useGetKrakenAccounts, useGetKrakenWhitelistedAddresses, useGetMfaDevices, useGetMfaMethods, useGetMfaRecoveryCodes, useGetMoonPayCurrencies, useGetMoonPayUrl, useGetMultichainTokenBalances, useGetNativeBalance, useGetPasskeys, useGetRegisteredDevices, useGetSwapQuote, useGetSwapStatus, useGetTokenBalances, useGetTransactionHistory, useGetUserSocialAccounts, useGetWalletAccounts, useGetWalletConnectCatalog, useGetWalletConnectCatalogWalletByWalletProviderKey, useGetWalletOptionsCatalogue, useGetWalletProviderDataByKey, useGetWalletRecoveryState, useImportWaasPrivateKey, useInitStatus, useIsDeviceRegistrationRequired, useIsMfaRequiredForAction, useIsPendingRecoveryCodesAcknowledgment, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useListBusinessAccounts, useLogout, useMergeUserAccounts, useMigrateFromFireblocks, useOnEvent, useOnWalletProviderEvent, useOnceEvent, usePrepareFlowSigning, useProveWalletAccountOwnership, useRefreshAuth, useRefreshWaasWalletAccountShares, useRegisterPasskey, useRegisterTotpMfaDevice, useRemoveBusinessAccountMember, useRemoveBusinessAccountSigner, useRemoveBusinessAccountWallet, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useRevokeWaasDelegation, useSendEmailOTP, useSendSmsOTP, useSessionExpiresAt, useSetDefaultMfaDevice, useSetWaasWalletAccountPassword, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSubmitFlowTransaction, useSwitchActiveNetwork, useTransferAmount, useTransferBusinessAccountOwnership, useTransferWalletAccount, useUnlinkSocialAccount, useUnlockWallet, useUpdateBusinessAccount, useUpdateBusinessAccountMemberRole, useUpdateUser, useUpdateWaasPassword, useUser, useVerifyOTP, useVerifyWalletAccount };
+export { DynamicProvider, useAcknowledgeRecoveryCodes, useAddBusinessAccountMember, useAddBusinessAccountSigner, useAddCoinbaseOnrampOrderEventListener, useAddNetwork, useAddWalletToBusinessAccount, useAssertWalletAccountSigningAvailability, useAttachFlowSource, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMFA, useAuthenticateTotpMfaDevice, useBackupWaasKeySharesToGoogleDrive, useBroadcastFlow, useCancelFlow, useCheckStepUpAuth, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useCreateBusinessAccount, useCreateCoinbaseExchangeTransfer, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateKrakenExchangeTransfer, useCreateNewMfaRecoveryCodes, useCreateWaasOfflineRecoveryShares, useCreateWaasWalletAccounts, useCreateWalletForBusinessAccount, useDelegateWaasKeyShares, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDetectSocialRedirectUrl, useDynamicClient, useExecuteSwapTransaction, useExportWaasClientKeyshares, useExportWaasPrivateKey, useGetActiveNetworkData, useGetActiveNetworkId, useGetAvailableWalletProvidersData, useGetBalanceForAddress, useGetBusinessAccount, useGetCoinbaseAccounts, useGetCoinbaseBuyUrl, useGetConnectedAddresses, useGetFlow, useGetFlowQuote, useGetGoogleDriveBackupReadiness, useGetKrakenAccounts, useGetKrakenWhitelistedAddresses, useGetMfaDevices, useGetMfaMethods, useGetMfaRecoveryCodes, useGetMoonPayCurrencies, useGetMoonPayUrl, useGetMultichainTokenBalances, useGetNativeBalance, useGetPasskeys, useGetRegisteredDevices, useGetSwapQuote, useGetSwapStatus, useGetTokenBalances, useGetTransactionHistory, useGetUserSocialAccounts, useGetWalletAccounts, useGetWalletConnectCatalog, useGetWalletConnectCatalogWalletByWalletProviderKey, useGetWalletOptionsCatalogue, useGetWalletProviderDataByKey, useGetWalletRecoveryState, useGetYieldDetails, useGetYieldPosition, useGetYieldRewards, useImportWaasPrivateKey, useInitStatus, useIsDeviceRegistrationRequired, useIsMfaRequiredForAction, useIsPendingRecoveryCodesAcknowledgment, useIsUserMissingMfaAuth, useIsUserOnboardingComplete, useListBusinessAccounts, useListYieldVaults, useLogout, useMergeUserAccounts, useMigrateFromFireblocks, useOnEvent, useOnWalletProviderEvent, useOnceEvent, usePrepareFlowSigning, useProveWalletAccountOwnership, useRefreshAuth, useRefreshWaasWalletAccountShares, useRegisterPasskey, useRegisterTotpMfaDevice, useRemoveBusinessAccountMember, useRemoveBusinessAccountSigner, useRemoveBusinessAccountWallet, useRemoveWalletAccount, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useRevokeWaasDelegation, useSendEmailOTP, useSendSmsOTP, useSessionExpiresAt, useSetDefaultMfaDevice, useSetWaasWalletAccountPassword, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSubmitFlowTransaction, useSwitchActiveNetwork, useTransferAmount, useTransferBusinessAccountOwnership, useTransferWalletAccount, useUnlinkSocialAccount, useUnlockWallet, useUpdateBusinessAccount, useUpdateBusinessAccountMemberRole, useUpdateUser, useUpdateWaasPassword, useUser, useVerifyOTP, useVerifyWalletAccount };
 //# sourceMappingURL=index.esm.js.map