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 Curated

useRevokeVesting

Admin revocation — clears the schedule (revocable variants only) and returns funds.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Revoke a vesting. Requires REVOKER_ROLE; the schedule must be revocable and not yet ended. The recipient keeps what vested up to now; the unvested remainder stays in the manager, released from reserves, and is withdrawn with withdrawAdmin (WITHDRAWER_ROLE).

After success, invalidate useVestingInfo({ vestingId }), and re-run useAccessClaimableAmount / useAccessSettledAmount for that vestingId (they are mutations that submit a transaction, so there is nothing to invalidate) to get fresh handles.

Signature

@tokenops/sdk/fhe-vesting/react

function useRevokeVesting(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseRevokeVestingArgs>;

Parameters

Shape of the object you pass to .mutate(args).

Property	Type	Description
vestingIdrequired	Hex
account	Account \| Address

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 useRevokeVesting; pick another from the dropdown if you'd rather start there.

Example

components/useRevokeVestingExample.tsx

tsx

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

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

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "RevokeVesting"}
    </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 generic-fallback errors. Product classes carry the offending value as fields — render them inline instead of a generic "transaction failed." See Vesting 2.0 › 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 revokeVesting = useRevokeVesting(/* options */);

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