2.0 RC docsView 1.x docs
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.
ReaduseQuery Curated

useVestingInfo

Plaintext schedule shape (start / end / cliff / interval) + encrypted-handle metadata.

Import
@tokenops/sdk/fhe-vesting/react
Return
{ data, isLoading, error, refetch }
Lifecycle
Read

Description

Read the plaintext snapshot of a vesting schedule — recipient, timestamps, unlock bps, revocability flag. Amounts are encrypted and NOT in this payload — use useAccessTotalAllocation / useAccessVestedAmount for encrypted-amount handles.

Signature

@tokenops/sdk/fhe-vesting/react
ts
function useVestingInfo(args: UseVestingInfoArgs): UseQueryResult<VestingInfo, Error>;

Parameters

Shape of the options object passed to the hook itself.

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

Example

components/useVestingInfoExample.tsx
tsx
"use client";
import { useVestingInfo } from "@tokenops/sdk/fhe-vesting/react";

export function Example() {
  const { data, isLoading } = useVestingInfo(/* args */);

  if (isLoading) return "loading…";
  return <pre>{JSON.stringify(data, null, 2)}</pre>;
}

Auto-generated from the hook's shape (the SDK doesn't carry a TSDoc @example here yet).

See also

Other Read hooks in vesting 2.0: