@dynamic-labs-sdk/react-hooks 1.29.0 → 1.30.3

package/dist/index.esm.js

@@ -1,6 +1,6 @@
-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-D9ib5b9h.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-dkF7NJuA.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, 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 { acknowledgeRecoveryCodes, addCoinbaseOnrampOrderEventListener, addNetwork, assertWalletAccountSigningAvailability, attachFlowSource, authenticateMfaRecoveryCode, authenticatePasskeyMFA, authenticateTotpMfaDevice, broadcastFlow, cancelFlow, checkStepUpAuth, claimYieldRewards, completeDeviceRegistration, completeSocialRedirect, confirmTransaction, connectAndVerifyWithWalletProvider, connectWithWalletProvider, createCoinbaseExchangeTransfer, createCoinbaseOnrampOrder, createCryptoDotComPayment, createKrakenExchangeTransfer, createNewMfaRecoveryCodes, deleteMfaDevice, deletePasskey, deleteUser, depositToYieldVault, 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, screenTransaction, sendEmailOTP, sendSmsOTP, setDefaultMfaDevice, signInWithExternalJwt, signInWithPasskey, signInWithSocialPopUp, signInWithSocialRedirect, signMessage, submitFlowTransaction, switchActiveNetwork, transferAmount, transferWalletAccount, unlinkSocialAccount, updateUser, verifyOTP, verifyWalletAccount, withdrawFromYieldVault } from "@dynamic-labs-sdk/client";
 import { useQueryClient } from "@tanstack/react-query";
 import { useEffect, useRef } from "react";
 import { getCore } from "@dynamic-labs-sdk/client/core";
