2.0 RC docsView 1.x docs
v2.0.0-rc.1 release candidate
The API is frozen and later candidates carry fixes only, except the receipt-free and Safe create surface of /fhe-airdrop, which is @beta. Published on the next dist-tag; latest stays on 1.6.0 until 2.0.0.
ReaduseQuery

useAirdropRoleMembers

List who holds role on an airdrop instance, with the member count.

Import
@tokenops/sdk/fhe-airdrop/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Read

Description

List who holds role on an airdrop instance, with the member count.

This is the supported way to discover a campaign's fee collectors: the contract deliberately ships no feeCollectors() view and points callers at getRoleMembers(FEE_COLLECTOR_ROLE) instead.

count is bundled rather than split into its own hook because it is the variable the contract's revoke floors are written against - a revoke of DEFAULT_ADMIN_ROLE at count 1 reverts LastAdmin, and of FEE_COLLECTOR_ROLE at count 1 on a fee-charging campaign reverts LastFeeCollector - so a UI showing the list wants to know in the same render whether a revoke is possible at all.

Unpaginated: role sets here are operator-sized, not user-sized.

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useAirdropRoleMembers(args: UseAirdropRoleMembersArgs): UseQueryResult<AirdropRoleMembership, Error>;

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
roleHexThe role whose members to list - from {
Want to run a similar shape interactively? The Playground ships 12 ready presets across vesting / airdrop / disperse / faucet — deploy a manager, create a vesting, claim, and run the product equivalents. The deep-link above auto-selects the closest preset to useAirdropRoleMembers; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const { data } = useAirdropRoleMembers({ address, role: roles?.FEE_COLLECTOR_ROLE });
const canRevoke = (data?.count ?? 0n) > 1n;

Pulled directly from the hook's TSDoc block — the same snippet your IDE shows on hover.

See also

Other Read hooks in airdrop v2: