Roles · RBACuseMutation

useAirdropGrantRole

AccessControl: grant role to accountTarget on this airdrop clone.

Import
@tokenops/sdk/fhe-airdrop/react
Return
{ mutate, mutateAsync, isPending, error, data }
Lifecycle
Roles · RBAC

Description

AccessControl: grant role to accountTarget on this airdrop clone. Caller must be a member of the role's admin role (typically DEFAULT_ADMIN_ROLE).

After success, invalidate useAirdropHasRole({ role, account: accountTarget }).

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useAirdropGrantRole(options: AirdropHookOptions): UseMutationResult<Hex, Error, UseAirdropGrantRoleArgs>;

Parameters

Shape of the object you pass to .mutate(args).

PropertyTypeDescription
rolerequiredHex
accountTargetrequiredAddress
accountAccount | Address
Want to run a similar shape interactively? The Playground ships 8 ready presets across vesting / airdrop / disperse — deploy a manager, create a vesting, claim, and the airdrop / disperse equivalents. The deep-link above auto-selects the closest preset to useAirdropGrantRole; pick another from the dropdown if you'd rather start there.

Example

components/useAirdropGrantRoleExample.tsx
tsx
"use client";
import { useAirdropGrantRole } from "@tokenops/sdk/fhe-airdrop/react";

export function Example() {
  const { mutate, isPending } = useAirdropGrantRole();

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "AirdropGrantRole"}
    </button>
  );
}

Auto-generated from the hook's shape (the SDK doesn't carry a TSDoc @example here yet).

Errors

This mutation can reject with SDK-level, product-level, or viem-passthrough errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop › Errors for the per-class recovery table.

Invalidation recipe

After this mutation succeeds, invalidate the queries it affects so consumer UI re-fetches fresh state. The SDK never auto-invalidates — that's a consumer decision (different apps cache different shapes).

patterns/invalidation.ts
ts
import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const airdropGrantRole = useAirdropGrantRole(/* options */);

airdropGrantRole.mutate(args, {
  onSuccess() {
    // Coarse invalidation: refresh every cached read on this product surface.
    queryClient.invalidateQueries({
      queryKey: ["tokenops-sdk", "fhe-airdrop"],
    });
  },
});

See also

Other Roles · RBAC hooks in airdrop: