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

useGrantRole

AccessControl: grant role to holder on the singleton.

Import

@tokenops/sdk/fhe-disperse/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Roles · RBAC

Description

AccessControl: grant role to holder on the singleton. Caller must hold the role's admin role (typically DEFAULT_ADMIN_ROLE, i.e. the all-zero hash). Role hashes are exported as DEFAULT_ADMIN_ROLE, FEE_MANAGER_ROLE, FEE_COLLECTOR_ROLE, PAUSER_ROLE and WITHDRAWER_ROLE from this subpath.

After success, invalidate useHasRole({ role, holder }).

Signature

@tokenops/sdk/fhe-disperse/react

function useGrantRole(options?: DisperseHookOptions): UseMutationResult<Hex, Error, UseGrantRoleArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type UseGrantRoleArgs. 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 useGrantRole; pick another from the dropdown if you'd rather start there.

Example

@tokenops/sdk/fhe-disperse/react · @example

tsx

import { FEE_MANAGER_ROLE } from "@tokenops/sdk/fhe-disperse/react";
const grant = useGrantRole();
grant.mutate({ role: 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 Disperse 2.0 › 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 grantRole = useGrantRole(/* options */);

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