useGuestAuth

type Request = {
  hook: 'useGuestAuth',
  params: [options?: GuestHookOptions]
}
 
type GuestHookOptions = {
  onSuccess?: (data: GuestHookResult) => void
  onError?: (error: OpenfortError) => void
  onSettled?: (data: GuestHookResult | undefined | null, error: OpenfortError | null) => void
  throwOnError?: boolean
  logoutOnError?: boolean
  recoverWalletAutomatically?: boolean
}
 
type OpenfortError = {
  message: string
  type: OpenfortErrorType
  data: { [key: string]: any }
  name: string
}
 
enum OpenfortErrorType {
  AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
  WALLET_ERROR = "WALLET_ERROR",
  CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
  VALIDATION_ERROR = "VALIDATION_ERROR",
}

type Response = GuestAuthReturn
 
type GuestAuthReturn = GuestStatusFlags & {
  signUpGuest(options?: GuestHookOptions): Promise<GuestHookResult>
}
 
type GuestStatusFlags = {
  isLoading: boolean
  isError: boolean
  isSuccess: boolean
  error?: OpenfortError | null
}
 
type GuestHookResult = {
  error?: OpenfortError
  user?: AuthPlayerResponse
  wallet?: UserWallet
}
 
type UserWallet = {
  address: `0x${string}`
  connectorType?: string
  walletClientType?: string
  id: string
  isAvailable: boolean
  isActive?: boolean
  isConnecting?: boolean
  recoveryMethod?: RecoveryMethod
  accountId?: string
  accountType?: AccountTypeEnum
  ownerAddress?: `0x${string}`
  implementationType?: string
  createdAt?: number
  salt?: string
}
 
type AuthPlayerResponse = {
  player?: {
    id: string
    object: 'player'
    name: string
    description?: string
    createdAt: number
    metadata?: { [key: string]: any }
    transactionIntents?: any[]
    accounts?: any[]
  }
  id: string
  object: 'player'
  createdAt: number
  linkedAccounts: LinkedAccount[]
}
 
type LinkedAccount = {
  provider: string
  email?: string
  address?: string
  externalUserId?: string
  verified?: boolean
  disabled: boolean
  walletClientType?: string
  connectorType?: string
  updatedAt?: number
  metadata?: { [key: string]: any }
}
 
enum RecoveryMethod {
  AUTOMATIC = "automatic",
  PASSWORD = "password",
  PASSKEY = "passkey",
}
 
enum AccountTypeEnum {
  SMART_ACCOUNT = "Smart Account",
  EOA = "Externally Owned Account",
}

import { useGuestAuth } from "@openfort/react"
 
function GuestEntry() {
  const { signUpGuest, isLoading, isError, isSuccess, error } = useGuestAuth({
    throwOnError: true,
    onSuccess: () => {},
    onError: () => {},
    onSettled: () => {},
  })
 
  const handleClick = async () => {
    const { user } = await signUpGuest()
    if (user) {
      console.log("Guest created", user.player.publicId)
    }
  }
 
  return <button onClick={handleClick} disabled={isLoading}>Continue as guest</button>
}