@frak-labs/react-sdk 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -1,298 +1,342 @@
-import * as react from 'react';
-import { PropsWithChildren, CSSProperties, ReactNode } from 'react';
-import * as _frak_labs_core_sdk from '@frak-labs/core-sdk';
-import { FrakWalletSdkConfig, FrakClient, WalletStatusReturnType, SendTransactionReturnType, FrakRpcError, SiweAuthenticateReturnType, DisplayModalParamsType, ModalStepTypes, SendInteractionReturnType, SendInteractionParamsType, ModalRpcStepsResultType, OpenSsoParamsType, GetProductInformationReturnType } from '@frak-labs/core-sdk';
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
-import { SendTransactionParams, SiweAuthenticateModalParams, ProcessReferralOptions } from '@frak-labs/core-sdk/actions';
-import { Hex } from 'viem';
-
-/**
- * The context that will keep the Frak Wallet SDK configuration
- * @ignore
- */
-declare const FrakConfigContext: react.Context<FrakWalletSdkConfig | undefined>;
-/**
- * Props to instantiate the Frak Wallet SDK configuration provider
- *
- * @group provider
- */
-type FrakConfigProviderProps = {
-    /**
-     * The wanted Frak configuration
-     * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig}
-     */
-    config: FrakWalletSdkConfig;
-};
-/**
- * Simple config provider for the Frak Wallet SDK
- *
- * Should be wrapped within a {@link @tanstack/react-query!QueryClientProvider | `QueryClientProvider`}
- *
- * @group provider
- *
- * @param parameters
- */
-declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): react.FunctionComponentElement<react.ProviderProps<FrakWalletSdkConfig | undefined>>;
-
-/**
- * The context that will keep the Frak Wallet SDK client
- * @ignore
- */
-declare const FrakIFrameClientContext: react.Context<FrakClient | undefined>;
-/**
- * Props to instantiate the Frak Wallet SDK configuration provider
- *
- * @group provider
- */
-type FrakIFrameClientProps = {
-    config: FrakWalletSdkConfig;
-};
-/**
- * IFrame client provider for the Frak Wallet SDK
- * It will automatically create the frak wallet iFrame (required for the wallet to communicate with the SDK securely), and provide it in the context
- *
- * @group provider
- *
- * @remarks
- * This provider must be wrapped within a {@link FrakConfigProvider} to work properly
- *
- * @param args
- * @param args.style - Some custom styles to apply to the iFrame
- * @param args.children - Descedant components that will have access to the Frak Client
- */
-declare function FrakIFrameClientProvider({ style, children, }: {
-    style?: CSSProperties;
-    children?: ReactNode;
-}): react.FunctionComponentElement<{
-    children?: ReactNode | undefined;
-}>;
-
-/**
- * Get the current Frak config
- * @throws {FrakRpcError} if the config is not found (only if this hooks is used outside a FrakConfigProvider)
- * @group hooks
- *
- * @see {@link @frak-labs/react-sdk!FrakConfigProvider | FrakConfigProvider} for the config provider
- * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig} for the config type
- */
-declare function useFrakConfig(): _frak_labs_core_sdk.FrakWalletSdkConfig;
-
-/**
- * Get the current Frak client
- *
- * @group hooks
- */
-declare function useFrakClient(): _frak_labs_core_sdk.FrakClient | undefined;
-
-/**
- * Hook that return a query helping to get the current wallet status.
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} action
- *
- * @group hooks
- *
- * @returns
- * The query hook wrapping the `watchWalletStatus()` action
- * The `data` result is a {@link @frak-labs/core-sdk!index.WalletStatusReturnType | `WalletStatusReturnType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery response
- */
-declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusReturnType, Error>;
-
-/** @ignore */
-type MutationOptions$4 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
-/** @inline */
-interface UseSendTransactionParams {
-    /**
-     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
-     */
-    mutations?: MutationOptions$4;
-}
-/**
- * Hook that return a mutation helping to send a transaction
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
- *
- * @param args
- *
- * @group hooks
- *
- * @returns
- * The mutation hook wrapping the `sendTransaction()` action
- * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SendTransactionParams | `SendTransactionParams`}
- * The `data` result is a {@link @frak-labs/core-sdk!index.SendTransactionReturnType | `SendTransactionReturnType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
- */
-declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): _tanstack_react_query.UseMutationResult<SendTransactionReturnType, FrakRpcError<undefined>, SendTransactionParams, unknown>;
-
-/** @inline */
-type MutationOptions$3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
-/** @ignore */
-interface UseSiweAuthenticateParams {
-    /**
-     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
-     */
-    mutations?: MutationOptions$3;
-}
-/**
- * Hook that return a mutation helping to send perform a SIWE authentication
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
- *
- * @param args
- *
- * @group hooks
- *
- * @returns
- * The mutation hook wrapping the `siweAuthenticate()` action
- * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SiweAuthenticateModalParams | `SiweAuthenticateModalParams`}
- * The `data` result is a {@link @frak-labs/core-sdk!index.SiweAuthenticateReturnType | `SiweAuthenticateReturnType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.siweAuthenticate | `siweAuthenticate()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
- */
-declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<SiweAuthenticateReturnType, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
-
-/**
- * Helper hook to automatically submit a referral interaction when detected
- *
- * @group hooks
- *
- * @param args
- * @param args.productId - The product id to interact with (if not specified will be recomputed from the current domain)
- * @param args.modalConfig - The modal configuration to display if the user is not logged in
- * @param args.options - Some options for the referral interaction
- *
- * @returns  The resulting referral state, or a potential error
- *
- * @description This function will automatically handle the referral interaction process
- *
- * @see {@link @frak-labs/core-sdk!actions.processReferral | `processReferral()`} for more details on the automatic referral handling process
- */
-declare function useReferralInteraction({ productId, modalConfig, options, }?: {
-    productId?: Hex;
-    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
-    options?: ProcessReferralOptions;
-}): Error | ("error" | "no-referrer" | "idle" | "processing" | "success" | "no-wallet" | "no-session" | "self-referral");
-
-/** @ignore */
-type MutationOptions$2 = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
-/** @inline */
-interface UseSendInteractionParams$1 {
-    /**
-     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
-     */
-    mutations?: MutationOptions$2;
-}
-/**
- * Hook that return a mutation helping to send a user interaction
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} action
- *
- * @param args
- *
- * @group hooks
- *
- * @returns
- * The mutation hook wrapping the `sendInteraction()` action
- * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.SendInteractionParamsType | `SendInteractionParamsType`}
- * The `data` result is a {@link @frak-labs/core-sdk!index.SendInteractionReturnType | `SendInteractionReturnType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
- */
-declare function useSendInteraction({ mutations, }?: UseSendInteractionParams$1): _tanstack_react_query.UseMutationResult<SendInteractionReturnType, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
-
-/** @ignore */
-type MutationOptions$1<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
-/** @inline */
-interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
-    /**
-     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
-     */
-    mutations?: MutationOptions$1<T>;
-}
-/**
- * Hook that return a mutation helping to display a modal to the user
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} action
- *
- * @param args
- *
- * @typeParam T
- * The modal steps types to display (the result will correspond to the steps types asked in params)
- * An array of {@link @frak-labs/core-sdk!index.ModalStepTypes | `ModalStepTypes`}
- * If not provided, it will default to a generic array of `ModalStepTypes`
- *
- * @group hooks
- *
- * @returns
- * The mutation hook wrapping the `displayModal()` action
- * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplayModalParamsType | `DisplayModalParamsType<T>`}, with type params `T` being the modal steps types to display
- * The `data` result is a {@link @frak-labs/core-sdk!index.ModalRpcStepsResultType | `ModalRpcStepsResultType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
- */
-declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): _tanstack_react_query.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
-
-/** @ignore */
-type MutationOptions = Omit<UseMutationOptions<void, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
-/** @inline */
-interface UseSendInteractionParams {
-    /**
-     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
-     */
-    mutations?: MutationOptions;
-}
-/**
- * Hook that return a mutation helping to open the SSO page
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} action
- *
- * @param args
- *
- * @group hooks
- *
- * @returns
- * The mutation hook wrapping the `openSso()` action
- * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.OpenSsoParamsType | `OpenSsoParamsType`}
- * The mutation doesn't output any value
- *
- * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
- */
-declare function useOpenSso({ mutations }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
-
-/** @ignore */
-type QueryOptions = Omit<UseQueryOptions<GetProductInformationReturnType, FrakRpcError, undefined>, "queryKey" | "queryFn">;
-/** @inline */
-interface UseGetProductInformationParams {
-    /**
-     * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
-     */
-    query?: QueryOptions;
-}
-/**
- * Hook that return a query helping to get the current product information
- *
- * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} action
- *
- * @param args
- *
- * @group hooks
- *
- * @returns
- * The query hook wrapping the `getProductInformation()` action
- * The `data` result is a {@link @frak-labs/core-sdk!index.GetProductInformationReturnType | `GetProductInformationReturnType`}
- *
- * @see {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} for more info about the underlying action
- * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
- */
-declare function useGetProductInformation({ query, }?: UseGetProductInformationParams): _tanstack_react_query.UseQueryResult<undefined, FrakRpcError<undefined>>;
-
-export { FrakConfigContext, FrakConfigProvider, type FrakConfigProviderProps, FrakIFrameClientContext, type FrakIFrameClientProps, FrakIFrameClientProvider, useDisplayModal, useFrakClient, useFrakConfig, useGetProductInformation, useOpenSso, useReferralInteraction, useSendInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };
+import { Context } from 'react';
+import { CSSProperties } from 'react';
+import { DisplayModalParamsType } from '@frak-labs/core-sdk';
+import { FrakClient } from '@frak-labs/core-sdk';
+import { FrakRpcError } from '@frak-labs/core-sdk';
+import { FrakWalletSdkConfig } from '@frak-labs/core-sdk';
+import { FunctionComponentElement } from 'react';
+import { GetProductInformationReturnType } from '@frak-labs/core-sdk';
+import { Hex } from 'viem';
+import { ModalRpcStepsResultType } from '@frak-labs/core-sdk';
+import { ModalStepTypes } from '@frak-labs/core-sdk';
+import { OpenSsoParamsType } from '@frak-labs/core-sdk';
+import { ProcessReferralOptions } from '@frak-labs/core-sdk/actions';
+import { PropsWithChildren } from 'react';
+import { ProviderProps } from 'react';
+import { ReactNode } from 'react';
+import { SendInteractionParamsType } from '@frak-labs/core-sdk';
+import { SendInteractionReturnType } from '@frak-labs/core-sdk';
+import { SendTransactionParams } from '@frak-labs/core-sdk/actions';
+import { SendTransactionReturnType } from '@frak-labs/core-sdk';
+import { SiweAuthenticateModalParams } from '@frak-labs/core-sdk/actions';
+import { SiweAuthenticateReturnType } from '@frak-labs/core-sdk';
+import { UseMutationOptions } from '@tanstack/react-query';
+import { UseMutationResult } from '@tanstack/react-query';
+import { UseQueryOptions } from '@tanstack/react-query';
+import { UseQueryResult } from '@tanstack/react-query';
+import { WalletStatusReturnType } from '@frak-labs/core-sdk';
+
+/**
+ * The context that will keep the Frak Wallet SDK configuration
+ * @ignore
+ */
+export declare const FrakConfigContext: Context<FrakWalletSdkConfig | undefined>;
+
+/**
+ * Simple config provider for the Frak Wallet SDK
+ *
+ * Should be wrapped within a {@link @tanstack/react-query!QueryClientProvider | `QueryClientProvider`}
+ *
+ * @group provider
+ *
+ * @param parameters
+ */
+export declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): FunctionComponentElement<ProviderProps<FrakWalletSdkConfig | undefined>>;
+
+/**
+ * Props to instantiate the Frak Wallet SDK configuration provider
+ *
+ * @group provider
+ */
+export declare type FrakConfigProviderProps = {
+    /**
+     * The wanted Frak configuration
+     * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig}
+     */
+    config: FrakWalletSdkConfig;
+};
+
+/**
+ * The context that will keep the Frak Wallet SDK client
+ * @ignore
+ */
+export declare const FrakIFrameClientContext: Context<FrakClient | undefined>;
+
+/**
+ * Props to instantiate the Frak Wallet SDK configuration provider
+ *
+ * @group provider
+ */
+export declare type FrakIFrameClientProps = {
+    config: FrakWalletSdkConfig;
+};
+
+/**
+ * IFrame client provider for the Frak Wallet SDK
+ * It will automatically create the frak wallet iFrame (required for the wallet to communicate with the SDK securely), and provide it in the context
+ *
+ * @group provider
+ *
+ * @remarks
+ * This provider must be wrapped within a {@link FrakConfigProvider} to work properly
+ *
+ * @param args
+ * @param args.style - Some custom styles to apply to the iFrame
+ * @param args.children - Descedant components that will have access to the Frak Client
+ */
+export declare function FrakIFrameClientProvider({ style, children, }: {
+    style?: CSSProperties;
+    children?: ReactNode;
+}): FunctionComponentElement<    {
+children?: ReactNode | undefined;
+}>;
+
+/** @ignore */
+declare type MutationOptions = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
+
+/** @ignore */
+declare type MutationOptions_2 = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+
+/** @inline */
+declare type MutationOptions_3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
+
+/** @ignore */
+declare type MutationOptions_4<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+
+/** @ignore */
+declare type MutationOptions_5 = Omit<UseMutationOptions<void, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
+
+/** @ignore */
+declare type QueryOptions = Omit<UseQueryOptions<GetProductInformationReturnType, FrakRpcError, undefined>, "queryKey" | "queryFn">;
+
+/**
+ * Hook that return a mutation helping to display a modal to the user
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} action
+ *
+ * @param args
+ *
+ * @typeParam T
+ * The modal steps types to display (the result will correspond to the steps types asked in params)
+ * An array of {@link @frak-labs/core-sdk!index.ModalStepTypes | `ModalStepTypes`}
+ * If not provided, it will default to a generic array of `ModalStepTypes`
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `displayModal()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplayModalParamsType | `DisplayModalParamsType<T>`}, with type params `T` being the modal steps types to display
+ * The `data` result is a {@link @frak-labs/core-sdk!index.ModalRpcStepsResultType | `ModalRpcStepsResultType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): UseMutationResult<    { [K in T[number]["key"]]: Extract<T[number], {
+key: K;
+}>["returns"]; }, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+
+/** @inline */
+declare interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions_4<T>;
+}
+
+/**
+ * Get the current Frak client
+ *
+ * @group hooks
+ */
+export declare function useFrakClient(): FrakClient | undefined;
+
+/**
+ * Get the current Frak config
+ * @throws {FrakRpcError} if the config is not found (only if this hooks is used outside a FrakConfigProvider)
+ * @group hooks
+ *
+ * @see {@link @frak-labs/react-sdk!FrakConfigProvider | FrakConfigProvider} for the config provider
+ * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig} for the config type
+ */
+export declare function useFrakConfig(): FrakWalletSdkConfig;
+
+/**
+ * Hook that return a query helping to get the current product information
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getProductInformation()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.GetProductInformationReturnType | `GetProductInformationReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+export declare function useGetProductInformation({ query, }?: UseGetProductInformationParams): UseQueryResult<undefined, FrakRpcError<undefined>>;
+
+/** @inline */
+declare interface UseGetProductInformationParams {
+    /**
+     * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+     */
+    query?: QueryOptions;
+}
+
+/**
+ * Hook that return a mutation helping to open the SSO page
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `openSso()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.OpenSsoParamsType | `OpenSsoParamsType`}
+ * The mutation doesn't output any value
+ *
+ * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useOpenSso({ mutations }?: UseSendInteractionParams_2): UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+
+/**
+ * Helper hook to automatically submit a referral interaction when detected
+ *
+ * @group hooks
+ *
+ * @param args
+ * @param args.productId - The product id to interact with (if not specified will be recomputed from the current domain)
+ * @param args.modalConfig - The modal configuration to display if the user is not logged in
+ * @param args.options - Some options for the referral interaction
+ *
+ * @returns  The resulting referral state, or a potential error
+ *
+ * @description This function will automatically handle the referral interaction process
+ *
+ * @see {@link @frak-labs/core-sdk!actions.processReferral | `processReferral()`} for more details on the automatic referral handling process
+ */
+export declare function useReferralInteraction({ productId, modalConfig, options, }?: {
+    productId?: Hex;
+    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
+    options?: ProcessReferralOptions;
+}): Error | ("error" | "no-referrer" | "idle" | "processing" | "success" | "no-wallet" | "no-session" | "self-referral");
+
+/**
+ * Hook that return a mutation helping to send a user interaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendInteraction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.SendInteractionParamsType | `SendInteractionParamsType`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendInteractionReturnType | `SendInteractionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendInteraction({ mutations, }?: UseSendInteractionParams): UseMutationResult<    {
+delegationId: string;
+}, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+
+/** @inline */
+declare interface UseSendInteractionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions_2;
+}
+
+/** @inline */
+declare interface UseSendInteractionParams_2 {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions_5;
+}
+
+/**
+ * Hook that return a mutation helping to send a transaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendTransaction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SendTransactionParams | `SendTransactionParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendTransactionReturnType | `SendTransactionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): UseMutationResult<    {
+hash: Hex;
+}, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+
+/** @inline */
+declare interface UseSendTransactionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+
+/**
+ * Hook that return a mutation helping to send perform a SIWE authentication
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `siweAuthenticate()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SiweAuthenticateModalParams | `SiweAuthenticateModalParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SiweAuthenticateReturnType | `SiweAuthenticateReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.siweAuthenticate | `siweAuthenticate()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): UseMutationResult<    {
+signature: Hex;
+message: string;
+}, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
+
+/** @ignore */
+declare interface UseSiweAuthenticateParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions_3;
+}
+
+/**
+ * Hook that return a query helping to get the current wallet status.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} action
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `watchWalletStatus()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.WalletStatusReturnType | `WalletStatusReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery response
+ */
+export declare function useWalletStatus(): UseQueryResult<WalletStatusReturnType, Error>;
+
+export { }