@@ -1952,6 +1952,42 @@ const useSignInWithSocialRedirect = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => signInWithSocialRedirect(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useScreenTransaction/useScreenTransaction.ts
+/**
+* Screens a connected wallet's transaction for sanctioned addresses before you
+* prompt it to sign, and returns the verdict.
+*
+* Wraps `screenTransaction` from `@dynamic-labs-sdk/client`. A `block` verdict
+* resolves rather than throwing, so branch on `decision` — only screening
+* failures land in `error`.
+*
+* @example
+* ```tsx
+* const { mutateAsync: screenTransaction, isPending } = useScreenTransaction();
+*
+* const send = async () => {
+*   const { decision } = await screenTransaction({
+*     chain: 'EVM',
+*     context: { evmTransaction: { to } },
+*   });
+*
+*   if (decision === 'block') return showBlockedDestination();
+*
+*   await walletClient.sendTransaction(transaction);
+* };
+* ```
+*
+* @param [params.mutateParams] - Optional react-query `UseMutationOptions` overrides.
+* @returns A react-query mutation whose `mutateAsync` resolves to the screening verdict.
+* @see screenTransaction
+* @see isExternalWalletScreeningEnabled
+*/
+const useScreenTransaction = ({ mutateParams } = {}) => useBaseMutation({
+	mutateParams,
+	mutationFn: ({ client, variables }) => screenTransaction(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useSignMessage/useSignMessage.ts
 /**
@@ -3222,6 +3258,56 @@ const useRemoveAccountPolicyRule = ({ mutateParams } = {}) => useBaseMutation({
 	mutationFn: ({ client, variables }) => removeAccountPolicyRule(variables, client)
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useClaimYieldRewards/useClaimYieldRewards.ts
+/**
+* Wraps `claimYieldRewards` from `@dynamic-labs-sdk/client`. Call
+* `mutate({ vaultId, walletAccount })` to claim a wallet account's accrued
+* rewards in a vault; the resolved `data` is `{ transactionHash }`.
+*
+* Rejects when there is nothing claimable for this vault right now. Read
+* accrued rewards with {@link useGetYieldRewards} before calling.
+*
+* @example
+* ```tsx
+* const { mutate: claim, data } = useClaimYieldRewards();
+* claim({ vaultId, walletAccount });
+* ```
+*
+* @returns A react-query mutation whose `data` is the claim transaction hash.
+* @see claimYieldRewards
+* @see UseClaimYieldRewardsParams
+*/
+const useClaimYieldRewards = ({ mutateParams } = {}) => useBaseMutation({
+	middlewares: [invalidatesQueries("useGetYieldRewards")],
+	mutateParams,
+	mutationFn: ({ client, variables }) => claimYieldRewards(variables, client)
+});
+
+//#endregion
+//#region src/hooks/wrappers/functions/useDepositToYieldVault/useDepositToYieldVault.ts
+/**
+* Wraps `depositToYieldVault` from `@dynamic-labs-sdk/client`. Call
+* `mutate({ amount, vaultId, walletAccount })` to deposit into a vault (using a
+* `vaultId` from {@link useListYieldVaults}); the resolved `data` is
+* `{ transactionHash }`.
+*
+* @example
+* ```tsx
+* const { mutate: deposit, data } = useDepositToYieldVault();
+* deposit({ amount: '10.5', vaultId, walletAccount });
+* ```
+*
+* @returns A react-query mutation whose `data` is the deposit transaction hash.
+* @see depositToYieldVault
+* @see UseDepositToYieldVaultParams
+*/
+const useDepositToYieldVault = ({ mutateParams } = {}) => useBaseMutation({
+	middlewares: [invalidatesQueries("useGetYieldPosition")],
+	mutateParams,
+	mutationFn: ({ client, variables }) => depositToYieldVault(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/functions/useGetYieldDetails/useGetYieldDetails.ts
 /**
@@ -3322,6 +3408,30 @@ const useListYieldVaults = ({ queryParams } = {}) => useBaseQuery({
 	queryParams
 });
 
+//#endregion
+//#region src/hooks/wrappers/functions/useWithdrawFromYieldVault/useWithdrawFromYieldVault.ts
+/**
+* Wraps `withdrawFromYieldVault` from `@dynamic-labs-sdk/client`. Call
+* `mutate({ amount, vaultId, walletAccount })` to withdraw from a vault (using a
+* `vaultId` from {@link useListYieldVaults}); the resolved `data` is
+* `{ transactionHash }`.
+*
+* @example
+* ```tsx
+* const { mutate: withdraw, data } = useWithdrawFromYieldVault();
+* withdraw({ amount: '10.5', vaultId, walletAccount });
+* ```
+*
+* @returns A react-query mutation whose `data` is the withdraw transaction hash.
+* @see withdrawFromYieldVault
+* @see UseWithdrawFromYieldVaultParams
+*/
+const useWithdrawFromYieldVault = ({ mutateParams } = {}) => useBaseMutation({
+	middlewares: [invalidatesQueries("useGetYieldPosition")],
+	mutateParams,
+	mutationFn: ({ client, variables }) => withdrawFromYieldVault(variables, client)
+});
+
 //#endregion
 //#region src/hooks/wrappers/state/useInitStatus/useInitStatus.ts
 /**
@@ -3398,5 +3508,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, useCreateCoinbaseExchangeTransfer, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateKrakenExchangeTransfer, useCreateNewMfaRecoveryCodes, useCreatePolicy, useCreateWaasOfflineRecoveryShares, useCreateWaasWalletAccounts, useCreateWalletForBusinessAccount, useDelegateWaasKeyShares, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDetectSocialRedirectUrl, useDynamicClient, useExecuteSwapTransaction, useExportWaasClientKeyshares, useExportWaasPrivateKey, useGetAccountPolicyLayer, useGetActiveNetworkData, useGetActiveNetworkId, useGetAvailableWalletProvidersData, useGetBalanceForAddress, useGetBusinessAccount, useGetCoinbaseAccounts, useGetCoinbaseBuyUrl, useGetConnectedAddresses, useGetFlow, useGetFlowQuote, useGetGoogleDriveBackupReadiness, useGetKrakenAccounts, useGetKrakenWhitelistedAddresses, useGetMfaDevices, useGetMfaMethods, useGetMfaRecoveryCodes, useGetMoonPayCurrencies, useGetMoonPayUrl, useGetMultichainTokenBalances, useGetNativeBalance, useGetPasskeys, useGetPolicy, useGetRegisteredDevices, useGetSignerPolicyLayer, useGetSwapQuote, useGetSwapStatus, useGetTokenBalances, useGetTransactionHistory, useGetUserSocialAccounts, useGetWalletAccounts, useGetWalletConnectCatalog, useGetWalletConnectCatalogWalletByWalletProviderKey, useGetWalletOptionsCatalogue, useGetWalletPolicyLayer, 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, useRemoveAccountPolicyRule, useRemoveBusinessAccountMember, useRemoveBusinessAccountSigner, useRemoveBusinessAccountWallet, useRemovePolicyRules, useRemoveSignerPolicyRule, useRemoveWalletAccount, useRemoveWalletPolicyRule, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useRevokeWaasDelegation, useSendEmailOTP, useSendSmsOTP, useSessionExpiresAt, useSetDefaultMfaDevice, useSetWaasWalletAccountPassword, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSignSerializedTransaction, useSubmitFlowTransaction, useSwitchActiveNetwork, useTransferAmount, useTransferBusinessAccountOwnership, useTransferWalletAccount, useUnlinkSocialAccount, useUnlockWallet, useUpdateBusinessAccount, useUpdateBusinessAccountMemberRole, useUpdateUser, useUpdateWaasPassword, useUpsertAccountPolicyRule, useUpsertSignerPolicyRule, useUpsertWalletPolicyRule, useUser, useVerifyOTP, useVerifyWalletAccount };
+export { DynamicProvider, useAcknowledgeRecoveryCodes, useAddBusinessAccountMember, useAddBusinessAccountSigner, useAddCoinbaseOnrampOrderEventListener, useAddNetwork, useAddWalletToBusinessAccount, useAssertWalletAccountSigningAvailability, useAttachFlowSource, useAuthenticateMfaRecoveryCode, useAuthenticatePasskeyMFA, useAuthenticateTotpMfaDevice, useBackupWaasKeySharesToGoogleDrive, useBroadcastFlow, useCancelFlow, useCheckStepUpAuth, useClaimYieldRewards, useCompleteDeviceRegistration, useCompleteSocialRedirect, useConfirmTransaction, useConnectAndVerifyWithWalletProvider, useConnectWithWalletProvider, useCreateBusinessAccount, useCreateCoinbaseExchangeTransfer, useCreateCoinbaseOnrampOrder, useCreateCryptoDotComPayment, useCreateKrakenExchangeTransfer, useCreateNewMfaRecoveryCodes, useCreatePolicy, useCreateWaasOfflineRecoveryShares, useCreateWaasWalletAccounts, useCreateWalletForBusinessAccount, useDelegateWaasKeyShares, useDeleteMfaDevice, useDeletePasskey, useDeleteUser, useDepositToYieldVault, useDetectSocialRedirectUrl, useDynamicClient, useExecuteSwapTransaction, useExportWaasClientKeyshares, useExportWaasPrivateKey, useGetAccountPolicyLayer, useGetActiveNetworkData, useGetActiveNetworkId, useGetAvailableWalletProvidersData, useGetBalanceForAddress, useGetBusinessAccount, useGetCoinbaseAccounts, useGetCoinbaseBuyUrl, useGetConnectedAddresses, useGetFlow, useGetFlowQuote, useGetGoogleDriveBackupReadiness, useGetKrakenAccounts, useGetKrakenWhitelistedAddresses, useGetMfaDevices, useGetMfaMethods, useGetMfaRecoveryCodes, useGetMoonPayCurrencies, useGetMoonPayUrl, useGetMultichainTokenBalances, useGetNativeBalance, useGetPasskeys, useGetPolicy, useGetRegisteredDevices, useGetSignerPolicyLayer, useGetSwapQuote, useGetSwapStatus, useGetTokenBalances, useGetTransactionHistory, useGetUserSocialAccounts, useGetWalletAccounts, useGetWalletConnectCatalog, useGetWalletConnectCatalogWalletByWalletProviderKey, useGetWalletOptionsCatalogue, useGetWalletPolicyLayer, 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, useRemoveAccountPolicyRule, useRemoveBusinessAccountMember, useRemoveBusinessAccountSigner, useRemoveBusinessAccountWallet, useRemovePolicyRules, useRemoveSignerPolicyRule, useRemoveWalletAccount, useRemoveWalletPolicyRule, useRequestExternalAuthElevatedToken, useRevokeAllRegisteredDevices, useRevokeRegisteredDevice, useRevokeWaasDelegation, useScreenTransaction, useSendEmailOTP, useSendSmsOTP, useSessionExpiresAt, useSetDefaultMfaDevice, useSetWaasWalletAccountPassword, useSignInWithExternalJwt, useSignInWithPasskey, useSignInWithSocialPopUp, useSignInWithSocialRedirect, useSignMessage, useSignSerializedTransaction, useSubmitFlowTransaction, useSwitchActiveNetwork, useTransferAmount, useTransferBusinessAccountOwnership, useTransferWalletAccount, useUnlinkSocialAccount, useUnlockWallet, useUpdateBusinessAccount, useUpdateBusinessAccountMemberRole, useUpdateUser, useUpdateWaasPassword, useUpsertAccountPolicyRule, useUpsertSignerPolicyRule, useUpsertWalletPolicyRule, useUser, useVerifyOTP, useVerifyWalletAccount, useWithdrawFromYieldVault };
 //# sourceMappingURL=index.esm.js.map