Encrypted readuseMutationencrypted handle Curated

useGetClaimableAmount

Encrypted-view read: min(vested, balance) - settled. Pair with useDecryptedHandle.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Submits a transaction to read the currently-claimable amount as an euint128 handle. Pass data.handle to the Zama relayer's userDecrypt.

Signature

@tokenops/sdk/fhe-vesting/react

function useGetClaimableAmount(options: ManagerHookOptions): UseMutationResult<EncryptedViewResult, Error, UseGetClaimableAmountArgs>;

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

Example

components/useGetClaimableAmountExample.tsx

tsx

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

export function Example() {
  const read = useGetClaimableAmount(/* args */);

  // Encrypted view: read.mutate() submits a tx that calls FHE.allow,
  // so the connected wallet gains ACL on the returned handle.
  // Pair read.data.handle with useDecryptedHandle (from @tokenops/sdk/fhe/react)
  // to user-decrypt via the Zama relayer.
}

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 getClaimableAmount = useGetClaimableAmount(/* options */);

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