Skip to content

useSiweAuthenticate

useSiweAuthenticate(args?): UseMutationResult<{ message: string; signature: `0x${string}`; }, FrakRpcError<undefined>, { metadata?: ModalRpcMetadata; siwe?: Partial<SiweAuthenticationParams>; }, unknown>

Defined in: react/src/hook/useSiweAuthenticate.ts:45

Hook that return a mutation helping to send perform a SIWE authentication

It’s a @tanstack/react-query!home | `tanstack` wrapper around the `siweAuthenticate()` action

Parameters

Section titled “Parameters”

args?

Section titled “args?”

UseSiweAuthenticateParams = {}

Optional config object with mutations for customizing the underlying @tanstack/react-query!useMutation | `useMutation()`

Returns

Section titled “Returns”

UseMutationResult<{ message: string; signature: `0x${string}`; }, FrakRpcError<undefined>, { metadata?: ModalRpcMetadata; siwe?: Partial<SiweAuthenticationParams>; }, unknown>

The mutation hook wrapping the siweAuthenticate() action The mutate and mutateAsync argument is of type `SiweAuthenticateModalParams` The data result is a `SiweAuthenticateReturnType`

See

Section titled “See”
  • `siweAuthenticate()` for more info about the underlying action
  • @tanstack/react-query!useMutation | `useMutation()` for more info about the mutation options and response