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.
Roles · RBACuseMutation

useComplianceRevokeRole

Revoke one role from one holder on a compliance-manager clone.

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

Description

Revoke one role from one holder on a compliance-manager clone. options.address is the CLONE. Requires the role's admin role.

Revoking a delegation admin revokes no delegation. The FHEVM ACL is append-only, so every delegate that account already added keeps decrypting until useRevokeComplianceDelegate is called for it explicitly. This is the most likely wrong assumption about this button: it removes the power to add more delegates, nothing else.

The contract enforces no last-admin floor either - revoking the sole DEFAULT_ADMIN_ROLE holder freezes the clone's delegate set permanently. Check useComplianceRoleMembers's count first.

Invalidates: this clone's useComplianceHasRole entry for exactly (role, holder) and its useComplianceRoleMembers entry for role. Scoped to this clone.

Signature

@tokenops/sdk/fhe-airdrop/react
ts
function useComplianceRevokeRole(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, ComplianceRevokeRoleArgs>;

Parameters

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

Example

@tokenops/sdk/fhe-airdrop/react · @example
tsx
const revoke = useComplianceRevokeRole({ address: managerAddress });
await revoke.mutateAsync({ role: roles.DELEGATION_ADMIN_ROLE, holder: formerTeam });

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
ts
import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const complianceRevokeRole = useComplianceRevokeRole(/* options */);

complianceRevokeRole.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 v2: