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

useAirdropRoleAdmin

Which role's holders may grant and revoke role on an airdrop instance.

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

Description

Which role's holders may grant and revoke role on an airdrop instance.

DEFAULT_ADMIN_ROLE for everything the instance wires up at initialize, with one exception the instance is alone in this module in having: FEE_COLLECTOR_ROLE is re-parented to itself, so only a current fee collector can add or remove another. This read is how a UI confirms that before it lets an admin key attempt a fee-collector grant that planInstanceRoleSplit already refuses to plan.

Stays idle until role is defined, so a component can call it while a form is still filling in. Set once at initialize, hence staleTime: Infinity by default (overridable through query).

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useAirdropRoleAdmin(args: UseAirdropRoleAdminArgs): UseQueryResult<Hex, Error>;

Parameters

Shape of the options object passed to the hook itself.

PropertyTypeDescription
roleHexThe role whose administrator to read - 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 useAirdropRoleAdmin; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const { data: admin } = useAirdropRoleAdmin({ address, role: roles?.FEE_COLLECTOR_ROLE });

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

See also

Other Read hooks in airdrop v2: