> For the complete documentation index, see [llms.txt](https://docs.justaname.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.justaname.id/sdk-reference/justaname-react-sdk/functions/useensauth.md).

# useEnsAuth

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

***

## Usage

```typescript
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`](/sdk-reference/justaname-react-sdk/interfaces/useensauthreturn.md)<`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`](/sdk-reference/justaname-react-sdk/interfaces/useensauthparams.md) - 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](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/react/src/lib/hooks/signIn/useEnsAuth.ts#L33)