WriteuseMutationencrypts input Curated

useSplitVesting

Split one vesting into two with custom proportions; both stay encrypted.

Import

@tokenops/sdk/fhe-vesting/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Write

Description

Split a vesting into two positions by encrypted numerator/denominator share.

The SDK auto-scales the plaintext ratio via scaleRatio to the universal privacy-preserving constant FHE_SPLIT_DENOMINATOR (90_090_000 = LCM(1..16, 10_000)) unless args.preScaled is set. The SDK encrypts numerator — pass plaintext.

For exact-integer ratios use the share builder: share.fraction(1, 7) (m ≤ 16) or share.basisPoints(250) (bps ≤ 10_000), then pass preScaled: true.

Returns { hash, newVestingId } — the id of the split-off vesting, parsed from the receipt's VestingSplit event. Required for any follow-up call (claim, transfer, disclose) on the new position.

Signature

@tokenops/sdk/fhe-vesting/react

function useSplitVesting(options: ManagerHookOptions): UseMutationResult<SplitVestingResult, Error, SplitVestingArgs>;

Parameters

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

Example

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

tsx

const split = useSplitVesting({ address: managerAddress, encryptor: () => useZamaSDK() });
const { newVestingId } = await split.mutateAsync({
  vestingId,
  numerator: 1n, denominator: 2n,   // 50% split, SDK scales automatically
  newRecipient: "0xNewRecipient",
});

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 splitVesting = useSplitVesting(/* options */);

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