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.

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

Amount units: TokenOps confidential (ERC-7984) tokens use a 6-decimals convention (1 token = 1_000_000 base units), not the 18 decimals typical of ERC-20. Amount parameters are base units of the token's actual decimals: for the CTTT test token (6 decimals) 1_000_000n = 1 CTTT, while the transparent TTT test token uses 18 decimals.

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

Silent-zero transfers. ERC-7984 transfers do not revert when the sender's encrypted balance is insufficient — the transfer succeeds and moves an encrypted zero instead. This is by design: reverting would leak balance information. The transaction receipt alone cannot tell you whether value actually moved.

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

Example

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

tsx

function Component() {
  const zamaSDK = useZamaSDK();
  const partial = usePartialClaim({ address: managerAddress, encryptor: () => zamaSDK.relayer });
  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 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 partialClaim = usePartialClaim(/* options */);

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