Batch writeuseMutationencrypts input Curated

useBatchCreateVesting

Batch variant of useCreateVesting — open N vestings in one tx with one batch input proof.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Batch write

Description

Batch-create confidential vesting schedules. All amounts are encrypted together under one input proof, saving gas vs. N separate useCreateVesting calls.

Respect useManagerMaxBatchSize before submitting large lists.

After success, invalidate ["tokenops-sdk", "fhe-vesting"] (broad) or the narrower recipient/vesting query keys.

Signature

@tokenops/sdk/fhe-vesting/react

function useBatchCreateVesting(options: ManagerHookOptions): UseMutationResult<Hex, Error, BatchCreateVestingArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type BatchCreateVestingArgs. 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 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 useBatchCreateVesting; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const batch = useBatchCreateVesting({ address: managerAddress, encryptor: () => useZamaSDK() });
batch.mutate({
  items: [
    { params: paramsA, amount: 100_000n },
    { params: paramsB, amount: 200_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 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 batchCreateVesting = useBatchCreateVesting(/* options */);

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