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.

Encrypted readuseMutationencrypted handle Curated

useDiscloseHandleToParty

Grant ACL on a single ciphertext handle to a third party (e.g. an auditor).

Import

@tokenops/sdk/fhe-airdrop/react

Return

{ mutate, mutateAsync, isPending, error, data }

Lifecycle

Encrypted read

Description

Grants party decrypt access to a handle you already hold - typically one returned by useAdminGetCurrentBalance or a claim preview, forwarded to an auditor without ever revealing plaintext.

Unlike the admin*Disclose* hooks this produces no new handle, so it returns the transaction hash rather than an EncryptedViewResult; there is no ACL event to parse.

Two gates apply on-chain: the handle must be persistently user-decryptable by the caller in this instance's context (a transient allowance from a fresh FHE op does not count; DISCLOSURE_ADMIN_ROLE bypasses this gate), and the *instance* must be allowed on it, so a handle minted by an unrelated contract cannot be laundered through this campaign. A failure of the first surfaces as FheHandleNotAllowedError.

Invalidates: nothing. ACL is append-only and no read hook in this subpath caches who is allowed on a handle.

Signature

@tokenops/sdk/fhe-airdrop/react

function useDiscloseHandleToParty(options: AirdropInstanceClientOptions): UseMutationResult<Hex, Error, DiscloseHandleToPartyArgs>;

Parameters

Shape of the object you pass to .mutate(args) is the SDK type DiscloseHandleToPartyArgs. 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 12 ready presets across vesting / airdrop / disperse / faucet — deploy a manager, create a vesting, claim, and run the product equivalents. The deep-link above auto-selects the closest preset to useDiscloseHandleToParty; pick another from the dropdown if you'd rather start there.

Example

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

tsx

const disclose = useDiscloseHandleToParty({ address: airdropAddress });
await disclose.mutateAsync({ handle, party: auditorAddress });

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 Airdrop v2 › 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 discloseHandleToParty = useDiscloseHandleToParty(/* options */);

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