useEnsAuth

A React hook for checking ENS-based authentication status and getting connected ENS information.

---

Usage

import { useEnsAuth } from '@justaname.id/react'

function EnsAuthComponent() {
  const { 
    isLoggedIn, 
    connectedEns, 
    isEnsAuthPending, 
    isEnsAuthFetching,
    isEnsAuthLoading,
    refreshEnsAuth 
  } = useEnsAuth({
    backendUrl: 'https://api.justaname.id',
    currentEnsRoute: '/auth/current-ens',
    enabled: true,
    local: false
  })
  
  if (isEnsAuthLoading) return <div>Checking authentication...</div>
  
  return (
    <div>
      {isLoggedIn && connectedEns ? (
        <div>
          <p>Welcome, {connectedEns.ens}!</p>
          <p>Address: {connectedEns.address}</p>
          <p>Chain ID: {connectedEns.chainId}</p>
          <button onClick={refreshEnsAuth}>Refresh Auth</button>
        </div>
      ) : (
        <div>
          <p>Not authenticated</p>
          <button onClick={refreshEnsAuth}>Check Auth Status</button>
        </div>
      )}
    </div>
  )
}

---

Returns

UseEnsAuthReturn<T> - An object containing:

• isLoggedIn: Boolean indicating if user is authenticated

• connectedEns: ENS authentication data object or null/undefined

• isEnsAuthPending: Boolean indicating if the auth check is pending

• isEnsAuthFetching: Boolean indicating if the auth check is fetching

• isEnsAuthLoading: Boolean indicating if the auth check is loading

• refreshEnsAuth: Function to manually refresh the authentication status

Parameters

• params?: UseEnsAuthParams - Optional parameters including backendUrl, currentEnsRoute, enabled, local

Type Parameters

• T extends object = object - Custom user type extending object

Defined in

packages/@justaname.id/react/src/lib/hooks/signIn/useEnsAuth.ts:33