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

useCreateVesting

Open a new vesting schedule on a manager — encrypts the amount client-side, submits the tx.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Create a single confidential vesting schedule. The SDK encrypts the plaintext amount into an externalEuint64 and submits it with an input proof — callers never handle ciphertext.

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.

Encryptor resolution. The hook-level encryptor (from ManagerHookOptions) is forwarded lazily to the SDK client. You can also pass encryptor per-mutation via args.encryptor to override it. If neither is present, the SDK throws MissingEncryptorError (code: "TOKENOPS_MISSING_ENCRYPTOR").

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.

After a successful create, invalidate read queries that depend on recipient/vesting state:

const queryClient = useQueryClient();
const create = useCreateVesting({ address: managerAddress });
create.mutate(args, {
  onSuccess: () => {
    queryClient.invalidateQueries({ queryKey: ["tokenops-sdk", "fhe-vesting"] });
  },
});

Signature

@tokenops/sdk/fhe-vesting/react

function useCreateVesting(options: ManagerHookOptions): UseMutationResult<Hex, Error, CreateVestingArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type CreateVestingArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).

Run it

Connect your wallet and click Open a 2.0 vesting — this dispatches a real Sepolia transaction through the same runner the stories use.

Interactive · live Sepolia tx

Manager clone addressDeploy one first via useCreateManager.RecipientAmount (bigint)Encrypted to euint64 client-side before submit.

Loading editor…

Edit any input above, then press ⌘↵ to run.

Console0 lines

No output yet. Run the snippet to see logs stream in.

Example

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

tsx

function Component() {
  const zamaSDK = useZamaSDK();
  const create = useCreateVesting({ address: managerAddress, encryptor: () => zamaSDK.relayer });
  create.mutate({
    params: { recipient, startTimestamp, endTimestamp, cliffSeconds: 0,
              releaseIntervalSecs: 86400, timelockSeconds: 0,
              initialUnlockBps: 0, cliffAmountBps: 0, isRevocable: false },
    amount: 1_000_000n,
  });
}

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 createVesting = useCreateVesting(/* options */);

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