Skip to content

useGuestAuth

Create guest accounts for instant onboarding without requiring authentication.

Usage

import { useGuestAuth } from '@openfort/react';
 
function GuestEntry() {
  const { signUpGuest, isLoading } = useGuestAuth();
 
  const handleClick = async () => {
    const { user } = await signUpGuest();
    if (user) console.log('Guest created:', user.id);
  };
 
  return <button onClick={handleClick} disabled={isLoading}>Continue as guest</button>;
}

Return type

type GuestAuthReturn = {
  signUpGuest(options?: GuestOptions): Promise<GuestResult>
  isLoading: boolean
  isError: boolean
  isSuccess: boolean
  error?: OpenfortError | null
}
 
type GuestOptions = {
  onSuccess?: (data: GuestResult) => void
  onError?: (error: OpenfortError) => void
}
 
type GuestResult = {
  user?: AuthPlayerResponse
  wallet?: UserWallet
  error?: OpenfortError
}