AdminuseMutation

useAdminClaim

Admin variant of useClaim — caller must hold CLAIMER_ROLE.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Admin

Description

Admin variant of useClaim — caller must hold CLAIMER_ROLE. Useful for sweep / forced-claim flows initiated by a treasury.

Signature

@tokenops/sdk/fhe-vesting/react

function useAdminClaim(options: ManagerHookOptions): UseMutationResult<Hex, Error, ClaimArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type ClaimArgs. 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 8 ready presets across vesting / airdrop / disperse — deploy a manager, create a vesting, claim, and the airdrop / disperse equivalents. The deep-link above auto-selects the closest preset to useAdminClaim; pick another from the dropdown if you'd rather start there.

Example

components/useAdminClaimExample.tsx

tsx

"use client";
import { useAdminClaim } from "@tokenops/sdk/fhe-vesting/react";

export function Example() {
  const { mutate, isPending } = useAdminClaim();

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "AdminClaim"}
    </button>
  );
}

Auto-generated from the hook's shape (the SDK doesn't carry a TSDoc @example here yet).

Errors

This mutation can reject with SDK-level, product-level, or viem-passthrough errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Vesting › 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 adminClaim = useAdminClaim(/* options */);

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