WriteuseMutation Curated

useClaim

Recipient-side claim. For FeeType.Gas managers pass value (read it with useManagerFeeInfo); omit value for FeeType.DistributionToken.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Claim the currently-claimable amount on a vesting schedule.

For `FeeType.Gas` managers, pass args.value = fee — use useManagerFeeInfo to read it. For FeeType.DistributionToken, omit value.

After success, invalidate useGetClaimableAmount (the encrypted view) and any UI counts you computed off it.

Signature

@tokenops/sdk/fhe-vesting/react

function useClaim(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).

Run it

Connect your wallet and click Claim — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

Manager clone addressvestingId (32-byte hex)

Loading editor…

Edit any input above, then press ⌘↵ to run.

Console0 lines

No output yet. Run the snippet to see logs stream in.

Example

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

tsx

const claim = useClaim({ address: managerAddress });
claim.mutate({ vestingId, value: gasFee });

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 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 claim = useClaim(/* options */);

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