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

useComplianceRenounceRole

Give up a role on a compliance-manager clone yourself.

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Roles · RBAC

Description

Give up a role on a compliance-manager clone yourself. options.address is the CLONE.

Self-only by construction: the contract's renounceRole(role, callerConfirmation) reverts AccessControlBadConfirmation unless the confirmation is the sender, so there is no holder to pass - the headless client fills it from the resolved sending account. To remove somebody else's role use useComplianceRevokeRole.

No last-admin floor guards this: the sole DEFAULT_ADMIN_ROLE holder CAN renounce, and doing so freezes the clone's delegate set permanently.

Invalidates: every useComplianceHasRole entry for this clone (prefix, all role/holder pairs), plus its useComplianceRoleMembers entry for role. The prefix is deliberate - the holder here is whichever account the wallet client resolves at submit time, which need not match any (role, holder) pair a component happens to have cached, and a narrower key would invalidate nothing while throwing nothing. Still scoped to this clone.

Signature

@tokenops/sdk/fhe-airdrop/react

function useComplianceRenounceRole(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, ComplianceRenounceRoleArgs>;

Parameters

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

Example

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

tsx

const renounce = useComplianceRenounceRole({ address: managerAddress });
await renounce.mutateAsync({ role: roles.DELEGATION_ADMIN_ROLE });

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 complianceRenounceRole = useComplianceRenounceRole(/* options */);

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