WriteuseMutationencrypts input Curated

usePartialClaim

Claim less than the unlocked amount — leaves the remainder encrypted on the clone.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Partial-claim a specific encrypted amount from a vesting. The SDK encrypts the plaintext amount (or use args.encryptedInput to bypass).

After success, invalidate useGetClaimableAmount and useGetSettledAmount.

Signature

@tokenops/sdk/fhe-vesting/react

function usePartialClaim(options: ManagerHookOptions): UseMutationResult<Hex, Error, PartialClaimArgs>;

Parameters

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

Example

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

tsx

const partial = usePartialClaim({ address: managerAddress, encryptor: () => useZamaSDK() });
partial.mutate({ vestingId, amount: 50_000n, 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 partialClaim = usePartialClaim(/* options */);

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