# 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)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.justaname.id/sdk-reference/justaname-react-sdk/functions/useensauth.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.