Encrypted readuseMutationencrypted handle

useAccessVestedAmount

Submits a transaction to read the vested amount at a given timestamp as an euint128 handle.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Submits a transaction to read the vested amount at a given timestamp as an euint128 handle. The contract performs FHE.allow(handle, msg.sender) so persistent ACL is granted to the caller; the SDK parses the handle from the receipt's ACL.Allowed event (NOT from simulation — that returns a different, ACL-less handle).

Pass data.handle to the Zama relayer's userDecrypt to get the plaintext.

Signature

@tokenops/sdk/fhe-vesting/react

function useAccessVestedAmount(options: ManagerHookOptions): UseMutationResult<EncryptedViewResult, Error, UseAccessVestedAmountArgs>;

Parameters

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

Property	Type	Description
vestingIdrequired	Hex
timestamprequired	number	Unix timestamp (seconds) — `Math.floor(Date.now() / 1000)` for "now".
account	Account \| Address

Want to run a similar shape interactively? The Playground ships 8 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 useAccessVestedAmount; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const getVested = useAccessVestedAmount({ address: managerAddress });
getVested.mutate({ vestingId, timestamp: Math.floor(Date.now() / 1000) });
// getVested.data → { handle: "0x...", hash: "0x..." }

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 › 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 accessVestedAmount = useAccessVestedAmount(/* options */);

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