useAccountInvitations
A React hook for fetching subname invitations issued to a connected account. Domain holders can issue subnames to user addresses, and users can fetch and accept these invitations.
Usage
import { useAccountInvitations } from '@justaname.id/react'
function AccountInvitationsComponent() {
const {
invitations,
isInvitationsPending,
refetchInvitations
} = useAccountInvitations({
coinType: 60,
chainId: 1,
isClaimed: false
})
if (isInvitationsPending) return <div>Loading invitations...</div>
return (
<div>
<h3>Your Subname Invitations</h3>
{invitations?.map((invitation, index) => (
<div key={index}>
<strong>{invitation.ens}</strong>
<p>{invitation.sanitizedRecords?.description}</p>
<p>Claimed: {invitation.isClaimed ? 'Yes' : 'No'}</p>
<p>JAN: {invitation.isJAN ? 'Yes' : 'No'}</p>
</div>
))}
<button onClick={refetchInvitations}>Refresh</button>
</div>
)
}
Returns
UseAccountInvitationsResult
- An object containing:
invitations
: Array ofRecords
objects containing subname invitation data withsanitizedRecords
propertyisInvitationsPending
: Boolean indicating if the data is being fetchedrefetchInvitations
: Function to manually refetch the data
Parameters
params?:
UseAccountInvitationsParams
- Optional parameters for the hook:coinType
:number
- Coin type for the invitation (default: 60 for ETH)chainId
:ChainId
- Chain ID for the invitationisClaimed
:boolean
- Filter by claimed statusenabled
:boolean
- Enable/disable the query
Defined in
packages/@justaname.id/react/src/lib/hooks/account/useAccountInvitations.ts:31
Last updated
Was this helpful?