useDiscloseToParty
Grant ACL on a full vesting (allocation + settled + claimable) to a third party.
@tokenops/sdk/fhe-vesting/react{ mutate, mutateAsync, isPending, error, data }Description
Recipient discloses a single encrypted field of their own vesting to a
party — grants ACL persistently so the party can userDecrypt the handle.
disclosureType selects which field (total / settled / vested / claimable).
Returns { hash, handle } — handle is the granted euint128, parsed from
the receipt's AmountDisclosed event. Pass it to the Zama relayer's
userDecrypt from the party side to obtain the plaintext.
Signature
function useDiscloseToParty(options: ManagerHookOptions): UseMutationResult<DiscloseToPartyResult, Error, DiscloseArgs>;Parameters
Shape of the object you pass to .mutate(args) is the SDK type DiscloseArgs. Inspect the type for the full shape (discriminated unions collapse to a tagged variant at call time).
Example
"use client";
import { useDiscloseToParty } from "@tokenops/sdk/fhe-vesting/react";
export function Example() {
const { mutate, isPending } = useDiscloseToParty();
return (
<button disabled={isPending} onClick={() => mutate(/* args */)}>
{isPending ? "Sending…" : "DiscloseToParty"}
</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).
import { useQueryClient } from "@tanstack/react-query";
const queryClient = useQueryClient();
const discloseToParty = useDiscloseToParty(/* options */);
discloseToParty.mutate(args, {
onSuccess() {
// Coarse invalidation: refresh every cached read on this product surface.
queryClient.invalidateQueries({
queryKey: ["tokenops-sdk", "fhe-vesting"],
});
},
});See also
Other Disclose · ACL hooks in vesting:
useBatchDiscloseToPartyBatch variant of useDiscloseToParty.useAdminDiscloseToPartyAdmin variant of useDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE.useAdminBatchDiscloseToPartyAdmin variant of useBatchDiscloseToParty — caller must hold DISCLOSURE_ADMIN_ROLE.useDiscloseHandleToPartyGrant ACL on a single ciphertext handle to a third party (e.g. an auditor).