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.

WriteuseMutation

useGrantInstanceRoles

Split an airdrop instance's roles after create — one grantRole / revokeRole transaction per requested assignment, submitted in the order planInstanceRoleSplit computes.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Split an airdrop instance's roles after create — one grantRole / revokeRole transaction per requested assignment, submitted in the order planInstanceRoleSplit computes.

Returns `RoleGrantOutcome[]` unchanged — do not collapse it. Each step is its own transaction and can independently fail; flattening the array into a single success/failure bit destroys exactly the partial-failure legibility grantInstanceRoles was designed to preserve (see roles.ts). Inspect outcomes.filter(o => o.error) for what didn't land.

Invalidates: every useAirdropHasRole entry for this instance (regardless of which role/holder pair), since a role split can touch several roles across several accounts in one call and the SDK does not duplicate the on-chain role-constant lookup client-side to invalidate more narrowly. It also invalidates every useAirdropRoleMembers entry for this instance. Scoped to this instance only - other campaigns' role caches are untouched.

Signature

@tokenops/sdk/fhe-airdrop/react

function useGrantInstanceRoles(options: AirdropInstanceClientOptions): UseMutationResult<RoleGrantOutcome[], Error, GrantInstanceRolesArgs>;

Parameters

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

Example

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

tsx

const grant = useGrantInstanceRoles({ address: airdropAddress });
const outcomes = await grant.mutateAsync({ assignment: { pauser, treasury } });
const failed = outcomes.filter((o) => o.error);

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 grantInstanceRoles = useGrantInstanceRoles(/* options */);

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