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.

Roles · RBACuseMutation

useFactoryGrantRole

Grant one factory role.

Import

@tokenops/sdk/fhe-airdrop/advanced/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Roles · RBAC

Description

Grant one factory role.

Requires DEFAULT_ADMIN_ROLE: the factory administers all five of its roles through the root role and never calls _setRoleAdmin, so unlike an airdrop instance there is no self-administered role here - one admin key can grant every one of them.

Invalidates: this factory's useFactoryHasRole entry for exactly (role, holder) and its useFactoryRoleMembers entry for role (the list and the count both move). Keyed off variables.holder, never the sending account - the submitter is an admin whose own membership does not change here.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react

function useFactoryGrantRole(options?: AirdropClientOptions): UseMutationResult<Hex, Error, FactoryGrantRoleArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type FactoryGrantRoleArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).

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 useFactoryGrantRole; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-airdrop/advanced/react · @example

tsx

const grant = useFactoryGrantRole();
await grant.mutateAsync({ role: roles.FEE_MANAGER_ROLE, holder: opsAddress });

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

Errors

This mutation can reject with SDK-level, product-level, or generic-fallback errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Airdrop v2 › 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

import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const factoryGrantRole = useFactoryGrantRole(/* options */);

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