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

useFactoryRenounceRole

Give up a factory role yourself.

Import

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

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Roles · RBAC

Description

Give up a factory role yourself.

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 a role from somebody else use useFactoryRevokeRole.

A sole `DEFAULT_ADMIN_ROLE` holder cannot renounce: the factory carries the same LastAdmin floor the instances do, so the call reverts instead of freezing role administration permanently. Grant the successor first, then renounce.

Invalidates: every useFactoryHasRole entry for this factory (prefix, all role/holder pairs), plus its useFactoryRoleMembers 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.

Signature

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

function useFactoryRenounceRole(options?: AirdropClientOptions): UseMutationResult<Hex, Error, FactoryRenounceRoleArgs>;

Parameters

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

Example

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

tsx

const renounce = useFactoryRenounceRole();
await renounce.mutateAsync({ role: roles.UPGRADE_MANAGER_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 factoryRenounceRole = useFactoryRenounceRole(/* options */);

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