WriteuseMutation Curated

useDirectVestingTransfer

Admin-driven transfer — moves a vesting without the recipient's signature.

Import
@tokenops/sdk/fhe-vesting/react
Return
{ mutate, mutateAsync, isPending, error, data }
Lifecycle
Write

Description

Directly transfer a vesting to newOwner — one-step variant. The contract gates this on appropriate role membership.

Signature

@tokenops/sdk/fhe-vesting/react
ts
function useDirectVestingTransfer(options: ManagerHookOptions): UseMutationResult<Hex, Error, UseDirectVestingTransferArgs>;

Parameters

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

PropertyTypeDescription
vestingIdrequiredHex
newOwnerrequiredAddress
accountAccount | Address
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 useDirectVestingTransfer; pick another from the dropdown if you'd rather start there.

Example

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

export function Example() {
  const { mutate, isPending } = useDirectVestingTransfer();

  return (
    <button disabled={isPending} onClick={() => mutate(/* args */)}>
      {isPending ? "Sending…" : "DirectVestingTransfer"}
    </button>
  );
}

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

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
ts
import { useQueryClient } from "@tanstack/react-query";

const queryClient = useQueryClient();
const directVestingTransfer = useDirectVestingTransfer(/* options */);

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

See also

Other Write hooks in vesting: