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.
WriteuseMutation

useClearUpgradeabilityPolicy

Drop a creator's useSetUpgradeabilityPolicy override, reverting them to the factory default.

Import
@tokenops/sdk/fhe-airdrop/advanced/react
Return
{ mutate, mutateAsync, isPending, error, data }
Lifecycle
Write

Description

Drop a creator's useSetUpgradeabilityPolicy override, reverting them to the factory default. Requires UPGRADE_MANAGER_ROLE.

Invalidates: fn "effectiveUpgradeable" and fn "upgradeabilityPolicy", both keyed on args.creator, plus the fn "preflightCreate" PREFIX. Reverting to the default flips effectiveUpgradeable exactly as setting an override does, and preflightCreate reads it to decide whether a mode: "uups" create is refused - so omitting the prefix here would leave a create form showing a stale allow/deny.

Signature

@tokenops/sdk/fhe-airdrop/advanced/react
ts
function useClearUpgradeabilityPolicy(options?: AirdropClientOptions): UseMutationResult<Hex, Error, ClearUpgradeabilityPolicyArgs>;

Parameters

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

Example

@tokenops/sdk/fhe-airdrop/advanced/react · @example
tsx
const clearPolicy = useClearUpgradeabilityPolicy();
await clearPolicy.mutateAsync({ creator });

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 clearUpgradeabilityPolicy = useClearUpgradeabilityPolicy(/* options */);

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

See also

Other Write hooks in airdrop v2: